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