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