Utilities/cmlibarchive/libarchive/archive.h

   1 /*-
   2  * Copyright (c) 2003-2010 Tim Kientzle
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.50 2008/05/26 17:00:22 kientzle Exp $
  26  */
  27
  28 #ifndef ARCHIVE_H_INCLUDED
  29 #define ARCHIVE_H_INCLUDED
  30
  31 /*
  32  * The version number is expressed as a single integer that makes it
  33  * easy to compare versions at build time: for version a.b.c, the
  34  * version number is printf("%d%03d%03d",a,b,c).  For example, if you
  35  * know your application requires version 2.12.108 or later, you can
  36  * assert that ARCHIVE_VERSION_NUMBER >= 2012108.
  37  */
  38 /* Note: Compiler will complain if this does not match archive_entry.h! */
  39 #define ARCHIVE_VERSION_NUMBER 3005003
  40
  41 #include <sys/stat.h>
  42 #include <stddef.h>  /* for wchar_t */
  43 #include <stdio.h> /* For FILE * */
  44 #include <time.h> /* For time_t */
  45
  46 /*
  47  * Note: archive.h is for use outside of libarchive; the configuration
  48  * headers (config.h, archive_platform.h, etc.) are purely internal.
  49  * Do NOT use HAVE_XXX configuration macros to control the behavior of
  50  * this header!  If you must conditionalize, use predefined compiler and/or
  51  * platform macros.
  52  */
  53 #if defined(__BORLANDC__) && __BORLANDC__ >= 0x560
  54 # include <stdint.h>
  55 #elif !defined(__WATCOMC__) && !defined(_MSC_VER) && !defined(__INTERIX) && !defined(__BORLANDC__) && !defined(_SCO_DS) && !defined(__osf__) && !defined(__CLANG_INTTYPES_H)
  56 # include <inttypes.h>
  57 #endif
  58
  59 /* Get appropriate definitions of 64-bit integer */
  60 #if !defined(__LA_INT64_T_DEFINED)
  61 /* Older code relied on the __LA_INT64_T macro; after 4.0 we'll switch to the typedef exclusively. */
  62 # if ARCHIVE_VERSION_NUMBER < 4000000
  63 #define __LA_INT64_T la_int64_t
  64 # endif
  65 #define __LA_INT64_T_DEFINED
  66 # if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__)
  67 typedef __int64 la_int64_t;
  68 # else
  69 # include <unistd.h>  /* ssize_t */
  70 #  if defined(_SCO_DS) || defined(__osf__)
  71 typedef long long la_int64_t;
  72 #  else
  73 typedef int64_t la_int64_t;
  74 #  endif
  75 # endif
  76 #endif
  77
  78 /* The la_ssize_t should match the type used in 'struct stat' */
  79 #if !defined(__LA_SSIZE_T_DEFINED)
  80 /* Older code relied on the __LA_SSIZE_T macro; after 4.0 we'll switch to the typedef exclusively. */
  81 # if ARCHIVE_VERSION_NUMBER < 4000000
  82 #define __LA_SSIZE_T la_ssize_t
  83 # endif
  84 #define __LA_SSIZE_T_DEFINED
  85 # if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__)
  86 #  if defined(_SSIZE_T_DEFINED) || defined(_SSIZE_T_)
  87 typedef ssize_t la_ssize_t;
  88 #  elif defined(_WIN64)
  89 typedef __int64 la_ssize_t;
  90 #  else
  91 typedef long la_ssize_t;
  92 #  endif
  93 # else
  94 # include <unistd.h>  /* ssize_t */
  95 typedef ssize_t la_ssize_t;
  96 # endif
  97 #endif
  98
  99 /* Large file support for Android */
 100 #ifdef __ANDROID__
 101 #include "android_lf.h"
 102 #endif
 103
 104 /*
 105  * On Windows, define LIBARCHIVE_STATIC if you're building or using a
 106  * .lib.  The default here assumes you're building a DLL.  Only
 107  * libarchive source should ever define __LIBARCHIVE_BUILD.
 108  */
 109 #if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC)
 110 # ifdef __LIBARCHIVE_BUILD
 111 #  ifdef __GNUC__
 112 #   define __LA_DECL    __attribute__((dllexport)) extern
 113 #  else
 114 #   define __LA_DECL    __declspec(dllexport)
 115 #  endif
 116 # else
 117 #  ifdef __GNUC__
 118 #   define __LA_DECL
 119 #  else
 120 #   define __LA_DECL    __declspec(dllimport)
 121 #  endif
 122 # endif
 123 #else
 124 /* Static libraries or non-Windows needs no special declaration. */
 125 # define __LA_DECL
 126 #endif
 127
 128 #if defined(__GNUC__) && __GNUC__ >= 3 && !defined(__MINGW32__)
 129 #define __LA_PRINTF(fmtarg, firstvararg) \
 130         __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
 131 #else
 132 #define __LA_PRINTF(fmtarg, firstvararg)        /* nothing */
 133 #endif
 134
 135 /* CMake uses some deprecated APIs to build with old libarchive versions.  */
 136 #define __LA_DEPRECATED
 137
 138 #ifdef __cplusplus
 139 extern "C" {
 140 #endif
 141
 142 /*
 143  * The version number is provided as both a macro and a function.
 144  * The macro identifies the installed header; the function identifies
 145  * the library version (which may not be the same if you're using a
 146  * dynamically-linked version of the library).  Of course, if the
 147  * header and library are very different, you should expect some
 148  * strangeness.  Don't do that.
 149  */
 150 __LA_DECL int           archive_version_number(void);
 151
 152 /*
 153  * Textual name/version of the library, useful for version displays.
 154  */
 155 #define ARCHIVE_VERSION_ONLY_STRING "3.5.3"
 156 #define ARCHIVE_VERSION_STRING "libarchive " ARCHIVE_VERSION_ONLY_STRING
 157 __LA_DECL const char *  archive_version_string(void);
 158
 159 /*
 160  * Detailed textual name/version of the library and its dependencies.
 161  * This has the form:
 162  *    "libarchive x.y.z zlib/a.b.c liblzma/d.e.f ... etc ..."
 163  * the list of libraries described here will vary depending on how
 164  * libarchive was compiled.
 165  */
 166 __LA_DECL const char *  archive_version_details(void);
 167
 168 /*
 169  * Returns NULL if libarchive was compiled without the associated library.
 170  * Otherwise, returns the version number that libarchive was compiled
 171  * against.
 172  */
 173 __LA_DECL const char *  archive_zlib_version(void);
 174 __LA_DECL const char *  archive_liblzma_version(void);
 175 __LA_DECL const char *  archive_bzlib_version(void);
 176 __LA_DECL const char *  archive_liblz4_version(void);
 177 __LA_DECL const char *  archive_libzstd_version(void);
 178
 179 /* Declare our basic types. */
 180 struct archive;
 181 struct archive_entry;
 182
 183 /*
 184  * Error codes: Use archive_errno() and archive_error_string()
 185  * to retrieve details.  Unless specified otherwise, all functions
 186  * that return 'int' use these codes.
 187  */
 188 #define ARCHIVE_EOF       1     /* Found end of archive. */
 189 #define ARCHIVE_OK        0     /* Operation was successful. */
 190 #define ARCHIVE_RETRY   (-10)   /* Retry might succeed. */
 191 #define ARCHIVE_WARN    (-20)   /* Partial success. */
 192 /* For example, if write_header "fails", then you can't push data. */
 193 #define ARCHIVE_FAILED  (-25)   /* Current operation cannot complete. */
 194 /* But if write_header is "fatal," then this archive is dead and useless. */
 195 #define ARCHIVE_FATAL   (-30)   /* No more operations are possible. */
 196
 197 /*
 198  * As far as possible, archive_errno returns standard platform errno codes.
 199  * Of course, the details vary by platform, so the actual definitions
 200  * here are stored in "archive_platform.h".  The symbols are listed here
 201  * for reference; as a rule, clients should not need to know the exact
 202  * platform-dependent error code.
 203  */
 204 /* Unrecognized or invalid file format. */
 205 /* #define      ARCHIVE_ERRNO_FILE_FORMAT */
 206 /* Illegal usage of the library. */
 207 /* #define      ARCHIVE_ERRNO_PROGRAMMER_ERROR */
 208 /* Unknown or unclassified error. */
 209 /* #define      ARCHIVE_ERRNO_MISC */
 210
 211 /*
 212  * Callbacks are invoked to automatically read/skip/write/open/close the
 213  * archive. You can provide your own for complex tasks (like breaking
 214  * archives across multiple tapes) or use standard ones built into the
 215  * library.
 216  */
 217
 218 /* Returns pointer and size of next block of data from archive. */
 219 typedef la_ssize_t      archive_read_callback(struct archive *,
 220                             void *_client_data, const void **_buffer);
 221
 222 /* Skips at most request bytes from archive and returns the skipped amount.
 223  * This may skip fewer bytes than requested; it may even skip zero bytes.
 224  * If you do skip fewer bytes than requested, libarchive will invoke your
 225  * read callback and discard data as necessary to make up the full skip.
 226  */
 227 typedef la_int64_t      archive_skip_callback(struct archive *,
 228                             void *_client_data, la_int64_t request);
 229
 230 /* Seeks to specified location in the file and returns the position.
 231  * Whence values are SEEK_SET, SEEK_CUR, SEEK_END from stdio.h.
 232  * Return ARCHIVE_FATAL if the seek fails for any reason.
 233  */
 234 typedef la_int64_t      archive_seek_callback(struct archive *,
 235     void *_client_data, la_int64_t offset, int whence);
 236
 237 /* Returns size actually written, zero on EOF, -1 on error. */
 238 typedef la_ssize_t      archive_write_callback(struct archive *,
 239                             void *_client_data,
 240                             const void *_buffer, size_t _length);
 241
 242 typedef int     archive_open_callback(struct archive *, void *_client_data);
 243
 244 typedef int     archive_close_callback(struct archive *, void *_client_data);
 245
 246 typedef int     archive_free_callback(struct archive *, void *_client_data);
 247
 248 /* Switches from one client data object to the next/prev client data object.
 249  * This is useful for reading from different data blocks such as a set of files
 250  * that make up one large file.
 251  */
 252 typedef int archive_switch_callback(struct archive *, void *_client_data1,
 253                             void *_client_data2);
 254
 255 /*
 256  * Returns a passphrase used for encryption or decryption, NULL on nothing
 257  * to do and give it up.
 258  */
 259 typedef const char *archive_passphrase_callback(struct archive *,
 260                             void *_client_data);
 261
 262 /*
 263  * Codes to identify various stream filters.
 264  */
 265 #define ARCHIVE_FILTER_NONE     0
 266 #define ARCHIVE_FILTER_GZIP     1
 267 #define ARCHIVE_FILTER_BZIP2    2
 268 #define ARCHIVE_FILTER_COMPRESS 3
 269 #define ARCHIVE_FILTER_PROGRAM  4
 270 #define ARCHIVE_FILTER_LZMA     5
 271 #define ARCHIVE_FILTER_XZ       6
 272 #define ARCHIVE_FILTER_UU       7
 273 #define ARCHIVE_FILTER_RPM      8
 274 #define ARCHIVE_FILTER_LZIP     9
 275 #define ARCHIVE_FILTER_LRZIP    10
 276 #define ARCHIVE_FILTER_LZOP     11
 277 #define ARCHIVE_FILTER_GRZIP    12
 278 #define ARCHIVE_FILTER_LZ4      13
 279 #define ARCHIVE_FILTER_ZSTD     14
 280
 281 #if ARCHIVE_VERSION_NUMBER < 4000000
 282 #define ARCHIVE_COMPRESSION_NONE        ARCHIVE_FILTER_NONE
 283 #define ARCHIVE_COMPRESSION_GZIP        ARCHIVE_FILTER_GZIP
 284 #define ARCHIVE_COMPRESSION_BZIP2       ARCHIVE_FILTER_BZIP2
 285 #define ARCHIVE_COMPRESSION_COMPRESS    ARCHIVE_FILTER_COMPRESS
 286 #define ARCHIVE_COMPRESSION_PROGRAM     ARCHIVE_FILTER_PROGRAM
 287 #define ARCHIVE_COMPRESSION_LZMA        ARCHIVE_FILTER_LZMA
 288 #define ARCHIVE_COMPRESSION_XZ          ARCHIVE_FILTER_XZ
 289 #define ARCHIVE_COMPRESSION_UU          ARCHIVE_FILTER_UU
 290 #define ARCHIVE_COMPRESSION_RPM         ARCHIVE_FILTER_RPM
 291 #define ARCHIVE_COMPRESSION_LZIP        ARCHIVE_FILTER_LZIP
 292 #define ARCHIVE_COMPRESSION_LRZIP       ARCHIVE_FILTER_LRZIP
 293 #endif
 294
 295 /*
 296  * Codes returned by archive_format.
 297  *
 298  * Top 16 bits identifies the format family (e.g., "tar"); lower
 299  * 16 bits indicate the variant.  This is updated by read_next_header.
 300  * Note that the lower 16 bits will often vary from entry to entry.
 301  * In some cases, this variation occurs as libarchive learns more about
 302  * the archive (for example, later entries might utilize extensions that
 303  * weren't necessary earlier in the archive; in this case, libarchive
 304  * will change the format code to indicate the extended format that
 305  * was used).  In other cases, it's because different tools have
 306  * modified the archive and so different parts of the archive
 307  * actually have slightly different formats.  (Both tar and cpio store
 308  * format codes in each entry, so it is quite possible for each
 309  * entry to be in a different format.)
 310  */
 311 #define ARCHIVE_FORMAT_BASE_MASK                0xff0000
 312 #define ARCHIVE_FORMAT_CPIO                     0x10000
 313 #define ARCHIVE_FORMAT_CPIO_POSIX               (ARCHIVE_FORMAT_CPIO | 1)
 314 #define ARCHIVE_FORMAT_CPIO_BIN_LE              (ARCHIVE_FORMAT_CPIO | 2)
 315 #define ARCHIVE_FORMAT_CPIO_BIN_BE              (ARCHIVE_FORMAT_CPIO | 3)
 316 #define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC          (ARCHIVE_FORMAT_CPIO | 4)
 317 #define ARCHIVE_FORMAT_CPIO_SVR4_CRC            (ARCHIVE_FORMAT_CPIO | 5)
 318 #define ARCHIVE_FORMAT_CPIO_AFIO_LARGE          (ARCHIVE_FORMAT_CPIO | 6)
 319 #define ARCHIVE_FORMAT_CPIO_PWB                 (ARCHIVE_FORMAT_CPIO | 7)
 320 #define ARCHIVE_FORMAT_SHAR                     0x20000
 321 #define ARCHIVE_FORMAT_SHAR_BASE                (ARCHIVE_FORMAT_SHAR | 1)
 322 #define ARCHIVE_FORMAT_SHAR_DUMP                (ARCHIVE_FORMAT_SHAR | 2)
 323 #define ARCHIVE_FORMAT_TAR                      0x30000
 324 #define ARCHIVE_FORMAT_TAR_USTAR                (ARCHIVE_FORMAT_TAR | 1)
 325 #define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE      (ARCHIVE_FORMAT_TAR | 2)
 326 #define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED       (ARCHIVE_FORMAT_TAR | 3)
 327 #define ARCHIVE_FORMAT_TAR_GNUTAR               (ARCHIVE_FORMAT_TAR | 4)
 328 #define ARCHIVE_FORMAT_ISO9660                  0x40000
 329 #define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE        (ARCHIVE_FORMAT_ISO9660 | 1)
 330 #define ARCHIVE_FORMAT_ZIP                      0x50000
 331 #define ARCHIVE_FORMAT_EMPTY                    0x60000
 332 #define ARCHIVE_FORMAT_AR                       0x70000
 333 #define ARCHIVE_FORMAT_AR_GNU                   (ARCHIVE_FORMAT_AR | 1)
 334 #define ARCHIVE_FORMAT_AR_BSD                   (ARCHIVE_FORMAT_AR | 2)
 335 #define ARCHIVE_FORMAT_MTREE                    0x80000
 336 #define ARCHIVE_FORMAT_RAW                      0x90000
 337 #define ARCHIVE_FORMAT_XAR                      0xA0000
 338 #define ARCHIVE_FORMAT_LHA                      0xB0000
 339 #define ARCHIVE_FORMAT_CAB                      0xC0000
 340 #define ARCHIVE_FORMAT_RAR                      0xD0000
 341 #define ARCHIVE_FORMAT_7ZIP                     0xE0000
 342 #define ARCHIVE_FORMAT_WARC                     0xF0000
 343 #define ARCHIVE_FORMAT_RAR_V5                   0x100000
 344
 345 /*
 346  * Codes returned by archive_read_format_capabilities().
 347  *
 348  * This list can be extended with values between 0 and 0xffff.
 349  * The original purpose of this list was to let different archive
 350  * format readers expose their general capabilities in terms of
 351  * encryption.
 352  */
 353 #define ARCHIVE_READ_FORMAT_CAPS_NONE (0) /* no special capabilities */
 354 #define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_DATA (1<<0)  /* reader can detect encrypted data */
 355 #define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_METADATA (1<<1)  /* reader can detect encryptable metadata (pathname, mtime, etc.) */
 356
 357 /*
 358  * Codes returned by archive_read_has_encrypted_entries().
 359  *
 360  * In case the archive does not support encryption detection at all
 361  * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned. If the reader
 362  * for some other reason (e.g. not enough bytes read) cannot say if
 363  * there are encrypted entries, ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW
 364  * is returned.
 365  */
 366 #define ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED -2
 367 #define ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW -1
 368
 369 /*-
 370  * Basic outline for reading an archive:
 371  *   1) Ask archive_read_new for an archive reader object.
 372  *   2) Update any global properties as appropriate.
 373  *      In particular, you'll certainly want to call appropriate
 374  *      archive_read_support_XXX functions.
 375  *   3) Call archive_read_open_XXX to open the archive
 376  *   4) Repeatedly call archive_read_next_header to get information about
 377  *      successive archive entries.  Call archive_read_data to extract
 378  *      data for entries of interest.
 379  *   5) Call archive_read_free to end processing.
 380  */
 381 __LA_DECL struct archive        *archive_read_new(void);
 382
 383 /*
 384  * The archive_read_support_XXX calls enable auto-detect for this
 385  * archive handle.  They also link in the necessary support code.
 386  * For example, if you don't want bzlib linked in, don't invoke
 387  * support_compression_bzip2().  The "all" functions provide the
 388  * obvious shorthand.
 389  */
 390
 391 #if ARCHIVE_VERSION_NUMBER < 4000000
 392 __LA_DECL int archive_read_support_compression_all(struct archive *)
 393                 __LA_DEPRECATED;
 394 __LA_DECL int archive_read_support_compression_bzip2(struct archive *)
 395                 __LA_DEPRECATED;
 396 __LA_DECL int archive_read_support_compression_compress(struct archive *)
 397                 __LA_DEPRECATED;
 398 __LA_DECL int archive_read_support_compression_gzip(struct archive *)
 399                 __LA_DEPRECATED;
 400 __LA_DECL int archive_read_support_compression_lzip(struct archive *)
 401                 __LA_DEPRECATED;
 402 __LA_DECL int archive_read_support_compression_lzma(struct archive *)
 403                 __LA_DEPRECATED;
 404 __LA_DECL int archive_read_support_compression_none(struct archive *)
 405                 __LA_DEPRECATED;
 406 __LA_DECL int archive_read_support_compression_program(struct archive *,
 407                      const char *command) __LA_DEPRECATED;
 408 __LA_DECL int archive_read_support_compression_program_signature
 409                 (struct archive *, const char *,
 410                  const void * /* match */, size_t) __LA_DEPRECATED;
 411
 412 __LA_DECL int archive_read_support_compression_rpm(struct archive *)
 413                 __LA_DEPRECATED;
 414 __LA_DECL int archive_read_support_compression_uu(struct archive *)
 415                 __LA_DEPRECATED;
 416 __LA_DECL int archive_read_support_compression_xz(struct archive *)
 417                 __LA_DEPRECATED;
 418 #endif
 419
 420 __LA_DECL int archive_read_support_filter_all(struct archive *);
 421 __LA_DECL int archive_read_support_filter_by_code(struct archive *, int);
 422 __LA_DECL int archive_read_support_filter_bzip2(struct archive *);
 423 __LA_DECL int archive_read_support_filter_compress(struct archive *);
 424 __LA_DECL int archive_read_support_filter_gzip(struct archive *);
 425 __LA_DECL int archive_read_support_filter_grzip(struct archive *);
 426 __LA_DECL int archive_read_support_filter_lrzip(struct archive *);
 427 __LA_DECL int archive_read_support_filter_lz4(struct archive *);
 428 __LA_DECL int archive_read_support_filter_lzip(struct archive *);
 429 __LA_DECL int archive_read_support_filter_lzma(struct archive *);
 430 __LA_DECL int archive_read_support_filter_lzop(struct archive *);
 431 __LA_DECL int archive_read_support_filter_none(struct archive *);
 432 __LA_DECL int archive_read_support_filter_program(struct archive *,
 433                      const char *command);
 434 __LA_DECL int archive_read_support_filter_program_signature
 435                 (struct archive *, const char * /* cmd */,
 436                                     const void * /* match */, size_t);
 437 __LA_DECL int archive_read_support_filter_rpm(struct archive *);
 438 __LA_DECL int archive_read_support_filter_uu(struct archive *);
 439 __LA_DECL int archive_read_support_filter_xz(struct archive *);
 440 __LA_DECL int archive_read_support_filter_zstd(struct archive *);
 441
 442 __LA_DECL int archive_read_support_format_7zip(struct archive *);
 443 __LA_DECL int archive_read_support_format_all(struct archive *);
 444 __LA_DECL int archive_read_support_format_ar(struct archive *);
 445 __LA_DECL int archive_read_support_format_by_code(struct archive *, int);
 446 __LA_DECL int archive_read_support_format_cab(struct archive *);
 447 __LA_DECL int archive_read_support_format_cpio(struct archive *);
 448 __LA_DECL int archive_read_support_format_empty(struct archive *);
 449 __LA_DECL int archive_read_support_format_gnutar(struct archive *);
 450 __LA_DECL int archive_read_support_format_iso9660(struct archive *);
 451 __LA_DECL int archive_read_support_format_lha(struct archive *);
 452 __LA_DECL int archive_read_support_format_mtree(struct archive *);
 453 __LA_DECL int archive_read_support_format_rar(struct archive *);
 454 __LA_DECL int archive_read_support_format_rar5(struct archive *);
 455 __LA_DECL int archive_read_support_format_raw(struct archive *);
 456 __LA_DECL int archive_read_support_format_tar(struct archive *);
 457 __LA_DECL int archive_read_support_format_warc(struct archive *);
 458 __LA_DECL int archive_read_support_format_xar(struct archive *);
 459 /* archive_read_support_format_zip() enables both streamable and seekable
 460  * zip readers. */
 461 __LA_DECL int archive_read_support_format_zip(struct archive *);
 462 /* Reads Zip archives as stream from beginning to end.  Doesn't
 463  * correctly handle SFX ZIP files or ZIP archives that have been modified
 464  * in-place. */
 465 __LA_DECL int archive_read_support_format_zip_streamable(struct archive *);
 466 /* Reads starting from central directory; requires seekable input. */
 467 __LA_DECL int archive_read_support_format_zip_seekable(struct archive *);
 468
 469 /* Functions to manually set the format and filters to be used. This is
 470  * useful to bypass the bidding process when the format and filters to use
 471  * is known in advance.
 472  */
 473 __LA_DECL int archive_read_set_format(struct archive *, int);
 474 __LA_DECL int archive_read_append_filter(struct archive *, int);
 475 __LA_DECL int archive_read_append_filter_program(struct archive *,
 476     const char *);
 477 __LA_DECL int archive_read_append_filter_program_signature
 478     (struct archive *, const char *, const void * /* match */, size_t);
 479
 480 /* Set various callbacks. */
 481 __LA_DECL int archive_read_set_open_callback(struct archive *,
 482     archive_open_callback *);
 483 __LA_DECL int archive_read_set_read_callback(struct archive *,
 484     archive_read_callback *);
 485 __LA_DECL int archive_read_set_seek_callback(struct archive *,
 486     archive_seek_callback *);
 487 __LA_DECL int archive_read_set_skip_callback(struct archive *,
 488     archive_skip_callback *);
 489 __LA_DECL int archive_read_set_close_callback(struct archive *,
 490     archive_close_callback *);
 491 /* Callback used to switch between one data object to the next */
 492 __LA_DECL int archive_read_set_switch_callback(struct archive *,
 493     archive_switch_callback *);
 494
 495 /* This sets the first data object. */
 496 __LA_DECL int archive_read_set_callback_data(struct archive *, void *);
 497 /* This sets data object at specified index */
 498 __LA_DECL int archive_read_set_callback_data2(struct archive *, void *,
 499     unsigned int);
 500 /* This adds a data object at the specified index. */
 501 __LA_DECL int archive_read_add_callback_data(struct archive *, void *,
 502     unsigned int);
 503 /* This appends a data object to the end of list */
 504 __LA_DECL int archive_read_append_callback_data(struct archive *, void *);
 505 /* This prepends a data object to the beginning of list */
 506 __LA_DECL int archive_read_prepend_callback_data(struct archive *, void *);
 507
 508 /* Opening freezes the callbacks. */
 509 __LA_DECL int archive_read_open1(struct archive *);
 510
 511 /* Convenience wrappers around the above. */
 512 __LA_DECL int archive_read_open(struct archive *, void *_client_data,
 513                      archive_open_callback *, archive_read_callback *,
 514                      archive_close_callback *);
 515 __LA_DECL int archive_read_open2(struct archive *, void *_client_data,
 516                      archive_open_callback *, archive_read_callback *,
 517                      archive_skip_callback *, archive_close_callback *);
 518
 519 /*
 520  * A variety of shortcuts that invoke archive_read_open() with
 521  * canned callbacks suitable for common situations.  The ones that
 522  * accept a block size handle tape blocking correctly.
 523  */
 524 /* Use this if you know the filename.  Note: NULL indicates stdin. */
 525 __LA_DECL int archive_read_open_filename(struct archive *,
 526                      const char *_filename, size_t _block_size);
 527 /* Use this for reading multivolume files by filenames.
 528  * NOTE: Must be NULL terminated. Sorting is NOT done. */
 529 __LA_DECL int archive_read_open_filenames(struct archive *,
 530                      const char **_filenames, size_t _block_size);
 531 __LA_DECL int archive_read_open_filename_w(struct archive *,
 532                      const wchar_t *_filename, size_t _block_size);
 533 /* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
 534 __LA_DECL int archive_read_open_file(struct archive *,
 535                      const char *_filename, size_t _block_size) __LA_DEPRECATED;
 536 /* Read an archive that's stored in memory. */
 537 __LA_DECL int archive_read_open_memory(struct archive *,
 538                      const void * buff, size_t size);
 539 /* A more involved version that is only used for internal testing. */
 540 __LA_DECL int archive_read_open_memory2(struct archive *a, const void *buff,
 541                      size_t size, size_t read_size);
 542 /* Read an archive that's already open, using the file descriptor. */
 543 __LA_DECL int archive_read_open_fd(struct archive *, int _fd,
 544                      size_t _block_size);
 545 /* Read an archive that's already open, using a FILE *. */
 546 /* Note: DO NOT use this with tape drives. */
 547 __LA_DECL int archive_read_open_FILE(struct archive *, FILE *_file);
 548
 549 /* Parses and returns next entry header. */
 550 __LA_DECL int archive_read_next_header(struct archive *,
 551                      struct archive_entry **);
 552
 553 /* Parses and returns next entry header using the archive_entry passed in */
 554 __LA_DECL int archive_read_next_header2(struct archive *,
 555                      struct archive_entry *);
 556
 557 /*
 558  * Retrieve the byte offset in UNCOMPRESSED data where last-read
 559  * header started.
 560  */
 561 __LA_DECL la_int64_t             archive_read_header_position(struct archive *);
 562
 563 /*
 564  * Returns 1 if the archive contains at least one encrypted entry.
 565  * If the archive format not support encryption at all
 566  * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned.
 567  * If for any other reason (e.g. not enough data read so far)
 568  * we cannot say whether there are encrypted entries, then
 569  * ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW is returned.
 570  * In general, this function will return values below zero when the
 571  * reader is uncertain or totally incapable of encryption support.
 572  * When this function returns 0 you can be sure that the reader
 573  * supports encryption detection but no encrypted entries have
 574  * been found yet.
 575  *
 576  * NOTE: If the metadata/header of an archive is also encrypted, you
 577  * cannot rely on the number of encrypted entries. That is why this
 578  * function does not return the number of encrypted entries but#
 579  * just shows that there are some.
 580  */
 581 __LA_DECL int   archive_read_has_encrypted_entries(struct archive *);
 582
 583 /*
 584  * Returns a bitmask of capabilities that are supported by the archive format reader.
 585  * If the reader has no special capabilities, ARCHIVE_READ_FORMAT_CAPS_NONE is returned.
 586  */
 587 __LA_DECL int            archive_read_format_capabilities(struct archive *);
 588
 589 /* Read data from the body of an entry.  Similar to read(2). */
 590 __LA_DECL la_ssize_t             archive_read_data(struct archive *,
 591                                     void *, size_t);
 592
 593 /* Seek within the body of an entry.  Similar to lseek(2). */
 594 __LA_DECL la_int64_t archive_seek_data(struct archive *, la_int64_t, int);
 595
 596 /*
 597  * A zero-copy version of archive_read_data that also exposes the file offset
 598  * of each returned block.  Note that the client has no way to specify
 599  * the desired size of the block.  The API does guarantee that offsets will
 600  * be strictly increasing and that returned blocks will not overlap.
 601  */
 602 __LA_DECL int archive_read_data_block(struct archive *a,
 603                     const void **buff, size_t *size, la_int64_t *offset);
 604
 605 /*-
 606  * Some convenience functions that are built on archive_read_data:
 607  *  'skip': skips entire entry
 608  *  'into_buffer': writes data into memory buffer that you provide
 609  *  'into_fd': writes data to specified filedes
 610  */
 611 __LA_DECL int archive_read_data_skip(struct archive *);
 612 __LA_DECL int archive_read_data_into_fd(struct archive *, int fd);
 613
 614 /*
 615  * Set read options.
 616  */
 617 /* Apply option to the format only. */
 618 __LA_DECL int archive_read_set_format_option(struct archive *_a,
 619                             const char *m, const char *o,
 620                             const char *v);
 621 /* Apply option to the filter only. */
 622 __LA_DECL int archive_read_set_filter_option(struct archive *_a,
 623                             const char *m, const char *o,
 624                             const char *v);
 625 /* Apply option to both the format and the filter. */
 626 __LA_DECL int archive_read_set_option(struct archive *_a,
 627                             const char *m, const char *o,
 628                             const char *v);
 629 /* Apply option string to both the format and the filter. */
 630 __LA_DECL int archive_read_set_options(struct archive *_a,
 631                             const char *opts);
 632
 633 /*
 634  * Add a decryption passphrase.
 635  */
 636 __LA_DECL int archive_read_add_passphrase(struct archive *, const char *);
 637 __LA_DECL int archive_read_set_passphrase_callback(struct archive *,
 638                             void *client_data, archive_passphrase_callback *);
 639
 640
 641 /*-
 642  * Convenience function to recreate the current entry (whose header
 643  * has just been read) on disk.
 644  *
 645  * This does quite a bit more than just copy data to disk. It also:
 646  *  - Creates intermediate directories as required.
 647  *  - Manages directory permissions:  non-writable directories will
 648  *    be initially created with write permission enabled; when the
 649  *    archive is closed, dir permissions are edited to the values specified
 650  *    in the archive.
 651  *  - Checks hardlinks:  hardlinks will not be extracted unless the
 652  *    linked-to file was also extracted within the same session. (TODO)
 653  */
 654
 655 /* The "flags" argument selects optional behavior, 'OR' the flags you want. */
 656
 657 /* Default: Do not try to set owner/group. */
 658 #define ARCHIVE_EXTRACT_OWNER                   (0x0001)
 659 /* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
 660 #define ARCHIVE_EXTRACT_PERM                    (0x0002)
 661 /* Default: Do not restore mtime/atime. */
 662 #define ARCHIVE_EXTRACT_TIME                    (0x0004)
 663 /* Default: Replace existing files. */
 664 #define ARCHIVE_EXTRACT_NO_OVERWRITE            (0x0008)
 665 /* Default: Try create first, unlink only if create fails with EEXIST. */
 666 #define ARCHIVE_EXTRACT_UNLINK                  (0x0010)
 667 /* Default: Do not restore ACLs. */
 668 #define ARCHIVE_EXTRACT_ACL                     (0x0020)
 669 /* Default: Do not restore fflags. */
 670 #define ARCHIVE_EXTRACT_FFLAGS                  (0x0040)
 671 /* Default: Do not restore xattrs. */
 672 #define ARCHIVE_EXTRACT_XATTR                   (0x0080)
 673 /* Default: Do not try to guard against extracts redirected by symlinks. */
 674 /* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
 675 #define ARCHIVE_EXTRACT_SECURE_SYMLINKS         (0x0100)
 676 /* Default: Do not reject entries with '..' as path elements. */
 677 #define ARCHIVE_EXTRACT_SECURE_NODOTDOT         (0x0200)
 678 /* Default: Create parent directories as needed. */
 679 #define ARCHIVE_EXTRACT_NO_AUTODIR              (0x0400)
 680 /* Default: Overwrite files, even if one on disk is newer. */
 681 #define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER      (0x0800)
 682 /* Detect blocks of 0 and write holes instead. */
 683 #define ARCHIVE_EXTRACT_SPARSE                  (0x1000)
 684 /* Default: Do not restore Mac extended metadata. */
 685 /* This has no effect except on Mac OS. */
 686 #define ARCHIVE_EXTRACT_MAC_METADATA            (0x2000)
 687 /* Default: Use HFS+ compression if it was compressed. */
 688 /* This has no effect except on Mac OS v10.6 or later. */
 689 #define ARCHIVE_EXTRACT_NO_HFS_COMPRESSION      (0x4000)
 690 /* Default: Do not use HFS+ compression if it was not compressed. */
 691 /* This has no effect except on Mac OS v10.6 or later. */
 692 #define ARCHIVE_EXTRACT_HFS_COMPRESSION_FORCED  (0x8000)
 693 /* Default: Do not reject entries with absolute paths */
 694 #define ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS (0x10000)
 695 /* Default: Do not clear no-change flags when unlinking object */
 696 #define ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS   (0x20000)
 697 /* Default: Do not extract atomically (using rename) */
 698 #define ARCHIVE_EXTRACT_SAFE_WRITES             (0x40000)
 699
 700 __LA_DECL int archive_read_extract(struct archive *, struct archive_entry *,
 701                      int flags);
 702 __LA_DECL int archive_read_extract2(struct archive *, struct archive_entry *,
 703                      struct archive * /* dest */);
 704 __LA_DECL void   archive_read_extract_set_progress_callback(struct archive *,
 705                      void (*_progress_func)(void *), void *_user_data);
 706
 707 /* Record the dev/ino of a file that will not be written.  This is
 708  * generally set to the dev/ino of the archive being read. */
 709 __LA_DECL void          archive_read_extract_set_skip_file(struct archive *,
 710                      la_int64_t, la_int64_t);
 711
 712 /* Close the file and release most resources. */
 713 __LA_DECL int            archive_read_close(struct archive *);
 714 /* Release all resources and destroy the object. */
 715 /* Note that archive_read_free will call archive_read_close for you. */
 716 __LA_DECL int            archive_read_free(struct archive *);
 717 #if ARCHIVE_VERSION_NUMBER < 4000000
 718 /* Synonym for archive_read_free() for backwards compatibility. */
 719 __LA_DECL int            archive_read_finish(struct archive *) __LA_DEPRECATED;
 720 #endif
 721
 722 /*-
 723  * To create an archive:
 724  *   1) Ask archive_write_new for an archive writer object.
 725  *   2) Set any global properties.  In particular, you should set
 726  *      the compression and format to use.
 727  *   3) Call archive_write_open to open the file (most people
 728  *       will use archive_write_open_file or archive_write_open_fd,
 729  *       which provide convenient canned I/O callbacks for you).
 730  *   4) For each entry:
 731  *      - construct an appropriate struct archive_entry structure
 732  *      - archive_write_header to write the header
 733  *      - archive_write_data to write the entry data
 734  *   5) archive_write_close to close the output
 735  *   6) archive_write_free to cleanup the writer and release resources
 736  */
 737 __LA_DECL struct archive        *archive_write_new(void);
 738 __LA_DECL int archive_write_set_bytes_per_block(struct archive *,
 739                      int bytes_per_block);
 740 __LA_DECL int archive_write_get_bytes_per_block(struct archive *);
 741 /* XXX This is badly misnamed; suggestions appreciated. XXX */
 742 __LA_DECL int archive_write_set_bytes_in_last_block(struct archive *,
 743                      int bytes_in_last_block);
 744 __LA_DECL int archive_write_get_bytes_in_last_block(struct archive *);
 745
 746 /* The dev/ino of a file that won't be archived.  This is used
 747  * to avoid recursively adding an archive to itself. */
 748 __LA_DECL int archive_write_set_skip_file(struct archive *,
 749     la_int64_t, la_int64_t);
 750
 751 #if ARCHIVE_VERSION_NUMBER < 4000000
 752 __LA_DECL int archive_write_set_compression_bzip2(struct archive *)
 753                 __LA_DEPRECATED;
 754 __LA_DECL int archive_write_set_compression_compress(struct archive *)
 755                 __LA_DEPRECATED;
 756 __LA_DECL int archive_write_set_compression_gzip(struct archive *)
 757                 __LA_DEPRECATED;
 758 __LA_DECL int archive_write_set_compression_lzip(struct archive *)
 759                 __LA_DEPRECATED;
 760 __LA_DECL int archive_write_set_compression_lzma(struct archive *)
 761                 __LA_DEPRECATED;
 762 __LA_DECL int archive_write_set_compression_none(struct archive *)
 763                 __LA_DEPRECATED;
 764 __LA_DECL int archive_write_set_compression_program(struct archive *,
 765                      const char *cmd) __LA_DEPRECATED;
 766 __LA_DECL int archive_write_set_compression_xz(struct archive *)
 767                 __LA_DEPRECATED;
 768 #endif
 769
 770 /* A convenience function to set the filter based on the code. */
 771 __LA_DECL int archive_write_add_filter(struct archive *, int filter_code);
 772 __LA_DECL int archive_write_add_filter_by_name(struct archive *,
 773                      const char *name);
 774 __LA_DECL int archive_write_add_filter_b64encode(struct archive *);
 775 __LA_DECL int archive_write_add_filter_bzip2(struct archive *);
 776 __LA_DECL int archive_write_add_filter_compress(struct archive *);
 777 __LA_DECL int archive_write_add_filter_grzip(struct archive *);
 778 __LA_DECL int archive_write_add_filter_gzip(struct archive *);
 779 __LA_DECL int archive_write_add_filter_lrzip(struct archive *);
 780 __LA_DECL int archive_write_add_filter_lz4(struct archive *);
 781 __LA_DECL int archive_write_add_filter_lzip(struct archive *);
 782 __LA_DECL int archive_write_add_filter_lzma(struct archive *);
 783 __LA_DECL int archive_write_add_filter_lzop(struct archive *);
 784 __LA_DECL int archive_write_add_filter_none(struct archive *);
 785 __LA_DECL int archive_write_add_filter_program(struct archive *,
 786                      const char *cmd);
 787 __LA_DECL int archive_write_add_filter_uuencode(struct archive *);
 788 __LA_DECL int archive_write_add_filter_xz(struct archive *);
 789 __LA_DECL int archive_write_add_filter_zstd(struct archive *);
 790
 791
 792 /* A convenience function to set the format based on the code or name. */
 793 __LA_DECL int archive_write_set_format(struct archive *, int format_code);
 794 __LA_DECL int archive_write_set_format_by_name(struct archive *,
 795                      const char *name);
 796 /* To minimize link pollution, use one or more of the following. */
 797 __LA_DECL int archive_write_set_format_7zip(struct archive *);
 798 __LA_DECL int archive_write_set_format_ar_bsd(struct archive *);
 799 __LA_DECL int archive_write_set_format_ar_svr4(struct archive *);
 800 __LA_DECL int archive_write_set_format_cpio(struct archive *);
 801 __LA_DECL int archive_write_set_format_cpio_bin(struct archive *);
 802 __LA_DECL int archive_write_set_format_cpio_newc(struct archive *);
 803 __LA_DECL int archive_write_set_format_cpio_odc(struct archive *);
 804 __LA_DECL int archive_write_set_format_cpio_pwb(struct archive *);
 805 __LA_DECL int archive_write_set_format_gnutar(struct archive *);
 806 __LA_DECL int archive_write_set_format_iso9660(struct archive *);
 807 __LA_DECL int archive_write_set_format_mtree(struct archive *);
 808 __LA_DECL int archive_write_set_format_mtree_classic(struct archive *);
 809 /* TODO: int archive_write_set_format_old_tar(struct archive *); */
 810 __LA_DECL int archive_write_set_format_pax(struct archive *);
 811 __LA_DECL int archive_write_set_format_pax_restricted(struct archive *);
 812 __LA_DECL int archive_write_set_format_raw(struct archive *);
 813 __LA_DECL int archive_write_set_format_shar(struct archive *);
 814 __LA_DECL int archive_write_set_format_shar_dump(struct archive *);
 815 __LA_DECL int archive_write_set_format_ustar(struct archive *);
 816 __LA_DECL int archive_write_set_format_v7tar(struct archive *);
 817 __LA_DECL int archive_write_set_format_warc(struct archive *);
 818 __LA_DECL int archive_write_set_format_xar(struct archive *);
 819 __LA_DECL int archive_write_set_format_zip(struct archive *);
 820 __LA_DECL int archive_write_set_format_filter_by_ext(struct archive *a, const char *filename);
 821 __LA_DECL int archive_write_set_format_filter_by_ext_def(struct archive *a, const char *filename, const char * def_ext);
 822 __LA_DECL int archive_write_zip_set_compression_deflate(struct archive *);
 823 __LA_DECL int archive_write_zip_set_compression_store(struct archive *);
 824 /* Deprecated; use archive_write_open2 instead */
 825 __LA_DECL int archive_write_open(struct archive *, void *,
 826                      archive_open_callback *, archive_write_callback *,
 827                      archive_close_callback *);
 828 __LA_DECL int archive_write_open2(struct archive *, void *,
 829                      archive_open_callback *, archive_write_callback *,
 830                      archive_close_callback *, archive_free_callback *);
 831 __LA_DECL int archive_write_open_fd(struct archive *, int _fd);
 832 __LA_DECL int archive_write_open_filename(struct archive *, const char *_file);
 833 __LA_DECL int archive_write_open_filename_w(struct archive *,
 834                      const wchar_t *_file);
 835 /* A deprecated synonym for archive_write_open_filename() */
 836 __LA_DECL int archive_write_open_file(struct archive *, const char *_file)
 837                 __LA_DEPRECATED;
 838 __LA_DECL int archive_write_open_FILE(struct archive *, FILE *);
 839 /* _buffSize is the size of the buffer, _used refers to a variable that
 840  * will be updated after each write into the buffer. */
 841 __LA_DECL int archive_write_open_memory(struct archive *,
 842                         void *_buffer, size_t _buffSize, size_t *_used);
 843
 844 /*
 845  * Note that the library will truncate writes beyond the size provided
 846  * to archive_write_header or pad if the provided data is short.
 847  */
 848 __LA_DECL int archive_write_header(struct archive *,
 849                      struct archive_entry *);
 850 __LA_DECL la_ssize_t    archive_write_data(struct archive *,
 851                             const void *, size_t);
 852
 853 /* This interface is currently only available for archive_write_disk handles.  */
 854 __LA_DECL la_ssize_t     archive_write_data_block(struct archive *,
 855                                     const void *, size_t, la_int64_t);
 856
 857 __LA_DECL int            archive_write_finish_entry(struct archive *);
 858 __LA_DECL int            archive_write_close(struct archive *);
 859 /* Marks the archive as FATAL so that a subsequent free() operation
 860  * won't try to close() cleanly.  Provides a fast abort capability
 861  * when the client discovers that things have gone wrong. */
 862 __LA_DECL int            archive_write_fail(struct archive *);
 863 /* This can fail if the archive wasn't already closed, in which case
 864  * archive_write_free() will implicitly call archive_write_close(). */
 865 __LA_DECL int            archive_write_free(struct archive *);
 866 #if ARCHIVE_VERSION_NUMBER < 4000000
 867 /* Synonym for archive_write_free() for backwards compatibility. */
 868 __LA_DECL int            archive_write_finish(struct archive *) __LA_DEPRECATED;
 869 #endif
 870
 871 /*
 872  * Set write options.
 873  */
 874 /* Apply option to the format only. */
 875 __LA_DECL int archive_write_set_format_option(struct archive *_a,
 876                             const char *m, const char *o,
 877                             const char *v);
 878 /* Apply option to the filter only. */
 879 __LA_DECL int archive_write_set_filter_option(struct archive *_a,
 880                             const char *m, const char *o,
 881                             const char *v);
 882 /* Apply option to both the format and the filter. */
 883 __LA_DECL int archive_write_set_option(struct archive *_a,
 884                             const char *m, const char *o,
 885                             const char *v);
 886 /* Apply option string to both the format and the filter. */
 887 __LA_DECL int archive_write_set_options(struct archive *_a,
 888                             const char *opts);
 889
 890 /*
 891  * Set a encryption passphrase.
 892  */
 893 __LA_DECL int archive_write_set_passphrase(struct archive *_a, const char *p);
 894 __LA_DECL int archive_write_set_passphrase_callback(struct archive *,
 895                             void *client_data, archive_passphrase_callback *);
 896
 897 /*-
 898  * ARCHIVE_WRITE_DISK API
 899  *
 900  * To create objects on disk:
 901  *   1) Ask archive_write_disk_new for a new archive_write_disk object.
 902  *   2) Set any global properties.  In particular, you probably
 903  *      want to set the options.
 904  *   3) For each entry:
 905  *      - construct an appropriate struct archive_entry structure
 906  *      - archive_write_header to create the file/dir/etc on disk
 907  *      - archive_write_data to write the entry data
 908  *   4) archive_write_free to cleanup the writer and release resources
 909  *
 910  * In particular, you can use this in conjunction with archive_read()
 911  * to pull entries out of an archive and create them on disk.
 912  */
 913 __LA_DECL struct archive        *archive_write_disk_new(void);
 914 /* This file will not be overwritten. */
 915 __LA_DECL int archive_write_disk_set_skip_file(struct archive *,
 916     la_int64_t, la_int64_t);
 917 /* Set flags to control how the next item gets created.
 918  * This accepts a bitmask of ARCHIVE_EXTRACT_XXX flags defined above. */
 919 __LA_DECL int            archive_write_disk_set_options(struct archive *,
 920                      int flags);
 921 /*
 922  * The lookup functions are given uname/uid (or gname/gid) pairs and
 923  * return a uid (gid) suitable for this system.  These are used for
 924  * restoring ownership and for setting ACLs.  The default functions
 925  * are naive, they just return the uid/gid.  These are small, so reasonable
 926  * for applications that don't need to preserve ownership; they
 927  * are probably also appropriate for applications that are doing
 928  * same-system backup and restore.
 929  */
 930 /*
 931  * The "standard" lookup functions use common system calls to lookup
 932  * the uname/gname, falling back to the uid/gid if the names can't be
 933  * found.  They cache lookups and are reasonably fast, but can be very
 934  * large, so they are not used unless you ask for them.  In
 935  * particular, these match the specifications of POSIX "pax" and old
 936  * POSIX "tar".
 937  */
 938 __LA_DECL int    archive_write_disk_set_standard_lookup(struct archive *);
 939 /*
 940  * If neither the default (naive) nor the standard (big) functions suit
 941  * your needs, you can write your own and register them.  Be sure to
 942  * include a cleanup function if you have allocated private data.
 943  */
 944 __LA_DECL int archive_write_disk_set_group_lookup(struct archive *,
 945     void * /* private_data */,
 946     la_int64_t (*)(void *, const char *, la_int64_t),
 947     void (* /* cleanup */)(void *));
 948 __LA_DECL int archive_write_disk_set_user_lookup(struct archive *,
 949     void * /* private_data */,
 950     la_int64_t (*)(void *, const char *, la_int64_t),
 951     void (* /* cleanup */)(void *));
 952 __LA_DECL la_int64_t archive_write_disk_gid(struct archive *, const char *, la_int64_t);
 953 __LA_DECL la_int64_t archive_write_disk_uid(struct archive *, const char *, la_int64_t);
 954
 955 /*
 956  * ARCHIVE_READ_DISK API
 957  *
 958  * This is still evolving and somewhat experimental.
 959  */
 960 __LA_DECL struct archive *archive_read_disk_new(void);
 961 /* The names for symlink modes here correspond to an old BSD
 962  * command-line argument convention: -L, -P, -H */
 963 /* Follow all symlinks. */
 964 __LA_DECL int archive_read_disk_set_symlink_logical(struct archive *);
 965 /* Follow no symlinks. */
 966 __LA_DECL int archive_read_disk_set_symlink_physical(struct archive *);
 967 /* Follow symlink initially, then not. */
 968 __LA_DECL int archive_read_disk_set_symlink_hybrid(struct archive *);
 969 /* TODO: Handle Linux stat32/stat64 ugliness. <sigh> */
 970 __LA_DECL int archive_read_disk_entry_from_file(struct archive *,
 971     struct archive_entry *, int /* fd */, const struct stat *);
 972 /* Look up gname for gid or uname for uid. */
 973 /* Default implementations are very, very stupid. */
 974 __LA_DECL const char *archive_read_disk_gname(struct archive *, la_int64_t);
 975 __LA_DECL const char *archive_read_disk_uname(struct archive *, la_int64_t);
 976 /* "Standard" implementation uses getpwuid_r, getgrgid_r and caches the
 977  * results for performance. */
 978 __LA_DECL int   archive_read_disk_set_standard_lookup(struct archive *);
 979 /* You can install your own lookups if you like. */
 980 __LA_DECL int   archive_read_disk_set_gname_lookup(struct archive *,
 981     void * /* private_data */,
 982     const char *(* /* lookup_fn */)(void *, la_int64_t),
 983     void (* /* cleanup_fn */)(void *));
 984 __LA_DECL int   archive_read_disk_set_uname_lookup(struct archive *,
 985     void * /* private_data */,
 986     const char *(* /* lookup_fn */)(void *, la_int64_t),
 987     void (* /* cleanup_fn */)(void *));
 988 /* Start traversal. */
 989 __LA_DECL int   archive_read_disk_open(struct archive *, const char *);
 990 __LA_DECL int   archive_read_disk_open_w(struct archive *, const wchar_t *);
 991 /*
 992  * Request that current entry be visited.  If you invoke it on every
 993  * directory, you'll get a physical traversal.  This is ignored if the
 994  * current entry isn't a directory or a link to a directory.  So, if
 995  * you invoke this on every returned path, you'll get a full logical
 996  * traversal.
 997  */
 998 __LA_DECL int   archive_read_disk_descend(struct archive *);
 999 __LA_DECL int   archive_read_disk_can_descend(struct archive *);
1000 __LA_DECL int   archive_read_disk_current_filesystem(struct archive *);
1001 __LA_DECL int   archive_read_disk_current_filesystem_is_synthetic(struct archive *);
1002 __LA_DECL int   archive_read_disk_current_filesystem_is_remote(struct archive *);
1003 /* Request that the access time of the entry visited by traversal be restored. */
1004 __LA_DECL int  archive_read_disk_set_atime_restored(struct archive *);
1005 /*
1006  * Set behavior. The "flags" argument selects optional behavior.
1007  */
1008 /* Request that the access time of the entry visited by traversal be restored.
1009  * This is the same as archive_read_disk_set_atime_restored. */
1010 #define ARCHIVE_READDISK_RESTORE_ATIME          (0x0001)
1011 /* Default: Do not skip an entry which has nodump flags. */
1012 #define ARCHIVE_READDISK_HONOR_NODUMP           (0x0002)
1013 /* Default: Skip a mac resource fork file whose prefix is "._" because of
1014  * using copyfile. */
1015 #define ARCHIVE_READDISK_MAC_COPYFILE           (0x0004)
1016 /* Default: Traverse mount points. */
1017 #define ARCHIVE_READDISK_NO_TRAVERSE_MOUNTS     (0x0008)
1018 /* Default: Xattrs are read from disk. */
1019 #define ARCHIVE_READDISK_NO_XATTR               (0x0010)
1020 /* Default: ACLs are read from disk. */
1021 #define ARCHIVE_READDISK_NO_ACL                 (0x0020)
1022 /* Default: File flags are read from disk. */
1023 #define ARCHIVE_READDISK_NO_FFLAGS              (0x0040)
1024
1025 __LA_DECL int  archive_read_disk_set_behavior(struct archive *,
1026                     int flags);
1027
1028 /*
1029  * Set archive_match object that will be used in archive_read_disk to
1030  * know whether an entry should be skipped. The callback function
1031  * _excluded_func will be invoked when an entry is skipped by the result
1032  * of archive_match.
1033  */
1034 __LA_DECL int   archive_read_disk_set_matching(struct archive *,
1035                     struct archive *_matching, void (*_excluded_func)
1036                     (struct archive *, void *, struct archive_entry *),
1037                     void *_client_data);
1038 __LA_DECL int   archive_read_disk_set_metadata_filter_callback(struct archive *,
1039                     int (*_metadata_filter_func)(struct archive *, void *,
1040                         struct archive_entry *), void *_client_data);
1041
1042 /* Simplified cleanup interface;
1043  * This calls archive_read_free() or archive_write_free() as needed. */
1044 __LA_DECL int   archive_free(struct archive *);
1045
1046 /*
1047  * Accessor functions to read/set various information in
1048  * the struct archive object:
1049  */
1050
1051 /* Number of filters in the current filter pipeline. */
1052 /* Filter #0 is the one closest to the format, -1 is a synonym for the
1053  * last filter, which is always the pseudo-filter that wraps the
1054  * client callbacks. */
1055 __LA_DECL int            archive_filter_count(struct archive *);
1056 __LA_DECL la_int64_t     archive_filter_bytes(struct archive *, int);
1057 __LA_DECL int            archive_filter_code(struct archive *, int);
1058 __LA_DECL const char *   archive_filter_name(struct archive *, int);
1059
1060 #if ARCHIVE_VERSION_NUMBER < 4000000
1061 /* These don't properly handle multiple filters, so are deprecated and
1062  * will eventually be removed. */
1063 /* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, -1); */
1064 __LA_DECL la_int64_t     archive_position_compressed(struct archive *)
1065                                 __LA_DEPRECATED;
1066 /* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, 0); */
1067 __LA_DECL la_int64_t     archive_position_uncompressed(struct archive *)
1068                                 __LA_DEPRECATED;
1069 /* As of libarchive 3.0, this is an alias for archive_filter_name(a, 0); */
1070 __LA_DECL const char    *archive_compression_name(struct archive *)
1071                                 __LA_DEPRECATED;
1072 /* As of libarchive 3.0, this is an alias for archive_filter_code(a, 0); */
1073 __LA_DECL int            archive_compression(struct archive *)
1074                                 __LA_DEPRECATED;
1075 #endif
1076
1077 __LA_DECL int            archive_errno(struct archive *);
1078 __LA_DECL const char    *archive_error_string(struct archive *);
1079 __LA_DECL const char    *archive_format_name(struct archive *);
1080 __LA_DECL int            archive_format(struct archive *);
1081 __LA_DECL void           archive_clear_error(struct archive *);
1082 __LA_DECL void           archive_set_error(struct archive *, int _err,
1083                             const char *fmt, ...) __LA_PRINTF(3, 4);
1084 __LA_DECL void           archive_copy_error(struct archive *dest,
1085                             struct archive *src);
1086 __LA_DECL int            archive_file_count(struct archive *);
1087
1088 /*
1089  * ARCHIVE_MATCH API
1090  */
1091 __LA_DECL struct archive *archive_match_new(void);
1092 __LA_DECL int   archive_match_free(struct archive *);
1093
1094 /*
1095  * Test if archive_entry is excluded.
1096  * This is a convenience function. This is the same as calling all
1097  * archive_match_path_excluded, archive_match_time_excluded
1098  * and archive_match_owner_excluded.
1099  */
1100 __LA_DECL int   archive_match_excluded(struct archive *,
1101                     struct archive_entry *);
1102
1103 /*
1104  * Test if pathname is excluded. The conditions are set by following functions.
1105  */
1106 __LA_DECL int   archive_match_path_excluded(struct archive *,
1107                     struct archive_entry *);
1108 /* Control recursive inclusion of directory content when directory is included. Default on. */
1109 __LA_DECL int   archive_match_set_inclusion_recursion(struct archive *, int);
1110 /* Add exclusion pathname pattern. */
1111 __LA_DECL int   archive_match_exclude_pattern(struct archive *, const char *);
1112 __LA_DECL int   archive_match_exclude_pattern_w(struct archive *,
1113                     const wchar_t *);
1114 /* Add exclusion pathname pattern from file. */
1115 __LA_DECL int   archive_match_exclude_pattern_from_file(struct archive *,
1116                     const char *, int _nullSeparator);
1117 __LA_DECL int   archive_match_exclude_pattern_from_file_w(struct archive *,
1118                     const wchar_t *, int _nullSeparator);
1119 /* Add inclusion pathname pattern. */
1120 __LA_DECL int   archive_match_include_pattern(struct archive *, const char *);
1121 __LA_DECL int   archive_match_include_pattern_w(struct archive *,
1122                     const wchar_t *);
1123 /* Add inclusion pathname pattern from file. */
1124 __LA_DECL int   archive_match_include_pattern_from_file(struct archive *,
1125                     const char *, int _nullSeparator);
1126 __LA_DECL int   archive_match_include_pattern_from_file_w(struct archive *,
1127                     const wchar_t *, int _nullSeparator);
1128 /*
1129  * How to get statistic information for inclusion patterns.
1130  */
1131 /* Return the amount number of unmatched inclusion patterns. */
1132 __LA_DECL int   archive_match_path_unmatched_inclusions(struct archive *);
1133 /* Return the pattern of unmatched inclusion with ARCHIVE_OK.
1134  * Return ARCHIVE_EOF if there is no inclusion pattern. */
1135 __LA_DECL int   archive_match_path_unmatched_inclusions_next(
1136                     struct archive *, const char **);
1137 __LA_DECL int   archive_match_path_unmatched_inclusions_next_w(
1138                     struct archive *, const wchar_t **);
1139
1140 /*
1141  * Test if a file is excluded by its time stamp.
1142  * The conditions are set by following functions.
1143  */
1144 __LA_DECL int   archive_match_time_excluded(struct archive *,
1145                     struct archive_entry *);
1146
1147 /*
1148  * Flags to tell a matching type of time stamps. These are used for
1149  * following functions.
1150  */
1151 /* Time flag: mtime to be tested. */
1152 #define ARCHIVE_MATCH_MTIME     (0x0100)
1153 /* Time flag: ctime to be tested. */
1154 #define ARCHIVE_MATCH_CTIME     (0x0200)
1155 /* Comparison flag: Match the time if it is newer than. */
1156 #define ARCHIVE_MATCH_NEWER     (0x0001)
1157 /* Comparison flag: Match the time if it is older than. */
1158 #define ARCHIVE_MATCH_OLDER     (0x0002)
1159 /* Comparison flag: Match the time if it is equal to. */
1160 #define ARCHIVE_MATCH_EQUAL     (0x0010)
1161 /* Set inclusion time. */
1162 __LA_DECL int   archive_match_include_time(struct archive *, int _flag,
1163                     time_t _sec, long _nsec);
1164 /* Set inclusion time by a date string. */
1165 __LA_DECL int   archive_match_include_date(struct archive *, int _flag,
1166                     const char *_datestr);
1167 __LA_DECL int   archive_match_include_date_w(struct archive *, int _flag,
1168                     const wchar_t *_datestr);
1169 /* Set inclusion time by a particular file. */
1170 __LA_DECL int   archive_match_include_file_time(struct archive *,
1171                     int _flag, const char *_pathname);
1172 __LA_DECL int   archive_match_include_file_time_w(struct archive *,
1173                     int _flag, const wchar_t *_pathname);
1174 /* Add exclusion entry. */
1175 __LA_DECL int   archive_match_exclude_entry(struct archive *,
1176                     int _flag, struct archive_entry *);
1177
1178 /*
1179  * Test if a file is excluded by its uid ,gid, uname or gname.
1180  * The conditions are set by following functions.
1181  */
1182 __LA_DECL int   archive_match_owner_excluded(struct archive *,
1183                     struct archive_entry *);
1184 /* Add inclusion uid, gid, uname and gname. */
1185 __LA_DECL int   archive_match_include_uid(struct archive *, la_int64_t);
1186 __LA_DECL int   archive_match_include_gid(struct archive *, la_int64_t);
1187 __LA_DECL int   archive_match_include_uname(struct archive *, const char *);
1188 __LA_DECL int   archive_match_include_uname_w(struct archive *,
1189                     const wchar_t *);
1190 __LA_DECL int   archive_match_include_gname(struct archive *, const char *);
1191 __LA_DECL int   archive_match_include_gname_w(struct archive *,
1192                     const wchar_t *);
1193
1194 /* Utility functions */
1195 /* Convenience function to sort a NULL terminated list of strings */
1196 __LA_DECL int archive_utility_string_sort(char **);
1197
1198 #ifdef __cplusplus
1199 }
1200 #endif
1201
1202 /* These are meaningless outside of this header. */
1203 #undef __LA_DECL
1204
1205 #endif /* !ARCHIVE_H_INCLUDED */