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