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 int make_backups = 0;
  25
  26 /**
  27  * If True, send the whole file as literal data rather than trying to
  28  * create an incremental diff.
  29  *
  30  * If both are 0, then look at whether we're local or remote and go by
  31  * that.
  32  *
  33  * @sa disable_deltas_p()
  34  **/
  35 int whole_file = 0;
  36 int no_whole_file = 0;
  37
  38 int copy_links = 0;
  39 int preserve_links = 0;
  40 int preserve_hard_links = 0;
  41 int preserve_perms = 0;
  42 int preserve_devices = 0;
  43 int preserve_uid = 0;
  44 int preserve_gid = 0;
  45 int preserve_times = 0;
  46 int update_only = 0;
  47 int cvs_exclude = 0;
  48 int dry_run=0;
  49 int local_server=0;
  50 int ignore_times=0;
  51 int delete_mode=0;
  52 int delete_excluded=0;
  53 int one_file_system=0;
  54 int remote_version=0;
  55 int sparse_files=0;
  56 int do_compression=0;
  57 int am_root=0;
  58 int orig_umask=0;
  59 int relative_paths=0;
  60 int numeric_ids = 0;
  61 int force_delete = 0;
  62 int io_timeout = 0;
  63 int io_error = 0;
  64 int read_only = 0;
  65 int module_id = -1;
  66 int am_server = 0;
  67 int am_sender = 0;
  68 int recurse = 0;
  69 int am_daemon = 0;
  70 int daemon_over_rsh = 0;
  71 int do_stats=0;
  72 int do_progress=0;
  73 int keep_partial=0;
  74 int safe_symlinks=0;
  75 int copy_unsafe_links=0;
  76 int block_size=BLOCK_SIZE;
  77 int size_only=0;
  78 int bwlimit=0;
  79 int delete_after=0;
  80 int only_existing=0;
  81 int opt_ignore_existing=0;
  82 int max_delete=0;
  83 int ignore_errors=0;
  84 #ifdef _WIN32
  85 int modify_window=2;
  86 #else
  87 int modify_window=0;
  88 #endif
  89 int blocking_io=-1;
  90
  91
  92 /** Network address family. **/
  93 #ifdef INET6
  94 int default_af_hint = 0;        /* Any protocol */
  95 #else
  96 int default_af_hint = AF_INET;  /* Must use IPv4 */
  97 #endif
  98
  99 /** Do not go into the background when run as --daemon.  Good
 100  * for debugging and required for running as a service on W32,
 101  * or under Unix process-monitors. **/
 102 int no_detach = 0;
 103
 104 int write_batch = 0;
 105 int read_batch = 0;
 106 int suffix_specified = 0;
 107
 108 char *backup_suffix = BACKUP_SUFFIX;
 109 char *tmpdir = NULL;
 110 char *compare_dest = NULL;
 111 char *config_file = RSYNCD_CONF;
 112 char *shell_cmd = NULL;
 113 char *log_format = NULL;
 114 char *password_file = NULL;
 115 char *rsync_path = RSYNC_PATH;
 116 char *backup_dir = NULL;
 117 int rsync_port = RSYNC_PORT;
 118
 119 int verbose = 0;
 120 int quiet = 0;
 121 int always_checksum = 0;
 122 int list_only = 0;
 123
 124 char *batch_prefix = NULL;
 125
 126 static int modify_window_set;
 127
 128 /** Local address to bind.  As a character string because it's
 129  * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
 130  * address, or a hostname. **/
 131 char *bind_address;
 132
 133
 134 static void print_rsync_version(enum logcode f)
 135 {
 136         char const *got_socketpair = "no ";
 137         char const *hardlinks = "no ";
 138         char const *links = "no ";
 139         char const *ipv6 = "no ";
 140         STRUCT_STAT *dumstat;
 141
 142 #ifdef HAVE_SOCKETPAIR
 143         got_socketpair = "";
 144 #endif
 145
 146 #if SUPPORT_HARD_LINKS
 147         hardlinks = "";
 148 #endif
 149
 150 #if SUPPORT_LINKS
 151         links = "";
 152 #endif
 153
 154 #if INET6
 155         ipv6 = "";
 156 #endif
 157
 158         rprintf(f, "%s  version %s  protocol version %d\n",
 159                 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
 160         rprintf(f,
 161                 "Copyright (C) 1996-2002 by Andrew Tridgell and others\n");
 162         rprintf(f, "<http://rsync.samba.org/>\n");
 163         rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
 164                 "%shard links, %ssymlinks, batchfiles, \n",
 165                 (int) (sizeof(OFF_T) * 8),
 166                 got_socketpair, hardlinks, links);
 167
 168         /* Note that this field may not have type ino_t.  It depends
 169          * on the complicated interaction between largefile feature
 170          * macros. */
 171         rprintf(f, "              %sIPv6, %d-bit system inums, %d-bit internal inums\n",
 172                 ipv6,
 173                 (int) (sizeof(dumstat->st_ino) * 8),
 174                 (int) (sizeof(INO64_T) * 8));
 175 #ifdef MAINTAINER_MODE
 176         rprintf(f, "              panic action: \"%s\"\n",
 177                 get_panic_action());
 178 #endif
 179
 180 #ifdef NO_INT64
 181         rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
 182 #endif
 183
 184         rprintf(f,
 185 "\n"
 186 "rsync comes with ABSOLUTELY NO WARRANTY.  This is free software, and you\n"
 187 "are welcome to redistribute it under certain conditions.  See the GNU\n"
 188 "General Public Licence for details.\n"
 189                 );
 190 }
 191
 192
 193 void usage(enum logcode F)
 194 {
 195   print_rsync_version(F);
 196
 197   rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
 198
 199   rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
 200   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST:SRC DEST\n");
 201   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... DEST\n");
 202   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
 203   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
 204   rprintf(F,"  or   rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
 205   rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
 206   rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
 207   rprintf(F,"  sources separated by space as long as they have same top-level\n");
 208   rprintf(F,"\nOptions\n");
 209   rprintf(F," -v, --verbose               increase verbosity\n");
 210   rprintf(F," -q, --quiet                 decrease verbosity\n");
 211   rprintf(F," -c, --checksum              always checksum\n");
 212   rprintf(F," -a, --archive               archive mode\n");
 213   rprintf(F," -r, --recursive             recurse into directories\n");
 214   rprintf(F," -R, --relative              use relative path names\n");
 215   rprintf(F," -b, --backup                make backups (default %s suffix)\n",BACKUP_SUFFIX);
 216   rprintf(F,"     --backup-dir            make backups into this directory\n");
 217   rprintf(F,"     --suffix=SUFFIX         override backup suffix\n");
 218   rprintf(F," -u, --update                update only (don't overwrite newer files)\n");
 219   rprintf(F," -l, --links                 copy symlinks as symlinks\n");
 220   rprintf(F," -L, --copy-links            copy the referent of symlinks\n");
 221   rprintf(F,"     --copy-unsafe-links     copy links outside the source tree\n");
 222   rprintf(F,"     --safe-links            ignore links outside the destination tree\n");
 223   rprintf(F," -H, --hard-links            preserve hard links\n");
 224   rprintf(F," -p, --perms                 preserve permissions\n");
 225   rprintf(F," -o, --owner                 preserve owner (root only)\n");
 226   rprintf(F," -g, --group                 preserve group\n");
 227   rprintf(F," -D, --devices               preserve devices (root only)\n");
 228   rprintf(F," -t, --times                 preserve times\n");
 229   rprintf(F," -S, --sparse                handle sparse files efficiently\n");
 230   rprintf(F," -n, --dry-run               show what would have been transferred\n");
 231   rprintf(F," -W, --whole-file            copy whole files, no incremental checks\n");
 232   rprintf(F,"     --no-whole-file         turn off --whole-file\n");
 233   rprintf(F," -x, --one-file-system       don't cross filesystem boundaries\n");
 234   rprintf(F," -B, --block-size=SIZE       checksum blocking size (default %d)\n",BLOCK_SIZE);
 235   rprintf(F," -e, --rsh=COMMAND           specify the remote shell\n");
 236   rprintf(F,"     --rsync-path=PATH       specify path to rsync on the remote machine\n");
 237   rprintf(F," -C, --cvs-exclude           auto ignore files in the same way CVS does\n");
 238   rprintf(F,"     --existing              only update files that already exist\n");
 239   rprintf(F,"     --ignore-existing       ignore files that already exist on the receiving side\n");
 240   rprintf(F,"     --delete                delete files that don't exist on the sending side\n");
 241   rprintf(F,"     --delete-excluded       also delete excluded files on the receiving side\n");
 242   rprintf(F,"     --delete-after          delete after transferring, not before\n");
 243   rprintf(F,"     --ignore-errors         delete even if there are IO errors\n");
 244   rprintf(F,"     --max-delete=NUM        don't delete more than NUM files\n");
 245   rprintf(F,"     --partial               keep partially transferred files\n");
 246   rprintf(F,"     --force                 force deletion of directories even if not empty\n");
 247   rprintf(F,"     --numeric-ids           don't map uid/gid values by user/group name\n");
 248   rprintf(F,"     --timeout=TIME          set IO timeout in seconds\n");
 249   rprintf(F," -I, --ignore-times          don't exclude files that match length and time\n");
 250   rprintf(F,"     --size-only             only use file size when determining if a file should be transferred\n");
 251   rprintf(F,"     --modify-window=NUM     Timestamp window (seconds) for file match (default=%d)\n",modify_window);
 252   rprintf(F," -T  --temp-dir=DIR          create temporary files in directory DIR\n");
 253   rprintf(F,"     --compare-dest=DIR      also compare destination files relative to DIR\n");
 254   rprintf(F," -P                          equivalent to --partial --progress\n");
 255   rprintf(F," -z, --compress              compress file data\n");
 256   rprintf(F,"     --exclude=PATTERN       exclude files matching PATTERN\n");
 257   rprintf(F,"     --exclude-from=FILE     exclude patterns listed in FILE\n");
 258   rprintf(F,"     --include=PATTERN       don't exclude files matching PATTERN\n");
 259   rprintf(F,"     --include-from=FILE     don't exclude patterns listed in FILE\n");
 260   rprintf(F,"     --version               print version number\n");
 261   rprintf(F,"     --daemon                run as a rsync daemon\n");
 262   rprintf(F,"     --no-detach             do not detach from the parent\n");
 263   rprintf(F,"     --address=ADDRESS       bind to the specified address\n");
 264   rprintf(F,"     --config=FILE           specify alternate rsyncd.conf file\n");
 265   rprintf(F,"     --port=PORT             specify alternate rsyncd port number\n");
 266   rprintf(F,"     --blocking-io           use blocking IO for the remote shell\n");
 267   rprintf(F,"     --no-blocking-io        turn off --blocking-io\n");
 268   rprintf(F,"     --stats                 give some file transfer stats\n");
 269   rprintf(F,"     --progress              show progress during transfer\n");
 270   rprintf(F,"     --log-format=FORMAT     log file transfers using specified format\n");
 271   rprintf(F,"     --password-file=FILE    get password from FILE\n");
 272   rprintf(F,"     --bwlimit=KBPS          limit I/O bandwidth, KBytes per second\n");
 273   rprintf(F,"     --write-batch=PREFIX    write batch fileset starting with PREFIX\n");
 274   rprintf(F,"     --read-batch=PREFIX     read batch fileset starting with PREFIX\n");
 275   rprintf(F," -h, --help                  show this help screen\n");
 276 #ifdef INET6
 277   rprintf(F," -4                          prefer IPv4\n");
 278   rprintf(F," -6                          prefer IPv6\n");
 279 #endif
 280
 281   rprintf(F,"\n");
 282
 283   rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
 284   rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
 285 }
 286
 287 enum {OPT_VERSION = 1000, OPT_SUFFIX, OPT_SENDER, OPT_SERVER, OPT_EXCLUDE,
 288       OPT_EXCLUDE_FROM, OPT_DELETE, OPT_DELETE_EXCLUDED, OPT_NUMERIC_IDS,
 289       OPT_RSYNC_PATH, OPT_FORCE, OPT_TIMEOUT, OPT_DAEMON, OPT_CONFIG, OPT_PORT,
 290       OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_STATS, OPT_PARTIAL, OPT_PROGRESS,
 291       OPT_COPY_UNSAFE_LINKS, OPT_SAFE_LINKS, OPT_COMPARE_DEST,
 292       OPT_LOG_FORMAT, OPT_PASSWORD_FILE, OPT_SIZE_ONLY, OPT_ADDRESS,
 293       OPT_DELETE_AFTER, OPT_EXISTING, OPT_MAX_DELETE, OPT_BACKUP_DIR,
 294       OPT_IGNORE_ERRORS, OPT_BWLIMIT, OPT_BLOCKING_IO,
 295       OPT_NO_BLOCKING_IO, OPT_WHOLE_FILE, OPT_NO_WHOLE_FILE,
 296       OPT_MODIFY_WINDOW, OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_IGNORE_EXISTING};
 297
 298 static struct poptOption long_options[] = {
 299   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 300   {"version",          0,  POPT_ARG_NONE,   0,             OPT_VERSION, 0, 0},
 301   {"suffix",           0,  POPT_ARG_STRING, &backup_suffix,     OPT_SUFFIX, 0, 0 },
 302   {"rsync-path",       0,  POPT_ARG_STRING, &rsync_path,        0, 0, 0 },
 303   {"password-file",    0,  POPT_ARG_STRING, &password_file,     0, 0, 0 },
 304   {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times , 0, 0, 0 },
 305   {"size-only",        0,  POPT_ARG_NONE,   &size_only , 0, 0, 0 },
 306   {"modify-window",    0,  POPT_ARG_INT,    &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
 307   {"one-file-system", 'x', POPT_ARG_NONE,   &one_file_system , 0, 0, 0 },
 308   {"delete",           0,  POPT_ARG_NONE,   &delete_mode , 0, 0, 0 },
 309   {"existing",         0,  POPT_ARG_NONE,   &only_existing , 0, 0, 0 },
 310   {"ignore-existing",  0,  POPT_ARG_NONE,   &opt_ignore_existing , 0, 0, 0 },
 311   {"delete-after",     0,  POPT_ARG_NONE,   0,              OPT_DELETE_AFTER, 0, 0 },
 312   {"delete-excluded",  0,  POPT_ARG_NONE,   0,              OPT_DELETE_EXCLUDED, 0, 0 },
 313   {"force",            0,  POPT_ARG_NONE,   &force_delete , 0, 0, 0 },
 314   {"numeric-ids",      0,  POPT_ARG_NONE,   &numeric_ids , 0, 0, 0 },
 315   {"exclude",          0,  POPT_ARG_STRING, 0,              OPT_EXCLUDE, 0, 0 },
 316   {"include",          0,  POPT_ARG_STRING, 0,              OPT_INCLUDE, 0, 0 },
 317   {"exclude-from",     0,  POPT_ARG_STRING, 0,              OPT_EXCLUDE_FROM, 0, 0 },
 318   {"include-from",     0,  POPT_ARG_STRING, 0,              OPT_INCLUDE_FROM, 0, 0 },
 319   {"safe-links",       0,  POPT_ARG_NONE,   &safe_symlinks , 0, 0, 0 },
 320   {"help",            'h', POPT_ARG_NONE,   0,              'h', 0, 0 },
 321   {"backup",          'b', POPT_ARG_NONE,   &make_backups , 0, 0, 0 },
 322   {"dry-run",         'n', POPT_ARG_NONE,   &dry_run , 0, 0, 0 },
 323   {"sparse",          'S', POPT_ARG_NONE,   &sparse_files , 0, 0, 0 },
 324   {"cvs-exclude",     'C', POPT_ARG_NONE,   &cvs_exclude , 0, 0, 0 },
 325   {"update",          'u', POPT_ARG_NONE,   &update_only , 0, 0, 0 },
 326   {"links",           'l', POPT_ARG_NONE,   &preserve_links , 0, 0, 0 },
 327   {"copy-links",      'L', POPT_ARG_NONE,   &copy_links , 0, 0, 0 },
 328   {"whole-file",      'W', POPT_ARG_NONE,   0,              OPT_WHOLE_FILE, 0, 0 },
 329   {"no-whole-file",    0,  POPT_ARG_NONE,   0,              OPT_NO_WHOLE_FILE, 0, 0 },
 330   {"copy-unsafe-links", 0, POPT_ARG_NONE,   &copy_unsafe_links , 0, 0, 0 },
 331   {"perms",           'p', POPT_ARG_NONE,   &preserve_perms , 0, 0, 0 },
 332   {"owner",           'o', POPT_ARG_NONE,   &preserve_uid , 0, 0, 0 },
 333   {"group",           'g', POPT_ARG_NONE,   &preserve_gid , 0, 0, 0 },
 334   {"devices",         'D', POPT_ARG_NONE,   &preserve_devices , 0, 0, 0 },
 335   {"times",           't', POPT_ARG_NONE,   &preserve_times , 0, 0, 0 },
 336   {"checksum",        'c', POPT_ARG_NONE,   &always_checksum , 0, 0, 0 },
 337   {"verbose",         'v', POPT_ARG_NONE,   0,               'v', 0, 0 },
 338   {"quiet",           'q', POPT_ARG_NONE,   0,               'q', 0, 0 },
 339   {"archive",         'a', POPT_ARG_NONE,   0,               'a', 0, 0 },
 340   {"server",           0,  POPT_ARG_NONE,   &am_server , 0, 0, 0 },
 341   {"sender",           0,  POPT_ARG_NONE,   0,               OPT_SENDER, 0, 0 },
 342   {"recursive",       'r', POPT_ARG_NONE,   &recurse , 0, 0, 0 },
 343   {"relative",        'R', POPT_ARG_NONE,   &relative_paths , 0, 0, 0 },
 344   {"rsh",             'e', POPT_ARG_STRING, &shell_cmd , 0, 0, 0 },
 345   {"block-size",      'B', POPT_ARG_INT,    &block_size , 0, 0, 0 },
 346   {"max-delete",       0,  POPT_ARG_INT,    &max_delete , 0, 0, 0 },
 347   {"timeout",          0,  POPT_ARG_INT,    &io_timeout , 0, 0, 0 },
 348   {"temp-dir",        'T', POPT_ARG_STRING, &tmpdir , 0, 0, 0 },
 349   {"compare-dest",     0,  POPT_ARG_STRING, &compare_dest , 0, 0, 0 },
 350   /* TODO: Should this take an optional int giving the compression level? */
 351   {"compress",        'z', POPT_ARG_NONE,   &do_compression , 0, 0, 0 },
 352   {"daemon",           0,  POPT_ARG_NONE,   &am_daemon , 0, 0, 0 },
 353   {"no-detach",        0,  POPT_ARG_NONE,   &no_detach , 0, 0, 0 },
 354   {"stats",            0,  POPT_ARG_NONE,   &do_stats , 0, 0, 0 },
 355   {"progress",         0,  POPT_ARG_NONE,   &do_progress , 0, 0, 0 },
 356   {"partial",          0,  POPT_ARG_NONE,   &keep_partial , 0, 0, 0 },
 357   {"ignore-errors",    0,  POPT_ARG_NONE,   &ignore_errors , 0, 0, 0 },
 358   {"blocking-io",      0,  POPT_ARG_NONE,   &blocking_io , 0, 0, 0 },
 359   {"no-blocking-io",   0,  POPT_ARG_NONE,   0,               OPT_NO_BLOCKING_IO, 0, 0 },
 360   {0,                 'P', POPT_ARG_NONE,   0,               'P', 0, 0 },
 361   {"config",           0,  POPT_ARG_STRING, &config_file , 0, 0, 0 },
 362   {"port",             0,  POPT_ARG_INT,    &rsync_port , 0, 0, 0 },
 363   {"log-format",       0,  POPT_ARG_STRING, &log_format , 0, 0, 0 },
 364   {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit , 0, 0, 0 },
 365   {"address",          0,  POPT_ARG_STRING, &bind_address, 0, 0, 0 },
 366   {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir , 0, 0, 0 },
 367   {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links , 0, 0, 0 },
 368   {"read-batch",       0,  POPT_ARG_STRING, &batch_prefix, OPT_READ_BATCH, 0, 0 },
 369   {"write-batch",      0,  POPT_ARG_STRING, &batch_prefix, OPT_WRITE_BATCH, 0, 0 },
 370 #ifdef INET6
 371   {0,                 '4', POPT_ARG_VAL,    &default_af_hint,   AF_INET , 0, 0 },
 372   {0,                 '6', POPT_ARG_VAL,    &default_af_hint,   AF_INET6 , 0, 0 },
 373 #endif
 374   {0,0,0,0, 0, 0, 0}
 375 };
 376
 377
 378 static char err_buf[100];
 379
 380
 381 /**
 382  * Store the option error message, if any, so that we can log the
 383  * connection attempt (which requires parsing the options), and then
 384  * show the error later on.
 385  **/
 386 void option_error(void)
 387 {
 388         if (err_buf[0]) {
 389                 rprintf(FLOG, "%s", err_buf);
 390                 rprintf(FERROR, "%s: %s", RSYNC_NAME, err_buf);
 391         } else {
 392                 rprintf (FERROR, "Error parsing options: "
 393                          "option may be supported on client but not on server?\n");
 394                 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
 395                          "option may be supported on client but not on server?\n");
 396         }
 397 }
 398
 399
 400 /**
 401  * Check to see if we should refuse this option
 402  **/
 403 static int check_refuse_options(char *ref, int opt)
 404 {
 405         int i, len;
 406         char *p;
 407         const char *name;
 408
 409         for (i=0; long_options[i].longName; i++) {
 410                 if (long_options[i].val == opt) break;
 411         }
 412
 413         if (!long_options[i].longName) return 0;
 414
 415         name = long_options[i].longName;
 416         len = strlen(name);
 417
 418         while ((p = strstr(ref,name))) {
 419                 if ((p==ref || p[-1]==' ') &&
 420                     (p[len] == ' ' || p[len] == 0)) {
 421                         snprintf(err_buf,sizeof(err_buf),
 422                                  "The '%s' option is not supported by this server\n", name);
 423                         return 1;
 424                 }
 425                 ref += len;
 426         }
 427         return 0;
 428 }
 429
 430
 431 static int count_args(char const **argv)
 432 {
 433         int i = 0;
 434
 435         while (argv[i] != NULL)
 436                 i++;
 437
 438         return i;
 439 }
 440
 441
 442 /**
 443  * Process command line arguments.  Called on both local and remote.
 444  *
 445  * @retval 1 if all options are OK; with globals set to appropriate
 446  * values
 447  *
 448  * @retval 0 on error, with err_buf containing an explanation
 449  **/
 450 int parse_arguments(int *argc, const char ***argv, int frommain)
 451 {
 452         int opt;
 453         char *ref = lp_refuse_options(module_id);
 454         poptContext pc;
 455
 456         /* TODO: Call poptReadDefaultConfig; handle errors. */
 457
 458         /* The context leaks in case of an error, but if there's a
 459          * problem we always exit anyhow. */
 460         pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
 461
 462         while ((opt = poptGetNextOpt(pc)) != -1) {
 463                 if (ref) {
 464                         if (check_refuse_options(ref, opt)) return 0;
 465                 }
 466
 467                 /* most options are handled automatically by popt;
 468                  * only special cases are returned and listed here. */
 469
 470                 switch (opt) {
 471                 case OPT_VERSION:
 472                         print_rsync_version(FINFO);
 473                         exit_cleanup(0);
 474
 475                 case OPT_SUFFIX:
 476                         /* The value has already been set by popt, but
 477                          * we need to remember that a suffix was specified
 478                          * in case a backup-directory is used. */
 479                         suffix_specified = 1;
 480                         break;
 481
 482                 case OPT_MODIFY_WINDOW:
 483                         /* The value has already been set by popt, but
 484                          * we need to remember that we're using a
 485                          * non-default setting. */
 486                         modify_window_set = 1;
 487                         break;
 488
 489                 case OPT_DELETE_AFTER:
 490                         delete_after = 1;
 491                         delete_mode = 1;
 492                         break;
 493
 494                 case OPT_DELETE_EXCLUDED:
 495                         delete_excluded = 1;
 496                         delete_mode = 1;
 497                         break;
 498
 499                 case OPT_EXCLUDE:
 500                         add_exclude(poptGetOptArg(pc), 0);
 501                         break;
 502
 503                 case OPT_INCLUDE:
 504                         add_exclude(poptGetOptArg(pc), 1);
 505                         break;
 506
 507                 case OPT_EXCLUDE_FROM:
 508                         add_exclude_file(poptGetOptArg(pc), 1, 0);
 509                         break;
 510
 511                 case OPT_INCLUDE_FROM:
 512                         add_exclude_file(poptGetOptArg(pc), 1, 1);
 513                         break;
 514
 515                 case OPT_WHOLE_FILE:
 516                         whole_file = 1;
 517                         no_whole_file = 0;
 518                         break;
 519
 520                 case OPT_NO_WHOLE_FILE:
 521                         no_whole_file = 1;
 522                         whole_file = 0;
 523                         break;
 524
 525                 case OPT_NO_BLOCKING_IO:
 526                         blocking_io = 0;
 527                         break;
 528
 529                 case 'h':
 530                         usage(FINFO);
 531                         exit_cleanup(0);
 532
 533                 case 'H':
 534 #if SUPPORT_HARD_LINKS
 535                         preserve_hard_links=1;
 536 #else
 537                         /* FIXME: Don't say "server" if this is
 538                          * happening on the client. */
 539                         /* FIXME: Why do we have the duplicated
 540                          * rprintf?  Everybody who gets this message
 541                          * ought to send it to the client and also to
 542                          * the logs. */
 543                         snprintf(err_buf,sizeof(err_buf),
 544                                  "hard links are not supported on this %s\n",
 545                                  am_server ? "server" : "client");
 546                         rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
 547                         return 0;
 548 #endif /* SUPPORT_HARD_LINKS */
 549                         break;
 550
 551                 case 'v':
 552                         verbose++;
 553                         break;
 554
 555                 case 'q':
 556                         if (frommain) quiet++;
 557                         break;
 558
 559                 case 'a':
 560                         recurse=1;
 561 #if SUPPORT_LINKS
 562                         preserve_links=1;
 563 #endif
 564                         preserve_perms=1;
 565                         preserve_times=1;
 566                         preserve_gid=1;
 567                         preserve_uid=1;
 568                         preserve_devices=1;
 569                         break;
 570
 571                 case OPT_SENDER:
 572                         if (!am_server) {
 573                                 usage(FERROR);
 574                                 exit_cleanup(RERR_SYNTAX);
 575                         }
 576                         am_sender = 1;
 577                         break;
 578
 579                 case 'P':
 580                         do_progress = 1;
 581                         keep_partial = 1;
 582                         break;
 583
 584                 case OPT_WRITE_BATCH:
 585                         /* popt stores the filename in batch_prefix for us */
 586                         write_batch = 1;
 587                         break;
 588
 589                 case OPT_READ_BATCH:
 590                         /* popt stores the filename in batch_prefix for us */
 591                         read_batch = 1;
 592                         break;
 593
 594                 default:
 595                         /* FIXME: If --daemon is specified, then errors for later
 596                          * parameters seem to disappear. */
 597                         snprintf(err_buf, sizeof(err_buf),
 598                                  "%s%s: %s\n",
 599                                  am_server ? "on remote machine: " : "",
 600                                  poptBadOption(pc, POPT_BADOPTION_NOALIAS),
 601                                  poptStrerror(opt));
 602                         return 0;
 603                 }
 604         }
 605
 606         if (write_batch && read_batch) {
 607             snprintf(err_buf,sizeof(err_buf),
 608                 "write-batch and read-batch can not be used together\n");
 609             rprintf(FERROR,"ERROR: write-batch and read-batch"
 610                 " can not be used together\n");
 611             return 0;
 612         }
 613
 614         if (do_compression && (write_batch || read_batch)) {
 615             snprintf(err_buf,sizeof(err_buf),
 616                 "compress can not be used with write-batch or read-batch\n");
 617             rprintf(FERROR,"ERROR: compress can not be used with"
 618                 "  write-batch or read-batch\n");
 619             return 0;
 620         }
 621
 622         *argv = poptGetArgs(pc);
 623         if (*argv)
 624                 *argc = count_args(*argv);
 625         else
 626                 *argc = 0;
 627
 628         return 1;
 629 }
 630
 631
 632 /**
 633  * Construct a filtered list of options to pass through from the
 634  * client to the server.
 635  *
 636  * This involves setting options that will tell the server how to
 637  * behave, and also filtering out options that are processed only
 638  * locally.
 639  **/
 640 void server_options(char **args,int *argc)
 641 {
 642         int ac = *argc;
 643         static char argstr[50];
 644         static char bsize[30];
 645         static char iotime[30];
 646         static char mdelete[30];
 647         static char mwindow[30];
 648         static char bw[50];
 649         /* Leave room for ``--(write|read)-batch='' */
 650         static char fext[MAXPATHLEN + 15];
 651
 652         int i, x;
 653
 654         if (blocking_io == -1)
 655                 blocking_io = 0;
 656
 657         args[ac++] = "--server";
 658
 659         if (daemon_over_rsh) {
 660                 args[ac++] = "--daemon";
 661                 *argc = ac;
 662                 /* if we're passing --daemon, we're done */
 663                 return;
 664         }
 665
 666         if (!am_sender)
 667                 args[ac++] = "--sender";
 668
 669         x = 1;
 670         argstr[0] = '-';
 671         for (i=0;i<verbose;i++)
 672                 argstr[x++] = 'v';
 673
 674         /* the -q option is intentionally left out */
 675         if (make_backups)
 676                 argstr[x++] = 'b';
 677         if (update_only)
 678                 argstr[x++] = 'u';
 679         if (dry_run)
 680                 argstr[x++] = 'n';
 681         if (preserve_links)
 682                 argstr[x++] = 'l';
 683         if (copy_links)
 684                 argstr[x++] = 'L';
 685
 686         assert(whole_file == 0 || whole_file == 1);
 687         if (whole_file)
 688                 argstr[x++] = 'W';
 689         /* We don't need to send --no-whole-file, because it's the
 690          * default for remote transfers, and in any case old versions
 691          * of rsync will not understand it. */
 692
 693         if (preserve_hard_links)
 694                 argstr[x++] = 'H';
 695         if (preserve_uid)
 696                 argstr[x++] = 'o';
 697         if (preserve_gid)
 698                 argstr[x++] = 'g';
 699         if (preserve_devices)
 700                 argstr[x++] = 'D';
 701         if (preserve_times)
 702                 argstr[x++] = 't';
 703         if (preserve_perms)
 704                 argstr[x++] = 'p';
 705         if (recurse)
 706                 argstr[x++] = 'r';
 707         if (always_checksum)
 708                 argstr[x++] = 'c';
 709         if (cvs_exclude)
 710                 argstr[x++] = 'C';
 711         if (ignore_times)
 712                 argstr[x++] = 'I';
 713         if (relative_paths)
 714                 argstr[x++] = 'R';
 715         if (one_file_system)
 716                 argstr[x++] = 'x';
 717         if (sparse_files)
 718                 argstr[x++] = 'S';
 719         if (do_compression)
 720                 argstr[x++] = 'z';
 721
 722         /* this is a complete hack - blame Rusty
 723
 724            this is a hack to make the list_only (remote file list)
 725            more useful */
 726         if (list_only && !recurse)
 727                 argstr[x++] = 'r';
 728
 729         argstr[x] = 0;
 730
 731         if (x != 1) args[ac++] = argstr;
 732
 733         if (block_size != BLOCK_SIZE) {
 734                 snprintf(bsize,sizeof(bsize),"-B%d",block_size);
 735                 args[ac++] = bsize;
 736         }
 737
 738         if (max_delete && am_sender) {
 739                 snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
 740                 args[ac++] = mdelete;
 741         }
 742
 743         if (batch_prefix != NULL) {
 744                 char *fmt = "";
 745                 if (write_batch)
 746                     fmt = "--write-batch=%s";
 747                 else
 748                 if (read_batch)
 749                     fmt = "--read-batch=%s";
 750                 snprintf(fext,sizeof(fext),fmt,batch_prefix);
 751                 args[ac++] = fext;
 752         }
 753
 754         if (io_timeout) {
 755                 snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
 756                 args[ac++] = iotime;
 757         }
 758
 759         if (bwlimit) {
 760                 snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
 761                 args[ac++] = bw;
 762         }
 763
 764         if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
 765                 args[ac++] = "--suffix";
 766                 args[ac++] = backup_suffix;
 767         }
 768
 769         if (delete_mode && !delete_excluded)
 770                 args[ac++] = "--delete";
 771
 772         if (delete_excluded)
 773                 args[ac++] = "--delete-excluded";
 774
 775         if (size_only)
 776                 args[ac++] = "--size-only";
 777
 778         if (modify_window_set) {
 779                 snprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
 780                          modify_window);
 781                 args[ac++] = mwindow;
 782         }
 783
 784         if (keep_partial)
 785                 args[ac++] = "--partial";
 786
 787         if (force_delete)
 788                 args[ac++] = "--force";
 789
 790         if (delete_after)
 791                 args[ac++] = "--delete-after";
 792
 793         if (ignore_errors)
 794                 args[ac++] = "--ignore-errors";
 795
 796         if (copy_unsafe_links)
 797                 args[ac++] = "--copy-unsafe-links";
 798
 799         if (safe_symlinks)
 800                 args[ac++] = "--safe-links";
 801
 802         if (numeric_ids)
 803                 args[ac++] = "--numeric-ids";
 804
 805         if (only_existing && am_sender)
 806                 args[ac++] = "--existing";
 807
 808         if (opt_ignore_existing && am_sender)
 809                 args[ac++] = "--ignore-existing";
 810
 811         if (tmpdir) {
 812                 args[ac++] = "--temp-dir";
 813                 args[ac++] = tmpdir;
 814         }
 815
 816         if (backup_dir && am_sender) {
 817                 /* only the receiver needs this option, if we are the sender
 818                  *   then we need to send it to the receiver.
 819                  */
 820                 args[ac++] = "--backup-dir";
 821                 args[ac++] = backup_dir;
 822         }
 823
 824         if (compare_dest && am_sender) {
 825                 /* the server only needs this option if it is not the sender,
 826                  *   and it may be an older version that doesn't know this
 827                  *   option, so don't send it if client is the sender.
 828                  */
 829                 args[ac++] = "--compare-dest";
 830                 args[ac++] = compare_dest;
 831         }
 832
 833         *argc = ac;
 834 }
 835