1 John Taylor's patch for implementing --time-limit and --stop-at, reworked
2 to be simpler and more efficient by Wayne Davison.
4 Do we need configure support for mktime()?
6 To use this patch, run these commands for a successful build:
8 patch -p1 <patches/time-limit.diff
9 ./configure (optional if already run)
12 diff --git a/io.c b/io.c
13 index 6a89c8f..d248f0f 100644
16 @@ -53,6 +53,7 @@ extern int protocol_version;
17 extern int remove_source_files;
18 extern int preserve_hard_links;
19 extern struct stats stats;
20 +extern time_t stop_at_utime;
21 extern struct file_list *cur_flist;
23 extern int filesfrom_convert;
24 @@ -182,16 +183,24 @@ static void check_timeout(void)
28 + if ((!io_timeout || ignore_timeout) && !stop_at_utime)
33 + if (stop_at_utime && t >= stop_at_utime) {
34 + rprintf(FERROR, "run-time limit exceeded\n");
35 + exit_cleanup(RERR_TIMEOUT);
38 if (!io_timeout || ignore_timeout)
42 - last_io_in = time(NULL);
49 if (t - last_io_in >= io_timeout) {
50 if (!am_server && !am_daemon) {
51 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
52 diff --git a/options.c b/options.c
53 index e7c6c61..6e72c02 100644
56 @@ -112,6 +112,7 @@ size_t bwlimit_writemax = 0;
57 int ignore_existing = 0;
58 int ignore_non_existing = 0;
59 int need_messages_from_generator = 0;
60 +time_t stop_at_utime = 0;
61 int max_delete = INT_MIN;
64 @@ -775,6 +776,8 @@ void usage(enum logcode F)
65 rprintf(F," --password-file=FILE read daemon-access password from FILE\n");
66 rprintf(F," --list-only list the files instead of copying them\n");
67 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
68 + rprintf(F," --stop-at=y-m-dTh:m Stop rsync at year-month-dayThour:minute\n");
69 + rprintf(F," --time-limit=MINS Stop rsync after MINS minutes have elapsed\n");
70 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
71 rprintf(F," --only-write-batch=FILE like --write-batch but w/o updating destination\n");
72 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
73 @@ -798,7 +801,7 @@ enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
74 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
75 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
76 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV, OPT_INFO, OPT_DEBUG,
77 - OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN,
78 + OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN, OPT_STOP_AT, OPT_TIME_LIMIT,
79 OPT_SERVER, OPT_REFUSED_BASE = 9000};
81 static struct poptOption long_options[] = {
82 @@ -988,6 +991,8 @@ static struct poptOption long_options[] = {
83 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
84 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
85 {"no-contimeout", 0, POPT_ARG_VAL, &connect_timeout, 0, 0, 0 },
86 + {"stop-at", 0, POPT_ARG_STRING, 0, OPT_STOP_AT, 0, 0 },
87 + {"time-limit", 0, POPT_ARG_STRING, 0, OPT_TIME_LIMIT, 0, 0 },
88 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
89 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
90 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
91 @@ -1742,6 +1747,36 @@ int parse_arguments(int *argc_p, const char ***argv_p)
96 + arg = poptGetOptArg(pc);
97 + if ((stop_at_utime = parse_time(arg)) == (time_t)-1) {
98 + snprintf(err_buf, sizeof err_buf,
99 + "invalid --stop-at format: %s\n",
101 + rprintf(FERROR, "ERROR: %s", err_buf);
104 + if (stop_at_utime < time(NULL)) {
105 + snprintf(err_buf, sizeof err_buf,
106 + "--stop-at time is in the past: %s\n",
108 + rprintf(FERROR, "ERROR: %s", err_buf);
113 + case OPT_TIME_LIMIT:
114 + arg = poptGetOptArg(pc);
115 + if ((stop_at_utime = atol(arg) * 60) <= 0) {
116 + snprintf(err_buf, sizeof err_buf,
117 + "invalid --time-limit value: %s\n",
119 + rprintf(FERROR, "ERROR: %s", err_buf);
122 + stop_at_utime += time(NULL);
126 /* A large opt value means that set_refuse_options()
127 * turned this option off. */
128 @@ -2428,6 +2463,15 @@ void server_options(char **args, int *argc_p)
132 + if (stop_at_utime) {
133 + long mins = (stop_at_utime - time(NULL)) / 60;
136 + if (asprintf(&arg, "--time-limit=%ld", mins) < 0)
142 args[ac++] = "--backup-dir";
143 args[ac++] = backup_dir;
144 diff --git a/rsync.yo b/rsync.yo
145 index 941f7a5..6945d06 100644
148 @@ -431,6 +431,8 @@ to the detailed description below for a complete description. verb(
149 --password-file=FILE read daemon-access password from FILE
150 --list-only list the files instead of copying them
151 --bwlimit=KBPS limit I/O bandwidth; KBytes per second
152 + --stop-at=y-m-dTh:m Stop rsync at year-month-dayThour:minute
153 + --time-limit=MINS Stop rsync after MINS minutes have elapsed
154 --write-batch=FILE write a batched update to FILE
155 --only-write-batch=FILE like --write-batch but w/o updating dest
156 --read-batch=FILE read a batched update from FILE
157 @@ -2230,6 +2232,19 @@ transfer was too fast, it will wait before sending the next data block. The
158 result is an average transfer rate equaling the specified limit. A value
159 of zero specifies no limit.
161 +dit(bf(--stop-at=y-m-dTh:m)) This option allows you to specify at what
162 +time to stop rsync, in year-month-dayThour:minute numeric format (e.g.
163 +2004-12-31T23:59). You can specify a 2 or 4-digit year. You can also
164 +leave off various items and the result will be the next possible time
165 +that matches the specified data. For example, "1-30" specifies the next
166 +January 30th (at midnight), "04:00" specifies the next 4am, "1"
167 +specifies the next 1st of the month at midnight, and ":59" specifies the
168 +next 59th minute after the hour. If you prefer, you may separate the
169 +date numbers using slashes instead of dashes.
171 +dit(bf(--time-limit=MINS)) This option allows you to specify the maximum
172 +number of minutes rsync will run for.
174 dit(bf(--write-batch=FILE)) Record a file that can later be applied to
175 another identical destination with bf(--read-batch). See the "BATCH MODE"
176 section for details, and also the bf(--only-write-batch) option.
177 diff --git a/util.c b/util.c
178 index 0cafed6..f3e2669 100644
181 @@ -123,6 +123,133 @@ NORETURN void overflow_exit(const char *str)
182 exit_cleanup(RERR_MALLOC);
185 +/* Allow the user to specify a time in the format yyyy-mm-ddThh:mm while
186 + * also allowing abbreviated data. For instance, if the time is omitted,
187 + * it defaults to midnight. If the date is omitted, it defaults to the
188 + * next possible date in the future with the specified time. Even the
189 + * year or year-month can be omitted, again defaulting to the next date
190 + * in the future that matches the specified information. A 2-digit year
191 + * is also OK, as is using '/' instead of '-'. */
192 +time_t parse_time(const char *arg)
195 + time_t val, now = time(NULL);
196 + struct tm t, *today = localtime(&now);
199 + memset(&t, 0, sizeof t);
200 + t.tm_year = t.tm_mon = t.tm_mday = -1;
201 + t.tm_hour = t.tm_min = t.tm_isdst = -1;
203 + if (*cp == 'T' || *cp == 't' || *cp == ':') {
214 + n = n * 10 + *cp++ - '0';
215 + } while (isDigit(cp));
220 + if (t.tm_year != -1)
222 + t.tm_year = t.tm_mon;
223 + t.tm_mon = t.tm_mday;
227 + if (*cp == 'T' || *cp == 't') {
231 + } else if (*cp != '-' && *cp != '/')
235 + if (t.tm_hour != -1)
237 + t.tm_hour = t.tm_min;
246 + if (t.tm_year < 0) {
247 + t.tm_year = today->tm_year;
249 + } else if (t.tm_year < 100) {
250 + while (t.tm_year < today->tm_year)
254 + if (t.tm_mon < 0) {
255 + t.tm_mon = today->tm_mon;
259 + if (t.tm_mday < 0) {
260 + t.tm_mday = today->tm_mday;
265 + if (t.tm_min < 0) {
266 + t.tm_hour = t.tm_min = 0;
267 + } else if (t.tm_hour < 0) {
271 + t.tm_hour = today->tm_hour;
275 + if (t.tm_hour > 23 || t.tm_min > 59
276 + || t.tm_mon < 0 || t.tm_mon >= 12
277 + || t.tm_mday < 1 || t.tm_mday > 31
278 + || (val = mktime(&t)) == (time_t)-1)
281 + if (val <= now && in_date) {
288 + if (++t.tm_mon == 12)
296 + if ((val = mktime(&t)) == (time_t)-1) {
297 + if (in_date == 3 && t.tm_mday > 28) {
312 int set_modtime(const char *fname, time_t modtime, mode_t mode)
314 #if !defined HAVE_LUTIMES || !defined HAVE_UTIMES