Mercurial > hg > orthanc
annotate OrthancFramework/Sources/Compression/ZipReader.cpp @ 4362:88be8b67b2d7
cont
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 08 Dec 2020 20:22:24 +0100 |
parents | 4301722b3225 |
children | 1382c908d67c |
rev | line source |
---|---|
4355 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium | |
6 * | |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU Lesser General Public License | |
9 * as published by the Free Software Foundation, either version 3 of | |
10 * the License, or (at your option) any later version. | |
11 * | |
12 * This program is distributed in the hope that it will be useful, but | |
13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 * Lesser General Public License for more details. | |
16 * | |
17 * You should have received a copy of the GNU Lesser General Public | |
18 * License along with this program. If not, see | |
19 * <http://www.gnu.org/licenses/>. | |
20 **/ | |
21 | |
22 | |
23 #include "../PrecompiledHeaders.h" | |
24 | |
25 #ifndef NOMINMAX | |
26 #define NOMINMAX | |
27 #endif | |
28 | |
29 #include "ZipReader.h" | |
30 | |
31 #include "../OrthancException.h" | |
32 #include "../../Resources/ThirdParty/minizip/unzip.h" | |
33 | |
34 #if ORTHANC_SANDBOXED != 1 | |
35 # include "../SystemToolbox.h" | |
36 #endif | |
37 | |
4359
074f37013186
fix ZipReader.cpp for msvc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4356
diff
changeset
|
38 #if defined(_MSC_VER) |
4360 | 39 # include <BaseTsd.h> // Definition of SSIZE_T |
4362 | 40 // typedef SSIZE_T ssize_t; |
4359
074f37013186
fix ZipReader.cpp for msvc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4356
diff
changeset
|
41 #endif |
074f37013186
fix ZipReader.cpp for msvc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4356
diff
changeset
|
42 |
4355 | 43 #include <string.h> |
44 | |
45 | |
46 namespace Orthanc | |
47 { | |
48 // ZPOS64_T corresponds to "uint64_t" | |
49 | |
50 class ZipReader::MemoryBuffer : public boost::noncopyable | |
51 { | |
52 private: | |
53 const uint8_t* content_; | |
54 size_t size_; | |
55 size_t pos_; | |
56 | |
57 public: | |
58 MemoryBuffer(const void* p, | |
59 size_t size) : | |
60 content_(reinterpret_cast<const uint8_t*>(p)), | |
61 size_(size), | |
62 pos_(0) | |
63 { | |
64 } | |
65 | |
4356 | 66 explicit MemoryBuffer(const std::string& s) : |
4355 | 67 content_(s.empty() ? NULL : reinterpret_cast<const uint8_t*>(s.c_str())), |
68 size_(s.size()), | |
69 pos_(0) | |
70 { | |
71 } | |
72 | |
73 // Returns the number of bytes actually read | |
74 uLong Read(void *target, | |
75 uLong size) | |
76 { | |
77 if (size <= 0) | |
78 { | |
79 return 0; | |
80 } | |
81 else | |
82 { | |
83 size_t s = static_cast<size_t>(size); | |
84 if (s + pos_ > size_) | |
85 { | |
86 s = size_ - pos_; | |
87 } | |
88 | |
89 if (s != 0) | |
90 { | |
91 memcpy(target, content_ + pos_, s); | |
92 } | |
93 | |
94 pos_ += s; | |
4360 | 95 return static_cast<uLong>(s); |
4355 | 96 } |
97 } | |
98 | |
99 ZPOS64_T Tell() const | |
100 { | |
101 return static_cast<ZPOS64_T>(pos_); | |
102 } | |
103 | |
104 long Seek(ZPOS64_T offset, | |
105 int origin) | |
106 { | |
107 ssize_t next; | |
108 | |
109 switch (origin) | |
110 { | |
111 case ZLIB_FILEFUNC_SEEK_CUR: | |
112 next = static_cast<ssize_t>(offset) + static_cast<ssize_t>(pos_); | |
113 break; | |
114 | |
115 case ZLIB_FILEFUNC_SEEK_SET: | |
116 next = static_cast<ssize_t>(offset); | |
117 break; | |
118 | |
119 case ZLIB_FILEFUNC_SEEK_END: | |
120 next = static_cast<ssize_t>(offset) + static_cast<ssize_t>(size_); | |
121 break; | |
122 | |
123 default: // Should never occur | |
124 return 1; // Error | |
125 } | |
126 | |
127 if (next < 0) | |
128 { | |
129 pos_ = 0; | |
130 } | |
131 else if (next >= static_cast<long>(size_)) | |
132 { | |
133 pos_ = size_; | |
134 } | |
135 else | |
136 { | |
137 pos_ = static_cast<long>(next); | |
138 } | |
139 | |
140 return 0; | |
141 } | |
142 | |
143 | |
144 static voidpf OpenWrapper(voidpf opaque, | |
145 const void* filename, | |
146 int mode) | |
147 { | |
148 // Don't return NULL to make "unzip.c" happy | |
149 return opaque; | |
150 } | |
151 | |
152 static uLong ReadWrapper(voidpf opaque, | |
153 voidpf stream, | |
154 void* buf, | |
155 uLong size) | |
156 { | |
157 assert(opaque != NULL); | |
158 return reinterpret_cast<MemoryBuffer*>(opaque)->Read(buf, size); | |
159 } | |
160 | |
161 static ZPOS64_T TellWrapper(voidpf opaque, | |
162 voidpf stream) | |
163 { | |
164 assert(opaque != NULL); | |
165 return reinterpret_cast<MemoryBuffer*>(opaque)->Tell(); | |
166 } | |
167 | |
168 static long SeekWrapper(voidpf opaque, | |
169 voidpf stream, | |
170 ZPOS64_T offset, | |
171 int origin) | |
172 { | |
173 assert(opaque != NULL); | |
174 return reinterpret_cast<MemoryBuffer*>(opaque)->Seek(offset, origin); | |
175 } | |
176 | |
177 static int CloseWrapper(voidpf opaque, | |
178 voidpf stream) | |
179 { | |
180 return 0; | |
181 } | |
182 | |
183 static int TestErrorWrapper(voidpf opaque, | |
184 voidpf stream) | |
185 { | |
186 return 0; // ?? | |
187 } | |
188 }; | |
189 | |
190 | |
191 | |
192 ZipReader* ZipReader::CreateFromMemory(const std::string& buffer) | |
193 { | |
194 if (buffer.empty()) | |
195 { | |
196 return CreateFromMemory(NULL, 0); | |
197 } | |
198 else | |
199 { | |
200 return CreateFromMemory(buffer.c_str(), buffer.size()); | |
201 } | |
202 } | |
203 | |
204 | |
205 bool ZipReader::IsZipMemoryBuffer(const void* buffer, | |
206 size_t size) | |
207 { | |
208 if (size < 4) | |
209 { | |
210 return false; | |
211 } | |
212 else | |
213 { | |
214 const uint8_t* c = reinterpret_cast<const uint8_t*>(buffer); | |
215 return (c[0] == 0x50 && // 'P' | |
216 c[1] == 0x4b && // 'K' | |
217 ((c[2] == 0x03 && c[3] == 0x04) || | |
218 (c[2] == 0x05 && c[3] == 0x06) || | |
219 (c[2] == 0x07 && c[3] == 0x08))); | |
220 } | |
221 } | |
222 | |
223 | |
224 bool ZipReader::IsZipMemoryBuffer(const std::string& content) | |
225 { | |
226 if (content.empty()) | |
227 { | |
228 return false; | |
229 } | |
230 else | |
231 { | |
232 return IsZipMemoryBuffer(content.c_str(), content.size()); | |
233 } | |
234 } | |
235 | |
236 | |
237 #if ORTHANC_SANDBOXED != 1 | |
238 bool ZipReader::IsZipFile(const std::string& path) | |
239 { | |
240 std::string content; | |
241 SystemToolbox::ReadFileRange(content, path, 0, 4, | |
242 false /* don't throw if file is too small */); | |
243 | |
244 return IsZipMemoryBuffer(content); | |
245 } | |
246 #endif | |
247 | |
248 | |
249 struct ZipReader::PImpl | |
250 { | |
251 unzFile unzip_; | |
252 std::unique_ptr<MemoryBuffer> reader_; | |
253 bool done_; | |
254 | |
255 PImpl() : | |
256 unzip_(NULL), | |
257 done_(true) | |
258 { | |
259 } | |
260 }; | |
261 | |
262 | |
263 ZipReader::ZipReader() : | |
264 pimpl_(new PImpl) | |
265 { | |
266 } | |
267 | |
268 | |
269 ZipReader::~ZipReader() | |
270 { | |
271 if (pimpl_->unzip_ != NULL) | |
272 { | |
273 unzClose(pimpl_->unzip_); | |
274 pimpl_->unzip_ = NULL; | |
275 } | |
276 } | |
277 | |
278 | |
279 uint64_t ZipReader::GetFilesCount() const | |
280 { | |
281 assert(pimpl_->unzip_ != NULL); | |
282 | |
283 unz_global_info64_s info; | |
284 | |
285 if (unzGetGlobalInfo64(pimpl_->unzip_, &info) == 0) | |
286 { | |
287 return info.number_entry; | |
288 } | |
289 else | |
290 { | |
291 throw OrthancException(ErrorCode_BadFileFormat); | |
292 } | |
293 } | |
294 | |
295 | |
296 void ZipReader::SeekFirst() | |
297 { | |
298 assert(pimpl_->unzip_ != NULL); | |
299 pimpl_->done_ = (unzGoToFirstFile(pimpl_->unzip_) != 0); | |
300 } | |
301 | |
302 | |
303 bool ZipReader::ReadNextFile(std::string& filename, | |
304 std::string& content) | |
305 { | |
306 assert(pimpl_->unzip_ != NULL); | |
307 | |
308 if (pimpl_->done_) | |
309 { | |
310 return false; | |
311 } | |
312 else | |
313 { | |
314 unz_file_info64_s info; | |
315 if (unzGetCurrentFileInfo64(pimpl_->unzip_, &info, NULL, 0, NULL, 0, NULL, 0) != 0) | |
316 { | |
317 throw OrthancException(ErrorCode_BadFileFormat); | |
318 } | |
319 | |
320 filename.resize(info.size_filename); | |
321 if (!filename.empty() && | |
4360 | 322 unzGetCurrentFileInfo64(pimpl_->unzip_, &info, &filename[0], |
323 static_cast<uLong>(filename.size()), NULL, 0, NULL, 0) != 0) | |
4355 | 324 { |
325 throw OrthancException(ErrorCode_BadFileFormat); | |
326 } | |
327 | |
328 content.resize(info.uncompressed_size); | |
329 | |
330 if (!content.empty()) | |
331 { | |
332 if (unzOpenCurrentFile(pimpl_->unzip_) == 0) | |
333 { | |
4360 | 334 bool success = (unzReadCurrentFile(pimpl_->unzip_, &content[0], |
335 static_cast<uLong>(content.size())) != 0); | |
4355 | 336 |
337 if (unzCloseCurrentFile(pimpl_->unzip_) != 0 || | |
338 !success) | |
339 { | |
340 throw OrthancException(ErrorCode_BadFileFormat); | |
341 } | |
342 } | |
343 else | |
344 { | |
345 throw OrthancException(ErrorCode_BadFileFormat); | |
346 } | |
347 } | |
348 | |
349 pimpl_->done_ = (unzGoToNextFile(pimpl_->unzip_) != 0); | |
350 | |
351 return true; | |
352 } | |
353 } | |
354 | |
355 | |
356 ZipReader* ZipReader::CreateFromMemory(const void* buffer, | |
357 size_t size) | |
358 { | |
359 if (!IsZipMemoryBuffer(buffer, size)) | |
360 { | |
361 throw OrthancException(ErrorCode_BadFileFormat, "The memory buffer doesn't contain a ZIP archive"); | |
362 } | |
363 else | |
364 { | |
365 std::unique_ptr<ZipReader> reader(new ZipReader); | |
366 | |
367 reader->pimpl_->reader_.reset(new MemoryBuffer(buffer, size)); | |
368 if (reader->pimpl_->reader_.get() == NULL) | |
369 { | |
370 throw OrthancException(ErrorCode_InternalError); | |
371 } | |
372 | |
373 zlib_filefunc64_def funcs; | |
374 memset(&funcs, 0, sizeof(funcs)); | |
375 | |
376 funcs.opaque = reader->pimpl_->reader_.get(); | |
377 funcs.zopen64_file = MemoryBuffer::OpenWrapper; | |
378 funcs.zread_file = MemoryBuffer::ReadWrapper; | |
379 funcs.ztell64_file = MemoryBuffer::TellWrapper; | |
380 funcs.zseek64_file = MemoryBuffer::SeekWrapper; | |
381 funcs.zclose_file = MemoryBuffer::CloseWrapper; | |
382 funcs.zerror_file = MemoryBuffer::TestErrorWrapper; | |
383 | |
384 reader->pimpl_->unzip_ = unzOpen2_64(NULL, &funcs); | |
385 if (reader->pimpl_->unzip_ == NULL) | |
386 { | |
387 throw OrthancException(ErrorCode_BadFileFormat, "Cannot open ZIP archive from memory buffer"); | |
388 } | |
389 else | |
390 { | |
391 reader->SeekFirst(); | |
392 return reader.release(); | |
393 } | |
394 } | |
395 } | |
396 | |
397 | |
398 #if ORTHANC_SANDBOXED != 1 | |
399 ZipReader* ZipReader::CreateFromFile(const std::string& path) | |
400 { | |
401 if (!IsZipFile(path)) | |
402 { | |
403 throw OrthancException(ErrorCode_BadFileFormat, "The file doesn't contain a ZIP archive: " + path); | |
404 } | |
405 else | |
406 { | |
407 std::unique_ptr<ZipReader> reader(new ZipReader); | |
408 | |
409 reader->pimpl_->unzip_ = unzOpen64(path.c_str()); | |
410 if (reader->pimpl_->unzip_ == NULL) | |
411 { | |
412 throw OrthancException(ErrorCode_BadFileFormat, "Cannot open ZIP archive from file: " + path); | |
413 } | |
414 else | |
415 { | |
416 reader->SeekFirst(); | |
417 return reader.release(); | |
418 } | |
419 } | |
420 } | |
421 #endif | |
422 } |