#include <ctype.h>
#include <errno.h>
#include <getopt.h>
-#include <glob.h>
+
#include <inttypes.h>
#include <libgen.h>
#include <limits.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
+#include <locale.h>
#ifdef HAVE_ALLOCA_H
#include <alloca.h>
#endif
+#ifdef __WIN32__
+# include "imagex-win32.h"
+#else
+# include <glob.h>
+#endif
+
#define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
#define for_opt(c, opts) while ((c = getopt_long_only(argc, (char**)argv, "", \
opts, NULL)) != -1)
enum imagex_op_type {
- APPEND,
+ APPEND = 0,
APPLY,
CAPTURE,
DELETE,
static void usage(int cmd_type);
static void usage_all();
+
static const char *usage_strings[] = {
[APPEND] =
-"imagex append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
+IMAGEX_PROGNAME" append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
" [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
" [--verbose] [--dereference] [--config=FILE]\n"
" [--threads=NUM_THREADS] [--rebuild] [--unix-data]\n"
-" [--source-list]\n",
+" [--source-list] [--noacls]\n",
[APPLY] =
-"imagex apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
+IMAGEX_PROGNAME" apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
" (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
-" [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n",
+" [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
+" [--noacls]\n",
[CAPTURE] =
-"imagex capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
+IMAGEX_PROGNAME" capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
" [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
" [--flags EDITION_ID] [--verbose] [--dereference]\n"
" [--config=FILE] [--threads=NUM_THREADS] [--unix-data]\n"
-" [--source-list]\n",
+" [--source-list] [--noacls]\n",
[DELETE] =
-"imagex delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n",
+IMAGEX_PROGNAME" delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n",
[DIR] =
-"imagex dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n",
+IMAGEX_PROGNAME" dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n",
[EXPORT] =
-"imagex export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
+IMAGEX_PROGNAME" export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
" DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
" [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
" [--threads=NUM_THREADS] [--rebuild]\n",
[INFO] =
-"imagex info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
+IMAGEX_PROGNAME" info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
" [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
" [--xml] [--extract-xml FILE] [--metadata]\n",
[JOIN] =
-"imagex join [--check] WIMFILE SPLIT_WIM...\n",
+IMAGEX_PROGNAME" join [--check] WIMFILE SPLIT_WIM...\n",
[MOUNT] =
-"imagex mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
+IMAGEX_PROGNAME" mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
" [--check] [--debug] [--streams-interface=INTERFACE]\n"
" [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n",
[MOUNTRW] =
-"imagex mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
+IMAGEX_PROGNAME" mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
" [--check] [--debug] [--streams-interface=INTERFACE]\n"
" [--staging-dir=DIR] [--unix-data] [--allow-other]\n",
[OPTIMIZE] =
-"imagex optimize WIMFILE [--check] [--recompress] [--compress=TYPE]\n",
+IMAGEX_PROGNAME" optimize WIMFILE [--check] [--recompress] [--compress=TYPE]\n",
[SPLIT] =
-"imagex split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n",
+IMAGEX_PROGNAME" split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n",
[UNMOUNT] =
-"imagex unmount DIRECTORY [--commit] [--check] [--rebuild]\n",
-};
-
-static const struct option common_options[] = {
- {"help", 0, NULL, 'h'},
- {"version", 0, NULL, 'v'},
- {NULL, 0, NULL, 0},
+IMAGEX_PROGNAME" unmount DIRECTORY [--commit] [--check] [--rebuild]\n",
};
static const struct option apply_options[] = {
{"verbose", no_argument, NULL, 'v'},
{"ref", required_argument, NULL, 'r'},
{"unix-data", no_argument, NULL, 'U'},
+ {"noacls", no_argument, NULL, 'N'},
{NULL, 0, NULL, 0},
};
static const struct option capture_or_append_options[] = {
{"rebuild", no_argument, NULL, 'R'},
{"unix-data", no_argument, NULL, 'U'},
{"source-list", no_argument, NULL, 'S'},
+ {"noacls", no_argument, NULL, 'N'},
{NULL, 0, NULL, 0},
};
static const struct option delete_options[] = {
{
if (image == WIMLIB_NO_IMAGE) {
imagex_error("\"%s\" is not a valid image in `%s'!\n"
- " Please specify a 1-based imagex index or "
+ " Please specify a 1-based image index or "
"image name.\n"
- " You may use `imagex info' to list the images "
+ " You may use `"IMAGEX_PROGNAME" info' to list the images "
"contained in a WIM.",
image_name, wim_name);
return -1;
return ret;
}
+/* Parse the argument to --compress */
static int get_compression_type(const char *optarg)
{
if (strcasecmp(optarg, "maximum") == 0 || strcasecmp(optarg, "lzx") == 0)
}
}
+/* Returns the size of a file given its name, or -1 if the file does not exist
+ * or its size cannot be determined. */
static off_t file_get_size(const char *filename)
{
struct stat st;
"*.cab\n"
"\\WINDOWS\\inf\\*.pnf\n";
+/* Read standard input until EOF and return the full contents in a malloc()ed
+ * buffer and the number of bytes of data in @len_ret. Returns NULL on read
+ * error. */
static char *stdin_get_contents(size_t *len_ret)
{
+ /* stdin can, of course, be a pipe or other non-seekable file, so the
+ * total length of the data cannot be pre-determined */
char *buf = NULL;
size_t newlen = 1024;
size_t pos = 0;
PARSE_FILENAME_NONE = 2,
};
-static int parse_filename(char **fn_ret, char **line_p, size_t *len_p)
+/*
+ * Parses a filename in the source list file format. (See the man page for
+ * 'wimlib-imagex capture' for details on this format and the meaning.)
+ * Accepted formats for filenames are an unquoted string (whitespace-delimited),
+ * or a double or single-quoted string.
+ *
+ * @line_p: Pointer to the pointer to the line of data. Will be updated
+ * to point past the filename iff the return value is
+ * PARSE_FILENAME_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
+ * be '\0'.
+ *
+ * @len_p: @len_p initially stores the length of the line of data, which may
+ * be 0, and it will be updated to the number of bytes remaining in
+ * the line iff the return value is PARSE_FILENAME_SUCCESS.
+ *
+ * @fn_ret: Iff the return value is PARSE_FILENAME_SUCCESS, a pointer to the
+ * parsed filename will be returned here.
+ *
+ * Returns: PARSE_FILENAME_SUCCESS if a filename was successfully parsed; or
+ * PARSE_FILENAME_FAILURE if the data was invalid due to a missing
+ * closing quote; or PARSE_FILENAME_NONE if the line ended before the
+ * beginning of a filename was found.
+ */
+static int parse_filename(char **line_p, size_t *len_p, char **fn_ret)
{
size_t len = *len_p;
char *line = *line_p;
char *fn;
- int ret;
char quote_char;
/* Skip leading whitespace */
len--;
fn = line;
line = memchr(line, quote_char, len);
- if (line) {
- *line = '\0';
- len -= line - fn;
- ret = PARSE_FILENAME_SUCCESS;
- } else {
+ if (!line) {
imagex_error("Missing closing quote: %s", fn - 1);
return PARSE_FILENAME_FAILURE;
}
fn = line;
do {
line++;
- len--;
} while (!isspace(*line) && *line != '\0');
- *line = '\0';
- ret = PARSE_FILENAME_SUCCESS;
}
+ *line = '\0';
+ len -= line - fn;
*len_p = len;
*line_p = line;
*fn_ret = fn;
- return ret;
+ return PARSE_FILENAME_SUCCESS;
}
+/* Parses a line of data (not an empty line or comment) in the source list file
+ * format. (See the man page for 'wimlib-imagex capture' for details on this
+ * format and the meaning.)
+ *
+ * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
+ * len == 0. The data in @line will be modified by this function call.
+ *
+ * @len: Length of the line of data.
+ *
+ * @source: On success, the capture source and target described by the line is
+ * written into this destination. Note that it will contain pointers
+ * to data in the @line array.
+ *
+ * Returns true if the line was valid; false otherwise. */
static bool
parse_source_list_line(char *line, size_t len,
struct wimlib_capture_source *source)
{
+ /* SOURCE [DEST] */
int ret;
- ret = parse_filename(&source->fs_source_path, &line, &len);
+ ret = parse_filename(&line, &len, &source->fs_source_path);
if (ret != PARSE_FILENAME_SUCCESS)
return false;
- ret = parse_filename(&source->wim_target_path, &line, &len);
+ ret = parse_filename(&line, &len, &source->wim_target_path);
if (ret == PARSE_FILENAME_NONE)
source->wim_target_path = source->fs_source_path;
return ret != PARSE_FILENAME_FAILURE;
}
+/* Returns %true if the given line of length @len > 0 is a comment or empty line
+ * in the source list file format. */
static bool is_comment_line(const char *line, size_t len)
{
for (;;) {
}
}
+/* Parses a file in the source list format. (See the man page for
+ * 'wimlib-imagex capture' for details on this format and the meaning.)
+ *
+ * @source_list_contents: Contents of the source list file. Note that this
+ * buffer will be modified to save memory allocations,
+ * and cannot be freed until the returned array of
+ * wimlib_capture_source's has also been freed.
+ *
+ * @source_list_nbytes: Number of bytes of data in the @source_list_contents
+ * buffer.
+ *
+ * @nsources_ret: On success, the length of the returned array is
+ * returned here.
+ *
+ * Returns: An array of `struct wimlib_capture_source's that can be passed to
+ * the wimlib_add_image_multisource() function to specify how a WIM image is to
+ * be created. */
static struct wimlib_capture_source *
parse_source_list(char *source_list_contents, size_t source_list_nbytes,
size_t *nsources_ret)
p = source_list_contents;
j = 0;
for (i = 0; i < nlines; i++) {
- char *endp = strchr(p, '\n');
+ /* XXX: Could use rawmemchr() here instead, but it may not be
+ * available on all platforms. */
+ char *endp = memchr(p, '\n', source_list_nbytes);
size_t len = endp - p + 1;
*endp = '\0';
if (!is_comment_line(p, len)) {
return sources;
}
+/* Reads the contents of a file into memory. */
static char *file_get_contents(const char *filename, size_t *len_ret)
{
struct stat stbuf;
return buf;
}
+/* Return 0 if a path names a file to which the current user has write access;
+ * -1 otherwise (and print an error message). */
static int file_writable(const char *path)
{
int ret;
#define TO_PERCENT(numerator, denominator) \
(((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
+/* Given an enumerated value for WIM compression type, return a descriptive
+ * string. */
static const char *get_data_type(int ctype)
{
switch (ctype) {
return NULL;
}
+/* Progress callback function passed to various wimlib functions. */
static int imagex_progress_func(enum wimlib_progress_msg msg,
const union wimlib_progress_info *info)
{
return 0;
}
-
+/* Open all the split WIM parts that correspond to a file glob.
+ *
+ * @first_part specifies the first part of the split WIM and it may be either
+ * included or omitted from the glob. */
static int open_swms_from_glob(const char *swm_glob,
const char *first_part,
int open_flags,
glob_t globbuf;
int ret;
+ /* Warning: glob() is replaced in Windows native builds */
ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
if (ret != 0) {
if (ret == GLOB_NOMATCH) {
}
-/* Extract one image, or all images, from a WIM file into a directory. */
+/* Apply one image, or all images, from a WIM file into a directory, OR apply
+ * one image from a WIM file to a NTFS volume. */
static int imagex_apply(int argc, char **argv)
{
int c;
case 'U':
extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
break;
+ case 'N':
+ extract_flags |= WIMLIB_EXTRACT_FLAG_NOACLS;
+ break;
default:
usage(APPLY);
return -1;
}
}
+#ifdef __WIN32__
+ win32_acquire_restore_privileges();
+#endif
ret = wimlib_extract_image(w, image, target, extract_flags,
additional_swms, num_additional_swms,
imagex_progress_func);
if (ret == 0)
printf("Done applying WIM image.\n");
+#ifdef __WIN32__
+ win32_release_restore_privileges();
+#endif
out:
wimlib_free(w);
if (additional_swms) {
return ret;
}
+/* Create a WIM image from a directory tree, NTFS volume, or multiple files or
+ * directory trees. 'wimlib-imagex capture': create a new WIM file containing
+ * the desired image. 'wimlib-imagex append': add a new image to an existing
+ * WIM file. */
static int imagex_capture_or_append(int argc, char **argv)
{
int c;
const char *config_file = NULL;
char *config_str = NULL;
- size_t config_len = 0;
+ size_t config_len;
bool source_list = false;
size_t source_list_nbytes;
case 'S':
source_list = true;
break;
+ case 'N':
+ add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
+ break;
default:
usage(cmd);
return -1;
if (argc >= 3) {
name = argv[2];
} else {
+ /* Set default name to SOURCE argument, omitting any directory
+ * prefixes and trailing slashes. This requires making a copy
+ * of @source. */
source_name_len = strlen(source);
source_copy = alloca(source_name_len + 1);
name = basename(strcpy(source_copy, source));
}
+ /* Image description defaults to NULL if not given. */
desc = (argc >= 4) ? argv[3] : NULL;
if (source_list) {
+ /* Set up capture sources in source list mode */
if (source[0] == '-' && source[1] == '\0') {
source_list_contents = stdin_get_contents(&source_list_nbytes);
} else {
}
capture_sources_malloced = true;
} else {
+ /* Set up capture source in non-source-list mode (could be
+ * either "normal" mode or "NTFS mode"--- see the man page). */
capture_sources = alloca(sizeof(struct wimlib_capture_source));
capture_sources[0].fs_source_path = source;
capture_sources[0].wim_target_path = NULL;
}
}
}
+#ifdef __WIN32__
+ win32_acquire_capture_privileges();
+#endif
ret = wimlib_add_image_multisource(w, capture_sources,
num_sources, name,
add_image_flags,
imagex_progress_func);
if (ret != 0)
- goto out;
+ goto out_release_privs;
cur_image = wimlib_get_num_images(w);
if (desc) {
ret = wimlib_set_image_descripton(w, cur_image, desc);
if (ret != 0)
- goto out;
+ goto out_release_privs;
}
if (flags_element) {
ret = wimlib_set_image_flags(w, cur_image, flags_element);
if (ret != 0)
- goto out;
+ goto out_release_privs;
}
if (cmd == APPEND) {
ret = wimlib_overwrite(w, write_flags, num_threads,
ret = 0;
if (ret != 0)
imagex_error("Failed to write the WIM file `%s'", wimfile);
+out_release_privs:
+#ifdef __WIN32__
+ win32_release_capture_privileges();
+#endif
out:
wimlib_free(w);
free(config_str);
wim_is_new = false;
/* Destination file exists. */
- if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
+
+ if (!S_ISREG(stbuf.st_mode)) {
imagex_error("`%s' is not a regular file",
- dest_wimfile);
+ dest_wimfile);
ret = -1;
goto out;
}
return -1;
}
+/* Rebuild a WIM file */
static int imagex_optimize(int argc, char **argv)
{
int c;
return ret;
}
-/* Unmounts an image. */
+/* Unmounts a mounted WIM image. */
static int imagex_unmount(int argc, char **argv)
{
int c;
static void version()
{
static const char *s =
- "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
+ IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
"Copyright (C) 2012, 2013 Eric Biggers\n"
"License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
"This is free software: you are free to change and redistribute it.\n"
printf("Usage: %s", usage_strings[cmd_type]);
for_imagex_command(cmd) {
if (cmd->cmd == cmd_type)
- printf("\nTry `man imagex-%s' for more details.\n",
+ printf("\nTry `man "IMAGEX_PROGNAME"-%s' for more details.\n",
cmd->name);
}
}
for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
printf(" %s", usage_strings[i]);
static const char *extra =
-" imagex --help\n"
-" imagex --version\n"
+" "IMAGEX_PROGNAME" --help\n"
+" "IMAGEX_PROGNAME" --version\n"
"\n"
" The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
"\n"
-" Try `man imagex' for more information.\n"
+" Try `man "IMAGEX_PROGNAME"' for more information.\n"
;
fputs(extra, stdout);
}
-
+/* Entry point for wimlib's ImageX implementation */
int main(int argc, char **argv)
{
const struct imagex_command *cmd;
int ret;
+ setlocale(LC_ALL, "");
+
if (argc < 2) {
imagex_error("No command specified");
usage_all();
return 1;
}
+ /* Handle --help and --version for all commands. Note that this will
+ * not return if either of these arguments are present. */
help_or_version(argc, argv);
argc--;
argv++;
+ /* The user may like to see more informative error messages. */
wimlib_set_print_errors(true);
+
+ /* Do any initializations that the library needs */
ret = wimlib_global_init();
if (ret)
goto out;
+ /* Search for the function to handle the ImageX subcommand. */
for_imagex_command(cmd) {
if (strcmp(cmd->name, *argv) == 0) {
ret = cmd->func(argc, argv);
- goto out;
+ goto out_check_write_error;
}
}
imagex_error("Unrecognized command: `%s'", argv[0]);
usage_all();
return 1;
+out_check_write_error:
+ /* For 'wimlib-imagex info' and 'wimlib-imagex dir', data printed to
+ * standard output is part of the program's actual behavior and not just
+ * for informational purposes, so we should set a failure exit status if
+ * there was a write error. */
+ if (cmd == &imagex_commands[INFO] || cmd == &imagex_commands[DIR]) {
+ if (ferror(stdout) || fclose(stdout)) {
+ imagex_error_with_errno("output error");
+ if (ret == 0)
+ ret = -1;
+ }
+ }
out:
+ /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
+ * outside of the wimlib library code. 0 indicates success. > 0
+ * indicates a wimlib error code from which an error message can be
+ * printed. */
if (ret > 0) {
imagex_error("Exiting with error code %d:\n"
" %s.", ret,
if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
imagex_error_with_errno("errno");
}
+
+ /* Make the library free any resources it's holding (not strictly
+ * necessary because the process is ending anyway). */
wimlib_global_cleanup();
return ret;
}
git://wimlib.net / wimlib / blobdiff