tarsnap/tar/bsdtar.h

/*-
 * Copyright 2006-2009 Colin Percival
 * All rights reserved.
 *
 * Portions of the file below are covered by the following license:
 *
 * 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 <stdint.h>
#include <stdio.h>

#include "elasticarray.h"
#include "passphrase_entry.h"

ELASTICARRAY_DECL(STRLIST, strlist, char *);

/*
 * The internal state for the "tarsnap" 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 */
	char		**tapenames; /* -f tapename */
	size_t		  ntapes;
	char		 *homedir;
	char		 *cachedir; /* --cachedir */
	dev_t		  cachedir_dev;
	ino_t		  cachedir_ino;
	int		  cachecrunch; /* --lowmem / --verylowmem */
	time_t		  snaptime; /* --snaptime */
	time_t		  creationtime; /* --creationtime */
	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		  verbose;   /* -v */
	int		  extract_flags; /* Flags for extract operation */
	int		  strip_components; /* Remove this many leading dirs */
	int		  mode; /* Program mode: 'c', 'd', 'r', 't', 'x' */
	const char	 *modestr; /* -[cdrtx] or --list, --fsck, etc. */
	char		  symlink_mode; /* H or L, per BSD conventions */
	char		  option_absolute_paths; /* -P */
	char		  option_chroot; /* --chroot */
	char		 *option_csv_filename; /* --csv-filename */
	char		  option_dont_traverse_mounts; /* --one-file-system */
	char		  option_dryrun; /* --dry-run / --dry-run-metadata */
	char		  option_fast_read; /* --fast-read */
	int               option_hashes;
	char		  option_honor_nodump; /* --nodump */
	char		  option_interactive; /* -w */
	char		  option_keep_going; /* --keep-going */
	char		  option_no_owner; /* -o */
	char		  option_no_subdirs; /* -n */
	char		  option_null; /* --null */
	char		  option_numeric_owner; /* --numeric-owner */
	char		  option_print_stats; /* --print-stats */
	uint64_t	  option_progress_bytes; /* --progress-bytes */
	char		  option_stdout; /* -O */
	char		  option_store_atime; /* --store-atime */
	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 */
	int		  have_keys; /* --keyfile */
	double		  bwlimit_rate_up;	/* --maxbw-rate(-up)? */
	double		  bwlimit_rate_down;	/* --maxbw-rate(-down)? */
	int		  disk_pause;		/* --disk-pause */
	int		  option_aggressive_networking_set;
	int		  option_archive_names_set;
	int		  option_cachecrunch_set;
	int		  option_disk_pause_set;
	int		  option_dump_config;
	int		  option_humanize_numbers_set;
	int		  option_maxbw_set;
	int		  option_maxbw_rate_down_set;
	int		  option_maxbw_rate_up_set;
	int		  option_nodump_set;
	int		  option_print_stats_set;
	int		  option_progress_bytes_set;
	int		  option_snaptime_set;
	int		  option_store_atime_set;
	int		  option_totals_set;
	int		  option_no_config_exclude;
	int		  option_no_config_include;
	int		  option_no_config_exclude_set;
	int		  option_no_config_include_set;
	int		  option_quiet;
	int		  option_quiet_set;
	int		  option_retry_forever_set;
	int		  option_resume_extract;
	int		  option_insane_filesystems;
	int		  option_insane_filesystems_set;
	int		  option_iso_dates;
	int		  option_iso_dates_set;
	int		  option_force_resources;
	int		  option_force_resources_set;
	const char	**configfiles;		/* --configfile */
	size_t		  nconfigfiles;
	int		  option_no_default_config; /* --no-default-config */
	char		 *keyfile;
	int		  keyfile_from_config;
	char		 *option_passphrase_arg;
	enum passphrase_entry option_passphrase_entry;

	/* Miscellaneous state information */
	struct archive	 *archive;
	const char	 *progname;
	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 */

	/* Config-file parsing strings. */
	char		 *conffile;
	char		 *conf_opt;
	char		 *conf_arg;
	FILE		 *conffile_actual;
	char		 *conffile_buffer;

	/* Temporary array for loading archive names. */
	STRLIST		 tapenames_setup;

	/* Used for --dryrun with tarsnap.conf.sample with a missing keyfile. */
	int		  config_file_keyfile_failed;

	/* Used for communicating with multitape code. */
	void		 *write_cookie;

	/* Used for communication with the storage layer. */
	int		  storage_modified;

	/* Chunkification cache. */
	void		 *chunk_cache;

	/* Original argc/argv, to be stored as archive metadata. */
	int		  argc_orig;
	char		**argv_orig;

	/* Machine number assigned by tarsnap server. */
	uint64_t	  machinenum;

	/*
	 * Data for various subsystems.  Full definitions are located in
	 * the file where they are used.
	 */
	struct delayedopt	*delopt;	/* for bsdtar.c */
	struct delayedopt	**delopt_tail;	/* for bsdtar.c */
	struct archive		*diskreader;	/* for write.c */
	struct archive_entry_linkresolver *resolver; /* for write.c */
	struct name_cache	*gname_cache;	/* for write.c */
	char			*buff;		/* for write.c */
	struct 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_AGGRESSIVE_NETWORKING=256,
	OPTION_ARCHIVE_NAMES,
	OPTION_CACHEDIR,
	OPTION_CHECK_LINKS,
	OPTION_CHECKPOINT_BYTES,
	OPTION_CHROOT,
	OPTION_CONFIGFILE,
	OPTION_CREATIONTIME,
	OPTION_CSV_FILE,
	OPTION_DEBUG_NETWORK_STATS,
	OPTION_DISK_PAUSE,
	OPTION_DRYRUN,
	OPTION_DRYRUN_METADATA,
	OPTION_DUMP_CONFIG,
	OPTION_EXCLUDE,
	OPTION_FORCE_RESOURCES,
	OPTION_FSCK,
	OPTION_FSCK_DELETE,	/* Operation mode, not a real option */
	OPTION_FSCK_PRUNE,
	OPTION_FSCK_WRITE,	/* Operation mode, not a real option */
	OPTION_HASHES,
	OPTION_HELP,
	OPTION_INCLUDE,
	OPTION_INITIALIZE_CACHEDIR,
	OPTION_INSANE_FILESYSTEMS,
	OPTION_ISO_DATES,
	OPTION_HUMANIZE_NUMBERS,
	OPTION_KEYFILE,
	OPTION_KEEP_GOING,
	OPTION_KEEP_NEWER_FILES,
	OPTION_LIST_ARCHIVES,
	OPTION_LOWMEM,
	OPTION_MAXBW,
	OPTION_MAXBW_RATE,
	OPTION_MAXBW_RATE_DOWN,
	OPTION_MAXBW_RATE_UP,
	OPTION_NEWER_CTIME,
	OPTION_NEWER_CTIME_THAN,
	OPTION_NEWER_MTIME,
	OPTION_NEWER_MTIME_THAN,
	OPTION_NODUMP,
	OPTION_NO_AGGRESSIVE_NETWORKING,
	OPTION_NO_CONFIG_EXCLUDE,
	OPTION_NO_CONFIG_INCLUDE,
	OPTION_NO_DEFAULT_CONFIG,
	OPTION_NO_DISK_PAUSE,
	OPTION_NO_FORCE_RESOURCES,
	OPTION_NO_HUMANIZE_NUMBERS,
	OPTION_NO_INSANE_FILESYSTEMS,
	OPTION_NO_ISO_DATES,
	OPTION_NO_MAXBW,
	OPTION_NO_MAXBW_RATE_DOWN,
	OPTION_NO_MAXBW_RATE_UP,
	OPTION_NO_NODUMP,
	OPTION_NO_PRINT_STATS,
	OPTION_NO_PROGRESS_BYTES,
	OPTION_NO_QUIET,
	OPTION_NO_RETRY_FOREVER,
	OPTION_NO_SAME_OWNER,
	OPTION_NO_SAME_PERMISSIONS,
	OPTION_NO_SNAPTIME,
	OPTION_NO_STORE_ATIME,
	OPTION_NO_TOTALS,
	OPTION_NOISY_WARNINGS,
	OPTION_NORMALMEM,
	OPTION_NUKE,
	OPTION_NULL,
	OPTION_NUMERIC_OWNER,
	OPTION_ONE_FILE_SYSTEM,
	OPTION_PASSPHRASE,
	OPTION_PRINT_STATS,
	OPTION_PROGRESS_BYTES,
	OPTION_RECOVER,
	OPTION_RECOVER_DELETE,	/* Operation mode, not a real option */
	OPTION_RECOVER_WRITE,	/* Operation mode, not a real option */
	OPTION_RESUME_EXTRACT,
	OPTION_RETRY_FOREVER,
	OPTION_QUIET,
	OPTION_SNAPTIME,
	OPTION_STORE_ATIME,
	OPTION_SAME_OWNER,
	OPTION_STRIP_COMPONENTS,
	OPTION_TOTALS,
	OPTION_VERIFY_CONFIG,
	OPTION_VERSION,
	OPTION_VERYLOWMEM
};


