6 * Copyright (C) 2012 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
24 #include "wimlib_internal.h"
25 #include "endianness.h"
27 #include "timestamp.h"
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
43 bool __wimlib_print_errors = false;
45 void wimlib_error(const char *format, ...)
47 if (__wimlib_print_errors) {
53 fputs("[ERROR] ", stderr);
54 vfprintf(stderr, format, va);
61 void wimlib_error_with_errno(const char *format, ...)
63 if (__wimlib_print_errors) {
70 fputs("[ERROR] ", stderr);
71 vfprintf(stderr, format, va);
72 fprintf(stderr, ": %s\n", strerror(errno_save));
78 void wimlib_warning(const char *format, ...)
80 if (__wimlib_print_errors) {
87 fputs("[WARNING] ", stderr);
88 vfprintf(stderr, format, va);
97 WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
99 #ifdef ENABLE_ERROR_MESSAGES
100 __wimlib_print_errors = show_error_messages;
103 if (show_error_messages)
104 return WIMLIB_ERR_UNSUPPORTED;
110 static const char *error_strings[] = {
113 [WIMLIB_ERR_ALREADY_LOCKED]
114 = "The WIM is already locked for writing",
115 [WIMLIB_ERR_CHAR_CONVERSION]
116 = "Failed to perform a conversion between UTF-8 and UTF-16LE",
117 [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
118 = "Lookup table is compressed",
119 [WIMLIB_ERR_DECOMPRESSION]
120 = "Failed to decompress compressed data",
121 [WIMLIB_ERR_DELETE_STAGING_DIR]
122 = "Failed to delete staging directory",
123 [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
124 = "The process servicing the mounted WIM has crashed",
126 = "Failed to fork another process",
128 = "An error was returned by fuse_main()",
129 [WIMLIB_ERR_FUSERMOUNT]
130 = "Could not execute the `fusermount' program, or it exited "
131 "with a failure status",
132 [WIMLIB_ERR_IMAGE_COUNT]
133 = "Inconsistent image count among the metadata "
134 "resources, the WIM header, and/or the XML data",
135 [WIMLIB_ERR_IMAGE_NAME_COLLISION]
136 = "Tried to add an image with a name that is already in use",
137 [WIMLIB_ERR_INTEGRITY]
138 = "The WIM failed an integrity check",
139 [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
140 = "The capture configuration string was invalid",
141 [WIMLIB_ERR_INVALID_CHUNK_SIZE]
142 = "The WIM is compressed but does not have a chunk "
144 [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
145 = "The WIM is compressed, but is not marked as having LZX or "
146 "XPRESS compression",
147 [WIMLIB_ERR_INVALID_DENTRY]
148 = "A directory entry in the WIM was invalid",
149 [WIMLIB_ERR_INVALID_HEADER_SIZE]
150 = "The WIM header was not 208 bytes",
151 [WIMLIB_ERR_INVALID_IMAGE]
152 = "Tried to select an image that does not exist in the WIM",
153 [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
154 = "The WIM's integrity table is invalid",
155 [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
156 = "An entry in the WIM's lookup table is invalid",
157 [WIMLIB_ERR_INVALID_PARAM]
158 = "An invalid parameter was given",
159 [WIMLIB_ERR_INVALID_PART_NUMBER]
160 = "The part number or total parts of the WIM is invalid",
161 [WIMLIB_ERR_INVALID_RESOURCE_HASH]
162 = "The SHA1 message digest of a WIM resource did not match the expected value",
163 [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
164 = "A resource entry in the WIM has an invalid size",
165 [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
166 = "The version of wimlib that has mounted a WIM image is incompatible with the "
167 "version being used to unmount it",
169 = "Failed to create a hard or symbolic link when extracting "
170 "a file from the WIM",
172 = "Failed to create a directory",
174 = "Failed to create or use a POSIX message queue",
176 = "Ran out of memory",
178 = "Expected a directory",
179 [WIMLIB_ERR_NOT_A_WIM_FILE]
180 = "The file did not begin with the magic characters that "
181 "identify a WIM file",
182 [WIMLIB_ERR_NO_FILENAME]
183 = "The WIM is not identified with a filename",
185 = "NTFS-3g encountered an error (check errno)",
187 = "Failed to open a file",
189 = "Failed to open a directory",
191 = "Could not read data from a file",
192 [WIMLIB_ERR_READLINK]
193 = "Could not read the target of a symbolic link",
195 = "Could not rename a file",
197 = "Could not re-open the WIM after overwriting it",
198 [WIMLIB_ERR_RESOURCE_ORDER]
199 = "The components of the WIM were arranged in an unexpected order",
200 [WIMLIB_ERR_SPECIAL_FILE]
201 = "Encountered a special file that cannot be archived",
202 [WIMLIB_ERR_SPLIT_INVALID]
203 = "The WIM is part of an invalid split WIM",
204 [WIMLIB_ERR_SPLIT_UNSUPPORTED]
205 = "The WIM is part of a split WIM, which is not supported for this operation",
207 = "Could not read the metadata for a file or directory",
208 [WIMLIB_ERR_UNKNOWN_VERSION]
209 = "The WIM file is marked with an unknown version number",
210 [WIMLIB_ERR_UNSUPPORTED]
211 = "The requested operation is unsupported",
213 = "Failed to write data to a file",
215 = "The XML data of the WIM is invalid",
218 WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code)
220 if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML)
223 return error_strings[code];
228 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
229 void *(*wimlib_malloc_func) (size_t) = malloc;
230 void (*wimlib_free_func) (void *) = free;
231 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
233 void *wimlib_calloc(size_t nmemb, size_t size)
235 size_t total_size = nmemb * size;
236 void *p = MALLOC(total_size);
238 memset(p, 0, total_size);
242 char *wimlib_strdup(const char *str)
248 p = MALLOC(size + 1);
250 memcpy(p, str, size + 1);
254 extern void xml_set_memory_allocator(void *(*malloc_func)(size_t),
255 void (*free_func)(void *),
256 void *(*realloc_func)(void *, size_t));
259 WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
260 void (*free_func)(void *),
261 void *(*realloc_func)(void *, size_t))
263 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
264 wimlib_malloc_func = malloc_func ? malloc_func : malloc;
265 wimlib_free_func = free_func ? free_func : free;
266 wimlib_realloc_func = realloc_func ? realloc_func : realloc;
268 xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
269 wimlib_realloc_func);
272 ERROR("Cannot set custom memory allocator functions:");
273 ERROR("wimlib was compiled with the --without-custom-memory-allocator "
275 return WIMLIB_ERR_UNSUPPORTED;
281 static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1);
283 /* Converts a string in the UTF-16 encoding to a newly allocated string in the
285 char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
286 size_t *utf8_len_ret)
288 if (cd_utf16_to_utf8 == (iconv_t)(-1)) {
289 cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE");
290 if (cd_utf16_to_utf8 == (iconv_t)-1) {
291 ERROR_WITH_ERRNO("Failed to get conversion descriptor "
292 "for converting UTF-16LE to UTF-8");
296 size_t utf16_bytes_left = utf16_len;
297 size_t utf8_bytes_left = utf16_len;
299 char *utf8_str = MALLOC(utf8_bytes_left);
303 char *orig_utf8_str = utf8_str;
305 size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str,
306 &utf16_bytes_left, &utf8_str, &utf8_bytes_left);
308 if (num_chars_converted == (size_t)(-1)) {
309 ERROR_WITH_ERRNO("Failed to convert UTF-16LE string to UTF-8 "
315 size_t utf8_len = utf16_len - utf8_bytes_left;
317 *utf8_len_ret = utf8_len;
318 orig_utf8_str[utf8_len] = '\0';
319 return orig_utf8_str;
322 static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1);
324 /* Converts a string in the UTF-8 encoding to a newly allocated string in the
325 * UTF-16 encoding. */
326 char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
327 size_t *utf16_len_ret)
329 if (cd_utf8_to_utf16 == (iconv_t)(-1)) {
330 cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8");
331 if (cd_utf8_to_utf16 == (iconv_t)-1) {
332 ERROR_WITH_ERRNO("Failed to get conversion descriptor "
333 "for converting UTF-8 to UTF-16LE");
338 size_t utf8_bytes_left = utf8_len;
339 size_t utf16_capacity = utf8_len * 4;
340 size_t utf16_bytes_left = utf16_capacity;
342 char *utf16_str = MALLOC(utf16_capacity + 2);
346 char *orig_utf16_str = utf16_str;
348 size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str,
349 &utf8_bytes_left, &utf16_str, &utf16_bytes_left);
351 if (num_chars_converted == (size_t)(-1)) {
352 ERROR_WITH_ERRNO("Failed to convert UTF-8 string to UTF-16LE "
354 FREE(orig_utf16_str);
358 size_t utf16_len = utf16_capacity - utf16_bytes_left;
360 *utf16_len_ret = utf16_len;
361 orig_utf16_str[utf16_len] = '\0';
362 orig_utf16_str[utf16_len + 1] = '\0';
363 return orig_utf16_str;
366 static bool seeded = false;
368 static void seed_random()
370 srand(time(NULL) * getpid());
374 /* Fills @n bytes pointed to by @p with random alphanumeric characters. */
375 void randomize_char_array_with_alnum(char p[], size_t n)
390 /* Fills @n bytes pointer to by @p with random numbers. */
391 void randomize_byte_array(u8 *p, size_t n)
399 /* Takes in a path of length @len in @buf, and transforms it into a string for
400 * the path of its parent directory. */
401 void to_parent_name(char buf[], size_t len)
403 ssize_t i = (ssize_t)len - 1;
404 while (i >= 0 && buf[i] == '/')
406 while (i >= 0 && buf[i] != '/')
408 while (i >= 0 && buf[i] == '/')
413 /* Like the basename() function, but does not modify @path; it just returns a
415 const char *path_basename(const char *path)
417 const char *p = path;
422 /* Trailing slashes. */
431 while ((p != path - 1) && *p != '/')
438 * Returns a pointer to the part of @path following the first colon in the last
439 * path component, or NULL if the last path component does not contain a colon.
441 const char *path_stream_name(const char *path)
443 const char *base = path_basename(path);
444 const char *stream_name = strchr(base, ':');
448 return stream_name + 1;
452 * Splits a file path into the part before the first '/', or the entire name if
453 * there is no '/', and the part after the first sequence of '/' characters.
455 * @path: The file path to split.
456 * @first_part_len_ret: A pointer to a `size_t' into which the length of the
457 * first part of the path will be returned.
458 * @return: A pointer to the next part of the path, after the first
459 * sequence of '/', or a pointer to the terminating
460 * null byte in the case of a path without any '/'.
462 const char *path_next_part(const char *path, size_t *first_part_len_ret)
465 const char *next_part;
468 while (path[i] != '/' && path[i] != '\0')
470 if (first_part_len_ret)
471 *first_part_len_ret = i;
472 next_part = &path[i];
473 while (*next_part == '/')
478 /* Returns the number of components of @path. */
479 int get_num_path_components(const char *path)
481 int num_components = 0;
487 while (*path && *path != '/')
490 return num_components;
495 * Prints a string. Printable characters are printed as-is, while unprintable
496 * characters are printed as their octal escape codes.
498 void print_string(const void *string, size_t len)
500 const u8 *p = string;
506 printf("\\%03hho", *p);
511 u64 get_wim_timestamp()
514 gettimeofday(&tv, NULL);
515 return timeval_to_wim_timestamp(&tv);
518 void wim_timestamp_to_str(u64 timestamp, char *buf, size_t len)
521 time_t t = wim_timestamp_to_unix(timestamp);
523 strftime(buf, len, "%a %b %d %H:%M:%S %Y UTC", &tm);