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