time-limit.diff

   1 John Taylor's patch for implementing --time-limit and --stop-at, reworked
   2 to be simpler and more efficient by Wayne Davison.
   3
   4 Do we need configure support for mktime()?
   5
   6 --- io.c        15 May 2004 19:31:10 -0000      1.121
   7 +++ io.c        17 May 2004 21:26:50 -0000
   8 @@ -44,6 +44,7 @@ static int io_multiplexing_in;
   9  static int multiplex_in_fd = -1;
  10  static int multiplex_out_fd = -1;
  11  static time_t last_io;
  12 +extern time_t stop_at_utime;
  13  static int no_flush;
  14
  15  extern int bwlimit;
  16 @@ -125,15 +126,20 @@ static void check_timeout(void)
  17  {
  18         time_t t;
  19
  20 -       if (!io_timeout)
  21 +       if (!io_timeout && !stop_at_utime)
  22                 return;
  23
  24 +       t = time(NULL);
  25 +
  26 +       if (stop_at_utime && t >= stop_at_utime) {
  27 +               rprintf(FERROR, "run-time limit exceeded\n");
  28 +               exit_cleanup(RERR_TIMEOUT);
  29 +       }
  30 +
  31         if (!last_io) {
  32 -               last_io = time(NULL);
  33 +               last_io = t;
  34                 return;
  35         }
  36 -
  37 -       t = time(NULL);
  38
  39         if (last_io && io_timeout && (t-last_io) >= io_timeout) {
  40                 if (!am_server && !am_daemon) {
  41 --- options.c   6 May 2004 21:08:01 -0000       1.148
  42 +++ options.c   17 May 2004 21:26:50 -0000
  43 @@ -92,6 +92,7 @@ int modify_window = 0;
  44  int blocking_io = -1;
  45  int checksum_seed = 0;
  46  unsigned int block_size = 0;
  47 +time_t stop_at_utime = 0;
  48
  49
  50  /** Network address family. **/
  51 @@ -288,6 +289,8 @@ void usage(enum logcode F)
  52    rprintf(F,"     --log-format=FORMAT     log file transfers using specified format\n");
  53    rprintf(F,"     --password-file=FILE    get password from FILE\n");
  54    rprintf(F,"     --bwlimit=KBPS          limit I/O bandwidth, KBytes per second\n");
  55 +  rprintf(F,"     --stop-at=y-m-dTh:m     Stop rsync at year-month-dayThour:minute\n");
  56 +  rprintf(F,"     --time-limit=MINS       Stop rsync after MINS minutes have elapsed\n");
  57    rprintf(F,"     --write-batch=PREFIX    write batch fileset starting with PREFIX\n");
  58    rprintf(F,"     --read-batch=PREFIX     read batch fileset starting with PREFIX\n");
  59  #ifdef INET6
  60 @@ -305,7 +308,7 @@ void usage(enum logcode F)
  61  enum {OPT_VERSION = 1000, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
  62        OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED, OPT_LINK_DEST,
  63        OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
  64 -      OPT_READ_BATCH, OPT_WRITE_BATCH,
  65 +      OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_STOP_AT, OPT_TIME_LIMIT,
  66        OPT_REFUSED_BASE = 9000};
  67
  68  static struct poptOption long_options[] = {
  69 @@ -377,6 +380,8 @@ static struct poptOption long_options[]
  70    {"port",             0,  POPT_ARG_INT,    &rsync_port, 0, 0, 0 },
  71    {"log-format",       0,  POPT_ARG_STRING, &log_format, 0, 0, 0 },
  72    {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
  73 +  {"stop-at",          0,  POPT_ARG_STRING, 0, OPT_STOP_AT, 0, 0 },
  74 +  {"time-limit",       0,  POPT_ARG_STRING, 0, OPT_TIME_LIMIT, 0, 0 },
  75    {"address",          0,  POPT_ARG_STRING, &bind_address, 0, 0, 0 },
  76    {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
  77    {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
  78 @@ -584,6 +589,36 @@ int parse_arguments(int *argc, const cha
  79                         return 0;
  80  #endif
  81
  82 +               case OPT_STOP_AT:
  83 +                       arg = poptGetOptArg(pc);
  84 +                       if ((stop_at_utime = parse_time(arg)) == (time_t)-1) {
  85 +                               snprintf(err_buf, sizeof err_buf,
  86 +                                   "invalid --stop-at format: %s\n",
  87 +                                   arg);
  88 +                               rprintf(FERROR, "ERROR: %s", err_buf);
  89 +                               return 0;
  90 +                       }
  91 +                       if (stop_at_utime < time(NULL)) {
  92 +                               snprintf(err_buf, sizeof err_buf,
  93 +                                   "--stop-at time is in the past: %s\n",
  94 +                                   arg);
  95 +                               rprintf(FERROR, "ERROR: %s", err_buf);
  96 +                               return 0;
  97 +                       }
  98 +                       break;
  99 +
 100 +               case OPT_TIME_LIMIT:
 101 +                       arg = poptGetOptArg(pc);
 102 +                       if ((stop_at_utime = atol(arg) * 60) <= 0) {
 103 +                               snprintf(err_buf, sizeof err_buf,
 104 +                                   "invalid --time-limit value: %s\n",
 105 +                                   arg);
 106 +                               rprintf(FERROR, "ERROR: %s", err_buf);
 107 +                               return 0;
 108 +                       }
 109 +                       stop_at_utime += time(NULL);
 110 +                       break;
 111 +
 112                 default:
 113                         /* A large opt value means that set_refuse_options()
 114                          * turned this option off (opt-BASE is its index). */
 115 @@ -881,6 +916,15 @@ void server_options(char **args,int *arg
 116
 117         if (bwlimit) {
 118                 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
 119 +                       goto oom;
 120 +               args[ac++] = arg;
 121 +       }
 122 +
 123 +       if (stop_at_utime) {
 124 +               long mins = (stop_at_utime - time(NULL)) / 60;
 125 +               if (mins <= 0)
 126 +                       mins = 1;
 127 +               if (asprintf(&arg, "--time-limit=%ld", mins) < 0)
 128                         goto oom;
 129                 args[ac++] = arg;
 130         }
 131 --- rsync.yo    7 May 2004 00:18:37 -0000       1.169
 132 +++ rsync.yo    17 May 2004 21:26:52 -0000
 133 @@ -346,6 +346,8 @@ verb(
 134       --log-format=FORMAT     log file transfers using specified format
 135       --password-file=FILE    get password from FILE
 136       --bwlimit=KBPS          limit I/O bandwidth, KBytes per second
 137 +     --stop-at=y-m-dTh:m     Stop rsync at year-month-dayThour:minute
 138 +     --time-limit=MINS       Stop rsync after MINS minutes have elapsed
 139       --write-batch=PREFIX    write batch fileset starting with PREFIX
 140       --read-batch=PREFIX     read batch fileset starting with PREFIX
 141   -4  --ipv4                  prefer IPv4
 142 @@ -890,6 +892,18 @@ of rsync transfers, blocks of data are s
 143  transfer was too fast, it will wait before sending the next data block. The
 144  result is an average transfer rate equaling the specified limit. A value
 145  of zero specifies no limit.
 146 +
 147 +dit(bf(--stop-at=y-m-dTh:m)) This option allows you to specify at what
 148 +time to stop rsync, in year-month-dayThour:minute numeric format (e.g.
 149 +2004-12-3lT23:59).  You can specify a 2 or 4-digit year.  You can also
 150 +leave off various items and the result will be the next possible time
 151 +that matches the specified data.  For example, "1-30" specifies the next
 152 +January 30th (at midnight), "04:00" specifies the next 4am, "1"
 153 +specifies the next 1st of the month at midnight, and ":59" specifies the
 154 +next 59th minute after the hour.
 155 +
 156 +dit(bf(--time-limit=MINS)) This option allows you to specify the maximum
 157 +number of minutes rsync will run for.
 158
 159  dit(bf(--write-batch=PREFIX)) Generate a set of files that can be
 160  transferred as a batch update. Each filename in the set starts with
 161 --- util.c      15 May 2004 19:31:10 -0000      1.143
 162 +++ util.c      17 May 2004 21:26:52 -0000
 163 @@ -122,6 +122,132 @@ void overflow(char *str)
 164         exit_cleanup(RERR_MALLOC);
 165  }
 166
 167 +/* Allow the user to specify a time in the format yyyy-mm-ddThh:mm while
 168 + * also allowing abbreviated data.  For instance, if the time is omitted,
 169 + * it defaults to midnight.  If the date is omitted, it defaults to the
 170 + * next possible date in the future with the specified time.  Even the
 171 + * year or year-month can be omitted, again defaulting to the next date
 172 + * in the future that matches the specified information.  A 2-digit year
 173 + * is also OK, as is using '/' instead of '-'. */
 174 +time_t parse_time(const char *arg)
 175 +{
 176 +       const char *cp;
 177 +       time_t val, now = time(NULL);
 178 +       struct tm t, *today = localtime(&now);
 179 +       int in_date, n;
 180 +
 181 +       memset(&t, 0, sizeof t);
 182 +       t.tm_year = t.tm_mon = t.tm_mday = -1;
 183 +       t.tm_hour = t.tm_min = t.tm_isdst = -1;
 184 +       cp = arg;
 185 +       if (*cp == 'T' || *cp == 't' || *cp == ':') {
 186 +               cp++;
 187 +               in_date = 0;
 188 +       } else
 189 +               in_date = 1;
 190 +       for ( ; ; cp++) {
 191 +               if (!isdigit(*cp))
 192 +                       return -1;
 193 +
 194 +               n = 0;
 195 +               do {
 196 +                       n = n * 10 + *cp++ - '0';
 197 +               } while (isdigit(*cp));
 198 +
 199 +               if (*cp == ':')
 200 +                       in_date = 0;
 201 +               if (in_date) {
 202 +                       if (t.tm_year != -1)
 203 +                               return -1;
 204 +                       t.tm_year = t.tm_mon;
 205 +                       t.tm_mon = t.tm_mday;
 206 +                       t.tm_mday = n;
 207 +                       if (!*cp)
 208 +                               break;
 209 +                       if (*cp == 'T' || *cp == 't') {
 210 +                               if (!cp[1])
 211 +                                       break;
 212 +                               in_date = 0;
 213 +                       } else if (*cp != '-' && *cp != '/')
 214 +                               return -1;
 215 +                       continue;
 216 +               }
 217 +               if (t.tm_hour != -1)
 218 +                       return -1;
 219 +               t.tm_hour = t.tm_min;
 220 +               t.tm_min = n;
 221 +               if (!*cp)
 222 +                       break;
 223 +               if (*cp != ':')
 224 +                       return -1;
 225 +       }
 226 +
 227 +       in_date = 0;
 228 +       if (t.tm_year < 0) {
 229 +               t.tm_year = today->tm_year;
 230 +               in_date = 1;
 231 +       } else if (t.tm_year < 100) {
 232 +               while (t.tm_year < today->tm_year)
 233 +                       t.tm_year += 100;
 234 +       } else
 235 +               t.tm_year -= 1900;
 236 +       if (t.tm_mon < 0) {
 237 +               t.tm_mon = today->tm_mon;
 238 +               in_date = 2;
 239 +       } else
 240 +               t.tm_mon--;
 241 +       if (t.tm_mday < 0) {
 242 +               t.tm_mday = today->tm_mday;
 243 +               in_date = 3;
 244 +       }
 245 +
 246 +       n = 0;
 247 +       if (t.tm_min < 0) {
 248 +               t.tm_hour = t.tm_min = 0;
 249 +       } else if (t.tm_hour < 0) {
 250 +               if (in_date != 3)
 251 +                       return -1;
 252 +               in_date = 0;
 253 +               t.tm_hour = today->tm_hour;
 254 +               n = 60*60;
 255 +       }
 256 +
 257 +       if (t.tm_hour > 23 || t.tm_min > 59
 258 +           || t.tm_mon < 0 || t.tm_mon >= 12
 259 +           || t.tm_mday < 1 || t.tm_mday > 31
 260 +           || (val = mktime(&t)) == (time_t)-1)
 261 +               return -1;
 262 +
 263 +       if (val <= now && in_date) {
 264 +           tweak_date:
 265 +               switch (in_date) {
 266 +               case 3:
 267 +                       t.tm_mday++;
 268 +                       break;
 269 +               case 2:
 270 +                       if (++t.tm_mon == 12)
 271 +                               t.tm_mon = 0;
 272 +                       else
 273 +                               break;
 274 +               case 1:
 275 +                       t.tm_year++;
 276 +                       break;
 277 +               }
 278 +               if ((val = mktime(&t)) == (time_t)-1) {
 279 +                       if (in_date == 3 && t.tm_mday > 28) {
 280 +                               t.tm_mday = 1;
 281 +                               in_date = 2;
 282 +                               goto tweak_date;
 283 +                       }
 284 +                       return -1;
 285 +               }
 286 +       }
 287 +       if (n) {
 288 +               while (val <= now)
 289 +                       val += n;
 290 +       }
 291 +       return val;
 292 +}
 293
 294
 295  int set_modtime(char *fname, time_t modtime)