38fd60b920b618479de168ebb7f4e296daee8598
[WebKit-https.git] / Source / WebCore / platform / network / win / DownloadBundleWin.cpp
1 /*
2  * Copyright (C) 2011 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "DownloadBundle.h"
28
29 #include <io.h>
30 #include <sys/stat.h>
31 #include <sys/types.h>
32 #include <wtf/text/CString.h>
33 #include <wtf/text/WTFString.h>
34 #include <wtf/text/win/WCharStringExtras.h>
35
36 namespace WebCore {
37
38 namespace DownloadBundle {
39
40 static uint32_t magicNumber()
41 {
42     return 0xDECAF4EA;
43 }
44
45 const String& fileExtension()
46 {
47     static const NeverDestroyed<String> extension { ".download"_s };
48     return extension;
49 }
50
51 bool appendResumeData(const char* resumeBytes, uint32_t resumeLength, const String& bundlePath)
52 {
53     if (!resumeBytes || !resumeLength) {
54         LOG_ERROR("Invalid resume data to write to bundle path");
55         return false;
56     }
57     if (bundlePath.isEmpty()) {
58         LOG_ERROR("Cannot write resume data to empty download bundle path");
59         return false;
60     }
61
62     String nullifiedPath = bundlePath;
63     FILE* bundle = 0;
64     if (_wfopen_s(&bundle, stringToNullTerminatedWChar(nullifiedPath).data(), TEXT("ab")) || !bundle) {
65         LOG_ERROR("Failed to open file %s to append resume data", bundlePath.ascii().data());
66         return false;
67     }
68
69     bool result = false;
70
71     if (fwrite(resumeBytes, 1, resumeLength, bundle) != resumeLength) {
72         LOG_ERROR("Failed to write resume data to the bundle - errno(%i)", errno);
73         goto exit;
74     }
75
76     if (fwrite(&resumeLength, 4, 1, bundle) != 1) {
77         LOG_ERROR("Failed to write footer length to the bundle - errno(%i)", errno);
78         goto exit;
79     }
80
81     const uint32_t magic = magicNumber();
82     if (fwrite(&magic, 4, 1, bundle) != 1) {
83         LOG_ERROR("Failed to write footer magic number to the bundle - errno(%i)", errno);
84         goto exit;
85     }
86
87     result = true;
88 exit:
89     fclose(bundle);
90     return result;
91 }
92
93 bool extractResumeData(const String& bundlePath, Vector<char>& resumeData)
94 {
95     if (bundlePath.isEmpty()) {
96         LOG_ERROR("Cannot create resume data from empty download bundle path");
97         return false;
98     }
99
100     // Open a handle to the bundle file
101     String nullifiedPath = bundlePath;
102     FILE* bundle = 0;
103     if (_wfopen_s(&bundle, stringToNullTerminatedWChar(nullifiedPath).data(), TEXT("r+b")) || !bundle) {
104         LOG_ERROR("Failed to open file %s to get resume data", bundlePath.ascii().data());
105         return false;
106     }
107
108     bool result = false;
109
110     // Stat the file to get its size
111     struct _stat64 fileStat;
112     if (_fstat64(_fileno(bundle), &fileStat))
113         goto exit;
114
115     // Check for the bundle magic number at the end of the file
116     fpos_t footerMagicNumberPosition = fileStat.st_size - 4;
117     ASSERT(footerMagicNumberPosition >= 0);
118     if (footerMagicNumberPosition < 0)
119         goto exit;
120     if (fsetpos(bundle, &footerMagicNumberPosition))
121         goto exit;
122
123     uint32_t footerMagicNumber = 0;
124     if (fread(&footerMagicNumber, 4, 1, bundle) != 1) {
125         LOG_ERROR("Failed to read footer magic number from the bundle - errno(%i)", errno);
126         goto exit;
127     }
128
129     if (footerMagicNumber != magicNumber()) {
130         LOG_ERROR("Footer's magic number does not match 0x%X - errno(%i)", magicNumber(), errno);
131         goto exit;
132     }
133
134     // Now we're *reasonably* sure this is a .download bundle we actually wrote.
135     // Get the length of the resume data
136     fpos_t footerLengthPosition = fileStat.st_size - 8;
137     ASSERT(footerLengthPosition >= 0);
138     if (footerLengthPosition < 0)
139         goto exit;
140
141     if (fsetpos(bundle, &footerLengthPosition))
142         goto exit;
143
144     uint32_t footerLength = 0;
145     if (fread(&footerLength, 4, 1, bundle) != 1) {
146         LOG_ERROR("Failed to read ResumeData length from the bundle - errno(%i)", errno);
147         goto exit;
148     }
149
150     // Make sure theres enough bytes to read in for the resume data, and perform the read
151     fpos_t footerStartPosition = fileStat.st_size - 8 - footerLength;
152     ASSERT(footerStartPosition >= 0);
153     if (footerStartPosition < 0)
154         goto exit;
155     if (fsetpos(bundle, &footerStartPosition))
156         goto exit;
157
158     resumeData.resize(footerLength);
159     if (fread(resumeData.data(), 1, footerLength, bundle) != footerLength) {
160         LOG_ERROR("Failed to read ResumeData from the bundle - errno(%i)", errno);
161         goto exit;
162     }
163
164     // CFURLDownload will seek to the appropriate place in the file (before our footer) and start overwriting from there
165     // However, say we were within a few hundred bytes of the end of a download when it was paused -
166     // The additional footer extended the length of the file beyond its final length, and there will be junk data leftover
167     // at the end.  Therefore, now that we've retrieved the footer data, we need to truncate it.
168     if (errno_t resizeError = _chsize_s(_fileno(bundle), footerStartPosition)) {
169         LOG_ERROR("Failed to truncate the resume footer off the end of the file - errno(%i)", resizeError);
170         goto exit;
171     }
172
173     result = true;
174 exit:
175     fclose(bundle);
176     return result;
177 }
178
179 } // namespace DownloadBundle
180
181 } // namespace WebCore