]> wimlib.net Git - wimlib/blobdiff - src/util.c
Honor WIM_HDR_FLAG_READONLY
[wimlib] / src / util.c
index 1e26a6f4349b74dd40c3570e99f707b729629b76..87dd3c50f8585d92bb984040185d36d7f7353348 100644 (file)
  * 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 <string.h>
-#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 <ctype.h>
 #include <errno.h>
-#include <stdlib.h>
 #include <stdarg.h>
+#include <stdlib.h>
+#include <time.h>
+#include <unistd.h>
 
-#include <unistd.h> /* 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,6 +142,12 @@ wimlib_fprintf(FILE *fp, const tchar *format, ...)
        return ret;
 }
 
+#endif /* __WIN32__ */
+
+#ifdef ENABLE_ERROR_MESSAGES
+static bool wimlib_print_errors = false;
+#endif
+
 #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
 static void
 wimlib_vmsg(const tchar *tag, const tchar *format,
@@ -158,6 +172,7 @@ wimlib_vmsg(const tchar *tag, const tchar *format,
                        tfprintf(stderr, T(": %"TS), buf);
                }
                tputc(T('\n'), stderr);
+               fflush(stderr);
                errno = errno_save;
 #ifndef DEBUG
        }
@@ -168,16 +183,13 @@ wimlib_vmsg(const tchar *tag, const tchar *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
-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 +199,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 +209,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 +219,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 +229,10 @@ 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);
+       tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
 
        va_start(va, format);
        wimlib_vmsg(buf, format, va, false);
@@ -269,6 +280,8 @@ static const tchar *error_strings[] = {
        [WIMLIB_ERR_IMAGE_COUNT]
                = 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]
                = T("Tried to add an image with a name that is already in use"),
        [WIMLIB_ERR_INTEGRITY]
@@ -299,6 +312,8 @@ 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_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]
@@ -312,6 +327,8 @@ 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_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
                = T("libxml2 was unable to find a character encoding conversion handler "
                  "for UTF-16LE"),
@@ -326,9 +343,14 @@ 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_NTFS_3G]
@@ -337,14 +359,16 @@ static const tchar *error_strings[] = {
                = 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_ORDER]
                = T("The components of the WIM were arranged in an unexpected order"),
        [WIMLIB_ERR_SPECIAL_FILE]
@@ -363,6 +387,10 @@ static const tchar *error_strings[] = {
                = T("The WIM file is marked with an unknown version number"),
        [WIMLIB_ERR_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_MARKED_READONLY]
+               = T("The WIM is marked as read-only"),
        [WIMLIB_ERR_WRITE]
                = T("Failed to write data to a file"),
        [WIMLIB_ERR_XML]
@@ -381,9 +409,33 @@ 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_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)
@@ -391,7 +443,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 +456,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,16 +470,21 @@ 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
+#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),
@@ -453,7 +510,7 @@ wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
 static bool seeded = false;
 
 static void
-seed_random()
+seed_random(void)
 {
        srand(time(NULL) * getpid());
        seeded = true;
@@ -486,140 +543,9 @@ 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');
-}
-
-const tchar *
-path_basename_with_len(const tchar *path, size_t len)
-{
-       const tchar *p = &path[len] - 1;
-
-       /* 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;
-}
-
-/* Like the basename() function, but does not modify @path; it just returns a
- * pointer to it. */
-const tchar *
-path_basename(const tchar *path)
-{
-       return path_basename_with_len(path, tstrlen(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 tchar *
-path_stream_name(const tchar *path)
-{
-       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)
+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);
-       tstrftime(buf, len, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
+       while (len--)
+               tfprintf(out, T("%02hhx"), *field++);
 }