X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fcapture_common.c;h=353ff2b67f64fabb134eae8150175a6f54ec27e8;hp=943d919ba5770530053ee60cf5007be7b8b706fb;hb=fd451e930fe11d94dc51700f67db84e1055fe917;hpb=b5b9681794d1f5f13350e3567f6f6e74f5c779cf diff --git a/src/capture_common.c b/src/capture_common.c index 943d919b..353ff2b6 100644 --- a/src/capture_common.c +++ b/src/capture_common.c @@ -5,36 +5,34 @@ /* * Copyright (C) 2013, 2014 Eric Biggers * - * This file is part of wimlib, a library for working with WIM files. + * This file is free software; you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation; either version 3 of the License, or (at your option) any + * later version. * - * wimlib is free software; you can redistribute it and/or modify it under the - * terms of the GNU General Public License as published by the Free - * Software Foundation; either version 3 of the License, or (at your option) - * any later version. - * - * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY - * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - * A PARTICULAR PURPOSE. See the GNU General Public License for more + * This file is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. * - * You should have received a copy of the GNU General Public License - * along with wimlib; if not, see http://www.gnu.org/licenses/. + * You should have received a copy of the GNU Lesser General Public License + * along with this file; if not, see http://www.gnu.org/licenses/. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif +#include + +#include "wimlib/blob_table.h" #include "wimlib/capture.h" #include "wimlib/dentry.h" #include "wimlib/error.h" -#include "wimlib/lookup_table.h" #include "wimlib/paths.h" +#include "wimlib/pattern.h" #include "wimlib/progress.h" #include "wimlib/textfile.h" -#include "wimlib/wildcard.h" - -#include /* * Tally a file (or directory) that has been scanned for a capture operation, @@ -44,8 +42,7 @@ * Flags, optional progress function, and progress data for the capture * operation. * @status - * Status of the scanned file (ok, unsupported, excluded, or excluded - * symlink). + * Status of the scanned file. * @inode * If @status is WIMLIB_SCAN_DENTRY_OK, this is a pointer to the WIM inode * that has been created for the scanned file. The first time the file is @@ -53,30 +50,33 @@ * via additional hard links, inode->i_nlink will be greater than 1. */ int -do_capture_progress(struct add_image_params *params, int status, +do_capture_progress(struct capture_params *params, int status, const struct wim_inode *inode) { switch (status) { case WIMLIB_SCAN_DENTRY_OK: if (!(params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)) return 0; + break; case WIMLIB_SCAN_DENTRY_UNSUPPORTED: case WIMLIB_SCAN_DENTRY_EXCLUDED: - case WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK: + case WIMLIB_SCAN_DENTRY_FIXED_SYMLINK: + case WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK: if (!(params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)) return 0; + break; } params->progress.scan.status = status; if (status == WIMLIB_SCAN_DENTRY_OK && inode->i_nlink == 1) { /* Successful scan, and visiting inode for the first time */ - /* Tally size of all data streams. */ - const struct wim_lookup_table_entry *lte; - for (unsigned i = 0; i <= inode->i_num_ads; i++) { - lte = inode_stream_lte_resolved(inode, i); - if (lte) - params->progress.scan.num_bytes_scanned += lte->size; + /* Tally size of all streams. */ + for (unsigned i = 0; i < inode->i_num_streams; i++) { + const struct blob_descriptor *blob = + stream_blob_resolved(&inode->i_streams[i]); + if (blob) + params->progress.scan.num_bytes_scanned += blob->size; } /* Tally the file itself. */ @@ -176,8 +176,15 @@ read_capture_config(const tchar *config_file, const void *buf, /* [PrepopulateList] is used for apply, not capture. But since we do * understand it, recognize it, thereby avoiding the unrecognized - * section warning, but discard the resulting strings. */ + * section warning, but discard the resulting strings. + * + * We currently ignore [CompressionExclusionList] and + * [CompressionFolderList]. This is a known issue that doesn't seem to + * have any real consequences, so don't issue warnings about not + * recognizing those sections. */ STRING_SET(prepopulate_pats); + STRING_SET(compression_exclusion_pats); + STRING_SET(compression_folder_pats); struct text_file_section sections[] = { {T("ExclusionList"), @@ -186,16 +193,39 @@ read_capture_config(const tchar *config_file, const void *buf, &config->exclusion_exception_pats}, {T("PrepopulateList"), &prepopulate_pats}, + {T("CompressionExclusionList"), + &compression_exclusion_pats}, + {T("CompressionFolderList"), + &compression_folder_pats}, }; void *mem; ret = do_load_text_file(config_file, buf, bufsize, &mem, sections, ARRAY_LEN(sections), LOAD_TEXT_FILE_REMOVE_QUOTES, mangle_pat); - if (ret) + if (ret) { + ERROR("Failed to load capture configuration file \"%"TS"\"", + config_file); + switch (ret) { + case WIMLIB_ERR_INVALID_UTF8_STRING: + case WIMLIB_ERR_INVALID_UTF16_STRING: + ERROR("Note: the capture configuration file must be " + "valid UTF-8 or UTF-16LE"); + ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG; + break; + case WIMLIB_ERR_OPEN: + case WIMLIB_ERR_STAT: + case WIMLIB_ERR_NOMEM: + case WIMLIB_ERR_READ: + ret = WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG; + break; + } return ret; + } FREE(prepopulate_pats.strings); + FREE(compression_exclusion_pats.strings); + FREE(compression_folder_pats.strings); config->buf = mem; return 0; @@ -210,53 +240,118 @@ destroy_capture_config(struct capture_config *config) } /* - * Determine whether a path matches any wildcard pattern in a list. - * - * Special rules apply about what form @path must be in; see match_path(). + * Determine whether @path, or any ancestor directory of @path, matches any of + * the patterns in @list. Path separators in @path must be WIM_PATH_SEPARATOR. */ bool -match_pattern_list(const tchar *path, size_t path_nchars, - const struct string_set *list) +match_pattern_list(const tchar *path, const struct string_set *list) { for (size_t i = 0; i < list->num_strings; i++) - if (match_path(path, path_nchars, list->strings[i], - OS_PREFERRED_PATH_SEPARATOR, true)) + if (match_path(path, list->strings[i], true)) return true; return false; } /* - * Determine whether the filesystem @path should be excluded from capture, based - * on the current capture configuration file. + * Determine if a file should be excluded from capture. + * + * This function tests exclusions from both possible sources of exclusions: * - * The @path must be given relative to the root of the capture, but with a - * leading path separator. For example, if the file "in/file" is being tested - * and the library user ran wimlib_add_image(wim, "in", ...), then the directory - * "in" is the root of the capture and the path should be specified as "/file". + * (1) The capture configuration file + * (2) The user-provided progress function * - * Also, all path separators in @path must be OS_PREFERRED_PATH_SEPARATOR, there - * cannot be trailing slashes, and there cannot be consecutive path separators. + * The capture implementation must have set params->capture_root_nchars to an + * appropriate value. Example for UNIX: if the capture root directory is + * "foobar/subdir", then all paths will be provided starting with + * "foobar/subdir", so params->capture_root_nchars must be set to + * strlen("foobar/subdir") so that the appropriate path can be matched against + * the patterns in the exclusion list. * - * As a special case, the empty string will be interpreted as a single path - * separator (which means the root of capture itself). + * Returns: + * < 0 if excluded + * = 0 if not excluded and no error + * > 0 (wimlib error code) if error + */ +int +try_exclude(const tchar *full_path, const struct capture_params *params) +{ + int ret; + + if (params->config) { + const tchar *path = full_path + params->capture_root_nchars; + if (match_pattern_list(path, ¶ms->config->exclusion_pats) && + !match_pattern_list(path, ¶ms->config->exclusion_exception_pats)) + return -1; + } + + if (unlikely(params->add_flags & WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION)) { + + union wimlib_progress_info info; + tchar *cookie; + + info.test_file_exclusion.path = full_path; + info.test_file_exclusion.will_exclude = false; + + cookie = progress_get_win32_path(full_path); + + ret = call_progress(params->progfunc, WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION, + &info, params->progctx); + + progress_put_win32_path(cookie); + + if (ret) + return ret; + if (info.test_file_exclusion.will_exclude) + return -1; + } + + return 0; +} + +/* + * Determine whether a directory entry of the specified name should be ignored. + * This is a lower level function which runs prior to try_exclude(). It handles + * the standard '.' and '..' entries, which show up in directory listings but + * should not be archived. It also checks for odd filenames that usually should + * not exist but could cause problems if archiving them were to be attempted. */ bool -should_exclude_path(const tchar *path, size_t path_nchars, - const struct capture_config *config) +should_ignore_filename(const tchar *name, const int name_nchars) { - tchar dummy[2]; + if (name_nchars <= 0) { + WARNING("Ignoring empty filename"); + return true; + } - if (!config) - return false; + if (name[0] == T('.') && + (name_nchars == 1 || (name_nchars == 2 && name[1] == T('.')))) + return true; - if (!*path) { - dummy[0] = OS_PREFERRED_PATH_SEPARATOR; - dummy[1] = T('\0'); - path = dummy; - path_nchars = 1; + for (int i = 0; i < name_nchars; i++) { + if (name[i] == T('\0')) { + WARNING("Ignoring filename containing embedded null character"); + return true; + } + if (name[i] == OS_PREFERRED_PATH_SEPARATOR) { + WARNING("Ignoring filename containing embedded path separator"); + return true; + } } - return match_pattern_list(path, path_nchars, &config->exclusion_pats) && - !match_pattern_list(path, path_nchars, &config->exclusion_exception_pats); + return false; +} + +/* Attach a newly scanned directory tree to its parent directory, with duplicate + * handling. */ +void +attach_scanned_tree(struct wim_dentry *parent, struct wim_dentry *child, + struct blob_table *blob_table) +{ + struct wim_dentry *duplicate; + if (child && (duplicate = dentry_add_child(parent, child))) { + WARNING("Duplicate file path: \"%"TS"\". Only capturing " + "the first version.", dentry_full_path(duplicate)); + free_dentry_tree(child, blob_table); + } }