options.c

   1 /*  -*- c-file-style: "linux" -*-
   2  *
   3  * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
   4  * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20
  21 #include "rsync.h"
  22 #include "popt.h"
  23
  24 extern int sanitize_paths;
  25 extern int select_timeout;
  26 extern char curr_dir[MAXPATHLEN];
  27 extern struct exclude_list_struct exclude_list;
  28
  29 int make_backups = 0;
  30
  31 /**
  32  * If 1, send the whole file as literal data rather than trying to
  33  * create an incremental diff.
  34  *
  35  * If -1, then look at whether we're local or remote and go by that.
  36  *
  37  * @sa disable_deltas_p()
  38  **/
  39 int whole_file = -1;
  40
  41 int archive_mode = 0;
  42 int keep_dirlinks = 0;
  43 int copy_links = 0;
  44 int preserve_links = 0;
  45 int preserve_hard_links = 0;
  46 int preserve_perms = 0;
  47 int preserve_devices = 0;
  48 int preserve_uid = 0;
  49 int preserve_gid = 0;
  50 int preserve_times = 0;
  51 int update_only = 0;
  52 int cvs_exclude = 0;
  53 int dry_run = 0;
  54 int local_server = 0;
  55 int ignore_times = 0;
  56 int delete_mode = 0;
  57 int delete_excluded = 0;
  58 int one_file_system = 0;
  59 int protocol_version = PROTOCOL_VERSION;
  60 int sparse_files = 0;
  61 int do_compression = 0;
  62 int am_root = 0;
  63 int orig_umask = 0;
  64 int relative_paths = -1;
  65 int implied_dirs = 1;
  66 int numeric_ids = 0;
  67 int force_delete = 0;
  68 int io_timeout = 0;
  69 int read_only = 0;
  70 int module_id = -1;
  71 int am_server = 0;
  72 int am_sender = 0;
  73 int am_generator = 0;
  74 char *files_from = NULL;
  75 int filesfrom_fd = -1;
  76 char *remote_filesfrom_file = NULL;
  77 int eol_nulls = 0;
  78 int recurse = 0;
  79 int am_daemon = 0;
  80 int daemon_over_rsh = 0;
  81 int do_stats = 0;
  82 int do_progress = 0;
  83 int keep_partial = 0;
  84 int safe_symlinks = 0;
  85 int copy_unsafe_links = 0;
  86 int size_only = 0;
  87 int bwlimit = 0;
  88 size_t bwlimit_writemax = 0;
  89 int delete_after = 0;
  90 int only_existing = 0;
  91 int opt_ignore_existing = 0;
  92 int max_delete = 0;
  93 int ignore_errors = 0;
  94 int modify_window = 0;
  95 int blocking_io = -1;
  96 int checksum_seed = 0;
  97 unsigned int block_size = 0;
  98
  99
 100 /** Network address family. **/
 101 #ifdef INET6
 102 int default_af_hint = 0;        /* Any protocol */
 103 #else
 104 int default_af_hint = AF_INET;  /* Must use IPv4 */
 105 #endif
 106
 107 /** Do not go into the background when run as --daemon.  Good
 108  * for debugging and required for running as a service on W32,
 109  * or under Unix process-monitors. **/
 110 int no_detach = 0;
 111
 112 int write_batch = 0;
 113 int read_batch = 0;
 114 int backup_dir_len = 0;
 115 int backup_suffix_len;
 116 unsigned int backup_dir_remainder;
 117
 118 char *backup_suffix = NULL;
 119 char *tmpdir = NULL;
 120 char *compare_dest = NULL;
 121 char *config_file = NULL;
 122 char *shell_cmd = NULL;
 123 char *log_format = NULL;
 124 char *password_file = NULL;
 125 char *rsync_path = RSYNC_PATH;
 126 char *backup_dir = NULL;
 127 char backup_dir_buf[MAXPATHLEN];
 128 int rsync_port = RSYNC_PORT;
 129 int link_dest = 0;
 130
 131 int verbose = 0;
 132 int quiet = 0;
 133 int always_checksum = 0;
 134 int list_only = 0;
 135
 136 #define MAX_BATCH_NAME_LEN 256  /* Must be less than MAXPATHLEN-13 */
 137 char *batch_name = NULL;
 138
 139 static int daemon_opt;   /* sets am_daemon after option error-reporting */
 140 static int modify_window_set;
 141
 142 /** Local address to bind.  As a character string because it's
 143  * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
 144  * address, or a hostname. **/
 145 char *bind_address;
 146
 147
 148 static void print_rsync_version(enum logcode f)
 149 {
 150         char const *got_socketpair = "no ";
 151         char const *hardlinks = "no ";
 152         char const *links = "no ";
 153         char const *ipv6 = "no ";
 154         STRUCT_STAT *dumstat;
 155
 156 #ifdef HAVE_SOCKETPAIR
 157         got_socketpair = "";
 158 #endif
 159
 160 #if SUPPORT_HARD_LINKS
 161         hardlinks = "";
 162 #endif
 163
 164 #if SUPPORT_LINKS
 165         links = "";
 166 #endif
 167
 168 #if INET6
 169         ipv6 = "";
 170 #endif
 171
 172         rprintf(f, "%s  version %s  protocol version %d\n",
 173                 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
 174         rprintf(f,
 175                 "Copyright (C) 1996-2004 by Andrew Tridgell and others\n");
 176         rprintf(f, "<http://rsync.samba.org/>\n");
 177         rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
 178                 "%shard links, %ssymlinks, batchfiles, \n",
 179                 (int) (sizeof (OFF_T) * 8),
 180                 got_socketpair, hardlinks, links);
 181
 182         /* Note that this field may not have type ino_t.  It depends
 183          * on the complicated interaction between largefile feature
 184          * macros. */
 185         rprintf(f, "              %sIPv6, %d-bit system inums, %d-bit internal inums\n",
 186                 ipv6,
 187                 (int) (sizeof dumstat->st_ino * 8),
 188                 (int) (sizeof (uint64) * 8));
 189 #ifdef MAINTAINER_MODE
 190         rprintf(f, "              panic action: \"%s\"\n",
 191                 get_panic_action());
 192 #endif
 193
 194 #ifdef NO_INT64
 195         rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
 196 #endif
 197
 198         rprintf(f,
 199 "\n"
 200 "rsync comes with ABSOLUTELY NO WARRANTY.  This is free software, and you\n"
 201 "are welcome to redistribute it under certain conditions.  See the GNU\n"
 202 "General Public Licence for details.\n"
 203                 );
 204 }
 205
 206
 207 void usage(enum logcode F)
 208 {
 209   print_rsync_version(F);
 210
 211   rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
 212
 213   rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
 214   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST:SRC DEST\n");
 215   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... DEST\n");
 216   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
 217   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
 218   rprintf(F,"  or   rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
 219   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
 220   rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
 221   rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
 222   rprintf(F,"  sources separated by space as long as they have same top-level\n");
 223   rprintf(F,"\nOptions\n");
 224   rprintf(F," -v, --verbose               increase verbosity\n");
 225   rprintf(F," -q, --quiet                 decrease verbosity\n");
 226   rprintf(F," -c, --checksum              always checksum\n");
 227   rprintf(F," -a, --archive               archive mode, equivalent to -rlptgoD\n");
 228   rprintf(F," -r, --recursive             recurse into directories\n");
 229   rprintf(F," -R, --relative              use relative path names\n");
 230   rprintf(F,"     --no-relative           turn off --relative\n");
 231   rprintf(F,"     --no-implied-dirs       don't send implied dirs with -R\n");
 232   rprintf(F," -b, --backup                make backups (see --suffix & --backup-dir)\n");
 233   rprintf(F,"     --backup-dir            make backups into this directory\n");
 234   rprintf(F,"     --suffix=SUFFIX         backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
 235   rprintf(F," -u, --update                update only (don't overwrite newer files)\n");
 236   rprintf(F," -K, --keep-dirlinks         treat symlinked dir on receiver as dir\n");
 237   rprintf(F," -l, --links                 copy symlinks as symlinks\n");
 238   rprintf(F," -L, --copy-links            copy the referent of all symlinks\n");
 239   rprintf(F,"     --copy-unsafe-links     copy the referent of \"unsafe\" symlinks\n");
 240   rprintf(F,"     --safe-links            ignore \"unsafe\" symlinks\n");
 241   rprintf(F," -H, --hard-links            preserve hard links\n");
 242   rprintf(F," -p, --perms                 preserve permissions\n");
 243   rprintf(F," -o, --owner                 preserve owner (root only)\n");
 244   rprintf(F," -g, --group                 preserve group\n");
 245   rprintf(F," -D, --devices               preserve devices (root only)\n");
 246   rprintf(F," -t, --times                 preserve times\n");
 247   rprintf(F," -S, --sparse                handle sparse files efficiently\n");
 248   rprintf(F," -n, --dry-run               show what would have been transferred\n");
 249   rprintf(F," -W, --whole-file            copy whole files, no incremental checks\n");
 250   rprintf(F,"     --no-whole-file         turn off --whole-file\n");
 251   rprintf(F," -x, --one-file-system       don't cross filesystem boundaries\n");
 252   rprintf(F," -B, --block-size=SIZE       checksum blocking size (default %d)\n",BLOCK_SIZE);
 253   rprintf(F," -e, --rsh=COMMAND           specify the remote shell\n");
 254   rprintf(F,"     --rsync-path=PATH       specify path to rsync on the remote machine\n");
 255   rprintf(F,"     --existing              only update files that already exist\n");
 256   rprintf(F,"     --ignore-existing       ignore files that already exist on receiving side\n");
 257   rprintf(F,"     --delete                delete files that don't exist on the sending side\n");
 258   rprintf(F,"     --delete-excluded       also delete excluded files on the receiving side\n");
 259   rprintf(F,"     --delete-after          receiver deletes after transferring, not before\n");
 260   rprintf(F,"     --ignore-errors         delete even if there are I/O errors\n");
 261   rprintf(F,"     --max-delete=NUM        don't delete more than NUM files\n");
 262   rprintf(F,"     --partial               keep partially transferred files\n");
 263   rprintf(F,"     --force                 force deletion of directories even if not empty\n");
 264   rprintf(F,"     --numeric-ids           don't map uid/gid values by user/group name\n");
 265   rprintf(F,"     --timeout=TIME          set I/O timeout in seconds\n");
 266   rprintf(F," -I, --ignore-times          turn off mod time & file size quick check\n");
 267   rprintf(F,"     --size-only             ignore mod time for quick check (use size)\n");
 268   rprintf(F,"     --modify-window=NUM     compare mod times with reduced accuracy\n");
 269   rprintf(F," -T  --temp-dir=DIR          create temporary files in directory DIR\n");
 270   rprintf(F,"     --compare-dest=DIR      also compare destination files relative to DIR\n");
 271   rprintf(F,"     --link-dest=DIR         create hardlinks to DIR for unchanged files\n");
 272   rprintf(F," -P                          equivalent to --partial --progress\n");
 273   rprintf(F," -z, --compress              compress file data\n");
 274   rprintf(F," -C, --cvs-exclude           auto ignore files in the same way CVS does\n");
 275   rprintf(F,"     --exclude=PATTERN       exclude files matching PATTERN\n");
 276   rprintf(F,"     --exclude-from=FILE     exclude patterns listed in FILE\n");
 277   rprintf(F,"     --include=PATTERN       don't exclude files matching PATTERN\n");
 278   rprintf(F,"     --include-from=FILE     don't exclude patterns listed in FILE\n");
 279   rprintf(F,"     --files-from=FILE       read FILE for list of source-file names\n");
 280   rprintf(F," -0  --from0                 all *-from file lists are delimited by nulls\n");
 281   rprintf(F,"     --version               print version number\n");
 282   rprintf(F,"     --daemon                run as an rsync daemon\n");
 283   rprintf(F,"     --no-detach             do not detach from the parent\n");
 284   rprintf(F,"     --address=ADDRESS       bind to the specified address\n");
 285   rprintf(F,"     --config=FILE           specify alternate rsyncd.conf file\n");
 286   rprintf(F,"     --port=PORT             specify alternate rsyncd port number\n");
 287   rprintf(F,"     --blocking-io           use blocking I/O for the remote shell\n");
 288   rprintf(F,"     --no-blocking-io        turn off --blocking-io\n");
 289   rprintf(F,"     --stats                 give some file transfer stats\n");
 290   rprintf(F,"     --progress              show progress during transfer\n");
 291   rprintf(F,"     --log-format=FORMAT     log file transfers using specified format\n");
 292   rprintf(F,"     --password-file=FILE    get password from FILE\n");
 293   rprintf(F,"     --bwlimit=KBPS          limit I/O bandwidth, KBytes per second\n");
 294   rprintf(F,"     --write-batch=FILE      write a batch to FILE\n");
 295   rprintf(F,"     --read-batch=FILE       read a batch from FILE\n");
 296   rprintf(F,"     --checksum-seed=NUM     set block/file checksum seed\n");
 297 #ifdef INET6
 298   rprintf(F," -4  --ipv4                  prefer IPv4\n");
 299   rprintf(F," -6  --ipv6                  prefer IPv6\n");
 300 #endif
 301   rprintf(F," -h, --help                  show this help screen\n");
 302
 303   rprintf(F,"\n");
 304
 305   rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
 306   rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
 307 }
 308
 309 enum {OPT_VERSION = 1000, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
 310       OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED, OPT_LINK_DEST,
 311       OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
 312       OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT,
 313       OPT_REFUSED_BASE = 9000};
 314
 315 static struct poptOption long_options[] = {
 316   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 317   {"version",          0,  POPT_ARG_NONE,   0,              OPT_VERSION, 0, 0},
 318   {"suffix",           0,  POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
 319   {"rsync-path",       0,  POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
 320   {"password-file",    0,  POPT_ARG_STRING, &password_file, 0, 0, 0 },
 321   {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times, 0, 0, 0 },
 322   {"size-only",        0,  POPT_ARG_NONE,   &size_only, 0, 0, 0 },
 323   {"modify-window",    0,  POPT_ARG_INT,    &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
 324   {"one-file-system", 'x', POPT_ARG_NONE,   &one_file_system, 0, 0, 0 },
 325   {"delete",           0,  POPT_ARG_NONE,   &delete_mode, 0, 0, 0 },
 326   {"existing",         0,  POPT_ARG_NONE,   &only_existing, 0, 0, 0 },
 327   {"ignore-existing",  0,  POPT_ARG_NONE,   &opt_ignore_existing, 0, 0, 0 },
 328   {"delete-after",     0,  POPT_ARG_NONE,   0,              OPT_DELETE_AFTER, 0, 0 },
 329   {"delete-excluded",  0,  POPT_ARG_NONE,   0,              OPT_DELETE_EXCLUDED, 0, 0 },
 330   {"force",            0,  POPT_ARG_NONE,   &force_delete, 0, 0, 0 },
 331   {"numeric-ids",      0,  POPT_ARG_NONE,   &numeric_ids, 0, 0, 0 },
 332   {"exclude",          0,  POPT_ARG_STRING, 0,              OPT_EXCLUDE, 0, 0 },
 333   {"include",          0,  POPT_ARG_STRING, 0,              OPT_INCLUDE, 0, 0 },
 334   {"exclude-from",     0,  POPT_ARG_STRING, 0,              OPT_EXCLUDE_FROM, 0, 0 },
 335   {"include-from",     0,  POPT_ARG_STRING, 0,              OPT_INCLUDE_FROM, 0, 0 },
 336   {"safe-links",       0,  POPT_ARG_NONE,   &safe_symlinks, 0, 0, 0 },
 337   {"help",            'h', POPT_ARG_NONE,   0,              'h', 0, 0 },
 338   {"backup",          'b', POPT_ARG_NONE,   &make_backups, 0, 0, 0 },
 339   {"dry-run",         'n', POPT_ARG_NONE,   &dry_run, 0, 0, 0 },
 340   {"sparse",          'S', POPT_ARG_NONE,   &sparse_files, 0, 0, 0 },
 341   {"cvs-exclude",     'C', POPT_ARG_NONE,   &cvs_exclude, 0, 0, 0 },
 342   {"update",          'u', POPT_ARG_NONE,   &update_only, 0, 0, 0 },
 343   {"keep-dirlinks",   'K', POPT_ARG_NONE,   &keep_dirlinks, 0, 0, 0 },
 344   {"links",           'l', POPT_ARG_NONE,   &preserve_links, 0, 0, 0 },
 345   {"copy-links",      'L', POPT_ARG_NONE,   &copy_links, 0, 0, 0 },
 346   {"whole-file",      'W', POPT_ARG_VAL,    &whole_file, 1, 0, 0 },
 347   {"no-whole-file",    0,  POPT_ARG_VAL,    &whole_file, 0, 0, 0 },
 348   {"copy-unsafe-links", 0, POPT_ARG_NONE,   &copy_unsafe_links, 0, 0, 0 },
 349   {"perms",           'p', POPT_ARG_NONE,   &preserve_perms, 0, 0, 0 },
 350   {"owner",           'o', POPT_ARG_NONE,   &preserve_uid, 0, 0, 0 },
 351   {"group",           'g', POPT_ARG_NONE,   &preserve_gid, 0, 0, 0 },
 352   {"devices",         'D', POPT_ARG_NONE,   &preserve_devices, 0, 0, 0 },
 353   {"times",           't', POPT_ARG_NONE,   &preserve_times, 0, 0, 0 },
 354   {"checksum",        'c', POPT_ARG_NONE,   &always_checksum, 0, 0, 0 },
 355   {"verbose",         'v', POPT_ARG_NONE,   0,               'v', 0, 0 },
 356   {"quiet",           'q', POPT_ARG_NONE,   0,               'q', 0, 0 },
 357   {"archive",         'a', POPT_ARG_NONE,   &archive_mode, 0, 0, 0 },
 358   {"server",           0,  POPT_ARG_NONE,   &am_server, 0, 0, 0 },
 359   {"sender",           0,  POPT_ARG_NONE,   0,              OPT_SENDER, 0, 0 },
 360   {"recursive",       'r', POPT_ARG_NONE,   &recurse, 0, 0, 0 },
 361   {"relative",        'R', POPT_ARG_VAL,    &relative_paths, 1, 0, 0 },
 362   {"no-relative",      0,  POPT_ARG_VAL,    &relative_paths, 0, 0, 0 },
 363   {"rsh",             'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
 364   {"block-size",      'B', POPT_ARG_INT,    &block_size, 0, 0, 0 },
 365   {"max-delete",       0,  POPT_ARG_INT,    &max_delete, 0, 0, 0 },
 366   {"timeout",          0,  POPT_ARG_INT,    &io_timeout, OPT_TIMEOUT, 0, 0 },
 367   {"temp-dir",        'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
 368   {"compare-dest",     0,  POPT_ARG_STRING, &compare_dest, 0, 0, 0 },
 369   {"link-dest",        0,  POPT_ARG_STRING, &compare_dest,  OPT_LINK_DEST, 0, 0 },
 370   /* TODO: Should this take an optional int giving the compression level? */
 371   {"compress",        'z', POPT_ARG_NONE,   &do_compression, 0, 0, 0 },
 372   {"daemon",           0,  POPT_ARG_NONE,   &daemon_opt, 0, 0, 0 },
 373   {"no-detach",        0,  POPT_ARG_NONE,   &no_detach, 0, 0, 0 },
 374   {"stats",            0,  POPT_ARG_NONE,   &do_stats, 0, 0, 0 },
 375   {"progress",         0,  POPT_ARG_NONE,   &do_progress, 0, 0, 0 },
 376   {"partial",          0,  POPT_ARG_NONE,   &keep_partial, 0, 0, 0 },
 377   {"ignore-errors",    0,  POPT_ARG_NONE,   &ignore_errors, 0, 0, 0 },
 378   {"blocking-io",      0,  POPT_ARG_VAL,    &blocking_io, 1, 0, 0 },
 379   {"no-blocking-io",   0,  POPT_ARG_VAL,    &blocking_io, 0, 0, 0 },
 380   {0,                 'P', POPT_ARG_NONE,   0,              'P', 0, 0 },
 381   {"config",           0,  POPT_ARG_STRING, &config_file, 0, 0, 0 },
 382   {"port",             0,  POPT_ARG_INT,    &rsync_port, 0, 0, 0 },
 383   {"log-format",       0,  POPT_ARG_STRING, &log_format, 0, 0, 0 },
 384   {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
 385   {"address",          0,  POPT_ARG_STRING, &bind_address, 0, 0, 0 },
 386   {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
 387   {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
 388   {"read-batch",       0,  POPT_ARG_STRING, &batch_name,  OPT_READ_BATCH, 0, 0 },
 389   {"write-batch",      0,  POPT_ARG_STRING, &batch_name,  OPT_WRITE_BATCH, 0, 0 },
 390   {"files-from",       0,  POPT_ARG_STRING, &files_from, 0, 0, 0 },
 391   {"from0",           '0', POPT_ARG_NONE,   &eol_nulls, 0, 0, 0},
 392   {"no-implied-dirs",  0,  POPT_ARG_VAL,    &implied_dirs, 0, 0, 0 },
 393   {"protocol",         0,  POPT_ARG_INT,    &protocol_version, 0, 0, 0 },
 394   {"checksum-seed",    0,  POPT_ARG_INT,    &checksum_seed, 0, 0, 0 },
 395 #ifdef INET6
 396   {"ipv4",            '4', POPT_ARG_VAL,    &default_af_hint, AF_INET, 0, 0 },
 397   {"ipv6",            '6', POPT_ARG_VAL,    &default_af_hint, AF_INET6, 0, 0 },
 398 #endif
 399   {0,0,0,0, 0, 0, 0}
 400 };
 401
 402
 403 static char err_buf[200];
 404
 405
 406 /**
 407  * Store the option error message, if any, so that we can log the
 408  * connection attempt (which requires parsing the options), and then
 409  * show the error later on.
 410  **/
 411 void option_error(void)
 412 {
 413         if (!err_buf[0]) {
 414                 strcpy(err_buf, "Error parsing options: "
 415                     "option may be supported on client but not on server?\n");
 416         }
 417
 418         rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
 419 }
 420
 421
 422 /**
 423  * Tweak the option table to disable all options that the rsyncd.conf
 424  * file has told us to refuse.
 425  **/
 426 static void set_refuse_options(char *bp)
 427 {
 428         struct poptOption *op;
 429         char *cp;
 430
 431         while (1) {
 432                 if ((cp = strchr(bp, ' ')) != NULL)
 433                         *cp= '\0';
 434                 for (op = long_options; ; op++) {
 435                         if (!op->longName) {
 436                                 rprintf(FLOG,
 437                                     "Unknown option %s in \"refuse options\" setting\n",
 438                                     bp);
 439                                 break;
 440                         }
 441                         if (strcmp(bp, op->longName) == 0) {
 442                                 op->val = (op - long_options)+OPT_REFUSED_BASE;
 443                                 break;
 444                         }
 445                 }
 446                 if (!cp)
 447                         break;
 448                 *cp = ' ';
 449                 bp = cp + 1;
 450         }
 451 }
 452
 453
 454 static int count_args(char const **argv)
 455 {
 456         int i = 0;
 457
 458         while (argv[i] != NULL)
 459                 i++;
 460
 461         return i;
 462 }
 463
 464
 465 /**
 466  * Process command line arguments.  Called on both local and remote.
 467  *
 468  * @retval 1 if all options are OK; with globals set to appropriate
 469  * values
 470  *
 471  * @retval 0 on error, with err_buf containing an explanation
 472  **/
 473 int parse_arguments(int *argc, const char ***argv, int frommain)
 474 {
 475         int opt;
 476         char *ref = lp_refuse_options(module_id);
 477         const char *arg;
 478         poptContext pc;
 479
 480         if (ref && *ref)
 481                 set_refuse_options(ref);
 482
 483         /* TODO: Call poptReadDefaultConfig; handle errors. */
 484
 485         /* The context leaks in case of an error, but if there's a
 486          * problem we always exit anyhow. */
 487         pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
 488
 489         while ((opt = poptGetNextOpt(pc)) != -1) {
 490                 /* most options are handled automatically by popt;
 491                  * only special cases are returned and listed here. */
 492
 493                 switch (opt) {
 494                 case OPT_VERSION:
 495                         print_rsync_version(FINFO);
 496                         exit_cleanup(0);
 497
 498                 case OPT_MODIFY_WINDOW:
 499                         /* The value has already been set by popt, but
 500                          * we need to remember that we're using a
 501                          * non-default setting. */
 502                         modify_window_set = 1;
 503                         break;
 504
 505                 case OPT_DELETE_AFTER:
 506                         delete_after = 1;
 507                         delete_mode = 1;
 508                         break;
 509
 510                 case OPT_DELETE_EXCLUDED:
 511                         delete_excluded = 1;
 512                         delete_mode = 1;
 513                         break;
 514
 515                 case OPT_EXCLUDE:
 516                         if (am_server || sanitize_paths)
 517                                 return 0; /* Impossible... */
 518                         add_exclude(&exclude_list, poptGetOptArg(pc), 0);
 519                         break;
 520
 521                 case OPT_INCLUDE:
 522                         if (am_server || sanitize_paths)
 523                                 return 0; /* Impossible... */
 524                         add_exclude(&exclude_list, poptGetOptArg(pc),
 525                                     XFLG_DEF_INCLUDE);
 526                         break;
 527
 528                 case OPT_EXCLUDE_FROM:
 529                         if (am_server || sanitize_paths)
 530                                 return 0; /* Impossible... */
 531                         arg = poptGetOptArg(pc);
 532                         add_exclude_file(&exclude_list, arg,
 533                                          XFLG_FATAL_ERRORS);
 534                         break;
 535
 536                 case OPT_INCLUDE_FROM:
 537                         if (am_server || sanitize_paths)
 538                                 return 0; /* Impossible... */
 539                         arg = poptGetOptArg(pc);
 540                         add_exclude_file(&exclude_list, arg,
 541                                          XFLG_FATAL_ERRORS | XFLG_DEF_INCLUDE);
 542                         break;
 543
 544                 case 'h':
 545                         usage(FINFO);
 546                         exit_cleanup(0);
 547
 548                 case 'v':
 549                         verbose++;
 550                         break;
 551
 552                 case 'q':
 553                         if (frommain)
 554                                 quiet++;
 555                         break;
 556
 557                 case OPT_SENDER:
 558                         if (!am_server) {
 559                                 usage(FERROR);
 560                                 exit_cleanup(RERR_SYNTAX);
 561                         }
 562                         am_sender = 1;
 563                         break;
 564
 565                 case 'P':
 566                         do_progress = 1;
 567                         keep_partial = 1;
 568                         break;
 569
 570                 case OPT_WRITE_BATCH:
 571                         /* batch_name is already set */
 572                         write_batch = 1;
 573                         break;
 574
 575                 case OPT_READ_BATCH:
 576                         /* batch_name is already set */
 577                         read_batch = 1;
 578                         break;
 579
 580                 case OPT_TIMEOUT:
 581                         if (io_timeout && io_timeout < select_timeout)
 582                                 select_timeout = io_timeout;
 583                         break;
 584
 585                 case OPT_LINK_DEST:
 586 #if HAVE_LINK
 587                         link_dest = 1;
 588                         break;
 589 #else
 590                         snprintf(err_buf, sizeof err_buf,
 591                                  "hard links are not supported on this %s\n",
 592                                  am_server ? "server" : "client");
 593                         return 0;
 594 #endif
 595
 596                 default:
 597                         /* A large opt value means that set_refuse_options()
 598                          * turned this option off (opt-BASE is its index). */
 599                         if (opt >= OPT_REFUSED_BASE) {
 600                                 struct poptOption *op =
 601                                     &long_options[opt-OPT_REFUSED_BASE];
 602                                 int n = snprintf(err_buf, sizeof err_buf,
 603                                     "This server does not support --%s\n",
 604                                     op->longName) - 1;
 605                                 if (op->shortName) {
 606                                         snprintf(err_buf+n, sizeof err_buf-n,
 607                                             " (-%c)\n", op->shortName);
 608                                 }
 609                         } else {
 610                                 snprintf(err_buf, sizeof err_buf,
 611                                     "%s%s: %s\n",
 612                                     am_server ? "on remote machine: " : "",
 613                                     poptBadOption(pc, POPT_BADOPTION_NOALIAS),
 614                                     poptStrerror(opt));
 615                         }
 616                         return 0;
 617                 }
 618         }
 619
 620 #if !SUPPORT_LINKS
 621         if (preserve_links && !am_sender) {
 622                 snprintf(err_buf, sizeof err_buf,
 623                          "symlinks are not supported on this %s\n",
 624                          am_server ? "server" : "client");
 625                 return 0;
 626         }
 627 #endif
 628
 629 #if !SUPPORT_HARD_LINKS
 630         if (preserve_hard_links) {
 631                 snprintf(err_buf, sizeof err_buf,
 632                          "hard links are not supported on this %s\n",
 633                          am_server ? "server" : "client");
 634                 return 0;
 635         }
 636 #endif
 637
 638         if (block_size > MAX_MAP_SIZE) {
 639                 rprintf(FINFO, "limiting block-size to %d bytes\n",
 640                         MAX_MAP_SIZE);
 641                 block_size = MAX_MAP_SIZE;
 642         }
 643
 644         if (write_batch && read_batch) {
 645                 rprintf(FERROR,
 646                         "write-batch and read-batch can not be used together\n");
 647                 exit_cleanup(RERR_SYNTAX);
 648         }
 649         if (write_batch || read_batch) {
 650                 if (dry_run) {
 651                         rprintf(FERROR,
 652                                 "--%s-batch cannot be used with --dry_run (-n)\n",
 653                                 write_batch ? "write" : "read");
 654                         exit_cleanup(RERR_SYNTAX);
 655                 }
 656                 if (am_server) {
 657                         rprintf(FINFO,
 658                                 "ignoring --%s-batch option sent to server\n",
 659                                 write_batch ? "write" : "read");
 660                         /* We don't actually exit_cleanup(), so that we can
 661                          * still service older version clients that still send
 662                          * batch args to server. */
 663                         read_batch = write_batch = 0;
 664                         batch_name = NULL;
 665                 }
 666         }
 667         if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
 668                 rprintf(FERROR,
 669                         "the batch-file name must be %d characters or less.\n",
 670                         MAX_BATCH_NAME_LEN);
 671                 exit_cleanup(RERR_SYNTAX);
 672         }
 673
 674         if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
 675                 rprintf(FERROR, "the --temp-dir path is WAY too long.\n");
 676                 exit_cleanup(RERR_SYNTAX);
 677         }
 678
 679         if (archive_mode) {
 680                 if (!files_from)
 681                         recurse = 1;
 682 #if SUPPORT_LINKS
 683                 preserve_links = 1;
 684 #endif
 685                 preserve_perms = 1;
 686                 preserve_times = 1;
 687                 preserve_gid = 1;
 688                 preserve_uid = 1;
 689                 preserve_devices = 1;
 690         }
 691
 692         if (relative_paths < 0)
 693                 relative_paths = files_from? 1 : 0;
 694
 695         *argv = poptGetArgs(pc);
 696         if (*argv)
 697                 *argc = count_args(*argv);
 698         else
 699                 *argc = 0;
 700
 701         if (sanitize_paths) {
 702                 int i;
 703                 for (i = *argc; i-- > 0; )
 704                         (*argv)[i] = alloc_sanitize_path((*argv)[i], NULL);
 705                 if (tmpdir)
 706                         tmpdir = alloc_sanitize_path(tmpdir, curr_dir);
 707                 if (compare_dest)
 708                         compare_dest = alloc_sanitize_path(compare_dest, curr_dir);
 709                 if (backup_dir)
 710                         backup_dir = alloc_sanitize_path(backup_dir, curr_dir);
 711                 if (files_from)
 712                         files_from = alloc_sanitize_path(files_from, curr_dir);
 713         }
 714
 715         if (daemon_opt) {
 716                 daemon_opt = 0;
 717                 am_daemon = 1;
 718                 return 1;
 719         }
 720
 721         if (!backup_suffix)
 722                 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
 723         backup_suffix_len = strlen(backup_suffix);
 724         if (strchr(backup_suffix, '/') != NULL) {
 725                 rprintf(FERROR, "--suffix cannot contain slashes: %s\n",
 726                         backup_suffix);
 727                 exit_cleanup(RERR_SYNTAX);
 728         }
 729         if (backup_dir) {
 730                 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
 731                 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
 732                 if (backup_dir_remainder < 32) {
 733                         rprintf(FERROR, "the --backup-dir path is WAY too long.\n");
 734                         exit_cleanup(RERR_SYNTAX);
 735                 }
 736                 if (backup_dir_buf[backup_dir_len - 1] != '/') {
 737                         backup_dir_buf[backup_dir_len++] = '/';
 738                         backup_dir_buf[backup_dir_len] = '\0';
 739                 }
 740                 if (verbose > 1 && !am_sender)
 741                         rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
 742         } else if (!backup_suffix_len && (!am_server || !am_sender)) {
 743                 rprintf(FERROR,
 744                         "--suffix cannot be a null string without --backup-dir\n");
 745                 exit_cleanup(RERR_SYNTAX);
 746         }
 747
 748         if (do_progress && !verbose)
 749                 verbose = 1;
 750
 751         if (bwlimit) {
 752                 bwlimit_writemax = (size_t)bwlimit * 128;
 753                 if (bwlimit_writemax < 512)
 754                         bwlimit_writemax = 512;
 755         }
 756
 757         if (files_from) {
 758                 char *colon;
 759                 if (*argc != 2 && !(am_server && am_sender && *argc == 1)) {
 760                         usage(FERROR);
 761                         exit_cleanup(RERR_SYNTAX);
 762                 }
 763                 if (strcmp(files_from, "-") == 0) {
 764                         filesfrom_fd = 0;
 765                         if (am_server)
 766                                 remote_filesfrom_file = "-";
 767                 }
 768                 else if ((colon = find_colon(files_from)) != 0) {
 769                         if (am_server) {
 770                                 usage(FERROR);
 771                                 exit_cleanup(RERR_SYNTAX);
 772                         }
 773                         remote_filesfrom_file = colon+1 + (colon[1] == ':');
 774                         if (strcmp(remote_filesfrom_file, "-") == 0) {
 775                                 rprintf(FERROR, "Invalid --files-from remote filename\n");
 776                                 exit_cleanup(RERR_SYNTAX);
 777                         }
 778                 } else {
 779                         filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
 780                         if (filesfrom_fd < 0) {
 781                                 rsyserr(FERROR, errno,
 782                                         "failed to open files-from file %s",
 783                                         files_from);
 784                                 exit_cleanup(RERR_FILEIO);
 785                         }
 786                 }
 787         }
 788
 789         return 1;
 790 }
 791
 792
 793 /**
 794  * Construct a filtered list of options to pass through from the
 795  * client to the server.
 796  *
 797  * This involves setting options that will tell the server how to
 798  * behave, and also filtering out options that are processed only
 799  * locally.
 800  **/
 801 void server_options(char **args,int *argc)
 802 {
 803         int ac = *argc;
 804         static char argstr[50];
 805         char *arg;
 806
 807         int i, x;
 808
 809         if (blocking_io == -1)
 810                 blocking_io = 0;
 811
 812         args[ac++] = "--server";
 813
 814         if (daemon_over_rsh) {
 815                 args[ac++] = "--daemon";
 816                 *argc = ac;
 817                 /* if we're passing --daemon, we're done */
 818                 return;
 819         }
 820
 821         if (!am_sender)
 822                 args[ac++] = "--sender";
 823
 824         x = 1;
 825         argstr[0] = '-';
 826         for (i = 0; i < verbose; i++)
 827                 argstr[x++] = 'v';
 828
 829         /* the -q option is intentionally left out */
 830         if (make_backups)
 831                 argstr[x++] = 'b';
 832         if (update_only)
 833                 argstr[x++] = 'u';
 834         if (dry_run)
 835                 argstr[x++] = 'n';
 836         if (preserve_links)
 837                 argstr[x++] = 'l';
 838         if (copy_links)
 839                 argstr[x++] = 'L';
 840         if (keep_dirlinks && am_sender)
 841                 argstr[x++] = 'K';
 842
 843         if (whole_file > 0)
 844                 argstr[x++] = 'W';
 845         /* We don't need to send --no-whole-file, because it's the
 846          * default for remote transfers, and in any case old versions
 847          * of rsync will not understand it. */
 848
 849         if (preserve_hard_links)
 850                 argstr[x++] = 'H';
 851         if (preserve_uid)
 852                 argstr[x++] = 'o';
 853         if (preserve_gid)
 854                 argstr[x++] = 'g';
 855         if (preserve_devices)
 856                 argstr[x++] = 'D';
 857         if (preserve_times)
 858                 argstr[x++] = 't';
 859         if (preserve_perms)
 860                 argstr[x++] = 'p';
 861         if (recurse)
 862                 argstr[x++] = 'r';
 863         if (always_checksum)
 864                 argstr[x++] = 'c';
 865         if (cvs_exclude)
 866                 argstr[x++] = 'C';
 867         if (ignore_times)
 868                 argstr[x++] = 'I';
 869         if (relative_paths)
 870                 argstr[x++] = 'R';
 871         if (one_file_system)
 872                 argstr[x++] = 'x';
 873         if (sparse_files)
 874                 argstr[x++] = 'S';
 875         if (do_compression)
 876                 argstr[x++] = 'z';
 877
 878         /* this is a complete hack - blame Rusty
 879
 880            this is a hack to make the list_only (remote file list)
 881            more useful */
 882         if (list_only && !recurse)
 883                 argstr[x++] = 'r';
 884
 885         argstr[x] = 0;
 886
 887         if (x != 1)
 888                 args[ac++] = argstr;
 889
 890         if (block_size) {
 891                 if (asprintf(&arg, "-B%u", block_size) < 0)
 892                         goto oom;
 893                 args[ac++] = arg;
 894         }
 895
 896         if (max_delete && am_sender) {
 897                 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
 898                         goto oom;
 899                 args[ac++] = arg;
 900         }
 901
 902         if (io_timeout) {
 903                 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
 904                         goto oom;
 905                 args[ac++] = arg;
 906         }
 907
 908         if (bwlimit) {
 909                 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
 910                         goto oom;
 911                 args[ac++] = arg;
 912         }
 913
 914         if (backup_dir) {
 915                 args[ac++] = "--backup-dir";
 916                 args[ac++] = backup_dir;
 917         }
 918
 919         /* Only send --suffix if it specifies a non-default value. */
 920         if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
 921                 /* We use the following syntax to avoid weirdness with '~'. */
 922                 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
 923                         goto oom;
 924                 args[ac++] = arg;
 925         }
 926
 927         if (delete_excluded)
 928                 args[ac++] = "--delete-excluded";
 929         else if (delete_mode)
 930                 args[ac++] = "--delete";
 931
 932         if (size_only)
 933                 args[ac++] = "--size-only";
 934
 935         if (modify_window_set) {
 936                 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
 937                         goto oom;
 938                 args[ac++] = arg;
 939         }
 940
 941         if (checksum_seed) {
 942                 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
 943                         goto oom;
 944                 args[ac++] = arg;
 945         }
 946
 947         if (keep_partial)
 948                 args[ac++] = "--partial";
 949
 950         if (force_delete)
 951                 args[ac++] = "--force";
 952
 953         if (delete_after)
 954                 args[ac++] = "--delete-after";
 955
 956         if (ignore_errors)
 957                 args[ac++] = "--ignore-errors";
 958
 959         if (copy_unsafe_links)
 960                 args[ac++] = "--copy-unsafe-links";
 961
 962         if (safe_symlinks)
 963                 args[ac++] = "--safe-links";
 964
 965         if (numeric_ids)
 966                 args[ac++] = "--numeric-ids";
 967
 968         if (only_existing && am_sender)
 969                 args[ac++] = "--existing";
 970
 971         if (opt_ignore_existing && am_sender)
 972                 args[ac++] = "--ignore-existing";
 973
 974         if (tmpdir) {
 975                 args[ac++] = "--temp-dir";
 976                 args[ac++] = tmpdir;
 977         }
 978
 979         if (compare_dest && am_sender) {
 980                 /* the server only needs this option if it is not the sender,
 981                  *   and it may be an older version that doesn't know this
 982                  *   option, so don't send it if client is the sender.
 983                  */
 984                 args[ac++] = link_dest ? "--link-dest" : "--compare-dest";
 985                 args[ac++] = compare_dest;
 986         }
 987
 988         if (files_from && (!am_sender || remote_filesfrom_file)) {
 989                 if (remote_filesfrom_file) {
 990                         args[ac++] = "--files-from";
 991                         args[ac++] = remote_filesfrom_file;
 992                         if (eol_nulls)
 993                                 args[ac++] = "--from0";
 994                 } else {
 995                         args[ac++] = "--files-from=-";
 996                         args[ac++] = "--from0";
 997                 }
 998         }
 999
1000         *argc = ac;
1001         return;
1002
1003     oom:
1004         out_of_memory("server_options");
1005 }
1006
1007 /**
1008  * Return the position of a ':' IF it is not part of a filename (i.e. as
1009  * long as it doesn't occur after a slash.
1010  */
1011 char *find_colon(char *s)
1012 {
1013         char *p, *p2;
1014
1015         p = strchr(s,':');
1016         if (!p)
1017                 return NULL;
1018
1019         /* now check to see if there is a / in the string before the : - if there is then
1020            discard the colon on the assumption that the : is part of a filename */
1021         p2 = strchr(s,'/');
1022         if (p2 && p2 < p)
1023                 return NULL;
1024
1025         return p;
1026 }