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;
108 static const char *error_strings[] = {
111 [WIMLIB_ERR_ALREADY_LOCKED]
112 = "The WIM is already locked for writing",
113 [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
114 = "Lookup table is compressed",
115 [WIMLIB_ERR_DECOMPRESSION]
116 = "Failed to decompress compressed data",
117 [WIMLIB_ERR_DELETE_STAGING_DIR]
118 = "Failed to delete staging directory",
120 = "Failed to fork another process",
122 = "An error was returned by fuse_main()",
123 [WIMLIB_ERR_FUSERMOUNT]
124 = "Could not execute the `fusermount' program, or it exited "
125 "with a failure status",
126 [WIMLIB_ERR_IMAGE_COUNT]
127 = "Inconsistent image count among the metadata "
128 "resources, the WIM header, and/or the XML data",
129 [WIMLIB_ERR_IMAGE_NAME_COLLISION]
130 = "Tried to add an image with a name that is already in use",
131 [WIMLIB_ERR_INTEGRITY]
132 = "The WIM failed an integrity check",
133 [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
134 = "The capture configuration string was invalid",
135 [WIMLIB_ERR_INVALID_CHUNK_SIZE]
136 = "The WIM is compressed but does not have a chunk "
138 [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
139 = "The WIM is compressed, but is not marked as having LZX or "
140 "XPRESS compression",
141 [WIMLIB_ERR_INVALID_DENTRY]
142 = "A directory entry in the WIM was invalid",
143 [WIMLIB_ERR_INVALID_HEADER_SIZE]
144 = "The WIM header was not 208 bytes",
145 [WIMLIB_ERR_INVALID_IMAGE]
146 = "Tried to select an image that does not exist in the WIM",
147 [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
148 = "The WIM's integrity table is invalid",
149 [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
150 = "An entry in the WIM's lookup table is invalid",
151 [WIMLIB_ERR_INVALID_PARAM]
152 = "An invalid parameter was given",
153 [WIMLIB_ERR_INVALID_RESOURCE_HASH]
154 = "The SHA1 message digest of a WIM resource did not match the expected value",
155 [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
156 = "A resource entry in the WIM has an invalid size",
158 = "Failed to create a hard or symbolic link when extracting "
159 "a file from the WIM",
161 = "Failed to create a directory",
163 = "Failed to create or use a POSIX message queue",
165 = "Ran out of memory",
167 = "Expected a directory",
168 [WIMLIB_ERR_NOT_A_WIM_FILE]
169 = "The file did not begin with the magic characters that "
170 "identify a WIM file",
171 [WIMLIB_ERR_NO_FILENAME]
172 = "The WIM is not identified with a filename",
174 = "NTFS-3g encountered an error (check errno)",
176 = "Failed to open a file",
178 = "Failed to open a directory",
180 = "Could not read data from a file",
181 [WIMLIB_ERR_READLINK]
182 = "Could not read the target of a symbolic link",
184 = "Could not rename a file",
186 = "Could not re-open the WIM after overwriting it",
187 [WIMLIB_ERR_RESOURCE_ORDER]
188 = "The components of the WIM were arranged in an unexpected order",
189 [WIMLIB_ERR_SPECIAL_FILE]
190 = "Encountered a special file that cannot be archived",
191 [WIMLIB_ERR_SPLIT_INVALID]
192 = "The WIM is part of an invalid split WIM",
193 [WIMLIB_ERR_SPLIT_UNSUPPORTED]
194 = "The WIM is part of a split WIM, which is not supported for this operation",
196 = "Could not read the metadata for a file or directory",
199 [WIMLIB_ERR_UNKNOWN_VERSION]
200 = "The WIM file is marked with an unknown version number",
201 [WIMLIB_ERR_UNSUPPORTED]
202 = "The requested operation is unsupported",
204 = "Failed to write data to a file",
206 = "The XML data of the WIM is invalid",
209 WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code)
211 if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML)
214 return error_strings[code];
219 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
220 void *(*wimlib_malloc_func) (size_t) = malloc;
221 void (*wimlib_free_func) (void *) = free;
222 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
224 void *wimlib_calloc(size_t nmemb, size_t size)
226 size_t total_size = nmemb * size;
227 void *p = MALLOC(total_size);
229 memset(p, 0, total_size);
233 char *wimlib_strdup(const char *str)
239 p = MALLOC(size + 1);
241 memcpy(p, str, size + 1);
245 extern void xml_set_memory_allocator(void *(*malloc_func)(size_t),
246 void (*free_func)(void *),
247 void *(*realloc_func)(void *, size_t));
250 WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
251 void (*free_func)(void *),
252 void *(*realloc_func)(void *, size_t))
254 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
255 wimlib_malloc_func = malloc_func ? malloc_func : malloc;
256 wimlib_free_func = free_func ? free_func : free;
257 wimlib_realloc_func = realloc_func ? realloc_func : realloc;
259 xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
260 wimlib_realloc_func);
263 ERROR("Cannot set custom memory allocator functions:");
264 ERROR("wimlib was compiled with the --without-custom-memory-allocator "
266 return WIMLIB_ERR_UNSUPPORTED;
272 static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1);
274 /* Converts a string in the UTF-16 encoding to a newly allocated string in the
276 char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
277 size_t *utf8_len_ret)
279 if (cd_utf16_to_utf8 == (iconv_t)(-1)) {
280 cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE");
281 if (cd_utf16_to_utf8 == (iconv_t)-1) {
282 ERROR_WITH_ERRNO("Failed to get conversion descriptor "
283 "for converting UTF-16LE to UTF-8");
287 size_t utf16_bytes_left = utf16_len;
288 size_t utf8_bytes_left = utf16_len;
290 char *utf8_str = MALLOC(utf8_bytes_left);
294 char *orig_utf8_str = utf8_str;
296 size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str,
297 &utf16_bytes_left, &utf8_str, &utf8_bytes_left);
299 if (num_chars_converted == (size_t)(-1)) {
300 ERROR_WITH_ERRNO("Failed to convert UTF-16LE string to UTF-8 "
306 size_t utf8_len = utf16_len - utf8_bytes_left;
308 *utf8_len_ret = utf8_len;
309 orig_utf8_str[utf8_len] = '\0';
310 return orig_utf8_str;
313 static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1);
315 /* Converts a string in the UTF-8 encoding to a newly allocated string in the
316 * UTF-16 encoding. */
317 char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
318 size_t *utf16_len_ret)
320 if (cd_utf8_to_utf16 == (iconv_t)(-1)) {
321 cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8");
322 if (cd_utf8_to_utf16 == (iconv_t)-1) {
323 ERROR_WITH_ERRNO("Failed to get conversion descriptor "
324 "for converting UTF-8 to UTF-16LE");
329 size_t utf8_bytes_left = utf8_len;
330 size_t utf16_capacity = utf8_len * 4;
331 size_t utf16_bytes_left = utf16_capacity;
333 char *utf16_str = MALLOC(utf16_capacity + 2);
337 char *orig_utf16_str = utf16_str;
339 size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str,
340 &utf8_bytes_left, &utf16_str, &utf16_bytes_left);
342 if (num_chars_converted == (size_t)(-1)) {
343 ERROR_WITH_ERRNO("Failed to convert UTF-8 string to UTF-16LE "
345 FREE(orig_utf16_str);
349 size_t utf16_len = utf16_capacity - utf16_bytes_left;
351 *utf16_len_ret = utf16_len;
352 orig_utf16_str[utf16_len] = '\0';
353 orig_utf16_str[utf16_len + 1] = '\0';
354 return orig_utf16_str;
357 /* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and
360 * Returns short count and set errno on failure. */
361 ssize_t full_write(int fd, const void *buf, size_t n)
368 ret = write(fd, p, n);
382 static bool seeded = false;
384 static void seed_random()
386 srand(time(NULL) * getpid());
390 /* Fills @n bytes pointed to by @p with random alphanumeric characters. */
391 void randomize_char_array_with_alnum(char p[], size_t n)
406 /* Fills @n bytes pointer to by @p with random numbers. */
407 void randomize_byte_array(u8 *p, size_t n)
415 /* Takes in a path of length @len in @buf, and transforms it into a string for
416 * the path of its parent directory. */
417 void to_parent_name(char buf[], size_t len)
419 ssize_t i = (ssize_t)len - 1;
420 while (i >= 0 && buf[i] == '/')
422 while (i >= 0 && buf[i] != '/')
424 while (i >= 0 && buf[i] == '/')
429 /* Like the basename() function, but does not modify @path; it just returns a
431 const char *path_basename(const char *path)
433 const char *p = path;
438 /* Trailing slashes. */
447 while ((p != path - 1) && *p != '/')
454 * Returns a pointer to the part of @path following the first colon in the last
455 * path component, or NULL if the last path component does not contain a colon.
457 const char *path_stream_name(const char *path)
459 const char *base = path_basename(path);
460 const char *stream_name = strchr(base, ':');
464 return stream_name + 1;
468 * Splits a file path into the part before the first '/', or the entire name if
469 * there is no '/', and the part after the first sequence of '/' characters.
471 * @path: The file path to split.
472 * @first_part_len_ret: A pointer to a `size_t' into which the length of the
473 * first part of the path will be returned.
474 * @return: A pointer to the next part of the path, after the first
475 * sequence of '/', or a pointer to the terminating
476 * null byte in the case of a path without any '/'.
478 const char *path_next_part(const char *path, size_t *first_part_len_ret)
481 const char *next_part;
484 while (path[i] != '/' && path[i] != '\0')
486 if (first_part_len_ret)
487 *first_part_len_ret = i;
488 next_part = &path[i];
489 while (*next_part == '/')
494 /* Returns the number of components of @path. */
495 int get_num_path_components(const char *path)
497 int num_components = 0;
503 while (*path && *path != '/')
506 return num_components;
511 * Prints a string. Printable characters are printed as-is, while unprintable
512 * characters are printed as their octal escape codes.
514 void print_string(const void *string, size_t len)
516 const u8 *p = string;
522 printf("\\%03hho", *p);
527 u64 get_wim_timestamp()
530 gettimeofday(&tv, NULL);
531 return timeval_to_wim_timestamp(&tv);