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