]> wimlib.net Git - wimlib/blob - src/wim.c
Fixes; comments
[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  * wimlib - Library for working with WIM files
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
14  * Software Foundation; either version 3 of the License, or (at your option)
15  * any later 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
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 #include "config.h"
27
28 #include <errno.h>
29 #include <fcntl.h>
30 #include <limits.h>
31 #include <stdarg.h>
32 #include <stdlib.h>
33 #include <unistd.h>
34
35 #ifdef WITH_NTFS_3G
36 #  include <time.h>
37 #  include <ntfs-3g/volume.h>
38 #endif
39
40 #ifdef __WIN32__
41 #  include "win32.h"
42 #else
43 #  include <langinfo.h>
44 #endif
45
46 #include "buffer_io.h"
47 #include "dentry.h"
48 #include "lookup_table.h"
49 #include "wimlib_internal.h"
50 #include "xml.h"
51
52 static int
53 image_print_metadata(WIMStruct *w)
54 {
55         DEBUG("Printing metadata for image %d", w->current_image);
56         print_security_data(wim_security_data(w));
57         return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
58                                   w->lookup_table);
59 }
60
61
62 static int
63 image_print_files(WIMStruct *w)
64 {
65         return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
66                                   NULL);
67 }
68
69 static WIMStruct *
70 new_wim_struct()
71 {
72         WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
73 #ifdef WITH_FUSE
74         if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
75                 ERROR_WITH_ERRNO("Failed to initialize mutex");
76                 FREE(w);
77                 w = NULL;
78         }
79 #endif
80         return w;
81
82 }
83
84 /*
85  * Calls a function on images in the WIM.  If @image is WIMLIB_ALL_IMAGES, @visitor
86  * is called on the WIM once for each image, with each image selected as the
87  * current image in turn.  If @image is a certain image, @visitor is called on
88  * the WIM only once, with that image selected.
89  */
90 int
91 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
92 {
93         int ret;
94         int start;
95         int end;
96         int i;
97
98         if (image == WIMLIB_ALL_IMAGES) {
99                 start = 1;
100                 end = w->hdr.image_count;
101         } else if (image >= 1 && image <= w->hdr.image_count) {
102                 start = image;
103                 end = image;
104         } else {
105                 return WIMLIB_ERR_INVALID_IMAGE;
106         }
107         for (i = start; i <= end; i++) {
108                 ret = select_wim_image(w, i);
109                 if (ret != 0)
110                         return ret;
111                 ret = visitor(w);
112                 if (ret != 0)
113                         return ret;
114         }
115         return 0;
116 }
117
118 /* Returns the compression type given in the flags of a WIM header. */
119 static int
120 wim_hdr_flags_compression_type(int wim_hdr_flags)
121 {
122         if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
123                 if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
124                         return WIMLIB_COMPRESSION_TYPE_LZX;
125                 else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
126                         return WIMLIB_COMPRESSION_TYPE_XPRESS;
127                 else
128                         return WIMLIB_COMPRESSION_TYPE_INVALID;
129         } else {
130                 return WIMLIB_COMPRESSION_TYPE_NONE;
131         }
132 }
133
134 /*
135  * Creates a WIMStruct for a new WIM file.
136  */
137 WIMLIBAPI int
138 wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
139 {
140         WIMStruct *w;
141         struct wim_lookup_table *table;
142         int ret;
143
144         DEBUG("Creating new WIM with %"TS" compression.",
145               wimlib_get_compression_type_string(ctype));
146
147         /* Allocate the WIMStruct. */
148         w = new_wim_struct();
149         if (!w)
150                 return WIMLIB_ERR_NOMEM;
151
152         ret = init_header(&w->hdr, ctype);
153         if (ret != 0)
154                 goto out_free;
155
156         table = new_lookup_table(9001);
157         if (!table) {
158                 ret = WIMLIB_ERR_NOMEM;
159                 goto out_free;
160         }
161         w->lookup_table = table;
162         *w_ret = w;
163         return 0;
164 out_free:
165         FREE(w);
166         return ret;
167 }
168
169 WIMLIBAPI int
170 wimlib_get_num_images(const WIMStruct *w)
171 {
172         return w->hdr.image_count;
173 }
174
175 int
176 select_wim_image(WIMStruct *w, int image)
177 {
178         struct wim_image_metadata *imd;
179         int ret;
180
181         DEBUG("Selecting image %d", image);
182
183         if (image == WIMLIB_NO_IMAGE) {
184                 ERROR("Invalid image: %d", WIMLIB_NO_IMAGE);
185                 return WIMLIB_ERR_INVALID_IMAGE;
186         }
187
188         if (image == w->current_image)
189                 return 0;
190
191         if (image < 1 || image > w->hdr.image_count) {
192                 ERROR("Cannot select image %d: There are only %u images",
193                       image, w->hdr.image_count);
194                 return WIMLIB_ERR_INVALID_IMAGE;
195         }
196
197         /* If a valid image is currently selected, it can be freed if it is not
198          * modified.  */
199         if (w->current_image != WIMLIB_NO_IMAGE) {
200                 imd = wim_get_current_image_metadata(w);
201                 if (!imd->modified) {
202                         wimlib_assert(list_empty(&imd->unhashed_streams));
203                         DEBUG("Freeing image %u", w->current_image);
204                         destroy_image_metadata(imd, NULL, false);
205                 }
206         }
207         w->current_image = image;
208         imd = wim_get_current_image_metadata(w);
209         if (imd->root_dentry) {
210                 ret = 0;
211         } else {
212                 #ifdef ENABLE_DEBUG
213                 DEBUG("Reading metadata resource specified by the following "
214                       "lookup table entry:");
215                 print_lookup_table_entry(imd->metadata_lte, stderr);
216                 #endif
217                 ret = read_metadata_resource(w, imd);
218                 if (ret)
219                         w->current_image = WIMLIB_NO_IMAGE;
220         }
221         return ret;
222 }
223
224
225 /* Returns the compression type of the WIM file. */
226 WIMLIBAPI int
227 wimlib_get_compression_type(const WIMStruct *w)
228 {
229         return wim_hdr_flags_compression_type(w->hdr.flags);
230 }
231
232 WIMLIBAPI const tchar *
233 wimlib_get_compression_type_string(int ctype)
234 {
235         switch (ctype) {
236                 case WIMLIB_COMPRESSION_TYPE_NONE:
237                         return T("None");
238                 case WIMLIB_COMPRESSION_TYPE_LZX:
239                         return T("LZX");
240                 case WIMLIB_COMPRESSION_TYPE_XPRESS:
241                         return T("XPRESS");
242                 default:
243                         return T("Invalid");
244         }
245 }
246
247 /*
248  * Returns the number of an image in the WIM file, given a string that is either
249  * the number of the image, or the name of the image.  The images are numbered
250  * starting at 1.
251  */
252 WIMLIBAPI int
253 wimlib_resolve_image(WIMStruct *w, const tchar *image_name_or_num)
254 {
255         tchar *p;
256         long image;
257         int i;
258
259         if (!image_name_or_num || !*image_name_or_num)
260                 return WIMLIB_NO_IMAGE;
261
262         if (!tstrcasecmp(image_name_or_num, T("all"))
263             || !tstrcasecmp(image_name_or_num, T("*")))
264                 return WIMLIB_ALL_IMAGES;
265         image = tstrtol(image_name_or_num, &p, 10);
266         if (p != image_name_or_num && *p == T('\0') && image > 0) {
267                 if (image > w->hdr.image_count)
268                         return WIMLIB_NO_IMAGE;
269                 return image;
270         } else {
271                 for (i = 1; i <= w->hdr.image_count; i++) {
272                         if (!tstrcmp(image_name_or_num,
273                                      wimlib_get_image_name(w, i)))
274                                 return i;
275                 }
276                 return WIMLIB_NO_IMAGE;
277         }
278 }
279
280 /* Prints some basic information about a WIM file. */
281 WIMLIBAPI void
282 wimlib_print_wim_information(const WIMStruct *w)
283 {
284         const struct wim_header *hdr;
285
286         hdr = &w->hdr;
287         tputs(T("WIM Information:"));
288         tputs(T("----------------"));
289         tprintf(T("Path:           %"TS"\n"), w->filename);
290         tfputs(T("GUID:           0x"), stdout);
291         print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
292         tputchar(T('\n'));
293         tprintf(T("Image Count:    %d\n"), hdr->image_count);
294         tprintf(T("Compression:    %"TS"\n"),
295                 wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
296         tprintf(T("Part Number:    %d/%d\n"), hdr->part_number, hdr->total_parts);
297         tprintf(T("Boot Index:     %d\n"), hdr->boot_idx);
298         tprintf(T("Size:           %"PRIu64" bytes\n"),
299                 wim_info_get_total_bytes(w->wim_info));
300         tprintf(T("Integrity Info: %"TS"\n"),
301                 (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
302         tputchar(T('\n'));
303 }
304
305 WIMLIBAPI bool
306 wimlib_has_integrity_table(const WIMStruct *w)
307 {
308         return w->hdr.integrity.size != 0;
309 }
310
311 WIMLIBAPI void
312 wimlib_print_available_images(const WIMStruct *w, int image)
313 {
314         int first;
315         int last;
316         int i;
317         int n;
318         if (image == WIMLIB_ALL_IMAGES) {
319                 n = tprintf(T("Available Images:\n"));
320                 first = 1;
321                 last = w->hdr.image_count;
322         } else if (image >= 1 && image <= w->hdr.image_count) {
323                 n = tprintf(T("Information for Image %d\n"), image);
324                 first = image;
325                 last = image;
326         } else {
327                 tprintf(T("wimlib_print_available_images(): Invalid image %d"),
328                         image);
329                 return;
330         }
331         for (i = 0; i < n - 1; i++)
332                 tputchar(T('-'));
333         tputchar(T('\n'));
334         for (i = first; i <= last; i++)
335                 print_image_info(w->wim_info, i);
336 }
337
338
339 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
340  * not WIMLIB_NO_IMAGE. */
341 WIMLIBAPI int
342 wimlib_print_metadata(WIMStruct *w, int image)
343 {
344         if (w->hdr.part_number != 1) {
345                 ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
346                        w->hdr.part_number, w->hdr.total_parts);
347                 ERROR("Select the first part of the split WIM to see the metadata.");
348                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
349         }
350         return for_image(w, image, image_print_metadata);
351 }
352
353 WIMLIBAPI int
354 wimlib_print_files(WIMStruct *w, int image)
355 {
356         if (w->hdr.part_number != 1) {
357                 ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
358                        w->hdr.part_number, w->hdr.total_parts);
359                 ERROR("Select the first part of the split WIM if you'd like to list the files.");
360                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
361         }
362         return for_image(w, image, image_print_files);
363 }
364
365 /* Sets the index of the bootable image. */
366 WIMLIBAPI int
367 wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
368 {
369         if (w->hdr.total_parts != 1) {
370                 ERROR("Cannot modify the boot index of a split WIM!");
371                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
372         }
373         if (boot_idx < 0 || boot_idx > w->hdr.image_count)
374                 return WIMLIB_ERR_INVALID_IMAGE;
375         w->hdr.boot_idx = boot_idx;
376         return 0;
377 }
378
379 WIMLIBAPI int
380 wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
381 {
382         if (total_parts_ret)
383                 *total_parts_ret = w->hdr.total_parts;
384         return w->hdr.part_number;
385 }
386
387
388 WIMLIBAPI int
389 wimlib_get_boot_idx(const WIMStruct *w)
390 {
391         return w->hdr.boot_idx;
392 }
393
394 /*
395  * Begins the reading of a WIM file; opens the file and reads its header and
396  * lookup table, and optionally checks the integrity.
397  */
398 static int
399 begin_read(WIMStruct *w, const tchar *in_wim_path, int open_flags,
400            wimlib_progress_func_t progress_func)
401 {
402         int ret;
403         int xml_num_images;
404
405         DEBUG("Reading the WIM file `%"TS"'", in_wim_path);
406
407         w->fp = tfopen(in_wim_path, T("rb"));
408         if (!w->fp) {
409                 ERROR_WITH_ERRNO("Failed to open `%"TS"' for reading",
410                                  in_wim_path);
411                 return WIMLIB_ERR_OPEN;
412         }
413
414         /* The absolute path to the WIM is requested so that wimlib_overwrite()
415          * still works even if the process changes its working directory.  This
416          * actually happens if a WIM is mounted read-write, since the FUSE
417          * thread changes directory to "/", and it needs to be able to find the
418          * WIM file again.
419          *
420          * This will break if the full path to the WIM changes in the
421          * intervening time...
422          *
423          * Warning: in Windows native builds, realpath() calls the replacement
424          * function in win32.c.
425          */
426         w->filename = realpath(in_wim_path, NULL);
427         if (!w->filename) {
428                 ERROR_WITH_ERRNO("Failed to resolve WIM filename");
429                 if (errno == ENOMEM)
430                         return WIMLIB_ERR_NOMEM;
431                 else
432                         return WIMLIB_ERR_OPEN;
433         }
434
435         ret = read_header(w->fp, &w->hdr, open_flags);
436         if (ret)
437                 return ret;
438
439         DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
440
441         /* If the boot index is invalid, print a warning and set it to 0 */
442         if (w->hdr.boot_idx > w->hdr.image_count) {
443                 WARNING("In `%"TS"', image %u is marked as bootable, "
444                         "but there are only %u images in the WIM",
445                         in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
446                 w->hdr.boot_idx = 0;
447         }
448
449         if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
450                 ERROR("Invalid compression type (WIM header flags = 0x%x)",
451                       w->hdr.flags);
452                 return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
453         }
454
455         if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
456                 ret = check_wim_integrity(w, progress_func);
457                 if (ret == WIM_INTEGRITY_NONEXISTENT) {
458                         WARNING("No integrity information for `%"TS"'; skipping "
459                                 "integrity check.", in_wim_path);
460                 } else if (ret == WIM_INTEGRITY_NOT_OK) {
461                         ERROR("WIM is not intact! (Failed integrity check)");
462                         return WIMLIB_ERR_INTEGRITY;
463                 } else if (ret != WIM_INTEGRITY_OK) {
464                         return ret;
465                 }
466         }
467
468         if (w->hdr.image_count != 0 && w->hdr.part_number == 1) {
469                 w->image_metadata = new_image_metadata_array(w->hdr.image_count);
470                 if (!w->image_metadata)
471                         return WIMLIB_ERR_NOMEM;
472         }
473
474         ret = read_lookup_table(w);
475         if (ret)
476                 return ret;
477
478         ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
479                             &w->xml_data, &w->wim_info);
480         if (ret)
481                 return ret;
482
483         xml_num_images = wim_info_get_num_images(w->wim_info);
484         if (xml_num_images != w->hdr.image_count) {
485                 ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
486                       "in the XML data,", in_wim_path, xml_num_images);
487                 ERROR("but %u images in the WIM!  There must be exactly one "
488                       "<IMAGE> element per image.", w->hdr.image_count);
489                 return WIMLIB_ERR_IMAGE_COUNT;
490         }
491
492         DEBUG("Done beginning read of WIM file `%"TS"'.", in_wim_path);
493         return 0;
494 }
495
496 /*
497  * Opens a WIM file and creates a WIMStruct for it.
498  */
499 WIMLIBAPI int
500 wimlib_open_wim(const tchar *wim_file, int open_flags,
501                 WIMStruct **w_ret,
502                 wimlib_progress_func_t progress_func)
503 {
504         WIMStruct *w;
505         int ret;
506
507         if (!wim_file || !w_ret)
508                 return WIMLIB_ERR_INVALID_PARAM;
509
510         w = new_wim_struct();
511         if (!w)
512                 return WIMLIB_ERR_NOMEM;
513
514         ret = begin_read(w, wim_file, open_flags, progress_func);
515         if (ret == 0)
516                 *w_ret = w;
517         else
518                 wimlib_free(w);
519         return ret;
520 }
521
522 void
523 destroy_image_metadata(struct wim_image_metadata *imd,
524                        struct wim_lookup_table *table,
525                        bool free_metadata_lte)
526 {
527         free_dentry_tree(imd->root_dentry, table);
528         imd->root_dentry = NULL;
529         free_security_data(imd->security_data);
530         imd->security_data = NULL;
531
532         if (free_metadata_lte) {
533                 free_lookup_table_entry(imd->metadata_lte);
534                 imd->metadata_lte = NULL;
535         }
536         if (!table) {
537                 struct wim_lookup_table_entry *lte, *tmp;
538                 list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
539                         free_lookup_table_entry(lte);
540         }
541         INIT_LIST_HEAD(&imd->unhashed_streams);
542         INIT_LIST_HEAD(&imd->inode_list);
543 }
544
545 void
546 put_image_metadata(struct wim_image_metadata *imd,
547                    struct wim_lookup_table *table)
548 {
549         if (imd && --imd->refcnt == 0) {
550                 destroy_image_metadata(imd, table, true);
551                 FREE(imd);
552         }
553 }
554
555 /* Appends the specified image metadata structure to the array of image metadata
556  * for a WIM, and increments the image count. */
557 int
558 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd)
559 {
560         struct wim_image_metadata **imd_array;
561
562         DEBUG("Reallocating image metadata array for image_count = %u",
563               w->hdr.image_count + 1);
564         imd_array = REALLOC(w->image_metadata,
565                             sizeof(w->image_metadata[0]) * (w->hdr.image_count + 1));
566
567         if (!imd_array)
568                 return WIMLIB_ERR_NOMEM;
569         w->image_metadata = imd_array;
570         imd_array[w->hdr.image_count++] = imd;
571         return 0;
572 }
573
574
575 struct wim_image_metadata *
576 new_image_metadata()
577 {
578         struct wim_image_metadata *imd;
579         
580         imd = CALLOC(1, sizeof(*imd));
581         if (imd) {
582                 imd->refcnt = 1;
583                 INIT_LIST_HEAD(&imd->inode_list);
584                 INIT_LIST_HEAD(&imd->unhashed_streams);
585                 DEBUG("Created new image metadata (refcnt=1)");
586         } else {
587                 ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
588         }
589         return imd;
590 }
591
592 struct wim_image_metadata **
593 new_image_metadata_array(unsigned num_images)
594 {
595         struct wim_image_metadata **imd_array;
596
597         DEBUG("Creating new image metadata array for %u images",
598               num_images);
599
600         imd_array = CALLOC(num_images, sizeof(imd_array[0]));
601
602         if (!imd_array) {
603                 ERROR("Failed to allocate memory for %u image metadata structures",
604                       num_images);
605                 return NULL;
606         }
607         for (unsigned i = 0; i < num_images; i++) {
608                 imd_array[i] = new_image_metadata();
609                 if (!imd_array[i]) {
610                         for (unsigned j = 0; j < i; j++)
611                                 put_image_metadata(imd_array[j], NULL);
612                         FREE(imd_array);
613                         return NULL;
614                 }
615         }
616         return imd_array;
617 }
618
619 /* Frees the memory for the WIMStruct, including all internal memory; also
620  * closes all files associated with the WIMStruct.  */
621 WIMLIBAPI void
622 wimlib_free(WIMStruct *w)
623 {
624         DEBUG("Freeing WIMStruct");
625
626         if (!w)
627                 return;
628         if (w->fp)
629                 fclose(w->fp);
630         if (w->out_fp)
631                 fclose(w->out_fp);
632
633 #ifdef WITH_FUSE
634         if (w->fp_tab) {
635                 for (size_t i = 0; i < w->num_allocated_fps; i++)
636                         if (w->fp_tab[i])
637                                 fclose(w->fp_tab[i]);
638                 FREE(w->fp_tab);
639         }
640         pthread_mutex_destroy(&w->fp_tab_mutex);
641 #endif
642
643         free_lookup_table(w->lookup_table);
644
645         FREE(w->filename);
646         FREE(w->xml_data);
647         free_wim_info(w->wim_info);
648         if (w->image_metadata) {
649                 for (unsigned i = 0; i < w->hdr.image_count; i++)
650                         put_image_metadata(w->image_metadata[i], NULL);
651                 FREE(w->image_metadata);
652         }
653 #ifdef WITH_NTFS_3G
654         if (w->ntfs_vol) {
655                 DEBUG("Unmounting NTFS volume");
656                 ntfs_umount(w->ntfs_vol, FALSE);
657         }
658 #endif
659         FREE(w);
660         DEBUG("Freed WIMStruct");
661 }
662
663 static bool
664 test_locale_ctype_utf8()
665 {
666 #ifdef __WIN32__
667         return false;
668 #else
669         char *ctype = nl_langinfo(CODESET);
670
671         return (!strstr(ctype, "UTF-8") ||
672                 !strstr(ctype, "UTF8") ||
673                 !strstr(ctype, "utf8") ||
674                 !strstr(ctype, "utf-8"));
675 #endif
676 }
677
678 /* Get global memory allocations out of the way,
679  * single-threaded programs like 'imagex'. */
680 WIMLIBAPI int
681 wimlib_global_init()
682 {
683         libxml_global_init();
684 #ifdef WITH_NTFS_3G
685         libntfs3g_global_init();
686 #endif
687         wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
688 #ifdef __WIN32__
689         win32_global_init();
690 #endif
691         return 0;
692 }
693
694 /* Free global memory allocations.  Not strictly necessary if the process using
695  * wimlib is just about to exit (as is the case for 'imagex'). */
696 WIMLIBAPI void
697 wimlib_global_cleanup()
698 {
699         libxml_global_cleanup();
700         iconv_global_cleanup();
701 #ifdef __WIN32__
702         win32_global_cleanup();
703 #endif
704 }