/*
* util.c
- *
- * Copyright (C) 2010 Carl Thijssen
+ */
+
+/*
* Copyright (C) 2012 Eric Biggers
*
- * wimlib - Library for working with WIM files
+ * This file is part of wimlib, a library for working with WIM files.
*
- * This library is free software; you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option) any
- * later version.
+ * wimlib is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
+ * any later version.
*
- * This library is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
*
- * You should have received a copy of the GNU Lesser General Public License along
- * with this library; if not, write to the Free Software Foundation, Inc., 59
- * Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * You should have received a copy of the GNU General Public License
+ * along with wimlib; if not, see http://www.gnu.org/licenses/.
*/
+#undef _GNU_SOURCE
+/* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
+ * version, which has a different return type. */
+#define _POSIX_C_SOURCE 200112
+#include <string.h>
+#define _GNU_SOURCE
+
#include "wimlib_internal.h"
#include "endianness.h"
-#include "sha1.h"
+#include "timestamp.h"
-
-#include <iconv.h>
-#include <string.h>
#include <ctype.h>
-#include <stdlib.h>
-#include <time.h>
-#include <unistd.h>
#include <errno.h>
+#include <stdlib.h>
+
+#include <unistd.h> /* for getpid() */
-/* True if WIMLIB is to print an informational message when an error occurs.
- * This can be turned off by calling wimlib_set_error_messages(false). */
+/* True if wimlib is to print an informational message when an error occurs.
+ * This can be turned off by calling wimlib_set_print_errors(false). */
#ifdef ENABLE_ERROR_MESSAGES
#include <stdarg.h>
-bool __wimlib_print_errors = false;
+static bool wimlib_print_errors = false;
-void wimlib_error(const char *format, ...)
+static void wimlib_vmsg(const char *tag, const char *format,
+ va_list va, bool perror)
{
- if (__wimlib_print_errors) {
- va_list va;
- int errno_save;
-
- va_start(va, format);
- errno_save = errno;
- fputs("ERROR: ", stderr);
+ if (wimlib_print_errors) {
+ int errno_save = errno;
+ fflush(stdout);
+ fputs(tag, stderr);
vfprintf(stderr, format, va);
+ if (perror && errno_save != 0) {
+ char buf[50];
+ int res = strerror_r(errno_save, buf, sizeof(buf));
+ if (res) {
+ snprintf(buf, sizeof(buf),
+ "unknown error (errno=%d)", errno_save);
+ }
+ fputs(buf, stderr);
+ }
+ putc('\n', stderr);
errno = errno_save;
- va_end(va);
}
}
+void wimlib_error(const char *format, ...)
+{
+ va_list va;
+
+ va_start(va, format);
+ wimlib_vmsg("[ERROR] ", format, va, false);
+ va_end(va);
+}
+
+void wimlib_error_with_errno(const char *format, ...)
+{
+ va_list va;
+
+ va_start(va, format);
+ wimlib_vmsg("[ERROR] ", format, va, true);
+ va_end(va);
+}
+
void wimlib_warning(const char *format, ...)
{
- if (__wimlib_print_errors) {
- va_list va;
- int errno_save;
+ va_list va;
- va_start(va, format);
- errno_save = errno;
- fputs("WARNING: ", stderr);
- vfprintf(stderr, format, va);
- errno = errno_save;
- va_end(va);
- }
+ va_start(va, format);
+ wimlib_vmsg("[WARNING] ", format, va, false);
+ va_end(va);
+}
+
+void wimlib_warning_with_errno(const char *format, ...)
+{
+ va_list va;
+
+ va_start(va, format);
+ wimlib_vmsg("[WARNING] ", format, va, true);
+ va_end(va);
}
#endif
WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
{
#ifdef ENABLE_ERROR_MESSAGES
- __wimlib_print_errors = show_error_messages;
+ wimlib_print_errors = show_error_messages;
return 0;
#else
if (show_error_messages)
return WIMLIB_ERR_UNSUPPORTED;
+ else
+ return 0;
#endif
}
static const char *error_strings[] = {
- [WIMLIB_ERR_SUCCESS]
+ [WIMLIB_ERR_SUCCESS]
= "Success",
- [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
+ [WIMLIB_ERR_ALREADY_LOCKED]
+ = "The WIM is already locked for writing",
+ [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
= "Lookup table is compressed",
- [WIMLIB_ERR_DECOMPRESSION]
+ [WIMLIB_ERR_DECOMPRESSION]
= "Failed to decompress compressed data",
- [WIMLIB_ERR_DELETE_STAGING_DIR]
+ [WIMLIB_ERR_DELETE_STAGING_DIR]
= "Failed to delete staging directory",
- [WIMLIB_ERR_FORK]
+ [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
+ = "The process servicing the mounted WIM has crashed",
+ [WIMLIB_ERR_FORK]
= "Failed to fork another process",
- [WIMLIB_ERR_FUSE]
+ [WIMLIB_ERR_FUSE]
= "An error was returned by fuse_main()",
- [WIMLIB_ERR_FUSERMOUNT]
+ [WIMLIB_ERR_FUSERMOUNT]
= "Could not execute the `fusermount' program, or it exited "
"with a failure status",
- [WIMLIB_ERR_IMAGE_COUNT]
+ [WIMLIB_ERR_IMAGE_COUNT]
= "Inconsistent image count among the metadata "
"resources, the WIM header, and/or the XML data",
- [WIMLIB_ERR_IMAGE_NAME_COLLISION]
+ [WIMLIB_ERR_IMAGE_NAME_COLLISION]
= "Tried to add an image with a name that is already in use",
- [WIMLIB_ERR_INTEGRITY]
+ [WIMLIB_ERR_INTEGRITY]
= "The WIM failed an integrity check",
- [WIMLIB_ERR_INVALID_CHUNK_SIZE]
+ [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
+ = "The capture configuration string was invalid",
+ [WIMLIB_ERR_INVALID_CHUNK_SIZE]
= "The WIM is compressed but does not have a chunk "
"size of 32768",
- [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
+ [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
= "The WIM is compressed, but is not marked as having LZX or "
"XPRESS compression",
- [WIMLIB_ERR_INVALID_DENTRY]
+ [WIMLIB_ERR_INVALID_DENTRY]
= "A directory entry in the WIM was invalid",
- [WIMLIB_ERR_INVALID_HEADER_SIZE]
+ [WIMLIB_ERR_INVALID_HEADER_SIZE]
= "The WIM header was not 208 bytes",
- [WIMLIB_ERR_INVALID_IMAGE]
+ [WIMLIB_ERR_INVALID_IMAGE]
= "Tried to select an image that does not exist in the WIM",
- [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
+ [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
= "The WIM's integrity table is invalid",
- [WIMLIB_ERR_INVALID_PARAM]
+ [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
+ = "An entry in the WIM's lookup table is invalid",
+ [WIMLIB_ERR_INVALID_PARAM]
= "An invalid parameter was given",
- [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
- = "A resource entry in the WIM is invalid",
- [WIMLIB_ERR_LINK]
+ [WIMLIB_ERR_INVALID_PART_NUMBER]
+ = "The part number or total parts of the WIM is invalid",
+ [WIMLIB_ERR_INVALID_RESOURCE_HASH]
+ = "The SHA1 message digest of a WIM resource did not match the expected value",
+ [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
+ = "The iconv() function does not seem to work. "
+ "Maybe check to make sure the directory /usr/lib/gconv exists",
+ [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
+ = "A resource entry in the WIM has an invalid size",
+ [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
+ = "The version of wimlib that has mounted a WIM image is incompatible with the "
+ "version being used to unmount it",
+ [WIMLIB_ERR_INVALID_UTF8_STRING]
+ = "A string provided as input by the user was not a valid UTF-8 string",
+ [WIMLIB_ERR_INVALID_UTF16_STRING]
+ = "A string in a WIM dentry is not a valid UTF-16LE string",
+ [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
+ = "libxml2 was unable to find a character encoding conversion handler "
+ "for UTF-16LE",
+ [WIMLIB_ERR_LINK]
= "Failed to create a hard or symbolic link when extracting "
"a file from the WIM",
- [WIMLIB_ERR_MKDIR]
+ [WIMLIB_ERR_MKDIR]
= "Failed to create a directory",
- [WIMLIB_ERR_MQUEUE]
+ [WIMLIB_ERR_MQUEUE]
= "Failed to create or use a POSIX message queue",
- [WIMLIB_ERR_NOMEM]
+ [WIMLIB_ERR_NOMEM]
= "Ran out of memory",
- [WIMLIB_ERR_NOTDIR]
+ [WIMLIB_ERR_NOTDIR]
= "Expected a directory",
- [WIMLIB_ERR_NOT_A_WIM_FILE]
+ [WIMLIB_ERR_NOT_A_WIM_FILE]
= "The file did not begin with the magic characters that "
"identify a WIM file",
- [WIMLIB_ERR_NO_FILENAME]
+ [WIMLIB_ERR_NO_FILENAME]
= "The WIM is not identified with a filename",
- [WIMLIB_ERR_OPEN]
+ [WIMLIB_ERR_NTFS_3G]
+ = "NTFS-3g encountered an error (check errno)",
+ [WIMLIB_ERR_OPEN]
= "Failed to open a file",
- [WIMLIB_ERR_OPENDIR]
+ [WIMLIB_ERR_OPENDIR]
= "Failed to open a directory",
- [WIMLIB_ERR_READ]
+ [WIMLIB_ERR_READ]
= "Could not read data from a file",
- [WIMLIB_ERR_RENAME]
+ [WIMLIB_ERR_READLINK]
+ = "Could not read the target of a symbolic link",
+ [WIMLIB_ERR_RENAME]
= "Could not rename a file",
- [WIMLIB_ERR_SPLIT_INVALID]
+ [WIMLIB_ERR_REOPEN]
+ = "Could not re-open the WIM after overwriting it",
+ [WIMLIB_ERR_RESOURCE_ORDER]
+ = "The components of the WIM were arranged in an unexpected order",
+ [WIMLIB_ERR_SPECIAL_FILE]
+ = "Encountered a special file that cannot be archived",
+ [WIMLIB_ERR_SPLIT_INVALID]
= "The WIM is part of an invalid split WIM",
- [WIMLIB_ERR_SPLIT_UNSUPPORTED]
+ [WIMLIB_ERR_SPLIT_UNSUPPORTED]
= "The WIM is part of a split WIM, which is not supported for this operation",
- [WIMLIB_ERR_STAT]
+ [WIMLIB_ERR_STAT]
= "Could not read the metadata for a file or directory",
- [WIMLIB_ERR_TIMEOUT]
- = "Timed out",
- [WIMLIB_ERR_UNKNOWN_VERSION]
+ [WIMLIB_ERR_UNKNOWN_VERSION]
= "The WIM file is marked with an unknown version number",
- [WIMLIB_ERR_UNSUPPORTED]
+ [WIMLIB_ERR_UNSUPPORTED]
= "The requested operation is unsupported",
- [WIMLIB_ERR_WRITE]
+ [WIMLIB_ERR_WRITE]
= "Failed to write data to a file",
- [WIMLIB_ERR_XML]
+ [WIMLIB_ERR_XML]
= "The XML data of the WIM is invalid",
};
#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
-void *(*wimlib_malloc_func)(size_t) = malloc;
-void (*wimlib_free_func)(void *) = free;
+void *(*wimlib_malloc_func) (size_t) = malloc;
+void (*wimlib_free_func) (void *) = free;
void *(*wimlib_realloc_func)(void *, size_t) = realloc;
void *wimlib_calloc(size_t nmemb, size_t size)
{
size_t size;
char *p;
-
- size = strlen(str);
+
+ size = strlen(str);
p = MALLOC(size + 1);
if (p)
memcpy(p, str, size + 1);
wimlib_free_func = free_func ? free_func : free;
wimlib_realloc_func = realloc_func ? realloc_func : realloc;
- xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
+ xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
wimlib_realloc_func);
+ return 0;
#else
- ERROR("Cannot set custom memory allocator functions:\n");
- ERROR("wimlib was compiled with the "
- "--without-custom-memory-allocator flag\n");
+ ERROR("Cannot set custom memory allocator functions:");
+ ERROR("wimlib was compiled with the --without-custom-memory-allocator "
+ "flag");
return WIMLIB_ERR_UNSUPPORTED;
#endif
}
+static bool seeded = false;
-
-static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1);
-
-/* Converts a string in the UTF-16 encoding to a newly allocated string in the
- * UTF-8 encoding. */
-char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
- size_t *utf8_len_ret)
-{
- if (cd_utf16_to_utf8 == (iconv_t)(-1)) {
- cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE");
- if (cd_utf16_to_utf8 == (iconv_t)-1) {
- ERROR("Failed to get conversion descriptor for "
- "converting UTF-16LE to UTF-8: %m\n");
- return NULL;
- }
- }
- size_t utf16_bytes_left = utf16_len;
- size_t utf8_bytes_left = utf16_len;
-
- char *utf8_str = MALLOC(utf8_bytes_left);
- if (!utf8_str)
- return NULL;
-
- char *orig_utf8_str = utf8_str;
-
- size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str,
- &utf16_bytes_left, &utf8_str, &utf8_bytes_left);
-
- if (num_chars_converted == (size_t)(-1)) {
- ERROR("Failed to convert UTF-16LE string to UTF-8 string: "
- "%m\n");
- FREE(orig_utf8_str);
- return NULL;
- }
-
- size_t utf8_len = utf16_len - utf8_bytes_left;
-
- *utf8_len_ret = utf8_len;
- orig_utf8_str[utf8_len] = '\0';
- return orig_utf8_str;
-}
-
-static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1);
-
-/* Converts a string in the UTF-8 encoding to a newly allocated string in the
- * UTF-16 encoding. */
-char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
- size_t *utf16_len_ret)
+static void seed_random()
{
- if (cd_utf8_to_utf16 == (iconv_t)(-1)) {
- cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8");
- if (cd_utf8_to_utf16 == (iconv_t)-1) {
- ERROR("Failed to get conversion descriptor for "
- "converting UTF-8 to UTF-16LE: %m\n");
- return NULL;
- }
- }
-
- size_t utf8_bytes_left = utf8_len;
- size_t utf16_capacity = utf8_len * 4;
- size_t utf16_bytes_left = utf16_capacity;
-
- char *utf16_str = MALLOC(utf16_capacity + 2);
- if (!utf16_str)
- return NULL;
-
- char *orig_utf16_str = utf16_str;
-
- size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str,
- &utf8_bytes_left, &utf16_str, &utf16_bytes_left);
-
- if (num_chars_converted == (size_t)(-1)) {
- ERROR("Failed to convert UTF-8 string to UTF-16LE string: "
- "%s\n",
- (errno == E2BIG) ?
- "Not enough room in output buffer" :
- strerror(errno));
- FREE(orig_utf16_str);
- return NULL;
- }
-
- size_t utf16_len = utf16_capacity - utf16_bytes_left;
-
- *utf16_len_ret = utf16_len;
- orig_utf16_str[utf16_len] = '\0';
- orig_utf16_str[utf16_len + 1] = '\0';
- return orig_utf16_str;
+ srand(time(NULL) * getpid());
+ seeded = true;
}
-/* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and
- * on short writes.
- *
- * Returns short count and set errno on failure. */
-ssize_t full_write(int fd, const void *buf, size_t n)
-{
- const char *p = buf;
- ssize_t ret;
- ssize_t total = 0;
-
- while (total != n) {
- ret = write(fd, p, n);
- if (ret < 0) {
- if (errno == EINTR)
- continue;
- else
- break;
- }
- total += ret;
- p += ret;
- }
- return total;
-}
-
-
-static bool seeded = false;
-
/* Fills @n bytes pointed to by @p with random alphanumeric characters. */
void randomize_char_array_with_alnum(char p[], size_t n)
{
- int r;
-
- if (!seeded) {
- srand(time(NULL));
- seeded = true;
- }
+ if (!seeded)
+ seed_random();
while (n--) {
- r = rand() % 62;
+ int r = rand() % 62;
if (r < 26)
*p++ = r + 'a';
else if (r < 52)
}
/* Fills @n bytes pointer to by @p with random numbers. */
-void randomize_byte_array(void *__p, size_t n)
+void randomize_byte_array(u8 *p, size_t n)
{
- u8 *p = __p;
-
- if (!seeded) {
- srand(time(NULL));
- seeded = true;
- }
+ if (!seeded)
+ seed_random();
while (n--)
*p++ = rand();
}
p--;
/* Trailing slashes. */
- while ((p != path - 1) && *p == '/')
+ while (1) {
+ if (p == path - 1)
+ return "";
+ if (*p != '/')
+ break;
p--;
+ }
while ((p != path - 1) && *p != '/')
p--;
return p + 1;
}
-/*
+/*
+ * Returns a pointer to the part of @path following the first colon in the last
+ * path component, or NULL if the last path component does not contain a colon.
+ */
+const char *path_stream_name(const char *path)
+{
+ const char *base = path_basename(path);
+ const char *stream_name = strchr(base, ':');
+ if (!stream_name)
+ return NULL;
+ else
+ return stream_name + 1;
+}
+
+/*
* Splits a file path into the part before the first '/', or the entire name if
* there is no '/', and the part after the first sequence of '/' characters.
*
* @first_part_len_ret: A pointer to a `size_t' into which the length of the
* first part of the path will be returned.
* @return: A pointer to the next part of the path, after the first
- * sequence of '/', or a pointer to the terminating
+ * sequence of '/', or a pointer to the terminating
* null byte in the case of a path without any '/'.
*/
const char *path_next_part(const char *path, size_t *first_part_len_ret)
}
-/*
+/*
* Prints a string. Printable characters are printed as-is, while unprintable
- * characters are printed as their octal escape codes.
+ * characters are printed as their octal escape codes.
*/
void print_string(const void *string, size_t len)
{
}
}
-/* Calculates the SHA1 message digest given the name of a file.
- * @buf must point to a buffer of length 20 bytes into which the message digest
- * is written.
- */
-int sha1sum(const char *filename, void *buf)
+u64 get_wim_timestamp()
{
- FILE *fp;
- int ret;
+ struct timeval tv;
+ gettimeofday(&tv, NULL);
+ return timeval_to_wim_timestamp(&tv);
+}
- fp = fopen(filename, "rb");
- if (!fp) {
- ERROR("Cannot open the file `%s' for reading: %m\n", filename);
- return WIMLIB_ERR_OPEN;
- }
- ret = sha1_stream(fp, buf);
- fclose(fp);
- return ret;
+void wim_timestamp_to_str(u64 timestamp, char *buf, size_t len)
+{
+ struct tm tm;
+ time_t t = wim_timestamp_to_unix(timestamp);
+ gmtime_r(&t, &tm);
+ strftime(buf, len, "%a %b %d %H:%M:%S %Y UTC", &tm);
}
git://wimlib.net / wimlib / blobdiff