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