本文描述了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:195Please respect copyright.PENANA5qqjWPXt8x
----------http range request-------195Please respect copyright.PENANACcnW8s10OY
GET /zen.iso HTTP/1.1195Please respect copyright.PENANASNS6xSRk6y
Range: bytes=100-1023195Please respect copyright.PENANAfABCkoWhLG
If-Match: "534231200_1732277116"195Please respect copyright.PENANA4HLeWUWXF7
......195Please respect copyright.PENANAGjXnFK4m5J
-----------------------------------195Please respect copyright.PENANAzZWGUPNwmU
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.
195Please respect copyright.PENANAniPHP2oNdK
Step 1. make a link for file to download, for example:195Please respect copyright.PENANAJFHBxCntnm
----------------html-----------------195Please respect copyright.PENANAEZFWIZ4U3G
<a href="/zen.iso">zen.iso</a>195Please respect copyright.PENANA2jqTwiSiNu
-------------------------------------195Please respect copyright.PENANAmiAeEwPyDg
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:195Please respect copyright.PENANAnqYVmF7jC9
----------get request------------195Please respect copyright.PENANA3ieUSlotI2
GET /zen.iso HTTP/1.1195Please respect copyright.PENANAYuMwEyxMpD
......195Please respect copyright.PENANARCDx9233lx
---------------------------------
195Please respect copyright.PENANAxZfpwhmPKt
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:195Please respect copyright.PENANAbWiEAKILwk
----------------server response--------------195Please respect copyright.PENANAc83hHqrJWj
HTTP/1.1 200 OK195Please respect copyright.PENANA8wtIZzCC5h
Date: Sat, 23 Nov 2024 06:29:19 GMT195Please respect copyright.PENANApQ2AD0GWZ2
accept-ranges: bytes195Please respect copyright.PENANAWfhtNqhcMN
content-range: bytes 0-534231199/534231200195Please respect copyright.PENANArGPFaDGEk2
ETag: "534231200_1732277116"195Please respect copyright.PENANACxtii5F3CC
Content-Disposition: attachment; filename="zen.iso"195Please respect copyright.PENANAhWUE8xq0eo
Content-Length: 534231200195Please respect copyright.PENANAvRVPvO1uHI
Content-Type: application/octet-stream
(http response body is the whole file content)195Please respect copyright.PENANA33SR31PFqt
-------------------------------------------
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:195Please respect copyright.PENANAQ2I3RMYk1A
---------------http server send big file content by multiple times--------------195Please respect copyright.PENANAQP1JRBghOI
const int buf_size=20000000; // buf size is about 20M195Please respect copyright.PENANAV1ed4b56dk
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers195Please respect copyright.PENANAIJuLOKRuwR
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 big195Please respect copyright.PENANA1bpDP0o76u
while(there_is_remain_file_content_to_send)195Please respect copyright.PENANAC8OCayGaMg
{ 195Please respect copyright.PENANAwm8ZfeoVc0
read_remain_file_content_to_send_buf(file, send_buf);195Please respect copyright.PENANAZEV78AMLhN
send_result = send(client_socket, send_buf);195Please respect copyright.PENANAdXqrVeI8ll
if(send_result == fail) return; else continue;195Please respect copyright.PENANA4BaiEIaDYN
}
// a way to make etag for a file using its file size and last modifed time195Please respect copyright.PENANAPGZeUa6Nmv
const char *file_etag(const char *path) 195Please respect copyright.PENANA9Mummmkztt
{195Please respect copyright.PENANA6QxLYIEwQY
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;195Please respect copyright.PENANAHaQZrnKvBN
}195Please respect copyright.PENANAr4F1eH24A1
-------------------------------------------------195Please respect copyright.PENANAOc5V1NhXVm
"accept-ranges: bytes" tells client web browser that the http server support range.195Please respect copyright.PENANAOD15v5IdW1
"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).195Please respect copyright.PENANA63bLj8kCl2
'ETag: "534231200_1732277116"' tells client web browser the file version.195Please respect copyright.PENANAR8ykjtiEuM
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.195Please respect copyright.PENANAC88gvA0lkO
"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.195Please respect copyright.PENANAJdYE68msFU
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
195Please respect copyright.PENANAiPbfBqaKpA
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.195Please respect copyright.PENANARazdTI3W9J
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.)195Please respect copyright.PENANAweoF8x0hrV
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.
195Please respect copyright.PENANAAYCcAUPN3A
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:195Please respect copyright.PENANAypdmLinV3u
---------resume range request---------195Please respect copyright.PENANAAYhW3XzYWs
GET /zen.iso HTTP/1.1195Please respect copyright.PENANAHskcG8tm9h
Range: bytes=243220480-195Please respect copyright.PENANA8isl9BC7bs
If-Match: "534231200_1732277116"195Please respect copyright.PENANA4tcIbBocSa
......195Please respect copyright.PENANAzmKFiOMYkG
-------------------------------------195Please respect copyright.PENANAwp4gzvCohf
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.195Please respect copyright.PENANAzRvPdtccS8
'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:195Please respect copyright.PENANAF8zpgpARQf
-------response content from resume point-------195Please respect copyright.PENANA5UZ5tkvDAS
HTTP/1.1 206 Partial Content195Please respect copyright.PENANA7gQAkz5lLp
Date: Sat, 23 Nov 2024 06:56:17 GMT195Please respect copyright.PENANATR53tvRSxi
accept-ranges: bytes195Please respect copyright.PENANA4qPOk8vlMT
content-range: bytes 243220480-534231199/534231200195Please respect copyright.PENANANx6adc93e7
Content-Length: 291010720195Please respect copyright.PENANA2PkalOU775
Content-Type: application/octet-stream195Please respect copyright.PENANAK1W2vGgty8
Content-Disposition: attachment; filename="zen.iso"195Please respect copyright.PENANAvzZnk3x38J
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)195Please respect copyright.PENANAcsvgjX9nsM
------------------------------------------------195Please respect copyright.PENANAYacTMjV4oh
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:195Please respect copyright.PENANAx2BDSHmJ0Z
-------response content from resume point-------195Please respect copyright.PENANAAaToMVhyto
HTTP/1.1 200 OK195Please respect copyright.PENANALyVvZri7eh
Date: Sat, 23 Nov 2024 06:29:19 GMT195Please respect copyright.PENANA8bjwuL9c9v
accept-ranges: bytes195Please respect copyright.PENANAs8S6BvkBxj
content-range: bytes 0-634231201/634231202195Please respect copyright.PENANAxha0UEb2Zt
ETag: "634231202_2732277118"195Please respect copyright.PENANAh4UGrhZLAs
Content-Disposition: attachment; filename="zen.iso"195Please respect copyright.PENANAkSf4SIq5PU
Content-Length: 634231202195Please respect copyright.PENANAV3MqN3jONg
Content-Type: application/octet-stream
(http response body is the whole file content)195Please respect copyright.PENANADanPLpLbKj
------------------------------------------------195Please respect copyright.PENANALEPPTFqdIh
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
195Please respect copyright.PENANAckH8FjprxC
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:195Please respect copyright.PENANAfcTsofABwB
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
195Please respect copyright.PENANAaTIFaD5mEa
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示195Please respect copyright.PENANAGwlQSFmuW4
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助195Please respect copyright.PENANA1QsFsEwcl4
https://gemini.google.com/
感谢互联网上无私奉献的参考资195Please respect copyright.PENANAIeUrPc04ty
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests195Please respect copyright.PENANAUx5GAm0wet
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range195Please respect copyright.PENANAgCzW8xk4hF
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag195Please respect copyright.PENANAFKXHF553rY
https://www.rfc-editor.org/rfc/rfc7233195Please respect copyright.PENANAOVfK1f5rRc
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
195Please respect copyright.PENANAX6vayNHClK
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]195Please respect copyright.PENANABQsUDU9LUI
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns216.73.216.146da2