本文描述了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:91Please respect copyright.PENANAvGHXZDM0NZ
----------http range request-------91Please respect copyright.PENANAyMGfuoN9BR
GET /zen.iso HTTP/1.191Please respect copyright.PENANAiNyDOoCup2
Range: bytes=100-102391Please respect copyright.PENANAgeRnsEmF7L
If-Match: "534231200_1732277116"91Please respect copyright.PENANAaeYBZvl6qy
......91Please respect copyright.PENANAcN9ghZLIZB
-----------------------------------91Please respect copyright.PENANABAdXXsz8fO
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.
91Please respect copyright.PENANAzrEpDmZpuw
Step 1. make a link for file to download, for example:91Please respect copyright.PENANA2Oxi1B42rD
----------------html-----------------91Please respect copyright.PENANAan0TIbQCp7
<a href="/zen.iso">zen.iso</a>91Please respect copyright.PENANApGNiOeYe7I
-------------------------------------91Please respect copyright.PENANAM9wGVsRsWQ
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:91Please respect copyright.PENANAXPkX01SEMG
----------get request------------91Please respect copyright.PENANA6rtI35A1mF
GET /zen.iso HTTP/1.191Please respect copyright.PENANAzb92y0svOJ
......91Please respect copyright.PENANAp9ZRplKzEW
---------------------------------
91Please respect copyright.PENANAkn2XiLaedj
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:91Please respect copyright.PENANAw6FrIp84Ff
----------------server response--------------91Please respect copyright.PENANA54i6nlQmXL
HTTP/1.1 200 OK91Please respect copyright.PENANAMxoGDfq7La
Date: Sat, 23 Nov 2024 06:29:19 GMT91Please respect copyright.PENANALmcvwmaz0m
accept-ranges: bytes91Please respect copyright.PENANAOuHcy76McJ
content-range: bytes 0-534231199/53423120091Please respect copyright.PENANAWPze7W2BXB
ETag: "534231200_1732277116"91Please respect copyright.PENANACnfSvulu48
Content-Disposition: attachment; filename="zen.iso"91Please respect copyright.PENANA1kVVqIOxvp
Content-Length: 53423120091Please respect copyright.PENANA5Z1NgNS24w
Content-Type: application/octet-stream
(http response body is the whole file content)91Please respect copyright.PENANAlLl9BT6bLm
-------------------------------------------
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:91Please respect copyright.PENANAQ1bqV6eY4p
---------------http server send big file content by multiple times--------------91Please respect copyright.PENANAyFZ2ttP41a
const int buf_size=20000000; // buf size is about 20M91Please respect copyright.PENANAA21KCDQQow
int client_socket; char send_buf[buf_size]; FILE *file;
// first send http response headers91Please respect copyright.PENANAuUwX9Nj80z
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 big91Please respect copyright.PENANA8bl7GiQXOL
while(there_is_remain_file_content_to_send)91Please respect copyright.PENANAidlnQOq83y
{ 91Please respect copyright.PENANA25MOHANtN8
read_remain_file_content_to_send_buf(file, send_buf);91Please respect copyright.PENANAVzmPD8l5R9
send_result = send(client_socket, send_buf);91Please respect copyright.PENANAnolqBCZKQh
if(send_result == fail) return; else continue;91Please respect copyright.PENANAEFhk2kf5Gb
}
// a way to make etag for a file using its file size and last modifed time91Please respect copyright.PENANABvRjT2N4o4
const char *file_etag(const char *path) 91Please respect copyright.PENANAK5ZIp0sXTK
{91Please respect copyright.PENANAFCZzHJ70QU
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;91Please respect copyright.PENANApehLI7nfgL
}91Please respect copyright.PENANAnBTNeQ0UOw
-------------------------------------------------91Please respect copyright.PENANAD2EanVceLG
"accept-ranges: bytes" tells client web browser that the http server support range.91Please respect copyright.PENANABrvanf0YD2
"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).91Please respect copyright.PENANAuMukz1JbEd
'ETag: "534231200_1732277116"' tells client web browser the file version.91Please respect copyright.PENANAVabpzxcIHC
'Content-Disposition: attachment; filename="zen.iso"' tells client web browser to download the file as attachment, and its file name.91Please respect copyright.PENANAJWpdtZJSZl
"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.91Please respect copyright.PENANAWV2iNMsdCW
"Content-Type: application/octet-stream" tells client web browser to treat the response body as binary stream.
91Please respect copyright.PENANAQNnN4SFJbs
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.91Please respect copyright.PENANA2bIVVe3p2X
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.)91Please respect copyright.PENANA3wUkygnzFL
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.
91Please respect copyright.PENANAtqFMfT4LQl
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:91Please respect copyright.PENANAYNa8lSks7T
---------resume range request---------91Please respect copyright.PENANAzoIy1oyeKf
GET /zen.iso HTTP/1.191Please respect copyright.PENANAnrKKpncQTP
Range: bytes=243220480-91Please respect copyright.PENANAW9zRdmxnGs
If-Match: "534231200_1732277116"91Please respect copyright.PENANA9FcFUC69FU
......91Please respect copyright.PENANAMGWbyLD26N
-------------------------------------91Please respect copyright.PENANAqzIxrYk71g
"Range: bytes=243220480-" tells the http server to send content from byte 243220480 to end.91Please respect copyright.PENANAJCqoIvATgU
'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:91Please respect copyright.PENANAC3Pds8lXFB
-------response content from resume point-------91Please respect copyright.PENANAZFHkaqrzCg
HTTP/1.1 206 Partial Content91Please respect copyright.PENANAQTVceWo8XJ
Date: Sat, 23 Nov 2024 06:56:17 GMT91Please respect copyright.PENANAFIsna95siV
accept-ranges: bytes91Please respect copyright.PENANArjAm47rcRt
content-range: bytes 243220480-534231199/53423120091Please respect copyright.PENANAZNSf5Fy0VL
Content-Length: 29101072091Please respect copyright.PENANA8XP5kvdMOF
Content-Type: application/octet-stream91Please respect copyright.PENANAp0yP5Qd2dk
Content-Disposition: attachment; filename="zen.iso"91Please respect copyright.PENANA7Mk19ovR4W
ETag: "534231200_1732277116"
(http response body is the file content from resume point to end)91Please respect copyright.PENANAklTnymMlLP
------------------------------------------------91Please respect copyright.PENANA6WeDlsREhC
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:91Please respect copyright.PENANA7U1XWbGUP4
-------response content from resume point-------91Please respect copyright.PENANAKtpSvqPGT2
HTTP/1.1 200 OK91Please respect copyright.PENANABo7PJXSsCj
Date: Sat, 23 Nov 2024 06:29:19 GMT91Please respect copyright.PENANAJI7y8YEJhg
accept-ranges: bytes91Please respect copyright.PENANAAS4pNpslDZ
content-range: bytes 0-634231201/63423120291Please respect copyright.PENANAr8yMNDqElt
ETag: "634231202_2732277118"91Please respect copyright.PENANAazDRK0AjBy
Content-Disposition: attachment; filename="zen.iso"91Please respect copyright.PENANAWiDeqlLd5j
Content-Length: 63423120291Please respect copyright.PENANAALoNMydyds
Content-Type: application/octet-stream
(http response body is the whole file content)91Please respect copyright.PENANADpQ9gRRqaK
------------------------------------------------91Please respect copyright.PENANAryabNMd6kE
When client download manager receives this response, it will clear the already downloaded content and start download from beginning.
91Please respect copyright.PENANAS7k7Z0rXXW
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:91Please respect copyright.PENANAxn9nR3bh0J
https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/?
91Please respect copyright.PENANA6gHLLNDjxt
Section C. Thanks
感謝曾旭的幫助,曾旭的文章对http range有非常好的描述。
感谢stackoverflow对使用etag的提示91Please respect copyright.PENANAkQe03vc87x
https://stackoverflow.com/questions/66998172/does-google-chrome-and-similar-browsers-support-range-headers-for-standard-downl
感谢gemini等ai对写代码的辅助91Please respect copyright.PENANA1NsjQztSgC
https://gemini.google.com/
感谢互联网上无私奉献的参考资91Please respect copyright.PENANA3M1TqgqAXh
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests91Please respect copyright.PENANAm76yqU0Hsd
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range91Please respect copyright.PENANAqtHjwmYiWK
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag91Please respect copyright.PENANA7oziGUIFVX
https://www.rfc-editor.org/rfc/rfc723391Please respect copyright.PENANAbu184rVeYg
https://mirrors.tuna.tsinghua.edu.cn/ubuntu-releases/24.10/
91Please respect copyright.PENANAUwYN2eRdVr
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]91Please respect copyright.PENANAnzSUY4YRZs
如果您发现本文有任何错误,或者对本文有好的建议,欢迎与我联系探讨,我的微信: si_jinmin, 我的email: [email protected]
如果您對C/C++ programming, Linux, website development, Vue, Git, vscode感興趣,邀請您加入「Linux/C/C++ Website Development」 微信群,請加我的微信(si_jinmin)以便拉您进群。
ns3.141.167.59da2