6 * Copyright (C) 2010 Carl Thijssen
7 * Copyright (C) 2012 Eric Biggers
9 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
25 #include "wimlib_internal.h"
26 #include "endianness.h"
28 #include "timestamp.h"
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
44 bool __wimlib_print_errors = false;
46 void wimlib_error(const char *format, ...)
48 if (__wimlib_print_errors) {
54 fputs("ERROR: ", stderr);
55 vfprintf(stderr, format, va);
62 void wimlib_error_with_errno(const char *format, ...)
64 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) {
86 fputs("WARNING: ", stderr);
87 vfprintf(stderr, format, va);
96 WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
98 #ifdef ENABLE_ERROR_MESSAGES
99 __wimlib_print_errors = show_error_messages;
102 if (show_error_messages)
103 return WIMLIB_ERR_UNSUPPORTED;
107 static const char *error_strings[] = {
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",
117 = "Failed to fork another process",
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 "
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",
149 = "Failed to create a hard or symbolic link when extracting "
150 "a file from the WIM",
152 = "Failed to create a directory",
154 = "Failed to create or use a POSIX message queue",
156 = "Ran out of memory",
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",
165 = "NTFS-3g encountered an error (check errno)",
167 = "Failed to open a file",
169 = "Failed to open a directory",
171 = "Could not read data from a file",
172 [WIMLIB_ERR_READLINK]
173 = "Could not read the target of a symbolic link",
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",
183 = "Could not read the metadata for a file or directory",
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",
191 = "Failed to write data to a file",
193 = "The XML data of the WIM is invalid",
196 WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code)
198 if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML)
201 return error_strings[code];
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;
211 void *wimlib_calloc(size_t nmemb, size_t size)
213 size_t total_size = nmemb * size;
214 void *p = MALLOC(total_size);
216 memset(p, 0, total_size);
220 char *wimlib_strdup(const char *str)
226 p = MALLOC(size + 1);
228 memcpy(p, str, size + 1);
232 extern void xml_set_memory_allocator(void *(*malloc_func)(size_t),
233 void (*free_func)(void *),
234 void *(*realloc_func)(void *, size_t));
237 WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
238 void (*free_func)(void *),
239 void *(*realloc_func)(void *, size_t))
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;
246 xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
247 wimlib_realloc_func);
250 ERROR("Cannot set custom memory allocator functions:");
251 ERROR("wimlib was compiled with the --without-custom-memory-allocator "
253 return WIMLIB_ERR_UNSUPPORTED;
259 static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1);
261 /* Converts a string in the UTF-16 encoding to a newly allocated string in the
263 char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
264 size_t *utf8_len_ret)
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");
274 size_t utf16_bytes_left = utf16_len;
275 size_t utf8_bytes_left = utf16_len;
277 char *utf8_str = MALLOC(utf8_bytes_left);
281 char *orig_utf8_str = utf8_str;
283 size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str,
284 &utf16_bytes_left, &utf8_str, &utf8_bytes_left);
286 if (num_chars_converted == (size_t)(-1)) {
287 ERROR_WITH_ERRNO("Failed to convert UTF-16LE string to UTF-8 "
293 size_t utf8_len = utf16_len - utf8_bytes_left;
295 *utf8_len_ret = utf8_len;
296 orig_utf8_str[utf8_len] = '\0';
297 return orig_utf8_str;
300 static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1);
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)
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");
316 size_t utf8_bytes_left = utf8_len;
317 size_t utf16_capacity = utf8_len * 4;
318 size_t utf16_bytes_left = utf16_capacity;
320 char *utf16_str = MALLOC(utf16_capacity + 2);
324 char *orig_utf16_str = utf16_str;
326 size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str,
327 &utf8_bytes_left, &utf16_str, &utf16_bytes_left);
329 if (num_chars_converted == (size_t)(-1)) {
330 ERROR_WITH_ERRNO("Failed to convert UTF-8 string to UTF-16LE "
332 FREE(orig_utf16_str);
336 size_t utf16_len = utf16_capacity - utf16_bytes_left;
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;
344 /* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and
347 * Returns short count and set errno on failure. */
348 ssize_t full_write(int fd, const void *buf, size_t n)
355 ret = write(fd, p, n);
369 static bool seeded = false;
371 /* Fills @n bytes pointed to by @p with random alphanumeric characters. */
372 void randomize_char_array_with_alnum(char p[], size_t n)
391 /* Fills @n bytes pointer to by @p with random numbers. */
392 void randomize_byte_array(u8 *p, size_t n)
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)
406 ssize_t i = (ssize_t)len - 1;
407 while (i >= 0 && buf[i] == '/')
409 while (i >= 0 && buf[i] != '/')
411 while (i >= 0 && buf[i] == '/')
416 /* Like the basename() function, but does not modify @path; it just returns a
418 const char *path_basename(const char *path)
420 const char *p = path;
425 /* Trailing slashes. */
426 while ((p != path - 1) && *p == '/')
429 while ((p != path - 1) && *p != '/')
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.
439 const char *path_stream_name(const char *path)
441 const char *base = path_basename(path);
442 const char *stream_name = strchr(base, ':');
446 return stream_name + 1;
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.
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 '/'.
460 const char *path_next_part(const char *path, size_t *first_part_len_ret)
463 const char *next_part;
466 while (path[i] != '/' && path[i] != '\0')
468 if (first_part_len_ret)
469 *first_part_len_ret = i;
470 next_part = &path[i];
471 while (*next_part == '/')
476 /* Returns the number of components of @path. */
477 int get_num_path_components(const char *path)
479 int num_components = 0;
485 while (*path && *path != '/')
488 return num_components;
493 * Prints a string. Printable characters are printed as-is, while unprintable
494 * characters are printed as their octal escape codes.
496 void print_string(const void *string, size_t len)
498 const u8 *p = string;
504 printf("\\%03hho", *p);
509 u64 get_wim_timestamp()
512 gettimeofday(&tv, NULL);
513 return timeval_to_wim_timestamp(&tv);