include/unarchive.h

   1 /* vi: set sw=4 ts=4: */
   2 #ifndef UNARCHIVE_H
   3 #define UNARCHIVE_H 1
   4
   5 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
   6
   7 typedef struct file_header_t {
   8         char *name;
   9         char *link_target;
  10 #if ENABLE_FEATURE_TAR_UNAME_GNAME
  11         char *tar__uname;
  12         char *tar__gname;
  13 #endif
  14         off_t size;
  15         uid_t uid;
  16         gid_t gid;
  17         mode_t mode;
  18         time_t mtime;
  19         dev_t device;
  20 } file_header_t;
  21
  22 struct hardlinks_t;
  23
  24 typedef struct archive_handle_t {
  25         /* Flags. 1st since it is most used member */
  26         unsigned ah_flags;
  27
  28         /* The raw stream as read from disk or stdin */
  29         int src_fd;
  30
  31         /* Define if the header and data component should be processed */
  32         char FAST_FUNC (*filter)(struct archive_handle_t *);
  33         /* List of files that have been accepted */
  34         llist_t *accept;
  35         /* List of files that have been rejected */
  36         llist_t *reject;
  37         /* List of files that have successfully been worked on */
  38         llist_t *passed;
  39
  40         /* Currently processed file's header */
  41         file_header_t *file_header;
  42
  43         /* Process the header component, e.g. tar -t */
  44         void FAST_FUNC (*action_header)(const file_header_t *);
  45
  46         /* Process the data component, e.g. extract to filesystem */
  47         void FAST_FUNC (*action_data)(struct archive_handle_t *);
  48
  49         /* Function that skips data */
  50         void FAST_FUNC (*seek)(int fd, off_t amount);
  51
  52         /* Count processed bytes */
  53         off_t offset;
  54
  55         /* Archiver specific. Can make it a union if it ever gets big */
  56 #if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB
  57         smallint tar__end;
  58 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
  59         char* tar__longname;
  60         char* tar__linkname;
  61 # endif
  62 # if ENABLE_FEATURE_TAR_SELINUX
  63         char* tar__global_sctx;
  64         char* tar__next_file_sctx;
  65 # endif
  66 #endif
  67 #if ENABLE_CPIO || ENABLE_RPM2CPIO || ENABLE_RPM
  68         uoff_t cpio__blocks;
  69         struct hardlinks_t *cpio__hardlinks_to_create;
  70         struct hardlinks_t *cpio__created_hardlinks;
  71 #endif
  72 #if ENABLE_DPKG || ENABLE_DPKG_DEB
  73         /* Temporary storage */
  74         char *dpkg__buffer;
  75         /* How to process any sub archive, e.g. get_header_tar_gz */
  76         char FAST_FUNC (*dpkg__action_data_subarchive)(struct archive_handle_t *);
  77         /* Contains the handle to a sub archive */
  78         struct archive_handle_t *dpkg__sub_archive;
  79 #endif
  80 #if ENABLE_FEATURE_AR_CREATE
  81         const char *ar__name;
  82         struct archive_handle_t *ar__out;
  83 #endif
  84 } archive_handle_t;
  85 /* bits in ah_flags */
  86 #define ARCHIVE_RESTORE_DATE        (1 << 0)
  87 #define ARCHIVE_CREATE_LEADING_DIRS (1 << 1)
  88 #define ARCHIVE_UNLINK_OLD          (1 << 2)
  89 #define ARCHIVE_EXTRACT_QUIET       (1 << 3)
  90 #define ARCHIVE_EXTRACT_NEWER       (1 << 4)
  91 #define ARCHIVE_DONT_RESTORE_OWNER  (1 << 5)
  92 #define ARCHIVE_DONT_RESTORE_PERM   (1 << 6)
  93 #define ARCHIVE_NUMERIC_OWNER       (1 << 7)
  94 #define ARCHIVE_O_TRUNC             (1 << 8)
  95
  96
  97 /* Info struct unpackers can fill out to inform users of thing like
  98  * timestamps of unpacked files */
  99 typedef struct unpack_info_t {
 100         time_t mtime;
 101 } unpack_info_t;
 102
 103 extern archive_handle_t *init_handle(void) FAST_FUNC;
 104
 105 extern char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC;
 106 extern char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC;
 107 extern char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC;
 108 extern char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC;
 109
 110 extern void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC;
 111
 112 extern void data_skip(archive_handle_t *archive_handle) FAST_FUNC;
 113 extern void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC;
 114 extern void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC;
 115
 116 extern void header_skip(const file_header_t *file_header) FAST_FUNC;
 117 extern void header_list(const file_header_t *file_header) FAST_FUNC;
 118 extern void header_verbose_list(const file_header_t *file_header) FAST_FUNC;
 119
 120 extern char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC;
 121 extern char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC;
 122 extern char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC;
 123 extern char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC;
 124 extern char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC;
 125 extern char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC;
 126
 127 extern void seek_by_jump(int fd, off_t amount) FAST_FUNC;
 128 extern void seek_by_read(int fd, off_t amount) FAST_FUNC;
 129
 130 extern void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC;
 131 extern const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC;
 132 extern const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC;
 133
 134 /* A bit of bunzip2 internals are exposed for compressed help support: */
 135 typedef struct bunzip_data bunzip_data;
 136 int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf, int len) FAST_FUNC;
 137 int read_bunzip(bunzip_data *bd, char *outbuf, int len) FAST_FUNC;
 138 void dealloc_bunzip(bunzip_data *bd) FAST_FUNC;
 139
 140 typedef struct inflate_unzip_result {
 141         off_t bytes_out;
 142         uint32_t crc;
 143 } inflate_unzip_result;
 144
 145 IF_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, off_t compr_size, int src_fd, int dst_fd) FAST_FUNC;
 146 /* lzma unpacker takes .lzma stream from offset 0 */
 147 IF_DESKTOP(long long) int unpack_lzma_stream(int src_fd, int dst_fd) FAST_FUNC;
 148 /* the rest wants 2 first bytes already skipped by the caller */
 149 IF_DESKTOP(long long) int unpack_bz2_stream(int src_fd, int dst_fd) FAST_FUNC;
 150 IF_DESKTOP(long long) int unpack_gz_stream(int src_fd, int dst_fd) FAST_FUNC;
 151 IF_DESKTOP(long long) int unpack_gz_stream_with_info(int src_fd, int dst_fd, unpack_info_t *info) FAST_FUNC;
 152 IF_DESKTOP(long long) int unpack_Z_stream(int fd_in, int fd_out) FAST_FUNC;
 153 /* wrapper which checks first two bytes to be "BZ" */
 154 IF_DESKTOP(long long) int unpack_bz2_stream_prime(int src_fd, int dst_fd) FAST_FUNC;
 155
 156 int bbunpack(char **argv,
 157              char* (*make_new_name)(char *filename),
 158              IF_DESKTOP(long long) int (*unpacker)(unpack_info_t *info)) FAST_FUNC;
 159
 160 #if BB_MMU
 161 void open_transformer(int fd,
 162         IF_DESKTOP(long long) int FAST_FUNC (*transformer)(int src_fd, int dst_fd)) FAST_FUNC;
 163 #define open_transformer(fd, transformer, transform_prog) open_transformer(fd, transformer)
 164 #else
 165 void open_transformer(int src_fd, const char *transform_prog) FAST_FUNC;
 166 #define open_transformer(fd, transformer, transform_prog) open_transformer(fd, transform_prog)
 167 #endif
 168
 169 POP_SAVED_FUNCTION_VISIBILITY
 170
 171 #endif