464ca711ea43a3dbb7dda4d87b3a4d9a8e0b20ec
[wimlib] / src / resource.c
1 /*
2  * resource.c
3  *
4  * Read uncompressed and compressed metadata and file resources from a WIM file.
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free Software
14  * Foundation; either version 3 of the License, or (at your option) any later
15  * version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License along with
22  * wimlib; if not, see http://www.gnu.org/licenses/.
23  */
24
25 #include "wimlib_internal.h"
26 #include "dentry.h"
27 #include "lookup_table.h"
28 #include "buffer_io.h"
29 #include "sha1.h"
30
31 #ifdef __WIN32__
32 #  include "win32.h"
33 #endif
34
35 #include <errno.h>
36 #include <stdarg.h>
37 #include <stdlib.h>
38 #include <unistd.h>
39 #include <fcntl.h>
40
41 #ifdef HAVE_ALLOCA_H
42 #  include <alloca.h>
43 #endif
44
45 /*
46  * Reads all or part of a compressed WIM resource.
47  *
48  * Returns zero on success, nonzero on failure.
49  */
50 static int
51 read_compressed_resource(filedes_t in_fd,
52                          u64 resource_compressed_size,
53                          u64 resource_uncompressed_size,
54                          u64 resource_offset,
55                          int resource_ctype,
56                          u64 len,
57                          u64 offset,
58                          consume_data_callback_t cb,
59                          void *ctx_or_buf)
60 {
61         int ret;
62
63         /* Trivial case */
64         if (len == 0)
65                 return 0;
66
67         int (*decompress)(const void *, unsigned, void *, unsigned);
68         /* Set the appropriate decompress function. */
69         if (resource_ctype == WIMLIB_COMPRESSION_TYPE_LZX)
70                 decompress = wimlib_lzx_decompress;
71         else
72                 decompress = wimlib_xpress_decompress;
73
74         /* The structure of a compressed resource consists of a table of chunk
75          * offsets followed by the chunks themselves.  Each chunk consists of
76          * compressed data, and there is one chunk for each WIM_CHUNK_SIZE =
77          * 32768 bytes of the uncompressed file, with the last chunk having any
78          * remaining bytes.
79          *
80          * The chunk offsets are measured relative to the end of the chunk
81          * table.  The first chunk is omitted from the table in the WIM file
82          * because its offset is implicitly given by the fact that it directly
83          * follows the chunk table and therefore must have an offset of 0.
84          */
85
86         /* Calculate how many chunks the resource consists of in its entirety.
87          * */
88         u64 num_chunks = (resource_uncompressed_size + WIM_CHUNK_SIZE - 1) /
89                                                                 WIM_CHUNK_SIZE;
90         /* As mentioned, the first chunk has no entry in the chunk table. */
91         u64 num_chunk_entries = num_chunks - 1;
92
93
94         /* The index of the chunk that the read starts at. */
95         u64 start_chunk = offset / WIM_CHUNK_SIZE;
96         /* The byte offset at which the read starts, within the start chunk. */
97         u64 start_chunk_offset = offset % WIM_CHUNK_SIZE;
98
99         /* The index of the chunk that contains the last byte of the read. */
100         u64 end_chunk   = (offset + len - 1) / WIM_CHUNK_SIZE;
101         /* The byte offset of the last byte of the read, within the end chunk */
102         u64 end_chunk_offset = (offset + len - 1) % WIM_CHUNK_SIZE;
103
104         /* Number of chunks that are actually needed to read the requested part
105          * of the file. */
106         u64 num_needed_chunks = end_chunk - start_chunk + 1;
107
108         /* If the end chunk is not the last chunk, an extra chunk entry is
109          * needed because we need to know the offset of the chunk after the last
110          * chunk read to figure out the size of the last read chunk. */
111         if (end_chunk != num_chunks - 1)
112                 num_needed_chunks++;
113
114         /* Allocate the chunk table.  It will only contain offsets for the
115          * chunks that are actually needed for this read. */
116         u64 *chunk_offsets;
117         bool chunk_offsets_malloced;
118         if (num_needed_chunks < 1000) {
119                 chunk_offsets = alloca(num_needed_chunks * sizeof(u64));
120                 chunk_offsets_malloced = false;
121         } else {
122                 chunk_offsets = malloc(num_needed_chunks * sizeof(u64));
123                 if (!chunk_offsets) {
124                         ERROR("Failed to allocate chunk table "
125                               "with %"PRIu64" entries", num_needed_chunks);
126                         return WIMLIB_ERR_NOMEM;
127                 }
128                 chunk_offsets_malloced = true;
129         }
130
131         /* Set the implicit offset of the first chunk if it is included in the
132          * needed chunks.
133          *
134          * Note: M$'s documentation includes a picture that shows the first
135          * chunk starting right after the chunk entry table, labeled as offset
136          * 0x10.  However, in the actual file format, the offset is measured
137          * from the end of the chunk entry table, so the first chunk has an
138          * offset of 0. */
139         if (start_chunk == 0)
140                 chunk_offsets[0] = 0;
141
142         /* According to M$'s documentation, if the uncompressed size of
143          * the file is greater than 4 GB, the chunk entries are 8-byte
144          * integers.  Otherwise, they are 4-byte integers. */
145         u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ?
146                                                                         8 : 4;
147
148         /* Size of the full chunk table in the WIM file. */
149         u64 chunk_table_size = chunk_entry_size * num_chunk_entries;
150
151         /* Read the needed chunk offsets from the table in the WIM file. */
152
153         /* Index, in the WIM file, of the first needed entry in the
154          * chunk table. */
155         u64 start_table_idx = (start_chunk == 0) ? 0 : start_chunk - 1;
156
157         /* Number of entries we need to actually read from the chunk
158          * table (excludes the implicit first chunk). */
159         u64 num_needed_chunk_entries = (start_chunk == 0) ?
160                                 num_needed_chunks - 1 : num_needed_chunks;
161
162         /* Skip over unneeded chunk table entries. */
163         u64 file_offset_of_needed_chunk_entries = resource_offset +
164                                 start_table_idx * chunk_entry_size;
165
166         /* Number of bytes we need to read from the chunk table. */
167         size_t size = num_needed_chunk_entries * chunk_entry_size;
168
169         /* Read the raw data into the end of the chunk_offsets array to
170          * avoid allocating another array. */
171         void *chunk_tab_buf = (void*)&chunk_offsets[num_needed_chunks] - size;
172
173         if (full_pread(in_fd, chunk_tab_buf, size,
174                        file_offset_of_needed_chunk_entries) != size)
175                 goto read_error;
176
177         /* Now fill in chunk_offsets from the entries we have read in
178          * chunk_tab_buf. */
179
180         u64 *chunk_tab_p = chunk_offsets;
181         if (start_chunk == 0)
182                 chunk_tab_p++;
183
184         if (chunk_entry_size == 4) {
185                 u32 *entries = (u32*)chunk_tab_buf;
186                 while (num_needed_chunk_entries--)
187                         *chunk_tab_p++ = le32_to_cpu(*entries++);
188         } else {
189                 u64 *entries = (u64*)chunk_tab_buf;
190                 while (num_needed_chunk_entries--)
191                         *chunk_tab_p++ = le64_to_cpu(*entries++);
192         }
193
194         /* Done with the chunk table now.  We must now seek to the first chunk
195          * that is needed for the read. */
196
197         u64 cur_read_offset = resource_offset + chunk_table_size + chunk_offsets[0];
198
199         /* Pointer to current position in the output buffer for uncompressed
200          * data.  Alternatively, if using a callback function, we repeatedly
201          * fill a temporary buffer to feed data into the callback function.  */
202         u8 *out_p;
203         if (cb)
204                 out_p = alloca(WIM_CHUNK_SIZE);
205         else
206                 out_p = ctx_or_buf;
207
208         /* Buffer for compressed data.  While most compressed chunks will have a
209          * size much less than WIM_CHUNK_SIZE, WIM_CHUNK_SIZE - 1 is the maximum
210          * size in the worst-case.  This assumption is valid only if chunks that
211          * happen to compress to more than the uncompressed size (i.e. a
212          * sequence of random bytes) are always stored uncompressed. But this seems
213          * to be the case in M$'s WIM files, even though it is undocumented. */
214         void *compressed_buf = alloca(WIM_CHUNK_SIZE - 1);
215
216         /* Decompress all the chunks. */
217         for (u64 i = start_chunk; i <= end_chunk; i++) {
218
219                 /* Calculate the sizes of the compressed chunk and of the
220                  * uncompressed chunk. */
221                 unsigned compressed_chunk_size;
222                 unsigned uncompressed_chunk_size;
223                 if (i != num_chunks - 1) {
224                         /* All the chunks except the last one in the resource
225                          * expand to WIM_CHUNK_SIZE uncompressed, and the amount
226                          * of compressed data for the chunk is given by the
227                          * difference of offsets in the chunk offset table. */
228                         compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] -
229                                                 chunk_offsets[i - start_chunk];
230                         uncompressed_chunk_size = WIM_CHUNK_SIZE;
231                 } else {
232                         /* The last compressed chunk consists of the remaining
233                          * bytes in the file resource, and the last uncompressed
234                          * chunk has size equal to however many bytes are left-
235                          * that is, the remainder of the uncompressed size when
236                          * divided by WIM_CHUNK_SIZE.
237                          *
238                          * Note that the resource_compressed_size includes the
239                          * chunk table, so the size of it must be subtracted. */
240                         compressed_chunk_size = resource_compressed_size -
241                                                 chunk_table_size -
242                                                 chunk_offsets[i - start_chunk];
243
244                         uncompressed_chunk_size = resource_uncompressed_size %
245                                                                 WIM_CHUNK_SIZE;
246
247                         /* If the remainder is 0, the last chunk actually
248                          * uncompresses to a full WIM_CHUNK_SIZE bytes. */
249                         if (uncompressed_chunk_size == 0)
250                                 uncompressed_chunk_size = WIM_CHUNK_SIZE;
251                 }
252
253                 /* Figure out how much of this chunk we actually need to read */
254                 u64 start_offset;
255                 if (i == start_chunk)
256                         start_offset = start_chunk_offset;
257                 else
258                         start_offset = 0;
259                 u64 end_offset;
260                 if (i == end_chunk)
261                         end_offset = end_chunk_offset;
262                 else
263                         end_offset = WIM_CHUNK_SIZE - 1;
264
265                 unsigned partial_chunk_size = end_offset + 1 - start_offset;
266                 bool is_partial_chunk = (partial_chunk_size != uncompressed_chunk_size);
267
268                 /* This is undocumented, but chunks can be uncompressed.  This
269                  * appears to always be the case when the compressed chunk size
270                  * is equal to the uncompressed chunk size. */
271                 if (compressed_chunk_size == uncompressed_chunk_size) {
272                         /* Uncompressed chunk */
273                         if (full_pread(in_fd,
274                                        cb ? out_p + start_offset : out_p,
275                                        partial_chunk_size,
276                                        cur_read_offset + start_offset) != partial_chunk_size)
277                         {
278                                 goto read_error;
279                         }
280                 } else {
281                         /* Compressed chunk */
282
283                         /* Read the compressed data into compressed_buf. */
284                         if (full_pread(in_fd,
285                                        compressed_buf,
286                                        compressed_chunk_size,
287                                        cur_read_offset) != compressed_chunk_size)
288                         {
289                                 goto read_error;
290                         }
291
292                         /* For partial chunks and when writing directly to a
293                          * buffer, we must buffer the uncompressed data because
294                          * we don't need all of it. */
295                         if (is_partial_chunk && !cb) {
296                                 u8 uncompressed_buf[uncompressed_chunk_size];
297
298                                 ret = decompress(compressed_buf,
299                                                  compressed_chunk_size,
300                                                  uncompressed_buf,
301                                                  uncompressed_chunk_size);
302                                 if (ret) {
303                                         ret = WIMLIB_ERR_DECOMPRESSION;
304                                         goto out;
305                                 }
306                                 memcpy(out_p, uncompressed_buf + start_offset,
307                                        partial_chunk_size);
308                         } else {
309                                 ret = decompress(compressed_buf,
310                                                  compressed_chunk_size,
311                                                  out_p,
312                                                  uncompressed_chunk_size);
313                                 if (ret) {
314                                         ret = WIMLIB_ERR_DECOMPRESSION;
315                                         goto out;
316                                 }
317                         }
318                 }
319                 if (cb) {
320                         /* Feed the data to the callback function */
321                         ret = cb(out_p + start_offset,
322                                  partial_chunk_size, ctx_or_buf);
323                         if (ret)
324                                 goto out;
325                 } else {
326                         /* No callback function provided; we are writing
327                          * directly to a buffer.  Advance the pointer into this
328                          * buffer by the number of uncompressed bytes that were
329                          * written.  */
330                         out_p += partial_chunk_size;
331                 }
332                 cur_read_offset += compressed_chunk_size;
333         }
334
335         ret = 0;
336 out:
337         if (chunk_offsets_malloced)
338                 FREE(chunk_offsets);
339         return ret;
340
341 read_error:
342         ERROR_WITH_ERRNO("Error reading compressed file resource");
343         ret = WIMLIB_ERR_READ;
344         goto out;
345 }
346
347 /*
348  * Reads uncompressed data from an open file stream.
349  */
350 int
351 read_uncompressed_resource(FILE *fp, u64 offset, u64 len, void *contents_ret)
352 {
353         if (fseeko(fp, offset, SEEK_SET) != 0) {
354                 ERROR("Failed to seek to byte %"PRIu64" of input file "
355                       "to read uncompressed resource (len = %"PRIu64")",
356                       offset, len);
357                 return WIMLIB_ERR_READ;
358         }
359         if (fread(contents_ret, 1, len, fp) != len) {
360                 if (feof(fp)) {
361                         ERROR("Unexpected EOF in uncompressed file resource");
362                 } else {
363                         ERROR("Failed to read %"PRIu64" bytes from "
364                               "uncompressed resource at offset %"PRIu64,
365                               len, offset);
366                 }
367                 return WIMLIB_ERR_READ;
368         }
369         return 0;
370 }
371
372 /* Reads the contents of a struct resource_entry, as represented in the on-disk
373  * format, from the memory pointed to by @p, and fills in the fields of @entry.
374  * A pointer to the byte after the memory read at @p is returned. */
375 const void *
376 get_resource_entry(const void *p, struct resource_entry *entry)
377 {
378         u64 size;
379         u8 flags;
380
381         p = get_u56(p, &size);
382         p = get_u8(p, &flags);
383         entry->size = size;
384         entry->flags = flags;
385
386         /* offset and original_size are truncated to 62 bits to avoid possible
387          * overflows, when converting to a signed 64-bit integer (off_t) or when
388          * adding size or original_size.  This is okay since no one would ever
389          * actually have a WIM bigger than 4611686018427387903 bytes... */
390         p = get_u64(p, &entry->offset);
391         if (entry->offset & 0xc000000000000000ULL) {
392                 WARNING("Truncating offset in resource entry");
393                 entry->offset &= 0x3fffffffffffffffULL;
394         }
395         p = get_u64(p, &entry->original_size);
396         if (entry->original_size & 0xc000000000000000ULL) {
397                 WARNING("Truncating original_size in resource entry");
398                 entry->original_size &= 0x3fffffffffffffffULL;
399         }
400         return p;
401 }
402
403 /* Copies the struct resource_entry @entry to the memory pointed to by @p in the
404  * on-disk format.  A pointer to the byte after the memory written at @p is
405  * returned. */
406 void *
407 put_resource_entry(void *p, const struct resource_entry *entry)
408 {
409         p = put_u56(p, entry->size);
410         p = put_u8(p, entry->flags);
411         p = put_u64(p, entry->offset);
412         p = put_u64(p, entry->original_size);
413         return p;
414 }
415
416 static int
417 read_partial_wim_resource(const struct wim_lookup_table_entry *lte,
418                           u64 size,
419                           consume_data_callback_t cb,
420                           void *ctx_or_buf,
421                           int flags,
422                           u64 offset)
423 {
424         WIMStruct *wim;
425         filedes_t in_fd;
426         int ret;
427
428         wimlib_assert(lte->resource_location == RESOURCE_IN_WIM);
429
430         wim = lte->wim;
431         in_fd = wim->in_fd;
432
433         if (lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED &&
434             !(flags & WIMLIB_RESOURCE_FLAG_RAW))
435         {
436                 ret = read_compressed_resource(in_fd,
437                                                lte->resource_entry.size,
438                                                lte->resource_entry.original_size,
439                                                lte->resource_entry.offset,
440                                                wimlib_get_compression_type(wim),
441                                                size,
442                                                offset,
443                                                cb,
444                                                ctx_or_buf);
445         } else {
446                 offset += lte->resource_entry.offset;
447                 if (cb) {
448                         /* Send data to callback function */
449                         u8 buf[min(WIM_CHUNK_SIZE, size)];
450                         while (size) {
451                                 size_t bytes_to_read = min(WIM_CHUNK_SIZE, size);
452                                 size_t bytes_read = full_pread(in_fd, buf,
453                                                                bytes_to_read, offset);
454                                 if (bytes_read != bytes_to_read)
455                                         goto read_error;
456                                 ret = cb(buf, bytes_read, ctx_or_buf);
457                                 if (ret)
458                                         goto out;
459                                 size -= bytes_read;
460                                 offset += bytes_read;
461                         }
462                 } else {
463                         /* Send data directly to a buffer */
464                         if (full_pread(in_fd, ctx_or_buf, size, offset) != size)
465                                 goto read_error;
466                 }
467                 ret = 0;
468         }
469         goto out;
470 read_error:
471         ERROR_WITH_ERRNO("Error reading data from WIM");
472         ret = WIMLIB_ERR_READ;
473 out:
474         if (ret) {
475                 if (errno == 0)
476                         errno = EIO;
477         }
478         return ret;
479 }
480
481
482 int
483 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
484                                    size_t size, u64 offset, void *buf)
485 {
486         return read_partial_wim_resource(lte, size, NULL, buf, 0, offset);
487 }
488
489 static int
490 read_wim_resource_prefix(const struct wim_lookup_table_entry *lte,
491                          u64 size,
492                          consume_data_callback_t cb,
493                          void *ctx_or_buf,
494                          int flags)
495 {
496         return read_partial_wim_resource(lte, size, cb, ctx_or_buf, flags, 0);
497 }
498
499
500 #ifndef __WIN32__
501 static int
502 read_file_on_disk_prefix(const struct wim_lookup_table_entry *lte,
503                          u64 size,
504                          consume_data_callback_t cb,
505                          void *ctx_or_buf,
506                          int _ignored_flags)
507 {
508         const tchar *filename = lte->file_on_disk;
509         int ret;
510         int fd;
511         size_t bytes_read;
512
513         fd = open(filename, O_RDONLY);
514         if (fd < 0) {
515                 ERROR_WITH_ERRNO("Can't open \"%"TS"\"", filename);
516                 return WIMLIB_ERR_OPEN;
517         }
518         if (cb) {
519                 /* Send data to callback function */
520                 u8 buf[min(WIM_CHUNK_SIZE, size)];
521                 size_t bytes_to_read;
522                 while (size) {
523                         bytes_to_read = min(WIM_CHUNK_SIZE, size);
524                         bytes_read = full_read(fd, buf, bytes_to_read);
525                         if (bytes_read != bytes_to_read)
526                                 goto read_error;
527                         ret = cb(buf, bytes_read, ctx_or_buf);
528                         if (ret)
529                                 goto out_close;
530                         size -= bytes_read;
531                 }
532         } else {
533                 /* Send data directly to a buffer */
534                 bytes_read = full_read(fd, ctx_or_buf, size);
535                 if (bytes_read != size)
536                         goto read_error;
537         }
538         ret = 0;
539         goto out_close;
540 read_error:
541         ERROR_WITH_ERRNO("Error reading \"%"TS"\"", filename);
542         ret = WIMLIB_ERR_READ;
543 out_close:
544         close(fd);
545         return ret;
546 }
547 #endif /* !__WIN32__ */
548
549 static int
550 read_buffer_prefix(const struct wim_lookup_table_entry *lte,
551                    u64 size, consume_data_callback_t cb,
552                    void *ctx_or_buf, int _ignored_flags)
553 {
554         const void *inbuf = lte->attached_buffer;
555         int ret;
556
557         if (cb) {
558                 while (size) {
559                         size_t chunk_size = min(WIM_CHUNK_SIZE, size);
560                         ret = cb(inbuf, chunk_size, ctx_or_buf);
561                         if (ret)
562                                 return ret;
563                         size -= chunk_size;
564                         inbuf += chunk_size;
565                 }
566         } else {
567                 memcpy(ctx_or_buf, inbuf, size);
568         }
569         return 0;
570 }
571
572 typedef int (*read_resource_prefix_handler_t)(const struct wim_lookup_table_entry *lte,
573                                               u64 size,
574                                               consume_data_callback_t cb,
575                                               void *ctx_or_buf,
576                                               int flags);
577
578 /*
579  * Read the first @size bytes from a generic "resource", which may be located in
580  * the WIM (compressed or uncompressed), in an external file, or directly in an
581  * in-memory buffer.
582  *
583  * Feed the data either to a callback function (cb != NULL, passing it
584  * ctx_or_buf), or write it directly into a buffer (cb == NULL, ctx_or_buf
585  * specifies the buffer, which must have room for @size bytes).
586  *
587  * When using a callback function, it is called with chunks up to 32768 bytes in
588  * size until the resource is exhausted.
589  *
590  * If the resource is located in a WIM file, @flags can be:
591  *   * WIMLIB_RESOURCE_FLAG_THREADSAFE_READ if it must be safe to access the resource
592  *     concurrently by multiple threads.
593  *   * WIMLIB_RESOURCE_FLAG_RAW if the raw compressed data is to be supplied
594  *     instead of the uncompressed data.
595  * Otherwise, the @flags are ignored.
596  */
597 int
598 read_resource_prefix(const struct wim_lookup_table_entry *lte,
599                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
600                      int flags)
601 {
602         static const read_resource_prefix_handler_t handlers[] = {
603                 [RESOURCE_IN_WIM]             = read_wim_resource_prefix,
604         #ifndef __WIN32__
605                 [RESOURCE_IN_FILE_ON_DISK]    = read_file_on_disk_prefix,
606         #endif
607                 [RESOURCE_IN_ATTACHED_BUFFER] = read_buffer_prefix,
608         #ifdef WITH_FUSE
609                 [RESOURCE_IN_STAGING_FILE]    = read_file_on_disk_prefix,
610         #endif
611         #ifdef WITH_NTFS_3G
612                 [RESOURCE_IN_NTFS_VOLUME]     = read_ntfs_file_prefix,
613         #endif
614         #ifdef __WIN32__
615                 [RESOURCE_WIN32]              = read_win32_file_prefix,
616                 [RESOURCE_WIN32_ENCRYPTED]    = read_win32_encrypted_file_prefix,
617         #endif
618         };
619         wimlib_assert(lte->resource_location < ARRAY_LEN(handlers)
620                       && handlers[lte->resource_location] != NULL);
621         return handlers[lte->resource_location](lte, size, cb, ctx_or_buf, flags);
622 }
623
624 int
625 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte,
626                             void *buf)
627 {
628         return read_resource_prefix(lte, wim_resource_size(lte), NULL, buf, 0);
629 }
630
631 struct extract_ctx {
632         SHA_CTX sha_ctx;
633         consume_data_callback_t extract_chunk;
634         void *extract_chunk_arg;
635 };
636
637 static int
638 extract_chunk_sha1_wrapper(const void *chunk, size_t chunk_size,
639                            void *_ctx)
640 {
641         struct extract_ctx *ctx = _ctx;
642
643         sha1_update(&ctx->sha_ctx, chunk, chunk_size);
644         return ctx->extract_chunk(chunk, chunk_size, ctx->extract_chunk_arg);
645 }
646
647 /* Extracts the first @size bytes of a WIM resource to somewhere.  In the
648  * process, the SHA1 message digest of the resource is checked if the full
649  * resource is being extracted.
650  *
651  * @extract_chunk is a function that is called to extract each chunk of the
652  * resource. */
653 int
654 extract_wim_resource(const struct wim_lookup_table_entry *lte,
655                      u64 size,
656                      consume_data_callback_t extract_chunk,
657                      void *extract_chunk_arg)
658 {
659         int ret;
660         if (size == wim_resource_size(lte)) {
661                 /* Do SHA1 */
662                 struct extract_ctx ctx;
663                 ctx.extract_chunk = extract_chunk;
664                 ctx.extract_chunk_arg = extract_chunk_arg;
665                 sha1_init(&ctx.sha_ctx);
666                 ret = read_resource_prefix(lte, size,
667                                            extract_chunk_sha1_wrapper,
668                                            &ctx, 0);
669                 if (ret == 0) {
670                         u8 hash[SHA1_HASH_SIZE];
671                         sha1_final(hash, &ctx.sha_ctx);
672                         if (!hashes_equal(hash, lte->hash)) {
673                         #ifdef ENABLE_ERROR_MESSAGES
674                                 ERROR("Invalid SHA1 message digest "
675                                       "on the following WIM resource:");
676                                 print_lookup_table_entry(lte, stderr);
677                                 if (lte->resource_location == RESOURCE_IN_WIM)
678                                         ERROR("The WIM file appears to be corrupt!");
679                         #endif
680                                 ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
681                         }
682                 }
683         } else {
684                 /* Don't do SHA1 */
685                 ret = read_resource_prefix(lte, size, extract_chunk,
686                                            extract_chunk_arg, 0);
687         }
688         return ret;
689 }
690
691 static int
692 extract_wim_chunk_to_fd(const void *buf, size_t len, void *_fd_p)
693 {
694         int fd = *(int*)_fd_p;
695         ssize_t ret = full_write(fd, buf, len);
696         if (ret < len) {
697                 ERROR_WITH_ERRNO("Error writing to file descriptor");
698                 return WIMLIB_ERR_WRITE;
699         } else {
700                 return 0;
701         }
702 }
703
704 int
705 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
706                            int fd, u64 size)
707 {
708         return extract_wim_resource(lte, size, extract_wim_chunk_to_fd, &fd);
709 }
710
711
712 static int
713 sha1_chunk(const void *buf, size_t len, void *ctx)
714 {
715         sha1_update(ctx, buf, len);
716         return 0;
717 }
718
719 /* Calculate the SHA1 message digest of a stream. */
720 int
721 sha1_resource(struct wim_lookup_table_entry *lte)
722 {
723         int ret;
724         SHA_CTX sha_ctx;
725
726         sha1_init(&sha_ctx);
727         ret = read_resource_prefix(lte, wim_resource_size(lte),
728                                    sha1_chunk, &sha_ctx, 0);
729         if (ret == 0)
730                 sha1_final(lte->hash, &sha_ctx);
731         return ret;
732 }
733
734 /*
735  * Copies the file resource specified by the lookup table entry @lte from the
736  * input WIM to the output WIM that has its FILE * given by
737  * ((WIMStruct*)wim)->out_fp.
738  *
739  * The output_resource_entry, out_refcnt, and part_number fields of @lte are
740  * updated.
741  *
742  * (This function is confusing and should be refactored somehow.)
743  */
744 int
745 copy_resource(struct wim_lookup_table_entry *lte, void *wim)
746 {
747         WIMStruct *w = wim;
748         int ret;
749
750         ret = write_wim_resource(lte, w->out_fd,
751                                  wim_resource_compression_type(lte),
752                                  &lte->output_resource_entry, 0);
753         if (ret == 0) {
754                 lte->out_refcnt = lte->refcnt;
755                 lte->part_number = w->hdr.part_number;
756         }
757         return ret;
758 }