usr.bin/tar/bsdtar.h

   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$
  26  */
  27
  28 #include "bsdtar_platform.h"
  29 #include <stdio.h>
  30
  31 #define DEFAULT_BYTES_PER_BLOCK (20*512)
  32
  33 /*
  34  * The internal state for the "bsdtar" program.
  35  *
  36  * Keeping all of the state in a structure like this simplifies memory
  37  * leak testing (at exit, anything left on the heap is suspect).  A
  38  * pointer to this structure is passed to most bsdtar internal
  39  * functions.
  40  */
  41 struct bsdtar {
  42         /* Options */
  43         const char       *filename; /* -f filename */
  44         const char       *create_format; /* -F format */
  45         char             *pending_chdir; /* -C dir */
  46         const char       *names_from_file; /* -T file */
  47         time_t            newer_ctime_sec; /* --newer/--newer-than */
  48         long              newer_ctime_nsec; /* --newer/--newer-than */
  49         time_t            newer_mtime_sec; /* --newer-mtime */
  50         long              newer_mtime_nsec; /* --newer-mtime-than */
  51         int               bytes_per_block; /* -b block_size */
  52         int               verbose;   /* -v */
  53         int               extract_flags; /* Flags for extract operation */
  54         int               strip_components; /* Remove this many leading dirs */
  55         char              mode; /* Program mode: 'c', 't', 'r', 'u', 'x' */
  56         char              symlink_mode; /* H or L, per BSD conventions */
  57         char              create_compression; /* j, y, or z */
  58         const char       *compress_program;
  59         char              option_absolute_paths; /* -P */
  60         char              option_chroot; /* --chroot */
  61         char              option_dont_traverse_mounts; /* --one-file-system */
  62         char              option_fast_read; /* --fast-read */
  63         const char       *option_options; /* --options */
  64         char              option_honor_nodump; /* --nodump */
  65         char              option_interactive; /* -w */
  66         char              option_no_owner; /* -o */
  67         char              option_no_subdirs; /* -n */
  68         char              option_null; /* --null */
  69         char              option_numeric_owner; /* --numeric-owner */
  70         char              option_stdout; /* -O */
  71         char              option_totals; /* --totals */
  72         char              option_unlink_first; /* -U */
  73         char              option_warn_links; /* --check-links */
  74         char              day_first; /* show day before month in -tv output */
  75
  76         /* If >= 0, then close this when done. */
  77         int               fd;
  78
  79         /* Miscellaneous state information */
  80         struct archive   *archive;
  81         int               argc;
  82         char            **argv;
  83         const char       *optarg;
  84         size_t            gs_width; /* For 'list_item' in read.c */
  85         size_t            u_width; /* for 'list_item' in read.c */
  86         uid_t             user_uid; /* UID running this program */
  87         int               return_value; /* Value returned by main() */
  88         char              warned_lead_slash; /* Already displayed warning */
  89         char              next_line_is_dir; /* Used for -C parsing in -cT */
  90
  91         /*
  92          * Data for various subsystems.  Full definitions are located in
  93          * the file where they are used.
  94          */
  95         struct archive          *diskreader;    /* for write.c */
  96         struct archive_entry_linkresolver *resolver; /* for write.c */
  97         struct archive_dir      *archive_dir;   /* for write.c */
  98         struct name_cache       *gname_cache;   /* for write.c */
  99         char                    *buff;          /* for write.c */
 100         struct matching         *matching;      /* for matching.c */
 101         struct security         *security;      /* for read.c */
 102         struct name_cache       *uname_cache;   /* for write.c */
 103         struct siginfo_data     *siginfo;       /* for siginfo.c */
 104         struct substitution     *substitution;  /* for subst.c */
 105 };
 106
 107 /* Fake short equivalents for long options that otherwise lack them. */
 108 enum {
 109         OPTION_CHECK_LINKS = 1,
 110         OPTION_CHROOT,
 111         OPTION_EXCLUDE,
 112         OPTION_FORMAT,
 113         OPTION_OPTIONS,
 114         OPTION_HELP,
 115         OPTION_INCLUDE,
 116         OPTION_KEEP_NEWER_FILES,
 117         OPTION_LZMA,
 118         OPTION_NEWER_CTIME,
 119         OPTION_NEWER_CTIME_THAN,
 120         OPTION_NEWER_MTIME,
 121         OPTION_NEWER_MTIME_THAN,
 122         OPTION_NODUMP,
 123         OPTION_NO_SAME_OWNER,
 124         OPTION_NO_SAME_PERMISSIONS,
 125         OPTION_NULL,
 126         OPTION_NUMERIC_OWNER,
 127         OPTION_ONE_FILE_SYSTEM,
 128         OPTION_POSIX,
 129         OPTION_SAME_OWNER,
 130         OPTION_STRIP_COMPONENTS,
 131         OPTION_TOTALS,
 132         OPTION_USE_COMPRESS_PROGRAM,
 133         OPTION_VERSION
 134 };
 135
 136 int     bsdtar_getopt(struct bsdtar *);
 137 void    cleanup_exclusions(struct bsdtar *);
 138 void    do_chdir(struct bsdtar *);
 139 int     edit_pathname(struct bsdtar *, struct archive_entry *);
 140 int     exclude(struct bsdtar *, const char *pattern);
 141 int     exclude_from_file(struct bsdtar *, const char *pathname);
 142 int     excluded(struct bsdtar *, const char *pathname);
 143 int     include(struct bsdtar *, const char *pattern);
 144 int     include_from_file(struct bsdtar *, const char *pathname);
 145 int     need_report(void);
 146 int     pathcmp(const char *a, const char *b);
 147 int     process_lines(struct bsdtar *bsdtar, const char *pathname,
 148             int (*process)(struct bsdtar *, const char *));
 149 void    safe_fprintf(FILE *, const char *fmt, ...);
 150 void    set_chdir(struct bsdtar *, const char *newdir);
 151 const char *tar_i64toa(int64_t);
 152 void    tar_mode_c(struct bsdtar *bsdtar);
 153 void    tar_mode_r(struct bsdtar *bsdtar);
 154 void    tar_mode_t(struct bsdtar *bsdtar);
 155 void    tar_mode_u(struct bsdtar *bsdtar);
 156 void    tar_mode_x(struct bsdtar *bsdtar);
 157 int     unmatched_inclusions(struct bsdtar *bsdtar);
 158 int     unmatched_inclusions_warn(struct bsdtar *bsdtar, const char *msg);
 159 void    usage(void);
 160 int     yes(const char *fmt, ...);
 161
 162 #if HAVE_REGEX_H
 163 void    add_substitution(struct bsdtar *, const char *);
 164 int     apply_substitution(struct bsdtar *, const char *, char **, int);
 165 void    cleanup_substitution(struct bsdtar *);
 166 #endif