wimlib.net Git - wimlib/blob - src/util.c

   1 /*
   2  * util.c
   3  */
   4
   5 /*
   6  * Copyright (C) 2012, 2013 Eric Biggers
   7  *
   8  * This file is part of wimlib, a library for working with WIM files.
   9  *
  10  * wimlib is free software; you can redistribute it and/or modify it under the
  11  * terms of the GNU General Public License as published by the Free
  12  * Software Foundation; either version 3 of the License, or (at your option)
  13  * any later version.
  14  *
  15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  22  */
  23
  24 #include "config.h"
  25
  26 #undef _GNU_SOURCE
  27 /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
  28  * version, which has a different return type. */
  29 #define _POSIX_C_SOURCE 200112
  30 #include <string.h>
  31 #define _GNU_SOURCE
  32
  33 #include "wimlib_internal.h"
  34 #include "endianness.h"
  35 #include "timestamp.h"
  36
  37 #include <ctype.h>
  38 #include <errno.h>
  39 #include <stdlib.h>
  40 #include <stdarg.h>
  41
  42 #include <unistd.h> /* for getpid() */
  43
  44 #ifdef __WIN32__
  45 #include "win32.h"
  46 #endif
  47
  48 static size_t
  49 utf16le_strlen(const utf16lechar *s)
  50 {
  51         const utf16lechar *p = s;
  52         while (*p)
  53                 p++;
  54         return (p - s) * sizeof(utf16lechar);
  55 }
  56
  57 #ifdef __WIN32__
  58 #  define wimlib_vfprintf vfwprintf
  59 #else
  60 /* Handle %W for UTF16-LE printing.
  61  *
  62  * TODO: this is not yet done properly--- it's assumed that if the format string
  63  * contains %W, then it contains no other format specifiers.
  64  */
  65 static int
  66 wimlib_vfprintf(FILE *fp, const tchar *format, va_list va)
  67 {
  68         const tchar *p;
  69         int n;
  70
  71         for (p = format; *p; p++)
  72                 if (*p == T('%') && *(p + 1) == T('W'))
  73                         goto special;
  74         return tvfprintf(fp, format, va);
  75 special:
  76         n = 0;
  77         for (p = format; *p; p++) {
  78                 if (*p == T('%') && (*(p + 1) == T('W'))) {
  79                         int ret;
  80                         tchar *tstr;
  81                         size_t tstr_nbytes;
  82                         utf16lechar *ucs = va_arg(va, utf16lechar*);
  83
  84                         if (ucs) {
  85                                 size_t ucs_nbytes = utf16le_strlen(ucs);
  86
  87                                 ret = utf16le_to_tstr(ucs, ucs_nbytes,
  88                                                       &tstr, &tstr_nbytes);
  89                                 if (ret) {
  90                                         ret = tfprintf(fp, T("??????"));
  91                                 } else {
  92                                         ret = tfprintf(fp, T("%"TS), tstr);
  93                                         FREE(tstr);
  94                                 }
  95                                 if (ret < 0)
  96                                         return -1;
  97                                 else
  98                                         n += ret;
  99                         } else {
 100                                 n += tfprintf(fp, T("(null)"));
 101                         }
 102                         p++;
 103                 } else {
 104                         if (tputc(*p, fp) == EOF)
 105                                 return -1;
 106                         n++;
 107                 }
 108         }
 109         return n;
 110 }
 111
 112 int
 113 wimlib_printf(const tchar *format, ...)
 114 {
 115         int ret;
 116         va_list va;
 117
 118         va_start(va, format);
 119         ret = wimlib_vfprintf(stdout, format, va);
 120         va_end(va);
 121         return ret;
 122 }
 123
 124 int
 125 wimlib_fprintf(FILE *fp, const tchar *format, ...)
 126 {
 127         int ret;
 128         va_list va;
 129
 130         va_start(va, format);
 131         ret = wimlib_vfprintf(fp, format, va);
 132         va_end(va);
 133         return ret;
 134 }
 135 #endif
 136
 137 #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
 138 static void
 139 wimlib_vmsg(const tchar *tag, const tchar *format,
 140             va_list va, bool perror)
 141 {
 142 #ifndef DEBUG
 143         if (wimlib_print_errors) {
 144 #endif
 145                 int errno_save = errno;
 146                 fflush(stdout);
 147                 tfputs(tag, stderr);
 148                 wimlib_vfprintf(stderr, format, va);
 149                 if (perror && errno_save != 0) {
 150                         tchar buf[50];
 151                         int res;
 152                         res = tstrerror_r(errno_save, buf, sizeof(buf));
 153                         if (res) {
 154                                 tsprintf(buf,
 155                                          T("unknown error (errno=%d)"),
 156                                          errno_save);
 157                         }
 158                         tfprintf(stderr, T(": %"TS), buf);
 159                 }
 160                 tputc(T('\n'), stderr);
 161                 fflush(stderr);
 162                 errno = errno_save;
 163 #ifndef DEBUG
 164         }
 165 #endif
 166 }
 167 #endif
 168
 169 /* True if wimlib is to print an informational message when an error occurs.
 170  * This can be turned off by calling wimlib_set_print_errors(false). */
 171 #ifdef ENABLE_ERROR_MESSAGES
 172 static bool wimlib_print_errors = false;
 173
 174
 175 void
 176 wimlib_error(const tchar *format, ...)
 177 {
 178         va_list va;
 179
 180         va_start(va, format);
 181         wimlib_vmsg(T("\r[ERROR] "), format, va, false);
 182         va_end(va);
 183 }
 184
 185 void
 186 wimlib_error_with_errno(const tchar *format, ...)
 187 {
 188         va_list va;
 189
 190         va_start(va, format);
 191         wimlib_vmsg(T("\r[ERROR] "), format, va, true);
 192         va_end(va);
 193 }
 194
 195 void
 196 wimlib_warning(const tchar *format, ...)
 197 {
 198         va_list va;
 199
 200         va_start(va, format);
 201         wimlib_vmsg(T("\r[WARNING] "), format, va, false);
 202         va_end(va);
 203 }
 204
 205 void
 206 wimlib_warning_with_errno(const tchar *format, ...)
 207 {
 208         va_list va;
 209
 210         va_start(va, format);
 211         wimlib_vmsg(T("\r[WARNING] "), format, va, true);
 212         va_end(va);
 213 }
 214
 215 #endif
 216
 217 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
 218 void wimlib_debug(const tchar *file, int line, const char *func,
 219                   const tchar *format, ...)
 220 {
 221         va_list va;
 222         tchar buf[tstrlen(file) + strlen(func) + 30];
 223
 224         tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
 225
 226         va_start(va, format);
 227         wimlib_vmsg(buf, format, va, false);
 228         va_end(va);
 229 }
 230 #endif
 231
 232 WIMLIBAPI int
 233 wimlib_set_print_errors(bool show_error_messages)
 234 {
 235 #ifdef ENABLE_ERROR_MESSAGES
 236         wimlib_print_errors = show_error_messages;
 237         return 0;
 238 #else
 239         if (show_error_messages)
 240                 return WIMLIB_ERR_UNSUPPORTED;
 241         else
 242                 return 0;
 243 #endif
 244 }
 245
 246 static const tchar *error_strings[] = {
 247         [WIMLIB_ERR_SUCCESS]
 248                 = T("Success"),
 249         [WIMLIB_ERR_ALREADY_LOCKED]
 250                 = T("The WIM is already locked for writing"),
 251         [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
 252                 = T("Lookup table is compressed"),
 253         [WIMLIB_ERR_DECOMPRESSION]
 254                 = T("Failed to decompress compressed data"),
 255         [WIMLIB_ERR_DELETE_STAGING_DIR]
 256                 = T("Failed to delete staging directory"),
 257         [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
 258                 = T("The process servicing the mounted WIM has crashed"),
 259         [WIMLIB_ERR_FORK]
 260                 = T("Failed to fork another process"),
 261         [WIMLIB_ERR_FUSE]
 262                 = T("An error was returned by fuse_main()"),
 263         [WIMLIB_ERR_FUSERMOUNT]
 264                 = T("Could not execute the `fusermount' program, or it exited "
 265                         "with a failure status"),
 266         [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
 267                 = T("The iconv() function does not seem to work. "
 268                   "Maybe check to make sure the directory /usr/lib/gconv exists"),
 269         [WIMLIB_ERR_IMAGE_COUNT]
 270                 = T("Inconsistent image count among the metadata "
 271                         "resources, the WIM header, and/or the XML data"),
 272         [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT]
 273                 = T("User does not have sufficient privileges to correctly extract the data"),
 274         [WIMLIB_ERR_IMAGE_NAME_COLLISION]
 275                 = T("Tried to add an image with a name that is already in use"),
 276         [WIMLIB_ERR_INTEGRITY]
 277                 = T("The WIM failed an integrity check"),
 278         [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
 279                 = T("The capture configuration string was invalid"),
 280         [WIMLIB_ERR_INVALID_CHUNK_SIZE]
 281                 = T("The WIM is compressed but does not have a chunk "
 282                         "size of 32768"),
 283         [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
 284                 = T("The WIM is compressed, but is not marked as having LZX or "
 285                         "XPRESS compression"),
 286         [WIMLIB_ERR_INVALID_DENTRY]
 287                 = T("A directory entry in the WIM was invalid"),
 288         [WIMLIB_ERR_INVALID_HEADER_SIZE]
 289                 = T("The WIM header was not 208 bytes"),
 290         [WIMLIB_ERR_INVALID_IMAGE]
 291                 = T("Tried to select an image that does not exist in the WIM"),
 292         [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
 293                 = T("The WIM's integrity table is invalid"),
 294         [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
 295                 = T("An entry in the WIM's lookup table is invalid"),
 296         [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
 297                 = T("A string was not valid in the current locale's character encoding"),
 298         [WIMLIB_ERR_INVALID_OVERLAY]
 299                 = T("Conflicting files in overlay when creating a WIM image"),
 300         [WIMLIB_ERR_INVALID_PARAM]
 301                 = T("An invalid parameter was given"),
 302         [WIMLIB_ERR_INVALID_PART_NUMBER]
 303                 = T("The part number or total parts of the WIM is invalid"),
 304         [WIMLIB_ERR_INVALID_RESOURCE_HASH]
 305                 = T("The SHA1 message digest of a WIM resource did not match the expected value"),
 306         [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
 307                 = T("A resource entry in the WIM has an invalid size"),
 308         [WIMLIB_ERR_INVALID_SECURITY_DATA]
 309                 = T("The table of security descriptors in the WIM is invalid"),
 310         [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
 311                 = T("The version of wimlib that has mounted a WIM image is incompatible with the "
 312                   "version being used to unmount it"),
 313         [WIMLIB_ERR_INVALID_UTF8_STRING]
 314                 = T("A string provided as input by the user was not a valid UTF-8 string"),
 315         [WIMLIB_ERR_INVALID_UTF16_STRING]
 316                 = T("A string in a WIM dentry is not a valid UTF-16LE string"),
 317         [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
 318                 = T("libxml2 was unable to find a character encoding conversion handler "
 319                   "for UTF-16LE"),
 320         [WIMLIB_ERR_LINK]
 321                 = T("Failed to create a hard or symbolic link when extracting "
 322                         "a file from the WIM"),
 323         [WIMLIB_ERR_MKDIR]
 324                 = T("Failed to create a directory"),
 325         [WIMLIB_ERR_MQUEUE]
 326                 = T("Failed to create or use a POSIX message queue"),
 327         [WIMLIB_ERR_NOMEM]
 328                 = T("Ran out of memory"),
 329         [WIMLIB_ERR_NOTDIR]
 330                 = T("Expected a directory"),
 331         [WIMLIB_ERR_NOT_A_WIM_FILE]
 332                 = T("The file did not begin with the magic characters that "
 333                         "identify a WIM file"),
 334         [WIMLIB_ERR_NO_FILENAME]
 335                 = T("The WIM is not identified with a filename"),
 336         [WIMLIB_ERR_NTFS_3G]
 337                 = T("NTFS-3g encountered an error (check errno)"),
 338         [WIMLIB_ERR_OPEN]
 339                 = T("Failed to open a file"),
 340         [WIMLIB_ERR_OPENDIR]
 341                 = T("Failed to open a directory"),
 342         [WIMLIB_ERR_READ]
 343                 = T("Could not read data from a file"),
 344         [WIMLIB_ERR_READLINK]
 345                 = T("Could not read the target of a symbolic link"),
 346         [WIMLIB_ERR_RENAME]
 347                 = T("Could not rename a file"),
 348         [WIMLIB_ERR_REOPEN]
 349                 = T("Could not re-open the WIM after overwriting it"),
 350         [WIMLIB_ERR_RESOURCE_ORDER]
 351                 = T("The components of the WIM were arranged in an unexpected order"),
 352         [WIMLIB_ERR_SPECIAL_FILE]
 353                 = T("Encountered a special file that cannot be archived"),
 354         [WIMLIB_ERR_SPLIT_INVALID]
 355                 = T("The WIM is part of an invalid split WIM"),
 356         [WIMLIB_ERR_SPLIT_UNSUPPORTED]
 357                 = T("The WIM is part of a split WIM, which is not supported for this operation"),
 358         [WIMLIB_ERR_STAT]
 359                 = T("Could not read the metadata for a file or directory"),
 360         [WIMLIB_ERR_TIMEOUT]
 361                 = T("Timed out while waiting for a message to arrive from another process"),
 362         [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
 363                 = T("A Unicode string could not be represented in the current locale's encoding"),
 364         [WIMLIB_ERR_UNKNOWN_VERSION]
 365                 = T("The WIM file is marked with an unknown version number"),
 366         [WIMLIB_ERR_UNSUPPORTED]
 367                 = T("The requested operation is unsupported"),
 368         [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
 369                 = T("The volume did not support a feature necessary to complete the operation"),
 370         [WIMLIB_ERR_WRITE]
 371                 = T("Failed to write data to a file"),
 372         [WIMLIB_ERR_XML]
 373                 = T("The XML data of the WIM is invalid"),
 374 };
 375
 376 WIMLIBAPI const tchar *
 377 wimlib_get_error_string(enum wimlib_error_code code)
 378 {
 379         if (code < 0 || code >= ARRAY_LEN(error_strings))
 380                 return NULL;
 381         else
 382                 return error_strings[code];
 383 }
 384
 385
 386
 387 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 388 void *(*wimlib_malloc_func) (size_t)         = malloc;
 389 void  (*wimlib_free_func)   (void *)         = free;
 390 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
 391
 392 void *
 393 wimlib_calloc(size_t nmemb, size_t size)
 394 {
 395         size_t total_size = nmemb * size;
 396         void *p = MALLOC(total_size);
 397         if (p)
 398                 memset(p, 0, total_size);
 399         return p;
 400 }
 401
 402 char *
 403 wimlib_strdup(const char *str)
 404 {
 405         size_t size;
 406         char *p;
 407
 408         size = strlen(str);
 409         p = MALLOC(size + 1);
 410         if (p)
 411                 memcpy(p, str, size + 1);
 412         return p;
 413 }
 414
 415 #ifdef __WIN32__
 416 wchar_t *
 417 wimlib_wcsdup(const wchar_t *str)
 418 {
 419         size_t size;
 420         wchar_t *p;
 421
 422         size = wcslen(str);
 423         p = MALLOC((size + 1) * sizeof(wchar_t));
 424         if (p)
 425                 memcpy(p, str, (size + 1) * sizeof(wchar_t));
 426         return p;
 427 }
 428 #endif
 429
 430 extern void
 431 xml_set_memory_allocator(void *(*malloc_func)(size_t),
 432                          void (*free_func)(void *),
 433                          void *(*realloc_func)(void *, size_t));
 434 #endif
 435
 436 WIMLIBAPI int
 437 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
 438                             void (*free_func)(void *),
 439                             void *(*realloc_func)(void *, size_t))
 440 {
 441 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 442         wimlib_malloc_func  = malloc_func  ? malloc_func  : malloc;
 443         wimlib_free_func    = free_func    ? free_func    : free;
 444         wimlib_realloc_func = realloc_func ? realloc_func : realloc;
 445
 446         xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
 447                                  wimlib_realloc_func);
 448         return 0;
 449 #else
 450         ERROR("Cannot set custom memory allocator functions:");
 451         ERROR("wimlib was compiled with the --without-custom-memory-allocator "
 452               "flag");
 453         return WIMLIB_ERR_UNSUPPORTED;
 454 #endif
 455 }
 456
 457 static bool seeded = false;
 458
 459 static void
 460 seed_random()
 461 {
 462         srand(time(NULL) * getpid());
 463         seeded = true;
 464 }
 465
 466 /* Fills @n characters pointed to by @p with random alphanumeric characters. */
 467 void
 468 randomize_char_array_with_alnum(tchar p[], size_t n)
 469 {
 470         if (!seeded)
 471                 seed_random();
 472         while (n--) {
 473                 int r = rand() % 62;
 474                 if (r < 26)
 475                         *p++ = r + 'a';
 476                 else if (r < 52)
 477                         *p++ = r - 26 + 'A';
 478                 else
 479                         *p++ = r - 52 + '0';
 480         }
 481 }
 482
 483 /* Fills @n bytes pointer to by @p with random numbers. */
 484 void
 485 randomize_byte_array(u8 *p, size_t n)
 486 {
 487         if (!seeded)
 488                 seed_random();
 489         while (n--)
 490                 *p++ = rand();
 491 }
 492
 493 const tchar *
 494 path_basename_with_len(const tchar *path, size_t len)
 495 {
 496         const tchar *p = &path[len] - 1;
 497
 498         /* Trailing slashes. */
 499         while (1) {
 500                 if (p == path - 1)
 501                         return T("");
 502                 if (*p != T('/'))
 503                         break;
 504                 p--;
 505         }
 506
 507         while ((p != path - 1) && *p != T('/'))
 508                 p--;
 509
 510         return p + 1;
 511 }
 512
 513 /* Like the basename() function, but does not modify @path; it just returns a
 514  * pointer to it. */
 515 const tchar *
 516 path_basename(const tchar *path)
 517 {
 518         return path_basename_with_len(path, tstrlen(path));
 519 }
 520
 521 /*
 522  * Returns a pointer to the part of @path following the first colon in the last
 523  * path component, or NULL if the last path component does not contain a colon.
 524  */
 525 const tchar *
 526 path_stream_name(const tchar *path)
 527 {
 528         const tchar *base = path_basename(path);
 529         const tchar *stream_name = tstrchr(base, T(':'));
 530         if (!stream_name)
 531                 return NULL;
 532         else
 533                 return stream_name + 1;
 534 }
 535
 536 u64
 537 get_wim_timestamp()
 538 {
 539         struct timeval tv;
 540         gettimeofday(&tv, NULL);
 541         return timeval_to_wim_timestamp(tv);
 542 }
 543
 544 void
 545 wim_timestamp_to_str(u64 timestamp, tchar *buf, size_t len)
 546 {
 547         struct tm tm;
 548         time_t t = wim_timestamp_to_unix(timestamp);
 549         gmtime_r(&t, &tm);
 550         tstrftime(buf, len, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
 551 }
 552
 553 void
 554 zap_backslashes(tchar *s)
 555 {
 556         if (s) {
 557                 while (*s != T('\0')) {
 558                         if (*s == T('\\'))
 559                                 *s = T('/');
 560                         s++;
 561                 }
 562         }
 563 }