X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Futil.c;h=c0244ba2f2a5a90d83a7fbcab51f19f84ae5536b;hp=faa0d0bf4488000cedfc9ef3294957c1ee1535a2;hb=de12c346dc64404821d52d545e2e1b3d44230f2a;hpb=e6227e4978dd41e0726ef1b54713089d343b57de diff --git a/src/util.c b/src/util.c index faa0d0bf..c0244ba2 100644 --- a/src/util.c +++ b/src/util.c @@ -3,7 +3,7 @@ */ /* - * Copyright (C) 2012 Eric Biggers + * Copyright (C) 2012, 2013 Eric Biggers * * This file is part of wimlib, a library for working with WIM files. * @@ -21,99 +21,240 @@ * along with wimlib; if not, see http://www.gnu.org/licenses/. */ +#include "config.h" + +#define MINGW_HAS_SECURE_API + +#undef _GNU_SOURCE +/* 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 + #include "wimlib_internal.h" #include "endianness.h" -#include "sha1.h" #include "timestamp.h" -#include - -#include -#include #include -#include -#include -#include #include - -/* 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 #include -bool __wimlib_print_errors = false; -void wimlib_error(const char *format, ...) +#include /* for getpid() */ + +/* Windoze compatibility */ +#ifdef __WIN32__ +# define strerror_r(errnum, buf, bufsize) strerror_s(buf, bufsize, errnum) +#endif + +size_t +utf16le_strlen(const utf16lechar *s) { - if (__wimlib_print_errors) { - va_list va; - int errno_save; - - va_start(va, format); - errno_save = errno; - fputs("[ERROR] ", stderr); - vfprintf(stderr, format, va); - putc('\n', stderr); - errno = errno_save; - va_end(va); + const utf16lechar *p = s; + while (*p) + p++; + return (p - s) * sizeof(utf16lechar); +} + +/* Handle %W for UTF16-LE printing and %U for UTF-8 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. + */ +static int +wimlib_vfprintf(FILE *fp, const char *format, va_list va) +{ + const char *p; + + for (p = format; *p; p++) + if (*p == '%' && (*(p + 1) == 'W' || *(p + 1) == 'U')) + goto special; + return vfprintf(fp, format, va); +special: + ; + int n = 0; + for (p = format; *p; p++) { + if (*p == '%' && (*(p + 1) == 'W' || *(p + 1) == 'U')) { + int ret; + mbchar *mbs; + size_t mbs_nbytes; + + if (*(p + 1) == 'W') { + utf16lechar *ucs = va_arg(va, utf16lechar*); + 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 = fprintf(fp, "??????"); + } else { + ret = fprintf(fp, "%s", mbs); + FREE(mbs); + } + if (ret < 0) + return -1; + else + n += ret; + p++; + } else { + if (putc(*p, fp) == EOF) + return -1; + n++; + } } + return n; } -void wimlib_error_with_errno(const char *format, ...) +int +wimlib_printf(const char *format, ...) { - if (__wimlib_print_errors) { - va_list va; - int errno_save; + int ret; + va_list va; - va_start(va, format); - errno_save = errno; - fflush(stdout); - fputs("[ERROR] ", stderr); - vfprintf(stderr, format, va); - fprintf(stderr, ": %s\n", strerror(errno_save)); - errno = errno_save; - va_end(va); - } + va_start(va, format); + ret = wimlib_vfprintf(stdout, format, va); + va_end(va); + return ret; } -void wimlib_warning(const char *format, ...) +int +wimlib_fprintf(FILE *fp, const char *format, ...) { - if (__wimlib_print_errors) { - va_list va; - int errno_save; + int ret; + va_list va; + + va_start(va, format); + ret = wimlib_vfprintf(fp, format, va); + va_end(va); + return ret; +} - va_start(va, format); - errno_save = errno; +#if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG) +static void +wimlib_vmsg(const char *tag, const char *format, + va_list va, bool perror) +{ +#ifndef DEBUG + if (wimlib_print_errors) { +#endif + int errno_save = errno; fflush(stdout); - fputs("[WARNING] ", stderr); - vfprintf(stderr, format, va); + fputs(tag, stderr); + wimlib_vfprintf(stderr, format, va); + if (perror && errno_save != 0) { + char buf[50]; + int res; + res = strerror_r(errno_save, buf, sizeof(buf)); + if (res) { + snprintf(buf, sizeof(buf), + "unknown error (errno=%d)", errno_save); + } + fprintf(stderr, ": %s", buf); + } putc('\n', stderr); errno = errno_save; - va_end(va); +#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 char *format, ...) +{ + va_list va; + + va_start(va, format); + wimlib_vmsg("[ERROR] ", format, va, false); + va_end(va); +} + +void +wimlib_error_with_errno(const char *format, ...) +{ + va_list va; + + va_start(va, format); + wimlib_vmsg("[ERROR] ", format, va, true); + va_end(va); +} + +void +wimlib_warning(const char *format, ...) +{ + va_list va; + + va_start(va, format); + wimlib_vmsg("[WARNING] ", format, va, false); + va_end(va); +} + +void +wimlib_warning_with_errno(const char *format, ...) +{ + va_list va; + + va_start(va, format); + wimlib_vmsg("[WARNING] ", format, va, true); + va_end(va); } #endif -WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages) +#ifdef ENABLE_DEBUG +void wimlib_debug(const char *file, int line, const char *func, + const char *format, ...) +{ + + va_list va; + char buf[strlen(file) + strlen(func) + 30]; + + sprintf(buf, "[%s %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; + wimlib_print_errors = show_error_messages; return 0; #else if (show_error_messages) return WIMLIB_ERR_UNSUPPORTED; + else + return 0; #endif } -static const char *error_strings[] = { +static const mbchar *error_strings[] = { [WIMLIB_ERR_SUCCESS] = "Success", + [WIMLIB_ERR_ALREADY_LOCKED] + = "The WIM is already locked for writing", [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE] = "Lookup table is compressed", [WIMLIB_ERR_DECOMPRESSION] = "Failed to decompress compressed data", [WIMLIB_ERR_DELETE_STAGING_DIR] = "Failed to delete staging directory", + [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED] + = "The process servicing the mounted WIM has crashed", [WIMLIB_ERR_FORK] = "Failed to fork another process", [WIMLIB_ERR_FUSE] @@ -121,6 +262,9 @@ static const char *error_strings[] = { [WIMLIB_ERR_FUSERMOUNT] = "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", [WIMLIB_ERR_IMAGE_COUNT] = "Inconsistent image count among the metadata " "resources, the WIM header, and/or the XML data", @@ -146,12 +290,30 @@ static const char *error_strings[] = { = "The WIM's integrity table is invalid", [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY] = "An entry in the WIM's lookup table is invalid", + [WIMLIB_ERR_INVALID_MULTIBYTE_STRING] + = "A string was not valid in the current locale's character encoding", + [WIMLIB_ERR_INVALID_OVERLAY] + = "Conflicting files in overlay when creating a WIM image", [WIMLIB_ERR_INVALID_PARAM] = "An invalid parameter was given", + [WIMLIB_ERR_INVALID_PART_NUMBER] + = "The part number or total parts of the WIM is invalid", [WIMLIB_ERR_INVALID_RESOURCE_HASH] = "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", + [WIMLIB_ERR_INVALID_SECURITY_DATA] + = "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", + [WIMLIB_ERR_INVALID_UTF8_STRING] + = "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", + [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE] + = "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", @@ -193,7 +355,9 @@ static const char *error_strings[] = { [WIMLIB_ERR_STAT] = "Could not read the metadata for a file or directory", [WIMLIB_ERR_TIMEOUT] - = "Timed out", + = "Timed out while waiting for a message to arrive from another process", + [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE] + = "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", [WIMLIB_ERR_UNSUPPORTED] @@ -204,9 +368,10 @@ static const char *error_strings[] = { = "The XML data of the WIM is invalid", }; -WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code) +WIMLIBAPI const mbchar * +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]; @@ -219,7 +384,8 @@ void *(*wimlib_malloc_func) (size_t) = malloc; void (*wimlib_free_func) (void *) = free; void *(*wimlib_realloc_func)(void *, size_t) = realloc; -void *wimlib_calloc(size_t nmemb, size_t size) +void * +wimlib_calloc(size_t nmemb, size_t size) { size_t total_size = nmemb * size; void *p = MALLOC(total_size); @@ -228,7 +394,8 @@ void *wimlib_calloc(size_t nmemb, size_t size) return p; } -char *wimlib_strdup(const char *str) +char * +wimlib_strdup(const char *str) { size_t size; char *p; @@ -240,14 +407,16 @@ char *wimlib_strdup(const char *str) return p; } -extern void xml_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)); +extern void +xml_set_memory_allocator(void *(*malloc_func)(size_t), + void (*free_func)(void *), + void *(*realloc_func)(void *, size_t)); #endif -WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)) +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; @@ -265,131 +434,23 @@ WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), #endif } +static bool seeded = false; - -static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1); - -/* Converts a string in the UTF-16 encoding to a newly allocated string in the - * UTF-8 encoding. */ -char *utf16_to_utf8(const char *utf16_str, size_t utf16_len, - size_t *utf8_len_ret) -{ - if (cd_utf16_to_utf8 == (iconv_t)(-1)) { - cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE"); - if (cd_utf16_to_utf8 == (iconv_t)-1) { - ERROR_WITH_ERRNO("Failed to get conversion descriptor " - "for converting UTF-16LE to UTF-8"); - return NULL; - } - } - size_t utf16_bytes_left = utf16_len; - size_t utf8_bytes_left = utf16_len; - - char *utf8_str = MALLOC(utf8_bytes_left); - if (!utf8_str) - return NULL; - - char *orig_utf8_str = utf8_str; - - size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str, - &utf16_bytes_left, &utf8_str, &utf8_bytes_left); - - if (num_chars_converted == (size_t)(-1)) { - ERROR_WITH_ERRNO("Failed to convert UTF-16LE string to UTF-8 " - "string"); - FREE(orig_utf8_str); - return NULL; - } - - size_t utf8_len = utf16_len - utf8_bytes_left; - - *utf8_len_ret = utf8_len; - orig_utf8_str[utf8_len] = '\0'; - return orig_utf8_str; -} - -static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1); - -/* Converts a string in the UTF-8 encoding to a newly allocated string in the - * UTF-16 encoding. */ -char *utf8_to_utf16(const char *utf8_str, size_t utf8_len, - size_t *utf16_len_ret) -{ - if (cd_utf8_to_utf16 == (iconv_t)(-1)) { - cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8"); - if (cd_utf8_to_utf16 == (iconv_t)-1) { - ERROR_WITH_ERRNO("Failed to get conversion descriptor " - "for converting UTF-8 to UTF-16LE"); - return NULL; - } - } - - size_t utf8_bytes_left = utf8_len; - size_t utf16_capacity = utf8_len * 4; - size_t utf16_bytes_left = utf16_capacity; - - char *utf16_str = MALLOC(utf16_capacity + 2); - if (!utf16_str) - return NULL; - - char *orig_utf16_str = utf16_str; - - size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str, - &utf8_bytes_left, &utf16_str, &utf16_bytes_left); - - if (num_chars_converted == (size_t)(-1)) { - ERROR_WITH_ERRNO("Failed to convert UTF-8 string to UTF-16LE " - "string"); - FREE(orig_utf16_str); - return NULL; - } - - size_t utf16_len = utf16_capacity - utf16_bytes_left; - - *utf16_len_ret = utf16_len; - orig_utf16_str[utf16_len] = '\0'; - orig_utf16_str[utf16_len + 1] = '\0'; - return orig_utf16_str; -} - -/* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and - * on short writes. - * - * Returns short count and set errno on failure. */ -ssize_t full_write(int fd, const void *buf, size_t n) +static void +seed_random() { - const char *p = buf; - ssize_t ret; - ssize_t total = 0; - - while (total != n) { - ret = write(fd, p, n); - if (ret < 0) { - if (errno == EINTR) - continue; - else - break; - } - total += ret; - p += ret; - } - return total; + srand(time(NULL) * getpid()); + seeded = true; } - -static bool seeded = false; - /* Fills @n bytes pointed to by @p with random alphanumeric characters. */ -void randomize_char_array_with_alnum(char p[], size_t n) +void +randomize_char_array_with_alnum(char p[], size_t n) { - int r; - - if (!seeded) { - srand(time(NULL)); - seeded = true; - } + if (!seeded) + seed_random(); while (n--) { - r = rand() % 62; + int r = rand() % 62; if (r < 26) *p++ = r + 'a'; else if (r < 52) @@ -400,19 +461,19 @@ 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) { - srand(time(NULL)); - seeded = true; - } + if (!seeded) + seed_random(); while (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) +void +to_parent_name(char buf[], size_t len) { ssize_t i = (ssize_t)len - 1; while (i >= 0 && buf[i] == '/') @@ -426,7 +487,8 @@ void to_parent_name(char buf[], size_t len) /* 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 * +path_basename(const char *path) { const char *p = path; while (*p) @@ -452,7 +514,8 @@ const char *path_basename(const char *path) * 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 * +path_stream_name(const char *path) { const char *base = path_basename(path); const char *stream_name = strchr(base, ':'); @@ -473,7 +536,8 @@ const char *path_stream_name(const char *path) * 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) +const char * +path_next_part(const char *path, size_t *first_part_len_ret) { size_t i; const char *next_part; @@ -490,7 +554,8 @@ const char *path_next_part(const char *path, size_t *first_part_len_ret) } /* Returns the number of components of @path. */ -int get_num_path_components(const char *path) +int +get_num_path_components(const char *path) { int num_components = 0; while (*path) { @@ -509,7 +574,8 @@ int get_num_path_components(const char *path) * 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) +void +print_string(const void *string, size_t len) { const u8 *p = string; @@ -522,11 +588,19 @@ void print_string(const void *string, size_t len) } } -u64 get_wim_timestamp() +u64 +get_wim_timestamp() { struct timeval tv; gettimeofday(&tv, NULL); - return timeval_to_wim_timestamp(&tv); + return timeval_to_wim_timestamp(tv); } - +void +wim_timestamp_to_str(u64 timestamp, char *buf, size_t len) +{ + 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); +}