summaryrefslogtreecommitdiffstats
path: root/Utilities/cmlibarchive/tar/bsdtar.h
blob: 9dfe843d6c83f67fa650e869ca09fb750f18fa15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*-
 * Copyright (c) 2003-2007 Tim Kientzle
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: src/usr.bin/tar/bsdtar.h,v 1.37 2008/12/06 07:37:14 kientzle Exp $
 */

#include "bsdtar_platform.h"
#include <stdio.h>

#include "matching.h"

#define DEFAULT_BYTES_PER_BLOCK (20*512)

/*
 * The internal state for the "bsdtar" program.
 *
 * Keeping all of the state in a structure like this simplifies memory
 * leak testing (at exit, anything left on the heap is suspect).  A
 * pointer to this structure is passed to most bsdtar internal
 * functions.
 */
struct bsdtar {
    /* Options */
    const char   *filename; /* -f filename */
    const char   *create_format; /* -F format */
    char         *pending_chdir; /* -C dir */
    const char   *names_from_file; /* -T file */
    time_t        newer_ctime_sec; /* --newer/--newer-than */
    long          newer_ctime_nsec; /* --newer/--newer-than */
    time_t        newer_mtime_sec; /* --newer-mtime */
    long          newer_mtime_nsec; /* --newer-mtime-than */
    int       bytes_per_block; /* -b block_size */
    int       verbose;   /* -v */
    int       extract_flags; /* Flags for extract operation */
    int       strip_components; /* Remove this many leading dirs */
    char          mode; /* Program mode: 'c', 't', 'r', 'u', 'x' */
    char          symlink_mode; /* H or L, per BSD conventions */
    char          create_compression; /* j, y, or z */
    const char   *compress_program;
    char          option_absolute_paths; /* -P */
    char          option_chroot; /* --chroot */
    char          option_dont_traverse_mounts; /* --one-file-system */
    char          option_fast_read; /* --fast-read */
    const char   *option_options; /* --options */
    char          option_honor_nodump; /* --nodump */
    char          option_interactive; /* -w */
    char          option_no_owner; /* -o */
    char          option_no_subdirs; /* -n */
    char          option_null; /* --null */
    char          option_numeric_owner; /* --numeric-owner */
    char          option_stdout; /* -O */
    char          option_totals; /* --totals */
    char          option_unlink_first; /* -U */
    char          option_warn_links; /* --check-links */
    char          day_first; /* show day before month in -tv output */

    /* If >= 0, then close this when done. */
    int       fd;

    /* Miscellaneous state information */
    int       argc;
    char        **argv;
    const char   *optarg;
    size_t        gs_width; /* For 'list_item' in read.c */
    size_t        u_width; /* for 'list_item' in read.c */
    uid_t         user_uid; /* UID running this program */
    int       return_value; /* Value returned by main() */
    char          warned_lead_slash; /* Already displayed warning */
    char          next_line_is_dir; /* Used for -C parsing in -cT */

    /*
     * Data for various subsystems.  Full definitions are located in
     * the file where they are used.
     */
    struct archive      *diskreader;    /* for write.c */
    struct archive_entry_linkresolver *resolver; /* for write.c */
    struct archive_dir  *archive_dir;   /* for write.c */
    struct name_cache   *gname_cache;   /* for write.c */
    char            *buff;      /* for write.c */
    struct lafe_matching    *matching;  /* for matching.c */
    struct security     *security;  /* for read.c */
    struct name_cache   *uname_cache;   /* for write.c */
    struct siginfo_data *siginfo;   /* for siginfo.c */
    struct substitution *substitution;  /* for subst.c */
};

/* Fake short equivalents for long options that otherwise lack them. */
enum {
    OPTION_CHECK_LINKS = 1,
    OPTION_CHROOT,
    OPTION_EXCLUDE,
    OPTION_FORMAT,
    OPTION_OPTIONS,
    OPTION_HELP,
    OPTION_INCLUDE,
    OPTION_KEEP_NEWER_FILES,
    OPTION_LZMA,
    OPTION_NEWER_CTIME,
    OPTION_NEWER_CTIME_THAN,
    OPTION_NEWER_MTIME,
    OPTION_NEWER_MTIME_THAN,
    OPTION_NODUMP,
    OPTION_NO_SAME_OWNER,
    OPTION_NO_SAME_PERMISSIONS,
    OPTION_NULL,
    OPTION_NUMERIC_OWNER,
    OPTION_ONE_FILE_SYSTEM,
    OPTION_POSIX,
    OPTION_SAME_OWNER,
    OPTION_STRIP_COMPONENTS,
    OPTION_TOTALS,
    OPTION_USE_COMPRESS_PROGRAM,
    OPTION_VERSION
};


int bsdtar_getopt(struct bsdtar *);
void    do_chdir(struct bsdtar *);
int edit_pathname(struct bsdtar *, struct archive_entry *);
int need_report(void);
int pathcmp(const char *a, const char *b);
void    safe_fprintf(FILE *, const char *fmt, ...);
void    set_chdir(struct bsdtar *, const char *newdir);
void    tar_mode_c(struct bsdtar *bsdtar);
void    tar_mode_r(struct bsdtar *bsdtar);
void    tar_mode_t(struct bsdtar *bsdtar);
void    tar_mode_u(struct bsdtar *bsdtar);
void    tar_mode_x(struct bsdtar *bsdtar);
void    usage(void);
int yes(const char *fmt, ...);

#if HAVE_REGEX_H
void    add_substitution(struct bsdtar *, const char *);
int apply_substitution(struct bsdtar *, const char *, char **, int);
void    cleanup_substitution(struct bsdtar *);
#endif