本文描述了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:83Please respect copyright.PENANAZsuBUuV4A8
----------http range request-------83Please respect copyright.PENANAJcfo42G2Mn
GET /zen.iso HTTP/1.183Please respect copyright.PENANA1929rZbZxx
Range: bytes=100-102383Please respect copyright.PENANA0rI85DgeaF
If-Match: "534231200_1732277116"83Please respect copyright.PENANAfljXg5f7hZ
......83Please respect copyright.PENANAEzGXAHRhXc
-----------------------------------83Please respect copyright.PENANAztOOi4qPkx
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.
83Please respect copyright.PENANAFxONBgPuuk
Step 1. make a link for file to download, for example:83Please respect copyright.PENANAbYtNI1OXov
----------------html-----------------83Please respect copyright.PENANAF8KgNf5JDY
<a href="/zen.iso">zen.iso</a>83Please respect copyright.PENANA6wxiwZVJ5j
-------------------------------------83Please respect copyright.PENANAw4h1pNgXxk
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:83Please respect copyright.PENANAWKeO9UE0kr
----------get request------------83Please respect copyright.PENANAnegagoLvNS
GET /zen.iso HTTP/1.183Please respect copyright.PENANAr28aGJLuxH
......83Please respect copyright.PENANA4d2GoqTpY3
---------------------------------
83Please respect copyright.PENANAS6gVRGrKoq
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:83Please respect copyright.PENANANiX7pIqs2B
----------------server response--------------83Please respect copyright.PENANAHBHnHSfgJU
HTTP/1.1 200 OK83Please respect copyright.PENANAdxXHbTkprZ
Date: Sat, 23 Nov 2024 06:29:19 GMT83Please respect copyright.PENANA7zxMbldbZn
accept-ranges: bytes83Please respect copyright.PENANAP5DKD2FiC4
content-range: bytes 0-534231199/53423120083Please respect copyright.PENANAYbB6mV5mGd
ETag: "534231200_1732277116"83Please respect copyright.PENANA4vzfUkTAr5
Content-Disposition: attachment; filename="zen.iso"83Please respect copyright.PENANAnoItDscEFI
Content-Length: 53423120083Please respect copyright.PENANAnO1tspbygB
Content-Type: application/octet-stream
(http response body is the whole file content)83Please respect copyright.PENANAVaNt9u9JYS
-------------------------------------------
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:83Please respect copyright.PENANAEghgKtKYUc
---------------http server send big file content by multiple times--------------83Please respect copyright.PENANAwHE27YgjGM
const int buf_size=20000000; // buf size is about 20M83Please respect copyright.PENANA8sAgI9AqUq
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers83Please respect copyright.PENANAzO4gekcF4R
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 big83Please respect copyright.PENANAK2YYJV4fAr
while(there_is_remain_file_content_to_send)83Please respect copyright.PENANAVnlJR8zTod
{ 83Please respect copyright.PENANAmxjLS14cla
read_remain_file_content_to_send_buf(file, send_buf);83Please respect copyright.PENANATT3LBOVGaH
send_result = send(client_socket, send_buf);83Please respect copyright.PENANAe7lKItoYtv
if(send_result == fail) return; else continue;83Please respect copyright.PENANABcx5NMMB8g
}
// a way to make etag for a file using its file size and last modifed time83Please respect copyright.PENANAytJxnqYmaX
const char *file_etag(const char *path) 83Please respect copyright.PENANA2yw5Vbz2ub
{83Please respect copyright.PENANAad3NSFV41y
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;83Please respect copyright.PENANA6ndZQiCsT6
}83Please respect copyright.PENANARiXuW0QEgm
-------------------------------------------------83Please respect copyright.PENANA0d2hd0j4xO
"accept-ranges: bytes" tells client web browser that the http server support range.83Please respect copyright.PENANApUlLN0r6Be
"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).83Please respect copyright.PENANAx26EY1HINb
'ETag: "534231200_1732277116"' tells client web browser the file version.83Please respect copyright.PENANAbhIU8saNEa
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.83Please respect copyright.PENANAjiQzeLwrbn
"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.83Please respect copyright.PENANAmn4wxJQcp2
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
83Please respect copyright.PENANAb30WN7hw0O
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.83Please respect copyright.PENANAZMb5GVC3Cv
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.)83Please respect copyright.PENANAW2c7MHH30B
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.
83Please respect copyright.PENANAn9O06crnGx
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:83Please respect copyright.PENANA3icYFajf5O
---------resume range request---------83Please respect copyright.PENANAOkfKHtDPXJ
GET /zen.iso HTTP/1.183Please respect copyright.PENANAoBgbk3foiU
Range: bytes=243220480-83Please respect copyright.PENANA24OSY3XOMM
If-Match: "534231200_1732277116"83Please respect copyright.PENANAL3AnUIwioH
......83Please respect copyright.PENANA0spShuPbe7
-------------------------------------83Please respect copyright.PENANAqXZH4PDnYR
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.83Please respect copyright.PENANA8bFOs0cW2r
'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:83Please respect copyright.PENANANqfZQ5RJRv
-------response content from resume point-------83Please respect copyright.PENANA3HkJBQoozl
HTTP/1.1 206 Partial Content83Please respect copyright.PENANARrD596ppxk
Date: Sat, 23 Nov 2024 06:56:17 GMT83Please respect copyright.PENANAn7U0rCuJJQ
accept-ranges: bytes83Please respect copyright.PENANATNqSzv3ePT
content-range: bytes 243220480-534231199/53423120083Please respect copyright.PENANAtpCuLthW0k
Content-Length: 29101072083Please respect copyright.PENANA2CqAMRx8Y8
Content-Type: application/octet-stream83Please respect copyright.PENANAWQts1Rm1HK
Content-Disposition: attachment; filename="zen.iso"83Please respect copyright.PENANAiwSgzeIAMc
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)83Please respect copyright.PENANAfDMJdTX2Yu
------------------------------------------------83Please respect copyright.PENANAV1CcfcxIz6
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:83Please respect copyright.PENANAW2RZKoW2D3
-------response content from resume point-------83Please respect copyright.PENANA8mOhyqxrVA
HTTP/1.1 200 OK83Please respect copyright.PENANAhw34usvVpB
Date: Sat, 23 Nov 2024 06:29:19 GMT83Please respect copyright.PENANAVgwRn5AaSL
accept-ranges: bytes83Please respect copyright.PENANAO0YuEqHhx5
content-range: bytes 0-634231201/63423120283Please respect copyright.PENANAFNN2bYlxTG
ETag: "634231202_2732277118"83Please respect copyright.PENANANwNqK1gO68
Content-Disposition: attachment; filename="zen.iso"83Please respect copyright.PENANAE7cbZLVaxg
Content-Length: 63423120283Please respect copyright.PENANA6IjILynKVk
Content-Type: application/octet-stream
(http response body is the whole file content)83Please respect copyright.PENANAMadYmlngMV
------------------------------------------------83Please respect copyright.PENANArJOdnWxuCv
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
83Please respect copyright.PENANAkPJpFknoll
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:83Please respect copyright.PENANAVeHPU7Jmjo
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
83Please respect copyright.PENANATAn2AMyaAi
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示83Please respect copyright.PENANA4mQIXTMbaR
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助83Please respect copyright.PENANAY0Ry8HBPPf
https://gemini.google.com/
感谢互联网上无私奉献的参考资83Please respect copyright.PENANAYtdG73Wyyk
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests83Please respect copyright.PENANARGlqFRNwH8
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range83Please respect copyright.PENANA4eRddiMOFi
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag83Please respect copyright.PENANA2jhg7YqjGE
https://www.rfc-editor.org/rfc/rfc723383Please respect copyright.PENANAfZkvb0w6lQ
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
83Please respect copyright.PENANAUGQ5hghISU
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]83Please respect copyright.PENANAExvnbH9jYC
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns3.15.211.199da2