blob: 8aa90beccfd59a46da922b972173e494b71b7823 [file] [log] [blame]
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +00001/* vi: set sw=4 ts=4: */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +00002#ifndef __UNARCHIVE_H__
3#define __UNARCHIVE_H__
Glenn L McGrathe9fc7812001-10-25 14:57:14 +00004
Rob Landleyf3d6c942005-10-27 22:49:08 +00005#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
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000012
Glenn L McGrath66125c82002-12-08 00:54:33 +000013#include "libbb.h"
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000014
15typedef 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
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000026typedef struct archive_handle_s {
Denis Vlasenko714701c2006-12-22 00:21:07 +000027 /* define if the header and data component should be processed */
Glenn L McGrath18bbca12002-11-05 01:52:23 +000028 char (*filter)(struct archive_handle_s *);
Glenn L McGrath66125c82002-12-08 00:54:33 +000029 llist_t *accept;
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000030 /* List of files that have been rejected */
Glenn L McGrath66125c82002-12-08 00:54:33 +000031 llist_t *reject;
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000032 /* List of files that have successfully been worked on */
33 llist_t *passed;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000034
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000035 /* Contains the processed header entry */
36 file_header_t *file_header;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000037
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000038 /* process the header component, e.g. tar -t */
39 void (*action_header)(const file_header_t *);
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000040
Glenn L McGrathf235d052003-10-29 03:37:54 +000041 /* process the data component, e.g. extract to filesystem */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000042 void (*action_data)(struct archive_handle_s *);
Eric Andersenc7bda1c2004-03-15 08:29:22 +000043
Glenn L McGrath18bbca12002-11-05 01:52:23 +000044 /* How to process any sub archive, e.g. get_header_tar_gz */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000045 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
Glenn L McGrath237ae422002-11-03 14:05:15 +000056 /* 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
Glenn L McGrathf235d052003-10-29 03:37:54 +000059 /* Temporary storage */
Glenn L McGrath61b79042002-10-19 10:40:55 +000060 char *buffer;
61
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000062 /* Flags and misc. stuff */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000063 unsigned char flags;
64
65} archive_handle_t;
66
Denis Vlasenkobb3d0fa2007-01-03 01:57:25 +000067
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000068extern archive_handle_t *init_handle(void);
69
Glenn L McGrath18bbca12002-11-05 01:52:23 +000070extern char filter_accept_all(archive_handle_t *archive_handle);
71extern char filter_accept_list(archive_handle_t *archive_handle);
72extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
73extern char filter_accept_reject_list(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000074
75extern void unpack_ar_archive(archive_handle_t *ar_archive);
76
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000077extern void data_skip(archive_handle_t *archive_handle);
78extern void data_extract_all(archive_handle_t *archive_handle);
79extern void data_extract_to_stdout(archive_handle_t *archive_handle);
Glenn L McGrath61b79042002-10-19 10:40:55 +000080extern void data_extract_to_buffer(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000081
82extern void header_skip(const file_header_t *file_header);
83extern void header_list(const file_header_t *file_header);
84extern void header_verbose_list(const file_header_t *file_header);
85
Denis Vlasenkoab9eef22007-03-07 22:02:23 +000086extern void check_header_gzip_or_die(int src_fd);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000087
88extern char get_header_ar(archive_handle_t *archive_handle);
Glenn L McGrathb72a7352002-12-10 00:17:22 +000089extern char get_header_cpio(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000090extern char get_header_tar(archive_handle_t *archive_handle);
Glenn L McGrath7f2a9532002-11-05 02:56:57 +000091extern char get_header_tar_bz2(archive_handle_t *archive_handle);
Rob Landleyc1d69902006-01-20 18:28:50 +000092extern char get_header_tar_lzma(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000093extern char get_header_tar_gz(archive_handle_t *archive_handle);
94
Glenn L McGrath237ae422002-11-03 14:05:15 +000095extern void seek_by_jump(const archive_handle_t *archive_handle, const unsigned int amount);
Denis Vlasenko13858992006-10-08 12:49:22 +000096extern void seek_by_read(const archive_handle_t *archive_handle, const unsigned int amount);
Glenn L McGrath60bce492002-11-03 07:28:38 +000097
Glenn L McGrath237ae422002-11-03 14:05:15 +000098extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
99
100extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
Glenn L McGrathc5c1a8a2002-10-19 06:19:22 +0000101extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
Denis Vlasenko314908d2006-09-03 14:04:33 +0000102extern const llist_t *find_list_entry2(const llist_t *list, const char *filename);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000103
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000104extern USE_DESKTOP(long long) int uncompressStream(int src_fd, int dst_fd);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000105/* A bit of bunzip2 internals are exposed for compressed help support: */
106typedef struct bunzip_data bunzip_data;
107int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf, int len);
108int read_bunzip(bunzip_data *bd, char *outbuf, int len);
109void dealloc_bunzip(bunzip_data *bd);
Denis Vlasenkocd42cb82007-01-05 23:56:53 +0000110
111typedef struct inflate_unzip_result {
112 off_t bytes_out;
113 uint32_t crc;
114} inflate_unzip_result;
115
116extern USE_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, unsigned bufsize, int in, int out);
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000117extern USE_DESKTOP(long long) int inflate_gunzip(int in, int out);
118extern USE_DESKTOP(long long) int unlzma(int src_fd, int dst_fd);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000119
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000120extern int open_transformer(int src_fd,
121 USE_DESKTOP(long long) int (*transformer)(int src_fd, int dst_fd));
Glenn L McGrath5699b852003-11-15 23:19:05 +0000122
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000123#endif