options.c

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