lib/libarchive/archive_entry.h

   1 /*-
   2  * Copyright (c) 2003-2008 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_ENTRY_H_INCLUDED
  29 #define ARCHIVE_ENTRY_H_INCLUDED
  30
  31 /*
  32  * Note: archive_entry.h is for use outside of libarchive; the
  33  * configuration headers (config.h, archive_platform.h, etc.) are
  34  * purely internal.  Do NOT use HAVE_XXX configuration macros to
  35  * control the behavior of this header!  If you must conditionalize,
  36  * use predefined compiler and/or platform macros.
  37  */
  38
  39 #include <sys/types.h>
  40 #include <stddef.h>  /* for wchar_t */
  41 #include <time.h>
  42
  43 /* Get appropriate definitions of standard POSIX-style types. */
  44 /* These should match the types used in 'struct stat' */
  45 #ifdef _WIN32
  46 #define __LA_UID_T      unsigned int
  47 #define __LA_GID_T      unsigned int
  48 #define __LA_DEV_T      unsigned int
  49 #define __LA_MODE_T     unsigned short
  50 #else
  51 #include <unistd.h>
  52 #define __LA_UID_T      uid_t
  53 #define __LA_GID_T      gid_t
  54 #define __LA_DEV_T      dev_t
  55 #define __LA_MODE_T     mode_t
  56 #endif
  57
  58 /*
  59  * XXX Is this defined for all Windows compilers?  If so, in what
  60  * header?  It would be nice to remove the __LA_INO_T indirection and
  61  * just use plain ino_t everywhere.  Likewise for the other types just
  62  * above.
  63  */
  64 #define __LA_INO_T      ino_t
  65
  66
  67 /*
  68  * On Windows, define LIBARCHIVE_STATIC if you're building or using a
  69  * .lib.  The default here assumes you're building a DLL.  Only
  70  * libarchive source should ever define __LIBARCHIVE_BUILD.
  71  */
  72 #if ((defined __WIN32__) || (defined _WIN32)) && (!defined LIBARCHIVE_STATIC)
  73 # ifdef __LIBARCHIVE_BUILD
  74 #  ifdef __GNUC__
  75 #   define __LA_DECL    __attribute__((dllexport)) extern
  76 #  else
  77 #   define __LA_DECL    __declspec(dllexport)
  78 #  endif
  79 # else
  80 #  ifdef __GNUC__
  81 #   define __LA_DECL    __attribute__((dllimport)) extern
  82 #  else
  83 #   define __LA_DECL    __declspec(dllimport)
  84 #  endif
  85 # endif
  86 #else
  87 /* Static libraries on all platforms and shared libraries on non-Windows. */
  88 # define __LA_DECL
  89 #endif
  90
  91 #ifdef __cplusplus
  92 extern "C" {
  93 #endif
  94
  95 /*
  96  * Description of an archive entry.
  97  *
  98  * You can think of this as "struct stat" with some text fields added in.
  99  *
 100  * TODO: Add "comment", "charset", and possibly other entries that are
 101  * supported by "pax interchange" format.  However, GNU, ustar, cpio,
 102  * and other variants don't support these features, so they're not an
 103  * excruciatingly high priority right now.
 104  *
 105  * TODO: "pax interchange" format allows essentially arbitrary
 106  * key/value attributes to be attached to any entry.  Supporting
 107  * such extensions may make this library useful for special
 108  * applications (e.g., a package manager could attach special
 109  * package-management attributes to each entry).
 110  */
 111 struct archive_entry;
 112
 113 /*
 114  * File-type constants.  These are returned from archive_entry_filetype()
 115  * and passed to archive_entry_set_filetype().
 116  *
 117  * These values match S_XXX defines on every platform I've checked,
 118  * including Windows, AIX, Linux, Solaris, and BSD.  They're
 119  * (re)defined here because platforms generally don't define the ones
 120  * they don't support.  For example, Windows doesn't define S_IFLNK or
 121  * S_IFBLK.  Instead of having a mass of conditional logic and system
 122  * checks to define any S_XXX values that aren't supported locally,
 123  * I've just defined a new set of such constants so that
 124  * libarchive-based applications can manipulate and identify archive
 125  * entries properly even if the hosting platform can't store them on
 126  * disk.
 127  *
 128  * These values are also used directly within some portable formats,
 129  * such as cpio.  If you find a platform that varies from these, the
 130  * correct solution is to leave these alone and translate from these
 131  * portable values to platform-native values when entries are read from
 132  * or written to disk.
 133  */
 134 #define AE_IFMT         0170000
 135 #define AE_IFREG        0100000
 136 #define AE_IFLNK        0120000
 137 #define AE_IFSOCK       0140000
 138 #define AE_IFCHR        0020000
 139 #define AE_IFBLK        0060000
 140 #define AE_IFDIR        0040000
 141 #define AE_IFIFO        0010000
 142
 143 /*
 144  * Basic object manipulation
 145  */
 146
 147 __LA_DECL struct archive_entry  *archive_entry_clear(struct archive_entry *);
 148 /* The 'clone' function does a deep copy; all of the strings are copied too. */
 149 __LA_DECL struct archive_entry  *archive_entry_clone(struct archive_entry *);
 150 __LA_DECL void                   archive_entry_free(struct archive_entry *);
 151 __LA_DECL struct archive_entry  *archive_entry_new(void);
 152
 153 /*
 154  * Retrieve fields from an archive_entry.
 155  *
 156  * There are a number of implicit conversions among these fields.  For
 157  * example, if a regular string field is set and you read the _w wide
 158  * character field, the entry will implicitly convert narrow-to-wide
 159  * using the current locale.  Similarly, dev values are automatically
 160  * updated when you write devmajor or devminor and vice versa.
 161  *
 162  * In addition, fields can be "set" or "unset."  Unset string fields
 163  * return NULL, non-string fields have _is_set() functions to test
 164  * whether they've been set.  You can "unset" a string field by
 165  * assigning NULL; non-string fields have _unset() functions to
 166  * unset them.
 167  *
 168  * Note: There is one ambiguity in the above; string fields will
 169  * also return NULL when implicit character set conversions fail.
 170  * This is usually what you want.
 171  */
 172 __LA_DECL time_t         archive_entry_atime(struct archive_entry *);
 173 __LA_DECL long           archive_entry_atime_nsec(struct archive_entry *);
 174 __LA_DECL int            archive_entry_atime_is_set(struct archive_entry *);
 175 __LA_DECL time_t         archive_entry_ctime(struct archive_entry *);
 176 __LA_DECL long           archive_entry_ctime_nsec(struct archive_entry *);
 177 __LA_DECL int            archive_entry_ctime_is_set(struct archive_entry *);
 178 __LA_DECL dev_t          archive_entry_dev(struct archive_entry *);
 179 __LA_DECL dev_t          archive_entry_devmajor(struct archive_entry *);
 180 __LA_DECL dev_t          archive_entry_devminor(struct archive_entry *);
 181 __LA_DECL __LA_MODE_T    archive_entry_filetype(struct archive_entry *);
 182 __LA_DECL void           archive_entry_fflags(struct archive_entry *,
 183                             unsigned long * /* set */,
 184                             unsigned long * /* clear */);
 185 __LA_DECL const char    *archive_entry_fflags_text(struct archive_entry *);
 186 __LA_DECL __LA_GID_T     archive_entry_gid(struct archive_entry *);
 187 __LA_DECL const char    *archive_entry_gname(struct archive_entry *);
 188 __LA_DECL const wchar_t *archive_entry_gname_w(struct archive_entry *);
 189 __LA_DECL const char    *archive_entry_hardlink(struct archive_entry *);
 190 __LA_DECL const wchar_t *archive_entry_hardlink_w(struct archive_entry *);
 191 __LA_DECL __LA_INO_T     archive_entry_ino(struct archive_entry *);
 192 __LA_DECL __LA_MODE_T    archive_entry_mode(struct archive_entry *);
 193 __LA_DECL time_t         archive_entry_mtime(struct archive_entry *);
 194 __LA_DECL long           archive_entry_mtime_nsec(struct archive_entry *);
 195 __LA_DECL int            archive_entry_mtime_is_set(struct archive_entry *);
 196 __LA_DECL unsigned int   archive_entry_nlink(struct archive_entry *);
 197 __LA_DECL const char    *archive_entry_pathname(struct archive_entry *);
 198 __LA_DECL const wchar_t *archive_entry_pathname_w(struct archive_entry *);
 199 __LA_DECL dev_t          archive_entry_rdev(struct archive_entry *);
 200 __LA_DECL dev_t          archive_entry_rdevmajor(struct archive_entry *);
 201 __LA_DECL dev_t          archive_entry_rdevminor(struct archive_entry *);
 202 __LA_DECL const char    *archive_entry_sourcepath(struct archive_entry *);
 203 __LA_DECL int64_t        archive_entry_size(struct archive_entry *);
 204 __LA_DECL int            archive_entry_size_is_set(struct archive_entry *);
 205 __LA_DECL const char    *archive_entry_strmode(struct archive_entry *);
 206 __LA_DECL const char    *archive_entry_symlink(struct archive_entry *);
 207 __LA_DECL const wchar_t *archive_entry_symlink_w(struct archive_entry *);
 208 __LA_DECL __LA_UID_T     archive_entry_uid(struct archive_entry *);
 209 __LA_DECL const char    *archive_entry_uname(struct archive_entry *);
 210 __LA_DECL const wchar_t *archive_entry_uname_w(struct archive_entry *);
 211
 212 /*
 213  * Set fields in an archive_entry.
 214  *
 215  * Note that string 'set' functions do not copy the string, only the pointer.
 216  * In contrast, 'copy' functions do copy the object pointed to.
 217  *
 218  * Note: As of libarchive 2.4, 'set' functions do copy the string and
 219  * are therefore exact synonyms for the 'copy' versions.  The 'copy'
 220  * names will be retired in libarchive 3.0.
 221  */
 222
 223 __LA_DECL void  archive_entry_set_atime(struct archive_entry *, time_t, long);
 224 __LA_DECL void  archive_entry_unset_atime(struct archive_entry *);
 225 __LA_DECL void  archive_entry_set_ctime(struct archive_entry *, time_t, long);
 226 __LA_DECL void  archive_entry_unset_ctime(struct archive_entry *);
 227 __LA_DECL void  archive_entry_set_dev(struct archive_entry *, dev_t);
 228 __LA_DECL void  archive_entry_set_devmajor(struct archive_entry *, dev_t);
 229 __LA_DECL void  archive_entry_set_devminor(struct archive_entry *, dev_t);
 230 __LA_DECL void  archive_entry_set_filetype(struct archive_entry *, unsigned int);
 231 __LA_DECL void  archive_entry_set_fflags(struct archive_entry *,
 232             unsigned long /* set */, unsigned long /* clear */);
 233 /* Returns pointer to start of first invalid token, or NULL if none. */
 234 /* Note that all recognized tokens are processed, regardless. */
 235 __LA_DECL const char *archive_entry_copy_fflags_text(struct archive_entry *,
 236             const char *);
 237 __LA_DECL const wchar_t *archive_entry_copy_fflags_text_w(struct archive_entry *,
 238             const wchar_t *);
 239 __LA_DECL void  archive_entry_set_gid(struct archive_entry *, __LA_GID_T);
 240 __LA_DECL void  archive_entry_set_gname(struct archive_entry *, const char *);
 241 __LA_DECL void  archive_entry_copy_gname(struct archive_entry *, const char *);
 242 __LA_DECL void  archive_entry_copy_gname_w(struct archive_entry *, const wchar_t *);
 243 __LA_DECL int   archive_entry_update_gname_utf8(struct archive_entry *, const char *);
 244 __LA_DECL void  archive_entry_set_hardlink(struct archive_entry *, const char *);
 245 __LA_DECL void  archive_entry_copy_hardlink(struct archive_entry *, const char *);
 246 __LA_DECL void  archive_entry_copy_hardlink_w(struct archive_entry *, const wchar_t *);
 247 __LA_DECL void  archive_entry_set_ino(struct archive_entry *, unsigned long);
 248 __LA_DECL void  archive_entry_set_link(struct archive_entry *, const char *);
 249 __LA_DECL void  archive_entry_copy_link(struct archive_entry *, const char *);
 250 __LA_DECL void  archive_entry_copy_link_w(struct archive_entry *, const wchar_t *);
 251 __LA_DECL int   archive_entry_update_link_utf8(struct archive_entry *, const char *);
 252 __LA_DECL void  archive_entry_set_mode(struct archive_entry *, __LA_MODE_T);
 253 __LA_DECL void  archive_entry_set_mtime(struct archive_entry *, time_t, long);
 254 __LA_DECL void  archive_entry_unset_mtime(struct archive_entry *);
 255 __LA_DECL void  archive_entry_set_nlink(struct archive_entry *, unsigned int);
 256 __LA_DECL void  archive_entry_set_pathname(struct archive_entry *, const char *);
 257 __LA_DECL void  archive_entry_copy_pathname(struct archive_entry *, const char *);
 258 __LA_DECL void  archive_entry_copy_pathname_w(struct archive_entry *, const wchar_t *);
 259 __LA_DECL int   archive_entry_update_pathname_utf8(struct archive_entry *, const char *);
 260 __LA_DECL void  archive_entry_set_perm(struct archive_entry *, __LA_MODE_T);
 261 __LA_DECL void  archive_entry_set_rdev(struct archive_entry *, dev_t);
 262 __LA_DECL void  archive_entry_set_rdevmajor(struct archive_entry *, dev_t);
 263 __LA_DECL void  archive_entry_set_rdevminor(struct archive_entry *, dev_t);
 264 __LA_DECL void  archive_entry_set_size(struct archive_entry *, int64_t);
 265 __LA_DECL void  archive_entry_unset_size(struct archive_entry *);
 266 __LA_DECL void  archive_entry_copy_sourcepath(struct archive_entry *, const char *);
 267 __LA_DECL void  archive_entry_set_symlink(struct archive_entry *, const char *);
 268 __LA_DECL void  archive_entry_copy_symlink(struct archive_entry *, const char *);
 269 __LA_DECL void  archive_entry_copy_symlink_w(struct archive_entry *, const wchar_t *);
 270 __LA_DECL void  archive_entry_set_uid(struct archive_entry *, __LA_UID_T);
 271 __LA_DECL void  archive_entry_set_uname(struct archive_entry *, const char *);
 272 __LA_DECL void  archive_entry_copy_uname(struct archive_entry *, const char *);
 273 __LA_DECL void  archive_entry_copy_uname_w(struct archive_entry *, const wchar_t *);
 274 __LA_DECL int   archive_entry_update_uname_utf8(struct archive_entry *, const char *);
 275 /*
 276  * Routines to bulk copy fields to/from a platform-native "struct
 277  * stat."  Libarchive used to just store a struct stat inside of each
 278  * archive_entry object, but this created issues when trying to
 279  * manipulate archives on systems different than the ones they were
 280  * created on.
 281  *
 282  * TODO: On Linux, provide both stat32 and stat64 versions of these functions.
 283  */
 284 __LA_DECL const struct stat     *archive_entry_stat(struct archive_entry *);
 285 __LA_DECL void  archive_entry_copy_stat(struct archive_entry *, const struct stat *);
 286
 287
 288 /*
 289  * ACL routines.  This used to simply store and return text-format ACL
 290  * strings, but that proved insufficient for a number of reasons:
 291  *   = clients need control over uname/uid and gname/gid mappings
 292  *   = there are many different ACL text formats
 293  *   = would like to be able to read/convert archives containing ACLs
 294  *     on platforms that lack ACL libraries
 295  *
 296  *  This last point, in particular, forces me to implement a reasonably
 297  *  complete set of ACL support routines.
 298  *
 299  *  TODO: Extend this to support NFSv4/NTFS permissions.  That should
 300  *  allow full ACL support on Mac OS, in particular, which uses
 301  *  POSIX.1e-style interfaces to manipulate NFSv4/NTFS permissions.
 302  */
 303
 304 /*
 305  * Permission bits mimic POSIX.1e.  Note that I've not followed POSIX.1e's
 306  * "permset"/"perm" abstract type nonsense.  A permset is just a simple
 307  * bitmap, following long-standing Unix tradition.
 308  */
 309 #define ARCHIVE_ENTRY_ACL_EXECUTE       1
 310 #define ARCHIVE_ENTRY_ACL_WRITE         2
 311 #define ARCHIVE_ENTRY_ACL_READ          4
 312
 313 /* We need to be able to specify either or both of these. */
 314 #define ARCHIVE_ENTRY_ACL_TYPE_ACCESS   256
 315 #define ARCHIVE_ENTRY_ACL_TYPE_DEFAULT  512
 316
 317 /* Tag values mimic POSIX.1e */
 318 #define ARCHIVE_ENTRY_ACL_USER          10001   /* Specified user. */
 319 #define ARCHIVE_ENTRY_ACL_USER_OBJ      10002   /* User who owns the file. */
 320 #define ARCHIVE_ENTRY_ACL_GROUP         10003   /* Specified group. */
 321 #define ARCHIVE_ENTRY_ACL_GROUP_OBJ     10004   /* Group who owns the file. */
 322 #define ARCHIVE_ENTRY_ACL_MASK          10005   /* Modify group access. */
 323 #define ARCHIVE_ENTRY_ACL_OTHER         10006   /* Public. */
 324
 325 /*
 326  * Set the ACL by clearing it and adding entries one at a time.
 327  * Unlike the POSIX.1e ACL routines, you must specify the type
 328  * (access/default) for each entry.  Internally, the ACL data is just
 329  * a soup of entries.  API calls here allow you to retrieve just the
 330  * entries of interest.  This design (which goes against the spirit of
 331  * POSIX.1e) is useful for handling archive formats that combine
 332  * default and access information in a single ACL list.
 333  */
 334 __LA_DECL void   archive_entry_acl_clear(struct archive_entry *);
 335 __LA_DECL void   archive_entry_acl_add_entry(struct archive_entry *,
 336             int /* type */, int /* permset */, int /* tag */,
 337             int /* qual */, const char * /* name */);
 338 __LA_DECL void   archive_entry_acl_add_entry_w(struct archive_entry *,
 339             int /* type */, int /* permset */, int /* tag */,
 340             int /* qual */, const wchar_t * /* name */);
 341
 342 /*
 343  * To retrieve the ACL, first "reset", then repeatedly ask for the
 344  * "next" entry.  The want_type parameter allows you to request only
 345  * access entries or only default entries.
 346  */
 347 __LA_DECL int    archive_entry_acl_reset(struct archive_entry *, int /* want_type */);
 348 __LA_DECL int    archive_entry_acl_next(struct archive_entry *, int /* want_type */,
 349             int * /* type */, int * /* permset */, int * /* tag */,
 350             int * /* qual */, const char ** /* name */);
 351 __LA_DECL int    archive_entry_acl_next_w(struct archive_entry *, int /* want_type */,
 352             int * /* type */, int * /* permset */, int * /* tag */,
 353             int * /* qual */, const wchar_t ** /* name */);
 354
 355 /*
 356  * Construct a text-format ACL.  The flags argument is a bitmask that
 357  * can include any of the following:
 358  *
 359  * ARCHIVE_ENTRY_ACL_TYPE_ACCESS - Include access entries.
 360  * ARCHIVE_ENTRY_ACL_TYPE_DEFAULT - Include default entries.
 361  * ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID - Include extra numeric ID field in
 362  *    each ACL entry.  (As used by 'star'.)
 363  * ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT - Include "default:" before each
 364  *    default ACL entry.
 365  */
 366 #define ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID        1024
 367 #define ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT    2048
 368 __LA_DECL const wchar_t *archive_entry_acl_text_w(struct archive_entry *,
 369                     int /* flags */);
 370
 371 /* Return a count of entries matching 'want_type' */
 372 __LA_DECL int    archive_entry_acl_count(struct archive_entry *, int /* want_type */);
 373
 374 /*
 375  * Private ACL parser.  This is private because it handles some
 376  * very weird formats that clients should not be messing with.
 377  * Clients should only deal with their platform-native formats.
 378  * Because of the need to support many formats cleanly, new arguments
 379  * are likely to get added on a regular basis.  Clients who try to use
 380  * this interface are likely to be surprised when it changes.
 381  *
 382  * You were warned!
 383  *
 384  * TODO: Move this declaration out of the public header and into
 385  * a private header.  Warnings above are silly.
 386  */
 387 __LA_DECL int            __archive_entry_acl_parse_w(struct archive_entry *,
 388                     const wchar_t *, int /* type */);
 389
 390 /*
 391  * extended attributes
 392  */
 393
 394 __LA_DECL void   archive_entry_xattr_clear(struct archive_entry *);
 395 __LA_DECL void   archive_entry_xattr_add_entry(struct archive_entry *,
 396             const char * /* name */, const void * /* value */,
 397             size_t /* size */);
 398
 399 /*
 400  * To retrieve the xattr list, first "reset", then repeatedly ask for the
 401  * "next" entry.
 402  */
 403
 404 __LA_DECL int   archive_entry_xattr_count(struct archive_entry *);
 405 __LA_DECL int   archive_entry_xattr_reset(struct archive_entry *);
 406 __LA_DECL int   archive_entry_xattr_next(struct archive_entry *,
 407             const char ** /* name */, const void ** /* value */, size_t *);
 408
 409 /*
 410  * Utility to match up hardlinks.
 411  *
 412  * The 'struct archive_entry_linkresolver' is a cache of archive entries
 413  * for files with multiple links.  Here's how to use it:
 414  *   1. Create a lookup object with archive_entry_linkresolver_new()
 415  *   2. Tell it the archive format you're using.
 416  *   3. Hand each archive_entry to archive_entry_linkify().
 417  *      That function will return 0, 1, or 2 entries that should
 418  *      be written.
 419  *   4. Call archive_entry_linkify(resolver, NULL) until
 420  *      no more entries are returned.
 421  *   5. Call archive_entry_link_resolver_free(resolver) to free resources.
 422  *
 423  * The entries returned have their hardlink and size fields updated
 424  * appropriately.  If an entry is passed in that does not refer to
 425  * a file with multiple links, it is returned unchanged.  The intention
 426  * is that you should be able to simply filter all entries through
 427  * this machine.
 428  *
 429  * To make things more efficient, be sure that each entry has a valid
 430  * nlinks value.  The hardlink cache uses this to track when all links
 431  * have been found.  If the nlinks value is zero, it will keep every
 432  * name in the cache indefinitely, which can use a lot of memory.
 433  *
 434  * Note that archive_entry_size() is reset to zero if the file
 435  * body should not be written to the archive.  Pay attention!
 436  */
 437 __LA_DECL struct archive_entry_linkresolver;
 438
 439 /*
 440  * There are three different strategies for marking hardlinks.
 441  * The descriptions below name them after the best-known
 442  * formats that rely on each strategy:
 443  *
 444  * "Old cpio" is the simplest, it always returns any entry unmodified.
 445  *    As far as I know, only cpio formats use this.  Old cpio archives
 446  *    store every link with the full body; the onus is on the dearchiver
 447  *    to detect and properly link the files as they are restored.
 448  * "tar" is also pretty simple; it caches a copy the first time it sees
 449  *    any link.  Subsequent appearances are modified to be hardlink
 450  *    references to the first one without any body.  Used by all tar
 451  *    formats, although the newest tar formats permit the "old cpio" strategy
 452  *    as well.  This strategy is very simple for the dearchiver,
 453  *    and reasonably straightforward for the archiver.
 454  * "new cpio" is trickier.  It stores the body only with the last
 455  *    occurrence.  The complication is that we might not
 456  *    see every link to a particular file in a single session, so
 457  *    there's no easy way to know when we've seen the last occurrence.
 458  *    The solution here is to queue one link until we see the next.
 459  *    At the end of the session, you can enumerate any remaining
 460  *    entries by calling archive_entry_linkify(NULL) and store those
 461  *    bodies.  If you have a file with three links l1, l2, and l3,
 462  *    you'll get the following behavior if you see all three links:
 463  *           linkify(l1) => NULL   (the resolver stores l1 internally)
 464  *           linkify(l2) => l1     (resolver stores l2, you write l1)
 465  *           linkify(l3) => l2, l3 (all links seen, you can write both).
 466  *    If you only see l1 and l2, you'll get this behavior:
 467  *           linkify(l1) => NULL
 468  *           linkify(l2) => l1
 469  *           linkify(NULL) => l2   (at end, you retrieve remaining links)
 470  *    As the name suggests, this strategy is used by newer cpio variants.
 471  *    It's noticably more complex for the archiver, slightly more complex
 472  *    for the dearchiver than the tar strategy, but makes it straightforward
 473  *    to restore a file using any link by simply continuing to scan until
 474  *    you see a link that is stored with a body.  In contrast, the tar
 475  *    strategy requires you to rescan the archive from the beginning to
 476  *    correctly extract an arbitrary link.
 477  */
 478
 479 __LA_DECL struct archive_entry_linkresolver *archive_entry_linkresolver_new(void);
 480 __LA_DECL void archive_entry_linkresolver_set_strategy(
 481         struct archive_entry_linkresolver *, int /* format_code */);
 482 __LA_DECL void archive_entry_linkresolver_free(struct archive_entry_linkresolver *);
 483 __LA_DECL void archive_entry_linkify(struct archive_entry_linkresolver *,
 484     struct archive_entry **, struct archive_entry **);
 485
 486 #ifdef __cplusplus
 487 }
 488 #endif
 489
 490 /* This is meaningless outside of this header. */
 491 #undef __LA_DECL
 492
 493 #endif /* !ARCHIVE_ENTRY_H_INCLUDED */