X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/57df171bc00cd813b5d661960b567a041107af13..e0ed4e4087ebeff0b0fe8f3419bcccf84fbd89a9:/options.c diff --git a/options.c b/options.c index 623385ae..85880caf 100644 --- a/options.c +++ b/options.c @@ -1,28 +1,41 @@ -/* - Copyright (C) Andrew Tridgell 1998 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -*/ - -/* options parsing code */ +/* -*- c-file-style: "linux" -*- + * + * Copyright (C) 1998-2001 by Andrew Tridgell + * Copyright (C) 2000, 2001, 2002 by Martin Pool + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ #include "rsync.h" +#include "popt.h" +extern struct exclude_struct **exclude_list; int make_backups = 0; -int whole_file = 0; + +/** + * If 1, send the whole file as literal data rather than trying to + * create an incremental diff. + * + * If -1, then look at whether we're local or remote and go by that. + * + * @sa disable_deltas_p() + **/ +int whole_file = -1; + +int archive_mode = 0; int copy_links = 0; int preserve_links = 0; int preserve_hard_links = 0; @@ -39,12 +52,13 @@ int ignore_times=0; int delete_mode=0; int delete_excluded=0; int one_file_system=0; -int remote_version=0; +int protocol_version = PROTOCOL_VERSION; int sparse_files=0; int do_compression=0; int am_root=0; int orig_umask=0; -int relative_paths=0; +int relative_paths = -1; +int implied_dirs = 1; int numeric_ids = 0; int force_delete = 0; int io_timeout = 0; @@ -52,41 +66,139 @@ int io_error = 0; int read_only = 0; int module_id = -1; int am_server = 0; -int am_sender=0; +int am_sender = 0; +char *files_from = NULL; +int filesfrom_fd = -1; +char *remote_filesfrom_file = NULL; +int eol_nulls = 0; int recurse = 0; -int am_daemon=0; +int am_daemon = 0; +int daemon_over_rsh = 0; int do_stats=0; int do_progress=0; int keep_partial=0; int safe_symlinks=0; int copy_unsafe_links=0; -int block_size=BLOCK_SIZE; +int block_size=0; int size_only=0; +int bwlimit=0; int delete_after=0; +int only_existing=0; +int opt_ignore_existing=0; +int max_delete=0; +int ignore_errors=0; +int modify_window=0; +int blocking_io=-1; + + +/** Network address family. **/ +#ifdef INET6 +int default_af_hint = 0; /* Any protocol */ +#else +int default_af_hint = AF_INET; /* Must use IPv4 */ +#endif + +/** Do not go into the background when run as --daemon. Good + * for debugging and required for running as a service on W32, + * or under Unix process-monitors. **/ +int no_detach = 0; -char *backup_suffix = BACKUP_SUFFIX; +int write_batch = 0; +int read_batch = 0; +int backup_dir_len = 0; +int backup_suffix_len; + +char *backup_suffix = NULL; char *tmpdir = NULL; char *compare_dest = NULL; -char *config_file = RSYNCD_CONF; +char *config_file = NULL; char *shell_cmd = NULL; char *log_format = NULL; char *password_file = NULL; -char *rsync_path = RSYNC_NAME; +char *rsync_path = RSYNC_PATH; +char *backup_dir = NULL; int rsync_port = RSYNC_PORT; +int link_dest = 0; int verbose = 0; int quiet = 0; int always_checksum = 0; int list_only = 0; -struct in_addr socket_address = {INADDR_ANY}; +char *batch_prefix = NULL; + +static int modify_window_set; + +/** Local address to bind. As a character string because it's + * interpreted by the IPv6 layer: should be a numeric IP4 or ip6 + * address, or a hostname. **/ +char *bind_address; -void usage(int F) + +static void print_rsync_version(enum logcode f) { - rprintf(F,"rsync version %s Copyright Andrew Tridgell and Paul Mackerras\n\n", - VERSION); + char const *got_socketpair = "no "; + char const *hardlinks = "no "; + char const *links = "no "; + char const *ipv6 = "no "; + STRUCT_STAT *dumstat; + +#ifdef HAVE_SOCKETPAIR + got_socketpair = ""; +#endif - rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n"); +#if SUPPORT_HARD_LINKS + hardlinks = ""; +#endif + +#if SUPPORT_LINKS + links = ""; +#endif + +#if INET6 + ipv6 = ""; +#endif + + rprintf(f, "%s version %s protocol version %d\n", + RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION); + rprintf(f, + "Copyright (C) 1996-2002 by Andrew Tridgell and others\n"); + rprintf(f, "\n"); + rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, " + "%shard links, %ssymlinks, batchfiles, \n", + (int) (sizeof(OFF_T) * 8), + got_socketpair, hardlinks, links); + + /* Note that this field may not have type ino_t. It depends + * on the complicated interaction between largefile feature + * macros. */ + rprintf(f, " %sIPv6, %d-bit system inums, %d-bit internal inums\n", + ipv6, + (int) (sizeof(dumstat->st_ino) * 8), + (int) (sizeof(INO64_T) * 8)); +#ifdef MAINTAINER_MODE + rprintf(f, " panic action: \"%s\"\n", + get_panic_action()); +#endif + +#ifdef NO_INT64 + rprintf(f, "WARNING: no 64-bit integers on this platform!\n"); +#endif + + rprintf(f, +"\n" +"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n" +"are welcome to redistribute it under certain conditions. See the GNU\n" +"General Public Licence for details.\n" + ); +} + + +void usage(enum logcode F) +{ + print_rsync_version(F); + + rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n"); rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n"); rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n"); @@ -94,6 +206,7 @@ void usage(int F) rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n"); rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n"); rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n"); + rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n"); rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n"); rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n"); rprintf(F," sources separated by space as long as they have same top-level\n"); @@ -101,14 +214,17 @@ void usage(int F) rprintf(F," -v, --verbose increase verbosity\n"); rprintf(F," -q, --quiet decrease verbosity\n"); rprintf(F," -c, --checksum always checksum\n"); - rprintf(F," -a, --archive archive mode\n"); + rprintf(F," -a, --archive archive mode, equivalent to -rlptgoD\n"); rprintf(F," -r, --recursive recurse into directories\n"); rprintf(F," -R, --relative use relative path names\n"); + rprintf(F," --no-relative turn off --relative\n"); + rprintf(F," --no-implied-dirs don't send implied dirs with -R\n"); rprintf(F," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX); - rprintf(F," --suffix=SUFFIX override backup suffix\n"); + rprintf(F," --backup-dir make backups into this directory\n"); + rprintf(F," --suffix=SUFFIX override backup suffix\n"); rprintf(F," -u, --update update only (don't overwrite newer files)\n"); - rprintf(F," -l, --links preserve soft links\n"); - rprintf(F," -L, --copy-links treat soft links like regular files\n"); + rprintf(F," -l, --links copy symlinks as symlinks\n"); + rprintf(F," -L, --copy-links copy the referent of symlinks\n"); rprintf(F," --copy-unsafe-links copy links outside the source tree\n"); rprintf(F," --safe-links ignore links outside the destination tree\n"); rprintf(F," -H, --hard-links preserve hard links\n"); @@ -116,152 +232,203 @@ void usage(int F) rprintf(F," -o, --owner preserve owner (root only)\n"); rprintf(F," -g, --group preserve group\n"); rprintf(F," -D, --devices preserve devices (root only)\n"); - rprintf(F," -t, --times preserve times\n"); + rprintf(F," -t, --times preserve times\n"); rprintf(F," -S, --sparse handle sparse files efficiently\n"); rprintf(F," -n, --dry-run show what would have been transferred\n"); rprintf(F," -W, --whole-file copy whole files, no incremental checks\n"); + rprintf(F," --no-whole-file turn off --whole-file\n"); rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n"); - rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE); - rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n"); + rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE); + rprintf(F," -e, --rsh=COMMAND specify the remote shell\n"); rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n"); - rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n"); + rprintf(F," --existing only update files that already exist\n"); + rprintf(F," --ignore-existing ignore files that already exist on the receiving side\n"); rprintf(F," --delete delete files that don't exist on the sending side\n"); rprintf(F," --delete-excluded also delete excluded files on the receiving side\n"); rprintf(F," --delete-after delete after transferring, not before\n"); + rprintf(F," --ignore-errors delete even if there are IO errors\n"); + rprintf(F," --max-delete=NUM don't delete more than NUM files\n"); rprintf(F," --partial keep partially transferred files\n"); rprintf(F," --force force deletion of directories even if not empty\n"); rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n"); rprintf(F," --timeout=TIME set IO timeout in seconds\n"); rprintf(F," -I, --ignore-times don't exclude files that match length and time\n"); rprintf(F," --size-only only use file size when determining if a file should be transferred\n"); + rprintf(F," --modify-window=NUM Timestamp window (seconds) for file match (default=%d)\n",modify_window); rprintf(F," -T --temp-dir=DIR create temporary files in directory DIR\n"); rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n"); + rprintf(F," --link-dest=DIR create hardlinks to DIR for unchanged files\n"); rprintf(F," -P equivalent to --partial --progress\n"); rprintf(F," -z, --compress compress file data\n"); + rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n"); rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n"); rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n"); rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n"); rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n"); - rprintf(F," --version print version number\n"); - rprintf(F," --daemon run as a rsync daemon\n"); - rprintf(F," --address bind to the specified address\n"); - rprintf(F," --config=FILE specify alternate rsyncd.conf file\n"); + rprintf(F," --files-from=FILE read FILE for list of source-file names\n"); + rprintf(F," -0 --from0 file names we read are separated by nulls, not newlines\n"); + rprintf(F," --version print version number\n"); + rprintf(F," --daemon run as a rsync daemon\n"); + rprintf(F," --no-detach do not detach from the parent\n"); + rprintf(F," --address=ADDRESS bind to the specified address\n"); + rprintf(F," --config=FILE specify alternate rsyncd.conf file\n"); rprintf(F," --port=PORT specify alternate rsyncd port number\n"); - rprintf(F," --stats give some file transfer stats\n"); - rprintf(F," --progress show progress during transfer\n"); - rprintf(F," --log-format=FORMAT log file transfers using specified format\n"); + rprintf(F," --blocking-io use blocking IO for the remote shell\n"); + rprintf(F," --no-blocking-io turn off --blocking-io\n"); + rprintf(F," --stats give some file transfer stats\n"); + rprintf(F," --progress show progress during transfer\n"); + rprintf(F," --log-format=FORMAT log file transfers using specified format\n"); rprintf(F," --password-file=FILE get password from FILE\n"); + rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n"); + rprintf(F," --write-batch=PREFIX write batch fileset starting with PREFIX\n"); + rprintf(F," --read-batch=PREFIX read batch fileset starting with PREFIX\n"); rprintf(F," -h, --help show this help screen\n"); +#ifdef INET6 + rprintf(F," -4 prefer IPv4\n"); + rprintf(F," -6 prefer IPv6\n"); +#endif rprintf(F,"\n"); rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n"); - rprintf(F,"See http://rsync.samba.org/ for updates and bug reports\n"); + rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n"); } -enum {OPT_VERSION, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE, - OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS, - OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT, - OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS, - OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST, - OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS, - OPT_DELETE_AFTER}; - -static char *short_options = "oblLWHpguDCtcahvqrRIxnSe:B:T:zP"; - -static struct option long_options[] = { - {"version", 0, 0, OPT_VERSION}, - {"server", 0, 0, OPT_SERVER}, - {"sender", 0, 0, OPT_SENDER}, - {"delete", 0, 0, OPT_DELETE}, - {"delete-excluded", 0, 0, OPT_DELETE_EXCLUDED}, - {"force", 0, 0, OPT_FORCE}, - {"numeric-ids", 0, 0, OPT_NUMERIC_IDS}, - {"exclude", 1, 0, OPT_EXCLUDE}, - {"exclude-from",1, 0, OPT_EXCLUDE_FROM}, - {"include", 1, 0, OPT_INCLUDE}, - {"include-from",1, 0, OPT_INCLUDE_FROM}, - {"rsync-path", 1, 0, OPT_RSYNC_PATH}, - {"password-file", 1, 0, OPT_PASSWORD_FILE}, - {"one-file-system",0, 0, 'x'}, - {"ignore-times",0, 0, 'I'}, - {"size-only", 0, 0, OPT_SIZE_ONLY}, - {"help", 0, 0, 'h'}, - {"dry-run", 0, 0, 'n'}, - {"sparse", 0, 0, 'S'}, - {"cvs-exclude", 0, 0, 'C'}, - {"archive", 0, 0, 'a'}, - {"checksum", 0, 0, 'c'}, - {"backup", 0, 0, 'b'}, - {"update", 0, 0, 'u'}, - {"verbose", 0, 0, 'v'}, - {"quiet", 0, 0, 'q'}, - {"recursive", 0, 0, 'r'}, - {"relative", 0, 0, 'R'}, - {"devices", 0, 0, 'D'}, - {"perms", 0, 0, 'p'}, - {"links", 0, 0, 'l'}, - {"copy-links", 0, 0, 'L'}, - {"copy-unsafe-links", 0, 0, OPT_COPY_UNSAFE_LINKS}, - {"safe-links", 0, 0, OPT_SAFE_LINKS}, - {"whole-file", 0, 0, 'W'}, - {"hard-links", 0, 0, 'H'}, - {"owner", 0, 0, 'o'}, - {"group", 0, 0, 'g'}, - {"times", 0, 0, 't'}, - {"rsh", 1, 0, 'e'}, - {"suffix", 1, 0, OPT_SUFFIX}, - {"block-size", 1, 0, 'B'}, - {"timeout", 1, 0, OPT_TIMEOUT}, - {"temp-dir", 1, 0, 'T'}, - {"compare-dest", 1, 0, OPT_COMPARE_DEST}, - {"compress", 0, 0, 'z'}, - {"daemon", 0, 0, OPT_DAEMON}, - {"stats", 0, 0, OPT_STATS}, - {"progress", 0, 0, OPT_PROGRESS}, - {"partial", 0, 0, OPT_PARTIAL}, - {"delete-after",0, 0, OPT_DELETE_AFTER}, - {"config", 1, 0, OPT_CONFIG}, - {"port", 1, 0, OPT_PORT}, - {"log-format", 1, 0, OPT_LOG_FORMAT}, - {"address", 1, 0, OPT_ADDRESS}, - {0,0,0,0}}; +enum {OPT_VERSION = 1000, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM, + OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED, OPT_LINK_DEST, + OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, + OPT_READ_BATCH, OPT_WRITE_BATCH}; + +static struct poptOption long_options[] = { + /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ + {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0}, + {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 }, + {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 }, + {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 }, + {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 }, + {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 }, + {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 }, + {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 }, + {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 }, + {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 }, + {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 }, + {"delete-after", 0, POPT_ARG_NONE, 0, OPT_DELETE_AFTER, 0, 0 }, + {"delete-excluded", 0, POPT_ARG_NONE, 0, OPT_DELETE_EXCLUDED, 0, 0 }, + {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 }, + {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 }, + {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 }, + {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 }, + {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 }, + {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 }, + {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 }, + {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 }, + {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 }, + {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 }, + {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 }, + {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 }, + {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 }, + {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 }, + {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 }, + {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 }, + {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 }, + {"copy-unsafe-links", 0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 }, + {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 }, + {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 }, + {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 }, + {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 }, + {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 }, + {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 }, + {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 }, + {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 }, + {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 }, + {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 }, + {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 }, + {"recursive", 'r', POPT_ARG_NONE, &recurse, 0, 0, 0 }, + {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 }, + {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 }, + {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 }, + {"block-size", 'B', POPT_ARG_INT, &block_size, 0, 0, 0 }, + {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 }, + {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 }, + {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 }, + {"compare-dest", 0, POPT_ARG_STRING, &compare_dest, 0, 0, 0 }, + {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 }, + /* TODO: Should this take an optional int giving the compression level? */ + {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 }, + {"daemon", 0, POPT_ARG_NONE, &am_daemon, 0, 0, 0 }, + {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 }, + {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 }, + {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 }, + {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 }, + {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 }, + {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 }, + {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 }, + {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 }, + {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 }, + {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 }, + {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 }, + {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 }, + {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 }, + {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 }, + {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 }, + {"read-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_READ_BATCH, 0, 0 }, + {"write-batch", 0, POPT_ARG_STRING, &batch_prefix, OPT_WRITE_BATCH, 0, 0 }, + {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 }, + {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0}, + {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 }, + {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 }, +#ifdef INET6 + {0, '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 }, + {0, '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 }, +#endif + {0,0,0,0, 0, 0, 0} +}; static char err_buf[100]; + +/** + * Store the option error message, if any, so that we can log the + * connection attempt (which requires parsing the options), and then + * show the error later on. + **/ void option_error(void) { if (err_buf[0]) { - rprintf(FLOG,"%s", err_buf); - rprintf(FERROR,"%s", err_buf); + rprintf(FLOG, "%s", err_buf); + rprintf(FERROR, RSYNC_NAME ": %s", err_buf); } else { - rprintf(FLOG,"Error parsing options - unsupported option?\n"); - rprintf(FERROR,"Error parsing options - unsupported option?\n"); + rprintf (FERROR, "Error parsing options: " + "option may be supported on client but not on server?\n"); + rprintf (FERROR, RSYNC_NAME ": Error parsing options: " + "option may be supported on client but not on server?\n"); } - exit_cleanup(RERR_UNSUPPORTED); } -/* check to see if we should refuse this option */ + +/** + * Check to see if we should refuse this option + **/ static int check_refuse_options(char *ref, int opt) { int i, len; char *p; const char *name; - for (i=0; long_options[i].name; i++) { + for (i=0; long_options[i].longName; i++) { if (long_options[i].val == opt) break; } - - if (!long_options[i].name) return 0; - name = long_options[i].name; + if (!long_options[i].longName) return 0; + + name = long_options[i].longName; len = strlen(name); while ((p = strstr(ref,name))) { if ((p==ref || p[-1]==' ') && (p[len] == ' ' || p[len] == 0)) { - slprintf(err_buf,sizeof(err_buf), + snprintf(err_buf,sizeof(err_buf), "The '%s' option is not supported by this server\n", name); return 1; } @@ -271,57 +438,60 @@ static int check_refuse_options(char *ref, int opt) } -int parse_arguments(int argc, char *argv[], int frommain) +static int count_args(char const **argv) +{ + int i = 0; + + while (argv[i] != NULL) + i++; + + return i; +} + + +/** + * Process command line arguments. Called on both local and remote. + * + * @retval 1 if all options are OK; with globals set to appropriate + * values + * + * @retval 0 on error, with err_buf containing an explanation + **/ +int parse_arguments(int *argc, const char ***argv, int frommain) { int opt; - int option_index; char *ref = lp_refuse_options(module_id); + poptContext pc; + + /* TODO: Call poptReadDefaultConfig; handle errors. */ - while ((opt = getopt_long(argc, argv, - short_options, long_options, &option_index)) - != -1) { + /* The context leaks in case of an error, but if there's a + * problem we always exit anyhow. */ + pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0); + while ((opt = poptGetNextOpt(pc)) != -1) { if (ref) { if (check_refuse_options(ref, opt)) return 0; } + /* most options are handled automatically by popt; + * only special cases are returned and listed here. */ + switch (opt) { case OPT_VERSION: - rprintf(FINFO,"rsync version %s protocol version %d\n\n", - VERSION,PROTOCOL_VERSION); - rprintf(FINFO,"Written by Andrew Tridgell and Paul Mackerras\n"); + print_rsync_version(FINFO); exit_cleanup(0); - - case OPT_SUFFIX: - backup_suffix = optarg; - break; - - case OPT_RSYNC_PATH: - rsync_path = optarg; - break; - - case OPT_PASSWORD_FILE: - password_file =optarg; - break; - case 'I': - ignore_times = 1; - break; - - case OPT_SIZE_ONLY: - size_only = 1; - break; - - case 'x': - one_file_system=1; - break; - - case OPT_DELETE: - delete_mode = 1; + case OPT_MODIFY_WINDOW: + /* The value has already been set by popt, but + * we need to remember that we're using a + * non-default setting. */ + modify_window_set = 1; break; case OPT_DELETE_AFTER: delete_after = 1; + delete_mode = 1; break; case OPT_DELETE_EXCLUDED: @@ -329,106 +499,46 @@ int parse_arguments(int argc, char *argv[], int frommain) delete_mode = 1; break; - case OPT_FORCE: - force_delete = 1; - break; - - case OPT_NUMERIC_IDS: - numeric_ids = 1; - break; - case OPT_EXCLUDE: - add_exclude(optarg, 0); + add_exclude(&exclude_list, poptGetOptArg(pc), + ADD_EXCLUDE); break; case OPT_INCLUDE: - add_exclude(optarg, 1); + add_exclude(&exclude_list, poptGetOptArg(pc), + ADD_INCLUDE); break; case OPT_EXCLUDE_FROM: - add_exclude_file(optarg,1, 0); + add_exclude_file(&exclude_list, poptGetOptArg(pc), + MISSING_FATAL, ADD_EXCLUDE); break; case OPT_INCLUDE_FROM: - add_exclude_file(optarg,1, 1); - break; - - case OPT_COPY_UNSAFE_LINKS: - copy_unsafe_links=1; - break; - - case OPT_SAFE_LINKS: - safe_symlinks=1; + add_exclude_file(&exclude_list, poptGetOptArg(pc), + MISSING_FATAL, ADD_INCLUDE); break; case 'h': usage(FINFO); exit_cleanup(0); - case 'b': - make_backups=1; - break; - - case 'n': - dry_run=1; - break; - - case 'S': - sparse_files=1; - break; - - case 'C': - cvs_exclude=1; - break; - - case 'u': - update_only=1; - break; - - case 'l': - preserve_links=1; - break; - - case 'L': - copy_links=1; - break; - - case 'W': - whole_file=1; - break; - case 'H': #if SUPPORT_HARD_LINKS preserve_hard_links=1; -#else - slprintf(err_buf,sizeof(err_buf),"hard links are not supported on this server\n"); - rprintf(FERROR,"ERROR: hard links not supported on this platform\n"); +#else + /* FIXME: Don't say "server" if this is + * happening on the client. */ + /* FIXME: Why do we have the duplicated + * rprintf? Everybody who gets this message + * ought to send it to the client and also to + * the logs. */ + snprintf(err_buf, sizeof err_buf, + "hard links are not supported on this %s\n", + am_server ? "server" : "client"); + rprintf(FERROR, "ERROR: %s", err_buf); return 0; -#endif - break; - - case 'p': - preserve_perms=1; - break; - - case 'o': - preserve_uid=1; - break; - - case 'g': - preserve_gid=1; - break; - - case 'D': - preserve_devices=1; - break; - - case 't': - preserve_times=1; - break; - - case 'c': - always_checksum=1; +#endif /* SUPPORT_HARD_LINKS */ break; case 'v': @@ -439,24 +549,6 @@ int parse_arguments(int argc, char *argv[], int frommain) if (frommain) quiet++; break; - case 'a': - recurse=1; -#if SUPPORT_LINKS - preserve_links=1; -#endif - preserve_perms=1; - preserve_times=1; - preserve_gid=1; - if (am_root) { - preserve_devices=1; - preserve_uid=1; - } - break; - - case OPT_SERVER: - am_server = 1; - break; - case OPT_SENDER: if (!am_server) { usage(FERROR); @@ -465,99 +557,173 @@ int parse_arguments(int argc, char *argv[], int frommain) am_sender = 1; break; - case 'r': - recurse = 1; - break; - - case 'R': - relative_paths = 1; - break; - - case 'e': - shell_cmd = optarg; - break; - - case 'B': - block_size = atoi(optarg); + case 'P': + do_progress = 1; + keep_partial = 1; break; - case OPT_TIMEOUT: - io_timeout = atoi(optarg); + case OPT_WRITE_BATCH: + /* popt stores the filename in batch_prefix for us */ + write_batch = 1; break; - case 'T': - tmpdir = optarg; + case OPT_READ_BATCH: + /* popt stores the filename in batch_prefix for us */ + read_batch = 1; break; - case OPT_COMPARE_DEST: - compare_dest = optarg; + case OPT_LINK_DEST: +#if HAVE_LINK + compare_dest = (char *)poptGetOptArg(pc); + link_dest = 1; break; +#else + snprintf(err_buf, sizeof err_buf, + "hard links are not supported on this %s\n", + am_server ? "server" : "client"); + rprintf(FERROR, "ERROR: %s", err_buf); + return 0; +#endif - case 'z': - do_compression = 1; - break; - case OPT_DAEMON: - am_daemon = 1; - break; + default: + /* FIXME: If --daemon is specified, then errors for later + * parameters seem to disappear. */ + snprintf(err_buf, sizeof(err_buf), + "%s%s: %s\n", + am_server ? "on remote machine: " : "", + poptBadOption(pc, POPT_BADOPTION_NOALIAS), + poptStrerror(opt)); + return 0; + } + } - case OPT_STATS: - do_stats = 1; - break; + if (write_batch && read_batch) { + rprintf(FERROR, + "write-batch and read-batch can not be used together\n"); + exit_cleanup(RERR_SYNTAX); + } - case OPT_PROGRESS: - do_progress = 1; - break; + if (do_compression && (write_batch || read_batch)) { + rprintf(FERROR, + "compress can not be used with write-batch or read-batch\n"); + exit_cleanup(RERR_SYNTAX); + } - case OPT_PARTIAL: - keep_partial = 1; - break; + if (archive_mode) { + if (!files_from) + recurse = 1; +#if SUPPORT_LINKS + preserve_links = 1; +#endif + preserve_perms = 1; + preserve_times = 1; + preserve_gid = 1; + preserve_uid = 1; + preserve_devices = 1; + } - case 'P': - do_progress = 1; - keep_partial = 1; - break; + if (relative_paths < 0) + relative_paths = files_from? 1 : 0; - case OPT_CONFIG: - config_file = optarg; - break; + if (!backup_suffix) + backup_suffix = backup_dir? "" : BACKUP_SUFFIX; + backup_suffix_len = strlen(backup_suffix); + if (strchr(backup_suffix, '/') != NULL) { + rprintf(FERROR, "--suffix cannot contain slashes: %s\n", + backup_suffix); + exit_cleanup(RERR_SYNTAX); + } + if (backup_dir) + backup_dir_len = strlen(backup_dir); + else if (!backup_suffix_len) { + rprintf(FERROR, + "--suffix cannot be a null string without --backup-dir\n"); + exit_cleanup(RERR_SYNTAX); + } - case OPT_PORT: - rsync_port = atoi(optarg); - break; + if (do_progress && !verbose) + verbose = 1; - case OPT_LOG_FORMAT: - log_format = optarg; - break; + *argv = poptGetArgs(pc); + if (*argv) + *argc = count_args(*argv); + else + *argc = 0; - case OPT_ADDRESS: - { - struct in_addr *ia; - if ((ia = ip_address(optarg))) { - socket_address = *ia; - } + if (files_from) { + char *colon; + if (*argc != 2) { + usage(FERROR); + exit_cleanup(RERR_SYNTAX); + } + if (strcmp(files_from, "-") == 0) { + filesfrom_fd = 0; + if (am_server) + remote_filesfrom_file = "-"; + } + else if ((colon = find_colon(files_from)) != 0) { + if (am_server) { + usage(FERROR); + exit_cleanup(RERR_SYNTAX); + } + remote_filesfrom_file = colon+1 + (colon[1] == ':'); + if (strcmp(remote_filesfrom_file, "-") == 0) { + rprintf(FERROR, "Invalid --files-from remote filename\n"); + exit_cleanup(RERR_SYNTAX); + } + } else { + extern int sanitize_paths; + if (sanitize_paths) + sanitize_path(strdup(files_from), NULL); + filesfrom_fd = open(files_from, O_RDONLY|O_BINARY); + if (filesfrom_fd < 0) { + rsyserr(FERROR, errno, + "failed to open files-from file %s", + files_from); + exit_cleanup(RERR_FILEIO); } - break; - - default: - slprintf(err_buf,sizeof(err_buf),"unrecognised option\n"); - return 0; } } + return 1; } +/** + * Construct a filtered list of options to pass through from the + * client to the server. + * + * This involves setting options that will tell the server how to + * behave, and also filtering out options that are processed only + * locally. + **/ void server_options(char **args,int *argc) { int ac = *argc; static char argstr[50]; static char bsize[30]; static char iotime[30]; + static char mdelete[30]; + static char mwindow[30]; + static char bw[50]; + /* Leave room for ``--(write|read)-batch='' */ + static char fext[MAXPATHLEN + 15]; + int i, x; + if (blocking_io == -1) + blocking_io = 0; + args[ac++] = "--server"; + if (daemon_over_rsh) { + args[ac++] = "--daemon"; + *argc = ac; + /* if we're passing --daemon, we're done */ + return; + } + if (!am_sender) args[ac++] = "--sender"; @@ -565,6 +731,7 @@ void server_options(char **args,int *argc) argstr[0] = '-'; for (i=0;i 0) argstr[x++] = 'W'; + /* We don't need to send --no-whole-file, because it's the + * default for remote transfers, and in any case old versions + * of rsync will not understand it. */ + if (preserve_hard_links) argstr[x++] = 'H'; if (preserve_uid) @@ -606,23 +778,62 @@ void server_options(char **args,int *argc) argstr[x++] = 'S'; if (do_compression) argstr[x++] = 'z'; + + /* this is a complete hack - blame Rusty + + this is a hack to make the list_only (remote file list) + more useful */ + if (list_only && !recurse) + argstr[x++] = 'r'; + argstr[x] = 0; if (x != 1) args[ac++] = argstr; - if (block_size != BLOCK_SIZE) { - sprintf(bsize,"-B%d",block_size); + if (block_size) { + snprintf(bsize,sizeof(bsize),"-B%d",block_size); args[ac++] = bsize; - } + } + + if (max_delete && am_sender) { + snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete); + args[ac++] = mdelete; + } + + if (batch_prefix != NULL) { + char *fmt = ""; + if (write_batch) + fmt = "--write-batch=%s"; + else + if (read_batch) + fmt = "--read-batch=%s"; + snprintf(fext,sizeof(fext),fmt,batch_prefix); + args[ac++] = fext; + } if (io_timeout) { - sprintf(iotime,"--timeout=%d",io_timeout); + snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout); args[ac++] = iotime; - } + } - if (strcmp(backup_suffix, BACKUP_SUFFIX)) { - args[ac++] = "--suffix"; - args[ac++] = backup_suffix; + if (bwlimit) { + snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit); + args[ac++] = bw; + } + + if (backup_dir) { + args[ac++] = "--backup-dir"; + args[ac++] = backup_dir; + } + + /* Only send --suffix if it specifies a non-default value. */ + if (strcmp(backup_suffix, backup_dir? "" : BACKUP_SUFFIX) != 0) { + char *s = new_array(char, 9+backup_suffix_len+1); + if (!s) + out_of_memory("server_options"); + /* We use the following syntax to avoid weirdness with '~'. */ + sprintf(s, "--suffix=%s", backup_suffix); + args[ac++] = s; } if (delete_mode && !delete_excluded) @@ -634,6 +845,12 @@ void server_options(char **args,int *argc) if (size_only) args[ac++] = "--size-only"; + if (modify_window_set) { + snprintf(mwindow,sizeof(mwindow),"--modify-window=%d", + modify_window); + args[ac++] = mwindow; + } + if (keep_partial) args[ac++] = "--partial"; @@ -643,6 +860,9 @@ void server_options(char **args,int *argc) if (delete_after) args[ac++] = "--delete-after"; + if (ignore_errors) + args[ac++] = "--ignore-errors"; + if (copy_unsafe_links) args[ac++] = "--copy-unsafe-links"; @@ -652,6 +872,12 @@ void server_options(char **args,int *argc) if (numeric_ids) args[ac++] = "--numeric-ids"; + if (only_existing && am_sender) + args[ac++] = "--existing"; + + if (opt_ignore_existing && am_sender) + args[ac++] = "--ignore-existing"; + if (tmpdir) { args[ac++] = "--temp-dir"; args[ac++] = tmpdir; @@ -662,11 +888,40 @@ void server_options(char **args,int *argc) * and it may be an older version that doesn't know this * option, so don't send it if client is the sender. */ - args[ac++] = "--compare-dest"; + args[ac++] = link_dest ? "--link-dest" : "--compare-dest"; args[ac++] = compare_dest; } + if (files_from && (!am_sender || remote_filesfrom_file)) { + if (remote_filesfrom_file) { + args[ac++] = "--files-from"; + args[ac++] = remote_filesfrom_file; + if (eol_nulls) + args[ac++] = "--from0"; + } else { + args[ac++] = "--files-from=-"; + args[ac++] = "--from0"; + } + } *argc = ac; } +/** + * Return the position of a ':' IF it is not part of a filename (i.e. as + * long as it doesn't occur after a slash. + */ +char *find_colon(char *s) +{ + char *p, *p2; + + p = strchr(s,':'); + if (!p) return NULL; + + /* now check to see if there is a / in the string before the : - if there is then + discard the colon on the assumption that the : is part of a filename */ + p2 = strchr(s,'/'); + if (p2 && p2 < p) return NULL; + + return p; +}