本文描述了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:142Please respect copyright.PENANALBsntX33jA
----------http range request-------142Please respect copyright.PENANADsLRnxwBjQ
GET /zen.iso HTTP/1.1142Please respect copyright.PENANAqPNPyH53oF
Range: bytes=100-1023142Please respect copyright.PENANA5v45XjA2aM
If-Match: "534231200_1732277116"142Please respect copyright.PENANA6nkPwoAnwP
......142Please respect copyright.PENANAgHSkq5CZK3
-----------------------------------142Please respect copyright.PENANASJ7TyFU6ET
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.
142Please respect copyright.PENANAKY5RIcBil7
Step 1. make a link for file to download, for example:142Please respect copyright.PENANANlKDcpNcQh
----------------html-----------------142Please respect copyright.PENANATeXqTKhF06
<a href="/zen.iso">zen.iso</a>142Please respect copyright.PENANAuxTmqvRPHN
-------------------------------------142Please respect copyright.PENANAdXejoYABlx
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:142Please respect copyright.PENANAkcdoybGyMK
----------get request------------142Please respect copyright.PENANARUmY6eMjKK
GET /zen.iso HTTP/1.1142Please respect copyright.PENANA0VX8NSXSPl
......142Please respect copyright.PENANAD8YGAvkMiZ
---------------------------------
142Please respect copyright.PENANAuWe5xVmmGN
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:142Please respect copyright.PENANAGbwu3cv1Cb
----------------server response--------------142Please respect copyright.PENANAdqBUlfdaLO
HTTP/1.1 200 OK142Please respect copyright.PENANARkBdsZ9UgS
Date: Sat, 23 Nov 2024 06:29:19 GMT142Please respect copyright.PENANAVzqA0lyP7V
accept-ranges: bytes142Please respect copyright.PENANA7ZJtBEibvc
content-range: bytes 0-534231199/534231200142Please respect copyright.PENANAPx9KoVwtwm
ETag: "534231200_1732277116"142Please respect copyright.PENANAHUMaNhtsMv
Content-Disposition: attachment; filename="zen.iso"142Please respect copyright.PENANAeG1RE5jrL0
Content-Length: 534231200142Please respect copyright.PENANAjOba03CmZs
Content-Type: application/octet-stream
(http response body is the whole file content)142Please respect copyright.PENANA53r2gpT5Va
-------------------------------------------
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:142Please respect copyright.PENANANtrNK4X2Kz
---------------http server send big file content by multiple times--------------142Please respect copyright.PENANAiReXmSDXEq
const int buf_size=20000000; // buf size is about 20M142Please respect copyright.PENANAuiiKfRJK5w
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers142Please respect copyright.PENANAD142nCr3CG
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 big142Please respect copyright.PENANAWLZOaAnFT7
while(there_is_remain_file_content_to_send)142Please respect copyright.PENANA9jFnAd9noz
{ 142Please respect copyright.PENANAYYbtLOo3Bs
read_remain_file_content_to_send_buf(file, send_buf);142Please respect copyright.PENANAwmivi5rYWU
send_result = send(client_socket, send_buf);142Please respect copyright.PENANANHg6fr8gFB
if(send_result == fail) return; else continue;142Please respect copyright.PENANASd2RJmCl0c
}
// a way to make etag for a file using its file size and last modifed time142Please respect copyright.PENANAD7gK5lD9li
const char *file_etag(const char *path) 142Please respect copyright.PENANA2pkV1pFY4E
{142Please respect copyright.PENANAaWemkkb2pa
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;142Please respect copyright.PENANAwMiFAdhwZL
}142Please respect copyright.PENANAKvPlOMXDVX
-------------------------------------------------142Please respect copyright.PENANAqPOECFqNAv
"accept-ranges: bytes" tells client web browser that the http server support range.142Please respect copyright.PENANAOjMWFUZ2wo
"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).142Please respect copyright.PENANAUqSYUCOWE2
'ETag: "534231200_1732277116"' tells client web browser the file version.142Please respect copyright.PENANAx46U7PBTnq
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.142Please respect copyright.PENANAHj8txJRiE3
"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.142Please respect copyright.PENANACtjtpg8lR4
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
142Please respect copyright.PENANAtpIj9Uc0FA
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.142Please respect copyright.PENANA5qxqOJvbgL
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.)142Please respect copyright.PENANAy47XB0ntxr
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.
142Please respect copyright.PENANA2U4XSwwhpg
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:142Please respect copyright.PENANAQvwEjnpwGH
---------resume range request---------142Please respect copyright.PENANA0Dwdh91HF3
GET /zen.iso HTTP/1.1142Please respect copyright.PENANAHgZR788FhM
Range: bytes=243220480-142Please respect copyright.PENANA0W66RvVW8a
If-Match: "534231200_1732277116"142Please respect copyright.PENANA3BEuUut1VB
......142Please respect copyright.PENANAIpps30uDVE
-------------------------------------142Please respect copyright.PENANAsAkPLZbrvW
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.142Please respect copyright.PENANACKSlnf11zi
'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:142Please respect copyright.PENANAV1LorYymlN
-------response content from resume point-------142Please respect copyright.PENANAtZdFMrQkMy
HTTP/1.1 206 Partial Content142Please respect copyright.PENANACjoRTf1Ilo
Date: Sat, 23 Nov 2024 06:56:17 GMT142Please respect copyright.PENANAa4qfzIMYqD
accept-ranges: bytes142Please respect copyright.PENANAnkZcsHcwPK
content-range: bytes 243220480-534231199/534231200142Please respect copyright.PENANA2tdRlQLXYf
Content-Length: 291010720142Please respect copyright.PENANAHUSlD254d3
Content-Type: application/octet-stream142Please respect copyright.PENANAXXlGKMspI4
Content-Disposition: attachment; filename="zen.iso"142Please respect copyright.PENANAR4DnBuvre0
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)142Please respect copyright.PENANAvWSHBoMHSH
------------------------------------------------142Please respect copyright.PENANAgQvfhuZ7ZM
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:142Please respect copyright.PENANAyE6Oi7whTd
-------response content from resume point-------142Please respect copyright.PENANAC8bnp6Gnpo
HTTP/1.1 200 OK142Please respect copyright.PENANAjFVrn8v4nX
Date: Sat, 23 Nov 2024 06:29:19 GMT142Please respect copyright.PENANAryv9ZsfFpE
accept-ranges: bytes142Please respect copyright.PENANA6ErtEeb5tk
content-range: bytes 0-634231201/634231202142Please respect copyright.PENANA06KtrkFxBT
ETag: "634231202_2732277118"142Please respect copyright.PENANAsvmydbydWq
Content-Disposition: attachment; filename="zen.iso"142Please respect copyright.PENANAbGdF9NGSjQ
Content-Length: 634231202142Please respect copyright.PENANA5wZ2JFjIoI
Content-Type: application/octet-stream
(http response body is the whole file content)142Please respect copyright.PENANA7R8EYricy3
------------------------------------------------142Please respect copyright.PENANADZXlyQpwIZ
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
142Please respect copyright.PENANAfUbju3j3DD
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:142Please respect copyright.PENANAncHqLkjatG
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
142Please respect copyright.PENANAnbT2MsXdR7
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示142Please respect copyright.PENANAukqy24dPjb
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助142Please respect copyright.PENANAW2IUjJGRou
https://gemini.google.com/
感谢互联网上无私奉献的参考资142Please respect copyright.PENANA4zi0vM0aYY
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests142Please respect copyright.PENANAfM0nFytRXH
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range142Please respect copyright.PENANAicTdGLVHLn
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag142Please respect copyright.PENANAyW3rwvfHsB
https://www.rfc-editor.org/rfc/rfc7233142Please respect copyright.PENANAEjSsHdRJmV
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
142Please respect copyright.PENANAWpExQkcGAG
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]142Please respect copyright.PENANAAX3bd4NmWM
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns216.73.216.197da2