本文描述了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:39Please respect copyright.PENANA5FuhZ1I7Mf
----------http range request-------39Please respect copyright.PENANA2gZm17pKii
GET /zen.iso HTTP/1.139Please respect copyright.PENANAvVI8iqBqQp
Range: bytes=100-102339Please respect copyright.PENANApb6YK5L0nq
If-Match: "534231200_1732277116"39Please respect copyright.PENANAlOmcwLjAEx
......39Please respect copyright.PENANAbb4iVjTMVS
-----------------------------------39Please respect copyright.PENANAvvAzXtaNgZ
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.
39Please respect copyright.PENANA3uutam8Bcx
Step 1. make a link for file to download, for example:39Please respect copyright.PENANA2GVxAgMsj8
----------------html-----------------39Please respect copyright.PENANAWgmYfmBGQx
<a href="/zen.iso">zen.iso</a>39Please respect copyright.PENANApFuP6CCxFw
-------------------------------------39Please respect copyright.PENANAm7GFerNXfx
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:39Please respect copyright.PENANAYkC504IVGw
----------get request------------39Please respect copyright.PENANAkbZQ4gVGld
GET /zen.iso HTTP/1.139Please respect copyright.PENANA6kfhpr12nJ
......39Please respect copyright.PENANAHLDq1tesEx
---------------------------------
39Please respect copyright.PENANAi4Wkd88j3D
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:39Please respect copyright.PENANAzenz3fAcmX
----------------server response--------------39Please respect copyright.PENANAAs1fImwnJx
HTTP/1.1 200 OK39Please respect copyright.PENANA2zCac26Mlo
Date: Sat, 23 Nov 2024 06:29:19 GMT39Please respect copyright.PENANA3QhQzn7fDT
accept-ranges: bytes39Please respect copyright.PENANAOI3Nd8yhht
content-range: bytes 0-534231199/53423120039Please respect copyright.PENANAbCGhO9Hn34
ETag: "534231200_1732277116"39Please respect copyright.PENANANL57zhbALe
Content-Disposition: attachment; filename="zen.iso"39Please respect copyright.PENANAOa7DSIIe2L
Content-Length: 53423120039Please respect copyright.PENANA2dcRBvp4ro
Content-Type: application/octet-stream
(http response body is the whole file content)39Please respect copyright.PENANAo38EkHwGuN
-------------------------------------------
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:39Please respect copyright.PENANALyroy3EbwY
---------------http server send big file content by multiple times--------------39Please respect copyright.PENANAgYFX5iJuqc
const int buf_size=20000000; // buf size is about 20M39Please respect copyright.PENANA0U2ulSCkmb
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers39Please respect copyright.PENANAqgTeKByOSa
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 big39Please respect copyright.PENANAhLNapgQSs4
while(there_is_remain_file_content_to_send)39Please respect copyright.PENANAkRpjLenWo5
{ 39Please respect copyright.PENANANWCoCa7nBJ
read_remain_file_content_to_send_buf(file, send_buf);39Please respect copyright.PENANApCi9kBWtPe
send_result = send(client_socket, send_buf);39Please respect copyright.PENANAxK7Nj2dhsz
if(send_result == fail) return; else continue;39Please respect copyright.PENANABlOOq04Znm
}
// a way to make etag for a file using its file size and last modifed time39Please respect copyright.PENANA0hZpC7b1Mu
const char *file_etag(const char *path) 39Please respect copyright.PENANAMzqM6avqJL
{39Please respect copyright.PENANAqRBuluoXGw
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;39Please respect copyright.PENANA85lbF1B4CQ
}39Please respect copyright.PENANAgJl3hLGjVX
-------------------------------------------------39Please respect copyright.PENANAamvETq5HY1
"accept-ranges: bytes" tells client web browser that the http server support range.39Please respect copyright.PENANAqwb8fymGbC
"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).39Please respect copyright.PENANA3GQmUupHdy
'ETag: "534231200_1732277116"' tells client web browser the file version.39Please respect copyright.PENANACLQYKf6Rpk
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.39Please respect copyright.PENANAEMfklfvE1V
"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.39Please respect copyright.PENANAnQNGCn7x8P
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
39Please respect copyright.PENANAM6WOt3TmcE
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.39Please respect copyright.PENANAGs8sO9Yb0z
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.)39Please respect copyright.PENANAZIfWkR0DNY
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.
39Please respect copyright.PENANAMgwd5kUbws
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:39Please respect copyright.PENANAiINgbG9AVV
---------resume range request---------39Please respect copyright.PENANAM1Uy7nTVrU
GET /zen.iso HTTP/1.139Please respect copyright.PENANArQLMRVVGr2
Range: bytes=243220480-39Please respect copyright.PENANAvsol5YyVFE
If-Match: "534231200_1732277116"39Please respect copyright.PENANAHUHIAsurgr
......39Please respect copyright.PENANAAUNoyfOs0Z
-------------------------------------39Please respect copyright.PENANA7AhLMnUbYF
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.39Please respect copyright.PENANAuYNMnXcbA8
'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:39Please respect copyright.PENANAbB2jW2jVUO
-------response content from resume point-------39Please respect copyright.PENANARsohhjE2Rc
HTTP/1.1 206 Partial Content39Please respect copyright.PENANACHGPVmcYkq
Date: Sat, 23 Nov 2024 06:56:17 GMT39Please respect copyright.PENANA2c7ycwllEn
accept-ranges: bytes39Please respect copyright.PENANAdwBuk8P3s5
content-range: bytes 243220480-534231199/53423120039Please respect copyright.PENANAGiWEZho65g
Content-Length: 29101072039Please respect copyright.PENANA5rVNmMFKl3
Content-Type: application/octet-stream39Please respect copyright.PENANAXueY3tu1fU
Content-Disposition: attachment; filename="zen.iso"39Please respect copyright.PENANAtdNpE2xP22
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)39Please respect copyright.PENANAnI9FjRd2L1
------------------------------------------------39Please respect copyright.PENANAOWub5UgZnO
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:39Please respect copyright.PENANA7ziyJvZvHx
-------response content from resume point-------39Please respect copyright.PENANAd84cXKvWt8
HTTP/1.1 200 OK39Please respect copyright.PENANAEyRBPjFROf
Date: Sat, 23 Nov 2024 06:29:19 GMT39Please respect copyright.PENANAzqU6b1uNR7
accept-ranges: bytes39Please respect copyright.PENANAVWhosB2irJ
content-range: bytes 0-634231201/63423120239Please respect copyright.PENANAp0WNkdEoEz
ETag: "634231202_2732277118"39Please respect copyright.PENANAiZXLE6KbqU
Content-Disposition: attachment; filename="zen.iso"39Please respect copyright.PENANAUnIQMD29ia
Content-Length: 63423120239Please respect copyright.PENANAX9VfzoYpLf
Content-Type: application/octet-stream
(http response body is the whole file content)39Please respect copyright.PENANAm6LBkG9ROM
------------------------------------------------39Please respect copyright.PENANAPhVtoVkxqd
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
39Please respect copyright.PENANAbS4Lzw6Mdr
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:39Please respect copyright.PENANAXZTAgIxiyr
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
39Please respect copyright.PENANA27ElGVVWGD
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示39Please respect copyright.PENANAjUG0NKcpSS
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助39Please respect copyright.PENANA3iWht7JvH4
https://gemini.google.com/
感谢互联网上无私奉献的参考资39Please respect copyright.PENANAiODZF2lDd3
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests39Please respect copyright.PENANAcHSncasH8j
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range39Please respect copyright.PENANAeSUAptdcEj
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag39Please respect copyright.PENANA2quZNC9QF4
https://www.rfc-editor.org/rfc/rfc723339Please respect copyright.PENANA3gNrqcFwdG
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
39Please respect copyright.PENANAQAtkh6i8cb
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.com39Please respect copyright.PENANAeRKhhfFFpQ
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: 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