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
  11 #include <stdio.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 llist_s {
  25         const char *data;
  26         const struct llist_s *link;
  27 } llist_t;
  28
  29 typedef struct archive_handle_s {
  30         /* define if the header and data compenent should processed */
  31         char (*filter)(struct archive_handle_s *);
  32         const llist_t *accept;
  33         const llist_t *reject;
  34         const llist_t *passed;  /* List of files that have successfully been worked on */
  35
  36         /* Contains the processed header entry */
  37         file_header_t *file_header;
  38
  39         /* process the header component, e.g. tar -t */
  40         void (*action_header)(const file_header_t *);
  41
  42         /* process the data componenet, e.g. extract to filesystem */
  43         void (*action_data)(struct archive_handle_s *);
  44
  45         /* How to process any sub archive, e.g. get_header_tar_gz */
  46         char (*action_data_subarchive)(struct archive_handle_s *);
  47
  48         /* Contains the handle to a sub archive */
  49         struct archive_handle_s *sub_archive;
  50
  51         /* The raw stream as read from disk or stdin */
  52         int src_fd;
  53
  54         /* Count the number of bytes processed */
  55         off_t offset;
  56
  57         /* Function that reads data: read or read_bz */
  58         ssize_t (*read)(int fd, void *buf, size_t count);
  59
  60         /* Function that skips data: read_by_char or read_by_skip */
  61         void (*seek)(const struct archive_handle_s *archive_handle, const unsigned int amount);
  62
  63         /* Temperary storage */
  64         char *buffer;
  65
  66         /* Misc. stuff */
  67         unsigned char flags;
  68
  69 } archive_handle_t;
  70
  71 extern archive_handle_t *init_handle(void);
  72
  73 extern char filter_accept_all(archive_handle_t *archive_handle);
  74 extern char filter_accept_list(archive_handle_t *archive_handle);
  75 extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
  76 extern char filter_accept_reject_list(archive_handle_t *archive_handle);
  77
  78 extern void unpack_ar_archive(archive_handle_t *ar_archive);
  79
  80 extern void data_skip(archive_handle_t *archive_handle);
  81 extern void data_extract_all(archive_handle_t *archive_handle);
  82 extern void data_extract_to_stdout(archive_handle_t *archive_handle);
  83 extern void data_extract_to_buffer(archive_handle_t *archive_handle);
  84
  85 extern void header_skip(const file_header_t *file_header);
  86 extern void header_list(const file_header_t *file_header);
  87 extern void header_verbose_list(const file_header_t *file_header);
  88
  89 extern void check_header_gzip(int src_fd);
  90 extern void check_trailer_gzip(int src_fd);
  91
  92 extern char get_header_ar(archive_handle_t *archive_handle);
  93 extern char get_header_tar(archive_handle_t *archive_handle);
  94 extern char get_header_tar_bz2(archive_handle_t *archive_handle);
  95 extern char get_header_tar_gz(archive_handle_t *archive_handle);
  96
  97 extern void seek_by_jump(const archive_handle_t *archive_handle, const unsigned int amount);
  98 extern void seek_by_char(const archive_handle_t *archive_handle, const unsigned int amount);
  99
 100 extern unsigned char archive_xread_char(const archive_handle_t *archive_handle);
 101 extern ssize_t archive_xread(const archive_handle_t *archive_handle, unsigned char *buf, const size_t count);
 102 extern void archive_xread_all(const archive_handle_t *archive_handle, void *buf, const size_t count);
 103 extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
 104
 105 extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
 106 extern const llist_t *add_to_list(const llist_t *old_head, const char *new_item);
 107 extern void archive_copy_file(const archive_handle_t *archive_handle, const int dst_fd);
 108 extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
 109
 110 extern ssize_t read_bz2(int fd, void *buf, size_t count);
 111 extern void BZ2_bzReadOpen(int fd, void *unused, int nUnused);
 112 extern void BZ2_bzReadClose(void);
 113 extern unsigned char uncompressStream(int src_fd, int dst_fd);
 114
 115 extern ssize_t read_gz(int fd, void *buf, size_t count);
 116 extern void GZ_gzReadOpen(int fd, void *unused, int nUnused);
 117 extern void GZ_gzReadClose(void);
 118 extern int inflate(int in, int out);
 119
 120 #endif