X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Futil.c;h=3053fd9e6d2bccbd76e1b15459ee30c0fd33ddf3;hp=bd377204a837bd6357ac0970383b307034e0b6bd;hb=ccdd5a74123ebf14353a9569bf014fb2e7774d1e;hpb=276f9f9f9658f4a8bafd6216db46760abe8c848d diff --git a/src/util.c b/src/util.c index bd377204..3053fd9e 100644 --- a/src/util.c +++ b/src/util.c @@ -21,29 +21,40 @@ * along with wimlib; if not, see http://www.gnu.org/licenses/. */ -#include "config.h" - -#define MINGW_HAS_SECURE_API +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif -#undef _GNU_SOURCE +#ifdef _GNU_SOURCE +# define _GNU_SOURCE_DEFINED 1 +# undef _GNU_SOURCE +#endif /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU * version, which has a different return type. */ -#define _POSIX_C_SOURCE 200112 #include -#define _GNU_SOURCE +#ifdef _GNU_SOURCE_DEFINED +# define _GNU_SOURCE +#endif + +#include "wimlib.h" +#include "wimlib/compiler.h" +#include "wimlib/encoding.h" +#include "wimlib/error.h" +#include "wimlib/types.h" +#include "wimlib/util.h" +#include "wimlib/xml.h" -#include "wimlib_internal.h" -#include "endianness.h" -#include "timestamp.h" +#ifdef __WIN32__ +# include "wimlib/win32.h" /* win32_strerror_r_replacement */ +#endif -#include #include -#include #include +#include +#include +#include -#include /* for getpid() */ - -size_t +static size_t utf16le_strlen(const utf16lechar *s) { const utf16lechar *p = s; @@ -52,62 +63,59 @@ utf16le_strlen(const utf16lechar *s) return (p - s) * sizeof(utf16lechar); } -/* Handle %W for UTF16-LE printing and %U for UTF-8 printing. +#ifdef __WIN32__ +# define wimlib_vfprintf vfwprintf +#else +/* Handle %W for UTF16-LE printing. * * TODO: this is not yet done properly--- it's assumed that if the format string - * contains %W and/or %U, then it contains no other format specifiers. + * contains %W, then it contains no other format specifiers. */ static int wimlib_vfprintf(FILE *fp, const tchar *format, va_list va) { const tchar *p; + int n; for (p = format; *p; p++) - if (*p == '%' && (*(p + 1) == T('W') || *(p + 1) == T('U'))) + if (*p == T('%') && *(p + 1) == T('W')) goto special; return tvfprintf(fp, format, va); special: - /* XXX */ - wimlib_assert(0); -#if 0 - ; - int n = 0; + n = 0; for (p = format; *p; p++) { - if (*p == T('%') && (*(p + 1) == T('W') || *(p + 1) == T('U'))) { + if (*p == T('%') && (*(p + 1) == T('W'))) { int ret; - tchar *mbs; - size_t mbs_nbytes; + tchar *tstr; + size_t tstr_nbytes; + utf16lechar *ucs = va_arg(va, utf16lechar*); - if (*(p + 1) == T('W')) { - utf16lechar *ucs = va_arg(va, utf16lechar*); + if (ucs) { size_t ucs_nbytes = utf16le_strlen(ucs); - ret = utf16le_to_mbs(ucs, ucs_nbytes, - &mbs, &mbs_nbytes); - } else { - utf8char *ucs = va_arg(va, utf8char*); - size_t ucs_nbytes = strlen(ucs); - ret = utf8_to_mbs(ucs, ucs_nbytes, - &mbs, &mbs_nbytes); - } - if (ret) { - ret = tfprintf(fp, T("??????")); + + ret = utf16le_to_tstr(ucs, ucs_nbytes, + &tstr, &tstr_nbytes); + if (ret) { + ret = tfprintf(fp, T("??????")); + } else { + ret = tfprintf(fp, T("%"TS), tstr); + FREE(tstr); + } + if (ret < 0) + return -1; + else + n += ret; } else { - ret = tfprintf(fp, T("%s"), mbs); - FREE(mbs); + n += tfprintf(fp, T("(null)")); } - if (ret < 0) - return -1; - else - n += ret; p++; } else { - if (putc(*p, fp) == EOF) + if (tputc(*p, fp) == EOF) return -1; n++; } } return n; -#endif } int @@ -134,50 +142,57 @@ wimlib_fprintf(FILE *fp, const tchar *format, ...) return ret; } +#endif /* __WIN32__ */ + +#ifdef ENABLE_ERROR_MESSAGES +bool wimlib_print_errors = false; +#endif + #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG) static void wimlib_vmsg(const tchar *tag, const tchar *format, va_list va, bool perror) { -#ifndef DEBUG - if (wimlib_print_errors) { +#if !defined(ENABLE_DEBUG) + if (wimlib_print_errors) #endif + { int errno_save = errno; fflush(stdout); tfputs(tag, stderr); wimlib_vfprintf(stderr, format, va); if (perror && errno_save != 0) { - tchar buf[50]; + tchar buf[64]; int res; - res = tstrerror_r(errno_save, buf, sizeof(buf)); + res = tstrerror_r(errno_save, buf, ARRAY_LEN(buf)); if (res) { tsprintf(buf, T("unknown error (errno=%d)"), errno_save); } + #ifdef WIN32 + if (errno_save == EBUSY) + tstrcpy(buf, T("Resource busy")); + #endif tfprintf(stderr, T(": %"TS), buf); } tputc(T('\n'), stderr); + fflush(stderr); errno = errno_save; -#ifndef DEBUG } -#endif } #endif /* True if wimlib is to print an informational message when an error occurs. * This can be turned off by calling wimlib_set_print_errors(false). */ #ifdef ENABLE_ERROR_MESSAGES -static bool wimlib_print_errors = false; - - void wimlib_error(const tchar *format, ...) { va_list va; va_start(va, format); - wimlib_vmsg(T("[ERROR] "), format, va, false); + wimlib_vmsg(T("\r[ERROR] "), format, va, false); va_end(va); } @@ -187,7 +202,7 @@ wimlib_error_with_errno(const tchar *format, ...) va_list va; va_start(va, format); - wimlib_vmsg(T("[ERROR] "), format, va, true); + wimlib_vmsg(T("\r[ERROR] "), format, va, true); va_end(va); } @@ -197,7 +212,7 @@ wimlib_warning(const tchar *format, ...) va_list va; va_start(va, format); - wimlib_vmsg(T("[WARNING] "), format, va, false); + wimlib_vmsg(T("\r[WARNING] "), format, va, false); va_end(va); } @@ -207,7 +222,7 @@ wimlib_warning_with_errno(const tchar *format, ...) va_list va; va_start(va, format); - wimlib_vmsg(T("[WARNING] "), format, va, true); + wimlib_vmsg(T("\r[WARNING] "), format, va, true); va_end(va); } @@ -217,11 +232,19 @@ wimlib_warning_with_errno(const tchar *format, ...) void wimlib_debug(const tchar *file, int line, const char *func, const tchar *format, ...) { - va_list va; tchar buf[tstrlen(file) + strlen(func) + 30]; - tsprintf(buf, "[%"TS" %d] %s(): ", file, line, func); + static bool debug_enabled = false; + if (!debug_enabled) { + char *value = getenv("WIMLIB_DEBUG"); + if (!value || strcmp(value, "0")) + debug_enabled = true; + else + return; + } + + tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func); va_start(va, format); wimlib_vmsg(buf, format, va, false); @@ -229,6 +252,7 @@ void wimlib_debug(const tchar *file, int line, const char *func, } #endif +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages) { @@ -248,8 +272,6 @@ static const tchar *error_strings[] = { = T("Success"), [WIMLIB_ERR_ALREADY_LOCKED] = T("The WIM is already locked for writing"), - [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE] - = T("Lookup table is compressed"), [WIMLIB_ERR_DECOMPRESSION] = T("Failed to decompress compressed data"), [WIMLIB_ERR_DELETE_STAGING_DIR] @@ -263,6 +285,8 @@ static const tchar *error_strings[] = { [WIMLIB_ERR_FUSERMOUNT] = T("Could not execute the `fusermount' program, or it exited " "with a failure status"), + [WIMLIB_ERR_GLOB_HAD_NO_MATCHES] + = T("The provided file glob did not match any files"), [WIMLIB_ERR_ICONV_NOT_AVAILABLE] = T("The iconv() function does not seem to work. " "Maybe check to make sure the directory /usr/lib/gconv exists"), @@ -271,20 +295,18 @@ static const tchar *error_strings[] = { "resources, the WIM header, and/or the XML data"), [WIMLIB_ERR_IMAGE_NAME_COLLISION] = T("Tried to add an image with a name that is already in use"), + [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES] + = T("The user does not have sufficient privileges"), [WIMLIB_ERR_INTEGRITY] = T("The WIM failed an integrity check"), [WIMLIB_ERR_INVALID_CAPTURE_CONFIG] = T("The capture configuration string was invalid"), [WIMLIB_ERR_INVALID_CHUNK_SIZE] - = T("The WIM is compressed but does not have a chunk " - "size of 32768"), + = T("The WIM chunk size was invalid"), [WIMLIB_ERR_INVALID_COMPRESSION_TYPE] - = T("The WIM is compressed, but is not marked as having LZX or " - "XPRESS compression"), - [WIMLIB_ERR_INVALID_DENTRY] - = T("A directory entry in the WIM was invalid"), - [WIMLIB_ERR_INVALID_HEADER_SIZE] - = T("The WIM header was not 208 bytes"), + = T("The WIM compression type was invalid"), + [WIMLIB_ERR_INVALID_HEADER] + = T("The WIM header was invalid"), [WIMLIB_ERR_INVALID_IMAGE] = T("Tried to select an image that does not exist in the WIM"), [WIMLIB_ERR_INVALID_INTEGRITY_TABLE] @@ -299,12 +321,14 @@ static const tchar *error_strings[] = { = T("An invalid parameter was given"), [WIMLIB_ERR_INVALID_PART_NUMBER] = T("The part number or total parts of the WIM is invalid"), + [WIMLIB_ERR_INVALID_PIPABLE_WIM] + = T("The pipable WIM is invalid"), + [WIMLIB_ERR_INVALID_REPARSE_DATA] + = T("The reparse data of a reparse point was invalid"), [WIMLIB_ERR_INVALID_RESOURCE_HASH] = T("The SHA1 message digest of a WIM resource did not match the expected value"), - [WIMLIB_ERR_INVALID_RESOURCE_SIZE] - = T("A resource entry in the WIM has an invalid size"), - [WIMLIB_ERR_INVALID_SECURITY_DATA] - = T("The table of security descriptors in the WIM is invalid"), + [WIMLIB_ERR_INVALID_METADATA_RESOURCE] + = T("The metadata resource is invalid"), [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE] = T("The version of wimlib that has mounted a WIM image is incompatible with the " "version being used to unmount it"), @@ -312,12 +336,18 @@ static const tchar *error_strings[] = { = T("A string provided as input by the user was not a valid UTF-8 string"), [WIMLIB_ERR_INVALID_UTF16_STRING] = T("A string in a WIM dentry is not a valid UTF-16LE string"), + [WIMLIB_ERR_IS_DIRECTORY] + = T("One of the specified paths to delete was a directory"), + [WIMLIB_ERR_IS_SPLIT_WIM] + = T("The WIM is part of a split WIM, which is not supported for this operation"), [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE] = T("libxml2 was unable to find a character encoding conversion handler " "for UTF-16LE"), [WIMLIB_ERR_LINK] = T("Failed to create a hard or symbolic link when extracting " "a file from the WIM"), + [WIMLIB_ERR_METADATA_NOT_FOUND] + = T("A required metadata resource could not be located"), [WIMLIB_ERR_MKDIR] = T("Failed to create a directory"), [WIMLIB_ERR_MQUEUE] @@ -326,53 +356,84 @@ static const tchar *error_strings[] = { = T("Ran out of memory"), [WIMLIB_ERR_NOTDIR] = T("Expected a directory"), + [WIMLIB_ERR_NOTEMPTY] + = T("Directory was not empty"), [WIMLIB_ERR_NOT_A_WIM_FILE] = T("The file did not begin with the magic characters that " "identify a WIM file"), + [WIMLIB_ERR_NOT_A_REGULAR_FILE] + = T("One of the specified paths to extract did not " + "correspond to a regular file"), [WIMLIB_ERR_NO_FILENAME] = T("The WIM is not identified with a filename"), + [WIMLIB_ERR_NOT_PIPABLE] + = T("The WIM was not captured such that it can be " + "applied from a pipe"), [WIMLIB_ERR_NTFS_3G] = T("NTFS-3g encountered an error (check errno)"), [WIMLIB_ERR_OPEN] = T("Failed to open a file"), [WIMLIB_ERR_OPENDIR] = T("Failed to open a directory"), + [WIMLIB_ERR_PATH_DOES_NOT_EXIST] + = T("The path does not exist in the WIM image"), [WIMLIB_ERR_READ] = T("Could not read data from a file"), [WIMLIB_ERR_READLINK] = T("Could not read the target of a symbolic link"), [WIMLIB_ERR_RENAME] = T("Could not rename a file"), - [WIMLIB_ERR_REOPEN] - = T("Could not re-open the WIM after overwriting it"), + [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED] + = T("Unable to complete reparse point fixup"), + [WIMLIB_ERR_RESOURCE_NOT_FOUND] + = T("A file resource needed to complete the operation was missing from the WIM"), [WIMLIB_ERR_RESOURCE_ORDER] = T("The components of the WIM were arranged in an unexpected order"), - [WIMLIB_ERR_SPECIAL_FILE] - = T("Encountered a special file that cannot be archived"), + [WIMLIB_ERR_SET_ATTRIBUTES] + = T("Failed to set attributes on extracted file"), + [WIMLIB_ERR_SET_REPARSE_DATA] + = T("Failed to set reparse data on extracted file"), + [WIMLIB_ERR_SET_SECURITY] + = T("Failed to set file owner, group, or other permissions on extracted file"), + [WIMLIB_ERR_SET_SHORT_NAME] + = T("Failed to set short name on extracted file"), + [WIMLIB_ERR_SET_TIMESTAMPS] + = T("Failed to set timestamps on extracted file"), [WIMLIB_ERR_SPLIT_INVALID] = T("The WIM is part of an invalid split WIM"), - [WIMLIB_ERR_SPLIT_UNSUPPORTED] - = T("The WIM is part of a split WIM, which is not supported for this operation"), [WIMLIB_ERR_STAT] = T("Could not read the metadata for a file or directory"), [WIMLIB_ERR_TIMEOUT] = T("Timed out while waiting for a message to arrive from another process"), + [WIMLIB_ERR_UNEXPECTED_END_OF_FILE] + = T("Unexpectedly reached the end of the file"), [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE] = T("A Unicode string could not be represented in the current locale's encoding"), [WIMLIB_ERR_UNKNOWN_VERSION] = T("The WIM file is marked with an unknown version number"), [WIMLIB_ERR_UNSUPPORTED] = T("The requested operation is unsupported"), + [WIMLIB_ERR_UNSUPPORTED_FILE] + = T("A file in the directory tree to archive was not of a supported type"), + [WIMLIB_ERR_VOLUME_LACKS_FEATURES] + = T("The volume did not support a feature necessary to complete the operation"), + [WIMLIB_ERR_WIM_IS_READONLY] + = T("The WIM is read-only (file permissions, header flag, or split WIM)"), [WIMLIB_ERR_WRITE] = T("Failed to write data to a file"), [WIMLIB_ERR_XML] = T("The XML data of the WIM is invalid"), + [WIMLIB_ERR_WIM_IS_ENCRYPTED] + = T("The WIM file (or parts of it) is encrypted"), + [WIMLIB_ERR_WIMBOOT] + = T("Failed to set WIMBoot pointer data"), }; +/* API function documented in wimlib.h */ WIMLIBAPI const tchar * wimlib_get_error_string(enum wimlib_error_code code) { - if (code < 0 || code >= ARRAY_LEN(error_strings)) + if ((int)code < 0 || code >= ARRAY_LEN(error_strings)) return NULL; else return error_strings[code]; @@ -380,10 +441,37 @@ wimlib_get_error_string(enum wimlib_error_code code) -#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR -void *(*wimlib_malloc_func) (size_t) = malloc; -void (*wimlib_free_func) (void *) = free; -void *(*wimlib_realloc_func)(void *, size_t) = realloc; +static void *(*wimlib_malloc_func) (size_t) = malloc; +static void (*wimlib_free_func) (void *) = free; +static void *(*wimlib_realloc_func)(void *, size_t) = realloc; + +void * +wimlib_malloc(size_t size) +{ + if (size == 0) + size = 1; + void *ptr = (*wimlib_malloc_func)(size); + if (ptr == NULL) + ERROR("memory exhausted"); + return ptr; +} + +void +wimlib_free_memory(void *ptr) +{ + (*wimlib_free_func)(ptr); +} + +void * +wimlib_realloc(void *ptr, size_t size) +{ + if (size == 0) + size = 1; + ptr = (*wimlib_realloc_func)(ptr, size); + if (ptr == NULL) + ERROR("memory exhausted"); + return ptr; +} void * wimlib_calloc(size_t nmemb, size_t size) @@ -391,7 +479,7 @@ wimlib_calloc(size_t nmemb, size_t size) size_t total_size = nmemb * size; void *p = MALLOC(total_size); if (p) - memset(p, 0, total_size); + p = memset(p, 0, total_size); return p; } @@ -404,7 +492,7 @@ wimlib_strdup(const char *str) size = strlen(str); p = MALLOC(size + 1); if (p) - memcpy(p, str, size + 1); + p = memcpy(p, str, size + 1); return p; } @@ -418,23 +506,26 @@ wimlib_wcsdup(const wchar_t *str) size = wcslen(str); p = MALLOC((size + 1) * sizeof(wchar_t)); if (p) - memcpy(p, str, (size + 1) * sizeof(wchar_t)); + p = wmemcpy(p, str, size + 1); return p; } #endif -extern void -xml_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)); -#endif +void * +memdup(const void *mem, size_t size) +{ + void *ptr = MALLOC(size); + if (ptr) + ptr = memcpy(ptr, mem, size); + return ptr; +} +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), void (*free_func)(void *), void *(*realloc_func)(void *, size_t)) { -#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR wimlib_malloc_func = malloc_func ? malloc_func : malloc; wimlib_free_func = free_func ? free_func : free; wimlib_realloc_func = realloc_func ? realloc_func : realloc; @@ -442,18 +533,12 @@ wimlib_set_memory_allocator(void *(*malloc_func)(size_t), xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func, wimlib_realloc_func); return 0; -#else - ERROR("Cannot set custom memory allocator functions:"); - ERROR("wimlib was compiled with the --without-custom-memory-allocator " - "flag"); - return WIMLIB_ERR_UNSUPPORTED; -#endif } static bool seeded = false; static void -seed_random() +seed_random(void) { srand(time(NULL) * getpid()); seeded = true; @@ -486,137 +571,16 @@ randomize_byte_array(u8 *p, size_t n) *p++ = rand(); } -/* Takes in a path of length @len in @buf, and transforms it into a string for - * the path of its parent directory. */ -void -to_parent_name(tchar *buf, size_t len) -{ - ssize_t i = (ssize_t)len - 1; - while (i >= 0 && buf[i] == T('/')) - i--; - while (i >= 0 && buf[i] != T('/')) - i--; - while (i >= 0 && buf[i] == T('/')) - i--; - buf[i + 1] = T('\0'); -} -/* Like the basename() function, but does not modify @path; it just returns a - * pointer to it. */ -const tchar * -path_basename(const tchar *path) +void print_byte_field(const u8 field[], size_t len, FILE *out) { - const tchar *p = path; - while (*p) - p++; - p--; - - /* Trailing slashes. */ - while (1) { - if (p == path - 1) - return T(""); - if (*p != T('/')) - break; - p--; - } - - while ((p != path - 1) && *p != T('/')) - p--; - - return p + 1; + while (len--) + tfprintf(out, T("%02hhx"), *field++); } -/* - * Returns a pointer to the part of @path following the first colon in the last - * path component, or NULL if the last path component does not contain a colon. - */ -const tchar * -path_stream_name(const tchar *path) +#ifndef HAVE_MEMPCPY +void *mempcpy(void *dst, const void *src, size_t n) { - const tchar *base = path_basename(path); - const tchar *stream_name = tstrchr(base, T(':')); - if (!stream_name) - return NULL; - else - return stream_name + 1; -} - -/* - * Splits a file path into the part before the first '/', or the entire name if - * there is no '/', and the part after the first sequence of '/' characters. - * - * @path: The file path to split. - * @first_part_len_ret: A pointer to a `size_t' into which the length of the - * first part of the path will be returned. - * @return: A pointer to the next part of the path, after the first - * sequence of '/', or a pointer to the terminating - * null byte in the case of a path without any '/'. - */ -const tchar * -path_next_part(const tchar *path, size_t *first_part_len_ret) -{ - size_t i; - const tchar *next_part; - - i = 0; - while (path[i] != T('/') && path[i] != T('\0')) - i++; - if (first_part_len_ret) - *first_part_len_ret = i; - next_part = &path[i]; - while (*next_part == T('/')) - next_part++; - return next_part; -} - -/* Returns the number of components of @path. */ -int -get_num_path_components(const char *path) -{ - int num_components = 0; - while (*path) { - while (*path == '/') - path++; - if (*path) - num_components++; - while (*path && *path != '/') - path++; - } - return num_components; -} - - -/* - * Prints a string. Printable characters are printed as-is, while unprintable - * characters are printed as their octal escape codes. - */ -void -print_string(const void *string, size_t len) -{ - const u8 *p = string; - - while (len--) { - if (isprint(*p)) - putchar(*p); - else - printf("\\%03hho", *p); - p++; - } -} - -u64 -get_wim_timestamp() -{ - struct timeval tv; - gettimeofday(&tv, NULL); - return timeval_to_wim_timestamp(tv); -} - -void -wim_timestamp_to_str(u64 timestamp, tchar *buf, size_t len) -{ - struct tm tm; - time_t t = wim_timestamp_to_unix(timestamp); - gmtime_r(&t, &tm); - tstrftime(buf, len, T("%a %b %d %H:%M:%S %Y UTC"), &tm); + return memcpy(dst, src, n) + n; } +#endif