contrib/libarchive/libarchive/archive_read_disk_private.h

   1 /*-
   2  * Copyright (c) 2003-2009 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  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef __LIBARCHIVE_BUILD
  30 #error This header is only to be used internally to libarchive.
  31 #endif
  32
  33 #ifndef ARCHIVE_READ_DISK_PRIVATE_H_INCLUDED
  34 #define ARCHIVE_READ_DISK_PRIVATE_H_INCLUDED
  35
  36 struct tree;
  37 struct archive_entry;
  38
  39 struct archive_read_disk {
  40         struct archive  archive;
  41
  42         /* Reused by archive_read_next_header() */
  43         struct archive_entry *entry;
  44
  45         /*
  46          * Symlink mode is one of 'L'ogical, 'P'hysical, or 'H'ybrid,
  47          * following an old BSD convention.  'L' follows all symlinks,
  48          * 'P' follows none, 'H' follows symlinks only for the first
  49          * item.
  50          */
  51         char    symlink_mode;
  52
  53         /*
  54          * Since symlink interaction changes, we need to track whether
  55          * we're following symlinks for the current item.  'L' mode above
  56          * sets this true, 'P' sets it false, 'H' changes it as we traverse.
  57          */
  58         char    follow_symlinks;  /* Either 'L' or 'P'. */
  59
  60         /* Directory traversals. */
  61         struct tree *tree;
  62         int     (*open_on_current_dir)(struct tree*, const char *, int);
  63         int     (*tree_current_dir_fd)(struct tree*);
  64         int     (*tree_enter_working_dir)(struct tree*);
  65
  66         /* Set 1 if users request to restore atime . */
  67         int              restore_time;
  68         /* Set 1 if users request to honor nodump flag . */
  69         int              honor_nodump;
  70         /* Set 1 if users request to enable mac copyfile. */
  71         int              enable_copyfile;
  72         /* Set 1 if users request to traverse mount points. */
  73         int              traverse_mount_points;
  74         /* Set 1 if users want to suppress xattr information. */
  75         int              suppress_xattr;
  76
  77         const char * (*lookup_gname)(void *private, int64_t gid);
  78         void    (*cleanup_gname)(void *private);
  79         void     *lookup_gname_data;
  80         const char * (*lookup_uname)(void *private, int64_t uid);
  81         void    (*cleanup_uname)(void *private);
  82         void     *lookup_uname_data;
  83
  84         int     (*metadata_filter_func)(struct archive *, void *,
  85                         struct archive_entry *);
  86         void    *metadata_filter_data;
  87
  88         /* ARCHIVE_MATCH object. */
  89         struct archive  *matching;
  90         /* Callback function, this will be invoked when ARCHIVE_MATCH
  91          * archive_match_*_excluded_ae return true. */
  92         void    (*excluded_cb_func)(struct archive *, void *,
  93                          struct archive_entry *);
  94         void    *excluded_cb_data;
  95 };
  96
  97 #endif