2075ca2ac25af398d37dcf65f429d47cb2e3430e
[oweals/busybox.git] / 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 #define ARCHIVE_EXTRACT_NEWER           16
9 #define ARCHIVE_NOPRESERVE_OWN          32
10 #define ARCHIVE_NOPRESERVE_PERM         64
11
12 #include <sys/types.h>
13 #include <stdio.h>
14 #include "libbb.h"
15
16 typedef struct file_headers_s {
17         char *name;
18         char *link_name;
19         off_t size;
20         uid_t uid;
21         gid_t gid;
22         mode_t mode;
23         time_t mtime;
24         dev_t device;
25 } file_header_t;
26
27 typedef struct archive_handle_s {
28         /* define if the header and data compenent should processed */
29         char (*filter)(struct archive_handle_s *);
30         llist_t *accept;
31         llist_t *reject;
32         llist_t *passed;        /* List of files that have successfully been worked on */
33
34         /* Contains the processed header entry */
35         file_header_t *file_header;
36
37         /* process the header component, e.g. tar -t */
38         void (*action_header)(const file_header_t *);
39
40         /* process the data component, e.g. extract to filesystem */
41         void (*action_data)(struct archive_handle_s *);
42
43         /* How to process any sub archive, e.g. get_header_tar_gz */
44         char (*action_data_subarchive)(struct archive_handle_s *);
45
46         /* Contains the handle to a sub archive */
47         struct archive_handle_s *sub_archive;
48
49         /* The raw stream as read from disk or stdin */
50         int src_fd;
51
52         /* Count the number of bytes processed */
53         off_t offset;
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         /* Temporary 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
86 extern char get_header_ar(archive_handle_t *archive_handle);
87 extern char get_header_cpio(archive_handle_t *archive_handle);
88 extern char get_header_tar(archive_handle_t *archive_handle);
89 extern char get_header_tar_bz2(archive_handle_t *archive_handle);
90 extern char get_header_tar_lzma(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 void archive_xread_all(const archive_handle_t *archive_handle, void *buf, const size_t count);
97 extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
98
99 extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
100 extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
101
102 extern int uncompressStream(int src_fd, int dst_fd);
103 extern void inflate_init(unsigned int bufsize);
104 extern void inflate_cleanup(void);
105 extern int inflate_unzip(int in, int out);
106 extern int inflate_gunzip(int in, int out);
107 extern int unlzma(int src_fd, int dst_fd);
108
109 extern int open_transformer(int src_fd, int (*transformer)(int src_fd, int dst_fd));
110
111
112 #endif