include/unarchive.h

   1 /* vi: set sw=4 ts=4: */
   2 #ifndef __UNARCHIVE_H__
   3 #define __UNARCHIVE_H__
   4
   5 #if __GNUC_PREREQ(4,1)
   6 # pragma GCC visibility push(hidden)
   7 #endif
   8
   9 #define ARCHIVE_PRESERVE_DATE           1
  10 #define ARCHIVE_CREATE_LEADING_DIRS     2
  11 #define ARCHIVE_EXTRACT_UNCONDITIONAL   4
  12 #define ARCHIVE_EXTRACT_QUIET           8
  13 #define ARCHIVE_EXTRACT_NEWER           16
  14 #define ARCHIVE_NOPRESERVE_OWN          32
  15 #define ARCHIVE_NOPRESERVE_PERM         64
  16
  17 typedef struct file_header_t {
  18         char *name;
  19         char *link_target;
  20 #if ENABLE_FEATURE_TAR_UNAME_GNAME
  21         char *uname;
  22         char *gname;
  23 #endif
  24         off_t size;
  25         uid_t uid;
  26         gid_t gid;
  27         mode_t mode;
  28         time_t mtime;
  29         dev_t device;
  30 } file_header_t;
  31
  32 typedef struct archive_handle_t {
  33         /* define if the header and data component should be processed */
  34         char (*filter)(struct archive_handle_t *);
  35         llist_t *accept;
  36         /* List of files that have been rejected */
  37         llist_t *reject;
  38         /* List of files that have successfully been worked on */
  39         llist_t *passed;
  40
  41         /* Contains the processed header entry */
  42         file_header_t *file_header;
  43
  44         /* process the header component, e.g. tar -t */
  45         void (*action_header)(const file_header_t *);
  46
  47         /* process the data component, e.g. extract to filesystem */
  48         void (*action_data)(struct archive_handle_t *);
  49
  50         /* How to process any sub archive, e.g. get_header_tar_gz */
  51         char (*action_data_subarchive)(struct archive_handle_t *);
  52
  53         /* Contains the handle to a sub archive */
  54         struct archive_handle_t *sub_archive;
  55
  56         /* The raw stream as read from disk or stdin */
  57         int src_fd;
  58
  59         /* Count the number of bytes processed */
  60         off_t offset;
  61
  62         /* Function that skips data: read_by_char or read_by_skip */
  63         void (*seek)(const struct archive_handle_t *archive_handle, const unsigned amount);
  64
  65         /* Temporary storage */
  66         char *buffer;
  67
  68         /* Flags and misc. stuff */
  69         unsigned char flags;
  70
  71 } archive_handle_t;
  72
  73
  74 extern archive_handle_t *init_handle(void);
  75
  76 extern char filter_accept_all(archive_handle_t *archive_handle);
  77 extern char filter_accept_list(archive_handle_t *archive_handle);
  78 extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
  79 extern char filter_accept_reject_list(archive_handle_t *archive_handle);
  80
  81 extern void unpack_ar_archive(archive_handle_t *ar_archive);
  82
  83 extern void data_skip(archive_handle_t *archive_handle);
  84 extern void data_extract_all(archive_handle_t *archive_handle);
  85 extern void data_extract_to_stdout(archive_handle_t *archive_handle);
  86 extern void data_extract_to_buffer(archive_handle_t *archive_handle);
  87
  88 extern void header_skip(const file_header_t *file_header);
  89 extern void header_list(const file_header_t *file_header);
  90 extern void header_verbose_list(const file_header_t *file_header);
  91
  92 extern char get_header_ar(archive_handle_t *archive_handle);
  93 extern char get_header_cpio(archive_handle_t *archive_handle);
  94 extern char get_header_tar(archive_handle_t *archive_handle);
  95 extern char get_header_tar_bz2(archive_handle_t *archive_handle);
  96 extern char get_header_tar_lzma(archive_handle_t *archive_handle);
  97 extern char get_header_tar_gz(archive_handle_t *archive_handle);
  98
  99 extern void seek_by_jump(const archive_handle_t *archive_handle, unsigned amount);
 100 extern void seek_by_read(const archive_handle_t *archive_handle, unsigned amount);
 101
 102 extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
 103
 104 extern void data_align(archive_handle_t *archive_handle, unsigned boundary);
 105 extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
 106 extern const llist_t *find_list_entry2(const llist_t *list, const char *filename);
 107
 108 /* A bit of bunzip2 internals are exposed for compressed help support: */
 109 typedef struct bunzip_data bunzip_data;
 110 int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf, int len);
 111 int read_bunzip(bunzip_data *bd, char *outbuf, int len);
 112 void dealloc_bunzip(bunzip_data *bd);
 113
 114 typedef struct inflate_unzip_result {
 115         off_t bytes_out;
 116         uint32_t crc;
 117 } inflate_unzip_result;
 118
 119 extern USE_DESKTOP(long long) int unpack_bz2_stream(int src_fd, int dst_fd);
 120 extern USE_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, off_t compr_size, int src_fd, int dst_fd);
 121 extern USE_DESKTOP(long long) int unpack_gz_stream(int src_fd, int dst_fd);
 122 extern USE_DESKTOP(long long) int unpack_lzma_stream(int src_fd, int dst_fd);
 123
 124 #if BB_MMU
 125 extern int open_transformer(int src_fd,
 126         USE_DESKTOP(long long) int (*transformer)(int src_fd, int dst_fd));
 127 #define open_transformer(src_fd, transformer, transform_prog) open_transformer(src_fd, transformer)
 128 #else
 129 extern int open_transformer(int src_fd, const char *transform_prog);
 130 #define open_transformer(src_fd, transformer, transform_prog) open_transformer(src_fd, transform_prog)
 131 #endif
 132
 133 #if __GNUC_PREREQ(4,1)
 134 # pragma GCC visibility pop
 135 #endif
 136
 137 #endif