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  * Should we send the whole file as literal data rather than trying to
  28  * create an incremental diff?  This is on by default when both source
  29  * and destination are local and we're not doing a batch delta,
  30  * because there it's no cheaper to read the whole basis file than to
  31  * just rewrite it.
  32  *
  33  * If both are 0, then look at whether we're local or remote and go by
  34  * that.
  35  **/
  36 int whole_file = 0;
  37 int no_whole_file = 0;
  38
  39 int copy_links = 0;
  40 int preserve_links = 0;
  41 int preserve_hard_links = 0;
  42 int preserve_perms = 0;
  43 int preserve_devices = 0;
  44 int preserve_uid = 0;
  45 int preserve_gid = 0;
  46 int preserve_times = 0;
  47 int update_only = 0;
  48 int cvs_exclude = 0;
  49 int dry_run=0;
  50 int local_server=0;
  51 int ignore_times=0;
  52 int delete_mode=0;
  53 int delete_excluded=0;
  54 int one_file_system=0;
  55 int remote_version=0;
  56 int sparse_files=0;
  57 int do_compression=0;
  58 int am_root=0;
  59 int orig_umask=0;
  60 int relative_paths=0;
  61 int numeric_ids = 0;
  62 int force_delete = 0;
  63 int io_timeout = 0;
  64 int io_error = 0;
  65 int read_only = 0;
  66 int module_id = -1;
  67 int am_server = 0;
  68 int am_sender = 0;
  69 int recurse = 0;
  70 int am_daemon=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
 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 rsh replacement\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,     0, 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,   &delete_after , 0, 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 /* We store the option error message, if any, so that we can log the
 381    connection attempt (which requires parsing the options), and then
 382    show the error later on. */
 383 void option_error(void)
 384 {
 385         if (err_buf[0]) {
 386                 rprintf(FLOG, "%s", err_buf);
 387                 rprintf(FERROR, "%s: %s", RSYNC_NAME, err_buf);
 388         } else {
 389                 rprintf (FERROR, "Error parsing options: "
 390                          "option may be supported on client but not on server?\n");
 391                 rprintf (FERROR, RSYNC_NAME ": Error parsing options: "
 392                          "option may be supported on client but not on server?\n");
 393         }
 394 }
 395
 396 /* check to see if we should refuse this option */
 397 static int check_refuse_options(char *ref, int opt)
 398 {
 399         int i, len;
 400         char *p;
 401         const char *name;
 402
 403         for (i=0; long_options[i].longName; i++) {
 404                 if (long_options[i].val == opt) break;
 405         }
 406
 407         if (!long_options[i].longName) return 0;
 408
 409         name = long_options[i].longName;
 410         len = strlen(name);
 411
 412         while ((p = strstr(ref,name))) {
 413                 if ((p==ref || p[-1]==' ') &&
 414                     (p[len] == ' ' || p[len] == 0)) {
 415                         snprintf(err_buf,sizeof(err_buf),
 416                                  "The '%s' option is not supported by this server\n", name);
 417                         return 1;
 418                 }
 419                 ref += len;
 420         }
 421         return 0;
 422 }
 423
 424
 425 static int count_args(char const **argv)
 426 {
 427         int i = 0;
 428
 429         while (argv[i] != NULL)
 430                 i++;
 431
 432         return i;
 433 }
 434
 435
 436 /* Process command line arguments.  Called on both local and remote.
 437  * Returns if all options are OK, otherwise fills in err_buf and
 438  * returns 0. */
 439 int parse_arguments(int *argc, const char ***argv, int frommain)
 440 {
 441         int opt;
 442         char *ref = lp_refuse_options(module_id);
 443         poptContext pc;
 444
 445         /* TODO: Call poptReadDefaultConfig; handle errors. */
 446
 447         /* The context leaks in case of an error, but if there's a
 448          * problem we always exit anyhow. */
 449         pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
 450
 451         while ((opt = poptGetNextOpt(pc)) != -1) {
 452                 if (ref) {
 453                         if (check_refuse_options(ref, opt)) return 0;
 454                 }
 455
 456                 /* most options are handled automatically by popt;
 457                  * only special cases are returned and listed here. */
 458
 459                 switch (opt) {
 460                 case OPT_VERSION:
 461                         print_rsync_version(FINFO);
 462                         exit_cleanup(0);
 463
 464                 case OPT_MODIFY_WINDOW:
 465                         /* The value has already been set by popt, but
 466                          * we need to remember that we're using a
 467                          * non-default setting. */
 468                         modify_window_set = 1;
 469                         break;
 470
 471                 case OPT_DELETE_EXCLUDED:
 472                         delete_excluded = 1;
 473                         delete_mode = 1;
 474                         break;
 475
 476                 case OPT_EXCLUDE:
 477                         add_exclude(poptGetOptArg(pc), 0);
 478                         break;
 479
 480                 case OPT_INCLUDE:
 481                         add_exclude(poptGetOptArg(pc), 1);
 482                         break;
 483
 484                 case OPT_EXCLUDE_FROM:
 485                         add_exclude_file(poptGetOptArg(pc), 1, 0);
 486                         break;
 487
 488                 case OPT_INCLUDE_FROM:
 489                         add_exclude_file(poptGetOptArg(pc), 1, 1);
 490                         break;
 491
 492                 case OPT_WHOLE_FILE:
 493                         whole_file = 1;
 494                         no_whole_file = 0;
 495                         break;
 496
 497                 case OPT_NO_WHOLE_FILE:
 498                         no_whole_file = 1;
 499                         whole_file = 0;
 500                         break;
 501
 502                 case OPT_NO_BLOCKING_IO:
 503                         blocking_io = 0;
 504                         break;
 505
 506                 case 'h':
 507                         usage(FINFO);
 508                         exit_cleanup(0);
 509
 510                 case 'H':
 511 #if SUPPORT_HARD_LINKS
 512                         preserve_hard_links=1;
 513 #else
 514                         /* FIXME: Don't say "server" if this is
 515                          * happening on the client. */
 516                         /* FIXME: Why do we have the duplicated
 517                          * rprintf?  Everybody who gets this message
 518                          * ought to send it to the client and also to
 519                          * the logs. */
 520                         snprintf(err_buf,sizeof(err_buf),
 521                                  "hard links are not supported on this %s\n",
 522                                  am_server ? "server" : "client");
 523                         rprintf(FERROR,"ERROR: hard links not supported on this platform\n");
 524                         return 0;
 525 #endif /* SUPPORT_HARD_LINKS */
 526                         break;
 527
 528                 case 'v':
 529                         verbose++;
 530                         break;
 531
 532                 case 'q':
 533                         if (frommain) quiet++;
 534                         break;
 535
 536                 case 'a':
 537                         recurse=1;
 538 #if SUPPORT_LINKS
 539                         preserve_links=1;
 540 #endif
 541                         preserve_perms=1;
 542                         preserve_times=1;
 543                         preserve_gid=1;
 544                         preserve_uid=1;
 545                         preserve_devices=1;
 546                         break;
 547
 548                 case OPT_SENDER:
 549                         if (!am_server) {
 550                                 usage(FERROR);
 551                                 exit_cleanup(RERR_SYNTAX);
 552                         }
 553                         am_sender = 1;
 554                         break;
 555
 556                 case 'P':
 557                         do_progress = 1;
 558                         keep_partial = 1;
 559                         break;
 560
 561                 case OPT_WRITE_BATCH:
 562                         /* popt stores the filename in batch_prefix for us */
 563                         write_batch = 1;
 564                         break;
 565
 566                 case OPT_READ_BATCH:
 567                         /* popt stores the filename in batch_prefix for us */
 568                         read_batch = 1;
 569                         break;
 570
 571                 default:
 572                         /* FIXME: If --daemon is specified, then errors for later
 573                          * parameters seem to disappear. */
 574                         snprintf(err_buf, sizeof(err_buf),
 575                                  "%s%s: %s\n",
 576                                  am_server ? "on remote machine: " : "",
 577                                  poptBadOption(pc, POPT_BADOPTION_NOALIAS),
 578                                  poptStrerror(opt));
 579                         return 0;
 580                 }
 581         }
 582
 583         if (write_batch && read_batch) {
 584             snprintf(err_buf,sizeof(err_buf),
 585                 "write-batch and read-batch can not be used together\n");
 586             rprintf(FERROR,"ERROR: write-batch and read-batch"
 587                 " can not be used together\n");
 588             return 0;
 589         }
 590
 591         if (do_compression && (write_batch || read_batch)) {
 592             snprintf(err_buf,sizeof(err_buf),
 593                 "compress can not be used with write-batch or read-batch\n");
 594             rprintf(FERROR,"ERROR: compress can not be used with"
 595                 "  write-batch or read-batch\n");
 596             return 0;
 597         }
 598
 599         *argv = poptGetArgs(pc);
 600         if (*argv)
 601                 *argc = count_args(*argv);
 602         else
 603                 *argc = 0;
 604
 605         return 1;
 606 }
 607
 608
 609 /* Construct a filtered list of options to pass through from the
 610  * client to the server */
 611 void server_options(char **args,int *argc)
 612 {
 613         int ac = *argc;
 614         static char argstr[50];
 615         static char bsize[30];
 616         static char iotime[30];
 617         static char mdelete[30];
 618         static char mwindow[30];
 619         static char bw[50];
 620         /* Leave room for ``--(write|read)-batch='' */
 621         static char fext[MAXPATHLEN + 15];
 622
 623         int i, x;
 624
 625         if (blocking_io == -1)
 626                 blocking_io = 0;
 627
 628         args[ac++] = "--server";
 629
 630         if (!am_sender)
 631                 args[ac++] = "--sender";
 632
 633         x = 1;
 634         argstr[0] = '-';
 635         for (i=0;i<verbose;i++)
 636                 argstr[x++] = 'v';
 637
 638         /* the -q option is intentionally left out */
 639         if (make_backups)
 640                 argstr[x++] = 'b';
 641         if (update_only)
 642                 argstr[x++] = 'u';
 643         if (dry_run)
 644                 argstr[x++] = 'n';
 645         if (preserve_links)
 646                 argstr[x++] = 'l';
 647         if (copy_links)
 648                 argstr[x++] = 'L';
 649
 650         assert(whole_file == 0 || whole_file == 1);
 651         if (whole_file)
 652                 argstr[x++] = 'W';
 653         /* We don't need to send --no-whole-file, because it's the
 654          * default for remote transfers, and in any case old versions
 655          * of rsync will not understand it. */
 656
 657         if (preserve_hard_links)
 658                 argstr[x++] = 'H';
 659         if (preserve_uid)
 660                 argstr[x++] = 'o';
 661         if (preserve_gid)
 662                 argstr[x++] = 'g';
 663         if (preserve_devices)
 664                 argstr[x++] = 'D';
 665         if (preserve_times)
 666                 argstr[x++] = 't';
 667         if (preserve_perms)
 668                 argstr[x++] = 'p';
 669         if (recurse)
 670                 argstr[x++] = 'r';
 671         if (always_checksum)
 672                 argstr[x++] = 'c';
 673         if (cvs_exclude)
 674                 argstr[x++] = 'C';
 675         if (ignore_times)
 676                 argstr[x++] = 'I';
 677         if (relative_paths)
 678                 argstr[x++] = 'R';
 679         if (one_file_system)
 680                 argstr[x++] = 'x';
 681         if (sparse_files)
 682                 argstr[x++] = 'S';
 683         if (do_compression)
 684                 argstr[x++] = 'z';
 685
 686         /* this is a complete hack - blame Rusty
 687
 688            this is a hack to make the list_only (remote file list)
 689            more useful */
 690         if (list_only && !recurse)
 691                 argstr[x++] = 'r';
 692
 693         argstr[x] = 0;
 694
 695         if (x != 1) args[ac++] = argstr;
 696
 697         if (block_size != BLOCK_SIZE) {
 698                 snprintf(bsize,sizeof(bsize),"-B%d",block_size);
 699                 args[ac++] = bsize;
 700         }
 701
 702         if (max_delete && am_sender) {
 703                 snprintf(mdelete,sizeof(mdelete),"--max-delete=%d",max_delete);
 704                 args[ac++] = mdelete;
 705         }
 706
 707         if (batch_prefix != NULL) {
 708                 char *fmt = "";
 709                 if (write_batch)
 710                     fmt = "--write-batch=%s";
 711                 else
 712                 if (read_batch)
 713                     fmt = "--read-batch=%s";
 714                 snprintf(fext,sizeof(fext),fmt,batch_prefix);
 715                 args[ac++] = fext;
 716         }
 717
 718         if (io_timeout) {
 719                 snprintf(iotime,sizeof(iotime),"--timeout=%d",io_timeout);
 720                 args[ac++] = iotime;
 721         }
 722
 723         if (bwlimit) {
 724                 snprintf(bw,sizeof(bw),"--bwlimit=%d",bwlimit);
 725                 args[ac++] = bw;
 726         }
 727
 728         if (strcmp(backup_suffix, BACKUP_SUFFIX)) {
 729                 args[ac++] = "--suffix";
 730                 args[ac++] = backup_suffix;
 731         }
 732
 733         if (delete_mode && !delete_excluded)
 734                 args[ac++] = "--delete";
 735
 736         if (delete_excluded)
 737                 args[ac++] = "--delete-excluded";
 738
 739         if (size_only)
 740                 args[ac++] = "--size-only";
 741
 742         if (modify_window_set) {
 743                 snprintf(mwindow,sizeof(mwindow),"--modify-window=%d",
 744                          modify_window);
 745                 args[ac++] = mwindow;
 746         }
 747
 748         if (keep_partial)
 749                 args[ac++] = "--partial";
 750
 751         if (force_delete)
 752                 args[ac++] = "--force";
 753
 754         if (delete_after)
 755                 args[ac++] = "--delete-after";
 756
 757         if (ignore_errors)
 758                 args[ac++] = "--ignore-errors";
 759
 760         if (copy_unsafe_links)
 761                 args[ac++] = "--copy-unsafe-links";
 762
 763         if (safe_symlinks)
 764                 args[ac++] = "--safe-links";
 765
 766         if (numeric_ids)
 767                 args[ac++] = "--numeric-ids";
 768
 769         if (only_existing && am_sender)
 770                 args[ac++] = "--existing";
 771
 772         if (opt_ignore_existing && am_sender)
 773                 args[ac++] = "--ignore-existing";
 774
 775         if (tmpdir) {
 776                 args[ac++] = "--temp-dir";
 777                 args[ac++] = tmpdir;
 778         }
 779
 780         if (backup_dir && am_sender) {
 781                 /* only the receiver needs this option, if we are the sender
 782                  *   then we need to send it to the receiver.
 783                  */
 784                 args[ac++] = "--backup-dir";
 785                 args[ac++] = backup_dir;
 786         }
 787
 788         if (compare_dest && am_sender) {
 789                 /* the server only needs this option if it is not the sender,
 790                  *   and it may be an older version that doesn't know this
 791                  *   option, so don't send it if client is the sender.
 792                  */
 793                 args[ac++] = "--compare-dest";
 794                 args[ac++] = compare_dest;
 795         }
 796
 797         *argc = ac;
 798 }
 799