本文描述了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:79Please respect copyright.PENANAFMFyoYHhXe
----------http range request-------79Please respect copyright.PENANAfzGMWTBFWN
GET /zen.iso HTTP/1.179Please respect copyright.PENANA1IVQE6cn9D
Range: bytes=100-102379Please respect copyright.PENANAokUWYJxlwG
If-Match: "534231200_1732277116"79Please respect copyright.PENANABMhUSOjFts
......79Please respect copyright.PENANAUEgpnHMNOd
-----------------------------------79Please respect copyright.PENANAxHJdriaUqF
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.
79Please respect copyright.PENANAOGM7nChKwi
Step 1. make a link for file to download, for example:79Please respect copyright.PENANAxlcvuYfWNs
----------------html-----------------79Please respect copyright.PENANAYXrpXXR9Yr
<a href="/zen.iso">zen.iso</a>79Please respect copyright.PENANAzRs8XvGv8v
-------------------------------------79Please respect copyright.PENANAF2gJZ8LC7J
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:79Please respect copyright.PENANAsAxR7CEtmc
----------get request------------79Please respect copyright.PENANAVcFQmVilmA
GET /zen.iso HTTP/1.179Please respect copyright.PENANAqWMZJwokyC
......79Please respect copyright.PENANAmcUfqBtKtf
---------------------------------
79Please respect copyright.PENANAE80slLnFH6
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:79Please respect copyright.PENANABRK2uH9mAT
----------------server response--------------79Please respect copyright.PENANAkrrhRuA7LG
HTTP/1.1 200 OK79Please respect copyright.PENANA75KNSAvYns
Date: Sat, 23 Nov 2024 06:29:19 GMT79Please respect copyright.PENANAxZgVgf5oba
accept-ranges: bytes79Please respect copyright.PENANAVSI7oaMoCN
content-range: bytes 0-534231199/53423120079Please respect copyright.PENANAUWT8rwLpq7
ETag: "534231200_1732277116"79Please respect copyright.PENANASmxFBWNSi1
Content-Disposition: attachment; filename="zen.iso"79Please respect copyright.PENANAQc4p5XyvGO
Content-Length: 53423120079Please respect copyright.PENANAx4iruxqoeP
Content-Type: application/octet-stream
(http response body is the whole file content)79Please respect copyright.PENANAN9lvt1Hc3f
-------------------------------------------
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:79Please respect copyright.PENANAHBWUVuL8jL
---------------http server send big file content by multiple times--------------79Please respect copyright.PENANAtAaB2Lmjb0
const int buf_size=20000000; // buf size is about 20M79Please respect copyright.PENANAXNJEkXZnT9
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers79Please respect copyright.PENANAZSQja9YUao
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 big79Please respect copyright.PENANAlSd0SoWPFP
while(there_is_remain_file_content_to_send)79Please respect copyright.PENANAQCImoSgujn
{ 79Please respect copyright.PENANAoieZjjfPWC
read_remain_file_content_to_send_buf(file, send_buf);79Please respect copyright.PENANA6bKGysLVMP
send_result = send(client_socket, send_buf);79Please respect copyright.PENANA1GiEnDHl1C
if(send_result == fail) return; else continue;79Please respect copyright.PENANAg5gruDDa6T
}
// a way to make etag for a file using its file size and last modifed time79Please respect copyright.PENANAzCpkbvg3N3
const char *file_etag(const char *path) 79Please respect copyright.PENANAAFRAxV6fd6
{79Please respect copyright.PENANAwgdj62CZCd
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;79Please respect copyright.PENANArg4s8VdX2z
}79Please respect copyright.PENANAWuy0oDJ17v
-------------------------------------------------79Please respect copyright.PENANAhbxAF7Y7T4
"accept-ranges: bytes" tells client web browser that the http server support range.79Please respect copyright.PENANAuIbz2bVpq1
"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).79Please respect copyright.PENANAtuU5cdRG1w
'ETag: "534231200_1732277116"' tells client web browser the file version.79Please respect copyright.PENANACCqtxsElJC
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.79Please respect copyright.PENANABKpFaKzf8D
"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.79Please respect copyright.PENANAVyXKLTlFPF
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
79Please respect copyright.PENANAQ08UL2g4wZ
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.79Please respect copyright.PENANAvllqpKgwf8
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.)79Please respect copyright.PENANA65I3JM6XW1
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.
79Please respect copyright.PENANARkVHgOO7DV
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:79Please respect copyright.PENANAgFNz0m0wE9
---------resume range request---------79Please respect copyright.PENANASCkW0RFMal
GET /zen.iso HTTP/1.179Please respect copyright.PENANAswgRrOoeUT
Range: bytes=243220480-79Please respect copyright.PENANA88QMGnq7kb
If-Match: "534231200_1732277116"79Please respect copyright.PENANA2u0ORhxws2
......79Please respect copyright.PENANAym1eP662VY
-------------------------------------79Please respect copyright.PENANABRVzYRZMF6
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.79Please respect copyright.PENANAg7Z5UCGW4V
'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:79Please respect copyright.PENANATr6LwNiVYI
-------response content from resume point-------79Please respect copyright.PENANAm3WUljR6YA
HTTP/1.1 206 Partial Content79Please respect copyright.PENANAZhQDodQSIT
Date: Sat, 23 Nov 2024 06:56:17 GMT79Please respect copyright.PENANADgByTL3AIS
accept-ranges: bytes79Please respect copyright.PENANAdY40nIYWQU
content-range: bytes 243220480-534231199/53423120079Please respect copyright.PENANAzj2nowIU3L
Content-Length: 29101072079Please respect copyright.PENANAJ6m1kNZuKE
Content-Type: application/octet-stream79Please respect copyright.PENANA2kmjiWSkq8
Content-Disposition: attachment; filename="zen.iso"79Please respect copyright.PENANAyNjlNQmYSG
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)79Please respect copyright.PENANA8UnDfjcmQe
------------------------------------------------79Please respect copyright.PENANAfP2GM9fCXJ
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:79Please respect copyright.PENANA3Gyn2ffX2s
-------response content from resume point-------79Please respect copyright.PENANAChGj5OXB0T
HTTP/1.1 200 OK79Please respect copyright.PENANAWKx8hFAn13
Date: Sat, 23 Nov 2024 06:29:19 GMT79Please respect copyright.PENANAA6cjfD3Q45
accept-ranges: bytes79Please respect copyright.PENANAaSjp7oDKw4
content-range: bytes 0-634231201/63423120279Please respect copyright.PENANAtC30JIap93
ETag: "634231202_2732277118"79Please respect copyright.PENANAshrr8WaZ3q
Content-Disposition: attachment; filename="zen.iso"79Please respect copyright.PENANAfDnpMl7dHS
Content-Length: 63423120279Please respect copyright.PENANAWSdEQsOef8
Content-Type: application/octet-stream
(http response body is the whole file content)79Please respect copyright.PENANAtOx5cqMfgQ
------------------------------------------------79Please respect copyright.PENANAm9NCO8FLve
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
79Please respect copyright.PENANAhS1HsslAMI
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:79Please respect copyright.PENANANuyJswFzTs
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
79Please respect copyright.PENANACYKFggTYMB
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示79Please respect copyright.PENANATsuYEnhnvT
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助79Please respect copyright.PENANAxvtdZaucNL
https://gemini.google.com/
感谢互联网上无私奉献的参考资79Please respect copyright.PENANA1dTTOUpfMq
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests79Please respect copyright.PENANAB8dRoYdmWb
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range79Please respect copyright.PENANAqAqubb6FB7
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag79Please respect copyright.PENANA8tid8bQaHJ
https://www.rfc-editor.org/rfc/rfc723379Please respect copyright.PENANAW7PqntRTsP
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
79Please respect copyright.PENANATtJcOFn1Y5
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]79Please respect copyright.PENANAD1CmS80yVV
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns18.117.241.170da2