c39ded67c3903ec1ba1b8458a504fd0ae07665eb
[wimlib] / src / add_image.c
1 /*
2  * add_image.c
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 #include "config.h"
25
26 #ifdef __WIN32__
27 #  include "win32.h"
28 #else
29 #  include <dirent.h>
30 #  include <sys/stat.h>
31 #  include <fnmatch.h>
32 #  include "timestamp.h"
33 #endif
34
35 #include "wimlib_internal.h"
36 #include "dentry.h"
37 #include "lookup_table.h"
38 #include "xml.h"
39 #include "security.h"
40
41 #include <ctype.h>
42 #include <errno.h>
43 #include <stdlib.h>
44 #include <limits.h>
45 #include <string.h>
46
47 #include <unistd.h>
48
49 #ifdef HAVE_ALLOCA_H
50 #  include <alloca.h>
51 #endif
52
53 /*
54  * Adds the dentry tree and security data for a new image to the image metadata
55  * array of the WIMStruct.
56  */
57 static int
58 add_new_dentry_tree(WIMStruct *w, struct wim_dentry *root_dentry,
59                     struct wim_security_data *sd)
60 {
61         struct wim_image_metadata *new_imd;
62         struct wim_lookup_table_entry *metadata_lte;
63         int ret;
64
65         metadata_lte = new_lookup_table_entry();
66         if (!metadata_lte)
67                 return WIMLIB_ERR_NOMEM;
68
69         metadata_lte->resource_entry.flags = WIM_RESHDR_FLAG_METADATA;
70         metadata_lte->unhashed = 1;
71
72         new_imd = new_image_metadata();
73         if (!new_imd) {
74                 free_lookup_table_entry(metadata_lte);
75                 return WIMLIB_ERR_NOMEM;
76         }
77
78         new_imd->root_dentry    = root_dentry;
79         new_imd->metadata_lte   = metadata_lte;
80         new_imd->security_data  = sd;
81         new_imd->modified       = 1;
82
83         ret = append_image_metadata(w, new_imd);
84         if (ret)
85                 put_image_metadata(new_imd, NULL);
86         return ret;
87
88 }
89
90 #ifndef __WIN32__
91
92 static int
93 unix_capture_regular_file(const char *path,
94                           u64 size,
95                           struct wim_inode *inode,
96                           struct wim_lookup_table *lookup_table)
97 {
98         inode->i_attributes = FILE_ATTRIBUTE_NORMAL;
99
100         /* Empty files do not have to have a lookup table entry. */
101         if (size != 0) {
102                 struct wim_lookup_table_entry *lte;
103                 char *file_on_disk;
104
105                 file_on_disk = STRDUP(path);
106                 if (!file_on_disk)
107                         return WIMLIB_ERR_NOMEM;
108                 lte = new_lookup_table_entry();
109                 if (!lte) {
110                         FREE(file_on_disk);
111                         return WIMLIB_ERR_NOMEM;
112                 }
113                 lte->file_on_disk = file_on_disk;
114                 lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
115                 lte->resource_entry.original_size = size;
116                 lookup_table_insert_unhashed(lookup_table, lte, inode, 0);
117                 inode->i_lte = lte;
118         }
119         return 0;
120 }
121
122 static int
123 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
124                                  char *path,
125                                  size_t path_len,
126                                  struct add_image_params *params);
127
128 static int
129 unix_capture_directory(struct wim_dentry *dir_dentry,
130                        char *path,
131                        size_t path_len,
132                        struct add_image_params *params)
133 {
134
135         DIR *dir;
136         struct dirent *entry;
137         struct wim_dentry *child;
138         int ret;
139
140         dir_dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
141         dir = opendir(path);
142         if (!dir) {
143                 ERROR_WITH_ERRNO("Failed to open the directory `%s'",
144                                  path);
145                 return WIMLIB_ERR_OPEN;
146         }
147
148         /* Recurse on directory contents */
149         ret = 0;
150         for (;;) {
151                 errno = 0;
152                 entry = readdir(dir);
153                 if (!entry) {
154                         if (errno) {
155                                 ret = WIMLIB_ERR_READ;
156                                 ERROR_WITH_ERRNO("Error reading the "
157                                                  "directory `%s'", path);
158                         }
159                         break;
160                 }
161
162                 if (entry->d_name[0] == '.' && (entry->d_name[1] == '\0'
163                       || (entry->d_name[1] == '.' && entry->d_name[2] == '\0')))
164                                 continue;
165
166                 size_t name_len = strlen(entry->d_name);
167
168                 path[path_len] = '/';
169                 memcpy(&path[path_len + 1], entry->d_name, name_len + 1);
170                 ret = unix_build_dentry_tree_recursive(&child,
171                                                        path,
172                                                        path_len + 1 + name_len,
173                                                        params);
174                 if (ret)
175                         break;
176                 if (child)
177                         dentry_add_child(dir_dentry, child);
178         }
179         closedir(dir);
180         return ret;
181 }
182
183 static int
184 unix_capture_symlink(struct wim_dentry **root_p,
185                      const char *path,
186                      struct wim_inode *inode,
187                      struct add_image_params *params)
188 {
189         char deref_name_buf[4096];
190         ssize_t deref_name_len;
191         int ret;
192
193         inode->i_attributes = FILE_ATTRIBUTE_REPARSE_POINT;
194         inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
195
196         /* The idea here is to call readlink() to get the UNIX target of
197          * the symbolic link, then turn the target into a reparse point
198          * data buffer that contains a relative or absolute symbolic
199          * link (NOT a junction point or *full* path symbolic link with
200          * drive letter).
201          */
202         deref_name_len = readlink(path, deref_name_buf,
203                                   sizeof(deref_name_buf) - 1);
204         if (deref_name_len >= 0) {
205                 char *dest = deref_name_buf;
206
207                 dest[deref_name_len] = '\0';
208                 DEBUG("Read symlink `%s'", dest);
209
210                 if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX) &&
211                      dest[0] == '/')
212                 {
213                         dest = capture_fixup_absolute_symlink(dest,
214                                                               params->capture_root_ino,
215                                                               params->capture_root_dev);
216                         if (!dest) {
217                                 WARNING("Ignoring out of tree absolute symlink "
218                                         "\"%s\" -> \"%s\"\n"
219                                         "          (Use --norpfix to capture "
220                                         "absolute symlinks as-is)",
221                                         path, deref_name_buf);
222                                 free_dentry(*root_p);
223                                 *root_p = NULL;
224                                 return 0;
225                         }
226                         inode->i_not_rpfixed = 0;
227                 }
228                 ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
229                 if (ret == 0) {
230                         /* Unfortunately, Windows seems to have the concept of
231                          * "file" symbolic links as being different from
232                          * "directory" symbolic links...  so
233                          * FILE_ATTRIBUTE_DIRECTORY needs to be set on the
234                          * symbolic link if the *target* of the symbolic link is
235                          * a directory.  */
236                         struct stat stbuf;
237                         if (stat(path, &stbuf) == 0 && S_ISDIR(stbuf.st_mode))
238                                 inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
239                 }
240         } else {
241                 ERROR_WITH_ERRNO("Failed to read target of "
242                                  "symbolic link `%s'", path);
243                 ret = WIMLIB_ERR_READLINK;
244         }
245         return ret;
246 }
247
248 static int
249 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
250                                  char *path,
251                                  size_t path_len,
252                                  struct add_image_params *params)
253 {
254         struct wim_dentry *root = NULL;
255         int ret = 0;
256         struct wim_inode *inode;
257
258         if (exclude_path(path, path_len, params->config, true)) {
259                 if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE)
260                     && params->progress_func)
261                 {
262                         union wimlib_progress_info info;
263                         info.scan.cur_path = path;
264                         info.scan.excluded = true;
265                         params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
266                 }
267                 goto out;
268         }
269
270         if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
271             && params->progress_func)
272         {
273                 union wimlib_progress_info info;
274                 info.scan.cur_path = path;
275                 info.scan.excluded = false;
276                 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
277         }
278
279         struct stat stbuf;
280         int (*stat_fn)(const char *restrict, struct stat *restrict);
281         if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE) ||
282             (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT))
283                 stat_fn = stat;
284         else
285                 stat_fn = lstat;
286
287         ret = (*stat_fn)(path, &stbuf);
288         if (ret != 0) {
289                 ERROR_WITH_ERRNO("Failed to stat `%s'", path);
290                 goto out;
291         }
292         if (!S_ISREG(stbuf.st_mode) && !S_ISDIR(stbuf.st_mode)
293             && !S_ISLNK(stbuf.st_mode)) {
294                 ERROR("`%s' is not a regular file, directory, or symbolic link.",
295                       path);
296                 ret = WIMLIB_ERR_SPECIAL_FILE;
297                 goto out;
298         }
299
300         ret = inode_table_new_dentry(params->inode_table,
301                                      path_basename_with_len(path, path_len),
302                                      stbuf.st_ino, stbuf.st_dev, false, &root);
303         if (ret)
304                 goto out;
305
306         inode = root->d_inode;
307
308         if (inode->i_nlink > 1) /* Already captured this inode? */
309                 goto out;
310
311 #ifdef HAVE_STAT_NANOSECOND_PRECISION
312         inode->i_creation_time = timespec_to_wim_timestamp(stbuf.st_mtim);
313         inode->i_last_write_time = timespec_to_wim_timestamp(stbuf.st_mtim);
314         inode->i_last_access_time = timespec_to_wim_timestamp(stbuf.st_atim);
315 #else
316         inode->i_creation_time = unix_timestamp_to_wim(stbuf.st_mtime);
317         inode->i_last_write_time = unix_timestamp_to_wim(stbuf.st_mtime);
318         inode->i_last_access_time = unix_timestamp_to_wim(stbuf.st_atime);
319 #endif
320         inode->i_resolved = 1;
321         if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) {
322                 ret = inode_set_unix_data(inode, stbuf.st_uid,
323                                           stbuf.st_gid,
324                                           stbuf.st_mode,
325                                           params->lookup_table,
326                                           UNIX_DATA_ALL | UNIX_DATA_CREATE);
327                 if (ret)
328                         goto out;
329         }
330         params->add_image_flags &=
331                 ~(WIMLIB_ADD_IMAGE_FLAG_ROOT | WIMLIB_ADD_IMAGE_FLAG_SOURCE);
332         if (S_ISREG(stbuf.st_mode))
333                 ret = unix_capture_regular_file(path, stbuf.st_size,
334                                                 inode, params->lookup_table);
335         else if (S_ISDIR(stbuf.st_mode))
336                 ret = unix_capture_directory(root, path, path_len, params);
337         else
338                 ret = unix_capture_symlink(&root, path, inode, params);
339 out:
340         if (ret == 0)
341                 *root_ret = root;
342         else
343                 free_dentry_tree(root, params->lookup_table);
344         return ret;
345 }
346
347 /*
348  * unix_build_dentry_tree():
349  *      Builds a tree of WIM dentries from an on-disk directory tree (UNIX
350  *      version; no NTFS-specific data is captured).
351  *
352  * @root_ret:   Place to return a pointer to the root of the dentry tree.  Only
353  *              modified if successful.  Set to NULL if the file or directory was
354  *              excluded from capture.
355  *
356  * @root_disk_path:  The path to the root of the directory tree on disk.
357  *
358  * @params:     See doc for `struct add_image_params'.
359  *
360  * @return:     0 on success, nonzero on failure.  It is a failure if any of
361  *              the files cannot be `stat'ed, or if any of the needed
362  *              directories cannot be opened or read.  Failure to add the files
363  *              to the WIM may still occur later when trying to actually read
364  *              the on-disk files during a call to wimlib_write() or
365  *              wimlib_overwrite().
366  */
367 static int
368 unix_build_dentry_tree(struct wim_dentry **root_ret,
369                        const char *root_disk_path,
370                        struct add_image_params *params)
371 {
372         char *path_buf;
373         int ret;
374         size_t path_len;
375         size_t path_bufsz;
376
377         {
378                 struct stat root_stbuf;
379                 if (stat(root_disk_path, &root_stbuf)) {
380                         ERROR_WITH_ERRNO("Failed to stat \"%s\"", root_disk_path);
381                         return WIMLIB_ERR_STAT;
382                 }
383
384                 if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) &&
385                     !S_ISDIR(root_stbuf.st_mode))
386                 {
387                         ERROR("Root of capture \"%s\" is not a directory",
388                               root_disk_path);
389                         return WIMLIB_ERR_NOTDIR;
390                 }
391                 params->capture_root_ino = root_stbuf.st_ino;
392                 params->capture_root_dev = root_stbuf.st_dev;
393         }
394
395         path_bufsz = min(32790, PATH_MAX + 1);
396         path_len = strlen(root_disk_path);
397
398         if (path_len >= path_bufsz)
399                 return WIMLIB_ERR_INVALID_PARAM;
400
401         path_buf = MALLOC(path_bufsz);
402         if (!path_buf)
403                 return WIMLIB_ERR_NOMEM;
404         memcpy(path_buf, root_disk_path, path_len + 1);
405
406         ret = unix_build_dentry_tree_recursive(root_ret, path_buf,
407                                                path_len, params);
408         FREE(path_buf);
409         return ret;
410 }
411 #endif /* !__WIN32__ */
412
413 static bool
414 match_pattern(const tchar *path,
415               const tchar *path_basename,
416               const struct wimlib_pattern_list *list)
417 {
418         for (size_t i = 0; i < list->num_pats; i++) {
419
420                 const tchar *pat = list->pats[i];
421                 const tchar *string;
422
423                 if (*pat == T('/')) {
424                         /* Absolute path from root of capture */
425                         string = path;
426                 } else {
427                         if (tstrchr(pat, T('/')))
428                                 /* Relative path from root of capture */
429                                 string = path + 1;
430                         else
431                                 /* A file name pattern */
432                                 string = path_basename;
433                 }
434
435                 /* Warning: on Windows native builds, fnmatch() calls the
436                  * replacement function in win32.c. */
437                 if (fnmatch(pat, string, FNM_PATHNAME | FNM_NOESCAPE
438                                 #ifdef FNM_CASEFOLD
439                                         | FNM_CASEFOLD
440                                 #endif
441                             ) == 0)
442                 {
443                         DEBUG("\"%"TS"\" matches the pattern \"%"TS"\"",
444                               string, pat);
445                         return true;
446                 } else {
447                         DEBUG2("\"%"TS"\" does not match the pattern \"%"TS"\"",
448                                string, pat);
449                 }
450         }
451         return false;
452 }
453
454 /* Return true if the image capture configuration file indicates we should
455  * exclude the filename @path from capture.
456  *
457  * If @exclude_prefix is %true, the part of the path up and including the name
458  * of the directory being captured is not included in the path for matching
459  * purposes.  This allows, for example, a pattern like /hiberfil.sys to match a
460  * file /mnt/windows7/hiberfil.sys if we are capturing the /mnt/windows7
461  * directory.
462  */
463 bool
464 exclude_path(const tchar *path, size_t path_len,
465              const struct wimlib_capture_config *config, bool exclude_prefix)
466 {
467         const tchar *basename = path_basename_with_len(path, path_len);
468         if (exclude_prefix) {
469                 wimlib_assert(path_len >= config->_prefix_num_tchars);
470                 if (!tmemcmp(config->_prefix, path, config->_prefix_num_tchars) &&
471                     path[config->_prefix_num_tchars] == T('/'))
472                 {
473                         path += config->_prefix_num_tchars;
474                 }
475         }
476         return match_pattern(path, basename, &config->exclusion_pats) &&
477                 !match_pattern(path, basename, &config->exclusion_exception_pats);
478
479 }
480
481 /* Strip leading and trailing slashes from the target paths, and translate all
482  * backslashes in the source and target paths into forward slashes. */
483 static void
484 canonicalize_sources_and_targets(struct wimlib_capture_source *sources,
485                                  size_t num_sources)
486 {
487         while (num_sources--) {
488                 DEBUG("Canonicalizing { source: \"%"TS"\", target=\"%"TS"\"}",
489                       sources->fs_source_path,
490                       sources->wim_target_path);
491
492                 /* The Windows API can handle forward slashes.  Just get rid of
493                  * backslashes to avoid confusing other parts of the library
494                  * code. */
495                 sources->fs_source_path = canonicalize_fs_path(sources->fs_source_path);
496                 sources->wim_target_path = canonicalize_wim_path(sources->wim_target_path);
497                 DEBUG("Canonical target: \"%"TS"\"", sources->wim_target_path);
498                 sources++;
499         }
500 }
501
502 static int
503 capture_source_cmp(const void *p1, const void *p2)
504 {
505         const struct wimlib_capture_source *s1 = p1, *s2 = p2;
506         return tstrcmp(s1->wim_target_path, s2->wim_target_path);
507 }
508
509 /* Sorts the capture sources lexicographically by target path.  This occurs
510  * after leading and trailing forward slashes are stripped.
511  *
512  * One purpose of this is to make sure that target paths that are inside other
513  * target paths are added after the containing target paths. */
514 static void
515 sort_sources(struct wimlib_capture_source *sources, size_t num_sources)
516 {
517         qsort(sources, num_sources, sizeof(sources[0]), capture_source_cmp);
518 }
519
520 static int
521 check_sorted_sources(struct wimlib_capture_source *sources, size_t num_sources,
522                      int add_image_flags)
523 {
524         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
525                 if (num_sources != 1) {
526                         ERROR("Must specify exactly 1 capture source "
527                               "(the NTFS volume) in NTFS mode!");
528                         return WIMLIB_ERR_INVALID_PARAM;
529                 }
530                 if (sources[0].wim_target_path[0] != T('\0')) {
531                         ERROR("In NTFS capture mode the target path inside "
532                               "the image must be the root directory!");
533                         return WIMLIB_ERR_INVALID_PARAM;
534                 }
535         } else if (num_sources != 0) {
536                 /* This code is disabled because the current code
537                  * unconditionally attempts to do overlays.  So, duplicate
538                  * target paths are OK. */
539         #if 0
540                 if (num_sources > 1 && sources[0].wim_target_path[0] == '\0') {
541                         ERROR("Cannot specify root target when using multiple "
542                               "capture sources!");
543                         return WIMLIB_ERR_INVALID_PARAM;
544                 }
545                 for (size_t i = 0; i < num_sources - 1; i++) {
546                         size_t len = strlen(sources[i].wim_target_path);
547                         size_t j = i + 1;
548                         const char *target1 = sources[i].wim_target_path;
549                         do {
550                                 const char *target2 = sources[j].wim_target_path;
551                                 DEBUG("target1=%s, target2=%s",
552                                       target1,target2);
553                                 if (strncmp(target1, target2, len) ||
554                                     target2[len] > '/')
555                                         break;
556                                 if (target2[len] == '/') {
557                                         ERROR("Invalid target `%s': is a prefix of `%s'",
558                                               target1, target2);
559                                         return WIMLIB_ERR_INVALID_PARAM;
560                                 }
561                                 if (target2[len] == '\0') {
562                                         ERROR("Invalid target `%s': is a duplicate of `%s'",
563                                               target1, target2);
564                                         return WIMLIB_ERR_INVALID_PARAM;
565                                 }
566                         } while (++j != num_sources);
567                 }
568         #endif
569         }
570         return 0;
571
572 }
573
574 /* Creates a new directory to place in the WIM image.  This is to create parent
575  * directories that are not part of any target as needed.  */
576 static int
577 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret)
578 {
579         int ret;
580         struct wim_dentry *dentry;
581
582         DEBUG("Creating filler directory \"%"TS"\"", name);
583         ret = new_dentry_with_inode(name, &dentry);
584         if (ret == 0) {
585                 /* Leave the inode number as 0; this is allowed for non
586                  * hard-linked files. */
587                 dentry->d_inode->i_resolved = 1;
588                 dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
589                 *dentry_ret = dentry;
590         }
591         return ret;
592 }
593
594 /* Overlays @branch onto @target, both of which must be directories. */
595 static int
596 do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
597 {
598         struct rb_root *rb_root;
599
600         DEBUG("Doing overlay \"%"WS"\" => \"%"WS"\"",
601               branch->file_name, target->file_name);
602
603         if (!dentry_is_directory(branch) || !dentry_is_directory(target)) {
604                 ERROR("Cannot overlay \"%"WS"\" onto existing dentry: "
605                       "is not directory-on-directory!", branch->file_name);
606                 return WIMLIB_ERR_INVALID_OVERLAY;
607         }
608
609         rb_root = &branch->d_inode->i_children;
610         while (rb_root->rb_node) { /* While @branch has children... */
611                 struct wim_dentry *child = rbnode_dentry(rb_root->rb_node);
612                 struct wim_dentry *existing;
613
614                 /* Move @child to the directory @target */
615                 unlink_dentry(child);
616                 existing = dentry_add_child(target, child);
617
618                 /* File or directory with same name already exists */
619                 if (existing) {
620                         int ret;
621                         ret = do_overlay(existing, child);
622                         if (ret) {
623                                 /* Overlay failed.  Revert the change to avoid
624                                  * leaking the directory tree rooted at @child.
625                                  * */
626                                 dentry_add_child(branch, child);
627                                 return ret;
628                         }
629                 }
630         }
631         free_dentry(branch);
632         return 0;
633 }
634
635 /* Attach or overlay a branch onto the WIM image.
636  *
637  * @root_p:
638  *      Pointer to the root of the WIM image, or pointer to NULL if it has not
639  *      been created yet.
640  * @branch
641  *      Branch to add.
642  * @target_path:
643  *      Path in the WIM image to add the branch, with leading and trailing
644  *      slashes stripped.
645  */
646 static int
647 attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
648               tchar *target_path)
649 {
650         tchar *slash;
651         struct wim_dentry *dentry, *parent, *target;
652         int ret;
653
654         DEBUG("Attaching branch \"%"WS"\" => \"%"TS"\"",
655               branch->file_name, target_path);
656
657         if (*target_path == T('\0')) {
658                 /* Target: root directory */
659                 if (*root_p) {
660                         /* Overlay on existing root */
661                         return do_overlay(*root_p, branch);
662                 } else  {
663                         /* Set as root */
664                         *root_p = branch;
665                         return 0;
666                 }
667         }
668
669         /* Adding a non-root branch.  Create root if it hasn't been created
670          * already. */
671         if (!*root_p) {
672                 ret  = new_filler_directory(T(""), root_p);
673                 if (ret)
674                         return ret;
675         }
676
677         /* Walk the path to the branch, creating filler directories as needed.
678          * */
679         parent = *root_p;
680         while ((slash = tstrchr(target_path, T('/')))) {
681                 *slash = T('\0');
682                 dentry = get_dentry_child_with_name(parent, target_path);
683                 if (!dentry) {
684                         ret = new_filler_directory(target_path, &dentry);
685                         if (ret)
686                                 return ret;
687                         dentry_add_child(parent, dentry);
688                 }
689                 parent = dentry;
690                 target_path = slash;
691                 /* Skip over slashes.  Note: this cannot overrun the length of
692                  * the string because the last character cannot be a slash, as
693                  * trailing slashes were tripped.  */
694                 do {
695                         ++target_path;
696                 } while (*target_path == T('/'));
697         }
698
699         /* If the target path already existed, overlay the branch onto it.
700          * Otherwise, set the branch as the target path. */
701         target = get_dentry_child_with_utf16le_name(parent, branch->file_name,
702                                                     branch->file_name_nbytes);
703         if (target) {
704                 return do_overlay(target, branch);
705         } else {
706                 dentry_add_child(parent, branch);
707                 return 0;
708         }
709 }
710
711 static int
712 canonicalize_pat(tchar **pat_p)
713 {
714         tchar *pat = *pat_p;
715
716         /* Turn all backslashes in the pattern into forward slashes. */
717         zap_backslashes(pat);
718
719         if (*pat != T('/') && *pat != T('\0') && *(pat + 1) == T(':')) {
720                 /* Pattern begins with drive letter */
721                 if (*(pat + 2) != T('/')) {
722                         /* Something like c:file, which is actually a path
723                          * relative to the current working directory on the c:
724                          * drive.  We require paths with drive letters to be
725                          * absolute. */
726                         ERROR("Invalid path \"%"TS"\"; paths including drive letters "
727                               "must be absolute!", pat);
728                         ERROR("Maybe try \"%"TC":/%"TS"\"?",
729                               *pat, pat + 2);
730                         return WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
731                 }
732
733                 WARNING("Pattern \"%"TS"\" starts with a drive letter, which is "
734                         "being removed.", pat);
735                 /* Strip the drive letter */
736                 pat += 2;
737                 *pat_p = pat;
738         }
739         return 0;
740 }
741
742 static int
743 canonicalize_pat_list(struct wimlib_pattern_list *pat_list)
744 {
745         int ret = 0;
746         for (size_t i = 0; i < pat_list->num_pats; i++) {
747                 ret = canonicalize_pat(&pat_list->pats[i]);
748                 if (ret)
749                         break;
750         }
751         return ret;
752 }
753
754 static int
755 canonicalize_capture_config(struct wimlib_capture_config *config)
756 {
757         int ret = canonicalize_pat_list(&config->exclusion_pats);
758         if (ret)
759                 return ret;
760         return canonicalize_pat_list(&config->exclusion_exception_pats);
761 }
762
763 WIMLIBAPI int
764 wimlib_add_image_multisource(WIMStruct *w,
765                              struct wimlib_capture_source *sources,
766                              size_t num_sources,
767                              const tchar *name,
768                              struct wimlib_capture_config *config,
769                              int add_image_flags,
770                              wimlib_progress_func_t progress_func)
771 {
772         int (*capture_tree)(struct wim_dentry **,
773                             const tchar *,
774                             struct add_image_params *);
775         void *extra_arg;
776         struct wim_dentry *root_dentry;
777         struct wim_dentry *branch;
778         struct wim_security_data *sd;
779         struct wim_image_metadata *imd;
780         struct wim_inode_table inode_table;
781         struct list_head unhashed_streams;
782         struct add_image_params params;
783         int ret;
784         struct sd_set sd_set;
785 #ifdef WITH_NTFS_3G
786         struct _ntfs_volume *ntfs_vol = NULL;
787 #endif
788
789         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
790 #ifdef WITH_NTFS_3G
791                 if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE) {
792                         ERROR("Cannot dereference files when capturing directly from NTFS");
793                         return WIMLIB_ERR_INVALID_PARAM;
794                 }
795                 if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) {
796                         ERROR("Capturing UNIX owner and mode not supported "
797                               "when capturing directly from NTFS");
798                         return WIMLIB_ERR_INVALID_PARAM;
799                 }
800                 capture_tree = build_dentry_tree_ntfs;
801                 extra_arg = &ntfs_vol;
802 #else
803                 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
804                       "        cannot capture a WIM image directly from a NTFS volume!");
805                 return WIMLIB_ERR_UNSUPPORTED;
806 #endif
807         } else {
808         #ifdef __WIN32__
809                 capture_tree = win32_build_dentry_tree;
810         #else
811                 capture_tree = unix_build_dentry_tree;
812         #endif
813                 extra_arg = NULL;
814         }
815
816 #ifdef __WIN32__
817         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) {
818                 ERROR("Capturing UNIX-specific data is not supported on Windows");
819                 return WIMLIB_ERR_INVALID_PARAM;
820         }
821         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE) {
822                 ERROR("Dereferencing symbolic links is not supported on Windows");
823                 return WIMLIB_ERR_INVALID_PARAM;
824         }
825 #endif
826
827         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
828                 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
829
830         if ((add_image_flags & (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
831                                 WIMLIB_ADD_IMAGE_FLAG_RPFIX)) ==
832                 (WIMLIB_ADD_IMAGE_FLAG_RPFIX | WIMLIB_ADD_IMAGE_FLAG_NORPFIX))
833         {
834                 ERROR("Cannot specify RPFIX and NORPFIX flags at the same time!");
835                 return WIMLIB_ERR_INVALID_PARAM;
836         }
837
838         if ((add_image_flags & (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
839                                 WIMLIB_ADD_IMAGE_FLAG_NORPFIX)) == 0)
840         {
841                 /* Do reparse-point fixups by default if the header flag is set
842                  * from previous images, or if this is the first image being
843                  * added. */
844                 if ((w->hdr.flags & WIM_HDR_FLAG_RP_FIX) || w->hdr.image_count == 0)
845                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
846         }
847
848         if (!name || !*name) {
849                 ERROR("Must specify a non-empty string for the image name");
850                 return WIMLIB_ERR_INVALID_PARAM;
851         }
852
853         if (w->hdr.total_parts != 1) {
854                 ERROR("Cannot add an image to a split WIM");
855                 return WIMLIB_ERR_SPLIT_UNSUPPORTED;
856         }
857
858         if (wimlib_image_name_in_use(w, name)) {
859                 ERROR("There is already an image named \"%"TS"\" in the WIM!",
860                       name);
861                 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
862         }
863
864         if (!config) {
865                 DEBUG("Capture config not provided; using empty config");
866                 config = alloca(sizeof(*config));
867                 memset(config, 0, sizeof(*config));
868         }
869
870         ret = canonicalize_capture_config(config);
871         if (ret)
872                 goto out;
873
874         ret = init_inode_table(&inode_table, 9001);
875         if (ret)
876                 goto out;
877
878         DEBUG("Allocating security data");
879         sd = CALLOC(1, sizeof(struct wim_security_data));
880         if (!sd) {
881                 ret = WIMLIB_ERR_NOMEM;
882                 goto out_destroy_inode_table;
883         }
884         sd->total_length = 8;
885
886         sd_set.sd = sd;
887         sd_set.rb_root.rb_node = NULL;
888
889
890         DEBUG("Using %zu capture sources", num_sources);
891         canonicalize_sources_and_targets(sources, num_sources);
892         sort_sources(sources, num_sources);
893         ret = check_sorted_sources(sources, num_sources, add_image_flags);
894         if (ret) {
895                 ret = WIMLIB_ERR_INVALID_PARAM;
896                 goto out_free_security_data;
897         }
898
899         INIT_LIST_HEAD(&unhashed_streams);
900         w->lookup_table->unhashed_streams = &unhashed_streams;
901         root_dentry = NULL;
902
903         params.lookup_table = w->lookup_table;
904         params.inode_table = &inode_table;
905         params.sd_set = &sd_set;
906         params.config = config;
907         params.add_image_flags = add_image_flags;
908         params.progress_func = progress_func;
909         params.extra_arg = extra_arg;
910         for (size_t i = 0; i < num_sources; i++) {
911                 int flags;
912                 union wimlib_progress_info progress;
913
914                 DEBUG("Building dentry tree for source %zu of %zu "
915                       "(\"%"TS"\" => \"%"TS"\")", i + 1, num_sources,
916                       sources[i].fs_source_path,
917                       sources[i].wim_target_path);
918                 if (progress_func) {
919                         memset(&progress, 0, sizeof(progress));
920                         progress.scan.source = sources[i].fs_source_path;
921                         progress.scan.wim_target_path = sources[i].wim_target_path;
922                         progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &progress);
923                 }
924                 config->_prefix = sources[i].fs_source_path;
925                 config->_prefix_num_tchars = tstrlen(sources[i].fs_source_path);
926                 flags = add_image_flags | WIMLIB_ADD_IMAGE_FLAG_SOURCE;
927                 if (!*sources[i].wim_target_path)
928                         flags |= WIMLIB_ADD_IMAGE_FLAG_ROOT;
929                 ret = (*capture_tree)(&branch, sources[i].fs_source_path,
930                                       &params);
931                 if (ret) {
932                         ERROR("Failed to build dentry tree for `%"TS"'",
933                               sources[i].fs_source_path);
934                         goto out_free_dentry_tree;
935                 }
936                 if (branch) {
937                         /* Use the target name, not the source name, for
938                          * the root of each branch from a capture
939                          * source.  (This will also set the root dentry
940                          * of the entire image to be unnamed.) */
941                         ret = set_dentry_name(branch,
942                                               path_basename(sources[i].wim_target_path));
943                         if (ret)
944                                 goto out_free_branch;
945
946                         ret = attach_branch(&root_dentry, branch,
947                                             sources[i].wim_target_path);
948                         if (ret)
949                                 goto out_free_branch;
950                 }
951                 if (progress_func)
952                         progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &progress);
953         }
954
955         if (root_dentry == NULL) {
956                 ret = new_filler_directory(T(""), &root_dentry);
957                 if (ret)
958                         goto out_free_dentry_tree;
959         }
960
961         ret = add_new_dentry_tree(w, root_dentry, sd);
962
963         if (ret) {
964 #ifdef WITH_NTFS_3G
965                 if (ntfs_vol)
966                         do_ntfs_umount(ntfs_vol);
967 #endif
968                 goto out_free_dentry_tree;
969         }
970
971         imd = w->image_metadata[w->hdr.image_count - 1];
972         list_transfer(&unhashed_streams, &imd->unhashed_streams);
973
974 #ifdef WITH_NTFS_3G
975         imd->ntfs_vol = ntfs_vol;
976 #endif
977
978         DEBUG("Assigning hard link group IDs");
979         inode_table_prepare_inode_list(&inode_table, &imd->inode_list);
980
981         ret = xml_add_image(w, name);
982         if (ret)
983                 goto out_put_imd;
984
985         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_BOOT)
986                 wimlib_set_boot_idx(w, w->hdr.image_count);
987
988         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX)
989                 w->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
990
991         ret = 0;
992         goto out_destroy_inode_table;
993 out_put_imd:
994         put_image_metadata(w->image_metadata[--w->hdr.image_count],
995                            w->lookup_table);
996         goto out_destroy_inode_table;
997 out_free_branch:
998         free_dentry_tree(branch, w->lookup_table);
999 out_free_dentry_tree:
1000         free_dentry_tree(root_dentry, w->lookup_table);
1001 out_free_security_data:
1002         free_security_data(sd);
1003 out_destroy_inode_table:
1004         destroy_inode_table(&inode_table);
1005         destroy_sd_set(&sd_set);
1006 out:
1007         return ret;
1008 }
1009
1010 WIMLIBAPI int
1011 wimlib_add_image(WIMStruct *w,
1012                  const tchar *source,
1013                  const tchar *name,
1014                  struct wimlib_capture_config *config,
1015                  int add_image_flags,
1016                  wimlib_progress_func_t progress_func)
1017 {
1018         if (!source || !*source)
1019                 return WIMLIB_ERR_INVALID_PARAM;
1020
1021         tchar *fs_source_path = TSTRDUP(source);
1022         int ret;
1023         struct wimlib_capture_source capture_src = {
1024                 .fs_source_path = fs_source_path,
1025                 .wim_target_path = NULL,
1026                 .reserved = 0,
1027         };
1028         ret = wimlib_add_image_multisource(w, &capture_src, 1, name,
1029                                            config, add_image_flags,
1030                                            progress_func);
1031         FREE(fs_source_path);
1032         return ret;
1033 }