Import libarchive 2.0.28.
[dragonfly.git] / contrib / libarchive-2.0 / libarchive / archive.h.in
1 /*-
2  * Copyright (c) 2003-2007 Tim Kientzle
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.41 2007/04/03 05:34:36 kientzle Exp $
26  */
27
28 #ifndef ARCHIVE_H_INCLUDED
29 #define ARCHIVE_H_INCLUDED
30
31 /*
32  * This header file corresponds to:
33  *   Library version @VERSION@
34  *   Shared library version @SHLIB_MAJOR@
35  */
36
37 #include <sys/types.h>  /* Linux requires this for off_t */
38 @ARCHIVE_H_INCLUDE_INTTYPES_H@
39 #include <stdio.h> /* For FILE * */
40 #ifndef _WIN32
41 #include <unistd.h>  /* For ssize_t and size_t */
42 #else
43 typedef long ssize_t;
44 typedef unsigned int uid_t;
45 typedef unsigned int gid_t;
46 typedef unsigned short mode_t;
47 #endif
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53
54 /*
55  * If ARCHIVE_API_VERSION != archive_api_version(), then the library you
56  * were linked with is using an incompatible API to the one you were
57  * compiled with.  This is almost certainly a fatal problem.
58  *
59  * ARCHIVE_API_FEATURE is incremented with each significant feature
60  * addition, so you can test (at compile or run time) if a particular
61  * feature is implemented.  It's no big deal if ARCHIVE_API_FEATURE !=
62  * archive_api_feature(), as long as both are high enough to include
63  * the features you're relying on.  Specific values of FEATURE are
64  * documented here:
65  *
66  *    1 - Version tests are available.
67  *    2 - archive_{read,write}_close available separately from _finish.
68  *    3 - open_memory, open_memory2, open_FILE, open_fd available
69  *    5 - archive_write_disk interface available
70  */
71 #define ARCHIVE_API_VERSION     @ARCHIVE_API_MAJOR@
72 int             archive_api_version(void);
73 #define ARCHIVE_API_FEATURE     @ARCHIVE_API_MINOR@
74 int             archive_api_feature(void);
75 /* Textual name/version of the library. */
76 #define ARCHIVE_LIBRARY_VERSION "libarchive @VERSION@"
77 const char *    archive_version(void);
78
79 #define ARCHIVE_BYTES_PER_RECORD          512
80 #define ARCHIVE_DEFAULT_BYTES_PER_BLOCK 10240
81
82 /* Declare our basic types. */
83 struct archive;
84 struct archive_entry;
85
86 /*
87  * Error codes: Use archive_errno() and archive_error_string()
88  * to retrieve details.  Unless specified otherwise, all functions
89  * that return 'int' use these codes.
90  */
91 #define ARCHIVE_EOF       1     /* Found end of archive. */
92 #define ARCHIVE_OK        0     /* Operation was successful. */
93 #define ARCHIVE_RETRY   (-10)   /* Retry might succeed. */
94 #define ARCHIVE_WARN    (-20)   /* Partial success. */
95 /* For example, if write_header "fails", then you can't push data. */
96 #define ARCHIVE_FAILED  (-25)   /* Current operation cannot complete. */
97 #define ARCHIVE_FATAL   (-30)   /* No more operations are possible. */
98
99 /*
100  * As far as possible, archive_errno returns standard platform errno codes.
101  * Of course, the details vary by platform, so the actual definitions
102  * here are stored in "archive_platform.h".  The symbols are listed here
103  * for reference; as a rule, clients should not need to know the exact
104  * platform-dependent error code.
105  */
106 /* Unrecognized or invalid file format. */
107 /* #define      ARCHIVE_ERRNO_FILE_FORMAT */
108 /* Illegal usage of the library. */
109 /* #define      ARCHIVE_ERRNO_PROGRAMMER_ERROR */
110 /* Unknown or unclassified error. */
111 /* #define      ARCHIVE_ERRNO_MISC */
112
113 /*
114  * Callbacks are invoked to automatically read/skip/write/open/close the
115  * archive. You can provide your own for complex tasks (like breaking
116  * archives across multiple tapes) or use standard ones built into the
117  * library.
118  */
119
120 /* Returns pointer and size of next block of data from archive. */
121 typedef ssize_t archive_read_callback(struct archive *, void *_client_data,
122                     const void **_buffer);
123 /* Skips at most request bytes from archive and returns the skipped amount */
124 #if ARCHIVE_API_VERSION < 2
125 typedef ssize_t archive_skip_callback(struct archive *, void *_client_data,
126                     size_t request);
127 #else
128 typedef off_t   archive_skip_callback(struct archive *, void *_client_data,
129                     off_t request);
130 #endif
131 /* Returns size actually written, zero on EOF, -1 on error. */
132 typedef ssize_t archive_write_callback(struct archive *, void *_client_data,
133                     const void *_buffer, size_t _length);
134 typedef int     archive_open_callback(struct archive *, void *_client_data);
135 typedef int     archive_close_callback(struct archive *, void *_client_data);
136
137 /*
138  * Codes for archive_compression.
139  */
140 #define ARCHIVE_COMPRESSION_NONE        0
141 #define ARCHIVE_COMPRESSION_GZIP        1
142 #define ARCHIVE_COMPRESSION_BZIP2       2
143 #define ARCHIVE_COMPRESSION_COMPRESS    3
144
145 /*
146  * Codes returned by archive_format.
147  *
148  * Top 16 bits identifies the format family (e.g., "tar"); lower
149  * 16 bits indicate the variant.  This is updated by read_next_header.
150  * Note that the lower 16 bits will often vary from entry to entry.
151  * In some cases, this variation occurs as libarchive learns more about
152  * the archive (for example, later entries might utilize extensions that
153  * weren't necessary earlier in the archive; in this case, libarchive
154  * will change the format code to indicate the extended format that
155  * was used).  In other cases, it's because different tools have
156  * modified the archive and so different parts of the archive
157  * actually have slightly different formts.  (Both tar and cpio store
158  * format codes in each entry, so it is quite possible for each
159  * entry to be in a different format.)
160  */
161 #define ARCHIVE_FORMAT_BASE_MASK                0xff0000
162 #define ARCHIVE_FORMAT_CPIO                     0x10000
163 #define ARCHIVE_FORMAT_CPIO_POSIX               (ARCHIVE_FORMAT_CPIO | 1)
164 #define ARCHIVE_FORMAT_CPIO_BIN_LE              (ARCHIVE_FORMAT_CPIO | 2)
165 #define ARCHIVE_FORMAT_CPIO_BIN_BE              (ARCHIVE_FORMAT_CPIO | 3)
166 #define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC          (ARCHIVE_FORMAT_CPIO | 4)
167 #define ARCHIVE_FORMAT_CPIO_SVR4_CRC            (ARCHIVE_FORMAT_CPIO | 5)
168 #define ARCHIVE_FORMAT_SHAR                     0x20000
169 #define ARCHIVE_FORMAT_SHAR_BASE                (ARCHIVE_FORMAT_SHAR | 1)
170 #define ARCHIVE_FORMAT_SHAR_DUMP                (ARCHIVE_FORMAT_SHAR | 2)
171 #define ARCHIVE_FORMAT_TAR                      0x30000
172 #define ARCHIVE_FORMAT_TAR_USTAR                (ARCHIVE_FORMAT_TAR | 1)
173 #define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE      (ARCHIVE_FORMAT_TAR | 2)
174 #define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED       (ARCHIVE_FORMAT_TAR | 3)
175 #define ARCHIVE_FORMAT_TAR_GNUTAR               (ARCHIVE_FORMAT_TAR | 4)
176 #define ARCHIVE_FORMAT_ISO9660                  0x40000
177 #define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE        (ARCHIVE_FORMAT_ISO9660 | 1)
178 #define ARCHIVE_FORMAT_ZIP                      0x50000
179 #define ARCHIVE_FORMAT_EMPTY                    0x60000
180 #define ARCHIVE_FORMAT_AR                       0x70000
181 #define ARCHIVE_FORMAT_AR_SVR4                  (ARCHIVE_FORMAT_AR | 1)
182 #define ARCHIVE_FORMAT_AR_BSD                   (ARCHIVE_FORMAT_AR | 2)
183
184 /*-
185  * Basic outline for reading an archive:
186  *   1) Ask archive_read_new for an archive reader object.
187  *   2) Update any global properties as appropriate.
188  *      In particular, you'll certainly want to call appropriate
189  *      archive_read_support_XXX functions.
190  *   3) Call archive_read_open_XXX to open the archive
191  *   4) Repeatedly call archive_read_next_header to get information about
192  *      successive archive entries.  Call archive_read_data to extract
193  *      data for entries of interest.
194  *   5) Call archive_read_finish to end processing.
195  */
196 struct archive  *archive_read_new(void);
197
198 /*
199  * The archive_read_support_XXX calls enable auto-detect for this
200  * archive handle.  They also link in the necessary support code.
201  * For example, if you don't want bzlib linked in, don't invoke
202  * support_compression_bzip2().  The "all" functions provide the
203  * obvious shorthand.
204  */
205 int              archive_read_support_compression_all(struct archive *);
206 int              archive_read_support_compression_bzip2(struct archive *);
207 int              archive_read_support_compression_compress(struct archive *);
208 int              archive_read_support_compression_gzip(struct archive *);
209 int              archive_read_support_compression_none(struct archive *);
210
211 int              archive_read_support_format_all(struct archive *);
212 int              archive_read_support_format_ar(struct archive *);
213 int              archive_read_support_format_cpio(struct archive *);
214 int              archive_read_support_format_empty(struct archive *);
215 int              archive_read_support_format_gnutar(struct archive *);
216 int              archive_read_support_format_iso9660(struct archive *);
217 int              archive_read_support_format_tar(struct archive *);
218 int              archive_read_support_format_zip(struct archive *);
219
220
221 /* Open the archive using callbacks for archive I/O. */
222 int              archive_read_open(struct archive *, void *_client_data,
223                      archive_open_callback *, archive_read_callback *,
224                      archive_close_callback *);
225 int              archive_read_open2(struct archive *, void *_client_data,
226                      archive_open_callback *, archive_read_callback *,
227                      archive_skip_callback *, archive_close_callback *);
228
229 /*
230  * A variety of shortcuts that invoke archive_read_open() with
231  * canned callbacks suitable for common situations.  The ones that
232  * accept a block size handle tape blocking correctly.
233  */
234 /* Use this if you know the filename.  Note: NULL indicates stdin. */
235 int              archive_read_open_filename(struct archive *,
236                      const char *_filename, size_t _block_size);
237 /* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
238 int              archive_read_open_file(struct archive *,
239                      const char *_filename, size_t _block_size);
240 /* Read an archive that's stored in memory. */
241 int              archive_read_open_memory(struct archive *,
242                      void * buff, size_t size);
243 /* A more involved version that is only used for internal testing. */
244 int             archive_read_open_memory2(struct archive *a, void *buff,
245                      size_t size, size_t read_size);
246 /* Read an archive that's already open, using the file descriptor. */
247 int              archive_read_open_fd(struct archive *, int _fd,
248                      size_t _block_size);
249 /* Read an archive that's already open, using a FILE *. */
250 /* Note: DO NOT use this with tape drives. */
251 int              archive_read_open_FILE(struct archive *, FILE *_file);
252
253 /* Parses and returns next entry header. */
254 int              archive_read_next_header(struct archive *,
255                      struct archive_entry **);
256
257 /*
258  * Retrieve the byte offset in UNCOMPRESSED data where last-read
259  * header started.
260  */
261 int64_t          archive_read_header_position(struct archive *);
262
263 /* Read data from the body of an entry.  Similar to read(2). */
264 ssize_t          archive_read_data(struct archive *, void *, size_t);
265 /*
266  * A zero-copy version of archive_read_data that also exposes the file offset
267  * of each returned block.  Note that the client has no way to specify
268  * the desired size of the block.  The API does guarantee that offsets will
269  * be strictly increasing and that returned blocks will not overlap.
270  */
271 int              archive_read_data_block(struct archive *a,
272                     const void **buff, size_t *size, off_t *offset);
273
274 /*-
275  * Some convenience functions that are built on archive_read_data:
276  *  'skip': skips entire entry
277  *  'into_buffer': writes data into memory buffer that you provide
278  *  'into_fd': writes data to specified filedes
279  */
280 int              archive_read_data_skip(struct archive *);
281 int              archive_read_data_into_buffer(struct archive *, void *buffer,
282                      ssize_t len);
283 int              archive_read_data_into_fd(struct archive *, int fd);
284
285 /*-
286  * Convenience function to recreate the current entry (whose header
287  * has just been read) on disk.
288  *
289  * This does quite a bit more than just copy data to disk. It also:
290  *  - Creates intermediate directories as required.
291  *  - Manages directory permissions:  non-writable directories will
292  *    be initially created with write permission enabled; when the
293  *    archive is closed, dir permissions are edited to the values specified
294  *    in the archive.
295  *  - Checks hardlinks:  hardlinks will not be extracted unless the
296  *    linked-to file was also extracted within the same session. (TODO)
297  */
298
299 /* The "flags" argument selects optional behavior, 'OR' the flags you want. */
300
301 /* Default: Do not try to set owner/group. */
302 #define ARCHIVE_EXTRACT_OWNER   (1)
303 /* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
304 #define ARCHIVE_EXTRACT_PERM    (2)
305 /* Default: Do not restore mtime/atime. */
306 #define ARCHIVE_EXTRACT_TIME    (4)
307 /* Default: Replace existing files. */
308 #define ARCHIVE_EXTRACT_NO_OVERWRITE (8)
309 /* Default: Try create first, unlink only if create fails with EEXIST. */
310 #define ARCHIVE_EXTRACT_UNLINK  (16)
311 /* Default: Do not restore ACLs. */
312 #define ARCHIVE_EXTRACT_ACL     (32)
313 /* Default: Do not restore fflags. */
314 #define ARCHIVE_EXTRACT_FFLAGS  (64)
315 /* Default: Do not restore xattrs. */
316 #define ARCHIVE_EXTRACT_XATTR   (128)
317 /* Default: Do not try to guard against extracts redirected by symlinks. */
318 /* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
319 #define ARCHIVE_EXTRACT_SECURE_SYMLINKS (256)
320 /* Default: Do not reject entries with '..' as path elements. */
321 #define ARCHIVE_EXTRACT_SECURE_NODOTDOT (512)
322
323 int              archive_read_extract(struct archive *, struct archive_entry *,
324                      int flags);
325 void             archive_read_extract_set_progress_callback(struct archive *,
326                      void (*_progress_func)(void *), void *_user_data);
327
328 /* Record the dev/ino of a file that will not be written.  This is
329  * generally set to the dev/ino of the archive being read. */
330 void            archive_read_extract_set_skip_file(struct archive *,
331                      dev_t, ino_t);
332
333 /* Close the file and release most resources. */
334 int              archive_read_close(struct archive *);
335 /* Release all resources and destroy the object. */
336 /* Note that archive_read_finish will call archive_read_close for you. */
337 #if ARCHIVE_API_VERSION > 1
338 int              archive_read_finish(struct archive *);
339 #else
340 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
341 /* Erroneously declared to return void in libarchive 1.x */
342 void             archive_read_finish(struct archive *);
343 #endif
344
345 /*-
346  * To create an archive:
347  *   1) Ask archive_write_new for a archive writer object.
348  *   2) Set any global properties.  In particular, you should set
349  *      the compression and format to use.
350  *   3) Call archive_write_open to open the file (most people
351  *       will use archive_write_open_file or archive_write_open_fd,
352  *       which provide convenient canned I/O callbacks for you).
353  *   4) For each entry:
354  *      - construct an appropriate struct archive_entry structure
355  *      - archive_write_header to write the header
356  *      - archive_write_data to write the entry data
357  *   5) archive_write_close to close the output
358  *   6) archive_write_finish to cleanup the writer and release resources
359  */
360 struct archive  *archive_write_new(void);
361 int              archive_write_set_bytes_per_block(struct archive *,
362                      int bytes_per_block);
363 int              archive_write_get_bytes_per_block(struct archive *);
364 /* XXX This is badly misnamed; suggestions appreciated. XXX */
365 int              archive_write_set_bytes_in_last_block(struct archive *,
366                      int bytes_in_last_block);
367 int              archive_write_get_bytes_in_last_block(struct archive *);
368
369 /* The dev/ino of a file that won't be archived.  This is used
370  * to avoid recursively adding an archive to itself. */
371 int              archive_write_set_skip_file(struct archive *, dev_t, ino_t);
372
373 int              archive_write_set_compression_bzip2(struct archive *);
374 int              archive_write_set_compression_gzip(struct archive *);
375 int              archive_write_set_compression_none(struct archive *);
376 /* A convenience function to set the format based on the code or name. */
377 int              archive_write_set_format(struct archive *, int format_code);
378 int              archive_write_set_format_by_name(struct archive *,
379                      const char *name);
380 /* To minimize link pollution, use one or more of the following. */
381 int              archive_write_set_format_ar_bsd(struct archive *);
382 int              archive_write_set_format_ar_svr4(struct archive *);
383 int              archive_write_set_format_cpio(struct archive *);
384 /* TODO: int archive_write_set_format_old_tar(struct archive *); */
385 int              archive_write_set_format_pax(struct archive *);
386 int              archive_write_set_format_pax_restricted(struct archive *);
387 int              archive_write_set_format_shar(struct archive *);
388 int              archive_write_set_format_shar_dump(struct archive *);
389 int              archive_write_set_format_ustar(struct archive *);
390 int              archive_write_open(struct archive *, void *,
391                      archive_open_callback *, archive_write_callback *,
392                      archive_close_callback *);
393 int              archive_write_open_fd(struct archive *, int _fd);
394 int              archive_write_open_filename(struct archive *, const char *_file);
395 /* A deprecated synonym for archive_write_open_filename() */
396 int              archive_write_open_file(struct archive *, const char *_file);
397 int              archive_write_open_FILE(struct archive *, FILE *);
398 /* _buffSize is the size of the buffer, _used refers to a variable that
399  * will be updated after each write into the buffer. */
400 int              archive_write_open_memory(struct archive *,
401                         void *_buffer, size_t _buffSize, size_t *_used);
402
403 /*
404  * Note that the library will truncate writes beyond the size provided
405  * to archive_write_header or pad if the provided data is short.
406  */
407 int              archive_write_header(struct archive *,
408                      struct archive_entry *);
409 #if ARCHIVE_API_VERSION > 1
410 ssize_t          archive_write_data(struct archive *, const void *, size_t);
411 #else
412 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
413 /* This was erroneously declared to return "int" in libarchive 1.x. */
414 int              archive_write_data(struct archive *, const void *, size_t);
415 #endif
416 ssize_t          archive_write_data_block(struct archive *, const void *, size_t, off_t);
417 int              archive_write_finish_entry(struct archive *);
418 int              archive_write_close(struct archive *);
419 #if ARCHIVE_API_VERSION > 1
420 int              archive_write_finish(struct archive *);
421 #else
422 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
423 /* Return value was incorrect in libarchive 1.x. */
424 void             archive_write_finish(struct archive *);
425 #endif
426
427 /*-
428  * To create objects on disk:
429  *   1) Ask archive_write_disk_new for a new archive_write_disk object.
430  *   2) Set any global properties.  In particular, you should set
431  *      the compression and format to use.
432  *   3) For each entry:
433  *      - construct an appropriate struct archive_entry structure
434  *      - archive_write_header to create the file/dir/etc on disk
435  *      - archive_write_data to write the entry data
436  *   4) archive_write_finish to cleanup the writer and release resources
437  *
438  * In particular, you can use this in conjunction with archive_read()
439  * to pull entries out of an archive and create them on disk.
440  */
441 struct archive  *archive_write_disk_new(void);
442 /* This file will not be overwritten. */
443 int              archive_write_disk_set_skip_file(struct archive *,
444                      dev_t, ino_t);
445 /* Set flags to control how the next item gets created. */
446 int              archive_write_disk_set_options(struct archive *,
447                      int flags);
448 /*
449  * The lookup functions are given uname/uid (or gname/gid) pairs and
450  * return a uid (gid) suitable for this system.  These are used for
451  * restoring ownership and for setting ACLs.  The default functions
452  * are naive, they just return the uid/gid.  These are small, so reasonable
453  * for applications that don't need to preserve ownership; they
454  * are probably also appropriate for applications that are doing
455  * same-system backup and restore.
456  */
457 /*
458  * The "standard" lookup functions use common system calls to lookup
459  * the uname/gname, falling back to the uid/gid if the names can't be
460  * found.  They cache lookups and are reasonably fast, but can be very
461  * large, so they are not used unless you ask for them.  In
462  * particular, these match the specifications of POSIX "pax" and old
463  * POSIX "tar".
464  */
465 int              archive_write_disk_set_standard_lookup(struct archive *);
466 /*
467  * If neither the default (naive) nor the standard (big) functions suit
468  * your needs, you can write your own and register them.  Be sure to
469  * include a cleanup function if you have allocated private data.
470  */
471 int              archive_write_disk_set_group_lookup(struct archive *,
472                      void *private_data,
473                      gid_t (*loookup)(void *, const char *gname, gid_t gid),
474                      void (*cleanup)(void *));
475 int              archive_write_disk_set_user_lookup(struct archive *,
476                      void *private_data,
477                      uid_t (*)(void *, const char *uname, uid_t uid),
478                      void (*cleanup)(void *));
479
480 /*
481  * Accessor functions to read/set various information in
482  * the struct archive object:
483  */
484 /* Bytes written after compression or read before decompression. */
485 int64_t          archive_position_compressed(struct archive *);
486 /* Bytes written to compressor or read from decompressor. */
487 int64_t          archive_position_uncompressed(struct archive *);
488
489 const char      *archive_compression_name(struct archive *);
490 int              archive_compression(struct archive *);
491 int              archive_errno(struct archive *);
492 const char      *archive_error_string(struct archive *);
493 const char      *archive_format_name(struct archive *);
494 int              archive_format(struct archive *);
495 void             archive_clear_error(struct archive *);
496 void             archive_set_error(struct archive *, int _err, const char *fmt, ...);
497
498 #ifdef __cplusplus
499 }
500 #endif
501
502 #endif /* !ARCHIVE_H_INCLUDED */