d885b7970988f6d6412cf1686b4f32c3d5c9c155
[wimlib] / src / wim.c
1 /*
2  * wim.c - Stuff that doesn't fit into any other file
3  */
4
5 /*
6  * Copyright (C) 2012, 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option)
13  * any later version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #include "wimlib/error.h"
29 #include "wimlib/dentry.h"
30 #include "wimlib/encoding.h"
31 #include "wimlib/file_io.h"
32 #include "wimlib/integrity.h"
33 #include "wimlib/lookup_table.h"
34 #include "wimlib/metadata.h"
35 #ifdef WITH_NTFS_3G
36 #  include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
37 #endif
38 #include "wimlib/security.h"
39 #include "wimlib/wim.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/compressor_ops.h"
42 #include "wimlib/decompressor_ops.h"
43
44 #ifdef __WIN32__
45 #  include "wimlib/win32.h" /* for realpath() replacement */
46 #endif
47
48 #include <errno.h>
49 #include <fcntl.h>
50 #ifndef __WIN32__
51 #  include <langinfo.h>
52 #endif
53 #include <limits.h>
54 #include <stdarg.h>
55 #include <stdlib.h>
56 #include <unistd.h>
57
58 static int
59 wim_default_pack_compression_type(void)
60 {
61         return WIMLIB_COMPRESSION_TYPE_LZMS;
62 }
63
64 static u32
65 wim_default_pack_chunk_size(int ctype) {
66         switch (ctype) {
67         case WIMLIB_COMPRESSION_TYPE_LZMS:
68                 /* Note: WIMGAPI uses 1 << 26, but lower sizes are compatible.
69                  * */
70                 return 1U << 25; /* 33554432  */
71         default:
72                 return 1U << 15; /* 32768     */
73         }
74 }
75
76 static WIMStruct *
77 new_wim_struct(void)
78 {
79         WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
80         if (wim) {
81                 filedes_invalidate(&wim->in_fd);
82                 filedes_invalidate(&wim->out_fd);
83                 wim->out_pack_compression_type = wim_default_pack_compression_type();
84                 wim->out_pack_chunk_size = wim_default_pack_chunk_size(
85                                                 wim->out_pack_compression_type);
86                 INIT_LIST_HEAD(&wim->subwims);
87         }
88         return wim;
89 }
90
91 /* Determine if the chunk size is valid for the specified compression type.  */
92 static bool
93 wim_chunk_size_valid(u32 chunk_size, int ctype)
94 {
95         u32 order;
96
97         /* Chunk size is meaningless for uncompressed WIMs --- any value is
98          * okay.  */
99         if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
100                 return true;
101
102         /* Chunk size must be power of 2.  */
103         if (chunk_size == 0)
104                 return false;
105         order = bsr32(chunk_size);
106         if (chunk_size != 1U << order)
107                 return false;
108
109         /* Order        Size
110          * =====        ====
111          * 15           32768
112          * 16           65536
113          * 17           131072
114          * 18           262144
115          * 19           524288
116          * 20           1048576
117          * 21           2097152
118          * 22           4194304
119          * 23           8388608
120          * 24           16777216
121          * 25           33554432
122          * 26           67108864
123          */
124
125         /* See the documentation for the --chunk-size option of `wimlib-imagex
126          * capture' for information about allowed chunk sizes.  */
127         switch (ctype) {
128         case WIMLIB_COMPRESSION_TYPE_LZX:
129                 return order >= 15 && order <= 21;
130
131         case WIMLIB_COMPRESSION_TYPE_XPRESS:
132         case WIMLIB_COMPRESSION_TYPE_LZMS:
133                 return order >= 15 && order <= 26;
134         }
135         return false;
136 }
137
138 /* Return the default chunk size to use for the specified compression type.
139  *
140  * See notes above in wim_chunk_size_valid().  */
141 static u32
142 wim_default_chunk_size(int ctype)
143 {
144         switch (ctype) {
145         case WIMLIB_COMPRESSION_TYPE_LZMS:
146                 return 1U << 17; /* 131072  */
147         default:
148                 return 1U << 15; /* 32768   */
149         }
150 }
151
152 /*
153  * Calls a function on images in the WIM.  If @image is WIMLIB_ALL_IMAGES,
154  * @visitor is called on the WIM once for each image, with each image selected
155  * as the current image in turn.  If @image is a certain image, @visitor is
156  * called on the WIM only once, with that image selected.
157  */
158 int
159 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
160 {
161         int ret;
162         int start;
163         int end;
164         int i;
165
166         if (image == WIMLIB_ALL_IMAGES) {
167                 start = 1;
168                 end = wim->hdr.image_count;
169         } else if (image >= 1 && image <= wim->hdr.image_count) {
170                 start = image;
171                 end = image;
172         } else {
173                 return WIMLIB_ERR_INVALID_IMAGE;
174         }
175         for (i = start; i <= end; i++) {
176                 ret = select_wim_image(wim, i);
177                 if (ret != 0)
178                         return ret;
179                 ret = visitor(wim);
180                 if (ret != 0)
181                         return ret;
182         }
183         return 0;
184 }
185
186 /* API function documented in wimlib.h  */
187 WIMLIBAPI int
188 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
189 {
190         WIMStruct *wim;
191         struct wim_lookup_table *table;
192         int ret;
193
194         wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
195
196         DEBUG("Creating new WIM with %"TS" compression.",
197               wimlib_get_compression_type_string(ctype));
198
199         /* Allocate the WIMStruct. */
200         wim = new_wim_struct();
201         if (wim == NULL)
202                 return WIMLIB_ERR_NOMEM;
203
204         ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
205         if (ret)
206                 goto out_free;
207
208         table = new_lookup_table(9001);
209         if (table == NULL) {
210                 ret = WIMLIB_ERR_NOMEM;
211                 goto out_free;
212         }
213         wim->lookup_table = table;
214         wim->refcnts_ok = 1;
215         wim->compression_type = ctype;
216         wim->out_compression_type = ctype;
217         wim->chunk_size = wim->hdr.chunk_size;
218         wim->out_chunk_size = wim->hdr.chunk_size;
219         *wim_ret = wim;
220         return 0;
221 out_free:
222         FREE(wim);
223         return ret;
224 }
225
226 int
227 select_wim_image(WIMStruct *wim, int image)
228 {
229         struct wim_image_metadata *imd;
230         int ret;
231
232         DEBUG("Selecting image %d", image);
233
234         if (image == WIMLIB_NO_IMAGE) {
235                 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
236                 return WIMLIB_ERR_INVALID_IMAGE;
237         }
238
239         if (image == wim->current_image)
240                 return 0;
241
242         if (image < 1 || image > wim->hdr.image_count) {
243                 ERROR("Cannot select image %d: There are only %u images",
244                       image, wim->hdr.image_count);
245                 return WIMLIB_ERR_INVALID_IMAGE;
246         }
247
248         if (!wim_has_metadata(wim)) {
249                 ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
250                 if (wim->hdr.part_number != 1)
251                         ERROR("Specify the first part of the split WIM instead.");
252                 return WIMLIB_ERR_METADATA_NOT_FOUND;
253         }
254
255         /* If a valid image is currently selected, it can be freed if it is not
256          * modified.  */
257         if (wim->current_image != WIMLIB_NO_IMAGE) {
258                 imd = wim_get_current_image_metadata(wim);
259                 if (!imd->modified) {
260                         wimlib_assert(list_empty(&imd->unhashed_streams));
261                         DEBUG("Freeing image %u", wim->current_image);
262                         destroy_image_metadata(imd, NULL, false);
263                 }
264         }
265         wim->current_image = image;
266         imd = wim_get_current_image_metadata(wim);
267         if (imd->root_dentry || imd->modified) {
268                 ret = 0;
269         } else {
270                 ret = read_metadata_resource(wim, imd);
271                 if (ret)
272                         wim->current_image = WIMLIB_NO_IMAGE;
273         }
274         return ret;
275 }
276
277
278 /* API function documented in wimlib.h  */
279 WIMLIBAPI const tchar *
280 wimlib_get_compression_type_string(int ctype)
281 {
282         switch (ctype) {
283                 case WIMLIB_COMPRESSION_TYPE_NONE:
284                         return T("None");
285                 case WIMLIB_COMPRESSION_TYPE_LZX:
286                         return T("LZX");
287                 case WIMLIB_COMPRESSION_TYPE_XPRESS:
288                         return T("XPRESS");
289                 case WIMLIB_COMPRESSION_TYPE_LZMS:
290                         return T("LZMS");
291                 default:
292                         return T("Invalid");
293         }
294 }
295
296 /* API function documented in wimlib.h  */
297 WIMLIBAPI int
298 wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
299 {
300         tchar *p;
301         long image;
302         int i;
303
304         if (!image_name_or_num || !*image_name_or_num)
305                 return WIMLIB_NO_IMAGE;
306
307         if (!tstrcasecmp(image_name_or_num, T("all"))
308             || !tstrcasecmp(image_name_or_num, T("*")))
309                 return WIMLIB_ALL_IMAGES;
310         image = tstrtol(image_name_or_num, &p, 10);
311         if (p != image_name_or_num && *p == T('\0') && image > 0) {
312                 if (image > wim->hdr.image_count)
313                         return WIMLIB_NO_IMAGE;
314                 return image;
315         } else {
316                 for (i = 1; i <= wim->hdr.image_count; i++) {
317                         if (!tstrcmp(image_name_or_num,
318                                      wimlib_get_image_name(wim, i)))
319                                 return i;
320                 }
321                 return WIMLIB_NO_IMAGE;
322         }
323 }
324
325 /* API function documented in wimlib.h  */
326 WIMLIBAPI void
327 wimlib_print_available_images(const WIMStruct *wim, int image)
328 {
329         int first;
330         int last;
331         int i;
332         int n;
333         if (image == WIMLIB_ALL_IMAGES) {
334                 n = tprintf(T("Available Images:\n"));
335                 first = 1;
336                 last = wim->hdr.image_count;
337         } else if (image >= 1 && image <= wim->hdr.image_count) {
338                 n = tprintf(T("Information for Image %d\n"), image);
339                 first = image;
340                 last = image;
341         } else {
342                 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
343                         image);
344                 return;
345         }
346         for (i = 0; i < n - 1; i++)
347                 tputchar(T('-'));
348         tputchar(T('\n'));
349         for (i = first; i <= last; i++)
350                 print_image_info(wim->wim_info, i);
351 }
352
353 /* TODO: Deprecated; remove this.  */
354 WIMLIBAPI int
355 wimlib_print_metadata(WIMStruct *wim, int image)
356 {
357         return WIMLIB_ERR_UNSUPPORTED;
358 }
359
360 /* API function documented in wimlib.h  */
361 WIMLIBAPI int
362 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
363 {
364         memset(info, 0, sizeof(struct wimlib_wim_info));
365         memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
366         info->image_count = wim->hdr.image_count;
367         info->boot_index = wim->hdr.boot_idx;
368         info->wim_version = wim->hdr.wim_version;
369         info->chunk_size = wim->chunk_size;
370         info->part_number = wim->hdr.part_number;
371         info->total_parts = wim->hdr.total_parts;
372         info->compression_type = wim->compression_type;
373         info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
374         info->has_integrity_table = wim_has_integrity_table(wim);
375         info->opened_from_file = (wim->filename != NULL);
376         info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
377                              (wim->hdr.total_parts != 1) ||
378                              (wim->filename && taccess(wim->filename, W_OK));
379         info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
380         info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
381         info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
382         info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
383         info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
384         info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
385         info->pipable = wim_is_pipable(wim);
386         return 0;
387 }
388
389 /* API function documented in wimlib.h  */
390 WIMLIBAPI int
391 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
392 {
393         int ret;
394
395         if (which & WIMLIB_CHANGE_READONLY_FLAG) {
396                 if (info->is_marked_readonly)
397                         wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
398                 else
399                         wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
400         }
401
402         if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
403                 return 0;
404
405         ret = can_modify_wim(wim);
406         if (ret)
407                 return ret;
408
409         if (which & WIMLIB_CHANGE_GUID) {
410                 memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
411                 wim->guid_set_explicitly = 1;
412         }
413
414         if (which & WIMLIB_CHANGE_BOOT_INDEX) {
415                 if (info->boot_index > wim->hdr.image_count) {
416                         ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
417                               info->boot_index);
418                         return WIMLIB_ERR_INVALID_IMAGE;
419                 }
420                 wim->hdr.boot_idx = info->boot_index;
421         }
422
423         if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
424                 if (info->has_rpfix)
425                         wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
426                 else
427                         wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
428         }
429         return 0;
430 }
431
432 static int
433 set_out_ctype(int ctype, u8 *out_ctype_p)
434 {
435         switch (ctype) {
436         case WIMLIB_COMPRESSION_TYPE_INVALID:
437                 break;
438         case WIMLIB_COMPRESSION_TYPE_NONE:
439         case WIMLIB_COMPRESSION_TYPE_LZX:
440         case WIMLIB_COMPRESSION_TYPE_XPRESS:
441         case WIMLIB_COMPRESSION_TYPE_LZMS:
442                 *out_ctype_p = ctype;
443                 return 0;
444         }
445         return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
446 }
447
448 /* API function documented in wimlib.h  */
449 WIMLIBAPI int
450 wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
451 {
452         int ret = set_out_ctype(ctype, &wim->out_compression_type);
453         if (ret)
454                 return ret;
455
456         /* Reset the chunk size if it's no longer valid.  */
457         if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
458                 wim->out_chunk_size = wim_default_chunk_size(ctype);
459         return 0;
460 }
461
462 /* API function documented in wimlib.h  */
463 WIMLIBAPI int
464 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
465 {
466         int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
467         if (ret)
468                 return ret;
469
470         /* Reset the chunk size if it's no longer valid.  */
471         if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
472                 wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
473         return 0;
474 }
475
476 static int
477 set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
478 {
479         if (!wim_chunk_size_valid(chunk_size, ctype)) {
480                 ERROR("Invalid chunk size (%"PRIu32" bytes) "
481                       "for compression type %"TS"!",
482                       chunk_size,
483                       wimlib_get_compression_type_string(ctype));
484                 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
485         }
486
487         *out_chunk_size_p = chunk_size;
488         return 0;
489 }
490
491 /* API function documented in wimlib.h  */
492 WIMLIBAPI int
493 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
494 {
495         if (chunk_size == 0) {
496                 wim->out_chunk_size =
497                         wim_default_chunk_size(wim->out_compression_type);
498                 return 0;
499         }
500
501         return set_out_chunk_size(chunk_size,
502                                   wim->out_compression_type,
503                                   &wim->out_chunk_size);
504 }
505
506 /* API function documented in wimlib.h  */
507 WIMLIBAPI int
508 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
509 {
510         if (chunk_size == 0) {
511                 wim->out_pack_chunk_size =
512                         wim_default_pack_chunk_size(wim->out_pack_compression_type);
513                 return 0;
514         }
515
516         return set_out_chunk_size(chunk_size,
517                                   wim->out_pack_compression_type,
518                                   &wim->out_pack_chunk_size);
519 }
520
521 static int
522 open_wim_file(const tchar *filename, struct filedes *fd_ret)
523 {
524         int raw_fd;
525
526         raw_fd = topen(filename, O_RDONLY | O_BINARY);
527         if (raw_fd < 0) {
528                 ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
529                 return WIMLIB_ERR_OPEN;
530         }
531         filedes_init(fd_ret, raw_fd);
532         return 0;
533 }
534
535 /*
536  * Begins the reading of a WIM file; opens the file and reads its header and
537  * lookup table, and optionally checks the integrity.
538  */
539 static int
540 begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
541            int open_flags, wimlib_progress_func_t progress_func)
542 {
543         int ret;
544         int xml_num_images;
545         const tchar *wimfile;
546
547         if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
548                 wimfile = NULL;
549                 filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
550                 wim->in_fd.is_pipe = 1;
551         } else {
552                 wimfile = wim_filename_or_fd;
553                 ret = open_wim_file(wimfile, &wim->in_fd);
554                 if (ret)
555                         return ret;
556
557                 /* The absolute path to the WIM is requested so that
558                  * wimlib_overwrite() still works even if the process changes
559                  * its working directory.  This actually happens if a WIM is
560                  * mounted read-write, since the FUSE thread changes directory
561                  * to "/", and it needs to be able to find the WIM file again.
562                  *
563                  * This will break if the full path to the WIM changes in the
564                  * intervening time...
565                  *
566                  * Warning: in Windows native builds, realpath() calls the
567                  * replacement function in win32_replacements.c.
568                  */
569                 wim->filename = realpath(wimfile, NULL);
570                 if (wim->filename == NULL) {
571                         ERROR_WITH_ERRNO("Failed to resolve WIM filename");
572                         if (errno == ENOMEM)
573                                 return WIMLIB_ERR_NOMEM;
574                         else
575                                 return WIMLIB_ERR_OPEN;
576                 }
577         }
578
579         ret = read_wim_header(wim, &wim->hdr);
580         if (ret)
581                 return ret;
582
583         if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
584                 WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
585                         "          \"%"TS"\".  It may be being changed by another process,\n"
586                         "          or a process may have crashed while writing the WIM.",
587                         wimfile);
588         }
589
590         if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
591                 ret = can_modify_wim(wim);
592                 if (ret)
593                         return ret;
594         }
595
596         if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
597             (wim->hdr.total_parts != 1))
598                 return WIMLIB_ERR_IS_SPLIT_WIM;
599
600         DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
601
602         /* If the boot index is invalid, print a warning and set it to 0 */
603         if (wim->hdr.boot_idx > wim->hdr.image_count) {
604                 WARNING("In `%"TS"', image %u is marked as bootable, "
605                         "but there are only %u images in the WIM",
606                         wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
607                 wim->hdr.boot_idx = 0;
608         }
609
610         /* Check and cache the compression type */
611         if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
612                 if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
613                         wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
614                 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
615                         wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
616                 } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
617                         wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
618                 } else {
619                         ERROR("The compression flag is set on \"%"TS"\", but "
620                               "a flag for a recognized format is not",
621                               wimfile);
622                         return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
623                 }
624         } else {
625                 wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
626         }
627         wim->out_compression_type = wim->compression_type;
628
629         /* Check and cache the chunk size.  */
630         wim->chunk_size = wim->hdr.chunk_size;
631         wim->out_chunk_size = wim->chunk_size;
632         if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
633                 ERROR("Invalid chunk size (%"PRIu32" bytes) "
634                       "for compression type %"TS"!",
635                       wim->chunk_size,
636                       wimlib_get_compression_type_string(wim->compression_type));
637                 return WIMLIB_ERR_INVALID_CHUNK_SIZE;
638         }
639
640         if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
641                 ret = check_wim_integrity(wim, progress_func);
642                 if (ret == WIM_INTEGRITY_NONEXISTENT) {
643                         WARNING("No integrity information for `%"TS"'; skipping "
644                                 "integrity check.", wimfile);
645                 } else if (ret == WIM_INTEGRITY_NOT_OK) {
646                         ERROR("WIM is not intact! (Failed integrity check)");
647                         return WIMLIB_ERR_INTEGRITY;
648                 } else if (ret != WIM_INTEGRITY_OK) {
649                         return ret;
650                 }
651         }
652
653         if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
654                 wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
655                 if (wim->image_metadata == NULL)
656                         return WIMLIB_ERR_NOMEM;
657         }
658
659         if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
660                 wim->lookup_table = new_lookup_table(9001);
661                 if (wim->lookup_table == NULL)
662                         return WIMLIB_ERR_NOMEM;
663         } else {
664
665                 ret = read_wim_xml_data(wim);
666                 if (ret)
667                         return ret;
668
669                 xml_num_images = wim_info_get_num_images(wim->wim_info);
670                 if (xml_num_images != wim->hdr.image_count) {
671                         ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
672                               "in the XML data,", wimfile, xml_num_images);
673                         ERROR("but %u images in the WIM!  There must be exactly one "
674                               "<IMAGE> element per image.", wim->hdr.image_count);
675                         return WIMLIB_ERR_IMAGE_COUNT;
676                 }
677
678                 ret = read_wim_lookup_table(wim);
679                 if (ret)
680                         return ret;
681
682                 DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
683         }
684         return 0;
685 }
686
687 int
688 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
689                       WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
690 {
691         WIMStruct *wim;
692         int ret;
693
694         if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
695                 DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
696         else
697                 DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
698
699         wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
700
701         if (wim_ret == NULL)
702                 return WIMLIB_ERR_INVALID_PARAM;
703
704         wim = new_wim_struct();
705         if (wim == NULL)
706                 return WIMLIB_ERR_NOMEM;
707
708         ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func);
709         if (ret) {
710                 wimlib_free(wim);
711                 return ret;
712         }
713
714         DEBUG("Successfully opened WIM and created WIMStruct.");
715         *wim_ret = wim;
716         return 0;
717 }
718
719 /* API function documented in wimlib.h  */
720 WIMLIBAPI int
721 wimlib_open_wim(const tchar *wimfile, int open_flags,
722                 WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
723 {
724         open_flags &= WIMLIB_OPEN_MASK_PUBLIC;
725         return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
726                                      progress_func);
727 }
728
729 void
730 destroy_image_metadata(struct wim_image_metadata *imd,
731                        struct wim_lookup_table *table,
732                        bool free_metadata_lte)
733 {
734         free_dentry_tree(imd->root_dentry, table);
735         imd->root_dentry = NULL;
736         free_wim_security_data(imd->security_data);
737         imd->security_data = NULL;
738
739         if (free_metadata_lte) {
740                 free_lookup_table_entry(imd->metadata_lte);
741                 imd->metadata_lte = NULL;
742         }
743         if (table == NULL) {
744                 struct wim_lookup_table_entry *lte, *tmp;
745                 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
746                         free_lookup_table_entry(lte);
747         }
748         INIT_LIST_HEAD(&imd->unhashed_streams);
749         INIT_LIST_HEAD(&imd->inode_list);
750 #ifdef WITH_NTFS_3G
751         if (imd->ntfs_vol) {
752                 do_ntfs_umount(imd->ntfs_vol);
753                 imd->ntfs_vol = NULL;
754         }
755 #endif
756 }
757
758 void
759 put_image_metadata(struct wim_image_metadata *imd,
760                    struct wim_lookup_table *table)
761 {
762         if (imd && --imd->refcnt == 0) {
763                 destroy_image_metadata(imd, table, true);
764                 FREE(imd);
765         }
766 }
767
768 /* Appends the specified image metadata structure to the array of image metadata
769  * for a WIM, and increments the image count. */
770 int
771 append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
772 {
773         struct wim_image_metadata **imd_array;
774
775         DEBUG("Reallocating image metadata array for image_count = %u",
776               wim->hdr.image_count + 1);
777         imd_array = REALLOC(wim->image_metadata,
778                             sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
779
780         if (imd_array == NULL)
781                 return WIMLIB_ERR_NOMEM;
782         wim->image_metadata = imd_array;
783         imd_array[wim->hdr.image_count++] = imd;
784         return 0;
785 }
786
787
788 struct wim_image_metadata *
789 new_image_metadata(void)
790 {
791         struct wim_image_metadata *imd;
792
793         imd = CALLOC(1, sizeof(*imd));
794         if (imd) {
795                 imd->refcnt = 1;
796                 INIT_LIST_HEAD(&imd->inode_list);
797                 INIT_LIST_HEAD(&imd->unhashed_streams);
798                 DEBUG("Created new image metadata (refcnt=1)");
799         } else {
800                 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
801         }
802         return imd;
803 }
804
805 struct wim_image_metadata **
806 new_image_metadata_array(unsigned num_images)
807 {
808         struct wim_image_metadata **imd_array;
809
810         DEBUG("Creating new image metadata array for %u images",
811               num_images);
812
813         imd_array = CALLOC(num_images, sizeof(imd_array[0]));
814
815         if (imd_array == NULL) {
816                 ERROR("Failed to allocate memory for %u image metadata structures",
817                       num_images);
818                 return NULL;
819         }
820         for (unsigned i = 0; i < num_images; i++) {
821                 imd_array[i] = new_image_metadata();
822                 if (imd_array[i] == NULL) {
823                         for (unsigned j = 0; j < i; j++)
824                                 put_image_metadata(imd_array[j], NULL);
825                         FREE(imd_array);
826                         return NULL;
827                 }
828         }
829         return imd_array;
830 }
831
832 /* Checksum all streams that are unhashed (other than the metadata streams),
833  * merging them into the lookup table as needed.  This is a no-op unless the
834  * library has previously used to add or mount an image using the same
835  * WIMStruct. */
836 int
837 wim_checksum_unhashed_streams(WIMStruct *wim)
838 {
839         int ret;
840
841         if (!wim_has_metadata(wim))
842                 return 0;
843         for (int i = 0; i < wim->hdr.image_count; i++) {
844                 struct wim_lookup_table_entry *lte, *tmp;
845                 struct wim_image_metadata *imd = wim->image_metadata[i];
846                 image_for_each_unhashed_stream_safe(lte, tmp, imd) {
847                         struct wim_lookup_table_entry *new_lte;
848                         ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
849                         if (ret)
850                                 return ret;
851                         if (new_lte != lte)
852                                 free_lookup_table_entry(lte);
853                 }
854         }
855         return 0;
856 }
857
858 /*
859  * can_modify_wim - Check if a given WIM is writeable.  This is only the case if
860  * it meets the following three conditions:
861  *
862  * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
863  * 2. The WIM is not part of a spanned set.
864  * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
865  *
866  * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
867  */
868 int
869 can_modify_wim(WIMStruct *wim)
870 {
871         if (wim->filename) {
872                 if (taccess(wim->filename, W_OK)) {
873                         ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
874                         return WIMLIB_ERR_WIM_IS_READONLY;
875                 }
876         }
877         if (wim->hdr.total_parts != 1) {
878                 ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
879                       wim->filename);
880                 return WIMLIB_ERR_WIM_IS_READONLY;
881         }
882         if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
883                 ERROR("Cannot modify \"%"TS"\": is marked read-only",
884                       wim->filename);
885                 return WIMLIB_ERR_WIM_IS_READONLY;
886         }
887         return 0;
888 }
889
890 /*
891  * can_delete_from_wim - Check if files or images can be deleted from a given
892  * WIM file.
893  *
894  * This theoretically should be exactly the same as can_modify_wim(), but
895  * unfortunately, due to bugs in Microsoft's software that generate incorrect
896  * reference counts for some WIM resources, we need to run expensive
897  * verifications to make sure the reference counts are correct on all WIM
898  * resources.  Otherwise we might delete a WIM resource whose reference count
899  * has fallen to 0, but is actually still referenced somewhere.
900  */
901 int
902 can_delete_from_wim(WIMStruct *wim)
903 {
904         int ret;
905
906         ret = can_modify_wim(wim);
907         if (ret)
908                 return ret;
909         if (!wim->refcnts_ok) {
910                 ret = wim_recalculate_refcnts(wim);
911                 if (ret)
912                         return ret;
913         }
914         return 0;
915 }
916
917 /* API function documented in wimlib.h  */
918 WIMLIBAPI void
919 wimlib_free(WIMStruct *wim)
920 {
921         if (wim == NULL)
922                 return;
923
924         DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
925               wim->filename, wim->hdr.image_count);
926
927         while (!list_empty(&wim->subwims)) {
928                 WIMStruct *subwim;
929
930                 subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
931                 list_del(&subwim->subwim_node);
932                 DEBUG("Freeing subwim.");
933                 wimlib_free(subwim);
934         }
935
936         if (filedes_valid(&wim->in_fd))
937                 filedes_close(&wim->in_fd);
938         if (filedes_valid(&wim->out_fd))
939                 filedes_close(&wim->out_fd);
940
941         free_lookup_table(wim->lookup_table);
942
943         wimlib_free_decompressor(wim->decompressor);
944
945         FREE(wim->filename);
946         free_wim_info(wim->wim_info);
947         if (wim->image_metadata) {
948                 for (unsigned i = 0; i < wim->hdr.image_count; i++)
949                         put_image_metadata(wim->image_metadata[i], NULL);
950                 FREE(wim->image_metadata);
951         }
952         FREE(wim);
953 }
954
955 static bool
956 test_locale_ctype_utf8(void)
957 {
958 #ifdef __WIN32__
959         return false;
960 #else
961         char *ctype = nl_langinfo(CODESET);
962
963         return (!strstr(ctype, "UTF-8") ||
964                 !strstr(ctype, "UTF8") ||
965                 !strstr(ctype, "utf8") ||
966                 !strstr(ctype, "utf-8"));
967 #endif
968 }
969
970 /* API function documented in wimlib.h  */
971 WIMLIBAPI int
972 wimlib_global_init(int init_flags)
973 {
974         static bool already_inited = false;
975
976         if (already_inited)
977                 return 0;
978         libxml_global_init();
979         if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
980                 wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
981         #ifdef WITH_NTFS_3G
982                 if (!wimlib_mbs_is_utf8)
983                         libntfs3g_global_init();
984         #endif
985         }
986 #ifdef __WIN32__
987         {
988                 int ret = win32_global_init(init_flags);
989                 if (ret)
990                         return ret;
991         }
992 #endif
993         init_upcase();
994         if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
995                 default_ignore_case = false;
996         else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
997                 default_ignore_case = true;
998         already_inited = true;
999         return 0;
1000 }
1001
1002 /* API function documented in wimlib.h  */
1003 WIMLIBAPI void
1004 wimlib_global_cleanup(void)
1005 {
1006         libxml_global_cleanup();
1007         iconv_global_cleanup();
1008 #ifdef __WIN32__
1009         win32_global_cleanup();
1010 #endif
1011         cleanup_decompressor_params();
1012         cleanup_compressor_params();
1013 }