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) {
71 fputs("[ERROR] ", stderr);
72 vfprintf(stderr, format, va);
73 fprintf(stderr, ": %s\n", strerror(errno_save));
79 void wimlib_warning(const char *format, ...)
81 if (__wimlib_print_errors) {
88 fputs("[WARNING] ", stderr);
89 vfprintf(stderr, format, va);
98 WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
100 #ifdef ENABLE_ERROR_MESSAGES
101 __wimlib_print_errors = show_error_messages;
104 if (show_error_messages)
105 return WIMLIB_ERR_UNSUPPORTED;
109 static const char *error_strings[] = {
112 [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
113 = "Lookup table is compressed",
114 [WIMLIB_ERR_DECOMPRESSION]
115 = "Failed to decompress compressed data",
116 [WIMLIB_ERR_DELETE_STAGING_DIR]
117 = "Failed to delete staging directory",
119 = "Failed to fork another process",
121 = "An error was returned by fuse_main()",
122 [WIMLIB_ERR_FUSERMOUNT]
123 = "Could not execute the `fusermount' program, or it exited "
124 "with a failure status",
125 [WIMLIB_ERR_IMAGE_COUNT]
126 = "Inconsistent image count among the metadata "
127 "resources, the WIM header, and/or the XML data",
128 [WIMLIB_ERR_IMAGE_NAME_COLLISION]
129 = "Tried to add an image with a name that is already in use",
130 [WIMLIB_ERR_INTEGRITY]
131 = "The WIM failed an integrity check",
132 [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
133 = "The capture configuration string was invalid",
134 [WIMLIB_ERR_INVALID_CHUNK_SIZE]
135 = "The WIM is compressed but does not have a chunk "
137 [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
138 = "The WIM is compressed, but is not marked as having LZX or "
139 "XPRESS compression",
140 [WIMLIB_ERR_INVALID_DENTRY]
141 = "A directory entry in the WIM was invalid",
142 [WIMLIB_ERR_INVALID_HEADER_SIZE]
143 = "The WIM header was not 208 bytes",
144 [WIMLIB_ERR_INVALID_IMAGE]
145 = "Tried to select an image that does not exist in the WIM",
146 [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
147 = "The WIM's integrity table is invalid",
148 [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
149 = "An entry in the WIM's lookup table is invalid",
150 [WIMLIB_ERR_INVALID_PARAM]
151 = "An invalid parameter was given",
152 [WIMLIB_ERR_INVALID_RESOURCE_HASH]
153 = "The SHA1 message digest of a WIM resource did not match the expected value",
154 [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
155 = "A resource entry in the WIM is invalid",
157 = "Failed to create a hard or symbolic link when extracting "
158 "a file from the WIM",
160 = "Failed to create a directory",
162 = "Failed to create or use a POSIX message queue",
164 = "Ran out of memory",
166 = "Expected a directory",
167 [WIMLIB_ERR_NOT_A_WIM_FILE]
168 = "The file did not begin with the magic characters that "
169 "identify a WIM file",
170 [WIMLIB_ERR_NO_FILENAME]
171 = "The WIM is not identified with a filename",
173 = "NTFS-3g encountered an error (check errno)",
175 = "Failed to open a file",
177 = "Failed to open a directory",
179 = "Could not read data from a file",
180 [WIMLIB_ERR_READLINK]
181 = "Could not read the target of a symbolic link",
183 = "Could not rename a file",
184 [WIMLIB_ERR_SPECIAL_FILE]
185 = "Encountered a special file that cannot be archived",
186 [WIMLIB_ERR_SPLIT_INVALID]
187 = "The WIM is part of an invalid split WIM",
188 [WIMLIB_ERR_SPLIT_UNSUPPORTED]
189 = "The WIM is part of a split WIM, which is not supported for this operation",
191 = "Could not read the metadata for a file or directory",
194 [WIMLIB_ERR_UNKNOWN_VERSION]
195 = "The WIM file is marked with an unknown version number",
196 [WIMLIB_ERR_UNSUPPORTED]
197 = "The requested operation is unsupported",
199 = "Failed to write data to a file",
201 = "The XML data of the WIM is invalid",
204 WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code)
206 if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML)
209 return error_strings[code];
214 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
215 void *(*wimlib_malloc_func) (size_t) = malloc;
216 void (*wimlib_free_func) (void *) = free;
217 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
219 void *wimlib_calloc(size_t nmemb, size_t size)
221 size_t total_size = nmemb * size;
222 void *p = MALLOC(total_size);
224 memset(p, 0, total_size);
228 char *wimlib_strdup(const char *str)
234 p = MALLOC(size + 1);
236 memcpy(p, str, size + 1);
240 extern void xml_set_memory_allocator(void *(*malloc_func)(size_t),
241 void (*free_func)(void *),
242 void *(*realloc_func)(void *, size_t));
245 WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
246 void (*free_func)(void *),
247 void *(*realloc_func)(void *, size_t))
249 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
250 wimlib_malloc_func = malloc_func ? malloc_func : malloc;
251 wimlib_free_func = free_func ? free_func : free;
252 wimlib_realloc_func = realloc_func ? realloc_func : realloc;
254 xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
255 wimlib_realloc_func);
258 ERROR("Cannot set custom memory allocator functions:");
259 ERROR("wimlib was compiled with the --without-custom-memory-allocator "
261 return WIMLIB_ERR_UNSUPPORTED;
267 static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1);
269 /* Converts a string in the UTF-16 encoding to a newly allocated string in the
271 char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
272 size_t *utf8_len_ret)
274 if (cd_utf16_to_utf8 == (iconv_t)(-1)) {
275 cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE");
276 if (cd_utf16_to_utf8 == (iconv_t)-1) {
277 ERROR_WITH_ERRNO("Failed to get conversion descriptor "
278 "for converting UTF-16LE to UTF-8");
282 size_t utf16_bytes_left = utf16_len;
283 size_t utf8_bytes_left = utf16_len;
285 char *utf8_str = MALLOC(utf8_bytes_left);
289 char *orig_utf8_str = utf8_str;
291 size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str,
292 &utf16_bytes_left, &utf8_str, &utf8_bytes_left);
294 if (num_chars_converted == (size_t)(-1)) {
295 ERROR_WITH_ERRNO("Failed to convert UTF-16LE string to UTF-8 "
301 size_t utf8_len = utf16_len - utf8_bytes_left;
303 *utf8_len_ret = utf8_len;
304 orig_utf8_str[utf8_len] = '\0';
305 return orig_utf8_str;
308 static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1);
310 /* Converts a string in the UTF-8 encoding to a newly allocated string in the
311 * UTF-16 encoding. */
312 char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
313 size_t *utf16_len_ret)
315 if (cd_utf8_to_utf16 == (iconv_t)(-1)) {
316 cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8");
317 if (cd_utf8_to_utf16 == (iconv_t)-1) {
318 ERROR_WITH_ERRNO("Failed to get conversion descriptor "
319 "for converting UTF-8 to UTF-16LE");
324 size_t utf8_bytes_left = utf8_len;
325 size_t utf16_capacity = utf8_len * 4;
326 size_t utf16_bytes_left = utf16_capacity;
328 char *utf16_str = MALLOC(utf16_capacity + 2);
332 char *orig_utf16_str = utf16_str;
334 size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str,
335 &utf8_bytes_left, &utf16_str, &utf16_bytes_left);
337 if (num_chars_converted == (size_t)(-1)) {
338 ERROR_WITH_ERRNO("Failed to convert UTF-8 string to UTF-16LE "
340 FREE(orig_utf16_str);
344 size_t utf16_len = utf16_capacity - utf16_bytes_left;
346 *utf16_len_ret = utf16_len;
347 orig_utf16_str[utf16_len] = '\0';
348 orig_utf16_str[utf16_len + 1] = '\0';
349 return orig_utf16_str;
352 /* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and
355 * Returns short count and set errno on failure. */
356 ssize_t full_write(int fd, const void *buf, size_t n)
363 ret = write(fd, p, n);
377 static bool seeded = false;
379 /* Fills @n bytes pointed to by @p with random alphanumeric characters. */
380 void randomize_char_array_with_alnum(char p[], size_t n)
399 /* Fills @n bytes pointer to by @p with random numbers. */
400 void randomize_byte_array(u8 *p, size_t n)
410 /* Takes in a path of length @len in @buf, and transforms it into a string for
411 * the path of its parent directory. */
412 void to_parent_name(char buf[], size_t len)
414 ssize_t i = (ssize_t)len - 1;
415 while (i >= 0 && buf[i] == '/')
417 while (i >= 0 && buf[i] != '/')
419 while (i >= 0 && buf[i] == '/')
424 /* Like the basename() function, but does not modify @path; it just returns a
426 const char *path_basename(const char *path)
428 const char *p = path;
433 /* Trailing slashes. */
442 while ((p != path - 1) && *p != '/')
449 * Returns a pointer to the part of @path following the first colon in the last
450 * path component, or NULL if the last path component does not contain a colon.
452 const char *path_stream_name(const char *path)
454 const char *base = path_basename(path);
455 const char *stream_name = strchr(base, ':');
459 return stream_name + 1;
463 * Splits a file path into the part before the first '/', or the entire name if
464 * there is no '/', and the part after the first sequence of '/' characters.
466 * @path: The file path to split.
467 * @first_part_len_ret: A pointer to a `size_t' into which the length of the
468 * first part of the path will be returned.
469 * @return: A pointer to the next part of the path, after the first
470 * sequence of '/', or a pointer to the terminating
471 * null byte in the case of a path without any '/'.
473 const char *path_next_part(const char *path, size_t *first_part_len_ret)
476 const char *next_part;
479 while (path[i] != '/' && path[i] != '\0')
481 if (first_part_len_ret)
482 *first_part_len_ret = i;
483 next_part = &path[i];
484 while (*next_part == '/')
489 /* Returns the number of components of @path. */
490 int get_num_path_components(const char *path)
492 int num_components = 0;
498 while (*path && *path != '/')
501 return num_components;
506 * Prints a string. Printable characters are printed as-is, while unprintable
507 * characters are printed as their octal escape codes.
509 void print_string(const void *string, size_t len)
511 const u8 *p = string;
517 printf("\\%03hho", *p);
522 u64 get_wim_timestamp()
525 gettimeofday(&tv, NULL);
526 return timeval_to_wim_timestamp(&tv);