batch.c

   1 /*
   2  * Support for the batch-file options.
   3  *
   4  * Copyright (C) 1999 Weiss
   5  * Copyright (C) 2004 Chris Shoemaker
   6  * Copyright (C) 2004-2020 Wayne Davison
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, visit the http://fsf.org website.
  20  */
  21
  22 #include "rsync.h"
  23 #include <zlib.h>
  24 #include <time.h>
  25
  26 extern int eol_nulls;
  27 extern int recurse;
  28 extern int xfer_dirs;
  29 extern int preserve_links;
  30 extern int preserve_hard_links;
  31 extern int preserve_devices;
  32 extern int preserve_uid;
  33 extern int preserve_gid;
  34 extern int preserve_acls;
  35 extern int preserve_xattrs;
  36 extern int always_checksum;
  37 extern int do_compression;
  38 extern int inplace;
  39 extern int append_mode;
  40 extern int write_batch;
  41 extern int protocol_version;
  42 extern int raw_argc, cooked_argc;
  43 extern char **raw_argv, **cooked_argv;
  44 extern char *batch_name;
  45 extern const char *checksum_choice;
  46 extern const char *compress_choice;
  47 #ifdef ICONV_OPTION
  48 extern char *iconv_opt;
  49 #endif
  50
  51 extern filter_rule_list filter_list;
  52
  53 int batch_fd = -1;
  54 int batch_sh_fd = -1;
  55 int batch_stream_flags;
  56
  57 static int tweaked_append;
  58 static int tweaked_append_verify;
  59 static int tweaked_iconv;
  60
  61 static int *flag_ptr[] = {
  62         &recurse,               /* 0 */
  63         &preserve_uid,          /* 1 */
  64         &preserve_gid,          /* 2 */
  65         &preserve_links,        /* 3 */
  66         &preserve_devices,      /* 4 */
  67         &preserve_hard_links,   /* 5 */
  68         &always_checksum,       /* 6 */
  69         &xfer_dirs,             /* 7 (protocol 29) */
  70         &do_compression,        /* 8 (protocol 29) */
  71         &tweaked_iconv,         /* 9  (protocol 30) */
  72         &preserve_acls,         /* 10 (protocol 30) */
  73         &preserve_xattrs,       /* 11 (protocol 30) */
  74         &inplace,               /* 12 (protocol 30) */
  75         &tweaked_append,        /* 13 (protocol 30) */
  76         &tweaked_append_verify, /* 14 (protocol 30) */
  77         NULL
  78 };
  79
  80 static char *flag_name[] = {
  81         "--recurse (-r)",
  82         "--owner (-o)",
  83         "--group (-g)",
  84         "--links (-l)",
  85         "--devices (-D)",
  86         "--hard-links (-H)",
  87         "--checksum (-c)",
  88         "--dirs (-d)",
  89         "--compress (-z)",
  90         "--iconv",
  91         "--acls (-A)",
  92         "--xattrs (-X)",
  93         "--inplace",
  94         "--append",
  95         "--append-verify",
  96         NULL
  97 };
  98
  99 void write_stream_flags(int fd)
 100 {
 101         int i, flags;
 102
 103         tweaked_append = append_mode == 1;
 104         tweaked_append_verify = append_mode == 2;
 105 #ifdef ICONV_OPTION
 106         tweaked_iconv = iconv_opt != NULL;
 107 #endif
 108
 109         /* Start the batch file with a bitmap of data-stream-affecting
 110          * flags. */
 111         for (i = 0, flags = 0; flag_ptr[i]; i++) {
 112                 if (*flag_ptr[i])
 113                         flags |= 1 << i;
 114         }
 115         write_int(fd, flags);
 116 }
 117
 118 void read_stream_flags(int fd)
 119 {
 120         batch_stream_flags = read_int(fd);
 121 }
 122
 123 void check_batch_flags(void)
 124 {
 125         int i;
 126
 127         if (protocol_version < 29)
 128                 flag_ptr[7] = NULL;
 129         else if (protocol_version < 30)
 130                 flag_ptr[9] = NULL;
 131         tweaked_append = append_mode == 1;
 132         tweaked_append_verify = append_mode == 2;
 133 #ifdef ICONV_OPTION
 134         tweaked_iconv = iconv_opt != NULL;
 135 #endif
 136         for (i = 0; flag_ptr[i]; i++) {
 137                 int set = batch_stream_flags & (1 << i) ? 1 : 0;
 138                 if (*flag_ptr[i] != set) {
 139                         if (i == 9) {
 140                                 rprintf(FERROR,
 141                                         "%s specify the --iconv option to use this batch file.\n",
 142                                         set ? "Please" : "Do not");
 143                                 exit_cleanup(RERR_SYNTAX);
 144                         }
 145                         if (INFO_GTE(MISC, 1)) {
 146                                 rprintf(FINFO,
 147                                         "%sing the %s option to match the batchfile.\n",
 148                                         set ? "Sett" : "Clear", flag_name[i]);
 149                         }
 150                         *flag_ptr[i] = set;
 151                 }
 152         }
 153         if (protocol_version < 29) {
 154                 if (recurse)
 155                         xfer_dirs |= 1;
 156                 else if (xfer_dirs < 2)
 157                         xfer_dirs = 0;
 158         }
 159
 160         if (tweaked_append)
 161                 append_mode = 1;
 162         else if (tweaked_append_verify)
 163                 append_mode = 2;
 164 }
 165
 166 static int write_arg(const char *arg)
 167 {
 168         const char *x, *s;
 169         int len, err = 0;
 170
 171         if (*arg == '-' && (x = strchr(arg, '=')) != NULL) {
 172                 err |= write(batch_sh_fd, arg, x - arg + 1) != x - arg + 1;
 173                 arg += x - arg + 1;
 174         }
 175
 176         if (strpbrk(arg, " \"'&;|[]()$#!*?^\\") != NULL) {
 177                 err |= write(batch_sh_fd, "'", 1) != 1;
 178                 for (s = arg; (x = strchr(s, '\'')) != NULL; s = x + 1) {
 179                         err |= write(batch_sh_fd, s, x - s + 1) != x - s + 1;
 180                         err |= write(batch_sh_fd, "'", 1) != 1;
 181                 }
 182                 len = strlen(s);
 183                 err |= write(batch_sh_fd, s, len) != len;
 184                 err |= write(batch_sh_fd, "'", 1) != 1;
 185                 return err;
 186         }
 187
 188         len = strlen(arg);
 189         err |= write(batch_sh_fd, arg, len) != len;
 190
 191         return err;
 192 }
 193
 194 /* Writes out a space and then an option (or other string) with an optional "=" + arg suffix. */
 195 static int write_opt(const char *opt, const char *arg)
 196 {
 197         int len = strlen(opt);
 198         int err = write(batch_sh_fd, " ", 1) != 1;
 199         err = write(batch_sh_fd, opt, len) != len ? 1 : 0;
 200         if (arg) {
 201                 err |= write(batch_sh_fd, "=", 1) != 1;
 202                 err |= write_arg(arg);
 203         }
 204         return err;
 205 }
 206
 207 static void write_filter_rules(int fd)
 208 {
 209         filter_rule *ent;
 210
 211         write_sbuf(fd, " <<'#E#'\n");
 212         for (ent = filter_list.head; ent; ent = ent->next) {
 213                 unsigned int plen;
 214                 char *p = get_rule_prefix(ent, "- ", 0, &plen);
 215                 write_buf(fd, p, plen);
 216                 write_sbuf(fd, ent->pattern);
 217                 if (ent->rflags & FILTRULE_DIRECTORY)
 218                         write_byte(fd, '/');
 219                 write_byte(fd, eol_nulls ? 0 : '\n');
 220         }
 221         if (eol_nulls)
 222                 write_sbuf(fd, ";\n");
 223         write_sbuf(fd, "#E#");
 224 }
 225
 226 /* This sets batch_fd and (for --write-batch) batch_sh_fd. */
 227 void open_batch_files(void)
 228 {
 229         if (write_batch) {
 230                 char filename[MAXPATHLEN];
 231
 232                 stringjoin(filename, sizeof filename, batch_name, ".sh", NULL);
 233
 234                 batch_sh_fd = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR | S_IXUSR);
 235                 if (batch_sh_fd < 0) {
 236                         rsyserr(FERROR, errno, "Batch file %s open error", full_fname(filename));
 237                         exit_cleanup(RERR_FILESELECT);
 238                 }
 239
 240                 batch_fd = do_open(batch_name, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
 241         } else if (strcmp(batch_name, "-") == 0)
 242                 batch_fd = STDIN_FILENO;
 243         else
 244                 batch_fd = do_open(batch_name, O_RDONLY, S_IRUSR | S_IWUSR);
 245
 246         if (batch_fd < 0) {
 247                 rsyserr(FERROR, errno, "Batch file %s open error", full_fname(batch_name));
 248                 exit_cleanup(RERR_FILEIO);
 249         }
 250 }
 251
 252 /* This routine tries to write out an equivalent --read-batch command
 253  * given the user's --write-batch args.  However, it doesn't really
 254  * understand most of the options, so it uses some overly simple
 255  * heuristics to munge the command line into something that will
 256  * (hopefully) work. */
 257 void write_batch_shell_file(void)
 258 {
 259         int i, len, err = 0;
 260         char *p, *p2;
 261
 262         /* Write argvs info to BATCH.sh file */
 263         err |= write_arg(raw_argv[0]);
 264         if (filter_list.head) {
 265                 if (protocol_version >= 29)
 266                         err |= write_opt("--filter", "._-");
 267                 else
 268                         err |= write_opt("--exclude-from", "-");
 269         }
 270
 271         /* We need to make sure that any protocol-based or negotiated choices get accurately
 272          * reflected in the options we save AND that we avoid any need for --read-batch to
 273          * do a string-based negotation (since we don't write them into the file). */
 274         if (do_compression)
 275                 err |= write_opt("--compress-choice", compress_choice);
 276         err |= write_opt("--checksum-choice", checksum_choice);
 277
 278         for (i = 1; i < raw_argc; i++) {
 279                 p = raw_argv[i];
 280                 if (cooked_argc && p[0] == cooked_argv[0][0] && strcmp(p, cooked_argv[0]) == 0) {
 281                         cooked_argv++;
 282                         cooked_argc--;
 283                         continue;
 284                 }
 285                 if (strncmp(p, "--files-from", 12) == 0
 286                     || strncmp(p, "--filter", 8) == 0
 287                     || strncmp(p, "--include", 9) == 0
 288                     || strncmp(p, "--exclude", 9) == 0) {
 289                         if (strchr(p, '=') == NULL)
 290                                 i++;
 291                         continue;
 292                 }
 293                 if (strcmp(p, "-f") == 0) {
 294                         i++;
 295                         continue;
 296                 }
 297                 if (strncmp(p, "--write-batch", len = 13) == 0
 298                  || strncmp(p, "--only-write-batch", len = 18) == 0)
 299                         err |= write_opt("--read-batch", p[len] == '=' ? p + len + 1 : NULL);
 300                 else {
 301                         err |= write(batch_sh_fd, " ", 1) != 1;
 302                         err |= write_arg(p);
 303                 }
 304         }
 305         if (!(p = check_for_hostspec(cooked_argv[cooked_argc - 1], &p2, &i)))
 306                 p = cooked_argv[cooked_argc - 1];
 307         err |= write_opt("${1:-", NULL);
 308         err |= write_arg(p);
 309         err |= write(batch_sh_fd, "}", 1) != 1;
 310         if (filter_list.head)
 311                 write_filter_rules(batch_sh_fd);
 312         if (write(batch_sh_fd, "\n", 1) != 1 || close(batch_sh_fd) < 0 || err) {
 313                 rsyserr(FERROR, errno, "Batch file %s.sh write error", batch_name);
 314                 exit_cleanup(RERR_FILEIO);
 315         }
 316         batch_sh_fd = -1;
 317 }