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