- patch from Denis Vlasenko to add and use bb_xchdir()
[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 <sys/types.h>
14 #include <stdio.h>
15 #include "libbb.h"
16
17 typedef struct file_headers_s {
18         char *name;
19         char *link_name;
20         off_t size;
21         uid_t uid;
22         gid_t gid;
23         mode_t mode;
24         time_t mtime;
25         dev_t device;
26 } file_header_t;
27
28 typedef struct archive_handle_s {
29         /* define if the header and data component should processed */
30         char (*filter)(struct archive_handle_s *);
31         llist_t *accept;
32         /* List of files that have been rejected */
33         llist_t *reject;
34         /* List of files that have successfully been worked on */
35         llist_t *passed;
36
37         /* Contains the processed header entry */
38         file_header_t *file_header;
39
40         /* process the header component, e.g. tar -t */
41         void (*action_header)(const file_header_t *);
42
43         /* process the data component, e.g. extract to filesystem */
44         void (*action_data)(struct archive_handle_s *);
45
46         /* How to process any sub archive, e.g. get_header_tar_gz */
47         char (*action_data_subarchive)(struct archive_handle_s *);
48
49         /* Contains the handle to a sub archive */
50         struct archive_handle_s *sub_archive;
51
52         /* The raw stream as read from disk or stdin */
53         int src_fd;
54
55         /* Count the number of bytes processed */
56         off_t offset;
57
58         /* Function that skips data: read_by_char or read_by_skip */
59         void (*seek)(const struct archive_handle_s *archive_handle, const unsigned int amount);
60
61         /* Temporary storage */
62         char *buffer;
63
64         /* Flags and misc. stuff */
65         unsigned char flags;
66
67 } archive_handle_t;
68
69 extern archive_handle_t *init_handle(void);
70
71 extern char filter_accept_all(archive_handle_t *archive_handle);
72 extern char filter_accept_list(archive_handle_t *archive_handle);
73 extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
74 extern char filter_accept_reject_list(archive_handle_t *archive_handle);
75
76 extern void unpack_ar_archive(archive_handle_t *ar_archive);
77
78 extern void data_skip(archive_handle_t *archive_handle);
79 extern void data_extract_all(archive_handle_t *archive_handle);
80 extern void data_extract_to_stdout(archive_handle_t *archive_handle);
81 extern void data_extract_to_buffer(archive_handle_t *archive_handle);
82
83 extern void header_skip(const file_header_t *file_header);
84 extern void header_list(const file_header_t *file_header);
85 extern void header_verbose_list(const file_header_t *file_header);
86
87 extern void check_header_gzip(int src_fd);
88
89 extern char get_header_ar(archive_handle_t *archive_handle);
90 extern char get_header_cpio(archive_handle_t *archive_handle);
91 extern char get_header_tar(archive_handle_t *archive_handle);
92 extern char get_header_tar_bz2(archive_handle_t *archive_handle);
93 extern char get_header_tar_lzma(archive_handle_t *archive_handle);
94 extern char get_header_tar_gz(archive_handle_t *archive_handle);
95
96 extern void seek_by_jump(const archive_handle_t *archive_handle, const unsigned int amount);
97 extern void seek_by_char(const archive_handle_t *archive_handle, const unsigned int amount);
98
99 extern void archive_xread_all(const archive_handle_t *archive_handle, void *buf, const size_t count);
100 extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
101
102 extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
103 extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
104
105 extern int uncompressStream(int src_fd, int dst_fd);
106 extern void inflate_init(unsigned int bufsize);
107 extern void inflate_cleanup(void);
108 extern int inflate_unzip(int in, int out);
109 extern int inflate_gunzip(int in, int out);
110 extern int unlzma(int src_fd, int dst_fd);
111
112 extern int open_transformer(int src_fd, int (*transformer)(int src_fd, int dst_fd));
113
114
115 #endif