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

   1 /*
   2  * util.c
   3  *
   4  * Copyright (C) 2010 Carl Thijssen
   5  * Copyright (C) 2012 Eric Biggers
   6  *
   7  * wimlib - Library for working with WIM files
   8  *
   9  * This library is free software; you can redistribute it and/or modify it under
  10  * the terms of the GNU Lesser General Public License as published by the Free
  11  * Software Foundation; either version 2.1 of the License, or (at your option) any
  12  * later version.
  13  *
  14  * This library is distributed in the hope that it will be useful, but WITHOUT ANY
  15  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  16  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License along
  19  * with this library; if not, write to the Free Software Foundation, Inc., 59
  20  * Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21  */
  22
  23 #include "wimlib_internal.h"
  24 #include "endianness.h"
  25 #include "sha1.h"
  26
  27
  28 #include <iconv.h>
  29 #include <string.h>
  30 #include <ctype.h>
  31 #include <stdlib.h>
  32 #include <time.h>
  33 #include <unistd.h>
  34 #include <errno.h>
  35
  36 /* True if WIMLIB is to print an informational message when an error occurs.
  37  * This can be turned off by calling wimlib_set_error_messages(false). */
  38 #ifdef ENABLE_ERROR_MESSAGES
  39 #include <stdarg.h>
  40 bool __wimlib_print_errors = false;
  41
  42 void wimlib_error(const char *format, ...)
  43 {
  44         if (__wimlib_print_errors) {
  45                 va_list va;
  46                 int errno_save;
  47
  48                 va_start(va, format);
  49                 errno_save = errno;
  50                 fputs("ERROR: ", stderr);
  51                 vfprintf(stderr, format, va);
  52                 errno = errno_save;
  53                 va_end(va);
  54         }
  55 }
  56
  57 void wimlib_warning(const char *format, ...)
  58 {
  59         if (__wimlib_print_errors) {
  60                 va_list va;
  61                 int errno_save;
  62
  63                 va_start(va, format);
  64                 errno_save = errno;
  65                 fputs("WARNING: ", stderr);
  66                 vfprintf(stderr, format, va);
  67                 errno = errno_save;
  68                 va_end(va);
  69         }
  70 }
  71
  72 #endif
  73
  74 WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
  75 {
  76 #ifdef ENABLE_ERROR_MESSAGES
  77         __wimlib_print_errors = show_error_messages;
  78         return 0;
  79 #else
  80         if (show_error_messages)
  81                 return WIMLIB_ERR_UNSUPPORTED;
  82 #endif
  83 }
  84
  85 static const char *error_strings[] = {
  86         [WIMLIB_ERR_SUCCESS]
  87                 = "Success",
  88         [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
  89                 = "Lookup table is compressed",
  90         [WIMLIB_ERR_DECOMPRESSION]
  91                 = "Failed to decompress compressed data",
  92         [WIMLIB_ERR_DELETE_STAGING_DIR]
  93                 = "Failed to delete staging directory",
  94         [WIMLIB_ERR_FORK]
  95                 = "Failed to fork another process",
  96         [WIMLIB_ERR_FUSE]
  97                 = "An error was returned by fuse_main()",
  98         [WIMLIB_ERR_FUSERMOUNT]
  99                 = "Could not execute the `fusermount' program, or it exited "
 100                         "with a failure status",
 101         [WIMLIB_ERR_IMAGE_COUNT]
 102                 = "Inconsistent image count among the metadata "
 103                         "resources, the WIM header, and/or the XML data",
 104         [WIMLIB_ERR_IMAGE_NAME_COLLISION]
 105                 = "Tried to add an image with a name that is already in use",
 106         [WIMLIB_ERR_INTEGRITY]
 107                 = "The WIM failed an integrity check",
 108         [WIMLIB_ERR_INVALID_CHUNK_SIZE]
 109                 = "The WIM is compressed but does not have a chunk "
 110                         "size of 32768",
 111         [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
 112                 = "The WIM is compressed, but is not marked as having LZX or "
 113                         "XPRESS compression",
 114         [WIMLIB_ERR_INVALID_DENTRY]
 115                 = "A directory entry in the WIM was invalid",
 116         [WIMLIB_ERR_INVALID_HEADER_SIZE]
 117                 = "The WIM header was not 208 bytes",
 118         [WIMLIB_ERR_INVALID_IMAGE]
 119                 = "Tried to select an image that does not exist in the WIM",
 120         [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
 121                 = "The WIM's integrity table is invalid",
 122         [WIMLIB_ERR_INVALID_PARAM]
 123                 = "An invalid parameter was given",
 124         [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
 125                 = "A resource entry in the WIM is invalid",
 126         [WIMLIB_ERR_LINK]
 127                 = "Failed to create a hard or symbolic link when extracting "
 128                         "a file from the WIM",
 129         [WIMLIB_ERR_MKDIR]
 130                 = "Failed to create a directory",
 131         [WIMLIB_ERR_MQUEUE]
 132                 = "Failed to create or use a POSIX message queue",
 133         [WIMLIB_ERR_NOMEM]
 134                 = "Ran out of memory",
 135         [WIMLIB_ERR_NOTDIR]
 136                 = "Expected a directory",
 137         [WIMLIB_ERR_NOT_A_WIM_FILE]
 138                 = "The file did not begin with the magic characters that "
 139                         "identify a WIM file",
 140         [WIMLIB_ERR_NO_FILENAME]
 141                 = "The WIM is not identified with a filename",
 142         [WIMLIB_ERR_OPEN]
 143                 = "Failed to open a file",
 144         [WIMLIB_ERR_OPENDIR]
 145                 = "Failed to open a directory",
 146         [WIMLIB_ERR_READ]
 147                 = "Could not read data from a file",
 148         [WIMLIB_ERR_RENAME]
 149                 = "Could not rename a file",
 150         [WIMLIB_ERR_SPLIT]
 151                 = "The WIM is part of a split WIM, which Wimlib does not support",
 152         [WIMLIB_ERR_STAT]
 153                 = "Could not read the metadata for a file or directory",
 154         [WIMLIB_ERR_TIMEOUT]
 155                 = "Timed out",
 156         [WIMLIB_ERR_UNKNOWN_VERSION]
 157                 = "The WIM file is marked with an unknown version number",
 158         [WIMLIB_ERR_UNSUPPORTED]
 159                 = "The requested operation is unsupported",
 160         [WIMLIB_ERR_WRITE]
 161                 = "Failed to write data to a file",
 162         [WIMLIB_ERR_XML]
 163                 = "The XML data of the WIM is invalid",
 164 };
 165
 166 WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code)
 167 {
 168         if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML)
 169                 return NULL;
 170         else
 171                 return error_strings[code];
 172 }
 173
 174
 175
 176 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 177 void *(*wimlib_malloc_func)(size_t) = malloc;
 178 void (*wimlib_free_func)(void *) = free;
 179 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
 180
 181 void *wimlib_calloc(size_t nmemb, size_t size)
 182 {
 183         size_t total_size = nmemb * size;
 184         void *p = MALLOC(total_size);
 185         if (p)
 186                 memset(p, 0, total_size);
 187         return p;
 188 }
 189
 190 char *wimlib_strdup(const char *str)
 191 {
 192         size_t size;
 193         char *p;
 194
 195         size = strlen(str);
 196         p = MALLOC(size + 1);
 197         if (p)
 198                 memcpy(p, str, size + 1);
 199         return p;
 200 }
 201
 202 extern void xml_set_memory_allocator(void *(*malloc_func)(size_t),
 203                                    void (*free_func)(void *),
 204                                    void *(*realloc_func)(void *, size_t));
 205 #endif
 206
 207 WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
 208                                            void (*free_func)(void *),
 209                                            void *(*realloc_func)(void *, size_t))
 210 {
 211 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 212         wimlib_malloc_func  = malloc_func  ? malloc_func  : malloc;
 213         wimlib_free_func    = free_func    ? free_func    : free;
 214         wimlib_realloc_func = realloc_func ? realloc_func : realloc;
 215
 216         xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
 217                                  wimlib_realloc_func);
 218 #else
 219         ERROR("Cannot set custom memory allocator functions:\n");
 220         ERROR("wimlib was compiled with the "
 221                         "--without-custom-memory-allocator flag\n");
 222         return WIMLIB_ERR_UNSUPPORTED;
 223 #endif
 224 }
 225
 226
 227
 228 static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1);
 229
 230 /* Converts a string in the UTF-16 encoding to a newly allocated string in the
 231  * UTF-8 encoding.  */
 232 char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
 233                                 size_t *utf8_len_ret)
 234 {
 235         if (cd_utf16_to_utf8 == (iconv_t)(-1)) {
 236                 cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE");
 237                 if (cd_utf16_to_utf8 == (iconv_t)-1) {
 238                         ERROR("Failed to get conversion descriptor for "
 239                                         "converting UTF-16LE to UTF-8: %m\n");
 240                         return NULL;
 241                 }
 242         }
 243         size_t utf16_bytes_left  = utf16_len;
 244         size_t utf8_bytes_left   = utf16_len;
 245
 246         char *utf8_str = MALLOC(utf8_bytes_left);
 247         if (!utf8_str)
 248                 return NULL;
 249
 250         char *orig_utf8_str = utf8_str;
 251
 252         size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str,
 253                         &utf16_bytes_left, &utf8_str, &utf8_bytes_left);
 254
 255         if (num_chars_converted == (size_t)(-1)) {
 256                 ERROR("Failed to convert UTF-16LE string to UTF-8 string: "
 257                                 "%m\n");
 258                 FREE(orig_utf8_str);
 259                 return NULL;
 260         }
 261
 262         size_t utf8_len = utf16_len - utf8_bytes_left;
 263
 264         *utf8_len_ret = utf8_len;
 265         orig_utf8_str[utf8_len] = '\0';
 266         return orig_utf8_str;
 267 }
 268
 269 static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1);
 270
 271 /* Converts a string in the UTF-8 encoding to a newly allocated string in the
 272  * UTF-16 encoding.  */
 273 char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
 274                                                 size_t *utf16_len_ret)
 275 {
 276         if (cd_utf8_to_utf16 == (iconv_t)(-1)) {
 277                 cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8");
 278                 if (cd_utf8_to_utf16 == (iconv_t)-1) {
 279                         ERROR("Failed to get conversion descriptor for "
 280                                         "converting UTF-8 to UTF-16LE: %m\n");
 281                         return NULL;
 282                 }
 283         }
 284
 285         size_t utf8_bytes_left   = utf8_len;
 286         size_t utf16_capacity    = utf8_len * 4;
 287         size_t utf16_bytes_left  = utf16_capacity;
 288
 289         char *utf16_str = MALLOC(utf16_capacity + 2);
 290         if (!utf16_str)
 291                 return NULL;
 292
 293         char *orig_utf16_str = utf16_str;
 294
 295         size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str,
 296                         &utf8_bytes_left, &utf16_str, &utf16_bytes_left);
 297
 298         if (num_chars_converted == (size_t)(-1)) {
 299                 ERROR("Failed to convert UTF-8 string to UTF-16LE string: "
 300                                 "%s\n",
 301                                 (errno == E2BIG) ?
 302                                         "Not enough room in output buffer" :
 303                                         strerror(errno));
 304                 FREE(orig_utf16_str);
 305                 return NULL;
 306         }
 307
 308         size_t utf16_len = utf16_capacity - utf16_bytes_left;
 309
 310         *utf16_len_ret = utf16_len;
 311         orig_utf16_str[utf16_len] = '\0';
 312         orig_utf16_str[utf16_len + 1] = '\0';
 313         return orig_utf16_str;
 314 }
 315
 316 /* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and
 317  * on short writes.
 318  *
 319  * Returns short count and set errno on failure. */
 320 ssize_t full_write(int fd, const void *buf, size_t n)
 321 {
 322         const char *p = buf;
 323         ssize_t ret;
 324         ssize_t total = 0;
 325
 326         while (total != n) {
 327                 ret = write(fd, p, n);
 328                 if (ret < 0) {
 329                         if (errno == EINTR)
 330                                 continue;
 331                         else
 332                                 break;
 333                 }
 334                 total += ret;
 335                 p += ret;
 336         }
 337         return total;
 338 }
 339
 340
 341 static bool seeded = false;
 342
 343 /* Fills @n bytes pointed to by @p with random alphanumeric characters. */
 344 void randomize_char_array_with_alnum(char p[], size_t n)
 345 {
 346         int r;
 347
 348         if (!seeded) {
 349                 srand(time(NULL));
 350                 seeded = true;
 351         }
 352         while (n--) {
 353                 r = rand() % 62;
 354                 if (r < 26)
 355                         *p++ = r + 'a';
 356                 else if (r < 52)
 357                         *p++ = r - 26 + 'A';
 358                 else
 359                         *p++ = r - 52 + '0';
 360         }
 361 }
 362
 363 /* Fills @n bytes pointer to by @p with random numbers. */
 364 void randomize_byte_array(void *__p, size_t n)
 365 {
 366         u8 *p = __p;
 367
 368         if (!seeded) {
 369                 srand(time(NULL));
 370                 seeded = true;
 371         }
 372         while (n--)
 373                 *p++ = rand();
 374 }
 375
 376 /* Takes in a path of length @len in @buf, and transforms it into a string for
 377  * the path of its parent directory. */
 378 void to_parent_name(char buf[], size_t len)
 379 {
 380         ssize_t i = (ssize_t)len - 1;
 381         while (i >= 0 && buf[i] == '/')
 382                 i--;
 383         while (i >= 0 && buf[i] != '/')
 384                 i--;
 385         while (i >= 0 && buf[i] == '/')
 386                 i--;
 387         buf[i + 1] = '\0';
 388 }
 389
 390 /* Like the basename() function, but does not modify @path; it just returns a
 391  * pointer to it. */
 392 const char *path_basename(const char *path)
 393 {
 394         const char *p = path;
 395         while (*p)
 396                 p++;
 397         p--;
 398
 399         /* Trailing slashes. */
 400         while ((p != path - 1) && *p == '/')
 401                 p--;
 402
 403         while ((p != path - 1) && *p != '/')
 404                 p--;
 405
 406         return p + 1;
 407 }
 408
 409 /*
 410  * Splits a file path into the part before the first '/', or the entire name if
 411  * there is no '/', and the part after the first sequence of '/' characters.
 412  *
 413  * @path:               The file path to split.
 414  * @first_part_len_ret: A pointer to a `size_t' into which the length of the
 415  *                              first part of the path will be returned.
 416  * @return:             A pointer to the next part of the path, after the first
 417  *                              sequence of '/', or a pointer to the terminating
 418  *                              null byte in the case of a path without any '/'.
 419  */
 420 const char *path_next_part(const char *path, size_t *first_part_len_ret)
 421 {
 422         size_t i;
 423         const char *next_part;
 424
 425         i = 0;
 426         while (path[i] != '/' && path[i] != '\0')
 427                 i++;
 428         if (first_part_len_ret)
 429                 *first_part_len_ret = i;
 430         next_part = &path[i];
 431         while (*next_part == '/')
 432                 next_part++;
 433         return next_part;
 434 }
 435
 436 /* Returns the number of components of @path.  */
 437 int get_num_path_components(const char *path)
 438 {
 439         int num_components = 0;
 440         while (*path) {
 441                 while (*path == '/')
 442                         path++;
 443                 if (*path)
 444                         num_components++;
 445                 while (*path && *path != '/')
 446                         path++;
 447         }
 448         return num_components;
 449 }
 450
 451
 452 /*
 453  * Prints a string.  Printable characters are printed as-is, while unprintable
 454  * characters are printed as their octal escape codes.
 455  */
 456 void print_string(const void *string, size_t len)
 457 {
 458         const u8 *p = string;
 459
 460         while (len--) {
 461                 if (isprint(*p))
 462                         putchar(*p);
 463                 else
 464                         printf("\\%03hho", *p);
 465                 p++;
 466         }
 467 }
 468
 469 /* Calculates the SHA1 message digest given the name of a file.
 470  * @buf must point to a buffer of length 20 bytes into which the message digest
 471  * is written.
 472  */
 473 int sha1sum(const char *filename, void *buf)
 474 {
 475         FILE *fp;
 476         int ret;
 477
 478         fp = fopen(filename, "rb");
 479         if (!fp) {
 480                 ERROR("Cannot open the file `%s' for reading: %m\n", filename);
 481                 return WIMLIB_ERR_OPEN;
 482         }
 483         ret = sha1_stream(fp, buf);
 484         fclose(fp);
 485         return ret;
 486 }