include/unarchive.h

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