include/unarchive.h

   1 #ifndef __UNARCHIVE_H__
   2 #define __UNARCHIVE_H__
   3
   4 #define ARCHIVE_PRESERVE_DATE   1
   5 #define ARCHIVE_CREATE_LEADING_DIRS             2
   6 #define ARCHIVE_EXTRACT_UNCONDITIONAL   4
   7 #define ARCHIVE_EXTRACT_QUIET   8
   8
   9 #include <sys/types.h>
  10 #include <stdio.h>
  11 #include "libbb.h"
  12
  13 typedef struct file_headers_s {
  14         char *name;
  15         char *link_name;
  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_s {
  25         /* define if the header and data compenent should processed */
  26         char (*filter)(struct archive_handle_s *);
  27         llist_t *accept;
  28         llist_t *reject;
  29         llist_t *passed;        /* List of files that have successfully been worked on */
  30
  31         /* Contains the processed header entry */
  32         file_header_t *file_header;
  33
  34         /* process the header component, e.g. tar -t */
  35         void (*action_header)(const file_header_t *);
  36
  37         /* process the data componenet, e.g. extract to filesystem */
  38         void (*action_data)(struct archive_handle_s *);
  39
  40         /* How to process any sub archive, e.g. get_header_tar_gz */
  41         char (*action_data_subarchive)(struct archive_handle_s *);
  42
  43         /* Contains the handle to a sub archive */
  44         struct archive_handle_s *sub_archive;
  45
  46         /* The raw stream as read from disk or stdin */
  47         int src_fd;
  48
  49         /* Count the number of bytes processed */
  50         off_t offset;
  51
  52         /* Function that reads data: read or read_bz */
  53         ssize_t (*read)(int fd, void *buf, size_t count);
  54
  55         /* Function that skips data: read_by_char or read_by_skip */
  56         void (*seek)(const struct archive_handle_s *archive_handle, const unsigned int amount);
  57
  58         /* Temperary storage */
  59         char *buffer;
  60
  61         /* Misc. stuff */
  62         unsigned char flags;
  63
  64 } archive_handle_t;
  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 void check_header_gzip(int src_fd);
  85 extern void check_trailer_gzip(int src_fd);
  86
  87 extern char get_header_ar(archive_handle_t *archive_handle);
  88 extern char get_header_cpio(archive_handle_t *archive_handle);
  89 extern char get_header_tar(archive_handle_t *archive_handle);
  90 extern char get_header_tar_bz2(archive_handle_t *archive_handle);
  91 extern char get_header_tar_gz(archive_handle_t *archive_handle);
  92
  93 extern void seek_by_jump(const archive_handle_t *archive_handle, const unsigned int amount);
  94 extern void seek_by_char(const archive_handle_t *archive_handle, const unsigned int amount);
  95
  96 extern unsigned char archive_xread_char(const archive_handle_t *archive_handle);
  97 extern ssize_t archive_xread(const archive_handle_t *archive_handle, unsigned char *buf, const size_t count);
  98 extern void archive_xread_all(const archive_handle_t *archive_handle, void *buf, const size_t count);
  99 extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
 100
 101 extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
 102 extern void archive_copy_file(const archive_handle_t *archive_handle, const int dst_fd);
 103 extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
 104
 105 extern ssize_t read_bz2(int fd, void *buf, size_t count);
 106 extern void BZ2_bzReadOpen(int fd, void *unused, int nUnused);
 107 extern void BZ2_bzReadClose(void);
 108 extern unsigned char uncompressStream(int src_fd, int dst_fd);
 109
 110 extern ssize_t read_gz(int fd, void *buf, size_t count);
 111 extern void GZ_gzReadOpen(int fd, void *unused, int nUnused);
 112 extern void GZ_gzReadClose(void);
 113 extern int inflate(int in, int out);
 114
 115 #endif