本文描述了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:40Please respect copyright.PENANAlToSQaItrI
----------http range request-------40Please respect copyright.PENANA4YA9yyr2Ix
GET /zen.iso HTTP/1.140Please respect copyright.PENANAvkeSk0si3z
Range: bytes=100-102340Please respect copyright.PENANAzicSHG4QSO
If-Match: "534231200_1732277116"40Please respect copyright.PENANAAaAbahlTTK
......40Please respect copyright.PENANAvgilrTB6R6
-----------------------------------40Please respect copyright.PENANApZGScYzIAp
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.
40Please respect copyright.PENANAw6bwbLGJXj
Step 1. make a link for file to download, for example:40Please respect copyright.PENANAqc1oa6R4Gf
----------------html-----------------40Please respect copyright.PENANAMN6qV1KmRg
<a href="/zen.iso">zen.iso</a>40Please respect copyright.PENANA2l4zH7Hvtc
-------------------------------------40Please respect copyright.PENANAiNnf4ednN2
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:40Please respect copyright.PENANAYPT1DAqDAJ
----------get request------------40Please respect copyright.PENANA33YF4hbxqY
GET /zen.iso HTTP/1.140Please respect copyright.PENANAQXQVnI0nBC
......40Please respect copyright.PENANA7iqGWOqKUq
---------------------------------
40Please respect copyright.PENANACsmteMMFga
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:40Please respect copyright.PENANAqsh5mL634D
----------------server response--------------40Please respect copyright.PENANAibAu87ZrcM
HTTP/1.1 200 OK40Please respect copyright.PENANApqBbOv05KT
Date: Sat, 23 Nov 2024 06:29:19 GMT40Please respect copyright.PENANAtRxrA8QEmT
accept-ranges: bytes40Please respect copyright.PENANAt9oypTJRok
content-range: bytes 0-534231199/53423120040Please respect copyright.PENANAMjQV2ni69I
ETag: "534231200_1732277116"40Please respect copyright.PENANA5aCuZ7th8w
Content-Disposition: attachment; filename="zen.iso"40Please respect copyright.PENANAwElNrJKUhF
Content-Length: 53423120040Please respect copyright.PENANAVuTOX1RON9
Content-Type: application/octet-stream
(http response body is the whole file content)40Please respect copyright.PENANAsTSvd1egHU
-------------------------------------------
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:40Please respect copyright.PENANA22F6pGJOao
---------------http server send big file content by multiple times--------------40Please respect copyright.PENANAedmsFcgR6x
const int buf_size=20000000; // buf size is about 20M40Please respect copyright.PENANAHafbwxvrED
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers40Please respect copyright.PENANAPYSwPYnLQf
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 big40Please respect copyright.PENANATGRj5y8tDF
while(there_is_remain_file_content_to_send)40Please respect copyright.PENANACc7HoZAhmM
{ 40Please respect copyright.PENANAPdSDOxTxGY
read_remain_file_content_to_send_buf(file, send_buf);40Please respect copyright.PENANAbE0T6QgsMa
send_result = send(client_socket, send_buf);40Please respect copyright.PENANAdoWLdSkJhq
if(send_result == fail) return; else continue;40Please respect copyright.PENANAIWJk3IKBWl
}
// a way to make etag for a file using its file size and last modifed time40Please respect copyright.PENANAnRjiC7ToVI
const char *file_etag(const char *path) 40Please respect copyright.PENANAuuVkbcke37
{40Please respect copyright.PENANAvFMUXznWiL
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;40Please respect copyright.PENANADZXDbDUiLQ
}40Please respect copyright.PENANA22u5NwHGKm
-------------------------------------------------40Please respect copyright.PENANAmwIlTMPBok
"accept-ranges: bytes" tells client web browser that the http server support range.40Please respect copyright.PENANAOUF36NDpyW
"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).40Please respect copyright.PENANAAYY6HWllqj
'ETag: "534231200_1732277116"' tells client web browser the file version.40Please respect copyright.PENANAsJxePMxdUS
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.40Please respect copyright.PENANANLapH03UrJ
"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.40Please respect copyright.PENANANTXXowcrZ0
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
40Please respect copyright.PENANAgnBtdbkuvk
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.40Please respect copyright.PENANAhD2CCVeip8
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.)40Please respect copyright.PENANAxXDD2oJIzt
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.
40Please respect copyright.PENANA8bGPNmUZKq
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:40Please respect copyright.PENANAVUavQTb86K
---------resume range request---------40Please respect copyright.PENANAEQm2jqQxaV
GET /zen.iso HTTP/1.140Please respect copyright.PENANAbdllH1qXhw
Range: bytes=243220480-40Please respect copyright.PENANAN5fMrPoMCT
If-Match: "534231200_1732277116"40Please respect copyright.PENANA749GDSV4iE
......40Please respect copyright.PENANAM1ZHWpeYXh
-------------------------------------40Please respect copyright.PENANArPZ0yHYwNG
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.40Please respect copyright.PENANALkLPjqmruG
'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:40Please respect copyright.PENANAP29Su5Z109
-------response content from resume point-------40Please respect copyright.PENANAhOJhSyDZSu
HTTP/1.1 206 Partial Content40Please respect copyright.PENANAQS7BwIyGW7
Date: Sat, 23 Nov 2024 06:56:17 GMT40Please respect copyright.PENANA6kzqpfmjLN
accept-ranges: bytes40Please respect copyright.PENANAXWQMBEoyQo
content-range: bytes 243220480-534231199/53423120040Please respect copyright.PENANAwaosFonXM6
Content-Length: 29101072040Please respect copyright.PENANAvcWCc6x6Fb
Content-Type: application/octet-stream40Please respect copyright.PENANA8BRG9GLPCJ
Content-Disposition: attachment; filename="zen.iso"40Please respect copyright.PENANAMuKoAvzh6r
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)40Please respect copyright.PENANAXzFjaqJAUh
------------------------------------------------40Please respect copyright.PENANAIrhGDclFmb
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:40Please respect copyright.PENANAw3vSIyhJJh
-------response content from resume point-------40Please respect copyright.PENANAErls0PHt2E
HTTP/1.1 200 OK40Please respect copyright.PENANAhkv6KFH0Kq
Date: Sat, 23 Nov 2024 06:29:19 GMT40Please respect copyright.PENANAipOIrEyAbU
accept-ranges: bytes40Please respect copyright.PENANA9v1zDOCX1L
content-range: bytes 0-634231201/63423120240Please respect copyright.PENANAGFLIQ09wzw
ETag: "634231202_2732277118"40Please respect copyright.PENANAxOSq3DQpdf
Content-Disposition: attachment; filename="zen.iso"40Please respect copyright.PENANANciVQPbsuJ
Content-Length: 63423120240Please respect copyright.PENANAUQC7UywPpK
Content-Type: application/octet-stream
(http response body is the whole file content)40Please respect copyright.PENANAEDIowlMy6f
------------------------------------------------40Please respect copyright.PENANAMUiA5BRbJ5
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
40Please respect copyright.PENANAMqvsxKSkaR
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:40Please respect copyright.PENANAPT3PNrnaEu
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
40Please respect copyright.PENANAkpvB28Pd4K
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示40Please respect copyright.PENANAzWR1YMx5IL
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助40Please respect copyright.PENANAprjUCyQykH
https://gemini.google.com/
感谢互联网上无私奉献的参考资40Please respect copyright.PENANAI9oJQRMRxO
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests40Please respect copyright.PENANAIkg2idrlNl
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range40Please respect copyright.PENANABtUn0LJnI8
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag40Please respect copyright.PENANACHiVn3YAHn
https://www.rfc-editor.org/rfc/rfc723340Please respect copyright.PENANAChZHFkWB5t
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
40Please respect copyright.PENANAujvC7vvdKQ
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: si.jinmin@gmail.com40Please respect copyright.PENANAlo9nGDlWw1
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: si.jinmin@gmail.com
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns 15.158.61.18da2