void	bsdtar_errc(struct bsdtar *, int _eval, int _code,
	    const char *fmt, ...) __LA_DEAD;
int	bsdtar_getopt(struct bsdtar *);
void	bsdtar_warnc(struct bsdtar *, int _code, const char *fmt, ...);
void	cleanup_exclusions(struct bsdtar *);
void	do_chdir(struct bsdtar *);
int	edit_pathname(struct bsdtar *, struct archive_entry *);
int	exclude(struct bsdtar *, const char *pattern);
int	exclude_from_file(struct bsdtar *, const char *pathname);
int	excluded(struct bsdtar *, const char *pathname);
int	include(struct bsdtar *, const char *pattern);
int	include_from_file(struct bsdtar *, const char *pathname);
int	pathcmp(const char *a, const char *b);
int	process_lines(struct bsdtar *bsdtar, const char *pathname,
	    int (*process)(struct bsdtar *, const char *), int null);
void	safe_fprintf(FILE *, const char *fmt, ...);
void	set_chdir(struct bsdtar *, const char *newdir);
void	siginfo_init(struct bsdtar *);
void	siginfo_setinfo(struct bsdtar *, const char * oper,
	    const char * path, int64_t size, int file_count,
	    int64_t archive_uncompressed);
void	siginfo_printinfo(struct bsdtar *, off_t progress, int finalmsg);
void	siginfo_done(struct bsdtar *);
void	tarsnap_mode_print_stats(struct bsdtar *bsdtar);
void	tarsnap_mode_c(struct bsdtar *bsdtar);
void	tarsnap_mode_d(struct bsdtar *bsdtar);
void	tarsnap_mode_r(struct bsdtar *bsdtar);
void	tarsnap_mode_t(struct bsdtar *bsdtar);
void	tarsnap_mode_x(struct bsdtar *bsdtar);
void	tarsnap_mode_fsck(struct bsdtar *bsdtar, int prune, int whichkey);
void	tarsnap_mode_initialize_cachedir(struct bsdtar *bsdtar);
void	tarsnap_mode_list_archives(struct bsdtar *bsdtar, int print_hashes);
void	tarsnap_mode_nuke(struct bsdtar *bsdtar);
void	tarsnap_mode_recover(struct bsdtar *bsdtar, int whichkey);
int	unmatched_inclusions(struct bsdtar *bsdtar);
int	unmatched_inclusions_warn(struct bsdtar *bsdtar, const char *msg);
void	usage(struct bsdtar *);
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

void	list_item_verbose(struct bsdtar *, FILE *,
		    struct archive_entry *);