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