本文描述了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:140Please respect copyright.PENANAqjn4Lk0ku9
----------http range request-------140Please respect copyright.PENANAUGSb31Zhqa
GET /zen.iso HTTP/1.1140Please respect copyright.PENANAi75WETOfmr
Range: bytes=100-1023140Please respect copyright.PENANAWASU7s3E3X
If-Match: "534231200_1732277116"140Please respect copyright.PENANA8piqArgCtO
......140Please respect copyright.PENANAulA5pPXQqe
-----------------------------------140Please respect copyright.PENANAQaJcyqYQWL
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.
140Please respect copyright.PENANAjpiKC0PUon
Step 1. make a link for file to download, for example:140Please respect copyright.PENANAJE9q5WqqWn
----------------html-----------------140Please respect copyright.PENANAMS8DvzvMtl
<a href="/zen.iso">zen.iso</a>140Please respect copyright.PENANATR2npDDv7x
-------------------------------------140Please respect copyright.PENANA3WfAXqSQGJ
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:140Please respect copyright.PENANAisNVvJ9XDW
----------get request------------140Please respect copyright.PENANAphxUB4StiA
GET /zen.iso HTTP/1.1140Please respect copyright.PENANA1BL0WXzTrW
......140Please respect copyright.PENANAxZ31nv90De
---------------------------------
140Please respect copyright.PENANANGmFaKlhEw
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:140Please respect copyright.PENANAKSUURPuBnH
----------------server response--------------140Please respect copyright.PENANAxWYNBocE1J
HTTP/1.1 200 OK140Please respect copyright.PENANAArnO6kJ9Ui
Date: Sat, 23 Nov 2024 06:29:19 GMT140Please respect copyright.PENANAAFbYCvsXXj
accept-ranges: bytes140Please respect copyright.PENANAZ7s4xPLwTW
content-range: bytes 0-534231199/534231200140Please respect copyright.PENANAXQ3OIaiivm
ETag: "534231200_1732277116"140Please respect copyright.PENANA03H7fL8xwg
Content-Disposition: attachment; filename="zen.iso"140Please respect copyright.PENANA3tqd5zKADz
Content-Length: 534231200140Please respect copyright.PENANAlvi6iNybHH
Content-Type: application/octet-stream
(http response body is the whole file content)140Please respect copyright.PENANAcZYlsNVmru
-------------------------------------------
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:140Please respect copyright.PENANARght6jq5yL
---------------http server send big file content by multiple times--------------140Please respect copyright.PENANAOSDpshuMoB
const int buf_size=20000000; // buf size is about 20M140Please respect copyright.PENANAciMjO21DKa
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers140Please respect copyright.PENANAApGu9zhugZ
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 big140Please respect copyright.PENANARX3ru6FVmy
while(there_is_remain_file_content_to_send)140Please respect copyright.PENANAnt7RVA09Ls
{ 140Please respect copyright.PENANAq5JMsmejHc
read_remain_file_content_to_send_buf(file, send_buf);140Please respect copyright.PENANAVoRs9wdOVO
send_result = send(client_socket, send_buf);140Please respect copyright.PENANAGsaMjNMRno
if(send_result == fail) return; else continue;140Please respect copyright.PENANAS4aDR9GGOd
}
// a way to make etag for a file using its file size and last modifed time140Please respect copyright.PENANA0vb9uucUvM
const char *file_etag(const char *path) 140Please respect copyright.PENANAcCb5YbAnJu
{140Please respect copyright.PENANAiJFLeWFZm5
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;140Please respect copyright.PENANA6MIKk4sGT8
}140Please respect copyright.PENANAs5QcWZjsM3
-------------------------------------------------140Please respect copyright.PENANAoPRn0cjGmW
"accept-ranges: bytes" tells client web browser that the http server support range.140Please respect copyright.PENANAfUCEtwJrzR
"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).140Please respect copyright.PENANAQE6yE5wRYE
'ETag: "534231200_1732277116"' tells client web browser the file version.140Please respect copyright.PENANAkKBuMZBhER
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.140Please respect copyright.PENANAIloHomVuwa
"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.140Please respect copyright.PENANA8ZsQozLEVE
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
140Please respect copyright.PENANA0wXIFbjXeh
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.140Please respect copyright.PENANAg0KcxqFekw
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.)140Please respect copyright.PENANAlXfkIiwosM
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.
140Please respect copyright.PENANAkDsUGcmqkw
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:140Please respect copyright.PENANAgNQFjJ7H0e
---------resume range request---------140Please respect copyright.PENANAEtE1YaSkc6
GET /zen.iso HTTP/1.1140Please respect copyright.PENANAyFETgvAuac
Range: bytes=243220480-140Please respect copyright.PENANAdUsiLBrWER
If-Match: "534231200_1732277116"140Please respect copyright.PENANAXIhyShROuK
......140Please respect copyright.PENANAZiaj7zF2RW
-------------------------------------140Please respect copyright.PENANAqBAV18MLgG
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.140Please respect copyright.PENANAhBRAuMluJE
'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:140Please respect copyright.PENANAB0TqeKfQKg
-------response content from resume point-------140Please respect copyright.PENANA5VugzJgHnv
HTTP/1.1 206 Partial Content140Please respect copyright.PENANApcIKXXhAxd
Date: Sat, 23 Nov 2024 06:56:17 GMT140Please respect copyright.PENANAyar5NYIlkb
accept-ranges: bytes140Please respect copyright.PENANAHdnw1BLgbO
content-range: bytes 243220480-534231199/534231200140Please respect copyright.PENANAIBkOmtxhpu
Content-Length: 291010720140Please respect copyright.PENANAgbHoLGpU4k
Content-Type: application/octet-stream140Please respect copyright.PENANAbIQ4EgKeOq
Content-Disposition: attachment; filename="zen.iso"140Please respect copyright.PENANAg8ZQcQDprH
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)140Please respect copyright.PENANAmx8BEcWnj3
------------------------------------------------140Please respect copyright.PENANALyf1LXNPH4
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:140Please respect copyright.PENANADzzOpfBzBf
-------response content from resume point-------140Please respect copyright.PENANAurSSF26COZ
HTTP/1.1 200 OK140Please respect copyright.PENANAL1t65Kl53P
Date: Sat, 23 Nov 2024 06:29:19 GMT140Please respect copyright.PENANAG3m8DvU7sR
accept-ranges: bytes140Please respect copyright.PENANA1dtdyLH7Pq
content-range: bytes 0-634231201/634231202140Please respect copyright.PENANAQSR1tZhX70
ETag: "634231202_2732277118"140Please respect copyright.PENANAOvXpeg0XEn
Content-Disposition: attachment; filename="zen.iso"140Please respect copyright.PENANAGDdyQtqP3o
Content-Length: 634231202140Please respect copyright.PENANA3rxOo9SRgQ
Content-Type: application/octet-stream
(http response body is the whole file content)140Please respect copyright.PENANAJf6QTPIJkX
------------------------------------------------140Please respect copyright.PENANAsNyZq11EXC
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
140Please respect copyright.PENANAD5Y9z2gOcC
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:140Please respect copyright.PENANAl6pGdd21hf
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
140Please respect copyright.PENANAkzxjmByqmg
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示140Please respect copyright.PENANAAGkTCDKiBZ
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助140Please respect copyright.PENANAQtTGCCg6lc
https://gemini.google.com/
感谢互联网上无私奉献的参考资140Please respect copyright.PENANAnvF7Qrgni8
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests140Please respect copyright.PENANAluAiKGycQ0
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range140Please respect copyright.PENANAvQN27UpBmK
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag140Please respect copyright.PENANAw5Pne01kZp
https://www.rfc-editor.org/rfc/rfc7233140Please respect copyright.PENANA2HLrl960qX
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
140Please respect copyright.PENANAnp90jeaSK1
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]140Please respect copyright.PENANAGwdI9nGFaq
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns216.73.216.30da2