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-2007 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/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 def_compress_level;
  39 extern int inplace;
  40 extern int append_mode;
  41 extern int protocol_version;
  42 extern char *batch_name;
  43 #ifdef ICONV_OPTION
  44 extern char *iconv_opt;
  45 #endif
  46
  47 extern struct filter_list_struct filter_list;
  48
  49 static int tweaked_compress_level;
  50 static int tweaked_append;
  51 static int tweaked_append_verify;
  52 static int tweaked_iconv;
  53
  54 static int *flag_ptr[] = {
  55         &recurse,               /* 0 */
  56         &preserve_uid,          /* 1 */
  57         &preserve_gid,          /* 2 */
  58         &preserve_links,        /* 3 */
  59         &preserve_devices,      /* 4 */
  60         &preserve_hard_links,   /* 5 */
  61         &always_checksum,       /* 6 */
  62         &xfer_dirs,             /* 7 (protocol 29) */
  63         &tweaked_compress_level,/* 8 (protocol 29) */
  64         &tweaked_iconv,         /* 9  (protocol 30) */
  65         &preserve_acls,         /* 10 (protocol 30) */
  66         &preserve_xattrs,       /* 11 (protocol 30) */
  67         &inplace,               /* 12 (protocol 30) */
  68         &tweaked_append,        /* 13 (protocol 30) */
  69         &tweaked_append_verify, /* 14 (protocol 30) */
  70         NULL
  71 };
  72
  73 static char *flag_name[] = {
  74         "--recurse (-r)",
  75         "--owner (-o)",
  76         "--group (-g)",
  77         "--links (-l)",
  78         "--devices (-D)",
  79         "--hard-links (-H)",
  80         "--checksum (-c)",
  81         "--dirs (-d)",
  82         "--compress (-z)",
  83         "--iconv",
  84         "--acls (-A)",
  85         "--xattrs (-X)",
  86         "--inplace",
  87         "--append",
  88         "--append-verify",
  89         NULL
  90 };
  91
  92 void write_stream_flags(int fd)
  93 {
  94         int i, flags;
  95
  96 #if Z_DEFAULT_COMPRESSION == -1
  97         tweaked_compress_level = do_compression ? def_compress_level + 2 : 0;
  98 #else
  99 #error internal logic error!  Fix def_compress_level logic above and below too!
 100 #endif
 101         tweaked_append = append_mode == 1;
 102         tweaked_append_verify = append_mode == 2;
 103 #ifdef ICONV_OPTION
 104         tweaked_iconv = iconv_opt != NULL;
 105 #endif
 106
 107         /* Start the batch file with a bitmap of data-stream-affecting
 108          * flags. */
 109         if (protocol_version < 29)
 110                 flag_ptr[7] = NULL;
 111         else if (protocol_version < 30)
 112                 flag_ptr[9] = NULL;
 113         for (i = 0, flags = 0; flag_ptr[i]; i++) {
 114                 if (*flag_ptr[i])
 115                         flags |= 1 << i;
 116         }
 117         write_int(fd, flags);
 118 }
 119
 120 void read_stream_flags(int fd)
 121 {
 122         int i, flags;
 123
 124         if (protocol_version < 29)
 125                 flag_ptr[7] = NULL;
 126         else if (protocol_version < 30)
 127                 flag_ptr[9] = NULL;
 128         tweaked_append = append_mode == 1;
 129         tweaked_append_verify = append_mode == 2;
 130 #ifdef ICONV_OPTION
 131         tweaked_iconv = iconv_opt != NULL;
 132 #endif
 133         for (i = 0, flags = read_int(fd); flag_ptr[i]; i++) {
 134                 int set = flags & (1 << i) ? 1 : 0;
 135                 if (*flag_ptr[i] != set) {
 136                         if (i == 9) {
 137                                 rprintf(FERROR,
 138                                         "%s specify the --iconv option to use this batch file.\n",
 139                                         set ? "Please" : "Do not");
 140                                 exit_cleanup(RERR_SYNTAX);
 141                         }
 142                         if (verbose) {
 143                                 rprintf(FINFO,
 144                                         "%sing the %s option to match the batchfile.\n",
 145                                         set ? "Sett" : "Clear", flag_name[i]);
 146                         }
 147                         *flag_ptr[i] = set;
 148                 }
 149         }
 150         if (protocol_version < 29) {
 151                 if (recurse)
 152                         xfer_dirs |= 1;
 153                 else if (xfer_dirs < 2)
 154                         xfer_dirs = 0;
 155         }
 156
 157         if (tweaked_compress_level == 0 || tweaked_compress_level == 2)
 158                 do_compression = 0;
 159         else {
 160                 do_compression = 1;
 161                 def_compress_level = tweaked_compress_level - 2;
 162         }
 163         if (tweaked_append)
 164                 append_mode = 1;
 165         else if (tweaked_append_verify)
 166                 append_mode = 2;
 167 }
 168
 169 static void write_arg(int fd, char *arg)
 170 {
 171         char *x, *s;
 172
 173         if (*arg == '-' && (x = strchr(arg, '=')) != NULL) {
 174                 write(fd, arg, x - arg + 1);
 175                 arg += x - arg + 1;
 176         }
 177
 178         if (strpbrk(arg, " \"'&;|[]()$#!*?^\\") != NULL) {
 179                 write(fd, "'", 1);
 180                 for (s = arg; (x = strchr(s, '\'')) != NULL; s = x + 1) {
 181                         write(fd, s, x - s + 1);
 182                         write(fd, "'", 1);
 183                 }
 184                 write(fd, s, strlen(s));
 185                 write(fd, "'", 1);
 186                 return;
 187         }
 188
 189         write(fd, arg, strlen(arg));
 190 }
 191
 192 static void write_filter_rules(int fd)
 193 {
 194         struct filter_struct *ent;
 195
 196         write_sbuf(fd, " <<'#E#'\n");
 197         for (ent = filter_list.head; ent; ent = ent->next) {
 198                 unsigned int plen;
 199                 char *p = get_rule_prefix(ent->match_flags, "- ", 0, &plen);
 200                 write_buf(fd, p, plen);
 201                 write_sbuf(fd, ent->pattern);
 202                 if (ent->match_flags & MATCHFLG_DIRECTORY)
 203                         write_byte(fd, '/');
 204                 write_byte(fd, eol_nulls ? 0 : '\n');
 205         }
 206         if (eol_nulls)
 207                 write_sbuf(fd, ";\n");
 208         write_sbuf(fd, "#E#");
 209 }
 210
 211 /* This routine tries to write out an equivalent --read-batch command
 212  * given the user's --write-batch args.  However, it doesn't really
 213  * understand most of the options, so it uses some overly simple
 214  * heuristics to munge the command line into something that will
 215  * (hopefully) work. */
 216 void write_batch_shell_file(int argc, char *argv[], int file_arg_cnt)
 217 {
 218         int fd, i, len;
 219         char *p, filename[MAXPATHLEN];
 220
 221         stringjoin(filename, sizeof filename,
 222                    batch_name, ".sh", NULL);
 223         fd = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
 224                      S_IRUSR | S_IWUSR | S_IEXEC);
 225         if (fd < 0) {
 226                 rsyserr(FERROR, errno, "Batch file %s open error",
 227                         filename);
 228                 exit_cleanup(RERR_FILESELECT);
 229         }
 230
 231         /* Write argvs info to BATCH.sh file */
 232         write_arg(fd, argv[0]);
 233         if (filter_list.head) {
 234                 if (protocol_version >= 29)
 235                         write_sbuf(fd, " --filter=._-");
 236                 else
 237                         write_sbuf(fd, " --exclude-from=-");
 238         }
 239         for (i = 1; i < argc - file_arg_cnt; i++) {
 240                 p = argv[i];
 241                 if (strncmp(p, "--files-from", 12) == 0
 242                     || strncmp(p, "--filter", 8) == 0
 243                     || strncmp(p, "--include", 9) == 0
 244                     || strncmp(p, "--exclude", 9) == 0) {
 245                         if (strchr(p, '=') == NULL)
 246                                 i++;
 247                         continue;
 248                 }
 249                 if (strcmp(p, "-f") == 0) {
 250                         i++;
 251                         continue;
 252                 }
 253                 write(fd, " ", 1);
 254                 if (strncmp(p, "--write-batch", len = 13) == 0
 255                  || strncmp(p, "--only-write-batch", len = 18) == 0) {
 256                         write(fd, "--read-batch", 12);
 257                         if (p[len] == '=') {
 258                                 write(fd, "=", 1);
 259                                 write_arg(fd, p + len + 1);
 260                         }
 261                 } else
 262                         write_arg(fd, p);
 263         }
 264         if (!(p = check_for_hostspec(argv[argc - 1], &p, &i)))
 265                 p = argv[argc - 1];
 266         write(fd, " ${1:-", 6);
 267         write_arg(fd, p);
 268         write_byte(fd, '}');
 269         if (filter_list.head)
 270                 write_filter_rules(fd);
 271         if (write(fd, "\n", 1) != 1 || close(fd) < 0) {
 272                 rsyserr(FERROR, errno, "Batch file %s write error",
 273                         filename);
 274                 exit_cleanup(RERR_FILEIO);
 275         }
 276 }