wimlib.net Git - wimlib/blob - src/modify.c

   1 /*
   2  * modify.c
   3  *
   4  * Support for modifying WIM files with image-level operations (delete an image,
   5  * add an image, export an image from one WIM to another.)  There is nothing
   6  * here that lets you change individual files in the WIM; for that you will need
   7  * to look at the filesystem implementation in mount.c.
   8  */
   9
  10 /*
  11  * Copyright (C) 2012 Eric Biggers
  12  *
  13  * This file is part of wimlib, a library for working with WIM files.
  14  *
  15  * wimlib is free software; you can redistribute it and/or modify it under the
  16  * terms of the GNU General Public License as published by the Free
  17  * Software Foundation; either version 3 of the License, or (at your option)
  18  * any later version.
  19  *
  20  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  21  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  22  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  23  * details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  27  */
  28
  29 #include "wimlib_internal.h"
  30 #include "util.h"
  31 #include "sha1.h"
  32 #include "dentry.h"
  33 #include "xml.h"
  34 #include "lookup_table.h"
  35 #include <sys/stat.h>
  36 #include <dirent.h>
  37 #include <string.h>
  38 #include <errno.h>
  39 #include <fnmatch.h>
  40 #include <ctype.h>
  41 #include <unistd.h>
  42
  43 /** Private flag: Used to mark that we currently adding the root directory of
  44  * the WIM image. */
  45 #define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000
  46
  47 void destroy_image_metadata(struct image_metadata *imd, struct lookup_table *lt)
  48 {
  49         free_dentry_tree(imd->root_dentry, lt);
  50         free_security_data(imd->security_data);
  51
  52         /* Get rid of the lookup table entry for this image's metadata resource
  53          * */
  54         if (lt)
  55                 lookup_table_remove(lt, imd->metadata_lte);
  56 }
  57
  58 /*
  59  * Recursively builds a dentry tree from a directory tree on disk, outside the
  60  * WIM file.
  61  *
  62  * @root_ret:   Place to return a pointer to the root of the dentry tree.  Only
  63  *              modified if successful.  NULL if the file or directory was
  64  *              excluded from capture.
  65  *
  66  * @root_disk_path:  The path to the root of the directory tree on disk.
  67  *
  68  * @lookup_table: The lookup table for the WIM file.  For each file added to the
  69  *              dentry tree being built, an entry is added to the lookup table,
  70  *              unless an identical stream is already in the lookup table.
  71  *              These lookup table entries that are added point to the path of
  72  *              the file on disk.
  73  *
  74  * @sd:         Ignored.  (Security data only captured in NTFS mode.)
  75  *
  76  * @capture_config:
  77  *              Configuration for files to be excluded from capture.
  78  *
  79  * @add_flags:  Bitwise or of WIMLIB_ADD_IMAGE_FLAG_*
  80  *
  81  * @extra_arg:  Ignored. (Only used in NTFS mode.)
  82  *
  83  * @return:     0 on success, nonzero on failure.  It is a failure if any of
  84  *              the files cannot be `stat'ed, or if any of the needed
  85  *              directories cannot be opened or read.  Failure to add the files
  86  *              to the WIM may still occur later when trying to actually read
  87  *              the on-disk files during a call to wimlib_write() or
  88  *              wimlib_overwrite().
  89  */
  90 static int build_dentry_tree(struct dentry **root_ret,
  91                              const char *root_disk_path,
  92                              struct lookup_table *lookup_table,
  93                              struct wim_security_data *sd,
  94                              const struct capture_config *config,
  95                              int add_flags,
  96                              void *extra_arg)
  97 {
  98         struct stat root_stbuf;
  99         int ret = 0;
 100         int (*stat_fn)(const char *restrict, struct stat *restrict);
 101         struct dentry *root;
 102         const char *filename;
 103
 104         if (exclude_path(root_disk_path, config, true)) {
 105                 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
 106                         ERROR("Cannot exclude the root directory from capture");
 107                         return WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
 108                 }
 109                 if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
 110                         printf("Excluding file `%s' from capture\n",
 111                                root_disk_path);
 112                 *root_ret = NULL;
 113                 return 0;
 114         }
 115
 116
 117         if (add_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE)
 118                 stat_fn = stat;
 119         else
 120                 stat_fn = lstat;
 121
 122         if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
 123                 printf("Scanning `%s'\n", root_disk_path);
 124
 125         ret = (*stat_fn)(root_disk_path, &root_stbuf);
 126         if (ret != 0) {
 127                 ERROR_WITH_ERRNO("Failed to stat `%s'", root_disk_path);
 128                 return WIMLIB_ERR_STAT;
 129         }
 130
 131         if ((add_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) &&
 132               !S_ISDIR(root_stbuf.st_mode)) {
 133                 ERROR("`%s' is not a directory", root_disk_path);
 134                 return WIMLIB_ERR_NOTDIR;
 135         }
 136         if (!S_ISREG(root_stbuf.st_mode) && !S_ISDIR(root_stbuf.st_mode)
 137             && !S_ISLNK(root_stbuf.st_mode)) {
 138                 ERROR("`%s' is not a regular file, directory, or symbolic link.",
 139                       root_disk_path);
 140                 return WIMLIB_ERR_SPECIAL_FILE;
 141         }
 142
 143         if (add_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT)
 144                 filename = "";
 145         else
 146                 filename = path_basename(root_disk_path);
 147
 148         root = new_dentry_with_timeless_inode(filename);
 149         if (!root)
 150                 return WIMLIB_ERR_NOMEM;
 151
 152         stbuf_to_inode(&root_stbuf, root->d_inode);
 153         add_flags &= ~WIMLIB_ADD_IMAGE_FLAG_ROOT;
 154         root->d_inode->resolved = true;
 155
 156         if (dentry_is_directory(root)) { /* Archiving a directory */
 157                 DIR *dir;
 158                 struct dirent *p;
 159                 struct dentry *child;
 160
 161                 dir = opendir(root_disk_path);
 162                 if (!dir) {
 163                         ERROR_WITH_ERRNO("Failed to open the directory `%s'",
 164                                          root_disk_path);
 165                         ret = WIMLIB_ERR_OPEN;
 166                         goto out;
 167                 }
 168
 169                 /* Buffer for names of files in directory. */
 170                 size_t len = strlen(root_disk_path);
 171                 char name[len + 1 + FILENAME_MAX + 1];
 172                 memcpy(name, root_disk_path, len);
 173                 name[len] = '/';
 174
 175                 /* Create a dentry for each entry in the directory on disk, and recurse
 176                  * to any subdirectories. */
 177                 while (1) {
 178                         errno = 0;
 179                         p = readdir(dir);
 180                         if (p == NULL) {
 181                                 if (errno) {
 182                                         ret = WIMLIB_ERR_READ;
 183                                         ERROR_WITH_ERRNO("Error reading the "
 184                                                          "directory `%s'",
 185                                                          root_disk_path);
 186                                 }
 187                                 break;
 188                         }
 189                         if (p->d_name[0] == '.' && (p->d_name[1] == '\0'
 190                               || (p->d_name[1] == '.' && p->d_name[2] == '\0')))
 191                                         continue;
 192                         strcpy(name + len + 1, p->d_name);
 193                         ret = build_dentry_tree(&child, name, lookup_table,
 194                                                 NULL, config,
 195                                                 add_flags, NULL);
 196                         if (ret != 0)
 197                                 break;
 198                         if (child)
 199                                 link_dentry(child, root);
 200                 }
 201                 closedir(dir);
 202         } else if (dentry_is_symlink(root)) { /* Archiving a symbolic link */
 203                 char deref_name_buf[4096];
 204                 ssize_t deref_name_len;
 205
 206                 deref_name_len = readlink(root_disk_path, deref_name_buf,
 207                                           sizeof(deref_name_buf) - 1);
 208                 if (deref_name_len >= 0) {
 209                         deref_name_buf[deref_name_len] = '\0';
 210                         DEBUG("Read symlink `%s'", deref_name_buf);
 211                         ret = inode_set_symlink(root->d_inode, deref_name_buf,
 212                                                 lookup_table, NULL);
 213                 } else {
 214                         ERROR_WITH_ERRNO("Failed to read target of "
 215                                          "symbolic link `%s'", root_disk_path);
 216                         ret = WIMLIB_ERR_READLINK;
 217                 }
 218         } else { /* Archiving a regular file */
 219
 220                 struct lookup_table_entry *lte;
 221                 u8 hash[SHA1_HASH_SIZE];
 222
 223                 /* Empty files do not have to have a lookup table entry. */
 224                 if (root_stbuf.st_size == 0)
 225                         goto out;
 226
 227                 /* For each regular file, we must check to see if the file is in
 228                  * the lookup table already; if it is, we increment its refcnt;
 229                  * otherwise, we create a new lookup table entry and insert it.
 230                  * */
 231
 232                 ret = sha1sum(root_disk_path, hash);
 233                 if (ret != 0)
 234                         goto out;
 235
 236                 lte = __lookup_resource(lookup_table, hash);
 237                 if (lte) {
 238                         lte->refcnt++;
 239                         DEBUG("Add lte reference %u for `%s'", lte->refcnt,
 240                               root_disk_path);
 241                 } else {
 242                         char *file_on_disk = STRDUP(root_disk_path);
 243                         if (!file_on_disk) {
 244                                 ERROR("Failed to allocate memory for file path");
 245                                 ret = WIMLIB_ERR_NOMEM;
 246                                 goto out;
 247                         }
 248                         lte = new_lookup_table_entry();
 249                         if (!lte) {
 250                                 FREE(file_on_disk);
 251                                 ret = WIMLIB_ERR_NOMEM;
 252                                 goto out;
 253                         }
 254                         lte->file_on_disk = file_on_disk;
 255                         lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
 256                         lte->resource_entry.original_size = root_stbuf.st_size;
 257                         lte->resource_entry.size = root_stbuf.st_size;
 258                         copy_hash(lte->hash, hash);
 259                         lookup_table_insert(lookup_table, lte);
 260                 }
 261                 root->d_inode->lte = lte;
 262         }
 263 out:
 264         if (ret == 0)
 265                 *root_ret = root;
 266         else
 267                 free_dentry_tree(root, lookup_table);
 268         return ret;
 269 }
 270
 271 struct wim_pair {
 272         WIMStruct *src_wim;
 273         WIMStruct *dest_wim;
 274         struct list_head lte_list_head;
 275 };
 276
 277 static int allocate_lte_if_needed(struct dentry *dentry, void *arg)
 278 {
 279         const WIMStruct *src_wim, *dest_wim;
 280         struct list_head *lte_list_head;
 281         struct inode *inode;
 282
 283         src_wim = ((struct wim_pair*)arg)->src_wim;
 284         dest_wim = ((struct wim_pair*)arg)->dest_wim;
 285         lte_list_head = &((struct wim_pair*)arg)->lte_list_head;
 286         inode = dentry->d_inode;
 287
 288         wimlib_assert(!inode->resolved);
 289
 290         for (unsigned i = 0; i <= inode->num_ads; i++) {
 291                 struct lookup_table_entry *src_lte, *dest_lte;
 292                 src_lte = inode_stream_lte_unresolved(inode, i,
 293                                                       src_wim->lookup_table);
 294
 295                 if (src_lte && ++src_lte->out_refcnt == 1) {
 296                         dest_lte = inode_stream_lte_unresolved(inode, i,
 297                                                                dest_wim->lookup_table);
 298
 299                         if (!dest_lte) {
 300                                 dest_lte = clone_lookup_table_entry(src_lte);
 301                                 if (!dest_lte)
 302                                         return WIMLIB_ERR_NOMEM;
 303                                 list_add_tail(&dest_lte->list, lte_list_head);
 304                         }
 305                 }
 306         }
 307         return 0;
 308 }
 309
 310 /*
 311  * This function takes in a dentry that was previously located only in image(s)
 312  * in @src_wim, but now is being added to @dest_wim.  For each stream associated
 313  * with the dentry, if there is already a lookup table entry for that stream in
 314  * the lookup table of the destination WIM file, its reference count is
 315  * incrementej.  Otherwise, a new lookup table entry is created that points back
 316  * to the stream in the source WIM file (through the @hash field combined with
 317  * the @wim field of the lookup table entry.)
 318  */
 319 static int add_lte_to_dest_wim(struct dentry *dentry, void *arg)
 320 {
 321         WIMStruct *src_wim, *dest_wim;
 322         struct inode *inode;
 323
 324         src_wim = ((struct wim_pair*)arg)->src_wim;
 325         dest_wim = ((struct wim_pair*)arg)->dest_wim;
 326         inode = dentry->d_inode;
 327
 328         wimlib_assert(!inode->resolved);
 329
 330         for (unsigned i = 0; i <= inode->num_ads; i++) {
 331                 struct lookup_table_entry *src_lte, *dest_lte;
 332                 src_lte = inode_stream_lte_unresolved(inode, i,
 333                                                       src_wim->lookup_table);
 334
 335                 if (!src_lte) /* Empty or nonexistent stream. */
 336                         continue;
 337
 338                 dest_lte = inode_stream_lte_unresolved(inode, i,
 339                                                        dest_wim->lookup_table);
 340                 if (dest_lte) {
 341                         dest_lte->refcnt++;
 342                 } else {
 343                         struct list_head *lte_list_head;
 344                         struct list_head *next;
 345
 346                         lte_list_head = &((struct wim_pair*)arg)->lte_list_head;
 347                         wimlib_assert(!list_empty(lte_list_head));
 348
 349                         next = lte_list_head->next;
 350                         list_del(next);
 351                         dest_lte = container_of(next, struct lookup_table_entry, list);
 352                         dest_lte->part_number = 1;
 353                         dest_lte->refcnt = 1;
 354                         wimlib_assert(hashes_equal(dest_lte->hash, src_lte->hash));
 355
 356                         lookup_table_insert(dest_wim->lookup_table, dest_lte);
 357                 }
 358         }
 359         return 0;
 360 }
 361
 362 /*
 363  * Adds an image (given by its dentry tree) to the image metadata array of a WIM
 364  * file, adds an entry to the lookup table for the image metadata, updates the
 365  * image count in the header, and selects the new image.
 366  *
 367  * Does not update the XML data.
 368  *
 369  * On failure, WIMLIB_ERR_NOMEM is returned and no changes are made.  Otherwise,
 370  * 0 is returned and the image metadata array of @w is modified.
 371  *
 372  * @w:            The WIMStruct for the WIM file.
 373  * @root_dentry:  The root of the directory tree for the image.
 374  * @sd:           The security data for the image.
 375  */
 376 static int add_new_dentry_tree(WIMStruct *w, struct dentry *root_dentry,
 377                                struct wim_security_data *sd)
 378 {
 379         struct lookup_table_entry *metadata_lte;
 380         struct image_metadata *imd;
 381         struct image_metadata *new_imd;
 382         int ret;
 383
 384         wimlib_assert(root_dentry != NULL);
 385
 386         DEBUG("Reallocating image metadata array for image_count = %u",
 387               w->hdr.image_count + 1);
 388         imd = CALLOC((w->hdr.image_count + 1), sizeof(struct image_metadata));
 389
 390         if (!imd) {
 391                 ERROR("Failed to allocate memory for new image metadata array");
 392                 return WIMLIB_ERR_NOMEM;
 393         }
 394
 395         memcpy(imd, w->image_metadata,
 396                w->hdr.image_count * sizeof(struct image_metadata));
 397
 398         metadata_lte = new_lookup_table_entry();
 399         if (!metadata_lte)
 400                 goto out_free_imd;
 401
 402         metadata_lte->resource_entry.flags = WIM_RESHDR_FLAG_METADATA;
 403         random_hash(metadata_lte->hash);
 404         lookup_table_insert(w->lookup_table, metadata_lte);
 405
 406         new_imd = &imd[w->hdr.image_count];
 407
 408         new_imd->root_dentry    = root_dentry;
 409         new_imd->metadata_lte   = metadata_lte;
 410         new_imd->security_data  = sd;
 411         new_imd->modified       = true;
 412
 413         FREE(w->image_metadata);
 414         w->image_metadata       = imd;
 415         w->hdr.image_count++;
 416
 417         /* Change the current image to the new one.  There should not be any
 418          * ways for this to fail, since the image is valid and the dentry tree
 419          * is already in memory. */
 420         ret = select_wim_image(w, w->hdr.image_count);
 421         wimlib_assert(ret == 0);
 422         return ret;
 423 out_free_metadata_lte:
 424         FREE(metadata_lte);
 425 out_free_imd:
 426         FREE(imd);
 427         return WIMLIB_ERR_NOMEM;
 428
 429 }
 430
 431 /*
 432  * Copies an image, or all the images, from a WIM file, into another WIM file.
 433  */
 434 WIMLIBAPI int wimlib_export_image(WIMStruct *src_wim,
 435                                   int src_image,
 436                                   WIMStruct *dest_wim,
 437                                   const char *dest_name,
 438                                   const char *dest_description,
 439                                   int flags,
 440                                   WIMStruct **additional_swms,
 441                                   unsigned num_additional_swms)
 442 {
 443         int i;
 444         int ret;
 445         struct dentry *root;
 446         struct wim_pair wims;
 447         struct wim_security_data *sd;
 448         struct lookup_table *joined_tab, *src_wim_tab_save;
 449
 450         if (!src_wim || !dest_wim)
 451                 return WIMLIB_ERR_INVALID_PARAM;
 452
 453         if (dest_wim->hdr.total_parts != 1) {
 454                 ERROR("Exporting an image to a split WIM is "
 455                       "unsupported");
 456                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
 457         }
 458
 459         if (src_image == WIM_ALL_IMAGES) {
 460                 if (src_wim->hdr.image_count > 1) {
 461
 462                         /* multi-image export. */
 463
 464                         if ((flags & WIMLIB_EXPORT_FLAG_BOOT) &&
 465                               (src_wim->hdr.boot_idx == 0))
 466                         {
 467                                 /* Specifying the boot flag on a multi-image
 468                                  * source WIM makes the boot index default to
 469                                  * the bootable image in the source WIM.  It is
 470                                  * an error if there is no such bootable image.
 471                                  * */
 472                                 ERROR("Cannot specify `boot' flag when "
 473                                       "exporting multiple images from a WIM "
 474                                       "with no bootable images");
 475                                 return WIMLIB_ERR_INVALID_PARAM;
 476                         }
 477                         if (dest_name || dest_description) {
 478                                 ERROR("Image name or image description was "
 479                                       "specified, but we are exporting "
 480                                       "multiple images");
 481                                 return WIMLIB_ERR_INVALID_PARAM;
 482                         }
 483                         for (i = 1; i <= src_wim->hdr.image_count; i++) {
 484                                 int export_flags = flags;
 485
 486                                 if (i != src_wim->hdr.boot_idx)
 487                                         export_flags &= ~WIMLIB_EXPORT_FLAG_BOOT;
 488
 489                                 ret = wimlib_export_image(src_wim, i, dest_wim,
 490                                                           NULL, NULL,
 491                                                           export_flags,
 492                                                           additional_swms,
 493                                                           num_additional_swms);
 494                                 if (ret != 0)
 495                                         return ret;
 496                         }
 497                         return 0;
 498                 } else {
 499                         src_image = 1;
 500                 }
 501         }
 502
 503         if (!dest_name) {
 504                 dest_name = wimlib_get_image_name(src_wim, src_image);
 505                 DEBUG("Using name `%s' for source image %d",
 506                       dest_name, src_image);
 507         }
 508
 509         if (!dest_description) {
 510                 dest_description = wimlib_get_image_description(src_wim,
 511                                                                 src_image);
 512                 DEBUG("Using description `%s' for source image %d",
 513                       dest_description, src_image);
 514         }
 515
 516         DEBUG("Exporting image %d from `%s'", src_image, src_wim->filename);
 517
 518         if (wimlib_image_name_in_use(dest_wim, dest_name)) {
 519                 ERROR("There is already an image named `%s' in the "
 520                       "destination WIM", dest_name);
 521                 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
 522         }
 523
 524         ret = verify_swm_set(src_wim, additional_swms, num_additional_swms);
 525         if (ret != 0)
 526                 return ret;
 527
 528         if (num_additional_swms) {
 529                 ret = new_joined_lookup_table(src_wim, additional_swms,
 530                                               num_additional_swms,
 531                                               &joined_tab);
 532                 if (ret != 0)
 533                         return ret;
 534                 src_wim_tab_save = src_wim->lookup_table;
 535                 src_wim->lookup_table = joined_tab;
 536         }
 537
 538         ret = select_wim_image(src_wim, src_image);
 539         if (ret != 0) {
 540                 ERROR("Could not select image %d from the WIM `%s' "
 541                       "to export it", src_image, src_wim->filename);
 542                 goto out;
 543         }
 544
 545         /* Pre-allocate the new lookup table entries that will be needed.  This
 546          * way, it's not possible to run out of memory part-way through
 547          * modifying the lookup table of the destination WIM. */
 548         wims.src_wim = src_wim;
 549         wims.dest_wim = dest_wim;
 550         INIT_LIST_HEAD(&wims.lte_list_head);
 551         for_lookup_table_entry(src_wim->lookup_table, lte_zero_out_refcnt, NULL);
 552         root = wim_root_dentry(src_wim);
 553         for_dentry_in_tree(root, dentry_unresolve_ltes, NULL);
 554         ret = for_dentry_in_tree(root, allocate_lte_if_needed, &wims);
 555         if (ret != 0)
 556                 goto out_free_ltes;
 557
 558         ret = xml_export_image(src_wim->wim_info, src_image,
 559                                &dest_wim->wim_info, dest_name, dest_description);
 560         if (ret != 0)
 561                 goto out_free_ltes;
 562
 563         sd = wim_security_data(src_wim);
 564         ret = add_new_dentry_tree(dest_wim, root, sd);
 565         if (ret != 0)
 566                 goto out_xml_delete_image;
 567
 568
 569         /* All memory allocations have been taken care of, so it's no longer
 570          * possible for this function to fail.  Go ahead and increment the
 571          * reference counts of the dentry tree and security data, then update
 572          * the lookup table of the destination WIM and the boot index, if
 573          * needed. */
 574         for_dentry_in_tree(root, increment_dentry_refcnt, NULL);
 575         sd->refcnt++;
 576         for_dentry_in_tree(root, add_lte_to_dest_wim, &wims);
 577         wimlib_assert(list_empty(&wims.lte_list_head));
 578
 579         if (flags & WIMLIB_EXPORT_FLAG_BOOT) {
 580                 DEBUG("Setting boot_idx to %d", dest_wim->hdr.image_count);
 581                 dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
 582         }
 583         ret = 0;
 584         goto out;
 585
 586 out_xml_delete_image:
 587         xml_delete_image(&dest_wim->wim_info, dest_wim->hdr.image_count);
 588 out_free_ltes:
 589         {
 590                 struct lookup_table_entry *lte, *tmp;
 591                 list_for_each_entry_safe(lte, tmp, &wims.lte_list_head, list)
 592                         free_lookup_table_entry(lte);
 593         }
 594
 595 out:
 596         if (num_additional_swms) {
 597                 free_lookup_table(src_wim->lookup_table);
 598                 src_wim->lookup_table = src_wim_tab_save;
 599         }
 600         return ret;
 601 }
 602
 603 /*
 604  * Deletes an image from the WIM.
 605  */
 606 WIMLIBAPI int wimlib_delete_image(WIMStruct *w, int image)
 607 {
 608         int i;
 609         int ret;
 610
 611         if (w->hdr.total_parts != 1) {
 612                 ERROR("Deleting an image from a split WIM is not supported.");
 613                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
 614         }
 615
 616         if (image == WIM_ALL_IMAGES) {
 617                 for (i = w->hdr.image_count; i >= 1; i--) {
 618                         ret = wimlib_delete_image(w, i);
 619                         if (ret != 0)
 620                                 return ret;
 621                 }
 622                 return 0;
 623         }
 624
 625         DEBUG("Deleting image %d", image);
 626
 627         /* Even if the dentry tree is not allocated, we must select it (and
 628          * therefore allocate it) so that we can decrement the reference counts
 629          * in the lookup table.  */
 630         ret = select_wim_image(w, image);
 631         if (ret != 0)
 632                 return ret;
 633
 634         /* Free the dentry tree, any lookup table entries that have their
 635          * refcnt decremented to 0, and the security data. */
 636         destroy_image_metadata(&w->image_metadata[image - 1], w->lookup_table);
 637
 638         /* Get rid of the empty slot in the image metadata array. */
 639         memmove(&w->image_metadata[image - 1], &w->image_metadata[image],
 640                 (w->hdr.image_count - image) * sizeof(struct image_metadata));
 641
 642         /* Decrement the image count. */
 643         if (--w->hdr.image_count == 0) {
 644                 FREE(w->image_metadata);
 645                 w->image_metadata = NULL;
 646         }
 647
 648         /* Fix the boot index. */
 649         if (w->hdr.boot_idx == image)
 650                 w->hdr.boot_idx = 0;
 651         else if (w->hdr.boot_idx > image)
 652                 w->hdr.boot_idx--;
 653
 654         w->current_image = WIM_NO_IMAGE;
 655
 656         /* Remove the image from the XML information. */
 657         xml_delete_image(&w->wim_info, image);
 658         return 0;
 659 }
 660
 661 enum pattern_type {
 662         NONE = 0,
 663         EXCLUSION_LIST,
 664         EXCLUSION_EXCEPTION,
 665         COMPRESSION_EXCLUSION_LIST,
 666         ALIGNMENT_LIST,
 667 };
 668
 669 /* Default capture configuration file when none is specified. */
 670 static const char *default_config =
 671 "[ExclusionList]\n"
 672 "\\$ntfs.log\n"
 673 "\\hiberfil.sys\n"
 674 "\\pagefile.sys\n"
 675 "\\System Volume Information\n"
 676 "\\RECYCLER\n"
 677 "\\Windows\\CSC\n"
 678 "\n"
 679 "[CompressionExclusionList]\n"
 680 "*.mp3\n"
 681 "*.zip\n"
 682 "*.cab\n"
 683 "\\WINDOWS\\inf\\*.pnf\n";
 684
 685 static void destroy_pattern_list(struct pattern_list *list)
 686 {
 687         FREE(list->pats);
 688 }
 689
 690 static void destroy_capture_config(struct capture_config *config)
 691 {
 692         destroy_pattern_list(&config->exclusion_list);
 693         destroy_pattern_list(&config->exclusion_exception);
 694         destroy_pattern_list(&config->compression_exclusion_list);
 695         destroy_pattern_list(&config->alignment_list);
 696         FREE(config->config_str);
 697         FREE(config->prefix);
 698         memset(config, 0, sizeof(*config));
 699 }
 700
 701 static int pattern_list_add_pattern(struct pattern_list *list,
 702                                     const char *pattern)
 703 {
 704         const char **pats;
 705         if (list->num_pats >= list->num_allocated_pats) {
 706                 pats = REALLOC(list->pats,
 707                                sizeof(list->pats[0]) * (list->num_allocated_pats + 8));
 708                 if (!pats)
 709                         return WIMLIB_ERR_NOMEM;
 710                 list->num_allocated_pats += 8;
 711                 list->pats = pats;
 712         }
 713         list->pats[list->num_pats++] = pattern;
 714         return 0;
 715 }
 716
 717 /* Parses the contents of the image capture configuration file and fills in a
 718  * `struct capture_config'. */
 719 static int init_capture_config(const char *_config_str, size_t config_len,
 720                                const char *_prefix, struct capture_config *config)
 721 {
 722         char *config_str;
 723         char *prefix;
 724         char *p;
 725         char *eol;
 726         char *next_p;
 727         size_t bytes_remaining;
 728         enum pattern_type type = NONE;
 729         int ret;
 730         unsigned long line_no = 0;
 731
 732         DEBUG("config_len = %zu", config_len);
 733         bytes_remaining = config_len;
 734         memset(config, 0, sizeof(*config));
 735         config_str = MALLOC(config_len);
 736         if (!config_str) {
 737                 ERROR("Could not duplicate capture config string");
 738                 return WIMLIB_ERR_NOMEM;
 739         }
 740         prefix = STRDUP(_prefix);
 741         if (!prefix) {
 742                 FREE(config_str);
 743                 return WIMLIB_ERR_NOMEM;
 744         }
 745
 746         memcpy(config_str, _config_str, config_len);
 747         next_p = config_str;
 748         config->config_str = config_str;
 749         config->prefix = prefix;
 750         config->prefix_len = strlen(prefix);
 751         while (bytes_remaining) {
 752                 line_no++;
 753                 p = next_p;
 754                 eol = memchr(p, '\n', bytes_remaining);
 755                 if (!eol) {
 756                         ERROR("Expected end-of-line in capture config file on "
 757                               "line %lu", line_no);
 758                         ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
 759                         goto out_destroy;
 760                 }
 761
 762                 next_p = eol + 1;
 763                 bytes_remaining -= (next_p - p);
 764                 if (eol == p)
 765                         continue;
 766
 767                 if (*(eol - 1) == '\r')
 768                         eol--;
 769                 *eol = '\0';
 770
 771                 /* Translate backslash to forward slash */
 772                 for (char *pp = p; pp != eol; pp++)
 773                         if (*pp == '\\')
 774                                 *pp = '/';
 775
 776                 /* Remove drive letter */
 777                 if (eol - p > 2 && isalpha(*p) && *(p + 1) == ':')
 778                         p += 2;
 779
 780                 ret = 0;
 781                 if (strcmp(p, "[ExclusionList]") == 0)
 782                         type = EXCLUSION_LIST;
 783                 else if (strcmp(p, "[ExclusionException]") == 0)
 784                         type = EXCLUSION_EXCEPTION;
 785                 else if (strcmp(p, "[CompressionExclusionList]") == 0)
 786                         type = COMPRESSION_EXCLUSION_LIST;
 787                 else if (strcmp(p, "[AlignmentList]") == 0)
 788                         type = ALIGNMENT_LIST;
 789                 else if (p[0] == '[' && strrchr(p, ']')) {
 790                         ERROR("Unknown capture configuration section `%s'", p);
 791                         ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
 792                 } else switch (type) {
 793                 case EXCLUSION_LIST:
 794                         DEBUG("Adding pattern \"%s\" to exclusion list", p);
 795                         ret = pattern_list_add_pattern(&config->exclusion_list, p);
 796                         break;
 797                 case EXCLUSION_EXCEPTION:
 798                         DEBUG("Adding pattern \"%s\" to exclusion exception list", p);
 799                         ret = pattern_list_add_pattern(&config->exclusion_exception, p);
 800                         break;
 801                 case COMPRESSION_EXCLUSION_LIST:
 802                         DEBUG("Adding pattern \"%s\" to compression exclusion list", p);
 803                         ret = pattern_list_add_pattern(&config->compression_exclusion_list, p);
 804                         break;
 805                 case ALIGNMENT_LIST:
 806                         DEBUG("Adding pattern \"%s\" to alignment list", p);
 807                         ret = pattern_list_add_pattern(&config->alignment_list, p);
 808                         break;
 809                 default:
 810                         ERROR("Line %lu of capture configuration is not "
 811                               "in a block (such as [ExclusionList])",
 812                               line_no);
 813                         ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
 814                         break;
 815                 }
 816                 if (ret != 0)
 817                         goto out_destroy;
 818         }
 819         return 0;
 820 out_destroy:
 821         destroy_capture_config(config);
 822         return ret;
 823 }
 824
 825 static bool match_pattern(const char *path, const char *path_basename,
 826                           const struct pattern_list *list)
 827 {
 828         for (size_t i = 0; i < list->num_pats; i++) {
 829                 const char *pat = list->pats[i];
 830                 const char *string;
 831                 if (pat[0] == '/')
 832                         /* Absolute path from root of capture */
 833                         string = path;
 834                 else {
 835                         if (strchr(pat, '/'))
 836                                 /* Relative path from root of capture */
 837                                 string = path + 1;
 838                         else
 839                                 /* A file name pattern */
 840                                 string = path_basename;
 841                 }
 842                 if (fnmatch(pat, string, FNM_PATHNAME
 843                         #ifdef FNM_CASEFOLD
 844                                         | FNM_CASEFOLD
 845                         #endif
 846                         ) == 0)
 847                 {
 848                         DEBUG("`%s' matches the pattern \"%s\"",
 849                               string, pat);
 850                         return true;
 851                 }
 852         }
 853         return false;
 854 }
 855
 856 static void print_pattern_list(const struct pattern_list *list)
 857 {
 858         for (size_t i = 0; i < list->num_pats; i++)
 859                 printf("    %s\n", list->pats[i]);
 860 }
 861
 862 static void print_capture_config(const struct capture_config *config)
 863 {
 864         if (config->exclusion_list.num_pats) {
 865                 puts("Files or folders excluded from image capture:");
 866                 print_pattern_list(&config->exclusion_list);
 867                 putchar('\n');
 868         }
 869 }
 870
 871 /* Return true if the image capture configuration file indicates we should
 872  * exclude the filename @path from capture.
 873  *
 874  * If @exclude_prefix is %true, the part of the path up and including the name
 875  * of the directory being captured is not included in the path for matching
 876  * purposes.  This allows, for example, a pattern like /hiberfil.sys to match a
 877  * file /mnt/windows7/hiberfil.sys if we are capturing the /mnt/windows7
 878  * directory.
 879  */
 880 bool exclude_path(const char *path, const struct capture_config *config,
 881                   bool exclude_prefix)
 882 {
 883         const char *basename = path_basename(path);
 884         if (exclude_prefix) {
 885                 wimlib_assert(strlen(path) >= config->prefix_len);
 886                 if (memcmp(config->prefix, path, config->prefix_len) == 0
 887                      && path[config->prefix_len] == '/')
 888                         path += config->prefix_len;
 889         }
 890         return match_pattern(path, basename, &config->exclusion_list) &&
 891                 !match_pattern(path, basename, &config->exclusion_exception);
 892
 893 }
 894
 895
 896
 897 /*
 898  * Adds an image to the WIM, delegating the capture of the dentry tree and
 899  * security data to the function @capture_tree passed as a parameter.
 900  * Currently, @capture_tree may be build_dentry_tree() for capturing a "regular"
 901  * directory tree on disk, or build_dentry_tree_ntfs() for capturing a WIM image
 902  * directory from a NTFS volume using libntfs-3g.
 903  *
 904  * The @capture_tree function is also expected to create lookup table entries
 905  * for all the file streams it captures and insert them into @lookup_table,
 906  * being careful to look for identical entries that already exist and simply
 907  * increment the reference count for them rather than duplicating the entry.
 908  */
 909 int do_add_image(WIMStruct *w, const char *dir, const char *name,
 910                  const char *config_str, size_t config_len,
 911                  int flags,
 912                  int (*capture_tree)(struct dentry **, const char *,
 913                                      struct lookup_table *,
 914                                      struct wim_security_data *,
 915                                      const struct capture_config *,
 916                                      int, void *),
 917                  void *extra_arg)
 918 {
 919         struct dentry *root_dentry = NULL;
 920         struct wim_security_data *sd;
 921         struct capture_config config;
 922         struct inode_table inode_tab;
 923         struct hlist_head inode_list;
 924         int ret;
 925
 926         DEBUG("Adding dentry tree from directory or NTFS volume `%s'.", dir);
 927
 928         if (!name || !*name) {
 929                 ERROR("Must specify a non-empty string for the image name");
 930                 return WIMLIB_ERR_INVALID_PARAM;
 931         }
 932         if (!dir) {
 933                 ERROR("Must specify the name of a directory or NTFS volume");
 934                 return WIMLIB_ERR_INVALID_PARAM;
 935         }
 936
 937         if (w->hdr.total_parts != 1) {
 938                 ERROR("Cannot add an image to a split WIM");
 939                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
 940         }
 941
 942         if (wimlib_image_name_in_use(w, name)) {
 943                 ERROR("There is already an image named \"%s\" in `%s'",
 944                       name, w->filename);
 945                 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
 946         }
 947
 948         DEBUG("Initializing capture configuration");
 949         if (!config_str) {
 950                 DEBUG("Using default capture configuration");
 951                 config_str = default_config;
 952                 config_len = strlen(default_config);
 953         }
 954         ret = init_capture_config(config_str, config_len, dir, &config);
 955         if (ret != 0)
 956                 return ret;
 957         print_capture_config(&config);
 958
 959         DEBUG("Allocating security data");
 960
 961         sd = CALLOC(1, sizeof(struct wim_security_data));
 962         if (!sd) {
 963                 ret = WIMLIB_ERR_NOMEM;
 964                 goto out_destroy_config;
 965         }
 966         sd->total_length = 8;
 967         sd->refcnt = 1;
 968
 969         DEBUG("Building dentry tree.");
 970         ret = (*capture_tree)(&root_dentry, dir, w->lookup_table, sd,
 971                               &config, flags | WIMLIB_ADD_IMAGE_FLAG_ROOT,
 972                               extra_arg);
 973         destroy_capture_config(&config);
 974
 975         if (ret != 0) {
 976                 ERROR("Failed to build dentry tree for `%s'", dir);
 977                 goto out_free_security_data;
 978         }
 979
 980         DEBUG("Calculating full paths of dentries.");
 981         ret = for_dentry_in_tree(root_dentry, calculate_dentry_full_path, NULL);
 982         if (ret != 0)
 983                 goto out_free_dentry_tree;
 984
 985         ret = add_new_dentry_tree(w, root_dentry, sd);
 986         if (ret != 0)
 987                 goto out_free_dentry_tree;
 988
 989         DEBUG("Inserting dentries into inode table");
 990         ret = init_inode_table(&inode_tab, 9001);
 991         if (ret != 0)
 992                 goto out_destroy_imd;
 993
 994         for_dentry_in_tree(root_dentry, inode_table_insert, &inode_tab);
 995
 996         DEBUG("Cleaning up the hard link groups");
 997         ret = fix_inodes(&inode_tab, &inode_list);
 998         destroy_inode_table(&inode_tab);
 999         if (ret != 0)
1000                 goto out_destroy_imd;
1001
1002         DEBUG("Assigning hard link group IDs");
1003         assign_inode_numbers(&inode_list);
1004
1005         ret = xml_add_image(w, name);
1006         if (ret != 0)
1007                 goto out_destroy_imd;
1008
1009         if (flags & WIMLIB_ADD_IMAGE_FLAG_BOOT)
1010                 w->hdr.boot_idx = w->hdr.image_count;
1011
1012         return 0;
1013 out_destroy_imd:
1014         destroy_image_metadata(&w->image_metadata[w->hdr.image_count - 1],
1015                                w->lookup_table);
1016         w->hdr.image_count--;
1017         return ret;
1018 out_free_dentry_tree:
1019         free_dentry_tree(root_dentry, w->lookup_table);
1020 out_free_security_data:
1021         free_security_data(sd);
1022 out_destroy_config:
1023         destroy_capture_config(&config);
1024         return ret;
1025 }
1026
1027 /*
1028  * Adds an image to a WIM file from a directory tree on disk.
1029  */
1030 WIMLIBAPI int wimlib_add_image(WIMStruct *w, const char *dir,
1031                                const char *name, const char *config_str,
1032                                size_t config_len, int flags)
1033 {
1034         return do_add_image(w, dir, name, config_str, config_len, flags,
1035                             build_dentry_tree, NULL);
1036 }