From efe48ccca651240d8e6d8dbabdedcbbdb2953468 Mon Sep 17 00:00:00 2001 From: Andrei Medar Date: Thu, 1 Oct 2020 00:15:33 +0000 Subject: [PATCH] Added unit tests. Cleaned up the code and added comments. Added README --- oss-internship-2020/libarchive/CMakeLists.txt | 32 +- oss-internship-2020/libarchive/README.md | 53 + .../libarchive/examples/CMakeLists.txt | 15 +- .../libarchive/examples/orig/minitar.cc | 478 ------- .../libarchive/examples/orig/tarfilter.cc | 113 -- .../libarchive/examples/orig/untar.cc | 277 ---- .../libarchive/examples/sandbox.h | 26 +- .../libarchive/examples/sapi_minitar.cc | 84 +- .../libarchive/examples/sapi_minitar.h | 44 +- .../libarchive/examples/sapi_minitar_main.cc | 18 + .../libarchive/files_diff/archive.h | 1198 ----------------- .../libarchive/files_diff/archive2.h | 1198 ----------------- .../libarchive/files_diff/archive_virtual.c | 163 --- .../libarchive/files_diff/archive_virtual2.c | 163 --- .../libarchive/test/CMakeLists.txt | 16 +- .../libarchive/test/minitar_test.cc | 210 ++- 16 files changed, 353 insertions(+), 3735 deletions(-) delete mode 100644 oss-internship-2020/libarchive/examples/orig/minitar.cc delete mode 100644 oss-internship-2020/libarchive/examples/orig/tarfilter.cc delete mode 100644 oss-internship-2020/libarchive/examples/orig/untar.cc delete mode 100644 oss-internship-2020/libarchive/files_diff/archive.h delete mode 100644 oss-internship-2020/libarchive/files_diff/archive2.h delete mode 100644 oss-internship-2020/libarchive/files_diff/archive_virtual.c delete mode 100644 oss-internship-2020/libarchive/files_diff/archive_virtual2.c diff --git a/oss-internship-2020/libarchive/CMakeLists.txt b/oss-internship-2020/libarchive/CMakeLists.txt index 78e30b0..9edc746 100644 --- a/oss-internship-2020/libarchive/CMakeLists.txt +++ b/oss-internship-2020/libarchive/CMakeLists.txt @@ -22,33 +22,8 @@ set(CMAKE_CXX_STANDARD_REQUIRED 17) # Build SAPI library set(SAPI_ROOT "/usr/local/google/home/amedar/internship/sandboxed-api" CACHE PATH "Path to the Sandboxed API source tree") -file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/patches") - -#add_custom_command( -# OUTPUT "${PROJECT_BINARY_DIR}/patches/archive.h" -# COMMENT "Applying patches." -# COMMAND cp "${PROJECT_SOURCE_DIR}/patches/header.patch" "${PROJECT_BINARY_DIR}/patches/" -# COMMAND cp "${PROJECT_SOURCE_DIR}/libarchive/libarchive/archive.h" "${PROJECT_BINARY_DIR}/patches/" -# COMMAND cd "${PROJECT_BINARY_DIR}/patches" && patch < header.patch -# COMMAND cp "${PROJECT_BINARY_DIR}/patches/archive.h" "${PROJECT_SOURCE_DIR}/libarchive/libarchive/" -#) -# -#set_property( -# SOURCE -# "${PROJECT_SOURCE_DIR}/libarchive/libarchive/archive.h" -# APPEND PROPERTY OBJECT_DEPENDS -# "${PROJECT_BINARY_DIR}/patches/archive.h" -#) - - add_subdirectory(libarchive) -#set_property(SOURCE -# "${PROJECT_SOURCE_DIR}/libarchive/libarchive/archive.h" -# APPEND PROPERTY OBJECT_DEPENDS -# "${PROJECT_SOURCE_DIR}/patches/archive.h" -#) - add_subdirectory("${SAPI_ROOT}" "${CMAKE_BINARY_DIR}/sandboxed-api-build" EXCLUDE_FROM_ALL @@ -62,8 +37,8 @@ add_sapi_library( FUNCTIONS ${FUNCTIONS_LIST} INPUTS - libarchive/libarchive/archive.h - libarchive/libarchive/archive_entry.h + libarchive/libarchive/archive.h + libarchive/libarchive/archive_entry.h LIBRARY archive_static LIBRARY_NAME Libarchive @@ -74,6 +49,5 @@ target_include_directories(libarchive_sapi INTERFACE "${PROJECT_BINARY_DIR}" # To find the generated SAPI header ) - add_subdirectory(examples) -add_subdirectory(test) +add_subdirectory(test) \ No newline at end of file diff --git a/oss-internship-2020/libarchive/README.md b/oss-internship-2020/libarchive/README.md index e69de29..4b921d9 100644 --- a/oss-internship-2020/libarchive/README.md +++ b/oss-internship-2020/libarchive/README.md @@ -0,0 +1,53 @@ +# libarchive Sandboxed API + +Sandboxed version of the [libarchive](https://www.libarchive.org/) minitar [example](https://github.com/libarchive/libarchive/blob/master/examples/minitar/minitar.c) using [Sandboxed API](https://github.com/google/sandboxed-api). + +## Build + +First, run `git submodule update --init --recursive` to update submodules. +After this, run the following commands: + +`mkdir -p build && cd build` + +`cmake .. -G Ninja` + +`cmake --build .` + + +The example binary file can be found at `build/examples/sapi_minitar` and the unit tests at `build/test/sapi_minitar_test`. + +## Patches +TODO + +## Examples + +In this project, the minitar example is sandboxed. +The code is found in the **examples** directory and is structured as follows: +- **sapi_minitar_main.cc** - ***main*** function of the minitar tool. This is mostly similar to the original example. +- **sapi_minitar.h** and **sapi_minitar.cc** - The two main functions (***create*** and ***extract***) and also other helper functions. +- **sandbox.h** - Custom security policies, depending on the whether the user creates or extracts an archive. + + +On top of that, unit tests can be found in the **test/minitar_test.cc** file. + +## Usage + +The unit tests can be executed with `./build/test/sapi_minitar_test`. + +The **sapi_minitar** command line tool can be used in the same way as the original example. It is also similar to the [tar](https://man7.org/linux/man-pages/man1/tar.1.html) command, only with fewer options: + +`./build/examples/sapi_minitar -[options] [-f file] [files]` + +The available options are: +- *c* - Create archive. +- *x* - Extract archive. +- *t* - Extract archive but only print entries. +- *p* - Preserve. +- *v* - Verbose. +- *j* or *y* - Compress with BZIP2. +- *Z* - Default compression. +- *z* - Compress with GZIP. + +If no compression method is chosen (in the case of archive creation) the files will only be archived. + + diff --git a/oss-internship-2020/libarchive/examples/CMakeLists.txt b/oss-internship-2020/libarchive/examples/CMakeLists.txt index 468b7bf..fd97002 100644 --- a/oss-internship-2020/libarchive/examples/CMakeLists.txt +++ b/oss-internship-2020/libarchive/examples/CMakeLists.txt @@ -30,7 +30,7 @@ target_link_libraries(sapi_minitar_lib PUBLIC ) target_include_directories(sapi_minitar_lib INTERFACE -"${PROJECT_SOURCE_DIR}/examples" + "${PROJECT_SOURCE_DIR}/examples" ) add_executable(sapi_minitar @@ -38,16 +38,5 @@ add_executable(sapi_minitar ) target_link_libraries(sapi_minitar PRIVATE - #libarchive_sapi - #sapi::sapi sapi_minitar_lib - #glog::glog -) - -add_executable(minitar - orig/minitar.cc -) - -target_link_libraries(minitar PRIVATE - archive -) +) \ No newline at end of file diff --git a/oss-internship-2020/libarchive/examples/orig/minitar.cc b/oss-internship-2020/libarchive/examples/orig/minitar.cc deleted file mode 100644 index 6d956d3..0000000 --- a/oss-internship-2020/libarchive/examples/orig/minitar.cc +++ /dev/null @@ -1,478 +0,0 @@ -/*- - * This file is in the public domain. - * Do with it as you will. - */ - -/*- - * This is a compact "tar" program whose primary goal is small size. - * Statically linked, it can be very small indeed. This serves a number - * of goals: - * o a testbed for libarchive (to check for link pollution), - * o a useful tool for space-constrained systems (boot floppies, etc), - * o a place to experiment with new implementation ideas for bsdtar, - * o a small program to demonstrate libarchive usage. - * - * Use the following macros to suppress features: - * NO_BZIP2 - Implies NO_BZIP2_CREATE and NO_BZIP2_EXTRACT - * NO_BZIP2_CREATE - Suppress bzip2 compression support. - * NO_BZIP2_EXTRACT - Suppress bzip2 auto-detection and decompression. - * NO_COMPRESS - Implies NO_COMPRESS_CREATE and NO_COMPRESS_EXTRACT - * NO_COMPRESS_CREATE - Suppress compress(1) compression support - * NO_COMPRESS_EXTRACT - Suppress compress(1) auto-detect and decompression. - * NO_CREATE - Suppress all archive creation support. - * NO_CPIO_EXTRACT - Suppress auto-detect and dearchiving of cpio archives. - * NO_GZIP - Implies NO_GZIP_CREATE and NO_GZIP_EXTRACT - * NO_GZIP_CREATE - Suppress gzip compression support. - * NO_GZIP_EXTRACT - Suppress gzip auto-detection and decompression. - * NO_LOOKUP - Try to avoid getpw/getgr routines, which can be very large - * NO_TAR_EXTRACT - Suppress tar extraction - * - * With all of the above macros defined (except NO_TAR_EXTRACT), you - * get a very small program that can recognize and extract essentially - * any uncompressed tar archive. On FreeBSD 5.1, this minimal program - * is under 64k, statically linked, which compares rather favorably to - * main(){printf("hello, world");} - * which is over 60k statically linked on the same operating system. - * Without any of the above macros, you get a static executable of - * about 180k with a lot of very sophisticated modern features. - * Obviously, it's trivial to add support for ISO, Zip, mtree, - * lzma/xz, etc. Just fill in the appropriate setup calls. - */ - -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include - -/* - * NO_CREATE implies NO_BZIP2_CREATE and NO_GZIP_CREATE and NO_COMPRESS_CREATE. - */ -#ifdef NO_CREATE -#undef NO_BZIP2_CREATE -#define NO_BZIP2_CREATE -#undef NO_COMPRESS_CREATE -#define NO_COMPRESS_CREATE -#undef NO_GZIP_CREATE -#define NO_GZIP_CREATE -#endif - -/* - * The combination of NO_BZIP2_CREATE and NO_BZIP2_EXTRACT is - * equivalent to NO_BZIP2. - */ -#ifdef NO_BZIP2_CREATE -#ifdef NO_BZIP2_EXTRACT -#undef NO_BZIP2 -#define NO_BZIP2 -#endif -#endif - -#ifdef NO_BZIP2 -#undef NO_BZIP2_EXTRACT -#define NO_BZIP2_EXTRACT -#undef NO_BZIP2_CREATE -#define NO_BZIP2_CREATE -#endif - -/* - * The combination of NO_COMPRESS_CREATE and NO_COMPRESS_EXTRACT is - * equivalent to NO_COMPRESS. - */ -#ifdef NO_COMPRESS_CREATE -#ifdef NO_COMPRESS_EXTRACT -#undef NO_COMPRESS -#define NO_COMPRESS -#endif -#endif - -#ifdef NO_COMPRESS -#undef NO_COMPRESS_EXTRACT -#define NO_COMPRESS_EXTRACT -#undef NO_COMPRESS_CREATE -#define NO_COMPRESS_CREATE -#endif - -/* - * The combination of NO_GZIP_CREATE and NO_GZIP_EXTRACT is - * equivalent to NO_GZIP. - */ -#ifdef NO_GZIP_CREATE -#ifdef NO_GZIP_EXTRACT -#undef NO_GZIP -#define NO_GZIP -#endif -#endif - -#ifdef NO_GZIP -#undef NO_GZIP_EXTRACT -#define NO_GZIP_EXTRACT -#undef NO_GZIP_CREATE -#define NO_GZIP_CREATE -#endif - -#ifndef NO_CREATE -static void create(const char *filename, int compress, const char **argv); -#endif -static void errmsg(const char *); -static void extract(const char *filename, int do_extract, int flags); -static int copy_data(struct archive *, struct archive *); -static void msg(const char *); -static void usage(void); - -static int verbose = 0; - -int -main(int argc, const char **argv) -{ - std::cout << "BEGIN\n"; - const char *filename = NULL; - int compress, flags, mode, opt; - - (void)argc; - mode = 'x'; - verbose = 0; - compress = '\0'; - flags = ARCHIVE_EXTRACT_TIME; - - /* Among other sins, getopt(3) pulls in printf(3). */ - while (*++argv != NULL && **argv == '-') { - const char *p = *argv + 1; - - while ((opt = *p++) != '\0') { - switch (opt) { -#ifndef NO_CREATE - case 'c': - mode = opt; - break; -#endif - case 'f': - if (*p != '\0') - filename = p; - else - filename = *++argv; - p += strlen(p); - break; -#ifndef NO_BZIP2_CREATE - case 'j': - compress = opt; - break; -#endif - case 'p': - flags |= ARCHIVE_EXTRACT_PERM; - flags |= ARCHIVE_EXTRACT_ACL; - flags |= ARCHIVE_EXTRACT_FFLAGS; - break; - case 't': - mode = opt; - break; - case 'v': - verbose++; - break; - case 'x': - mode = opt; - break; -#ifndef NO_BZIP2_CREATE - case 'y': - compress = opt; - break; -#endif -#ifndef NO_COMPRESS_CREATE - case 'Z': - compress = opt; - break; -#endif -#ifndef NO_GZIP_CREATE - case 'z': - compress = opt; - break; -#endif - default: - usage(); - } - } - } - - switch (mode) { -#ifndef NO_CREATE - case 'c': - create(filename, compress, argv); - break; -#endif - case 't': - extract(filename, 0, flags); - break; - case 'x': - extract(filename, 1, flags); - break; - } - - return (0); -} - - -#ifndef NO_CREATE -static char buff[16384]; - -static void -create(const char *filename, int compress, const char **argv) -{ - - std::cout << "CREATE FILENAME=" << filename << std::endl; - struct archive *a; - struct archive_entry *entry; - ssize_t len; - int fd; - - a = archive_write_new(); - switch (compress) { -#ifndef NO_BZIP2_CREATE - case 'j': case 'y': - archive_write_add_filter_bzip2(a); - break; -#endif -#ifndef NO_COMPRESS_CREATE - case 'Z': - archive_write_add_filter_compress(a); - break; -#endif -#ifndef NO_GZIP_CREATE - case 'z': - archive_write_add_filter_gzip(a); - break; -#endif - default: - archive_write_add_filter_none(a); - break; - } - archive_write_set_format_ustar(a); - if (filename != NULL && strcmp(filename, "-") == 0) - filename = NULL; - archive_write_open_filename(a, filename); - - while (*argv != NULL) { - std::cout << "handling file = " << *argv << std::endl; - struct archive *disk = archive_read_disk_new(); -#ifndef NO_LOOKUP - archive_read_disk_set_standard_lookup(disk); -#endif - int r; - - r = archive_read_disk_open(disk, *argv); - if (r != ARCHIVE_OK) { - errmsg(archive_error_string(disk)); - errmsg("\n"); - exit(1); - } - - for (;;) { - int needcr = 0; - - entry = archive_entry_new(); - r = archive_read_next_header2(disk, entry); - if (r == ARCHIVE_EOF) - break; - if (r != ARCHIVE_OK) { - errmsg(archive_error_string(disk)); - errmsg("\n"); - exit(1); - } - archive_read_disk_descend(disk); - if (verbose) { - msg("a "); - msg(archive_entry_pathname(entry)); - needcr = 1; - } - r = archive_write_header(a, entry); - if (r < ARCHIVE_OK) { - std::cout << " --- error here, code = " << r << " --- " << std::endl; - errmsg(": "); - errmsg(archive_error_string(a)); - needcr = 1; - } - if (r == ARCHIVE_FATAL) - exit(1); - if (r > ARCHIVE_FAILED) { -#if 0 - /* Ideally, we would be able to use - * the same code to copy a body from - * an archive_read_disk to an - * archive_write that we use for - * copying data from an archive_read - * to an archive_write_disk. - * Unfortunately, this doesn't quite - * work yet. */ - copy_data(disk, a); -#else - /* For now, we use a simpler loop to copy data - * into the target archive. */ - fd = open(archive_entry_sourcepath(entry), O_RDONLY); - len = read(fd, buff, sizeof(buff)); - while (len > 0) { - archive_write_data(a, buff, len); - len = read(fd, buff, sizeof(buff)); - } - close(fd); -#endif - } - archive_entry_free(entry); - if (needcr) - msg("\n"); - } - archive_read_close(disk); - archive_read_free(disk); - argv++; - } - archive_write_close(a); - archive_write_free(a); -} -#endif - -static void -extract(const char *filename, int do_extract, int flags) -{ - - struct archive *a; - struct archive *ext; - struct archive_entry *entry; - int r; - - a = archive_read_new(); - ext = archive_write_disk_new(); - archive_write_disk_set_options(ext, flags); -#ifndef NO_BZIP2_EXTRACT - archive_read_support_filter_bzip2(a); -#endif -#ifndef NO_GZIP_EXTRACT - archive_read_support_filter_gzip(a); -#endif -#ifndef NO_COMPRESS_EXTRACT - archive_read_support_filter_compress(a); -#endif -#ifndef NO_TAR_EXTRACT - archive_read_support_format_tar(a); -#endif -#ifndef NO_CPIO_EXTRACT - archive_read_support_format_cpio(a); -#endif -#ifndef NO_LOOKUP - archive_write_disk_set_standard_lookup(ext); -#endif - if (filename != NULL && strcmp(filename, "-") == 0) - filename = NULL; - if ((r = archive_read_open_filename(a, filename, 10240))) { - errmsg(archive_error_string(a)); - errmsg("\n"); - exit(r); - } - for (;;) { - int needcr = 0; - r = archive_read_next_header(a, &entry); - if (r == ARCHIVE_EOF) - break; - if (r != ARCHIVE_OK) { - errmsg(archive_error_string(a)); - errmsg("\n"); - exit(1); - } - if (verbose && do_extract) - msg("x "); - if (verbose || !do_extract) { - msg(archive_entry_pathname(entry)); - msg(" "); - needcr = 1; - } - if (do_extract) { - r = archive_write_header(ext, entry); - if (r != ARCHIVE_OK) { - errmsg(archive_error_string(a)); - needcr = 1; - } - else { - r = copy_data(a, ext); - if (r != ARCHIVE_OK) - needcr = 1; - } - } - if (needcr) - msg("\n"); - } - archive_read_close(a); - archive_read_free(a); - - archive_write_close(ext); - archive_write_free(ext); - exit(0); -} - -static int -copy_data(struct archive *ar, struct archive *aw) -{ - int r; - const void *buff; - size_t size; - int64_t offset; - - for (;;) { - r = archive_read_data_block(ar, &buff, &size, &offset); - if (r == ARCHIVE_EOF) - return (ARCHIVE_OK); - if (r != ARCHIVE_OK) { - errmsg(archive_error_string(ar)); - return (r); - } - r = archive_write_data_block(aw, buff, size, offset); - if (r != ARCHIVE_OK) { - errmsg(archive_error_string(ar)); - return (r); - } - } -} - -static void -msg(const char *m) -{ - write(1, m, strlen(m)); -} - -static void -errmsg(const char *m) -{ - if (m == NULL) { - m = "Error: No error description provided.\n"; - } - write(2, m, strlen(m)); -} - -static void -usage(void) -{ -/* Many program options depend on compile options. */ - const char *m = "Usage: minitar [-" -#ifndef NO_CREATE - "c" -#endif -#ifndef NO_BZIP2 - "j" -#endif - "tvx" -#ifndef NO_BZIP2 - "y" -#endif -#ifndef NO_COMPRESS - "Z" -#endif -#ifndef NO_GZIP - "z" -#endif - "] [-f file] [file]\n"; - - errmsg(m); - exit(1); -} diff --git a/oss-internship-2020/libarchive/examples/orig/tarfilter.cc b/oss-internship-2020/libarchive/examples/orig/tarfilter.cc deleted file mode 100644 index 0d323e1..0000000 --- a/oss-internship-2020/libarchive/examples/orig/tarfilter.cc +++ /dev/null @@ -1,113 +0,0 @@ -/* - * This file is in the public domain. - * - * Feel free to use it as you wish. - */ - -/* - * This example program reads an archive from stdin (which can be in - * any format recognized by libarchive) and writes certain entries to - * an uncompressed ustar archive on stdout. This is a template for - * many kinds of archive manipulation: converting formats, resetting - * ownership, inserting entries, removing entries, etc. - * - * To compile: - * gcc -Wall -o tarfilter tarfilter.c -larchive -lz -lbz2 - */ - -#include -#include -#include -#include -#include -#include - -static void -die(char *fmt, ...) -{ - va_list ap; - - va_start(ap, fmt); - vfprintf(stderr, fmt, ap); - va_end(ap); - fprintf(stderr, "\n"); - exit(1); -} - -int -main(int argc, char **argv) -{ - char buff[8192]; - ssize_t len; - int r; - mode_t m; - struct archive *ina; - struct archive *outa; - struct archive_entry *entry; - - /* Read an archive from stdin, with automatic format detection. */ - ina = archive_read_new(); - if (ina == NULL) - die("Couldn't create archive reader."); - if (archive_read_support_filter_all(ina) != ARCHIVE_OK) - die("Couldn't enable decompression"); - if (archive_read_support_format_all(ina) != ARCHIVE_OK) - die("Couldn't enable read formats"); - if (archive_read_open_fd(ina, 0, 10240) != ARCHIVE_OK) - die("Couldn't open input archive"); - - /* Write an uncompressed ustar archive to stdout. */ - outa = archive_write_new(); - if (outa == NULL) - die("Couldn't create archive writer."); - if (archive_write_set_compression_none(outa) != ARCHIVE_OK) - die("Couldn't enable compression"); - if (archive_write_set_format_ustar(outa) != ARCHIVE_OK) - die("Couldn't set output format"); - if (archive_write_open_fd(outa, 1) != ARCHIVE_OK) - die("Couldn't open output archive"); - - /* Examine each entry in the input archive. */ - while ((r = archive_read_next_header(ina, &entry)) == ARCHIVE_OK) { - fprintf(stderr, "%s: ", archive_entry_pathname(entry)); - - /* Skip anything that isn't a regular file. */ - if (!S_ISREG(archive_entry_mode(entry))) { - fprintf(stderr, "skipped\n"); - continue; - } - - /* Make everything owned by root/wheel. */ - archive_entry_set_uid(entry, 0); - archive_entry_set_uname(entry, "root"); - archive_entry_set_gid(entry, 0); - archive_entry_set_gname(entry, "wheel"); - - /* Make everything permission 0744, strip SUID, etc. */ - m = archive_entry_mode(entry); - archive_entry_set_mode(entry, (m & ~07777) | 0744); - - /* Copy input entries to output archive. */ - if (archive_write_header(outa, entry) != ARCHIVE_OK) - die("Error writing output archive"); - if (archive_entry_size(entry) > 0) { - len = archive_read_data(ina, buff, sizeof(buff)); - while (len > 0) { - if (archive_write_data(outa, buff, len) != len) - die("Error writing output archive"); - len = archive_read_data(ina, buff, sizeof(buff)); - } - if (len < 0) - die("Error reading input archive"); - } - fprintf(stderr, "copied\n"); - } - if (r != ARCHIVE_EOF) - die("Error reading archive"); - /* Close the archives. */ - if (archive_read_free(ina) != ARCHIVE_OK) - die("Error closing input archive"); - if (archive_write_free(outa) != ARCHIVE_OK) - die("Error closing output archive"); - return (0); -} diff --git a/oss-internship-2020/libarchive/examples/orig/untar.cc b/oss-internship-2020/libarchive/examples/orig/untar.cc deleted file mode 100644 index 7f06c5b..0000000 --- a/oss-internship-2020/libarchive/examples/orig/untar.cc +++ /dev/null @@ -1,277 +0,0 @@ -/* - * This file is in the public domain. - * Use it as you wish. - */ - -/* - * This is a compact tar extraction program using libarchive whose - * primary goal is small executable size. Statically linked, it can - * be very small, depending in large part on how cleanly factored your - * system libraries are. Note that this uses the standard libarchive, - * without any special recompilation. The only functional concession - * is that this program uses the uid/gid from the archive instead of - * doing uname/gname lookups. (Add a call to - * archive_write_disk_set_standard_lookup() to enable uname/gname - * lookups, but be aware that this can add 500k or more to a static - * executable, depending on the system libraries, since user/group - * lookups frequently pull in password, YP/LDAP, networking, and DNS - * resolver libraries.) - * - * To build: - * $ gcc -static -Wall -o untar untar.c -larchive - * $ strip untar - * - * NOTE: On some systems, you may need to add additional flags - * to ensure that untar.c is compiled the same way as libarchive - * was compiled. In particular, Linux users will probably - * have to add -D_FILE_OFFSET_BITS=64 to the command line above. - * - * For fun, statically compile the following simple hello.c program - * using the same flags as for untar and compare the size: - * - * #include - * int main(int argc, char **argv) { - * printf("hello, world\n"); - * return(0); - * } - * - * You may be even more surprised by the compiled size of true.c listed here: - * - * int main(int argc, char **argv) { - * return (0); - * } - * - * On a slightly customized FreeBSD 5 system that I used around - * 2005, hello above compiled to 89k compared to untar of 69k. So at - * that time, libarchive's tar reader and extract-to-disk routines - * compiled to less code than printf(). - * - * On my FreeBSD development system today (August, 2009): - * hello: 195024 bytes - * true: 194912 bytes - * untar: 259924 bytes - */ - -#include -#include - -#include - -#include -#include -#include -#include -#include -#include -#include - -static void errmsg(const char *); -static void extract(const char *filename, int do_extract, int flags); -static void fail(const char *, const char *, int); -static int copy_data(struct archive *, struct archive *); -static void msg(const char *); -static void usage(void); -static void warn(const char *, const char *); - -static int verbose = 0; - -int -main(int argc, const char **argv) -{ - const char *filename = NULL; - int compress, flags, mode, opt; - - (void)argc; - mode = 'x'; - verbose = 0; - compress = '\0'; - flags = ARCHIVE_EXTRACT_TIME; - - /* Among other sins, getopt(3) pulls in printf(3). */ - while (*++argv != NULL && **argv == '-') { - const char *p = *argv + 1; - - while ((opt = *p++) != '\0') { - switch (opt) { - case 'f': - if (*p != '\0') - filename = p; - else - filename = *++argv; - p += strlen(p); - break; - case 'p': - flags |= ARCHIVE_EXTRACT_PERM; - flags |= ARCHIVE_EXTRACT_ACL; - flags |= ARCHIVE_EXTRACT_FFLAGS; - break; - case 't': - mode = opt; - break; - case 'v': - verbose++; - break; - case 'x': - mode = opt; - break; - default: - usage(); - } - } - } - - std::cout << "begin\n"; - - switch (mode) { - case 't': - extract(filename, 0, flags); - break; - case 'x': - extract(filename, 1, flags); - break; - } - - std::cout << "end"; - - return (0); -} - - -static void -extract(const char *filename, int do_extract, int flags) -{ - struct archive *a; - struct archive *ext; - struct archive_entry *entry; - int r; - - a = archive_read_new(); - ext = archive_write_disk_new(); - archive_write_disk_set_options(ext, flags); - /* - * Note: archive_write_disk_set_standard_lookup() is useful - * here, but it requires library routines that can add 500k or - * more to a static executable. - */ - archive_read_support_format_tar(a); - /* - * On my system, enabling other archive formats adds 20k-30k - * each. Enabling gzip decompression adds about 20k. - * Enabling bzip2 is more expensive because the libbz2 library - * isn't very well factored. - */ - - std::cout <<"AAA\n"; - if (filename != NULL && strcmp(filename, "-") == 0) - filename = NULL; - if ((r = archive_read_open_filename(a, filename, 10240))) - fail("archive_read_open_filename()", - archive_error_string(a), r); - - std::cout << "BBB\n"; - for (;;) { - r = archive_read_next_header(a, &entry); - if (r == ARCHIVE_EOF) - break; - if (r != ARCHIVE_OK) - fail("archive_read_next_header()", - archive_error_string(a), 1); - if (verbose && do_extract) - msg("x "); - if (verbose || !do_extract) - msg(archive_entry_pathname(entry)); - if (do_extract) { - r = archive_write_header(ext, entry); - if (r != ARCHIVE_OK) - warn("archive_write_header()", - archive_error_string(ext)); - else { - copy_data(a, ext); - r = archive_write_finish_entry(ext); - if (r != ARCHIVE_OK) - fail("archive_write_finish_entry()", - archive_error_string(ext), 1); - } - - } - if (verbose || !do_extract) - msg("\n"); - } - archive_read_close(a); - archive_read_free(a); - - archive_write_close(ext); - archive_write_free(ext); - exit(0); -} - -static int -copy_data(struct archive *ar, struct archive *aw) -{ - int r; - const void *buff; - size_t size; -#if ARCHIVE_VERSION_NUMBER >= 3000000 - int64_t offset; -#else - off_t offset; -#endif - - for (;;) { - r = archive_read_data_block(ar, &buff, &size, &offset); - if (r == ARCHIVE_EOF) - return (ARCHIVE_OK); - if (r != ARCHIVE_OK) - return (r); - r = archive_write_data_block(aw, buff, size, offset); - if (r != ARCHIVE_OK) { - warn("archive_write_data_block()", - archive_error_string(aw)); - return (r); - } - } -} - -/* - * These reporting functions use low-level I/O; on some systems, this - * is a significant code reduction. Of course, on many server and - * desktop operating systems, malloc() and even crt rely on printf(), - * which in turn pulls in most of the rest of stdio, so this is not an - * optimization at all there. (If you're going to pay 100k or more - * for printf() anyway, you may as well use it!) - */ -static void -msg(const char *m) -{ - write(1, m, strlen(m)); -} - -static void -errmsg(const char *m) -{ - write(2, m, strlen(m)); -} - -static void -warn(const char *f, const char *m) -{ - errmsg(f); - errmsg(" failed: "); - errmsg(m); - errmsg("\n"); -} - -static void -fail(const char *f, const char *m, int r) -{ - warn(f, m); - exit(r); -} - -static void -usage(void) -{ - const char *m = "Usage: untar [-tvx] [-f file] [file]\n"; - errmsg(m); - exit(1); -} diff --git a/oss-internship-2020/libarchive/examples/sandbox.h b/oss-internship-2020/libarchive/examples/sandbox.h index 1cdb285..2a8ca09 100644 --- a/oss-internship-2020/libarchive/examples/sandbox.h +++ b/oss-internship-2020/libarchive/examples/sandbox.h @@ -1,20 +1,28 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + #ifndef SAPI_LIBARCHIVE_SANDBOX_H #define SAPI_LIBARCHIVE_SANDBOX_H #include -#include -#include -#include -#include #include "libarchive_sapi.sapi.h" #include "sandboxed_api/sandbox2/util/fileops.h" -#include "sapi_minitar.h" -// #include "sandboxed_api/sandbox2/util/fileops.h" // When creating an archive, we need read permissions on each of the // file/directory added in the archive. Also, in order to create the archive, we -// map /output with the basename of the archive. This way, the program can +// map "/output" with the basename of the archive. This way, the program can // create the file without having access to anything else. class SapiLibarchiveSandboxCreate : public LibarchiveSandbox { public: @@ -54,7 +62,7 @@ class SapiLibarchiveSandboxCreate : public LibarchiveSandbox { __NR_getdents64, }); - // Here we only check whether the entry is a file or a directory. + // We check whether the entry is a file or a directory. for (const auto& i : files_) { struct stat s; stat(i.c_str(), &s); @@ -133,4 +141,4 @@ class SapiLibarchiveSandboxExtract : public LibarchiveSandbox { const int do_extract_; }; -#endif // SAPI_LIBARCHIVE_SANDBOX_H \ No newline at end of file +#endif // SAPI_LIBARCHIVE_SANDBOX_H diff --git a/oss-internship-2020/libarchive/examples/sapi_minitar.cc b/oss-internship-2020/libarchive/examples/sapi_minitar.cc index 7dd7b21..4f5984d 100644 --- a/oss-internship-2020/libarchive/examples/sapi_minitar.cc +++ b/oss-internship-2020/libarchive/examples/sapi_minitar.cc @@ -1,10 +1,23 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + #include "sapi_minitar.h" void create(const char* initial_filename, int compress, const char** argv, bool verbose /* = true */) { // We split the filename path into dirname and filename. To the filename we // prepend "/output/"" so that it will work with the security policy. - std::string abs_path = MakeAbsolutePathAtCWD(std::string(initial_filename)); auto [archive_path, filename_tmp] = std::move(sandbox2::file::SplitPath(abs_path)); @@ -24,16 +37,14 @@ void create(const char* initial_filename, int compress, const char** argv, std::transform(relative_paths.begin(), relative_paths.end(), relative_paths.begin(), sandbox2::file::CleanPath); - // At this point, we have the cleaned relative and absolute paths saved + // At this point, we have the relative and absolute paths (cleaned) saved // in vectors. - // Initialize sandbox and api object + // Initialize sandbox and api objects. SapiLibarchiveSandboxCreate sandbox(absolute_paths, archive_path); CHECK(sandbox.Init().ok()) << "Error during sandbox initialization"; LibarchiveApi api(&sandbox); - std::cout << "AJUNGE AICI" << std::endl; - absl::StatusOr ret = api.archive_write_new(); CHECK(ret.ok()) << "write_new call failed"; CHECK(ret.value() != NULL) << "Failed to create write archive"; @@ -42,8 +53,6 @@ void create(const char* initial_filename, int compress, const char** argv, // to the client process. sapi::v::RemotePtr a(ret.value()); - std::cout << "AJUNGE AICI" << std::endl; - absl::StatusOr ret2; switch (compress) { @@ -114,8 +123,6 @@ void create(const char* initial_filename, int compress, const char** argv, << CheckStatusAndGetString(api.archive_error_string(&disk), sandbox); for (;;) { - int needcr = 0; - absl::StatusOr ret3; ret3 = api.archive_entry_new(); @@ -139,14 +146,15 @@ void create(const char* initial_filename, int compress, const char** argv, // After using the absolute path before, we now need to add the pathname // to the archive entry. This would help store the files by their relative - // paths. However, in the case where a directory is added to the archive, - // all of the files inside of it are addes as well so we replace the - // absolute path prefix with the relative one. Example: we add the folder - // test_files which becomes /absolute/path/test_files and the files inside - // of it will become /absolute/path/test_files/file1 and we change it to - // test_files/file1 so that it is relative. This only changes the pathname - // so that relative paths are preserved. - + // paths(similar to the usual tar command). + // However, in the case where a directory is added to the archive, + // all of the files inside of it are added as well so we replace the + // absolute path prefix with the relative one. + // Example: + // we add the folder "test_files" which becomes + // "/absolute/path/test_files" and the files inside of it will become + // similar to "/absolute/path/test_files/file1" + // which we then change to "test_files/file1" so that it is relative. std::string path_name = CheckStatusAndGetString(api.archive_entry_pathname(&entry), sandbox); @@ -156,7 +164,6 @@ void create(const char* initial_filename, int compress, const char** argv, // On top of those changes, we need to remove leading '/' characters // and also remove everything up to the last occurrence of '../'. - size_t found = path_name.find_first_not_of("/"); if (found != std::string::npos) { path_name.erase(path_name.begin(), path_name.begin() + found); @@ -174,8 +181,8 @@ void create(const char* initial_filename, int compress, const char** argv, if (verbose) { std::cout << CheckStatusAndGetString(api.archive_entry_pathname(&entry), - sandbox); - needcr = 1; + sandbox) + << std::endl; } ret2 = api.archive_write_header(&a, &entry); @@ -183,8 +190,8 @@ void create(const char* initial_filename, int compress, const char** argv, if (ret2.value() < ARCHIVE_OK) { std::cout << CheckStatusAndGetString(api.archive_error_string(&a), - sandbox); - needcr = 1; + sandbox) + << std::endl; } CHECK(ret2.value() != ARCHIVE_FATAL) << "Unexpected result from write_header call"; @@ -204,12 +211,12 @@ void create(const char* initial_filename, int compress, const char** argv, sapi::v::Array buff(kBuffSize); sapi::v::UInt ssize(kBuffSize); - // We allocate the buffer remotely and then we can simply use the remote - // pointer. + // We allocate the buffer remotely and then we can simply use the + // remote pointer(with PtrNone). CHECK(sandbox.Allocate(&buff, true).ok()) << "Could not allocate remote buffer"; - // We can use sapi objects that help us with file descriptors. + // We can use sapi methods that help us with file descriptors. CHECK(sandbox.TransferToSandboxee(&sapi_fd).ok()) << "Could not transfer file descriptor"; @@ -230,12 +237,7 @@ void create(const char* initial_filename, int compress, const char** argv, // sapi_fd variable goes out of scope here so both the local and the // remote file descriptors are closed. } - CHECK(api.archive_entry_free(&entry).ok()) << "entry_free call failed"; - - if (needcr) { - std::cout << std::endl; - } } ret2 = api.archive_read_close(&disk); @@ -258,7 +260,6 @@ void create(const char* initial_filename, int compress, const char** argv, void extract(const char* filename, int do_extract, int flags, bool verbose /* = true */) { - std::cout << "flags = " << flags << std::endl; std::string tmp_dir; if (do_extract) { tmp_dir = CreateTempDirAtCWD(); @@ -275,17 +276,17 @@ void extract(const char* filename, int do_extract, int flags, // We should only delete it if the do_extract flag is true which // means that this struct is instantiated only in that case. - std::shared_ptr cleanup_ptr; + std::unique_ptr cleanup_ptr; if (do_extract) { - cleanup_ptr = std::make_unique(); + cleanup_ptr = absl::make_unique(); cleanup_ptr->dir = tmp_dir; } std::string filename_absolute = MakeAbsolutePathAtCWD(filename); + // Initialize sandbox and api objects. SapiLibarchiveSandboxExtract sandbox(filename_absolute, do_extract, tmp_dir); CHECK(sandbox.Init().ok()) << "Error during sandbox initialization"; - LibarchiveApi api(&sandbox); absl::StatusOr ret = api.archive_read_new(); @@ -350,7 +351,6 @@ void extract(const char* filename, int do_extract, int flags, sandbox); for (;;) { - int needcr = 0; sapi::v::IntBase entry_ptr_tmp(0); ret2 = api.archive_read_next_header(&a, entry_ptr_tmp.PtrAfter()); @@ -372,8 +372,7 @@ void extract(const char* filename, int do_extract, int flags, if (verbose || !do_extract) { std::cout << CheckStatusAndGetString(api.archive_entry_pathname(&entry), sandbox) - << " "; - needcr = 1; + << std::endl; } if (do_extract) { @@ -383,15 +382,10 @@ void extract(const char* filename, int do_extract, int flags, if (ret2.value() != ARCHIVE_OK) { std::cout << CheckStatusAndGetString(api.archive_error_string(&a), sandbox); - needcr = 1; - } else if (copy_data(&a, &ext, api, sandbox) != ARCHIVE_OK) { - needcr = 1; + } else { + copy_data(&a, &ext, api, sandbox); } } - - if (needcr) { - std::cout << std::endl; - } } ret2 = api.archive_read_close(&a); @@ -411,8 +405,6 @@ void extract(const char* filename, int do_extract, int flags, CHECK(!ret2.value()) << "Unexpected result from write_free call"; } -// This function is only called from the "extract function". It is still -// isolated in order to not modify the code structure as much. int copy_data(sapi::v::RemotePtr* ar, sapi::v::RemotePtr* aw, LibarchiveApi& api, SapiLibarchiveSandboxExtract& sandbox) { absl::StatusOr ret; diff --git a/oss-internship-2020/libarchive/examples/sapi_minitar.h b/oss-internship-2020/libarchive/examples/sapi_minitar.h index 4e02b3d..76632e5 100644 --- a/oss-internship-2020/libarchive/examples/sapi_minitar.h +++ b/oss-internship-2020/libarchive/examples/sapi_minitar.h @@ -1,54 +1,62 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + #ifndef SAPI_LIBARCHIVE_MINITAR_H #define SAPI_LIBARCHIVE_MINITAR_H #include #include #include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include #include "libarchive_sapi.sapi.h" #include "sandbox.h" #include "sandboxed_api/sandbox2/util.h" -#include "sandboxed_api/sandbox2/util/fileops.h" #include "sandboxed_api/sandbox2/util/path.h" #include "sandboxed_api/sandbox2/util/temp_file.h" -#include "sandboxed_api/var_array.h" +// Creates an archive file at the given filename. void create(const char* filename, int compress, const char** argv, bool verbose = true); +// Extracts an archive file. If do_extract is true, the files will +// be created relative to the current working directory. If do_extract +// is false then the function will just print the entries of the archive. void extract(const char* filename, int do_extract, int flags, bool verbose = true); +// This function is only called from the "extract function". It is still +// isolated in order to not modify the code structure as much. int copy_data(sapi::v::RemotePtr* ar, sapi::v::RemotePtr* aw, LibarchiveApi& api, SapiLibarchiveSandboxExtract& sandbox); inline constexpr size_t kBlockSize = 10240; inline constexpr size_t kBuffSize = 16384; -// Converts only one string to an absolute path by prepending the current -// working directory to the relative path +// Converts one string to an absolute path by prepending the current +// working directory to the relative path. +// The path is also cleaned at the end. std::string MakeAbsolutePathAtCWD(const std::string& path); // This function takes a status as argument and after checking the status // it transfers the string. This is used mostly with archive_error_string -// and other library functions that return a char *. +// and other library functions that return a char*. std::string CheckStatusAndGetString(const absl::StatusOr& status, LibarchiveSandbox& sandbox); // Creates a temporary directory in the current working directory and -// returns the path. This is used in the extract function where the sandbox -// changes the current working directory to this temporary directory. +// returns the path. This is used in the extract function where the sandboxed +// process changes the current working directory to this temporary directory. std::string CreateTempDirAtCWD(); #endif // SAPI_LIBARCHIVE_MINITAR_H diff --git a/oss-internship-2020/libarchive/examples/sapi_minitar_main.cc b/oss-internship-2020/libarchive/examples/sapi_minitar_main.cc index fb18f4a..c323600 100644 --- a/oss-internship-2020/libarchive/examples/sapi_minitar_main.cc +++ b/oss-internship-2020/libarchive/examples/sapi_minitar_main.cc @@ -1,4 +1,22 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// This file contains the main function from the original minitar example: +// https://github.com/libarchive/libarchive/blob/master/examples/minitar/minitar.c +// Most of the logic is the same, it was only simplified a bit since this is +// only used for the command line tool. +// No sandboxing takes place in this function. #include diff --git a/oss-internship-2020/libarchive/files_diff/archive.h b/oss-internship-2020/libarchive/files_diff/archive.h deleted file mode 100644 index a3f3bfd..0000000 --- a/oss-internship-2020/libarchive/files_diff/archive.h +++ /dev/null @@ -1,1198 +0,0 @@ -/*- - * Copyright (c) 2003-2010 Tim Kientzle - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.50 2008/05/26 17:00:22 kientzle Exp $ - */ - -#ifndef ARCHIVE_H_INCLUDED -#define ARCHIVE_H_INCLUDED - -/* - * The version number is expressed as a single integer that makes it - * easy to compare versions at build time: for version a.b.c, the - * version number is printf("%d%03d%03d",a,b,c). For example, if you - * know your application requires version 2.12.108 or later, you can - * assert that ARCHIVE_VERSION_NUMBER >= 2012108. - */ -/* Note: Compiler will complain if this does not match archive_entry.h! */ -#define ARCHIVE_VERSION_NUMBER 3004004 - -#include -#include /* for wchar_t */ -#include /* For FILE * */ -#include /* For time_t */ - -/* - * Note: archive.h is for use outside of libarchive; the configuration - * headers (config.h, archive_platform.h, etc.) are purely internal. - * Do NOT use HAVE_XXX configuration macros to control the behavior of - * this header! If you must conditionalize, use predefined compiler and/or - * platform macros. - */ -#if defined(__BORLANDC__) && __BORLANDC__ >= 0x560 -# include -#elif !defined(__WATCOMC__) && !defined(_MSC_VER) && !defined(__INTERIX) && !defined(__BORLANDC__) && !defined(_SCO_DS) && !defined(__osf__) && !defined(__CLANG_INTTYPES_H) -# include -#endif - -/* Get appropriate definitions of 64-bit integer */ -#if !defined(__LA_INT64_T_DEFINED) -/* Older code relied on the __LA_INT64_T macro; after 4.0 we'll switch to the typedef exclusively. */ -# if ARCHIVE_VERSION_NUMBER < 4000000 -#define __LA_INT64_T la_int64_t -# endif -#define __LA_INT64_T_DEFINED -# if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__) -typedef __int64 la_int64_t; -# else -# include /* ssize_t */ -# if defined(_SCO_DS) || defined(__osf__) -typedef long long la_int64_t; -# else -typedef int64_t la_int64_t; -# endif -# endif -#endif - -/* The la_ssize_t should match the type used in 'struct stat' */ -#if !defined(__LA_SSIZE_T_DEFINED) -/* Older code relied on the __LA_SSIZE_T macro; after 4.0 we'll switch to the typedef exclusively. */ -# if ARCHIVE_VERSION_NUMBER < 4000000 -#define __LA_SSIZE_T la_ssize_t -# endif -#define __LA_SSIZE_T_DEFINED -# if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__) -# if defined(_SSIZE_T_DEFINED) || defined(_SSIZE_T_) -typedef ssize_t la_ssize_t; -# elif defined(_WIN64) -typedef __int64 la_ssize_t; -# else -typedef long la_ssize_t; -# endif -# else -# include /* ssize_t */ -typedef ssize_t la_ssize_t; -# endif -#endif - -/* Large file support for Android */ -#ifdef __ANDROID__ -#include "android_lf.h" -#endif - -/* - * On Windows, define LIBARCHIVE_STATIC if you're building or using a - * .lib. The default here assumes you're building a DLL. Only - * libarchive source should ever define __LIBARCHIVE_BUILD. - */ -#if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC) -# ifdef __LIBARCHIVE_BUILD -# ifdef __GNUC__ -# define __LA_DECL __attribute__((dllexport)) extern -# else -# define __LA_DECL __declspec(dllexport) -# endif -# else -# ifdef __GNUC__ -# define __LA_DECL -# else -# define __LA_DECL __declspec(dllimport) -# endif -# endif -#else -/* Static libraries or non-Windows needs no special declaration. */ -# define __LA_DECL -#endif - -#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(__MINGW32__) -#define __LA_PRINTF(fmtarg, firstvararg) \ - __attribute__((__format__ (__printf__, fmtarg, firstvararg))) -#else -#define __LA_PRINTF(fmtarg, firstvararg) /* nothing */ -#endif - -#if defined(__GNUC__) && __GNUC__ >= 3 && __GNUC_MINOR__ >= 1 -# define __LA_DEPRECATED __attribute__((deprecated)) -#else -# define __LA_DEPRECATED -#endif - -#ifdef __cplusplus -extern "C" { -#endif - -/* - * The version number is provided as both a macro and a function. - * The macro identifies the installed header; the function identifies - * the library version (which may not be the same if you're using a - * dynamically-linked version of the library). Of course, if the - * header and library are very different, you should expect some - * strangeness. Don't do that. - */ -__LA_DECL int archive_version_number(void); - -/* - * Textual name/version of the library, useful for version displays. - */ -#define ARCHIVE_VERSION_ONLY_STRING "3.4.4dev" -#define ARCHIVE_VERSION_STRING "libarchive " ARCHIVE_VERSION_ONLY_STRING -__LA_DECL const char * archive_version_string(void); - -/* - * Detailed textual name/version of the library and its dependencies. - * This has the form: - * "libarchive x.y.z zlib/a.b.c liblzma/d.e.f ... etc ..." - * the list of libraries described here will vary depending on how - * libarchive was compiled. - */ -__LA_DECL const char * archive_version_details(void); - -/* - * Returns NULL if libarchive was compiled without the associated library. - * Otherwise, returns the version number that libarchive was compiled - * against. - */ -__LA_DECL const char * archive_zlib_version(void); -__LA_DECL const char * archive_liblzma_version(void); -__LA_DECL const char * archive_bzlib_version(void); -__LA_DECL const char * archive_liblz4_version(void); -__LA_DECL const char * archive_libzstd_version(void); - -/* Declare our basic types. */ -struct archive; -struct archive_entry; - -/* - * Error codes: Use archive_errno() and archive_error_string() - * to retrieve details. Unless specified otherwise, all functions - * that return 'int' use these codes. - */ -#define ARCHIVE_EOF 1 /* Found end of archive. */ -#define ARCHIVE_OK 0 /* Operation was successful. */ -#define ARCHIVE_RETRY (-10) /* Retry might succeed. */ -#define ARCHIVE_WARN (-20) /* Partial success. */ -/* For example, if write_header "fails", then you can't push data. */ -#define ARCHIVE_FAILED (-25) /* Current operation cannot complete. */ -/* But if write_header is "fatal," then this archive is dead and useless. */ -#define ARCHIVE_FATAL (-30) /* No more operations are possible. */ - -/* - * As far as possible, archive_errno returns standard platform errno codes. - * Of course, the details vary by platform, so the actual definitions - * here are stored in "archive_platform.h". The symbols are listed here - * for reference; as a rule, clients should not need to know the exact - * platform-dependent error code. - */ -/* Unrecognized or invalid file format. */ -/* #define ARCHIVE_ERRNO_FILE_FORMAT */ -/* Illegal usage of the library. */ -/* #define ARCHIVE_ERRNO_PROGRAMMER_ERROR */ -/* Unknown or unclassified error. */ -/* #define ARCHIVE_ERRNO_MISC */ - -/* - * Callbacks are invoked to automatically read/skip/write/open/close the - * archive. You can provide your own for complex tasks (like breaking - * archives across multiple tapes) or use standard ones built into the - * library. - */ - -/* Returns pointer and size of next block of data from archive. */ -typedef la_ssize_t archive_read_callback(struct archive *, - void *_client_data, const void **_buffer); - -/* Skips at most request bytes from archive and returns the skipped amount. - * This may skip fewer bytes than requested; it may even skip zero bytes. - * If you do skip fewer bytes than requested, libarchive will invoke your - * read callback and discard data as necessary to make up the full skip. - */ -typedef la_int64_t archive_skip_callback(struct archive *, - void *_client_data, la_int64_t request); - -/* Seeks to specified location in the file and returns the position. - * Whence values are SEEK_SET, SEEK_CUR, SEEK_END from stdio.h. - * Return ARCHIVE_FATAL if the seek fails for any reason. - */ -typedef la_int64_t archive_seek_callback(struct archive *, - void *_client_data, la_int64_t offset, int whence); - -/* Returns size actually written, zero on EOF, -1 on error. */ -typedef la_ssize_t archive_write_callback(struct archive *, - void *_client_data, - const void *_buffer, size_t _length); - -typedef int archive_open_callback(struct archive *, void *_client_data); - -typedef int archive_close_callback(struct archive *, void *_client_data); - -/* Switches from one client data object to the next/prev client data object. - * This is useful for reading from different data blocks such as a set of files - * that make up one large file. - */ -typedef int archive_switch_callback(struct archive *, void *_client_data1, - void *_client_data2); - -/* - * Returns a passphrase used for encryption or decryption, NULL on nothing - * to do and give it up. - */ -typedef const char *archive_passphrase_callback(struct archive *, - void *_client_data); - -/* - * Codes to identify various stream filters. - */ -#define ARCHIVE_FILTER_NONE 0 -#define ARCHIVE_FILTER_GZIP 1 -#define ARCHIVE_FILTER_BZIP2 2 -#define ARCHIVE_FILTER_COMPRESS 3 -#define ARCHIVE_FILTER_PROGRAM 4 -#define ARCHIVE_FILTER_LZMA 5 -#define ARCHIVE_FILTER_XZ 6 -#define ARCHIVE_FILTER_UU 7 -#define ARCHIVE_FILTER_RPM 8 -#define ARCHIVE_FILTER_LZIP 9 -#define ARCHIVE_FILTER_LRZIP 10 -#define ARCHIVE_FILTER_LZOP 11 -#define ARCHIVE_FILTER_GRZIP 12 -#define ARCHIVE_FILTER_LZ4 13 -#define ARCHIVE_FILTER_ZSTD 14 - -#if ARCHIVE_VERSION_NUMBER < 4000000 -#define ARCHIVE_COMPRESSION_NONE ARCHIVE_FILTER_NONE -#define ARCHIVE_COMPRESSION_GZIP ARCHIVE_FILTER_GZIP -#define ARCHIVE_COMPRESSION_BZIP2 ARCHIVE_FILTER_BZIP2 -#define ARCHIVE_COMPRESSION_COMPRESS ARCHIVE_FILTER_COMPRESS -#define ARCHIVE_COMPRESSION_PROGRAM ARCHIVE_FILTER_PROGRAM -#define ARCHIVE_COMPRESSION_LZMA ARCHIVE_FILTER_LZMA -#define ARCHIVE_COMPRESSION_XZ ARCHIVE_FILTER_XZ -#define ARCHIVE_COMPRESSION_UU ARCHIVE_FILTER_UU -#define ARCHIVE_COMPRESSION_RPM ARCHIVE_FILTER_RPM -#define ARCHIVE_COMPRESSION_LZIP ARCHIVE_FILTER_LZIP -#define ARCHIVE_COMPRESSION_LRZIP ARCHIVE_FILTER_LRZIP -#endif - -/* - * Codes returned by archive_format. - * - * Top 16 bits identifies the format family (e.g., "tar"); lower - * 16 bits indicate the variant. This is updated by read_next_header. - * Note that the lower 16 bits will often vary from entry to entry. - * In some cases, this variation occurs as libarchive learns more about - * the archive (for example, later entries might utilize extensions that - * weren't necessary earlier in the archive; in this case, libarchive - * will change the format code to indicate the extended format that - * was used). In other cases, it's because different tools have - * modified the archive and so different parts of the archive - * actually have slightly different formats. (Both tar and cpio store - * format codes in each entry, so it is quite possible for each - * entry to be in a different format.) - */ -#define ARCHIVE_FORMAT_BASE_MASK 0xff0000 -#define ARCHIVE_FORMAT_CPIO 0x10000 -#define ARCHIVE_FORMAT_CPIO_POSIX (ARCHIVE_FORMAT_CPIO | 1) -#define ARCHIVE_FORMAT_CPIO_BIN_LE (ARCHIVE_FORMAT_CPIO | 2) -#define ARCHIVE_FORMAT_CPIO_BIN_BE (ARCHIVE_FORMAT_CPIO | 3) -#define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC (ARCHIVE_FORMAT_CPIO | 4) -#define ARCHIVE_FORMAT_CPIO_SVR4_CRC (ARCHIVE_FORMAT_CPIO | 5) -#define ARCHIVE_FORMAT_CPIO_AFIO_LARGE (ARCHIVE_FORMAT_CPIO | 6) -#define ARCHIVE_FORMAT_SHAR 0x20000 -#define ARCHIVE_FORMAT_SHAR_BASE (ARCHIVE_FORMAT_SHAR | 1) -#define ARCHIVE_FORMAT_SHAR_DUMP (ARCHIVE_FORMAT_SHAR | 2) -#define ARCHIVE_FORMAT_TAR 0x30000 -#define ARCHIVE_FORMAT_TAR_USTAR (ARCHIVE_FORMAT_TAR | 1) -#define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE (ARCHIVE_FORMAT_TAR | 2) -#define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED (ARCHIVE_FORMAT_TAR | 3) -#define ARCHIVE_FORMAT_TAR_GNUTAR (ARCHIVE_FORMAT_TAR | 4) -#define ARCHIVE_FORMAT_ISO9660 0x40000 -#define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE (ARCHIVE_FORMAT_ISO9660 | 1) -#define ARCHIVE_FORMAT_ZIP 0x50000 -#define ARCHIVE_FORMAT_EMPTY 0x60000 -#define ARCHIVE_FORMAT_AR 0x70000 -#define ARCHIVE_FORMAT_AR_GNU (ARCHIVE_FORMAT_AR | 1) -#define ARCHIVE_FORMAT_AR_BSD (ARCHIVE_FORMAT_AR | 2) -#define ARCHIVE_FORMAT_MTREE 0x80000 -#define ARCHIVE_FORMAT_RAW 0x90000 -#define ARCHIVE_FORMAT_XAR 0xA0000 -#define ARCHIVE_FORMAT_LHA 0xB0000 -#define ARCHIVE_FORMAT_CAB 0xC0000 -#define ARCHIVE_FORMAT_RAR 0xD0000 -#define ARCHIVE_FORMAT_7ZIP 0xE0000 -#define ARCHIVE_FORMAT_WARC 0xF0000 -#define ARCHIVE_FORMAT_RAR_V5 0x100000 - -/* - * Codes returned by archive_read_format_capabilities(). - * - * This list can be extended with values between 0 and 0xffff. - * The original purpose of this list was to let different archive - * format readers expose their general capabilities in terms of - * encryption. - */ -#define ARCHIVE_READ_FORMAT_CAPS_NONE (0) /* no special capabilities */ -#define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_DATA (1<<0) /* reader can detect encrypted data */ -#define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_METADATA (1<<1) /* reader can detect encryptable metadata (pathname, mtime, etc.) */ - -/* - * Codes returned by archive_read_has_encrypted_entries(). - * - * In case the archive does not support encryption detection at all - * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned. If the reader - * for some other reason (e.g. not enough bytes read) cannot say if - * there are encrypted entries, ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW - * is returned. - */ -#define ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED -2 -#define ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW -1 - -/*- - * Basic outline for reading an archive: - * 1) Ask archive_read_new for an archive reader object. - * 2) Update any global properties as appropriate. - * In particular, you'll certainly want to call appropriate - * archive_read_support_XXX functions. - * 3) Call archive_read_open_XXX to open the archive - * 4) Repeatedly call archive_read_next_header to get information about - * successive archive entries. Call archive_read_data to extract - * data for entries of interest. - * 5) Call archive_read_free to end processing. - */ -__LA_DECL struct archive *archive_read_new(void); - -/* - * The archive_read_support_XXX calls enable auto-detect for this - * archive handle. They also link in the necessary support code. - * For example, if you don't want bzlib linked in, don't invoke - * support_compression_bzip2(). The "all" functions provide the - * obvious shorthand. - */ - -#if ARCHIVE_VERSION_NUMBER < 4000000 -__LA_DECL int archive_read_support_compression_all(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_bzip2(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_compress(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_gzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_lzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_lzma(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_none(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_program(struct archive *, - const char *command) __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_program_signature - (struct archive *, const char *, - const void * /* match */, size_t) __LA_DEPRECATED; - -__LA_DECL int archive_read_support_compression_rpm(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_uu(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_xz(struct archive *) - __LA_DEPRECATED; -#endif - -__LA_DECL int archive_read_support_filter_all(struct archive *); -__LA_DECL int archive_read_support_filter_by_code(struct archive *, int); -__LA_DECL int archive_read_support_filter_bzip2(struct archive *); -__LA_DECL int archive_read_support_filter_compress(struct archive *); -__LA_DECL int archive_read_support_filter_gzip(struct archive *); -__LA_DECL int archive_read_support_filter_grzip(struct archive *); -__LA_DECL int archive_read_support_filter_lrzip(struct archive *); -__LA_DECL int archive_read_support_filter_lz4(struct archive *); -__LA_DECL int archive_read_support_filter_lzip(struct archive *); -__LA_DECL int archive_read_support_filter_lzma(struct archive *); -__LA_DECL int archive_read_support_filter_lzop(struct archive *); -__LA_DECL int archive_read_support_filter_none(struct archive *); -__LA_DECL int archive_read_support_filter_program(struct archive *, - const char *command); -__LA_DECL int archive_read_support_filter_program_signature - (struct archive *, const char * /* cmd */, - const void * /* match */, size_t); -__LA_DECL int archive_read_support_filter_rpm(struct archive *); -__LA_DECL int archive_read_support_filter_uu(struct archive *); -__LA_DECL int archive_read_support_filter_xz(struct archive *); -__LA_DECL int archive_read_support_filter_zstd(struct archive *); - -__LA_DECL int archive_read_support_format_7zip(struct archive *); -__LA_DECL int archive_read_support_format_all(struct archive *); -__LA_DECL int archive_read_support_format_ar(struct archive *); -__LA_DECL int archive_read_support_format_by_code(struct archive *, int); -__LA_DECL int archive_read_support_format_cab(struct archive *); -__LA_DECL int archive_read_support_format_cpio(struct archive *); -__LA_DECL int archive_read_support_format_empty(struct archive *); -__LA_DECL int archive_read_support_format_gnutar(struct archive *); -__LA_DECL int archive_read_support_format_iso9660(struct archive *); -__LA_DECL int archive_read_support_format_lha(struct archive *); -__LA_DECL int archive_read_support_format_mtree(struct archive *); -__LA_DECL int archive_read_support_format_rar(struct archive *); -__LA_DECL int archive_read_support_format_rar5(struct archive *); -__LA_DECL int archive_read_support_format_raw(struct archive *); -__LA_DECL int archive_read_support_format_tar(struct archive *); -__LA_DECL int archive_read_support_format_warc(struct archive *); -__LA_DECL int archive_read_support_format_xar(struct archive *); -/* archive_read_support_format_zip() enables both streamable and seekable - * zip readers. */ -__LA_DECL int archive_read_support_format_zip(struct archive *); -/* Reads Zip archives as stream from beginning to end. Doesn't - * correctly handle SFX ZIP files or ZIP archives that have been modified - * in-place. */ -__LA_DECL int archive_read_support_format_zip_streamable(struct archive *); -/* Reads starting from central directory; requires seekable input. */ -__LA_DECL int archive_read_support_format_zip_seekable(struct archive *); - -/* Functions to manually set the format and filters to be used. This is - * useful to bypass the bidding process when the format and filters to use - * is known in advance. - */ -__LA_DECL int archive_read_set_format(struct archive *, int); -__LA_DECL int archive_read_append_filter(struct archive *, int); -__LA_DECL int archive_read_append_filter_program(struct archive *, - const char *); -__LA_DECL int archive_read_append_filter_program_signature - (struct archive *, const char *, const void * /* match */, size_t); - -/* Set various callbacks. */ -__LA_DECL int archive_read_set_open_callback(struct archive *, - archive_open_callback *); -__LA_DECL int archive_read_set_read_callback(struct archive *, - archive_read_callback *); -__LA_DECL int archive_read_set_seek_callback(struct archive *, - archive_seek_callback *); -__LA_DECL int archive_read_set_skip_callback(struct archive *, - archive_skip_callback *); -__LA_DECL int archive_read_set_close_callback(struct archive *, - archive_close_callback *); -/* Callback used to switch between one data object to the next */ -__LA_DECL int archive_read_set_switch_callback(struct archive *, - archive_switch_callback *); - -/* This sets the first data object. */ -__LA_DECL int archive_read_set_callback_data(struct archive *, void *); -/* This sets data object at specified index */ -__LA_DECL int archive_read_set_callback_data2(struct archive *, void *, - unsigned int); -/* This adds a data object at the specified index. */ -__LA_DECL int archive_read_add_callback_data(struct archive *, void *, - unsigned int); -/* This appends a data object to the end of list */ -__LA_DECL int archive_read_append_callback_data(struct archive *, void *); -/* This prepends a data object to the beginning of list */ -__LA_DECL int archive_read_prepend_callback_data(struct archive *, void *); - -/* Opening freezes the callbacks. */ -__LA_DECL int archive_read_open1(struct archive *); - -/* Convenience wrappers around the above. */ -__LA_DECL int archive_read_open(struct archive *, void *_client_data, - archive_open_callback *, archive_read_callback *, - archive_close_callback *); -__LA_DECL int archive_read_open2(struct archive *, void *_client_data, - archive_open_callback *, archive_read_callback *, - archive_skip_callback *, archive_close_callback *); - -/* - * A variety of shortcuts that invoke archive_read_open() with - * canned callbacks suitable for common situations. The ones that - * accept a block size handle tape blocking correctly. - */ -/* Use this if you know the filename. Note: NULL indicates stdin. */ -__LA_DECL int archive_read_open_filename(struct archive *, - const char *_filename, size_t _block_size); -/* Use this for reading multivolume files by filenames. - * NOTE: Must be NULL terminated. Sorting is NOT done. */ -__LA_DECL int archive_read_open_filenames(struct archive *, - const char **_filenames, size_t _block_size); -__LA_DECL int archive_read_open_filename_w(struct archive *, - const wchar_t *_filename, size_t _block_size); -/* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */ -__LA_DECL int archive_read_open_file(struct archive *, - const char *_filename, size_t _block_size) __LA_DEPRECATED; -/* Read an archive that's stored in memory. */ -__LA_DECL int archive_read_open_memory(struct archive *, - const void * buff, size_t size); -/* A more involved version that is only used for internal testing. */ -__LA_DECL int archive_read_open_memory2(struct archive *a, const void *buff, - size_t size, size_t read_size); -/* Read an archive that's already open, using the file descriptor. */ -__LA_DECL int archive_read_open_fd(struct archive *, int _fd, - size_t _block_size); -/* Read an archive that's already open, using a FILE *. */ -/* Note: DO NOT use this with tape drives. */ -__LA_DECL int archive_read_open_FILE(struct archive *, FILE *_file); - -/* Parses and returns next entry header. */ -__LA_DECL int archive_read_next_header(struct archive *, - struct archive_entry **); - -/* Parses and returns next entry header using the archive_entry passed in */ -__LA_DECL int archive_read_next_header2(struct archive *, - struct archive_entry *); - -/* - * Retrieve the byte offset in UNCOMPRESSED data where last-read - * header started. - */ -__LA_DECL la_int64_t archive_read_header_position(struct archive *); - -/* - * Returns 1 if the archive contains at least one encrypted entry. - * If the archive format not support encryption at all - * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned. - * If for any other reason (e.g. not enough data read so far) - * we cannot say whether there are encrypted entries, then - * ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW is returned. - * In general, this function will return values below zero when the - * reader is uncertain or totally incapable of encryption support. - * When this function returns 0 you can be sure that the reader - * supports encryption detection but no encrypted entries have - * been found yet. - * - * NOTE: If the metadata/header of an archive is also encrypted, you - * cannot rely on the number of encrypted entries. That is why this - * function does not return the number of encrypted entries but# - * just shows that there are some. - */ -__LA_DECL int archive_read_has_encrypted_entries(struct archive *); - -/* - * Returns a bitmask of capabilities that are supported by the archive format reader. - * If the reader has no special capabilities, ARCHIVE_READ_FORMAT_CAPS_NONE is returned. - */ -__LA_DECL int archive_read_format_capabilities(struct archive *); - -/* Read data from the body of an entry. Similar to read(2). */ -__LA_DECL la_ssize_t archive_read_data(struct archive *, - void *, size_t); - -/* Seek within the body of an entry. Similar to lseek(2). */ -__LA_DECL la_int64_t archive_seek_data(struct archive *, la_int64_t, int); - -/* - * A zero-copy version of archive_read_data that also exposes the file offset - * of each returned block. Note that the client has no way to specify - * the desired size of the block. The API does guarantee that offsets will - * be strictly increasing and that returned blocks will not overlap. - */ -__LA_DECL int archive_read_data_block(struct archive *a, - const void **buff, size_t *size, la_int64_t *offset); - -/*- - * Some convenience functions that are built on archive_read_data: - * 'skip': skips entire entry - * 'into_buffer': writes data into memory buffer that you provide - * 'into_fd': writes data to specified filedes - */ -__LA_DECL int archive_read_data_skip(struct archive *); -__LA_DECL int archive_read_data_into_fd(struct archive *, int fd); - -/* - * Set read options. - */ -/* Apply option to the format only. */ -__LA_DECL int archive_read_set_format_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to the filter only. */ -__LA_DECL int archive_read_set_filter_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to both the format and the filter. */ -__LA_DECL int archive_read_set_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option string to both the format and the filter. */ -__LA_DECL int archive_read_set_options(struct archive *_a, - const char *opts); - -/* - * Add a decryption passphrase. - */ -__LA_DECL int archive_read_add_passphrase(struct archive *, const char *); -__LA_DECL int archive_read_set_passphrase_callback(struct archive *, - void *client_data, archive_passphrase_callback *); - - -/*- - * Convenience function to recreate the current entry (whose header - * has just been read) on disk. - * - * This does quite a bit more than just copy data to disk. It also: - * - Creates intermediate directories as required. - * - Manages directory permissions: non-writable directories will - * be initially created with write permission enabled; when the - * archive is closed, dir permissions are edited to the values specified - * in the archive. - * - Checks hardlinks: hardlinks will not be extracted unless the - * linked-to file was also extracted within the same session. (TODO) - */ - -/* The "flags" argument selects optional behavior, 'OR' the flags you want. */ - -/* Default: Do not try to set owner/group. */ -#define ARCHIVE_EXTRACT_OWNER (0x0001) -/* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */ -#define ARCHIVE_EXTRACT_PERM (0x0002) -/* Default: Do not restore mtime/atime. */ -#define ARCHIVE_EXTRACT_TIME (0x0004) -/* Default: Replace existing files. */ -#define ARCHIVE_EXTRACT_NO_OVERWRITE (0x0008) -/* Default: Try create first, unlink only if create fails with EEXIST. */ -#define ARCHIVE_EXTRACT_UNLINK (0x0010) -/* Default: Do not restore ACLs. */ -#define ARCHIVE_EXTRACT_ACL (0x0020) -/* Default: Do not restore fflags. */ -#define ARCHIVE_EXTRACT_FFLAGS (0x0040) -/* Default: Do not restore xattrs. */ -#define ARCHIVE_EXTRACT_XATTR (0x0080) -/* Default: Do not try to guard against extracts redirected by symlinks. */ -/* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */ -#define ARCHIVE_EXTRACT_SECURE_SYMLINKS (0x0100) -/* Default: Do not reject entries with '..' as path elements. */ -#define ARCHIVE_EXTRACT_SECURE_NODOTDOT (0x0200) -/* Default: Create parent directories as needed. */ -#define ARCHIVE_EXTRACT_NO_AUTODIR (0x0400) -/* Default: Overwrite files, even if one on disk is newer. */ -#define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER (0x0800) -/* Detect blocks of 0 and write holes instead. */ -#define ARCHIVE_EXTRACT_SPARSE (0x1000) -/* Default: Do not restore Mac extended metadata. */ -/* This has no effect except on Mac OS. */ -#define ARCHIVE_EXTRACT_MAC_METADATA (0x2000) -/* Default: Use HFS+ compression if it was compressed. */ -/* This has no effect except on Mac OS v10.6 or later. */ -#define ARCHIVE_EXTRACT_NO_HFS_COMPRESSION (0x4000) -/* Default: Do not use HFS+ compression if it was not compressed. */ -/* This has no effect except on Mac OS v10.6 or later. */ -#define ARCHIVE_EXTRACT_HFS_COMPRESSION_FORCED (0x8000) -/* Default: Do not reject entries with absolute paths */ -#define ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS (0x10000) -/* Default: Do not clear no-change flags when unlinking object */ -#define ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS (0x20000) -/* Default: Do not extract atomically (using rename) */ -#define ARCHIVE_EXTRACT_SAFE_WRITES (0x40000) - -__LA_DECL int archive_read_extract(struct archive *, struct archive_entry *, - int flags); -__LA_DECL int archive_read_extract2(struct archive *, struct archive_entry *, - struct archive * /* dest */); -__LA_DECL void archive_read_extract_set_progress_callback(struct archive *, - void (*_progress_func)(void *), void *_user_data); - -/* Record the dev/ino of a file that will not be written. This is - * generally set to the dev/ino of the archive being read. */ -__LA_DECL void archive_read_extract_set_skip_file(struct archive *, - la_int64_t, la_int64_t); - -/* Close the file and release most resources. */ -__LA_DECL int archive_read_close(struct archive *); -/* Release all resources and destroy the object. */ -/* Note that archive_read_free will call archive_read_close for you. */ -__LA_DECL int archive_read_free(struct archive *); -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* Synonym for archive_read_free() for backwards compatibility. */ -__LA_DECL int archive_read_finish(struct archive *) __LA_DEPRECATED; -#endif - -/*- - * To create an archive: - * 1) Ask archive_write_new for an archive writer object. - * 2) Set any global properties. In particular, you should set - * the compression and format to use. - * 3) Call archive_write_open to open the file (most people - * will use archive_write_open_file or archive_write_open_fd, - * which provide convenient canned I/O callbacks for you). - * 4) For each entry: - * - construct an appropriate struct archive_entry structure - * - archive_write_header to write the header - * - archive_write_data to write the entry data - * 5) archive_write_close to close the output - * 6) archive_write_free to cleanup the writer and release resources - */ -__LA_DECL struct archive *archive_write_new(void); -__LA_DECL int archive_write_set_bytes_per_block(struct archive *, - int bytes_per_block); -__LA_DECL int archive_write_get_bytes_per_block(struct archive *); -/* XXX This is badly misnamed; suggestions appreciated. XXX */ -__LA_DECL int archive_write_set_bytes_in_last_block(struct archive *, - int bytes_in_last_block); -__LA_DECL int archive_write_get_bytes_in_last_block(struct archive *); - -/* The dev/ino of a file that won't be archived. This is used - * to avoid recursively adding an archive to itself. */ -__LA_DECL int archive_write_set_skip_file(struct archive *, - la_int64_t, la_int64_t); - -#if ARCHIVE_VERSION_NUMBER < 4000000 -__LA_DECL int archive_write_set_compression_bzip2(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_compress(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_gzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_lzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_lzma(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_none(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_program(struct archive *, - const char *cmd) __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_xz(struct archive *) - __LA_DEPRECATED; -#endif - -/* A convenience function to set the filter based on the code. */ -__LA_DECL int archive_write_add_filter(struct archive *, int filter_code); -__LA_DECL int archive_write_add_filter_by_name(struct archive *, - const char *name); -__LA_DECL int archive_write_add_filter_b64encode(struct archive *); -__LA_DECL int archive_write_add_filter_bzip2(struct archive *); -__LA_DECL int archive_write_add_filter_compress(struct archive *); -__LA_DECL int archive_write_add_filter_grzip(struct archive *); -__LA_DECL int archive_write_add_filter_gzip(struct archive *); -__LA_DECL int archive_write_add_filter_lrzip(struct archive *); -__LA_DECL int archive_write_add_filter_lz4(struct archive *); -__LA_DECL int archive_write_add_filter_lzip(struct archive *); -__LA_DECL int archive_write_add_filter_lzma(struct archive *); -__LA_DECL int archive_write_add_filter_lzop(struct archive *); -__LA_DECL int archive_write_add_filter_none(struct archive *); -__LA_DECL int archive_write_add_filter_program(struct archive *, - const char *cmd); -__LA_DECL int archive_write_add_filter_uuencode(struct archive *); -__LA_DECL int archive_write_add_filter_xz(struct archive *); -__LA_DECL int archive_write_add_filter_zstd(struct archive *); - - -/* A convenience function to set the format based on the code or name. */ -__LA_DECL int archive_write_set_format(struct archive *, int format_code); -__LA_DECL int archive_write_set_format_by_name(struct archive *, - const char *name); -/* To minimize link pollution, use one or more of the following. */ -__LA_DECL int archive_write_set_format_7zip(struct archive *); -__LA_DECL int archive_write_set_format_ar_bsd(struct archive *); -__LA_DECL int archive_write_set_format_ar_svr4(struct archive *); -__LA_DECL int archive_write_set_format_cpio(struct archive *); -__LA_DECL int archive_write_set_format_cpio_newc(struct archive *); -__LA_DECL int archive_write_set_format_gnutar(struct archive *); -__LA_DECL int archive_write_set_format_iso9660(struct archive *); -__LA_DECL int archive_write_set_format_mtree(struct archive *); -__LA_DECL int archive_write_set_format_mtree_classic(struct archive *); -/* TODO: int archive_write_set_format_old_tar(struct archive *); */ -__LA_DECL int archive_write_set_format_pax(struct archive *); -__LA_DECL int archive_write_set_format_pax_restricted(struct archive *); -__LA_DECL int archive_write_set_format_raw(struct archive *); -__LA_DECL int archive_write_set_format_shar(struct archive *); -__LA_DECL int archive_write_set_format_shar_dump(struct archive *); -__LA_DECL int archive_write_set_format_ustar(struct archive *); -__LA_DECL int archive_write_set_format_v7tar(struct archive *); -__LA_DECL int archive_write_set_format_warc(struct archive *); -__LA_DECL int archive_write_set_format_xar(struct archive *); -__LA_DECL int archive_write_set_format_zip(struct archive *); -__LA_DECL int archive_write_set_format_filter_by_ext(struct archive *a, const char *filename); -__LA_DECL int archive_write_set_format_filter_by_ext_def(struct archive *a, const char *filename, const char * def_ext); -__LA_DECL int archive_write_zip_set_compression_deflate(struct archive *); -__LA_DECL int archive_write_zip_set_compression_store(struct archive *); -__LA_DECL int archive_write_open(struct archive *, void *, - archive_open_callback *, archive_write_callback *, - archive_close_callback *); -__LA_DECL int archive_write_open_fd(struct archive *, int _fd); -__LA_DECL int archive_write_open_filename(struct archive *, const char *_file); -__LA_DECL int archive_write_open_filename_w(struct archive *, - const wchar_t *_file); -/* A deprecated synonym for archive_write_open_filename() */ -__LA_DECL int archive_write_open_file(struct archive *, const char *_file) - __LA_DEPRECATED; -__LA_DECL int archive_write_open_FILE(struct archive *, FILE *); -/* _buffSize is the size of the buffer, _used refers to a variable that - * will be updated after each write into the buffer. */ -__LA_DECL int archive_write_open_memory(struct archive *, - void *_buffer, size_t _buffSize, size_t *_used); - -/* - * Note that the library will truncate writes beyond the size provided - * to archive_write_header or pad if the provided data is short. - */ -__LA_DECL int archive_write_header(struct archive *, - struct archive_entry *); -__LA_DECL la_ssize_t archive_write_data(struct archive *, - const void *, size_t); - -/* This interface is currently only available for archive_write_disk handles. */ -__LA_DECL la_ssize_t archive_write_data_block(struct archive *, - const void *, size_t, la_int64_t); - -__LA_DECL int archive_write_finish_entry(struct archive *); -__LA_DECL int archive_write_close(struct archive *); -/* Marks the archive as FATAL so that a subsequent free() operation - * won't try to close() cleanly. Provides a fast abort capability - * when the client discovers that things have gone wrong. */ -__LA_DECL int archive_write_fail(struct archive *); -/* This can fail if the archive wasn't already closed, in which case - * archive_write_free() will implicitly call archive_write_close(). */ -__LA_DECL int archive_write_free(struct archive *); -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* Synonym for archive_write_free() for backwards compatibility. */ -__LA_DECL int archive_write_finish(struct archive *) __LA_DEPRECATED; -#endif - -/* - * Set write options. - */ -/* Apply option to the format only. */ -__LA_DECL int archive_write_set_format_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to the filter only. */ -__LA_DECL int archive_write_set_filter_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to both the format and the filter. */ -__LA_DECL int archive_write_set_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option string to both the format and the filter. */ -__LA_DECL int archive_write_set_options(struct archive *_a, - const char *opts); - -/* - * Set a encryption passphrase. - */ -__LA_DECL int archive_write_set_passphrase(struct archive *_a, const char *p); -__LA_DECL int archive_write_set_passphrase_callback(struct archive *, - void *client_data, archive_passphrase_callback *); - -/*- - * ARCHIVE_WRITE_DISK API - * - * To create objects on disk: - * 1) Ask archive_write_disk_new for a new archive_write_disk object. - * 2) Set any global properties. In particular, you probably - * want to set the options. - * 3) For each entry: - * - construct an appropriate struct archive_entry structure - * - archive_write_header to create the file/dir/etc on disk - * - archive_write_data to write the entry data - * 4) archive_write_free to cleanup the writer and release resources - * - * In particular, you can use this in conjunction with archive_read() - * to pull entries out of an archive and create them on disk. - */ -__LA_DECL struct archive *archive_write_disk_new(void); -/* This file will not be overwritten. */ -__LA_DECL int archive_write_disk_set_skip_file(struct archive *, - la_int64_t, la_int64_t); -/* Set flags to control how the next item gets created. - * This accepts a bitmask of ARCHIVE_EXTRACT_XXX flags defined above. */ -__LA_DECL int archive_write_disk_set_options(struct archive *, - int flags); -/* - * The lookup functions are given uname/uid (or gname/gid) pairs and - * return a uid (gid) suitable for this system. These are used for - * restoring ownership and for setting ACLs. The default functions - * are naive, they just return the uid/gid. These are small, so reasonable - * for applications that don't need to preserve ownership; they - * are probably also appropriate for applications that are doing - * same-system backup and restore. - */ -/* - * The "standard" lookup functions use common system calls to lookup - * the uname/gname, falling back to the uid/gid if the names can't be - * found. They cache lookups and are reasonably fast, but can be very - * large, so they are not used unless you ask for them. In - * particular, these match the specifications of POSIX "pax" and old - * POSIX "tar". - */ -__LA_DECL int archive_write_disk_set_standard_lookup(struct archive *); -/* - * If neither the default (naive) nor the standard (big) functions suit - * your needs, you can write your own and register them. Be sure to - * include a cleanup function if you have allocated private data. - */ -__LA_DECL int archive_write_disk_set_group_lookup(struct archive *, - void * /* private_data */, - la_int64_t (*)(void *, const char *, la_int64_t), - void (* /* cleanup */)(void *)); -__LA_DECL int archive_write_disk_set_user_lookup(struct archive *, - void * /* private_data */, - la_int64_t (*)(void *, const char *, la_int64_t), - void (* /* cleanup */)(void *)); -__LA_DECL la_int64_t archive_write_disk_gid(struct archive *, const char *, la_int64_t); -__LA_DECL la_int64_t archive_write_disk_uid(struct archive *, const char *, la_int64_t); - -/* - * ARCHIVE_READ_DISK API - * - * This is still evolving and somewhat experimental. - */ -__LA_DECL struct archive *archive_read_disk_new(void); -/* The names for symlink modes here correspond to an old BSD - * command-line argument convention: -L, -P, -H */ -/* Follow all symlinks. */ -__LA_DECL int archive_read_disk_set_symlink_logical(struct archive *); -/* Follow no symlinks. */ -__LA_DECL int archive_read_disk_set_symlink_physical(struct archive *); -/* Follow symlink initially, then not. */ -__LA_DECL int archive_read_disk_set_symlink_hybrid(struct archive *); -/* TODO: Handle Linux stat32/stat64 ugliness. */ -__LA_DECL int archive_read_disk_entry_from_file(struct archive *, - struct archive_entry *, int /* fd */, const struct stat *); -/* Look up gname for gid or uname for uid. */ -/* Default implementations are very, very stupid. */ -__LA_DECL const char *archive_read_disk_gname(struct archive *, la_int64_t); -__LA_DECL const char *archive_read_disk_uname(struct archive *, la_int64_t); -/* "Standard" implementation uses getpwuid_r, getgrgid_r and caches the - * results for performance. */ -__LA_DECL int archive_read_disk_set_standard_lookup(struct archive *); -/* You can install your own lookups if you like. */ -__LA_DECL int archive_read_disk_set_gname_lookup(struct archive *, - void * /* private_data */, - const char *(* /* lookup_fn */)(void *, la_int64_t), - void (* /* cleanup_fn */)(void *)); -__LA_DECL int archive_read_disk_set_uname_lookup(struct archive *, - void * /* private_data */, - const char *(* /* lookup_fn */)(void *, la_int64_t), - void (* /* cleanup_fn */)(void *)); -/* Start traversal. */ -__LA_DECL int archive_read_disk_open(struct archive *, const char *); -__LA_DECL int archive_read_disk_open_w(struct archive *, const wchar_t *); -/* - * Request that current entry be visited. If you invoke it on every - * directory, you'll get a physical traversal. This is ignored if the - * current entry isn't a directory or a link to a directory. So, if - * you invoke this on every returned path, you'll get a full logical - * traversal. - */ -__LA_DECL int archive_read_disk_descend(struct archive *); -__LA_DECL int archive_read_disk_can_descend(struct archive *); -__LA_DECL int archive_read_disk_current_filesystem(struct archive *); -__LA_DECL int archive_read_disk_current_filesystem_is_synthetic(struct archive *); -__LA_DECL int archive_read_disk_current_filesystem_is_remote(struct archive *); -/* Request that the access time of the entry visited by traversal be restored. */ -__LA_DECL int archive_read_disk_set_atime_restored(struct archive *); -/* - * Set behavior. The "flags" argument selects optional behavior. - */ -/* Request that the access time of the entry visited by traversal be restored. - * This is the same as archive_read_disk_set_atime_restored. */ -#define ARCHIVE_READDISK_RESTORE_ATIME (0x0001) -/* Default: Do not skip an entry which has nodump flags. */ -#define ARCHIVE_READDISK_HONOR_NODUMP (0x0002) -/* Default: Skip a mac resource fork file whose prefix is "._" because of - * using copyfile. */ -#define ARCHIVE_READDISK_MAC_COPYFILE (0x0004) -/* Default: Traverse mount points. */ -#define ARCHIVE_READDISK_NO_TRAVERSE_MOUNTS (0x0008) -/* Default: Xattrs are read from disk. */ -#define ARCHIVE_READDISK_NO_XATTR (0x0010) -/* Default: ACLs are read from disk. */ -#define ARCHIVE_READDISK_NO_ACL (0x0020) -/* Default: File flags are read from disk. */ -#define ARCHIVE_READDISK_NO_FFLAGS (0x0040) - -__LA_DECL int archive_read_disk_set_behavior(struct archive *, - int flags); - -/* - * Set archive_match object that will be used in archive_read_disk to - * know whether an entry should be skipped. The callback function - * _excluded_func will be invoked when an entry is skipped by the result - * of archive_match. - */ -__LA_DECL int archive_read_disk_set_matching(struct archive *, - struct archive *_matching, void (*_excluded_func) - (struct archive *, void *, struct archive_entry *), - void *_client_data); -__LA_DECL int archive_read_disk_set_metadata_filter_callback(struct archive *, - int (*_metadata_filter_func)(struct archive *, void *, - struct archive_entry *), void *_client_data); - -/* Simplified cleanup interface; - * This calls archive_read_free() or archive_write_free() as needed. */ -__LA_DECL int archive_free(struct archive *); - -/* - * Accessor functions to read/set various information in - * the struct archive object: - */ - -/* Number of filters in the current filter pipeline. */ -/* Filter #0 is the one closest to the format, -1 is a synonym for the - * last filter, which is always the pseudo-filter that wraps the - * client callbacks. */ -__LA_DECL int archive_filter_count(struct archive *); -__LA_DECL la_int64_t archive_filter_bytes(struct archive *, int); -__LA_DECL int archive_filter_code(struct archive *, int); -__LA_DECL const char * archive_filter_name(struct archive *, int); - -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* These don't properly handle multiple filters, so are deprecated and - * will eventually be removed. */ -/* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, -1); */ -__LA_DECL la_int64_t archive_position_compressed(struct archive *) - __LA_DEPRECATED; -/* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, 0); */ -__LA_DECL la_int64_t archive_position_uncompressed(struct archive *) - __LA_DEPRECATED; -/* As of libarchive 3.0, this is an alias for archive_filter_name(a, 0); */ -__LA_DECL const char *archive_compression_name(struct archive *) - __LA_DEPRECATED; -/* As of libarchive 3.0, this is an alias for archive_filter_code(a, 0); */ -__LA_DECL int archive_compression(struct archive *) - __LA_DEPRECATED; -#endif - -__LA_DECL int archive_errno(struct archive *); -__LA_DECL const char *archive_error_string(struct archive *); -__LA_DECL const char *archive_format_name(struct archive *); -__LA_DECL int archive_format(struct archive *); -__LA_DECL void archive_clear_error(struct archive *); -__LA_DECL void archive_set_error(struct archive *, int _err, - const char *fmt, ...) __LA_PRINTF(3, 4); -__LA_DECL void archive_copy_error(struct archive *dest, - struct archive *src); -__LA_DECL int archive_file_count(struct archive *); - -/* - * ARCHIVE_MATCH API - */ -__LA_DECL struct archive *archive_match_new(void); -__LA_DECL int archive_match_free(struct archive *); - -/* - * Test if archive_entry is excluded. - * This is a convenience function. This is the same as calling all - * archive_match_path_excluded, archive_match_time_excluded - * and archive_match_owner_excluded. - */ -__LA_DECL int archive_match_excluded(struct archive *, - struct archive_entry *); - -/* - * Test if pathname is excluded. The conditions are set by following functions. - */ -__LA_DECL int archive_match_path_excluded(struct archive *, - struct archive_entry *); -/* Control recursive inclusion of directory content when directory is included. Default on. */ -__LA_DECL int archive_match_set_inclusion_recursion(struct archive *, int); -/* Add exclusion pathname pattern. */ -__LA_DECL int archive_match_exclude_pattern(struct archive *, const char *); -__LA_DECL int archive_match_exclude_pattern_w(struct archive *, - const wchar_t *); -/* Add exclusion pathname pattern from file. */ -__LA_DECL int archive_match_exclude_pattern_from_file(struct archive *, - const char *, int _nullSeparator); -__LA_DECL int archive_match_exclude_pattern_from_file_w(struct archive *, - const wchar_t *, int _nullSeparator); -/* Add inclusion pathname pattern. */ -__LA_DECL int archive_match_include_pattern(struct archive *, const char *); -__LA_DECL int archive_match_include_pattern_w(struct archive *, - const wchar_t *); -/* Add inclusion pathname pattern from file. */ -__LA_DECL int archive_match_include_pattern_from_file(struct archive *, - const char *, int _nullSeparator); -__LA_DECL int archive_match_include_pattern_from_file_w(struct archive *, - const wchar_t *, int _nullSeparator); -/* - * How to get statistic information for inclusion patterns. - */ -/* Return the amount number of unmatched inclusion patterns. */ -__LA_DECL int archive_match_path_unmatched_inclusions(struct archive *); -/* Return the pattern of unmatched inclusion with ARCHIVE_OK. - * Return ARCHIVE_EOF if there is no inclusion pattern. */ -__LA_DECL int archive_match_path_unmatched_inclusions_next( - struct archive *, const char **); -__LA_DECL int archive_match_path_unmatched_inclusions_next_w( - struct archive *, const wchar_t **); - -/* - * Test if a file is excluded by its time stamp. - * The conditions are set by following functions. - */ -__LA_DECL int archive_match_time_excluded(struct archive *, - struct archive_entry *); - -/* - * Flags to tell a matching type of time stamps. These are used for - * following functions. - */ -/* Time flag: mtime to be tested. */ -#define ARCHIVE_MATCH_MTIME (0x0100) -/* Time flag: ctime to be tested. */ -#define ARCHIVE_MATCH_CTIME (0x0200) -/* Comparison flag: Match the time if it is newer than. */ -#define ARCHIVE_MATCH_NEWER (0x0001) -/* Comparison flag: Match the time if it is older than. */ -#define ARCHIVE_MATCH_OLDER (0x0002) -/* Comparison flag: Match the time if it is equal to. */ -#define ARCHIVE_MATCH_EQUAL (0x0010) -/* Set inclusion time. */ -__LA_DECL int archive_match_include_time(struct archive *, int _flag, - time_t _sec, long _nsec); -/* Set inclusion time by a date string. */ -__LA_DECL int archive_match_include_date(struct archive *, int _flag, - const char *_datestr); -__LA_DECL int archive_match_include_date_w(struct archive *, int _flag, - const wchar_t *_datestr); -/* Set inclusion time by a particular file. */ -__LA_DECL int archive_match_include_file_time(struct archive *, - int _flag, const char *_pathname); -__LA_DECL int archive_match_include_file_time_w(struct archive *, - int _flag, const wchar_t *_pathname); -/* Add exclusion entry. */ -__LA_DECL int archive_match_exclude_entry(struct archive *, - int _flag, struct archive_entry *); - -/* - * Test if a file is excluded by its uid ,gid, uname or gname. - * The conditions are set by following functions. - */ -__LA_DECL int archive_match_owner_excluded(struct archive *, - struct archive_entry *); -/* Add inclusion uid, gid, uname and gname. */ -__LA_DECL int archive_match_include_uid(struct archive *, la_int64_t); -__LA_DECL int archive_match_include_gid(struct archive *, la_int64_t); -__LA_DECL int archive_match_include_uname(struct archive *, const char *); -__LA_DECL int archive_match_include_uname_w(struct archive *, - const wchar_t *); -__LA_DECL int archive_match_include_gname(struct archive *, const char *); -__LA_DECL int archive_match_include_gname_w(struct archive *, - const wchar_t *); - -/* Utility functions */ -/* Convenience function to sort a NULL terminated list of strings */ -__LA_DECL int archive_utility_string_sort(char **); - -#ifdef __cplusplus -} -#endif - -/* These are meaningless outside of this header. */ -#undef __LA_DECL - -#endif /* !ARCHIVE_H_INCLUDED */ diff --git a/oss-internship-2020/libarchive/files_diff/archive2.h b/oss-internship-2020/libarchive/files_diff/archive2.h deleted file mode 100644 index 3f56b5f..0000000 --- a/oss-internship-2020/libarchive/files_diff/archive2.h +++ /dev/null @@ -1,1198 +0,0 @@ -/*- - * Copyright (c) 2003-2010 Tim Kientzle - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.50 2008/05/26 17:00:22 kientzle Exp $ - */ - -#ifndef ARCHIVE_H_INCLUDED -#define ARCHIVE_H_INCLUDED - -/* - * The version number is expressed as a single integer that makes it - * easy to compare versions at build time: for version a.b.c, the - * version number is printf("%d%03d%03d",a,b,c). For example, if you - * know your application requires version 2.12.108 or later, you can - * assert that ARCHIVE_VERSION_NUMBER >= 2012108. - */ -/* Note: Compiler will complain if this does not match archive_entry.h! */ -#define ARCHIVE_VERSION_NUMBER 3004004 - -#include -#include /* for wchar_t */ -#include /* For FILE * */ -#include /* For time_t */ - -/* - * Note: archive.h is for use outside of libarchive; the configuration - * headers (config.h, archive_platform.h, etc.) are purely internal. - * Do NOT use HAVE_XXX configuration macros to control the behavior of - * this header! If you must conditionalize, use predefined compiler and/or - * platform macros. - */ -#if defined(__BORLANDC__) && __BORLANDC__ >= 0x560 -# include -#elif !defined(__WATCOMC__) && !defined(_MSC_VER) && !defined(__INTERIX) && !defined(__BORLANDC__) && !defined(_SCO_DS) && !defined(__osf__) && !defined(__CLANG_INTTYPES_H) -# include -#endif - -/* Get appropriate definitions of 64-bit integer */ -#if !defined(__LA_INT64_T_DEFINED) -/* Older code relied on the __LA_INT64_T macro; after 4.0 we'll switch to the typedef exclusively. */ -# if ARCHIVE_VERSION_NUMBER < 4000000 -#define __LA_INT64_T la_int64_t -# endif -#define __LA_INT64_T_DEFINED -# if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__) -typedef __int64 la_int64_t; -# else -# include /* ssize_t */ -# if defined(_SCO_DS) || defined(__osf__) -typedef long long la_int64_t; -# else -typedef int64_t la_int64_t; -# endif -# endif -#endif - -/* The la_ssize_t should match the type used in 'struct stat' */ -#if !defined(__LA_SSIZE_T_DEFINED) -/* Older code relied on the __LA_SSIZE_T macro; after 4.0 we'll switch to the typedef exclusively. */ -# if ARCHIVE_VERSION_NUMBER < 4000000 -#define __LA_SSIZE_T la_ssize_t -# endif -#define __LA_SSIZE_T_DEFINED -# if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__) -# if defined(_SSIZE_T_DEFINED) || defined(_SSIZE_T_) -typedef ssize_t la_ssize_t; -# elif defined(_WIN64) -typedef __int64 la_ssize_t; -# else -typedef long la_ssize_t; -# endif -# else -# include /* ssize_t */ -typedef ssize_t la_ssize_t; -# endif -#endif - -/* Large file support for Android */ -#ifdef __ANDROID__ -#include "android_lf.h" -#endif - -/* - * On Windows, define LIBARCHIVE_STATIC if you're building or using a - * .lib. The default here assumes you're building a DLL. Only - * libarchive source should ever define __LIBARCHIVE_BUILD. - */ -#if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC) -# ifdef __LIBARCHIVE_BUILD -# ifdef __GNUC__ -# define __LA_DECL __attribute__((dllexport)) extern -# else -# define __LA_DECL __declspec(dllexport) -# endif -# else -# ifdef __GNUC__ -# define __LA_DECL -# else -# define __LA_DECL __declspec(dllimport) -# endif -# endif -#else -/* Static libraries or non-Windows needs no special declaration. */ -# define __LA_DECL -#endif - -#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(__MINGW32__) -#define __LA_PRINTF(fmtarg, firstvararg) \ - __attribute__((__format__ (__printf__, fmtarg, firstvararg))) -#else -#define __LA_PRINTF(fmtarg, firstvararg) /* nothing */ -#endif - -#if defined(__GNUC__) && __GNUC__ >= 3 && __GNUC_MINOR__ >= 1 -# define __LA_DEPRECATED __attribute__((deprecated)) -#else -# define __LA_DEPRECATED -#endif - -#ifdef __cplusplus -extern "C" { -#endif - -/* - * The version number is provided as both a macro and a function. - * The macro identifies the installed header; the function identifies - * the library version (which may not be the same if you're using a - * dynamically-linked version of the library). Of course, if the - * header and library are very different, you should expect some - * strangeness. Don't do that. - */ -__LA_DECL int archive_version_number(void); - -/* - * Textual name/version of the library, useful for version displays. - */ -#define ARCHIVE_VERSION_ONLY_STRING "3.4.4dev" -#define ARCHIVE_VERSION_STRING "libarchive " ARCHIVE_VERSION_ONLY_STRING -__LA_DECL const char * archive_version_string(void); - -/* - * Detailed textual name/version of the library and its dependencies. - * This has the form: - * "libarchive x.y.z zlib/a.b.c liblzma/d.e.f ... etc ..." - * the list of libraries described here will vary depending on how - * libarchive was compiled. - */ -__LA_DECL const char * archive_version_details(void); - -/* - * Returns NULL if libarchive was compiled without the associated library. - * Otherwise, returns the version number that libarchive was compiled - * against. - */ -__LA_DECL const char * archive_zlib_version(void); -__LA_DECL const char * archive_liblzma_version(void); -__LA_DECL const char * archive_bzlib_version(void); -__LA_DECL const char * archive_liblz4_version(void); -__LA_DECL const char * archive_libzstd_version(void); - -/* Declare our basic types. */ -struct archive; -struct archive_entry; - -/* - * Error codes: Use archive_errno() and archive_error_string() - * to retrieve details. Unless specified otherwise, all functions - * that return 'int' use these codes. - */ -#define ARCHIVE_EOF 1 /* Found end of archive. */ -#define ARCHIVE_OK 0 /* Operation was successful. */ -#define ARCHIVE_RETRY (-10) /* Retry might succeed. */ -#define ARCHIVE_WARN (-20) /* Partial success. */ -/* For example, if write_header "fails", then you can't push data. */ -#define ARCHIVE_FAILED (-25) /* Current operation cannot complete. */ -/* But if write_header is "fatal," then this archive is dead and useless. */ -#define ARCHIVE_FATAL (-30) /* No more operations are possible. */ - -/* - * As far as possible, archive_errno returns standard platform errno codes. - * Of course, the details vary by platform, so the actual definitions - * here are stored in "archive_platform.h". The symbols are listed here - * for reference; as a rule, clients should not need to know the exact - * platform-dependent error code. - */ -/* Unrecognized or invalid file format. */ -/* #define ARCHIVE_ERRNO_FILE_FORMAT */ -/* Illegal usage of the library. */ -/* #define ARCHIVE_ERRNO_PROGRAMMER_ERROR */ -/* Unknown or unclassified error. */ -/* #define ARCHIVE_ERRNO_MISC */ - -/* - * Callbacks are invoked to automatically read/skip/write/open/close the - * archive. You can provide your own for complex tasks (like breaking - * archives across multiple tapes) or use standard ones built into the - * library. - */ - -/* Returns pointer and size of next block of data from archive. */ -typedef la_ssize_t archive_read_callback(struct archive *, - void *_client_data, const void **_buffer); - -/* Skips at most request bytes from archive and returns the skipped amount. - * This may skip fewer bytes than requested; it may even skip zero bytes. - * If you do skip fewer bytes than requested, libarchive will invoke your - * read callback and discard data as necessary to make up the full skip. - */ -typedef la_int64_t archive_skip_callback(struct archive *, - void *_client_data, la_int64_t request); - -/* Seeks to specified location in the file and returns the position. - * Whence values are SEEK_SET, SEEK_CUR, SEEK_END from stdio.h. - * Return ARCHIVE_FATAL if the seek fails for any reason. - */ -typedef la_int64_t archive_seek_callback(struct archive *, - void *_client_data, la_int64_t offset, int whence); - -/* Returns size actually written, zero on EOF, -1 on error. */ -typedef la_ssize_t archive_write_callback(struct archive *, - void *_client_data, - const void *_buffer, size_t _length); - -typedef int archive_open_callback(struct archive *, void *_client_data); - -typedef int archive_close_callback(struct archive *, void *_client_data); - -/* Switches from one client data object to the next/prev client data object. - * This is useful for reading from different data blocks such as a set of files - * that make up one large file. - */ -typedef int archive_switch_callback(struct archive *, void *_client_data1, - void *_client_data2); - -/* - * Returns a passphrase used for encryption or decryption, NULL on nothing - * to do and give it up. - */ -typedef const char *archive_passphrase_callback(struct archive *, - void *_client_data); - -/* - * Codes to identify various stream filters. - */ -#define ARCHIVE_FILTER_NONE 0 -#define ARCHIVE_FILTER_GZIP 1 -#define ARCHIVE_FILTER_BZIP2 2 -#define ARCHIVE_FILTER_COMPRESS 3 -#define ARCHIVE_FILTER_PROGRAM 4 -#define ARCHIVE_FILTER_LZMA 5 -#define ARCHIVE_FILTER_XZ 6 -#define ARCHIVE_FILTER_UU 7 -#define ARCHIVE_FILTER_RPM 8 -#define ARCHIVE_FILTER_LZIP 9 -#define ARCHIVE_FILTER_LRZIP 10 -#define ARCHIVE_FILTER_LZOP 11 -#define ARCHIVE_FILTER_GRZIP 12 -#define ARCHIVE_FILTER_LZ4 13 -#define ARCHIVE_FILTER_ZSTD 14 - -#if ARCHIVE_VERSION_NUMBER < 4000000 -#define ARCHIVE_COMPRESSION_NONE ARCHIVE_FILTER_NONE -#define ARCHIVE_COMPRESSION_GZIP ARCHIVE_FILTER_GZIP -#define ARCHIVE_COMPRESSION_BZIP2 ARCHIVE_FILTER_BZIP2 -#define ARCHIVE_COMPRESSION_COMPRESS ARCHIVE_FILTER_COMPRESS -#define ARCHIVE_COMPRESSION_PROGRAM ARCHIVE_FILTER_PROGRAM -#define ARCHIVE_COMPRESSION_LZMA ARCHIVE_FILTER_LZMA -#define ARCHIVE_COMPRESSION_XZ ARCHIVE_FILTER_XZ -#define ARCHIVE_COMPRESSION_UU ARCHIVE_FILTER_UU -#define ARCHIVE_COMPRESSION_RPM ARCHIVE_FILTER_RPM -#define ARCHIVE_COMPRESSION_LZIP ARCHIVE_FILTER_LZIP -#define ARCHIVE_COMPRESSION_LRZIP ARCHIVE_FILTER_LRZIP -#endif - -/* - * Codes returned by archive_format. - * - * Top 16 bits identifies the format family (e.g., "tar"); lower - * 16 bits indicate the variant. This is updated by read_next_header. - * Note that the lower 16 bits will often vary from entry to entry. - * In some cases, this variation occurs as libarchive learns more about - * the archive (for example, later entries might utilize extensions that - * weren't necessary earlier in the archive; in this case, libarchive - * will change the format code to indicate the extended format that - * was used). In other cases, it's because different tools have - * modified the archive and so different parts of the archive - * actually have slightly different formats. (Both tar and cpio store - * format codes in each entry, so it is quite possible for each - * entry to be in a different format.) - */ -#define ARCHIVE_FORMAT_BASE_MASK 0xff0000 -#define ARCHIVE_FORMAT_CPIO 0x10000 -#define ARCHIVE_FORMAT_CPIO_POSIX (ARCHIVE_FORMAT_CPIO | 1) -#define ARCHIVE_FORMAT_CPIO_BIN_LE (ARCHIVE_FORMAT_CPIO | 2) -#define ARCHIVE_FORMAT_CPIO_BIN_BE (ARCHIVE_FORMAT_CPIO | 3) -#define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC (ARCHIVE_FORMAT_CPIO | 4) -#define ARCHIVE_FORMAT_CPIO_SVR4_CRC (ARCHIVE_FORMAT_CPIO | 5) -#define ARCHIVE_FORMAT_CPIO_AFIO_LARGE (ARCHIVE_FORMAT_CPIO | 6) -#define ARCHIVE_FORMAT_SHAR 0x20000 -#define ARCHIVE_FORMAT_SHAR_BASE (ARCHIVE_FORMAT_SHAR | 1) -#define ARCHIVE_FORMAT_SHAR_DUMP (ARCHIVE_FORMAT_SHAR | 2) -#define ARCHIVE_FORMAT_TAR 0x30000 -#define ARCHIVE_FORMAT_TAR_USTAR (ARCHIVE_FORMAT_TAR | 1) -#define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE (ARCHIVE_FORMAT_TAR | 2) -#define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED (ARCHIVE_FORMAT_TAR | 3) -#define ARCHIVE_FORMAT_TAR_GNUTAR (ARCHIVE_FORMAT_TAR | 4) -#define ARCHIVE_FORMAT_ISO9660 0x40000 -#define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE (ARCHIVE_FORMAT_ISO9660 | 1) -#define ARCHIVE_FORMAT_ZIP 0x50000 -#define ARCHIVE_FORMAT_EMPTY 0x60000 -#define ARCHIVE_FORMAT_AR 0x70000 -#define ARCHIVE_FORMAT_AR_GNU (ARCHIVE_FORMAT_AR | 1) -#define ARCHIVE_FORMAT_AR_BSD (ARCHIVE_FORMAT_AR | 2) -#define ARCHIVE_FORMAT_MTREE 0x80000 -#define ARCHIVE_FORMAT_RAW 0x90000 -#define ARCHIVE_FORMAT_XAR 0xA0000 -#define ARCHIVE_FORMAT_LHA 0xB0000 -#define ARCHIVE_FORMAT_CAB 0xC0000 -#define ARCHIVE_FORMAT_RAR 0xD0000 -#define ARCHIVE_FORMAT_7ZIP 0xE0000 -#define ARCHIVE_FORMAT_WARC 0xF0000 -#define ARCHIVE_FORMAT_RAR_V5 0x100000 - -/* - * Codes returned by archive_read_format_capabilities(). - * - * This list can be extended with values between 0 and 0xffff. - * The original purpose of this list was to let different archive - * format readers expose their general capabilities in terms of - * encryption. - */ -#define ARCHIVE_READ_FORMAT_CAPS_NONE (0) /* no special capabilities */ -#define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_DATA (1<<0) /* reader can detect encrypted data */ -#define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_METADATA (1<<1) /* reader can detect encryptable metadata (pathname, mtime, etc.) */ - -/* - * Codes returned by archive_read_has_encrypted_entries(). - * - * In case the archive does not support encryption detection at all - * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned. If the reader - * for some other reason (e.g. not enough bytes read) cannot say if - * there are encrypted entries, ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW - * is returned. - */ -#define ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED -2 -#define ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW -1 - -/*- - * Basic outline for reading an archive: - * 1) Ask archive_read_new for an archive reader object. - * 2) Update any global properties as appropriate. - * In particular, you'll certainly want to call appropriate - * archive_read_support_XXX functions. - * 3) Call archive_read_open_XXX to open the archive - * 4) Repeatedly call archive_read_next_header to get information about - * successive archive entries. Call archive_read_data to extract - * data for entries of interest. - * 5) Call archive_read_free to end processing. - */ -__LA_DECL struct archive *archive_read_new(void); - -/* - * The archive_read_support_XXX calls enable auto-detect for this - * archive handle. They also link in the necessary support code. - * For example, if you don't want bzlib linked in, don't invoke - * support_compression_bzip2(). The "all" functions provide the - * obvious shorthand. - */ - -#if ARCHIVE_VERSION_NUMBER < 4000000 -__LA_DECL int archive_read_support_compression_all(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_bzip2(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_compress(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_gzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_lzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_lzma(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_none(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_program(struct archive *, - const char *command) __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_program_signature - (struct archive *, const char *, - const void * /* match */, size_t) __LA_DEPRECATED; - -__LA_DECL int archive_read_support_compression_rpm(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_uu(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_read_support_compression_xz(struct archive *) - __LA_DEPRECATED; -#endif - -__LA_DECL int archive_read_support_filter_all(struct archive *); -__LA_DECL int archive_read_support_filter_by_code(struct archive *, int); -__LA_DECL int archive_read_support_filter_bzip2(struct archive *); -__LA_DECL int archive_read_support_filter_compress(struct archive *); -__LA_DECL int archive_read_support_filter_gzip(struct archive *); -__LA_DECL int archive_read_support_filter_grzip(struct archive *); -__LA_DECL int archive_read_support_filter_lrzip(struct archive *); -__LA_DECL int archive_read_support_filter_lz4(struct archive *); -__LA_DECL int archive_read_support_filter_lzip(struct archive *); -__LA_DECL int archive_read_support_filter_lzma(struct archive *); -__LA_DECL int archive_read_support_filter_lzop(struct archive *); -__LA_DECL int archive_read_support_filter_none(struct archive *); -__LA_DECL int archive_read_support_filter_program(struct archive *, - const char *command); -__LA_DECL int archive_read_support_filter_program_signature - (struct archive *, const char * /* cmd */, - const void * /* match */, size_t); -__LA_DECL int archive_read_support_filter_rpm(struct archive *); -__LA_DECL int archive_read_support_filter_uu(struct archive *); -__LA_DECL int archive_read_support_filter_xz(struct archive *); -__LA_DECL int archive_read_support_filter_zstd(struct archive *); - -__LA_DECL int archive_read_support_format_7zip(struct archive *); -__LA_DECL int archive_read_support_format_all(struct archive *); -__LA_DECL int archive_read_support_format_ar(struct archive *); -__LA_DECL int archive_read_support_format_by_code(struct archive *, int); -__LA_DECL int archive_read_support_format_cab(struct archive *); -__LA_DECL int archive_read_support_format_cpio(struct archive *); -__LA_DECL int archive_read_support_format_empty(struct archive *); -__LA_DECL int archive_read_support_format_gnutar(struct archive *); -__LA_DECL int archive_read_support_format_iso9660(struct archive *); -__LA_DECL int archive_read_support_format_lha(struct archive *); -__LA_DECL int archive_read_support_format_mtree(struct archive *); -__LA_DECL int archive_read_support_format_rar(struct archive *); -__LA_DECL int archive_read_support_format_rar5(struct archive *); -__LA_DECL int archive_read_support_format_raw(struct archive *); -__LA_DECL int archive_read_support_format_tar(struct archive *); -__LA_DECL int archive_read_support_format_warc(struct archive *); -__LA_DECL int archive_read_support_format_xar(struct archive *); -/* archive_read_support_format_zip() enables both streamable and seekable - * zip readers. */ -__LA_DECL int archive_read_support_format_zip(struct archive *); -/* Reads Zip archives as stream from beginning to end. Doesn't - * correctly handle SFX ZIP files or ZIP archives that have been modified - * in-place. */ -__LA_DECL int archive_read_support_format_zip_streamable(struct archive *); -/* Reads starting from central directory; requires seekable input. */ -__LA_DECL int archive_read_support_format_zip_seekable(struct archive *); - -/* Functions to manually set the format and filters to be used. This is - * useful to bypass the bidding process when the format and filters to use - * is known in advance. - */ -__LA_DECL int archive_read_set_format(struct archive *, int); -__LA_DECL int archive_read_append_filter(struct archive *, int); -__LA_DECL int archive_read_append_filter_program(struct archive *, - const char *); -__LA_DECL int archive_read_append_filter_program_signature - (struct archive *, const char *, const void * /* match */, size_t); - -/* Set various callbacks. */ -__LA_DECL int archive_read_set_open_callback(struct archive *, - archive_open_callback *); -__LA_DECL int archive_read_set_read_callback(struct archive *, - archive_read_callback *); -__LA_DECL int archive_read_set_seek_callback(struct archive *, - archive_seek_callback *); -__LA_DECL int archive_read_set_skip_callback(struct archive *, - archive_skip_callback *); -__LA_DECL int archive_read_set_close_callback(struct archive *, - archive_close_callback *); -/* Callback used to switch between one data object to the next */ -__LA_DECL int archive_read_set_switch_callback(struct archive *, - archive_switch_callback *); - -/* This sets the first data object. */ -__LA_DECL int archive_read_set_callback_data(struct archive *, void *); -/* This sets data object at specified index */ -__LA_DECL int archive_read_set_callback_data2(struct archive *, void *, - unsigned int); -/* This adds a data object at the specified index. */ -__LA_DECL int archive_read_add_callback_data(struct archive *, void *, - unsigned int); -/* This appends a data object to the end of list */ -__LA_DECL int archive_read_append_callback_data(struct archive *, void *); -/* This prepends a data object to the beginning of list */ -__LA_DECL int archive_read_prepend_callback_data(struct archive *, void *); - -/* Opening freezes the callbacks. */ -__LA_DECL int archive_read_open1(struct archive *); - -/* Convenience wrappers around the above. */ -__LA_DECL int archive_read_open(struct archive *, void *_client_data, - archive_open_callback *, archive_read_callback *, - archive_close_callback *); -__LA_DECL int archive_read_open2(struct archive *, void *_client_data, - archive_open_callback *, archive_read_callback *, - archive_skip_callback *, archive_close_callback *); - -/* - * A variety of shortcuts that invoke archive_read_open() with - * canned callbacks suitable for common situations. The ones that - * accept a block size handle tape blocking correctly. - */ -/* Use this if you know the filename. Note: NULL indicates stdin. */ -__LA_DECL int archive_read_open_filename(struct archive *, - const char *_filename, size_t _block_size); -/* Use this for reading multivolume files by filenames. - * NOTE: Must be NULL terminated. Sorting is NOT done. */ -__LA_DECL int archive_read_open_filenames(struct archive *, - const char **_filenames, size_t _block_size); -__LA_DECL int archive_read_open_filename_w(struct archive *, - const wchar_t *_filename, size_t _block_size); -/* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */ -__LA_DECL int archive_read_open_file(struct archive *, - const char *_filename, size_t _block_size) __LA_DEPRECATED; -/* Read an archive that's stored in memory. */ -__LA_DECL int archive_read_open_memory(struct archive *, - const void * buff, size_t size); -/* A more involved version that is only used for internal testing. */ -__LA_DECL int archive_read_open_memory2(struct archive *a, const void *buff, - size_t size, size_t read_size); -/* Read an archive that's already open, using the file descriptor. */ -__LA_DECL int archive_read_open_fd(struct archive *, int _fd, - size_t _block_size); -/* Read an archive that's already open, using a FILE *. */ -/* Note: DO NOT use this with tape drives. */ -__LA_DECL int archive_read_open_FILE(struct archive *, FILE *_file); - -/* Parses and returns next entry header. */ -__LA_DECL int archive_read_next_header(struct archive *, - struct archive_entry **); - -/* Parses and returns next entry header using the archive_entry passed in */ -__LA_DECL int archive_read_next_header2(struct archive *, - struct archive_entry *); - -/* - * Retrieve the byte offset in UNCOMPRESSED data where last-read - * header started. - */ -__LA_DECL la_int64_t archive_read_header_position(struct archive *); - -/* - * Returns 1 if the archive contains at least one encrypted entry. - * If the archive format not support encryption at all - * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned. - * If for any other reason (e.g. not enough data read so far) - * we cannot say whether there are encrypted entries, then - * ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW is returned. - * In general, this function will return values below zero when the - * reader is uncertain or totally incapable of encryption support. - * When this function returns 0 you can be sure that the reader - * supports encryption detection but no encrypted entries have - * been found yet. - * - * NOTE: If the metadata/header of an archive is also encrypted, you - * cannot rely on the number of encrypted entries. That is why this - * function does not return the number of encrypted entries but# - * just shows that there are some. - */ -__LA_DECL int archive_read_has_encrypted_entries(struct archive *); - -/* - * Returns a bitmask of capabilities that are supported by the archive format reader. - * If the reader has no special capabilities, ARCHIVE_READ_FORMAT_CAPS_NONE is returned. - */ -__LA_DECL int archive_read_format_capabilities(struct archive *); - -/* Read data from the body of an entry. Similar to read(2). */ -__LA_DECL la_ssize_t archive_read_data(struct archive *, - void *, size_t); - -/* Seek within the body of an entry. Similar to lseek(2). */ -__LA_DECL la_int64_t archive_seek_data(struct archive *, la_int64_t, int); - -/* - * A zero-copy version of archive_read_data that also exposes the file offset - * of each returned block. Note that the client has no way to specify - * the desired size of the block. The API does guarantee that offsets will - * be strictly increasing and that returned blocks will not overlap. - */ -__LA_DECL int archive_read_data_block(struct archive *a, - const void **buff, size_t *size, la_int64_t *offset); - -/*- - * Some convenience functions that are built on archive_read_data: - * 'skip': skips entire entry - * 'into_buffer': writes data into memory buffer that you provide - * 'into_fd': writes data to specified filedes - */ -__LA_DECL int archive_read_data_skip(struct archive *); -__LA_DECL int archive_read_data_into_fd(struct archive *, int fd); - -/* - * Set read options. - */ -/* Apply option to the format only. */ -__LA_DECL int archive_read_set_format_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to the filter only. */ -__LA_DECL int archive_read_set_filter_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to both the format and the filter. */ -__LA_DECL int archive_read_set_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option string to both the format and the filter. */ -__LA_DECL int archive_read_set_options(struct archive *_a, - const char *opts); - -/* - * Add a decryption passphrase. - */ -__LA_DECL int archive_read_add_passphrase(struct archive *, const char *); -__LA_DECL int archive_read_set_passphrase_callback(struct archive *, - void *client_data, archive_passphrase_callback *); - - -/*- - * Convenience function to recreate the current entry (whose header - * has just been read) on disk. - * - * This does quite a bit more than just copy data to disk. It also: - * - Creates intermediate directories as required. - * - Manages directory permissions: non-writable directories will - * be initially created with write permission enabled; when the - * archive is closed, dir permissions are edited to the values specified - * in the archive. - * - Checks hardlinks: hardlinks will not be extracted unless the - * linked-to file was also extracted within the same session. (TODO) - */ - -/* The "flags" argument selects optional behavior, 'OR' the flags you want. */ - -/* Default: Do not try to set owner/group. */ -#define ARCHIVE_EXTRACT_OWNER (0x0001) -/* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */ -#define ARCHIVE_EXTRACT_PERM (0x0002) -/* Default: Do not restore mtime/atime. */ -#define ARCHIVE_EXTRACT_TIME (0x0004) -/* Default: Replace existing files. */ -#define ARCHIVE_EXTRACT_NO_OVERWRITE (0x0008) -/* Default: Try create first, unlink only if create fails with EEXIST. */ -#define ARCHIVE_EXTRACT_UNLINK (0x0010) -/* Default: Do not restore ACLs. */ -#define ARCHIVE_EXTRACT_ACL (0x0020) -/* Default: Do not restore fflags. */ -#define ARCHIVE_EXTRACT_FFLAGS (0x0040) -/* Default: Do not restore xattrs. */ -#define ARCHIVE_EXTRACT_XATTR (0x0080) -/* Default: Do not try to guard against extracts redirected by symlinks. */ -/* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */ -#define ARCHIVE_EXTRACT_SECURE_SYMLINKS (0x0100) -/* Default: Do not reject entries with '..' as path elements. */ -#define ARCHIVE_EXTRACT_SECURE_NODOTDOT (0x0200) -/* Default: Create parent directories as needed. */ -#define ARCHIVE_EXTRACT_NO_AUTODIR (0x0400) -/* Default: Overwrite files, even if one on disk is newer. */ -#define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER (0x0800) -/* Detect blocks of 0 and write holes instead. */ -#define ARCHIVE_EXTRACT_SPARSE (0x1000) -/* Default: Do not restore Mac extended metadata. */ -/* This has no effect except on Mac OS. */ -#define ARCHIVE_EXTRACT_MAC_METADATA (0x2000) -/* Default: Use HFS+ compression if it was compressed. */ -/* This has no effect except on Mac OS v10.6 or later. */ -#define ARCHIVE_EXTRACT_NO_HFS_COMPRESSION (0x4000) -/* Default: Do not use HFS+ compression if it was not compressed. */ -/* This has no effect except on Mac OS v10.6 or later. */ -#define ARCHIVE_EXTRACT_HFS_COMPRESSION_FORCED (0x8000) -/* Default: Do not reject entries with absolute paths */ -#define ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS (0x10000) -/* Default: Do not clear no-change flags when unlinking object */ -#define ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS (0x20000) -/* Default: Do not extract atomically (using rename) */ -#define ARCHIVE_EXTRACT_SAFE_WRITES (0x40000) - -__LA_DECL int archive_read_extract(struct archive *, struct archive_entry *, - int flags); -__LA_DECL int archive_read_extract2(struct archive *, struct archive_entry *, - struct archive * /* dest */); -__LA_DECL void archive_read_extract_set_progress_callback(struct archive *, - void (*_progress_func)(void *), void *_user_data); - -/* Record the dev/ino of a file that will not be written. This is - * generally set to the dev/ino of the archive being read. */ -__LA_DECL void archive_read_extract_set_skip_file(struct archive *, - la_int64_t, la_int64_t); - -/* Close the file and release most resources. */ -__LA_DECL int archive_read_close(struct archive *); -/* Release all resources and destroy the object. */ -/* Note that archive_read_free will call archive_read_close for you. */ -__LA_DECL int archive_read_free(struct archive *); -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* Synonym for archive_read_free() for backwards compatibility. */ -__LA_DECL int archive_read_finish(struct archive *) __LA_DEPRECATED; -#endif - -/*- - * To create an archive: - * 1) Ask archive_write_new for an archive writer object. - * 2) Set any global properties. In particular, you should set - * the compression and format to use. - * 3) Call archive_write_open to open the file (most people - * will use archive_write_open_file or archive_write_open_fd, - * which provide convenient canned I/O callbacks for you). - * 4) For each entry: - * - construct an appropriate struct archive_entry structure - * - archive_write_header to write the header - * - archive_write_data to write the entry data - * 5) archive_write_close to close the output - * 6) archive_write_free to cleanup the writer and release resources - */ -__LA_DECL struct archive *archive_write_new(void); -__LA_DECL int archive_write_set_bytes_per_block(struct archive *, - int bytes_per_block); -__LA_DECL int archive_write_get_bytes_per_block(struct archive *); -/* XXX This is badly misnamed; suggestions appreciated. XXX */ -__LA_DECL int archive_write_set_bytes_in_last_block(struct archive *, - int bytes_in_last_block); -__LA_DECL int archive_write_get_bytes_in_last_block(struct archive *); - -/* The dev/ino of a file that won't be archived. This is used - * to avoid recursively adding an archive to itself. */ -__LA_DECL int archive_write_set_skip_file(struct archive *, - la_int64_t, la_int64_t); - -#if ARCHIVE_VERSION_NUMBER < 4000000 -__LA_DECL int archive_write_set_compression_bzip2(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_compress(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_gzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_lzip(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_lzma(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_none(struct archive *) - __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_program(struct archive *, - const char *cmd) __LA_DEPRECATED; -__LA_DECL int archive_write_set_compression_xz(struct archive *) - __LA_DEPRECATED; -#endif - -/* A convenience function to set the filter based on the code. */ -__LA_DECL int archive_write_add_filter(struct archive *, int filter_code); -__LA_DECL int archive_write_add_filter_by_name(struct archive *, - const char *name); -__LA_DECL int archive_write_add_filter_b64encode(struct archive *); -__LA_DECL int archive_write_add_filter_bzip2(struct archive *); -__LA_DECL int archive_write_add_filter_compress(struct archive *); -__LA_DECL int archive_write_add_filter_grzip(struct archive *); -__LA_DECL int archive_write_add_filter_gzip(struct archive *); -__LA_DECL int archive_write_add_filter_lrzip(struct archive *); -__LA_DECL int archive_write_add_filter_lz4(struct archive *); -__LA_DECL int archive_write_add_filter_lzip(struct archive *); -__LA_DECL int archive_write_add_filter_lzma(struct archive *); -__LA_DECL int archive_write_add_filter_lzop(struct archive *); -__LA_DECL int archive_write_add_filter_none(struct archive *); -__LA_DECL int archive_write_add_filter_program(struct archive *, - const char *cmd); -__LA_DECL int archive_write_add_filter_uuencode(struct archive *); -__LA_DECL int archive_write_add_filter_xz(struct archive *); -__LA_DECL int archive_write_add_filter_zstd(struct archive *); - - -/* A convenience function to set the format based on the code or name. */ -__LA_DECL int archive_write_set_format(struct archive *, int format_code); -__LA_DECL int archive_write_set_format_by_name(struct archive *, - const char *name); -/* To minimize link pollution, use one or more of the following. */ -__LA_DECL int archive_write_set_format_7zip(struct archive *); -__LA_DECL int archive_write_set_format_ar_bsd(struct archive *); -__LA_DECL int archive_write_set_format_ar_svr4(struct archive *); -__LA_DECL int archive_write_set_format_cpio(struct archive *); -__LA_DECL int archive_write_set_format_cpio_newc(struct archive *); -__LA_DECL int archive_write_set_format_gnutar(struct archive *); -__LA_DECL int archive_write_set_format_iso9660(struct archive *); -__LA_DECL int archive_write_set_format_mtree(struct archive *); -__LA_DECL int archive_write_set_format_mtree_classic(struct archive *); -/* TODO: int archive_write_set_format_old_tar(struct archive *); */ -__LA_DECL int archive_write_set_format_pax(struct archive *); -__LA_DECL int archive_write_set_format_pax_restricted(struct archive *); -__LA_DECL int archive_write_set_format_raw(struct archive *); -__LA_DECL int archive_write_set_format_shar(struct archive *); -__LA_DECL int archive_write_set_format_shar_dump(struct archive *); -__LA_DECL int archive_write_set_format_ustar(struct archive *); -__LA_DECL int archive_write_set_format_v7tar(struct archive *); -__LA_DECL int archive_write_set_format_warc(struct archive *); -__LA_DECL int archive_write_set_format_xar(struct archive *); -__LA_DECL int archive_write_set_format_zip(struct archive *); -__LA_DECL int archive_write_set_format_filter_by_ext(struct archive *a, const char *filename); -__LA_DECL int archive_write_set_format_filter_by_ext_def(struct archive *a, const char *filename, const char * def_ext); -__LA_DECL int archive_write_zip_set_compression_deflate(struct archive *); -__LA_DECL int archive_write_zip_set_compression_store(struct archive *); -__LA_DECL int archive_write_open(struct archive *, void *, - archive_open_callback *, archive_write_callback *, - archive_close_callback *); -__LA_DECL int archive_write_open_fd(struct archive *, int _fd); -__LA_DECL int archive_write_open_filename(struct archive *, const char *_file); -__LA_DECL int archive_write_open_filename_w(struct archive *, - const wchar_t *_file); -/* A deprecated synonym for archive_write_open_filename() */ -__LA_DECL int archive_write_open_file(struct archive *, const char *_file) - __LA_DEPRECATED; -__LA_DECL int archive_write_open_FILE(struct archive *, FILE *); -/* _buffSize is the size of the buffer, _used refers to a variable that - * will be updated after each write into the buffer. */ -__LA_DECL int archive_write_open_memory(struct archive *, - void *_buffer, size_t _buffSize, size_t *_used); - -/* - * Note that the library will truncate writes beyond the size provided - * to archive_write_header or pad if the provided data is short. - */ -__LA_DECL int archive_write_header(struct archive *, - struct archive_entry *); -__LA_DECL int archive_write_data(struct archive *, - const void *, size_t); - -/* This interface is currently only available for archive_write_disk handles. */ -__LA_DECL int archive_write_data_block(struct archive *, - const void *, size_t, la_int64_t); - -__LA_DECL int archive_write_finish_entry(struct archive *); -__LA_DECL int archive_write_close(struct archive *); -/* Marks the archive as FATAL so that a subsequent free() operation - * won't try to close() cleanly. Provides a fast abort capability - * when the client discovers that things have gone wrong. */ -__LA_DECL int archive_write_fail(struct archive *); -/* This can fail if the archive wasn't already closed, in which case - * archive_write_free() will implicitly call archive_write_close(). */ -__LA_DECL int archive_write_free(struct archive *); -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* Synonym for archive_write_free() for backwards compatibility. */ -__LA_DECL int archive_write_finish(struct archive *) __LA_DEPRECATED; -#endif - -/* - * Set write options. - */ -/* Apply option to the format only. */ -__LA_DECL int archive_write_set_format_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to the filter only. */ -__LA_DECL int archive_write_set_filter_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option to both the format and the filter. */ -__LA_DECL int archive_write_set_option(struct archive *_a, - const char *m, const char *o, - const char *v); -/* Apply option string to both the format and the filter. */ -__LA_DECL int archive_write_set_options(struct archive *_a, - const char *opts); - -/* - * Set a encryption passphrase. - */ -__LA_DECL int archive_write_set_passphrase(struct archive *_a, const char *p); -__LA_DECL int archive_write_set_passphrase_callback(struct archive *, - void *client_data, archive_passphrase_callback *); - -/*- - * ARCHIVE_WRITE_DISK API - * - * To create objects on disk: - * 1) Ask archive_write_disk_new for a new archive_write_disk object. - * 2) Set any global properties. In particular, you probably - * want to set the options. - * 3) For each entry: - * - construct an appropriate struct archive_entry structure - * - archive_write_header to create the file/dir/etc on disk - * - archive_write_data to write the entry data - * 4) archive_write_free to cleanup the writer and release resources - * - * In particular, you can use this in conjunction with archive_read() - * to pull entries out of an archive and create them on disk. - */ -__LA_DECL struct archive *archive_write_disk_new(void); -/* This file will not be overwritten. */ -__LA_DECL int archive_write_disk_set_skip_file(struct archive *, - la_int64_t, la_int64_t); -/* Set flags to control how the next item gets created. - * This accepts a bitmask of ARCHIVE_EXTRACT_XXX flags defined above. */ -__LA_DECL int archive_write_disk_set_options(struct archive *, - int flags); -/* - * The lookup functions are given uname/uid (or gname/gid) pairs and - * return a uid (gid) suitable for this system. These are used for - * restoring ownership and for setting ACLs. The default functions - * are naive, they just return the uid/gid. These are small, so reasonable - * for applications that don't need to preserve ownership; they - * are probably also appropriate for applications that are doing - * same-system backup and restore. - */ -/* - * The "standard" lookup functions use common system calls to lookup - * the uname/gname, falling back to the uid/gid if the names can't be - * found. They cache lookups and are reasonably fast, but can be very - * large, so they are not used unless you ask for them. In - * particular, these match the specifications of POSIX "pax" and old - * POSIX "tar". - */ -__LA_DECL int archive_write_disk_set_standard_lookup(struct archive *); -/* - * If neither the default (naive) nor the standard (big) functions suit - * your needs, you can write your own and register them. Be sure to - * include a cleanup function if you have allocated private data. - */ -__LA_DECL int archive_write_disk_set_group_lookup(struct archive *, - void * /* private_data */, - la_int64_t (*)(void *, const char *, la_int64_t), - void (* /* cleanup */)(void *)); -__LA_DECL int archive_write_disk_set_user_lookup(struct archive *, - void * /* private_data */, - la_int64_t (*)(void *, const char *, la_int64_t), - void (* /* cleanup */)(void *)); -__LA_DECL la_int64_t archive_write_disk_gid(struct archive *, const char *, la_int64_t); -__LA_DECL la_int64_t archive_write_disk_uid(struct archive *, const char *, la_int64_t); - -/* - * ARCHIVE_READ_DISK API - * - * This is still evolving and somewhat experimental. - */ -__LA_DECL struct archive *archive_read_disk_new(void); -/* The names for symlink modes here correspond to an old BSD - * command-line argument convention: -L, -P, -H */ -/* Follow all symlinks. */ -__LA_DECL int archive_read_disk_set_symlink_logical(struct archive *); -/* Follow no symlinks. */ -__LA_DECL int archive_read_disk_set_symlink_physical(struct archive *); -/* Follow symlink initially, then not. */ -__LA_DECL int archive_read_disk_set_symlink_hybrid(struct archive *); -/* TODO: Handle Linux stat32/stat64 ugliness. */ -__LA_DECL int archive_read_disk_entry_from_file(struct archive *, - struct archive_entry *, int /* fd */, const struct stat *); -/* Look up gname for gid or uname for uid. */ -/* Default implementations are very, very stupid. */ -__LA_DECL const char *archive_read_disk_gname(struct archive *, la_int64_t); -__LA_DECL const char *archive_read_disk_uname(struct archive *, la_int64_t); -/* "Standard" implementation uses getpwuid_r, getgrgid_r and caches the - * results for performance. */ -__LA_DECL int archive_read_disk_set_standard_lookup(struct archive *); -/* You can install your own lookups if you like. */ -__LA_DECL int archive_read_disk_set_gname_lookup(struct archive *, - void * /* private_data */, - const char *(* /* lookup_fn */)(void *, la_int64_t), - void (* /* cleanup_fn */)(void *)); -__LA_DECL int archive_read_disk_set_uname_lookup(struct archive *, - void * /* private_data */, - const char *(* /* lookup_fn */)(void *, la_int64_t), - void (* /* cleanup_fn */)(void *)); -/* Start traversal. */ -__LA_DECL int archive_read_disk_open(struct archive *, const char *); -__LA_DECL int archive_read_disk_open_w(struct archive *, const wchar_t *); -/* - * Request that current entry be visited. If you invoke it on every - * directory, you'll get a physical traversal. This is ignored if the - * current entry isn't a directory or a link to a directory. So, if - * you invoke this on every returned path, you'll get a full logical - * traversal. - */ -__LA_DECL int archive_read_disk_descend(struct archive *); -__LA_DECL int archive_read_disk_can_descend(struct archive *); -__LA_DECL int archive_read_disk_current_filesystem(struct archive *); -__LA_DECL int archive_read_disk_current_filesystem_is_synthetic(struct archive *); -__LA_DECL int archive_read_disk_current_filesystem_is_remote(struct archive *); -/* Request that the access time of the entry visited by traversal be restored. */ -__LA_DECL int archive_read_disk_set_atime_restored(struct archive *); -/* - * Set behavior. The "flags" argument selects optional behavior. - */ -/* Request that the access time of the entry visited by traversal be restored. - * This is the same as archive_read_disk_set_atime_restored. */ -#define ARCHIVE_READDISK_RESTORE_ATIME (0x0001) -/* Default: Do not skip an entry which has nodump flags. */ -#define ARCHIVE_READDISK_HONOR_NODUMP (0x0002) -/* Default: Skip a mac resource fork file whose prefix is "._" because of - * using copyfile. */ -#define ARCHIVE_READDISK_MAC_COPYFILE (0x0004) -/* Default: Traverse mount points. */ -#define ARCHIVE_READDISK_NO_TRAVERSE_MOUNTS (0x0008) -/* Default: Xattrs are read from disk. */ -#define ARCHIVE_READDISK_NO_XATTR (0x0010) -/* Default: ACLs are read from disk. */ -#define ARCHIVE_READDISK_NO_ACL (0x0020) -/* Default: File flags are read from disk. */ -#define ARCHIVE_READDISK_NO_FFLAGS (0x0040) - -__LA_DECL int archive_read_disk_set_behavior(struct archive *, - int flags); - -/* - * Set archive_match object that will be used in archive_read_disk to - * know whether an entry should be skipped. The callback function - * _excluded_func will be invoked when an entry is skipped by the result - * of archive_match. - */ -__LA_DECL int archive_read_disk_set_matching(struct archive *, - struct archive *_matching, void (*_excluded_func) - (struct archive *, void *, struct archive_entry *), - void *_client_data); -__LA_DECL int archive_read_disk_set_metadata_filter_callback(struct archive *, - int (*_metadata_filter_func)(struct archive *, void *, - struct archive_entry *), void *_client_data); - -/* Simplified cleanup interface; - * This calls archive_read_free() or archive_write_free() as needed. */ -__LA_DECL int archive_free(struct archive *); - -/* - * Accessor functions to read/set various information in - * the struct archive object: - */ - -/* Number of filters in the current filter pipeline. */ -/* Filter #0 is the one closest to the format, -1 is a synonym for the - * last filter, which is always the pseudo-filter that wraps the - * client callbacks. */ -__LA_DECL int archive_filter_count(struct archive *); -__LA_DECL la_int64_t archive_filter_bytes(struct archive *, int); -__LA_DECL int archive_filter_code(struct archive *, int); -__LA_DECL const char * archive_filter_name(struct archive *, int); - -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* These don't properly handle multiple filters, so are deprecated and - * will eventually be removed. */ -/* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, -1); */ -__LA_DECL la_int64_t archive_position_compressed(struct archive *) - __LA_DEPRECATED; -/* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, 0); */ -__LA_DECL la_int64_t archive_position_uncompressed(struct archive *) - __LA_DEPRECATED; -/* As of libarchive 3.0, this is an alias for archive_filter_name(a, 0); */ -__LA_DECL const char *archive_compression_name(struct archive *) - __LA_DEPRECATED; -/* As of libarchive 3.0, this is an alias for archive_filter_code(a, 0); */ -__LA_DECL int archive_compression(struct archive *) - __LA_DEPRECATED; -#endif - -__LA_DECL int archive_errno(struct archive *); -__LA_DECL const char *archive_error_string(struct archive *); -__LA_DECL const char *archive_format_name(struct archive *); -__LA_DECL int archive_format(struct archive *); -__LA_DECL void archive_clear_error(struct archive *); -__LA_DECL void archive_set_error(struct archive *, int _err, - const char *fmt, ...) __LA_PRINTF(3, 4); -__LA_DECL void archive_copy_error(struct archive *dest, - struct archive *src); -__LA_DECL int archive_file_count(struct archive *); - -/* - * ARCHIVE_MATCH API - */ -__LA_DECL struct archive *archive_match_new(void); -__LA_DECL int archive_match_free(struct archive *); - -/* - * Test if archive_entry is excluded. - * This is a convenience function. This is the same as calling all - * archive_match_path_excluded, archive_match_time_excluded - * and archive_match_owner_excluded. - */ -__LA_DECL int archive_match_excluded(struct archive *, - struct archive_entry *); - -/* - * Test if pathname is excluded. The conditions are set by following functions. - */ -__LA_DECL int archive_match_path_excluded(struct archive *, - struct archive_entry *); -/* Control recursive inclusion of directory content when directory is included. Default on. */ -__LA_DECL int archive_match_set_inclusion_recursion(struct archive *, int); -/* Add exclusion pathname pattern. */ -__LA_DECL int archive_match_exclude_pattern(struct archive *, const char *); -__LA_DECL int archive_match_exclude_pattern_w(struct archive *, - const wchar_t *); -/* Add exclusion pathname pattern from file. */ -__LA_DECL int archive_match_exclude_pattern_from_file(struct archive *, - const char *, int _nullSeparator); -__LA_DECL int archive_match_exclude_pattern_from_file_w(struct archive *, - const wchar_t *, int _nullSeparator); -/* Add inclusion pathname pattern. */ -__LA_DECL int archive_match_include_pattern(struct archive *, const char *); -__LA_DECL int archive_match_include_pattern_w(struct archive *, - const wchar_t *); -/* Add inclusion pathname pattern from file. */ -__LA_DECL int archive_match_include_pattern_from_file(struct archive *, - const char *, int _nullSeparator); -__LA_DECL int archive_match_include_pattern_from_file_w(struct archive *, - const wchar_t *, int _nullSeparator); -/* - * How to get statistic information for inclusion patterns. - */ -/* Return the amount number of unmatched inclusion patterns. */ -__LA_DECL int archive_match_path_unmatched_inclusions(struct archive *); -/* Return the pattern of unmatched inclusion with ARCHIVE_OK. - * Return ARCHIVE_EOF if there is no inclusion pattern. */ -__LA_DECL int archive_match_path_unmatched_inclusions_next( - struct archive *, const char **); -__LA_DECL int archive_match_path_unmatched_inclusions_next_w( - struct archive *, const wchar_t **); - -/* - * Test if a file is excluded by its time stamp. - * The conditions are set by following functions. - */ -__LA_DECL int archive_match_time_excluded(struct archive *, - struct archive_entry *); - -/* - * Flags to tell a matching type of time stamps. These are used for - * following functions. - */ -/* Time flag: mtime to be tested. */ -#define ARCHIVE_MATCH_MTIME (0x0100) -/* Time flag: ctime to be tested. */ -#define ARCHIVE_MATCH_CTIME (0x0200) -/* Comparison flag: Match the time if it is newer than. */ -#define ARCHIVE_MATCH_NEWER (0x0001) -/* Comparison flag: Match the time if it is older than. */ -#define ARCHIVE_MATCH_OLDER (0x0002) -/* Comparison flag: Match the time if it is equal to. */ -#define ARCHIVE_MATCH_EQUAL (0x0010) -/* Set inclusion time. */ -__LA_DECL int archive_match_include_time(struct archive *, int _flag, - time_t _sec, long _nsec); -/* Set inclusion time by a date string. */ -__LA_DECL int archive_match_include_date(struct archive *, int _flag, - const char *_datestr); -__LA_DECL int archive_match_include_date_w(struct archive *, int _flag, - const wchar_t *_datestr); -/* Set inclusion time by a particular file. */ -__LA_DECL int archive_match_include_file_time(struct archive *, - int _flag, const char *_pathname); -__LA_DECL int archive_match_include_file_time_w(struct archive *, - int _flag, const wchar_t *_pathname); -/* Add exclusion entry. */ -__LA_DECL int archive_match_exclude_entry(struct archive *, - int _flag, struct archive_entry *); - -/* - * Test if a file is excluded by its uid ,gid, uname or gname. - * The conditions are set by following functions. - */ -__LA_DECL int archive_match_owner_excluded(struct archive *, - struct archive_entry *); -/* Add inclusion uid, gid, uname and gname. */ -__LA_DECL int archive_match_include_uid(struct archive *, la_int64_t); -__LA_DECL int archive_match_include_gid(struct archive *, la_int64_t); -__LA_DECL int archive_match_include_uname(struct archive *, const char *); -__LA_DECL int archive_match_include_uname_w(struct archive *, - const wchar_t *); -__LA_DECL int archive_match_include_gname(struct archive *, const char *); -__LA_DECL int archive_match_include_gname_w(struct archive *, - const wchar_t *); - -/* Utility functions */ -/* Convenience function to sort a NULL terminated list of strings */ -__LA_DECL int archive_utility_string_sort(char **); - -#ifdef __cplusplus -} -#endif - -/* These are meaningless outside of this header. */ -#undef __LA_DECL - -#endif /* !ARCHIVE_H_INCLUDED */ diff --git a/oss-internship-2020/libarchive/files_diff/archive_virtual.c b/oss-internship-2020/libarchive/files_diff/archive_virtual.c deleted file mode 100644 index f509ee5..0000000 --- a/oss-internship-2020/libarchive/files_diff/archive_virtual.c +++ /dev/null @@ -1,163 +0,0 @@ -/*- - * Copyright (c) 2003-2007 Tim Kientzle - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -#include "archive_platform.h" -__FBSDID("$FreeBSD: head/lib/libarchive/archive_virtual.c 201098 2009-12-28 02:58:14Z kientzle $"); - -#include "archive.h" -#include "archive_entry.h" -#include "archive_private.h" - -int -archive_filter_code(struct archive *a, int n) -{ - return ((a->vtable->archive_filter_code)(a, n)); -} - -int -archive_filter_count(struct archive *a) -{ - return ((a->vtable->archive_filter_count)(a)); -} - -const char * -archive_filter_name(struct archive *a, int n) -{ - return ((a->vtable->archive_filter_name)(a, n)); -} - -la_int64_t -archive_filter_bytes(struct archive *a, int n) -{ - return ((a->vtable->archive_filter_bytes)(a, n)); -} - -int -archive_free(struct archive *a) -{ - if (a == NULL) - return (ARCHIVE_OK); - return ((a->vtable->archive_free)(a)); -} - -int -archive_write_close(struct archive *a) -{ - return ((a->vtable->archive_close)(a)); -} - -int -archive_read_close(struct archive *a) -{ - return ((a->vtable->archive_close)(a)); -} - -int -archive_write_fail(struct archive *a) -{ - a->state = ARCHIVE_STATE_FATAL; - return a->state; -} - -int -archive_write_free(struct archive *a) -{ - return archive_free(a); -} - -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* For backwards compatibility; will be removed with libarchive 4.0. */ -int -archive_write_finish(struct archive *a) -{ - return archive_write_free(a); -} -#endif - -int -archive_read_free(struct archive *a) -{ - return archive_free(a); -} - -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* For backwards compatibility; will be removed with libarchive 4.0. */ -int -archive_read_finish(struct archive *a) -{ - return archive_read_free(a); -} -#endif - -int -archive_write_header(struct archive *a, struct archive_entry *entry) -{ - ++a->file_count; - return ((a->vtable->archive_write_header)(a, entry)); -} - -int -archive_write_finish_entry(struct archive *a) -{ - return ((a->vtable->archive_write_finish_entry)(a)); -} - -la_ssize_t -archive_write_data(struct archive *a, const void *buff, size_t s) -{ - return ((a->vtable->archive_write_data)(a, buff, s)); -} - -la_ssize_t -archive_write_data_block(struct archive *a, const void *buff, size_t s, - la_int64_t o) -{ - if (a->vtable->archive_write_data_block == NULL) { - archive_set_error(a, ARCHIVE_ERRNO_MISC, - "archive_write_data_block not supported"); - a->state = ARCHIVE_STATE_FATAL; - return (ARCHIVE_FATAL); - } - return ((a->vtable->archive_write_data_block)(a, buff, s, o)); -} - -int -archive_read_next_header(struct archive *a, struct archive_entry **entry) -{ - return ((a->vtable->archive_read_next_header)(a, entry)); -} - -int -archive_read_next_header2(struct archive *a, struct archive_entry *entry) -{ - return ((a->vtable->archive_read_next_header2)(a, entry)); -} - -int -archive_read_data_block(struct archive *a, - const void **buff, size_t *s, la_int64_t *o) -{ - return ((a->vtable->archive_read_data_block)(a, buff, s, o)); -} diff --git a/oss-internship-2020/libarchive/files_diff/archive_virtual2.c b/oss-internship-2020/libarchive/files_diff/archive_virtual2.c deleted file mode 100644 index 9cf10fb..0000000 --- a/oss-internship-2020/libarchive/files_diff/archive_virtual2.c +++ /dev/null @@ -1,163 +0,0 @@ -/*- - * Copyright (c) 2003-2007 Tim Kientzle - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -#include "archive_platform.h" -__FBSDID("$FreeBSD: head/lib/libarchive/archive_virtual.c 201098 2009-12-28 02:58:14Z kientzle $"); - -#include "archive.h" -#include "archive_entry.h" -#include "archive_private.h" - -int -archive_filter_code(struct archive *a, int n) -{ - return ((a->vtable->archive_filter_code)(a, n)); -} - -int -archive_filter_count(struct archive *a) -{ - return ((a->vtable->archive_filter_count)(a)); -} - -const char * -archive_filter_name(struct archive *a, int n) -{ - return ((a->vtable->archive_filter_name)(a, n)); -} - -la_int64_t -archive_filter_bytes(struct archive *a, int n) -{ - return ((a->vtable->archive_filter_bytes)(a, n)); -} - -int -archive_free(struct archive *a) -{ - if (a == NULL) - return (ARCHIVE_OK); - return ((a->vtable->archive_free)(a)); -} - -int -archive_write_close(struct archive *a) -{ - return ((a->vtable->archive_close)(a)); -} - -int -archive_read_close(struct archive *a) -{ - return ((a->vtable->archive_close)(a)); -} - -int -archive_write_fail(struct archive *a) -{ - a->state = ARCHIVE_STATE_FATAL; - return a->state; -} - -int -archive_write_free(struct archive *a) -{ - return archive_free(a); -} - -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* For backwards compatibility; will be removed with libarchive 4.0. */ -int -archive_write_finish(struct archive *a) -{ - return archive_write_free(a); -} -#endif - -int -archive_read_free(struct archive *a) -{ - return archive_free(a); -} - -#if ARCHIVE_VERSION_NUMBER < 4000000 -/* For backwards compatibility; will be removed with libarchive 4.0. */ -int -archive_read_finish(struct archive *a) -{ - return archive_read_free(a); -} -#endif - -int -archive_write_header(struct archive *a, struct archive_entry *entry) -{ - ++a->file_count; - return ((a->vtable->archive_write_header)(a, entry)); -} - -int -archive_write_finish_entry(struct archive *a) -{ - return ((a->vtable->archive_write_finish_entry)(a)); -} - -int -archive_write_data(struct archive *a, const void *buff, size_t s) -{ - return ((a->vtable->archive_write_data)(a, buff, s)); -} - -int -archive_write_data_block(struct archive *a, const void *buff, size_t s, - la_int64_t o) -{ - if (a->vtable->archive_write_data_block == NULL) { - archive_set_error(a, ARCHIVE_ERRNO_MISC, - "archive_write_data_block not supported"); - a->state = ARCHIVE_STATE_FATAL; - return (ARCHIVE_FATAL); - } - return ((a->vtable->archive_write_data_block)(a, buff, s, o)); -} - -int -archive_read_next_header(struct archive *a, struct archive_entry **entry) -{ - return ((a->vtable->archive_read_next_header)(a, entry)); -} - -int -archive_read_next_header2(struct archive *a, struct archive_entry *entry) -{ - return ((a->vtable->archive_read_next_header2)(a, entry)); -} - -int -archive_read_data_block(struct archive *a, - const void **buff, size_t *s, la_int64_t *o) -{ - return ((a->vtable->archive_read_data_block)(a, buff, s, o)); -} diff --git a/oss-internship-2020/libarchive/test/CMakeLists.txt b/oss-internship-2020/libarchive/test/CMakeLists.txt index edd6691..50035e9 100644 --- a/oss-internship-2020/libarchive/test/CMakeLists.txt +++ b/oss-internship-2020/libarchive/test/CMakeLists.txt @@ -1,3 +1,16 @@ +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. include(GoogleTest) enable_testing() @@ -9,8 +22,7 @@ add_executable(sapi_minitar_test target_link_libraries(sapi_minitar_test PRIVATE sapi_minitar_lib gtest - gmock sapi::test_main ) -gtest_discover_tests(sapi_minitar_test) +gtest_discover_tests(sapi_minitar_test) \ No newline at end of file diff --git a/oss-internship-2020/libarchive/test/minitar_test.cc b/oss-internship-2020/libarchive/test/minitar_test.cc index f0bb712..2e34f0f 100644 --- a/oss-internship-2020/libarchive/test/minitar_test.cc +++ b/oss-internship-2020/libarchive/test/minitar_test.cc @@ -1,39 +1,63 @@ -// #include -#include -#include +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. #include -#include -#include "absl/strings/string_view.h" -#include "gmock/gmock.h" +#include "build/googletest-src/googlemock/include/gmock/gmock-more-matchers.h" #include "gtest/gtest.h" -#include "sandboxed_api/sandbox2/util/fileops.h" -#include "sandboxed_api/sandbox2/util/path.h" #include "sandboxed_api/util/status_matchers.h" #include "sapi_minitar.h" -// #include "testing/base/public/gunit.h" -// #include "testing/base/public/gunit.h" using ::sandbox2::file::JoinPath; using ::testing::Eq; using ::testing::IsTrue; +using ::testing::StrEq; using ::sandbox2::file_util::fileops::Exists; +using ::sandbox2::util::VecStringToCharPtrArr; namespace { +// We will use a fixture class for testing which allows us to override the +// SetUp and TearDown functions. Also, data that needs to be initialized +// or destroyed only once (the test files and directories) will be handled +// in the SetUpTestSuite and TearDownTestSuite functions which are executed +// only once. +// All of the testing data will be placed in a temporary directory and each +// test will have it's own temporary directory. At the end of each test +// and all of the tests, the temporary data is deleted. class MiniTarTest : public ::testing::Test { protected: + // Before running the tests, we create a temporary directory which will + // store generated files and directories used for testing. + // The directory will look as follows: + // -file1 + // -dir1 - file2 + // - dir2 - file3 static void SetUpTestSuite() { data_dir_ = CreateTempDirAtCWD(); init_wd_ = sandbox2::file_util::fileops::GetCWD(); ASSERT_THAT(Exists(data_dir_, false), IsTrue()) << "Test data directory was not created"; - ASSERT_THAT(chdir(data_dir_.c_str()), Eq(0)) + ASSERT_THAT(chdir(data_dir_.data()), Eq(0)) << "Could not chdir into test data directory"; - CreateAndWriteToFile("file1"); + CreateAndWriteToFile(kFile1_); + ASSERT_THAT(mkdir(kDir1_.data(), 0755), Eq(0)) << "Could not create dir1"; + CreateAndWriteToFile(kFile2_); + ASSERT_THAT(mkdir(kDir2_.data(), 0755), Eq(0)) << "Could not create dir2"; + CreateAndWriteToFile(kFile3_); test_count_ = 0; } @@ -42,7 +66,7 @@ class MiniTarTest : public ::testing::Test { // The tests have the data directory as their working directory at the end // so we move to the initial working directory in order to not delete the // directory that we are inside of. - ASSERT_THAT(chdir(init_wd_.c_str()), Eq(0)) + ASSERT_THAT(chdir(init_wd_.data()), Eq(0)) << "Could not chdir into initial working directory"; EXPECT_THAT(sandbox2::file_util::fileops::DeleteRecursively(data_dir_), IsTrue) @@ -50,17 +74,19 @@ class MiniTarTest : public ::testing::Test { } void SetUp() override { + // We use a unique id based on test count to make sure that files created + // during tests do not overlap. id_ = "test" + std::to_string(test_count_); tmp_dir_ = CreateTempDirAtCWD(); ASSERT_THAT(Exists(tmp_dir_, false), IsTrue) << "Could not create test specific temporary directory"; - ASSERT_THAT(chdir(data_dir_.c_str()), Eq(0)) + ASSERT_THAT(chdir(data_dir_.data()), Eq(0)) << "Could not chdir into test data directory"; } void TearDown() override { - // Move to another directory before deleting the temporary folder - ASSERT_THAT(chdir(data_dir_.c_str()), Eq(0)) + // Move to another directory before deleting the temporary folder. + ASSERT_THAT(chdir(data_dir_.data()), Eq(0)) << "Could not chdir into test data directory"; EXPECT_THAT(sandbox2::file_util::fileops::DeleteRecursively(tmp_dir_), @@ -70,8 +96,8 @@ class MiniTarTest : public ::testing::Test { } // Creates the file specified and writes the same filename. - // This is done in order to not have completely empty files for the archiving - // step. + // This is done in order to not have completely empty files for the + // archiving step. static void CreateAndWriteToFile(absl::string_view file) { std::ofstream fin(file.data()); ASSERT_THAT(fin.is_open(), IsTrue()) << "Could not create" << file; @@ -79,30 +105,158 @@ class MiniTarTest : public ::testing::Test { fin.close(); } + // Checks if the files exists and if the contents are correct. + // In these tests, each file contains the relative path from the test + // directory. + // Example: dir1/dir2/file3 will contain dir1/dir2/file3. + // What the files contain does not matter as much, the only important thing + // is that they are not empty so we can check if the contents are preserved. + static void CheckFile(const std::string& file) { + ASSERT_THAT(Exists(file, false), IsTrue()) << "Could not find " << file; + std::ifstream fin(file); + ASSERT_THAT(fin.is_open(), IsTrue()) << "Error when opening " << file; + + std::string file_contents((std::istreambuf_iterator(fin)), + std::istreambuf_iterator()); + + EXPECT_THAT(file_contents, StrEq(file)) + << "Contents of " << file << " are different after extraction"; + fin.close(); + } + static int test_count_; static std::string data_dir_; static std::string init_wd_; std::string tmp_dir_, id_; + + static constexpr absl::string_view kFile1_ = "file1"; + static constexpr absl::string_view kFile2_ = "dir1/file2"; + static constexpr absl::string_view kFile3_ = "dir1/dir2/file3"; + static constexpr absl::string_view kDir1_ = "dir1"; + static constexpr absl::string_view kDir2_ = "dir1/dir2"; }; -int MiniTarTest::test_count_ = 0; +int MiniTarTest::test_count_; std::string MiniTarTest::data_dir_; std::string MiniTarTest::init_wd_; -TEST_F(MiniTarTest, Test1) { - // ASSERT_THAT(true, IsTrue()) << "TEST"; - const char* args[] = {"file1", nullptr}; - create(id_.c_str(), 0, args, false); +// The tests have the following pattern: +// 1) From inside the test data directory, call the create function with +// different arguments. +// 2) Move to the test specific temporary directory created during the +// set up phase. +// 3) Extract the archive created at step 1. +// 4) Check that the files in the archive have been extracted correctly +// by first checking if they exist and then checking if the content is the +// same as in the original file. +TEST_F(MiniTarTest, TestFileSimple) { + std::vector v = {kFile1_.data()}; - ASSERT_THAT(chdir(tmp_dir_.c_str()), Eq(0)) + create(id_.data(), 0, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) << "Could not chdir into test data directory"; - extract(JoinPath(data_dir_, id_).c_str(), 1, 0, false); - EXPECT_THAT(Exists("file1", false), IsTrue()) << "Could not find file1"; + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile1_)); } -TEST_F(MiniTarTest, Test2) { ASSERT_THAT(true, IsTrue()) << "TEST"; } +TEST_F(MiniTarTest, TestMultipleFiles) { + std::vector v = {kFile1_.data(), kFile2_.data(), kFile3_.data()}; + create(id_.data(), 0, VecStringToCharPtrArr(v), false); + ASSERT_THAT(Exists(id_.data(), false), IsTrue()) + << "Archive file was not created"; -TEST(TESTEX1, TESTEX2) { ASSERT_THAT(true, IsTrue()) << "TEST"; } + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile1_)); + CheckFile(std::string(kFile2_)); + CheckFile(std::string(kFile3_)); +} + +TEST_F(MiniTarTest, TestDirectorySimple) { + std::vector v = {kDir2_.data()}; + create(id_.data(), 0, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile3_)); +} + +TEST_F(MiniTarTest, TestDirectoryNested) { + std::vector v = {kDir1_.data()}; + create(id_.data(), 0, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile2_)); + CheckFile(std::string(kFile3_)); +} + +TEST_F(MiniTarTest, TestComplex) { + std::vector v = {kFile1_.data(), kDir1_.data()}; + create(id_.data(), 0, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile1_)); + CheckFile(std::string(kFile2_)); + CheckFile(std::string(kFile3_)); +} + +TEST_F(MiniTarTest, TestCompress) { + std::vector v = {kFile1_.data(), kDir1_.data()}; + int compress = 'Z'; + create(id_.data(), compress, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile1_)); + CheckFile(std::string(kFile2_)); + CheckFile(std::string(kFile3_)); +} + +TEST_F(MiniTarTest, TestGZIP) { + std::vector v = {kFile1_.data(), kDir1_.data()}; + int compress = 'z'; + create(id_.data(), compress, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile1_)); + CheckFile(std::string(kFile2_)); + CheckFile(std::string(kFile3_)); +} + +TEST_F(MiniTarTest, TestBZIP2) { + std::vector v = {kFile1_.data(), kDir1_.data()}; + int compress = 'j'; + create(id_.data(), compress, VecStringToCharPtrArr(v), false); + + ASSERT_THAT(chdir(tmp_dir_.data()), Eq(0)) + << "Could not chdir into test data directory"; + extract(JoinPath(data_dir_, id_).data(), 1, 0, false); + + CheckFile(std::string(kFile1_)); + CheckFile(std::string(kFile2_)); + CheckFile(std::string(kFile3_)); +} } // namespace