843f68f73a677c7bbd792e1ca33bb061f3342cbc
[oweals/busybox.git] / 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 #include "libbb.h"
14
15 typedef struct file_headers_s {
16         char *name;
17         char *link_name;
18         off_t size;
19         uid_t uid;
20         gid_t gid;
21         mode_t mode;
22         time_t mtime;
23         dev_t device;
24 } file_header_t;
25
26 typedef struct archive_handle_s {
27         /* define if the header and data component should be processed */
28         char (*filter)(struct archive_handle_s *);
29         llist_t *accept;
30         /* List of files that have been rejected */
31         llist_t *reject;
32         /* List of files that have successfully been worked on */
33         llist_t *passed;
34
35         /* Contains the processed header entry */
36         file_header_t *file_header;
37
38         /* process the header component, e.g. tar -t */
39         void (*action_header)(const file_header_t *);
40
41         /* process the data component, e.g. extract to filesystem */
42         void (*action_data)(struct archive_handle_s *);
43
44         /* How to process any sub archive, e.g. get_header_tar_gz */
45         char (*action_data_subarchive)(struct archive_handle_s *);
46
47         /* Contains the handle to a sub archive */
48         struct archive_handle_s *sub_archive;
49
50         /* The raw stream as read from disk or stdin */
51         int src_fd;
52
53         /* Count the number of bytes processed */
54         off_t offset;
55
56         /* Function that skips data: read_by_char or read_by_skip */
57         void (*seek)(const struct archive_handle_s *archive_handle, const unsigned int amount);
58
59         /* Temporary storage */
60         char *buffer;
61
62         /* Flags and misc. stuff */
63         unsigned char flags;
64
65 } archive_handle_t;
66
67
68 extern uint32_t gunzip_crc;
69 extern off_t gunzip_bytes_out;
70
71
72 extern archive_handle_t *init_handle(void);
73
74 extern char filter_accept_all(archive_handle_t *archive_handle);
75 extern char filter_accept_list(archive_handle_t *archive_handle);
76 extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
77 extern char filter_accept_reject_list(archive_handle_t *archive_handle);
78
79 extern void unpack_ar_archive(archive_handle_t *ar_archive);
80
81 extern void data_skip(archive_handle_t *archive_handle);
82 extern void data_extract_all(archive_handle_t *archive_handle);
83 extern void data_extract_to_stdout(archive_handle_t *archive_handle);
84 extern void data_extract_to_buffer(archive_handle_t *archive_handle);
85
86 extern void header_skip(const file_header_t *file_header);
87 extern void header_list(const file_header_t *file_header);
88 extern void header_verbose_list(const file_header_t *file_header);
89
90 extern void check_header_gzip(int src_fd);
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, const unsigned int amount);
100 extern void seek_by_read(const archive_handle_t *archive_handle, const unsigned int 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, const unsigned short 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 extern USE_DESKTOP(long long) int uncompressStream(int src_fd, int dst_fd);
109 extern void inflate_init(unsigned int bufsize);
110 extern void inflate_cleanup(void);
111 extern USE_DESKTOP(long long) int inflate_unzip(int in, int out);
112 extern USE_DESKTOP(long long) int inflate_gunzip(int in, int out);
113 extern USE_DESKTOP(long long) int unlzma(int src_fd, int dst_fd);
114
115 extern int open_transformer(int src_fd,
116         USE_DESKTOP(long long) int (*transformer)(int src_fd, int dst_fd));
117
118
119 #endif