X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Futil.c;h=f5a8ca29fb5e6451aea7926a0975471ce10f2514;hp=e566b52b2e21f52f28aafd6ccdde28501e3d872b;hb=fced769402ff6ef0bf75fe9e4dcb2880891469e0;hpb=9e56d04309e3e6a896319225288f0c86bd36d34e diff --git a/src/util.c b/src/util.c index e566b52b..f5a8ca29 100644 --- a/src/util.c +++ b/src/util.c @@ -21,90 +21,227 @@ * along with wimlib; if not, see http://www.gnu.org/licenses/. */ -#undef _GNU_SOURCE +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#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_internal.h" -#include "endianness.h" -#include "timestamp.h" +#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" + +#ifdef __WIN32__ +# include "wimlib/win32.h" /* win32_strerror_r_replacement */ +#endif -#include #include +#include #include +#include +#include -#include /* for getpid() */ +static size_t +utf16le_strlen(const utf16lechar *s) +{ + const utf16lechar *p = s; + while (*p) + p++; + return (p - s) * sizeof(utf16lechar); +} + +#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, 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 == T('%') && *(p + 1) == T('W')) + goto special; + return tvfprintf(fp, format, va); +special: + n = 0; + for (p = format; *p; p++) { + if (*p == T('%') && (*(p + 1) == T('W'))) { + int ret; + tchar *tstr; + size_t tstr_nbytes; + utf16lechar *ucs = va_arg(va, utf16lechar*); + + if (ucs) { + size_t ucs_nbytes = utf16le_strlen(ucs); + + 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 { + n += tfprintf(fp, T("(null)")); + } + p++; + } else { + if (tputc(*p, fp) == EOF) + return -1; + n++; + } + } + return n; +} + +int +wimlib_printf(const tchar *format, ...) +{ + int ret; + va_list va; + + va_start(va, format); + ret = wimlib_vfprintf(stdout, format, va); + va_end(va); + return ret; +} + +int +wimlib_fprintf(FILE *fp, const tchar *format, ...) +{ + int ret; + va_list va; + + va_start(va, format); + ret = wimlib_vfprintf(fp, format, va); + va_end(va); + return ret; +} + +#endif /* __WIN32__ */ -/* 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 -#include -static bool wimlib_print_errors = false; +bool wimlib_print_errors = false; +#endif -static void wimlib_vmsg(const char *tag, const char *format, - va_list va, bool perror) +#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) { +#endif int errno_save = errno; fflush(stdout); - fputs(tag, stderr); - vfprintf(stderr, format, va); + tfputs(tag, stderr); + wimlib_vfprintf(stderr, format, va); if (perror && errno_save != 0) { - char buf[50]; - int res = strerror_r(errno_save, buf, sizeof(buf)); + tchar buf[50]; + int res; + res = tstrerror_r(errno_save, buf, sizeof(buf)); if (res) { - snprintf(buf, sizeof(buf), - "unknown error (errno=%d)", errno_save); + tsprintf(buf, + T("unknown error (errno=%d)"), + errno_save); } - fprintf(stderr, ": %s", buf); + tfprintf(stderr, T(": %"TS), buf); } - putc('\n', stderr); + tputc(T('\n'), stderr); + fflush(stderr); errno = errno_save; +#ifndef DEBUG } +#endif } +#endif -void wimlib_error(const char *format, ...) +/* 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 +void +wimlib_error(const tchar *format, ...) { va_list va; va_start(va, format); - wimlib_vmsg("[ERROR] ", format, va, false); + wimlib_vmsg(T("\r[ERROR] "), format, va, false); va_end(va); } -void wimlib_error_with_errno(const char *format, ...) +void +wimlib_error_with_errno(const tchar *format, ...) { va_list va; va_start(va, format); - wimlib_vmsg("[ERROR] ", format, va, true); + wimlib_vmsg(T("\r[ERROR] "), format, va, true); va_end(va); } -void wimlib_warning(const char *format, ...) +void +wimlib_warning(const tchar *format, ...) { va_list va; va_start(va, format); - wimlib_vmsg("[WARNING] ", format, va, false); + wimlib_vmsg(T("\r[WARNING] "), format, va, false); va_end(va); } -void wimlib_warning_with_errno(const char *format, ...) +void +wimlib_warning_with_errno(const tchar *format, ...) { va_list va; va_start(va, format); - wimlib_vmsg("[WARNING] ", format, va, true); + wimlib_vmsg(T("\r[WARNING] "), format, va, true); va_end(va); } #endif -WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages) +#if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG) +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, T("[%"TS" %d] %s(): "), file, line, func); + + va_start(va, format); + wimlib_vmsg(buf, format, va, false); + va_end(va); +} +#endif + +WIMLIBAPI int +wimlib_set_print_errors(bool show_error_messages) { #ifdef ENABLE_ERROR_MESSAGES wimlib_print_errors = show_error_messages; @@ -117,129 +254,153 @@ WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages) #endif } -static const char *error_strings[] = { +static const tchar *error_strings[] = { [WIMLIB_ERR_SUCCESS] - = "Success", + = T("Success"), [WIMLIB_ERR_ALREADY_LOCKED] - = "The WIM is already locked for writing", + = T("The WIM is already locked for writing"), [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE] - = "Lookup table is compressed", + = T("Lookup table is compressed"), [WIMLIB_ERR_DECOMPRESSION] - = "Failed to decompress compressed data", + = T("Failed to decompress compressed data"), [WIMLIB_ERR_DELETE_STAGING_DIR] - = "Failed to delete staging directory", + = T("Failed to delete staging directory"), [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED] - = "The process servicing the mounted WIM has crashed", + = T("The process servicing the mounted WIM has crashed"), [WIMLIB_ERR_FORK] - = "Failed to fork another process", + = T("Failed to fork another process"), [WIMLIB_ERR_FUSE] - = "An error was returned by fuse_main()", + = T("An error was returned by fuse_main()"), [WIMLIB_ERR_FUSERMOUNT] - = "Could not execute the `fusermount' program, or it exited " - "with a failure status", + = T("Could not execute the `fusermount' program, or it exited " + "with a failure status"), [WIMLIB_ERR_ICONV_NOT_AVAILABLE] - = "The iconv() function does not seem to work. " - "Maybe check to make sure the directory /usr/lib/gconv exists", + = T("The iconv() function does not seem to work. " + "Maybe check to make sure the directory /usr/lib/gconv exists"), [WIMLIB_ERR_IMAGE_COUNT] - = "Inconsistent image count among the metadata " - "resources, the WIM header, and/or the XML data", + = T("Inconsistent image count among the metadata " + "resources, the WIM header, and/or the XML data"), + [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT] + = T("User does not have sufficient privileges to correctly extract the data"), [WIMLIB_ERR_IMAGE_NAME_COLLISION] - = "Tried to add an image with a name that is already in use", + = T("Tried to add an image with a name that is already in use"), [WIMLIB_ERR_INTEGRITY] - = "The WIM failed an integrity check", + = T("The WIM failed an integrity check"), [WIMLIB_ERR_INVALID_CAPTURE_CONFIG] - = "The capture configuration string was invalid", + = T("The capture configuration string was invalid"), [WIMLIB_ERR_INVALID_CHUNK_SIZE] - = "The WIM is compressed but does not have a chunk " - "size of 32768", + = T("The WIM is compressed but does not have a chunk " + "size of 32768"), [WIMLIB_ERR_INVALID_COMPRESSION_TYPE] - = "The WIM is compressed, but is not marked as having LZX or " - "XPRESS compression", + = T("The WIM is compressed, but is not marked as having LZX or " + "XPRESS compression"), [WIMLIB_ERR_INVALID_DENTRY] - = "A directory entry in the WIM was invalid", + = T("A directory entry in the WIM was invalid"), [WIMLIB_ERR_INVALID_HEADER_SIZE] - = "The WIM header was not 208 bytes", + = T("The WIM header was not 208 bytes"), [WIMLIB_ERR_INVALID_IMAGE] - = "Tried to select an image that does not exist in the WIM", + = T("Tried to select an image that does not exist in the WIM"), [WIMLIB_ERR_INVALID_INTEGRITY_TABLE] - = "The WIM's integrity table is invalid", + = T("The WIM's integrity table is invalid"), [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY] - = "An entry in the WIM's lookup table is invalid", + = T("An entry in the WIM's lookup table is invalid"), + [WIMLIB_ERR_INVALID_MULTIBYTE_STRING] + = T("A string was not valid in the current locale's character encoding"), + [WIMLIB_ERR_INVALID_OVERLAY] + = T("Conflicting files in overlay when creating a WIM image"), [WIMLIB_ERR_INVALID_PARAM] - = "An invalid parameter was given", + = T("An invalid parameter was given"), [WIMLIB_ERR_INVALID_PART_NUMBER] - = "The part number or total parts of the WIM is invalid", + = T("The part number or total parts of the WIM is invalid"), + [WIMLIB_ERR_INVALID_REPARSE_DATA] + = T("The reparse data of a reparse point was invalid"), [WIMLIB_ERR_INVALID_RESOURCE_HASH] - = "The SHA1 message digest of a WIM resource did not match the expected value", + = T("The SHA1 message digest of a WIM resource did not match the expected value"), [WIMLIB_ERR_INVALID_RESOURCE_SIZE] - = "A resource entry in the WIM has an invalid size", + = T("A resource entry in the WIM has an invalid size"), [WIMLIB_ERR_INVALID_SECURITY_DATA] - = "The table of security descriptors in the WIM is invalid", + = T("The table of security descriptors in the WIM is invalid"), [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE] - = "The version of wimlib that has mounted a WIM image is incompatible with the " - "version being used to unmount it", + = T("The version of wimlib that has mounted a WIM image is incompatible with the " + "version being used to unmount it"), [WIMLIB_ERR_INVALID_UTF8_STRING] - = "A string provided as input by the user was not a valid UTF-8 string", + = T("A string provided as input by the user was not a valid UTF-8 string"), [WIMLIB_ERR_INVALID_UTF16_STRING] - = "A string in a WIM dentry is not a valid UTF-16LE 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_LIBXML_UTF16_HANDLER_NOT_AVAILABLE] - = "libxml2 was unable to find a character encoding conversion handler " - "for UTF-16LE", + = T("libxml2 was unable to find a character encoding conversion handler " + "for UTF-16LE"), [WIMLIB_ERR_LINK] - = "Failed to create a hard or symbolic link when extracting " - "a file from the WIM", + = T("Failed to create a hard or symbolic link when extracting " + "a file from the WIM"), [WIMLIB_ERR_MKDIR] - = "Failed to create a directory", + = T("Failed to create a directory"), [WIMLIB_ERR_MQUEUE] - = "Failed to create or use a POSIX message queue", + = T("Failed to create or use a POSIX message queue"), [WIMLIB_ERR_NOMEM] - = "Ran out of memory", + = T("Ran out of memory"), [WIMLIB_ERR_NOTDIR] - = "Expected a directory", + = T("Expected a directory"), + [WIMLIB_ERR_NOTEMPTY] + = T("Directory was not empty"), [WIMLIB_ERR_NOT_A_WIM_FILE] - = "The file did not begin with the magic characters that " - "identify 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] - = "The WIM is not identified with a filename", + = T("The WIM is not identified with a filename"), [WIMLIB_ERR_NTFS_3G] - = "NTFS-3g encountered an error (check errno)", + = T("NTFS-3g encountered an error (check errno)"), [WIMLIB_ERR_OPEN] - = "Failed to open a file", + = T("Failed to open a file"), [WIMLIB_ERR_OPENDIR] - = "Failed to open a directory", + = 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] - = "Could not read data from a file", + = T("Could not read data from a file"), [WIMLIB_ERR_READLINK] - = "Could not read the target of a symbolic link", + = T("Could not read the target of a symbolic link"), [WIMLIB_ERR_RENAME] - = "Could not rename a file", - [WIMLIB_ERR_REOPEN] - = "Could not re-open the WIM after overwriting it", + = T("Could not rename a file"), + [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED] + = T("Unable to complete reparse point fixup"), [WIMLIB_ERR_RESOURCE_ORDER] - = "The components of the WIM were arranged in an unexpected order", + = T("The components of the WIM were arranged in an unexpected order"), [WIMLIB_ERR_SPECIAL_FILE] - = "Encountered a special file that cannot be archived", + = T("Encountered a special file that cannot be archived"), [WIMLIB_ERR_SPLIT_INVALID] - = "The WIM is part of an invalid split WIM", + = T("The WIM is part of an invalid split WIM"), [WIMLIB_ERR_SPLIT_UNSUPPORTED] - = "The WIM is part of a split WIM, which is not supported for this operation", + = T("The WIM is part of a split WIM, which is not supported for this operation"), [WIMLIB_ERR_STAT] - = "Could not read the metadata for a file or directory", + = T("Could not read the metadata for a file or directory"), [WIMLIB_ERR_TIMEOUT] - = "Timed out while waiting for a message to arrive from another process", + = T("Timed out while waiting for a message to arrive from another process"), + [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE] + = T("A Unicode string could not be represented in the current locale's encoding"), [WIMLIB_ERR_UNKNOWN_VERSION] - = "The WIM file is marked with an unknown version number", + = T("The WIM file is marked with an unknown version number"), [WIMLIB_ERR_UNSUPPORTED] - = "The requested operation is unsupported", + = T("The requested operation is unsupported"), + [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] - = "Failed to write data to a file", + = T("Failed to write data to a file"), [WIMLIB_ERR_XML] - = "The XML data of the WIM is invalid", + = T("The XML data of the WIM is invalid"), }; -WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code) +WIMLIBAPI const tchar * +wimlib_get_error_string(enum wimlib_error_code code) { - if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML) + if (code < 0 || code >= ARRAY_LEN(error_strings)) return NULL; else return error_strings[code]; @@ -248,20 +409,46 @@ WIMLIBAPI const char *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) +{ + void *ptr = (*wimlib_malloc_func)(size); + if (ptr == NULL && size != 0) + ERROR("memory exhausted"); + return ptr; +} -void *wimlib_calloc(size_t nmemb, size_t size) +void +wimlib_free_memory(void *ptr) +{ + (*wimlib_free_func)(ptr); +} + +void * +wimlib_realloc(void *ptr, size_t size) +{ + ptr = (*wimlib_realloc_func)(ptr, size); + if (ptr == NULL && size != 0) + ERROR("memory exhausted"); + return ptr; +} + +void * +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; } -char *wimlib_strdup(const char *str) +char * +wimlib_strdup(const char *str) { size_t size; char *p; @@ -269,18 +456,40 @@ char *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; } -extern void xml_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)); +#ifdef __WIN32__ +wchar_t * +wimlib_wcsdup(const wchar_t *str) +{ + size_t size; + wchar_t *p; + + size = wcslen(str); + p = MALLOC((size + 1) * sizeof(wchar_t)); + if (p) + p = wmemcpy(p, str, size + 1); + return p; +} #endif -WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)) +#endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */ + +void * +memdup(const void *mem, size_t size) +{ + void *ptr = MALLOC(size); + if (ptr) + ptr = memcpy(ptr, mem, size); + return ptr; +} + +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; @@ -300,14 +509,16 @@ WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), static bool seeded = false; -static void seed_random() +static void +seed_random(void) { srand(time(NULL) * getpid()); seeded = true; } -/* Fills @n bytes pointed to by @p with random alphanumeric characters. */ -void randomize_char_array_with_alnum(char p[], size_t n) +/* Fills @n characters pointed to by @p with random alphanumeric characters. */ +void +randomize_char_array_with_alnum(tchar p[], size_t n) { if (!seeded) seed_random(); @@ -323,7 +534,8 @@ void randomize_char_array_with_alnum(char p[], size_t n) } /* Fills @n bytes pointer to by @p with random numbers. */ -void randomize_byte_array(u8 *p, size_t n) +void +randomize_byte_array(u8 *p, size_t n) { if (!seeded) seed_random(); @@ -331,129 +543,9 @@ void 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(char buf[], size_t len) -{ - ssize_t i = (ssize_t)len - 1; - while (i >= 0 && buf[i] == '/') - i--; - while (i >= 0 && buf[i] != '/') - i--; - while (i >= 0 && buf[i] == '/') - i--; - buf[i + 1] = '\0'; -} - -/* Like the basename() function, but does not modify @path; it just returns a - * pointer to it. */ -const char *path_basename(const char *path) -{ - const char *p = path; - while (*p) - p++; - p--; - - /* Trailing slashes. */ - while (1) { - if (p == path - 1) - return ""; - if (*p != '/') - break; - p--; - } - - while ((p != path - 1) && *p != '/') - p--; - - return p + 1; -} - -/* - * 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 char *path_stream_name(const char *path) -{ - const char *base = path_basename(path); - const char *stream_name = strchr(base, ':'); - 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 char *path_next_part(const char *path, size_t *first_part_len_ret) -{ - size_t i; - const char *next_part; - - i = 0; - while (path[i] != '/' && path[i] != '\0') - i++; - if (first_part_len_ret) - *first_part_len_ret = i; - next_part = &path[i]; - while (*next_part == '/') - 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, char *buf, size_t len) +void print_byte_field(const u8 field[], size_t len, FILE *out) { - struct tm tm; - time_t t = wim_timestamp_to_unix(timestamp); - gmtime_r(&t, &tm); - strftime(buf, len, "%a %b %d %H:%M:%S %Y UTC", &tm); + while (len--) + tfprintf(out, T("%02hhx"), *field++); }