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