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 */ 43 struct 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 char mode; /* Program mode: 'c', 't', 'r', 'u', 'x' */ 58 char symlink_mode; /* H or L, per BSD conventions */ 59 char create_compression; /* j, y, or z */ 60 const char *compress_program; 61 char option_absolute_paths; /* -P */ 62 char option_chroot; /* --chroot */ 63 char option_dont_traverse_mounts; /* --one-file-system */ 64 char option_fast_read; /* --fast-read */ 65 const char *option_options; /* --options */ 66 char option_honor_nodump; /* --nodump */ 67 char option_interactive; /* -w */ 68 char option_no_owner; /* -o */ 69 char option_no_subdirs; /* -n */ 70 char option_null; /* --null */ 71 char option_numeric_owner; /* --numeric-owner */ 72 char option_stdout; /* -O */ 73 char option_totals; /* --totals */ 74 char option_unlink_first; /* -U */ 75 char option_warn_links; /* --check-links */ 76 char day_first; /* show day before month in -tv output */ 77 78 /* If >= 0, then close this when done. */ 79 int fd; 80 81 /* Miscellaneous state information */ 82 int argc; 83 char **argv; 84 const char *optarg; 85 size_t gs_width; /* For 'list_item' in read.c */ 86 size_t u_width; /* for 'list_item' in read.c */ 87 uid_t user_uid; /* UID running this program */ 88 int return_value; /* Value returned by main() */ 89 char warned_lead_slash; /* Already displayed warning */ 90 char next_line_is_dir; /* Used for -C parsing in -cT */ 91 92 /* 93 * Data for various subsystems. Full definitions are located in 94 * the file where they are used. 95 */ 96 struct archive *diskreader; /* for write.c */ 97 struct archive_entry_linkresolver *resolver; /* for write.c */ 98 struct archive_dir *archive_dir; /* for write.c */ 99 struct name_cache *gname_cache; /* for write.c */ 100 char *buff; /* for write.c */ 101 struct lafe_matching *matching; /* for matching.c */ 102 struct security *security; /* for read.c */ 103 struct name_cache *uname_cache; /* for write.c */ 104 struct siginfo_data *siginfo; /* for siginfo.c */ 105 struct substitution *substitution; /* for subst.c */ 106 }; 107 108 /* Fake short equivalents for long options that otherwise lack them. */ 109 enum { 110 OPTION_CHECK_LINKS = 1, 111 OPTION_CHROOT, 112 OPTION_EXCLUDE, 113 OPTION_FORMAT, 114 OPTION_OPTIONS, 115 OPTION_HELP, 116 OPTION_INCLUDE, 117 OPTION_KEEP_NEWER_FILES, 118 OPTION_LZMA, 119 OPTION_NEWER_CTIME, 120 OPTION_NEWER_CTIME_THAN, 121 OPTION_NEWER_MTIME, 122 OPTION_NEWER_MTIME_THAN, 123 OPTION_NODUMP, 124 OPTION_NO_SAME_OWNER, 125 OPTION_NO_SAME_PERMISSIONS, 126 OPTION_NULL, 127 OPTION_NUMERIC_OWNER, 128 OPTION_ONE_FILE_SYSTEM, 129 OPTION_POSIX, 130 OPTION_SAME_OWNER, 131 OPTION_STRIP_COMPONENTS, 132 OPTION_TOTALS, 133 OPTION_USE_COMPRESS_PROGRAM, 134 OPTION_VERSION 135 }; 136 137 138 int bsdtar_getopt(struct bsdtar *); 139 void do_chdir(struct bsdtar *); 140 int edit_pathname(struct bsdtar *, struct archive_entry *); 141 int need_report(void); 142 int pathcmp(const char *a, const char *b); 143 void safe_fprintf(FILE *, const char *fmt, ...); 144 void set_chdir(struct bsdtar *, const char *newdir); 145 const char *tar_i64toa(int64_t); 146 void tar_mode_c(struct bsdtar *bsdtar); 147 void tar_mode_r(struct bsdtar *bsdtar); 148 void tar_mode_t(struct bsdtar *bsdtar); 149 void tar_mode_u(struct bsdtar *bsdtar); 150 void tar_mode_x(struct bsdtar *bsdtar); 151 void usage(void); 152 int yes(const char *fmt, ...); 153 154 #if HAVE_REGEX_H 155 void add_substitution(struct bsdtar *, const char *); 156 int apply_substitution(struct bsdtar *, const char *, char **, int); 157 void cleanup_substitution(struct bsdtar *); 158 #endif 159