bsdtar.h revision 228753 
1/*-
2 * Copyright (c) 2003-2007 Tim Kientzle
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 *
25 * $FreeBSD: src/usr.bin/tar/bsdtar.h,v 1.37 2008/12/06 07:37:14 kientzle Exp $
26 */
27
28#include "bsdtar_platform.h"
29#include <stdio.h>
30
31#include "matching.h"
32
33#define	DEFAULT_BYTES_PER_BLOCK	(20*512)
34
35/*
36 * The internal state for the "bsdtar" program.
37 *
38 * Keeping all of the state in a structure like this simplifies memory
39 * leak testing (at exit, anything left on the heap is suspect).  A
40 * pointer to this structure is passed to most bsdtar internal
41 * functions.
42 */
43struct bsdtar {
44	/* Options */
45	const char	 *filename; /* -f filename */
46	const char	 *create_format; /* -F format */
47	char		 *pending_chdir; /* -C dir */
48	const char	 *names_from_file; /* -T file */
49	time_t		  newer_ctime_sec; /* --newer/--newer-than */
50	long		  newer_ctime_nsec; /* --newer/--newer-than */
51	time_t		  newer_mtime_sec; /* --newer-mtime */
52	long		  newer_mtime_nsec; /* --newer-mtime-than */
53	int		  bytes_per_block; /* -b block_size */
54	int		  verbose;   /* -v */
55	int		  extract_flags; /* Flags for extract operation */
56	int		  strip_components; /* Remove this many leading dirs */
57	int		  gid;  /* --gid */
58	const char	 *gname; /* --gname */
59	int		  uid;  /* --uid */
60	const char	 *uname; /* --uname */
61	char		  mode; /* Program mode: 'c', 't', 'r', 'u', 'x' */
62	char		  symlink_mode; /* H or L, per BSD conventions */
63	char		  create_compression; /* j, y, or z */
64	const char	 *compress_program;
65	char		  option_absolute_paths; /* -P */
66	char		  option_chroot; /* --chroot */
67	char		  option_dont_traverse_mounts; /* --one-file-system */
68	char		  option_fast_read; /* --fast-read */
69	const char	 *option_options; /* --options */
70	char		  option_honor_nodump; /* --nodump */
71	char		  option_interactive; /* -w */
72	char		  option_no_owner; /* -o */
73	char		  option_no_subdirs; /* -n */
74	char		  option_null; /* --null */
75	char		  option_stdout; /* -O */
76	char		  option_totals; /* --totals */
77	char		  option_unlink_first; /* -U */
78	char		  option_warn_links; /* --check-links */
79	char		  day_first; /* show day before month in -tv output */
80
81	/* If >= 0, then close this when done. */
82	int		  fd;
83
84	/* Miscellaneous state information */
85	int		  argc;
86	char		**argv;
87	const char	 *optarg;
88	size_t		  gs_width; /* For 'list_item' in read.c */
89	size_t		  u_width; /* for 'list_item' in read.c */
90	uid_t		  user_uid; /* UID running this program */
91	int		  return_value; /* Value returned by main() */
92	char		  warned_lead_slash; /* Already displayed warning */
93	char		  next_line_is_dir; /* Used for -C parsing in -cT */
94
95	/*
96	 * Data for various subsystems.  Full definitions are located in
97	 * the file where they are used.
98	 */
99	struct archive		*diskreader;	/* for write.c */
100	struct archive_entry_linkresolver *resolver; /* for write.c */
101	struct archive_dir	*archive_dir;	/* for write.c */
102	struct name_cache	*gname_cache;	/* for write.c */
103	char			*buff;		/* for write.c */
104	struct lafe_matching	*matching;	/* for matching.c */
105	struct security		*security;	/* for read.c */
106	struct name_cache	*uname_cache;	/* for write.c */
107	struct siginfo_data	*siginfo;	/* for siginfo.c */
108	struct substitution	*substitution;	/* for subst.c */
109};
110
111/* Fake short equivalents for long options that otherwise lack them. */
112enum {
113	OPTION_CHECK_LINKS = 1,
114	OPTION_CHROOT,
115	OPTION_EXCLUDE,
116	OPTION_FORMAT,
117	OPTION_GID,
118	OPTION_GNAME,
119	OPTION_HELP,
120	OPTION_INCLUDE,
121	OPTION_KEEP_NEWER_FILES,
122	OPTION_LZMA,
123	OPTION_NEWER_CTIME,
124	OPTION_NEWER_CTIME_THAN,
125	OPTION_NEWER_MTIME,
126	OPTION_NEWER_MTIME_THAN,
127	OPTION_NODUMP,
128	OPTION_NO_SAME_OWNER,
129	OPTION_NO_SAME_PERMISSIONS,
130	OPTION_NULL,
131	OPTION_NUMERIC_OWNER,
132	OPTION_ONE_FILE_SYSTEM,
133	OPTION_OPTIONS,
134	OPTION_POSIX,
135	OPTION_SAME_OWNER,
136	OPTION_STRIP_COMPONENTS,
137	OPTION_TOTALS,
138	OPTION_UID,
139	OPTION_UNAME,
140	OPTION_USE_COMPRESS_PROGRAM,
141	OPTION_VERSION
142};
143
144
145int	bsdtar_getopt(struct bsdtar *);
146void	do_chdir(struct bsdtar *);
147int	edit_pathname(struct bsdtar *, struct archive_entry *);
148int	need_report(void);
149int	pathcmp(const char *a, const char *b);
150void	safe_fprintf(FILE *, const char *fmt, ...);
151void	set_chdir(struct bsdtar *, const char *newdir);
152const char *tar_i64toa(int64_t);
153void	tar_mode_c(struct bsdtar *bsdtar);
154void	tar_mode_r(struct bsdtar *bsdtar);
155void	tar_mode_t(struct bsdtar *bsdtar);
156void	tar_mode_u(struct bsdtar *bsdtar);
157void	tar_mode_x(struct bsdtar *bsdtar);
158void	usage(void);
159int	yes(const char *fmt, ...);
160
161#if HAVE_REGEX_H
162void	add_substitution(struct bsdtar *, const char *);
163int	apply_substitution(struct bsdtar *, const char *, char **, int);
164void	cleanup_substitution(struct bsdtar *);
165#endif
166