2 * capture_common.c - Mostly code to handle excluding paths from capture.
6 * Copyright (C) 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
28 #include "wimlib/assert.h"
29 #include "wimlib/capture.h"
30 #include "wimlib/error.h"
31 #include "wimlib/paths.h"
34 # include "wimlib/win32.h" /* for fnmatch() equivalent */
42 canonicalize_pattern(const tchar *pat, tchar **canonical_pat_ret)
46 if (!is_any_path_separator(pat[0]) &&
47 pat[0] != T('\0') && pat[1] == T(':'))
49 /* Pattern begins with drive letter */
50 if (!is_any_path_separator(pat[2])) {
51 /* Something like c:file, which is actually a path
52 * relative to the current working directory on the c:
53 * drive. We require paths with drive letters to be
55 ERROR("Invalid path \"%"TS"\"; paths including drive letters "
56 "must be absolute!", pat);
57 ERROR("Maybe try \"%"TC":\\%"TS"\"?",
59 return WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
62 WARNING("Pattern \"%"TS"\" starts with a drive letter, which is "
63 "being removed.", pat);
64 /* Strip the drive letter */
67 canonical_pat = canonicalize_fs_path(pat);
69 return WIMLIB_ERR_NOMEM;
71 /* Translate all possible path separators into the operating system's
72 * preferred path separator. */
73 for (tchar *p = canonical_pat; *p; p++)
74 if (is_any_path_separator(*p))
75 *p = OS_PREFERRED_PATH_SEPARATOR;
76 *canonical_pat_ret = canonical_pat;
81 copy_and_canonicalize_pattern_list(const struct wimlib_pattern_list *list,
82 struct wimlib_pattern_list *copy)
86 copy->pats = CALLOC(list->num_pats, sizeof(list->pats[0]));
88 return WIMLIB_ERR_NOMEM;
89 copy->num_pats = list->num_pats;
90 for (size_t i = 0; i < list->num_pats; i++) {
91 ret = canonicalize_pattern(list->pats[i], ©->pats[i]);
99 copy_and_canonicalize_capture_config(const struct wimlib_capture_config *config,
100 struct wimlib_capture_config **config_copy_ret)
102 struct wimlib_capture_config *config_copy;
105 config_copy = CALLOC(1, sizeof(struct wimlib_capture_config));
107 ret = WIMLIB_ERR_NOMEM;
108 goto out_free_capture_config;
110 ret = copy_and_canonicalize_pattern_list(&config->exclusion_pats,
111 &config_copy->exclusion_pats);
113 goto out_free_capture_config;
114 ret = copy_and_canonicalize_pattern_list(&config->exclusion_exception_pats,
115 &config_copy->exclusion_exception_pats);
117 goto out_free_capture_config;
118 *config_copy_ret = config_copy;
120 out_free_capture_config:
121 free_capture_config(config_copy);
127 destroy_pattern_list(struct wimlib_pattern_list *list)
129 for (size_t i = 0; i < list->num_pats; i++)
135 free_capture_config(struct wimlib_capture_config *config)
138 destroy_pattern_list(&config->exclusion_pats);
139 destroy_pattern_list(&config->exclusion_exception_pats);
145 match_pattern(const tchar *path,
146 const tchar *path_basename,
147 const struct wimlib_pattern_list *list)
149 for (size_t i = 0; i < list->num_pats; i++) {
151 const tchar *pat = list->pats[i];
154 if (*pat == OS_PREFERRED_PATH_SEPARATOR) {
155 /* Absolute path from root of capture */
158 if (tstrchr(pat, OS_PREFERRED_PATH_SEPARATOR))
159 /* Relative path from root of capture */
162 /* A file name pattern */
163 string = path_basename;
166 /* Warning: on Windows native builds, fnmatch() calls the
167 * replacement function in win32.c. */
168 if (fnmatch(pat, string, FNM_PATHNAME | FNM_NOESCAPE
174 DEBUG("\"%"TS"\" matches the pattern \"%"TS"\"",
178 DEBUG2("\"%"TS"\" does not match the pattern \"%"TS"\"",
185 /* Return true if the image capture configuration file indicates we should
186 * exclude the filename @path from capture.
188 * If @exclude_prefix is %true, the part of the path up and including the name
189 * of the directory being captured is not included in the path for matching
190 * purposes. This allows, for example, a pattern like /hiberfil.sys to match a
191 * file /mnt/windows7/hiberfil.sys if we are capturing the /mnt/windows7
195 exclude_path(const tchar *path, size_t path_len,
196 const struct wimlib_capture_config *config, bool exclude_prefix)
200 const tchar *basename = path_basename_with_len(path, path_len);
201 if (exclude_prefix) {
202 wimlib_assert(path_len >= config->_prefix_num_tchars);
203 if (!tmemcmp(config->_prefix, path, config->_prefix_num_tchars) &&
204 path[config->_prefix_num_tchars] == OS_PREFERRED_PATH_SEPARATOR)
206 path += config->_prefix_num_tchars;
209 return match_pattern(path, basename, &config->exclusion_pats) &&
210 !match_pattern(path, basename, &config->exclusion_exception_pats);