blob: 05ab0c16a88b3517ea9cb1b87a68ffc3507357ba [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
13#include <sys/types.h>
Glenn L McGrath237ae422002-11-03 14:05:15 +000014#include <stdio.h>
Glenn L McGrath66125c82002-12-08 00:54:33 +000015#include "libbb.h"
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000016
17typedef 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
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000028typedef struct archive_handle_s {
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000029 /* define if the header and data component should processed */
Glenn L McGrath18bbca12002-11-05 01:52:23 +000030 char (*filter)(struct archive_handle_s *);
Glenn L McGrath66125c82002-12-08 00:54:33 +000031 llist_t *accept;
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000032 /* List of files that have been rejected */
Glenn L McGrath66125c82002-12-08 00:54:33 +000033 llist_t *reject;
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000034 /* List of files that have successfully been worked on */
35 llist_t *passed;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000036
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000037 /* Contains the processed header entry */
38 file_header_t *file_header;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000039
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000040 /* process the header component, e.g. tar -t */
41 void (*action_header)(const file_header_t *);
Glenn L McGrathe9fc7812001-10-25 14:57:14 +000042
Glenn L McGrathf235d052003-10-29 03:37:54 +000043 /* process the data component, e.g. extract to filesystem */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000044 void (*action_data)(struct archive_handle_s *);
Eric Andersenc7bda1c2004-03-15 08:29:22 +000045
Glenn L McGrath18bbca12002-11-05 01:52:23 +000046 /* How to process any sub archive, e.g. get_header_tar_gz */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000047 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
Glenn L McGrath237ae422002-11-03 14:05:15 +000058 /* 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
Glenn L McGrathf235d052003-10-29 03:37:54 +000061 /* Temporary storage */
Glenn L McGrath61b79042002-10-19 10:40:55 +000062 char *buffer;
63
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +000064 /* Flags and misc. stuff */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000065 unsigned char flags;
66
67} archive_handle_t;
68
69extern archive_handle_t *init_handle(void);
70
Glenn L McGrath18bbca12002-11-05 01:52:23 +000071extern char filter_accept_all(archive_handle_t *archive_handle);
72extern char filter_accept_list(archive_handle_t *archive_handle);
73extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
74extern char filter_accept_reject_list(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000075
76extern void unpack_ar_archive(archive_handle_t *ar_archive);
77
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000078extern void data_skip(archive_handle_t *archive_handle);
79extern void data_extract_all(archive_handle_t *archive_handle);
80extern void data_extract_to_stdout(archive_handle_t *archive_handle);
Glenn L McGrath61b79042002-10-19 10:40:55 +000081extern void data_extract_to_buffer(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000082
83extern void header_skip(const file_header_t *file_header);
84extern void header_list(const file_header_t *file_header);
85extern void header_verbose_list(const file_header_t *file_header);
86
87extern void check_header_gzip(int src_fd);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000088
89extern char get_header_ar(archive_handle_t *archive_handle);
Glenn L McGrathb72a7352002-12-10 00:17:22 +000090extern char get_header_cpio(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000091extern char get_header_tar(archive_handle_t *archive_handle);
Glenn L McGrath7f2a9532002-11-05 02:56:57 +000092extern char get_header_tar_bz2(archive_handle_t *archive_handle);
Rob Landleyc1d69902006-01-20 18:28:50 +000093extern char get_header_tar_lzma(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +000094extern char get_header_tar_gz(archive_handle_t *archive_handle);
95
Glenn L McGrath237ae422002-11-03 14:05:15 +000096extern void seek_by_jump(const archive_handle_t *archive_handle, const unsigned int amount);
97extern void seek_by_char(const archive_handle_t *archive_handle, const unsigned int amount);
Glenn L McGrath60bce492002-11-03 07:28:38 +000098
Glenn L McGrath237ae422002-11-03 14:05:15 +000099extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
100
101extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
Glenn L McGrathc5c1a8a2002-10-19 06:19:22 +0000102extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000103
Glenn L McGrath5699b852003-11-15 23:19:05 +0000104extern int uncompressStream(int src_fd, int dst_fd);
105extern void inflate_init(unsigned int bufsize);
Paul Fox0840b762005-07-20 20:26:49 +0000106extern void inflate_cleanup(void);
Glenn L McGrath5699b852003-11-15 23:19:05 +0000107extern int inflate_unzip(int in, int out);
108extern int inflate_gunzip(int in, int out);
Rob Landleyc1d69902006-01-20 18:28:50 +0000109extern int unlzma(int src_fd, int dst_fd);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000110
Glenn L McGrath5699b852003-11-15 23:19:05 +0000111extern int open_transformer(int src_fd, int (*transformer)(int src_fd, int dst_fd));
112
Glenn L McGrathefe78892002-11-19 21:07:17 +0000113
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000114#endif