本文描述了Http服务器使用http range支持浏览器的下载管理器下载大文件时可暂停和继续的实现方法,后面用英文写,但我的英文不太好,如有错误之处,希望大家帮我纠正,我的联系方式在后面。
Section A. Summary
I'm making a http server in C, in order to support big file download, I have to support Http Range in my server, as the usual way for web browsers to download big files is to use its download manager, where we can pause and resume the download progress. For the pause and resume functions of download manager to work, the http server must support Http Range requests.
Besides file download, http range is also needed for <video> element to play videos on web page, when the user click a random position of the video time line, the browser use http range requests to get the corresponding file content of the video file.
Http range is imported into http protocol from http 1.1. A http range request is like this:158Please respect copyright.PENANAdJp52hyiEx
----------http range request-------158Please respect copyright.PENANARmR7i2JH7D
GET /zen.iso HTTP/1.1158Please respect copyright.PENANAjyNC2yDPGd
Range: bytes=100-1023158Please respect copyright.PENANAbyUQWR2eQ6
If-Match: "534231200_1732277116"158Please respect copyright.PENANABA9QVHHBy1
......158Please respect copyright.PENANAfXBi2VuLhe
-----------------------------------158Please respect copyright.PENANAhm8JS4p8B5
It means to get the content from byte 100 to byte 1023, totally 924 bytes, and it tells the http server the etag value of already downloaded part is "534231200_1732277116", the etag value is used for the web browser to determine if the requested content has been modified, it's necessory for some browsers like chrome and edge to resume the download of a file. If http server do not provide etag for range content, the resume function of web browser download manager will not work.
Section B. Detailed Steps
The following is the steps for serving file download, support pause and resume functions of web browser download manager.
158Please respect copyright.PENANA8Iq53y9yt7
Step 1. make a link for file to download, for example:158Please respect copyright.PENANApoxWTMLYOO
----------------html-----------------158Please respect copyright.PENANA5yTX2dSRk7
<a href="/zen.iso">zen.iso</a>158Please respect copyright.PENANAkm393QrM3v
-------------------------------------158Please respect copyright.PENANA82QYPmV57H
When user click the link, web browser download manager will take care of the file download immediately. We cannot use javascript fetch(url) to start downloading, as in this way javascript code will take care of the download instead of download manager.
When the link is clicked, the http request sent to server is like this:158Please respect copyright.PENANAtlqibpKQDU
----------get request------------158Please respect copyright.PENANASn8aTh2xZk
GET /zen.iso HTTP/1.1158Please respect copyright.PENANAZu2U7OQRsW
......158Please respect copyright.PENANAjHe3yshOL9
---------------------------------
158Please respect copyright.PENANA8tQEgFpweH
Step 2. when http server receives above request, it sends the whole file content as response body back as usual, and indicates support of http range in the response headers, like this:158Please respect copyright.PENANAb1rHpKW9U0
----------------server response--------------158Please respect copyright.PENANAU3Zx8Nhzw9
HTTP/1.1 200 OK158Please respect copyright.PENANAFVaC3gIiC9
Date: Sat, 23 Nov 2024 06:29:19 GMT158Please respect copyright.PENANAL0BkymHy98
accept-ranges: bytes158Please respect copyright.PENANAjCK31Tcm91
content-range: bytes 0-534231199/534231200158Please respect copyright.PENANAlpy59VOMEW
ETag: "534231200_1732277116"158Please respect copyright.PENANA1msPPtWJOG
Content-Disposition: attachment; filename="zen.iso"158Please respect copyright.PENANA8Ba6wpDSPP
Content-Length: 534231200158Please respect copyright.PENANA9zRcm6KK3O
Content-Type: application/octet-stream
(http response body is the whole file content)158Please respect copyright.PENANA6NLD7YmWRG
-------------------------------------------
Http server usually use a small buf to send the whole file content by multiple times if the file size is bigger than it, like this:158Please respect copyright.PENANAJXsqGaOgMS
---------------http server send big file content by multiple times--------------158Please respect copyright.PENANAEE41TuABdY
const int buf_size=20000000; // buf size is about 20M158Please respect copyright.PENANAWvbYixqWTc
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers158Please respect copyright.PENANAzdttzumJPc
send_http_response_headers(client_socket, http_response_headers);
// then send the whole file content as response body by multiple times if the file is big158Please respect copyright.PENANAtTlCnmJskV
while(there_is_remain_file_content_to_send)158Please respect copyright.PENANAQrKoVWiSnL
{ 158Please respect copyright.PENANAUeI91hpN3i
read_remain_file_content_to_send_buf(file, send_buf);158Please respect copyright.PENANAxdzYwPOrMn
send_result = send(client_socket, send_buf);158Please respect copyright.PENANAXronwaDf5R
if(send_result == fail) return; else continue;158Please respect copyright.PENANA2SLqwqqV6S
}
// a way to make etag for a file using its file size and last modifed time158Please respect copyright.PENANADplUymgrfA
const char *file_etag(const char *path) 158Please respect copyright.PENANA7V46UgqbK0
{158Please respect copyright.PENANAzeOwwirbkK
struct stat st; if (stat(path, &st) < 0) return NULL; char* data=malloc(64); snprintf(data, 63, "%ld_%ld", (long)st.st_size, (long)st.st_mtime); return data;158Please respect copyright.PENANA3WuqCiht0g
}158Please respect copyright.PENANAhpprbTcIHo
-------------------------------------------------158Please respect copyright.PENANAnObvHQF3WT
"accept-ranges: bytes" tells client web browser that the http server support range.158Please respect copyright.PENANAfNCfRb9k1O
"content-range: bytes 0-534231199/534231200" tells client web browser the content range(0-534231199) of the response body and the total file size(534231200).158Please respect copyright.PENANAZaB447UYr0
'ETag: "534231200_1732277116"' tells client web browser the file version.158Please respect copyright.PENANAcG3wvjHK67
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.158Please respect copyright.PENANAQYEoaT7NXt
"Content-Length: 534231200" tells client web browser the total size of the response body, which is the size of the whole file in this example.158Please respect copyright.PENANAZ5HuAsGhUw
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
158Please respect copyright.PENANAZOaVpihMYT
step 3. When the web browser receives above response, it knows the server support http range, and knows the total file size by "content-range: bytes 0-534231199/534231200", it also saves the etag for later comparation.158Please respect copyright.PENANAYSQ6owidxd
If the file is big, the above sends may take several minutes, during this time, the user can click pause in the download manager of web browser(for firefox, you have to press ctrl and right click the file to show the pause command.)158Please respect copyright.PENANAw1HANGajVZ
When pause is pressed, the web browser disconnects with http server, and the "send_result = send(client_socket, send_buf);" of http server will be fail, then the http server stops sending anymore.
158Please respect copyright.PENANAl98AUgf2ye
step 4. Later the user can click resume to continue the download in download manager, and the download manager will send a http range request to tell the server the resume start point, like this:158Please respect copyright.PENANALqLNyYMBBq
---------resume range request---------158Please respect copyright.PENANAgIxXv6fHhP
GET /zen.iso HTTP/1.1158Please respect copyright.PENANAMttxcfrh9h
Range: bytes=243220480-158Please respect copyright.PENANAdlODjZNfA7
If-Match: "534231200_1732277116"158Please respect copyright.PENANAKzkDfG7Daj
......158Please respect copyright.PENANAsCOTH9MpoV
-------------------------------------158Please respect copyright.PENANA8m5vATdYJh
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.158Please respect copyright.PENANAHZfzQgJCry
'If-Match: "534231200_1732277116"' tells the http server to check the file etag.
If the etag remains the same, it means the file is not changed, so the server can send from the resume point 243220480, and its response status should be 206 partial content, like this:158Please respect copyright.PENANAnhS1Fs2oLC
-------response content from resume point-------158Please respect copyright.PENANAuoB43c54y1
HTTP/1.1 206 Partial Content158Please respect copyright.PENANAiNwvj0j6h5
Date: Sat, 23 Nov 2024 06:56:17 GMT158Please respect copyright.PENANAWFFhmBVgBg
accept-ranges: bytes158Please respect copyright.PENANAJyvmedQenG
content-range: bytes 243220480-534231199/534231200158Please respect copyright.PENANA7woUUKZ2m7
Content-Length: 291010720158Please respect copyright.PENANA3TxPcyO1qI
Content-Type: application/octet-stream158Please respect copyright.PENANAzNCUYdVFmr
Content-Disposition: attachment; filename="zen.iso"158Please respect copyright.PENANAioDPQiS8vs
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)158Please respect copyright.PENANAUEsLx5AWwa
------------------------------------------------158Please respect copyright.PENANAs4GZytk2on
When client download manager receives this response, it will keep the already downloaded content and append the new respone body content to it.
If the etag diffs, it means the file has been changed, then the server should send the file content from beginning to end, with a 200 OK response status, like this:158Please respect copyright.PENANA9G51icuZGG
-------response content from resume point-------158Please respect copyright.PENANALVNWcn1LoD
HTTP/1.1 200 OK158Please respect copyright.PENANAB8Pr9R9bD1
Date: Sat, 23 Nov 2024 06:29:19 GMT158Please respect copyright.PENANAFGYbBOt7GZ
accept-ranges: bytes158Please respect copyright.PENANAV9erA5qw1a
content-range: bytes 0-634231201/634231202158Please respect copyright.PENANAeMHQOJov8Q
ETag: "634231202_2732277118"158Please respect copyright.PENANASk12tBR8Ie
Content-Disposition: attachment; filename="zen.iso"158Please respect copyright.PENANAZNly5PyvtC
Content-Length: 634231202158Please respect copyright.PENANA6KTsLlzHt0
Content-Type: application/octet-stream
(http response body is the whole file content)158Please respect copyright.PENANAKMx8Hqz8U3
------------------------------------------------158Please respect copyright.PENANAj8RVhtfH0s
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
158Please respect copyright.PENANAKZdEluSkq1
step 5. when a <video src="/video_file.mp4"> is used to play videos on web page, the browser also used http range requests, as Zeng Xu's article describes:158Please respect copyright.PENANA5GqA5DIw1u
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
158Please respect copyright.PENANAGGha9msqJF
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示158Please respect copyright.PENANAmSDA0DRhUo
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助158Please respect copyright.PENANAVQl8noRv1W
https://gemini.google.com/
感谢互联网上无私奉献的参考资158Please respect copyright.PENANAwoTm0CxxHY
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests158Please respect copyright.PENANAtwIblvSb6d
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range158Please respect copyright.PENANAeRz2W3TWd9
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag158Please respect copyright.PENANA4Gp8WO7zDY
https://www.rfc-editor.org/rfc/rfc7233158Please respect copyright.PENANA37pB1Z7AaF
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
158Please respect copyright.PENANAcRvisolFzP
Section D. Contacts Me
If you found any errors or have any suggestions for this article, please let me know, my wechat: si_jinmin, my email: [email protected]158Please respect copyright.PENANA2xmWaEZkDZ
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns216.73.216.6da2