Fixed the -r kluge sent for pre-2.6.4 --list-only support.
[rsync/rsync.git] / util.c
CommitLineData
1960e228 1/* -*- c-file-style: "linux" -*-
5cb37436
WD
2 *
3 * Copyright (C) 1996-2000 by Andrew Tridgell
0ecfbf27
MP
4 * Copyright (C) Paul Mackerras 1996
5 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
5cb37436 6 *
0ecfbf27
MP
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
5cb37436 11 *
0ecfbf27
MP
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
5cb37436 16 *
0ecfbf27
MP
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
c627d613 21
ac13ad10 22/**
0ecfbf27 23 * @file
ac13ad10 24 *
5cb37436 25 * Utilities used in rsync
ac13ad10 26 **/
c627d613 27
c627d613
AT
28#include "rsync.h"
29
c7c11a0d 30extern int verbose;
bc6ebcd2
WD
31extern int dry_run;
32extern int module_id;
33extern int modify_window;
a7260c40 34extern char *partial_dir;
7842418b 35extern struct filter_list_struct server_filter_list;
c7c11a0d 36
0ecfbf27
MP
37int sanitize_paths = 0;
38
39
f0359dd0 40
ac13ad10 41/**
0ecfbf27
MP
42 * Set a fd into nonblocking mode
43 **/
f0359dd0
AT
44void set_nonblocking(int fd)
45{
46 int val;
47
0ecfbf27 48 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
f0359dd0
AT
49 return;
50 if (!(val & NONBLOCK_FLAG)) {
51 val |= NONBLOCK_FLAG;
52 fcntl(fd, F_SETFL, val);
53 }
54}
55
ac13ad10 56/**
0ecfbf27
MP
57 * Set a fd into blocking mode
58 **/
36349ea0
AT
59void set_blocking(int fd)
60{
61 int val;
62
0ecfbf27 63 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
36349ea0
AT
64 return;
65 if (val & NONBLOCK_FLAG) {
66 val &= ~NONBLOCK_FLAG;
67 fcntl(fd, F_SETFL, val);
68 }
69}
70
f0359dd0 71
ac13ad10 72/**
0ecfbf27
MP
73 * Create a file descriptor pair - like pipe() but use socketpair if
74 * possible (because of blocking issues on pipes).
5cb37436 75 *
0ecfbf27 76 * Always set non-blocking.
f0359dd0 77 */
08f15335
AT
78int fd_pair(int fd[2])
79{
f0359dd0
AT
80 int ret;
81
4f5b0756 82#ifdef HAVE_SOCKETPAIR
f0359dd0 83 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
08f15335 84#else
f0359dd0 85 ret = pipe(fd);
08f15335 86#endif
f0359dd0
AT
87
88 if (ret == 0) {
89 set_nonblocking(fd[0]);
90 set_nonblocking(fd[1]);
91 }
0ecfbf27 92
f0359dd0 93 return ret;
08f15335
AT
94}
95
96
0ecfbf27 97void print_child_argv(char **cmd)
5ad0e46f 98{
1bbd10fe 99 rprintf(FINFO, "opening connection using ");
5ad0e46f
MP
100 for (; *cmd; cmd++) {
101 /* Look for characters that ought to be quoted. This
102 * is not a great quoting algorithm, but it's
103 * sufficient for a log message. */
104 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
105 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
106 "0123456789"
107 ",.-_=+@/") != strlen(*cmd)) {
f8cd88db 108 rprintf(FINFO, "\"%s\" ", safe_fname(*cmd));
5ad0e46f 109 } else {
f8cd88db 110 rprintf(FINFO, "%s ", safe_fname(*cmd));
5ad0e46f
MP
111 }
112 }
113 rprintf(FINFO, "\n");
114}
115
116
c627d613
AT
117void out_of_memory(char *str)
118{
c284f34a
WD
119 rprintf(FERROR, "ERROR: out of memory in %s\n", str);
120 exit_cleanup(RERR_MALLOC);
575f2fca
AT
121}
122
123void overflow(char *str)
124{
c284f34a
WD
125 rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
126 exit_cleanup(RERR_MALLOC);
c627d613
AT
127}
128
129
c627d613 130
404e813c 131int set_modtime(char *fname, time_t modtime)
c627d613 132{
404e813c
MP
133 if (verbose > 2) {
134 rprintf(FINFO, "set modtime of %s to (%ld) %s",
f8cd88db 135 safe_fname(fname), (long)modtime,
404e813c
MP
136 asctime(localtime(&modtime)));
137 }
5cb37436 138
15778afb
WD
139 if (dry_run)
140 return 0;
141
31e12522 142 {
4f5b0756 143#ifdef HAVE_UTIMBUF
5cb37436 144 struct utimbuf tbuf;
31e12522
AT
145 tbuf.actime = time(NULL);
146 tbuf.modtime = modtime;
147 return utime(fname,&tbuf);
4f5b0756 148#elif defined HAVE_UTIME
31e12522
AT
149 time_t t[2];
150 t[0] = time(NULL);
151 t[1] = modtime;
152 return utime(fname,t);
c627d613 153#else
31e12522
AT
154 struct timeval t[2];
155 t[0].tv_sec = time(NULL);
156 t[0].tv_usec = 0;
157 t[1].tv_sec = modtime;
158 t[1].tv_usec = 0;
159 return utimes(fname,t);
c627d613 160#endif
31e12522 161 }
c627d613 162}
94481d91 163
720b47f2 164
ac13ad10
MP
165/**
166 Create any necessary directories in fname. Unfortunately we don't know
167 what perms to give the directory when this is called so we need to rely
168 on the umask
169**/
0ecfbf27 170int create_directory_path(char *fname, int base_umask)
6574b4f7 171{
6574b4f7
AT
172 char *p;
173
c284f34a
WD
174 while (*fname == '/')
175 fname++;
176 while (strncmp(fname, "./", 2) == 0)
177 fname += 2;
6574b4f7
AT
178
179 p = fname;
c284f34a 180 while ((p = strchr(p,'/')) != NULL) {
6574b4f7 181 *p = 0;
5cb37436 182 do_mkdir(fname, 0777 & ~base_umask);
6574b4f7
AT
183 *p = '/';
184 p++;
185 }
186 return 0;
187}
950ab32d
AT
188
189
ac13ad10
MP
190/**
191 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
192 * interrupted.
193 *
194 * @retval len upon success
195 *
196 * @retval <0 write's (negative) error code
197 *
198 * Derived from GNU C's cccp.c.
199 */
6566d205 200int full_write(int desc, char *ptr, size_t len)
950ab32d
AT
201{
202 int total_written;
5cb37436 203
950ab32d
AT
204 total_written = 0;
205 while (len > 0) {
5c1b7bfd 206 int written = write(desc, ptr, len);
950ab32d 207 if (written < 0) {
950ab32d
AT
208 if (errno == EINTR)
209 continue;
950ab32d
AT
210 return written;
211 }
212 total_written += written;
213 ptr += written;
214 len -= written;
215 }
216 return total_written;
217}
218
950ab32d 219
ac13ad10
MP
220/**
221 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
222 * interrupted.
223 *
224 * @retval >0 the actual number of bytes read
225 *
226 * @retval 0 for EOF
227 *
228 * @retval <0 for an error.
229 *
230 * Derived from GNU C's cccp.c. */
9dd891bb 231static int safe_read(int desc, char *ptr, size_t len)
950ab32d
AT
232{
233 int n_chars;
5cb37436 234
9dd891bb 235 if (len == 0)
950ab32d 236 return len;
5cb37436 237
950ab32d
AT
238 do {
239 n_chars = read(desc, ptr, len);
240 } while (n_chars < 0 && errno == EINTR);
5cb37436 241
950ab32d
AT
242 return n_chars;
243}
244
245
ac13ad10
MP
246/** Copy a file.
247 *
3e13004b
WD
248 * This is used in conjunction with the --temp-dir, --backup, and
249 * --copy-dest options. */
950ab32d
AT
250int copy_file(char *source, char *dest, mode_t mode)
251{
252 int ifd;
253 int ofd;
254 char buf[1024 * 8];
255 int len; /* Number of bytes read into `buf'. */
256
8c9fd200 257 ifd = do_open(source, O_RDONLY, 0);
950ab32d 258 if (ifd == -1) {
d62bcc17 259 rsyserr(FERROR, errno, "open %s", full_fname(source));
950ab32d
AT
260 return -1;
261 }
262
c7c11a0d 263 if (robust_unlink(dest) && errno != ENOENT) {
d62bcc17 264 rsyserr(FERROR, errno, "unlink %s", full_fname(dest));
950ab32d
AT
265 return -1;
266 }
267
31e12522 268 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
c46ded46 269 if (ofd == -1) {
d62bcc17 270 rsyserr(FERROR, errno, "open %s", full_fname(dest));
950ab32d
AT
271 close(ifd);
272 return -1;
273 }
274
5cb37436 275 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
950ab32d 276 if (full_write(ofd, buf, len) < 0) {
d62bcc17 277 rsyserr(FERROR, errno, "write %s", full_fname(dest));
950ab32d
AT
278 close(ifd);
279 close(ofd);
280 return -1;
281 }
282 }
283
8b602edd 284 if (len < 0) {
d62bcc17 285 rsyserr(FERROR, errno, "read %s", full_fname(source));
8b602edd
WD
286 close(ifd);
287 close(ofd);
288 return -1;
289 }
290
9f27cd8c 291 if (close(ifd) < 0) {
d62bcc17
WD
292 rsyserr(FINFO, errno, "close failed on %s",
293 full_fname(source));
9f27cd8c
WD
294 }
295
296 if (close(ofd) < 0) {
d62bcc17
WD
297 rsyserr(FERROR, errno, "close failed on %s",
298 full_fname(dest));
9f27cd8c
WD
299 return -1;
300 }
950ab32d 301
950ab32d
AT
302 return 0;
303}
feaa89c4 304
c7c11a0d
DD
305/* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
306#define MAX_RENAMES_DIGITS 3
307#define MAX_RENAMES 1000
308
ac13ad10 309/**
b4235b31
MP
310 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
311 * rename to <path>/.rsyncNNN instead.
312 *
313 * Note that successive rsync runs will shuffle the filenames around a
314 * bit as long as the file is still busy; this is because this function
315 * does not know if the unlink call is due to a new file coming in, or
316 * --delete trying to remove old .rsyncNNN files, hence it renames it
317 * each time.
318 **/
c7c11a0d
DD
319int robust_unlink(char *fname)
320{
321#ifndef ETXTBSY
322 return do_unlink(fname);
323#else
324 static int counter = 1;
325 int rc, pos, start;
326 char path[MAXPATHLEN];
327
328 rc = do_unlink(fname);
c284f34a 329 if (rc == 0 || errno != ETXTBSY)
c7c11a0d
DD
330 return rc;
331
c284f34a
WD
332 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
333 pos = MAXPATHLEN - 1;
c7c11a0d 334
c284f34a
WD
335 while (pos > 0 && path[pos-1] != '/')
336 pos--;
5cb37436 337 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
c7c11a0d
DD
338
339 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
340 errno = ETXTBSY;
341 return -1;
342 }
343
344 /* start where the last one left off to reduce chance of clashes */
345 start = counter;
346 do {
347 sprintf(&path[pos], "%03d", counter);
348 if (++counter >= MAX_RENAMES)
349 counter = 1;
c284f34a 350 } while ((rc = access(path, 0)) == 0 && counter != start);
c7c11a0d 351
4791825d 352 if (verbose > 0) {
c7c11a0d 353 rprintf(FINFO,"renaming %s to %s because of text busy\n",
f8cd88db 354 safe_fname(fname), safe_fname(path));
4791825d 355 }
c7c11a0d
DD
356
357 /* maybe we should return rename()'s exit status? Nah. */
358 if (do_rename(fname, path) != 0) {
359 errno = ETXTBSY;
360 return -1;
361 }
362 return 0;
363#endif
364}
365
630f548f
WD
366/* Returns 0 on successful rename, 1 if we successfully copied the file
367 * across filesystems, -2 if copy_file() failed, and -1 on other errors. */
62c9e6b3 368int robust_rename(char *from, char *to, int mode)
c7c11a0d 369{
62c9e6b3
WD
370 int tries = 4;
371
372 while (tries--) {
373 if (do_rename(from, to) == 0)
374 return 0;
375
376 switch (errno) {
377#ifdef ETXTBSY
378 case ETXTBSY:
379 if (robust_unlink(to) != 0)
380 return -1;
381 break;
c7c11a0d 382#endif
62c9e6b3
WD
383 case EXDEV:
384 if (copy_file(from, to, mode) != 0)
385 return -2;
386 do_unlink(from);
630f548f 387 return 1;
62c9e6b3
WD
388 default:
389 return -1;
390 }
391 }
392 return -1;
feaa89c4 393}
3ba62a83
AT
394
395
396static pid_t all_pids[10];
397static int num_pids;
398
4cf64834 399/** Fork and record the pid of the child. **/
3ba62a83
AT
400pid_t do_fork(void)
401{
402 pid_t newpid = fork();
5cb37436 403
4cf64834 404 if (newpid != 0 && newpid != -1) {
3ba62a83
AT
405 all_pids[num_pids++] = newpid;
406 }
407 return newpid;
408}
409
4cf64834
MP
410/**
411 * Kill all children.
412 *
413 * @todo It would be kind of nice to make sure that they are actually
414 * all our children before we kill them, because their pids may have
415 * been recycled by some other process. Perhaps when we wait for a
416 * child, we should remove it from this array. Alternatively we could
417 * perhaps use process groups, but I think that would not work on
418 * ancient Unix versions that don't support them.
419 **/
3ba62a83
AT
420void kill_all(int sig)
421{
422 int i;
4cf64834
MP
423
424 for (i = 0; i < num_pids; i++) {
425 /* Let's just be a little careful where we
426 * point that gun, hey? See kill(2) for the
427 * magic caused by negative values. */
428 pid_t p = all_pids[i];
429
430 if (p == getpid())
431 continue;
432 if (p <= 0)
433 continue;
434
435 kill(p, sig);
3ba62a83
AT
436 }
437}
9486289c 438
4cf64834 439
ac13ad10 440/** Turn a user name into a uid */
8ef4ffd6
AT
441int name_to_uid(char *name, uid_t *uid)
442{
443 struct passwd *pass;
b5bd5542
WD
444 if (!name || !*name)
445 return 0;
8ef4ffd6
AT
446 pass = getpwnam(name);
447 if (pass) {
448 *uid = pass->pw_uid;
449 return 1;
450 }
451 return 0;
452}
453
ac13ad10 454/** Turn a group name into a gid */
8ef4ffd6
AT
455int name_to_gid(char *name, gid_t *gid)
456{
457 struct group *grp;
b5bd5542
WD
458 if (!name || !*name)
459 return 0;
8ef4ffd6
AT
460 grp = getgrnam(name);
461 if (grp) {
462 *gid = grp->gr_gid;
463 return 1;
464 }
465 return 0;
466}
467
ff8b29b8 468
ac13ad10 469/** Lock a byte range in a open file */
31593dd6 470int lock_range(int fd, int offset, int len)
0c515f17 471{
31593dd6 472 struct flock lock;
0c515f17 473
31593dd6
AT
474 lock.l_type = F_WRLCK;
475 lock.l_whence = SEEK_SET;
476 lock.l_start = offset;
477 lock.l_len = len;
478 lock.l_pid = 0;
5cb37436 479
31593dd6 480 return fcntl(fd,F_SETLK,&lock) == 0;
0c515f17 481}
874895d5 482
7842418b 483static int filter_server_path(char *arg)
4791825d
WD
484{
485 char *s;
4791825d 486
7842418b 487 if (server_filter_list.head) {
4791825d
WD
488 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
489 *s = '\0';
7842418b 490 if (check_filter(&server_filter_list, arg, 1) < 0) {
4791825d
WD
491 /* We must leave arg truncated! */
492 return 1;
493 }
494 *s++ = '/';
495 }
496 }
497 return 0;
498}
874895d5 499
b7061c82
WD
500static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
501 int *maxargs_ptr)
874895d5 502{
b7061c82 503 char **argv = *argv_ptr;
b5bd5542 504 int argc = *argc_ptr;
b7061c82 505 int maxargs = *maxargs_ptr;
4f5b0756 506#if !defined HAVE_GLOB || !defined HAVE_GLOB_H
b7061c82
WD
507 if (argc == maxargs) {
508 maxargs += MAX_ARGS;
509 if (!(argv = realloc_array(argv, char *, maxargs)))
510 out_of_memory("glob_expand_one");
511 *argv_ptr = argv;
512 *maxargs_ptr = maxargs;
513 }
4135d091
WD
514 if (!*s)
515 s = ".";
b5bd5542 516 s = argv[argc++] = strdup(s);
7842418b 517 filter_server_path(s);
874895d5
AT
518#else
519 glob_t globbuf;
520 int i;
521
b5bd5542
WD
522 if (maxargs <= argc)
523 return;
4135d091
WD
524 if (!*s)
525 s = ".";
e42c9458 526
4135d091 527 if (sanitize_paths)
1d6b8f9a 528 s = sanitize_path(NULL, s, "", 0);
84a63795
WD
529 else
530 s = strdup(s);
087bf010 531
5cb37436 532 memset(&globbuf, 0, sizeof globbuf);
7842418b 533 if (!filter_server_path(s))
4791825d 534 glob(s, 0, NULL, &globbuf);
b7061c82
WD
535 if (MAX((int)globbuf.gl_pathc, 1) > maxargs - argc) {
536 maxargs += globbuf.gl_pathc + MAX_ARGS;
537 if (!(argv = realloc_array(argv, char *, maxargs)))
538 out_of_memory("glob_expand_one");
539 *argv_ptr = argv;
540 *maxargs_ptr = maxargs;
541 }
b5bd5542
WD
542 if (globbuf.gl_pathc == 0)
543 argv[argc++] = s;
544 else {
545 int j = globbuf.gl_pathc;
b5bd5542
WD
546 free(s);
547 for (i = 0; i < j; i++) {
548 if (!(argv[argc++] = strdup(globbuf.gl_pathv[i])))
549 out_of_memory("glob_expand_one");
550 }
874895d5
AT
551 }
552 globfree(&globbuf);
874895d5 553#endif
b5bd5542 554 *argc_ptr = argc;
874895d5 555}
5a96ee05 556
4791825d 557/* This routine is only used in daemon mode. */
b7061c82 558void glob_expand(char *base1, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
087bf010 559{
b7061c82 560 char *s = (*argv_ptr)[*argc_ptr];
087bf010 561 char *p, *q;
ba5e128d 562 char *base = base1;
4791825d 563 int base_len = strlen(base);
087bf010 564
b5bd5542
WD
565 if (!s || !*s)
566 return;
087bf010 567
4791825d
WD
568 if (strncmp(s, base, base_len) == 0)
569 s += base_len;
e42c9458 570
b5bd5542
WD
571 if (!(s = strdup(s)))
572 out_of_memory("glob_expand");
087bf010 573
b5bd5542
WD
574 if (asprintf(&base," %s/", base1) <= 0)
575 out_of_memory("glob_expand");
4791825d 576 base_len++;
ba5e128d 577
b5bd5542
WD
578 for (q = s; *q; q = p + base_len) {
579 if ((p = strstr(q, base)) != NULL)
580 *p = '\0'; /* split it at this point */
b7061c82 581 glob_expand_one(q, argv_ptr, argc_ptr, maxargs_ptr);
b5bd5542
WD
582 if (!p)
583 break;
087bf010
AT
584 }
585
087bf010 586 free(s);
ba5e128d 587 free(base);
087bf010 588}
5a96ee05 589
ac13ad10
MP
590/**
591 * Convert a string to lower case
592 **/
5a96ee05
AT
593void strlower(char *s)
594{
595 while (*s) {
b5bd5542
WD
596 if (isupper(*(unsigned char *)s))
597 *s = tolower(*(unsigned char *)s);
5a96ee05
AT
598 s++;
599 }
600}
e42c9458 601
368ad70e
WD
602/* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
603 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
a8f7e4b8
WD
604 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
605 * string fits into destsize. */
368ad70e
WD
606size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
607{
608 size_t len = strlcpy(dest, p1, destsize);
609 if (len < destsize - 1) {
610 if (!len || dest[len-1] != '/')
611 dest[len++] = '/';
612 if (len < destsize - 1)
613 len += strlcpy(dest + len, p2, destsize - len);
614 else {
615 dest[len] = '\0';
616 len += strlen(p2);
617 }
618 }
619 else
620 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
621 return len;
622}
623
624/* Join any number of strings together, putting them in "dest". The return
a8f7e4b8
WD
625 * value is the length of all the strings, regardless of whether the null-
626 * terminated whole fits in destsize. Your list of string pointers must end
627 * with a NULL to indicate the end of the list. */
368ad70e
WD
628size_t stringjoin(char *dest, size_t destsize, ...)
629{
5cb37436 630 va_list ap;
368ad70e
WD
631 size_t len, ret = 0;
632 const char *src;
633
634 va_start(ap, destsize);
635 while (1) {
636 if (!(src = va_arg(ap, const char *)))
637 break;
638 len = strlen(src);
639 ret += len;
640 if (destsize > 1) {
641 if (len >= destsize)
642 len = destsize - 1;
643 memcpy(dest, src, len);
644 destsize -= len;
645 dest += len;
646 }
647 }
648 *dest = '\0';
649 va_end(ap);
650
651 return ret;
652}
653
1d6b8f9a
WD
654int count_dir_elements(const char *p)
655{
656 int cnt = 0, new_component = 1;
657 while (*p) {
658 if (*p++ == '/')
659 new_component = 1;
660 else if (new_component) {
661 new_component = 0;
662 cnt++;
663 }
664 }
665 return cnt;
666}
667
b92693da
WD
668/* Turns multiple adjacent slashes into a single slash, gets rid of "./"
669 * elements (but not a trailing dot dir), removes a trailing slash, and
670 * optionally collapses ".." elements (except for those at the start of the
671 * string). If the resulting name would be empty, change it into a ".". */
672unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
5243c216 673{
e012b94f 674 char *limit = name - 1, *t = name, *f = name;
ebdd24d6 675 int anchored;
5243c216 676
b5bd5542 677 if (!name)
3104620c 678 return 0;
5243c216 679
ebdd24d6
WD
680 if ((anchored = *f == '/') != 0)
681 *t++ = *f++;
682 while (*f) {
683 /* discard extra slashes */
684 if (*f == '/') {
685 f++;
686 continue;
5243c216 687 }
ebdd24d6
WD
688 if (*f == '.') {
689 /* discard "." dirs (but NOT a trailing '.'!) */
690 if (f[1] == '/') {
e012b94f 691 f += 2;
ebdd24d6
WD
692 continue;
693 }
694 /* collapse ".." dirs */
b92693da
WD
695 if (collapse_dot_dot
696 && f[1] == '.' && (f[2] == '/' || !f[2])) {
ebdd24d6
WD
697 char *s = t - 1;
698 if (s == name && anchored) {
699 f += 2;
700 continue;
701 }
702 while (s > limit && *--s != '/') {}
e012b94f 703 if (s != t - 1 && (s < name || *s == '/')) {
ebdd24d6
WD
704 t = s + 1;
705 f += 2;
706 continue;
707 }
f55c2dfc 708 limit = t + 2;
5243c216
AT
709 }
710 }
ebdd24d6 711 while (*f && (*t++ = *f++) != '/') {}
5243c216 712 }
ebdd24d6
WD
713
714 if (t > name+anchored && t[-1] == '/')
715 t--;
716 if (t == name)
717 *t++ = '.';
718 *t = '\0';
3104620c
WD
719
720 return t - name;
5243c216
AT
721}
722
84a63795
WD
723/* Make path appear as if a chroot had occurred. This handles a leading
724 * "/" (either removing it or expanding it) and any leading or embedded
725 * ".." components that attempt to escape past the module's top dir.
b4235b31 726 *
1d6b8f9a
WD
727 * If dest is NULL, a buffer is allocated to hold the result. It is legal
728 * to call with the dest and the path (p) pointing to the same buffer, but
729 * rootdir will be ignored to avoid expansion of the string.
b4235b31 730 *
1d6b8f9a
WD
731 * The rootdir string contains a value to use in place of a leading slash.
732 * Specify NULL to get the default of lp_path(module_id).
ac13ad10 733 *
5886edfa
WD
734 * If depth is >= 0, it is a count of how many '..'s to allow at the start
735 * of the path. Use -1 to allow unlimited depth.
ac13ad10 736 *
b92693da
WD
737 * We also clean the path in a manner similar to clean_fname() but with a
738 * few differences:
739 *
740 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
741 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
742 * ALWAYS collapses ".." elements (except for those at the start of the
743 * string up to "depth" deep). If the resulting name would be empty,
744 * change it into a ".". */
1d6b8f9a 745char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
1b8e662a 746{
44e2e578 747 char *start, *sanp;
84a63795
WD
748 int rlen = 0;
749
750 if (dest != p) {
751 int plen = strlen(p);
1d6b8f9a
WD
752 if (*p == '/') {
753 if (!rootdir)
754 rootdir = lp_path(module_id);
755 rlen = strlen(rootdir);
756 depth = 0;
84a63795
WD
757 p++;
758 }
759 if (dest) {
760 if (rlen + plen + 1 >= MAXPATHLEN)
761 return NULL;
762 } else if (!(dest = new_array(char, rlen + plen + 1)))
763 out_of_memory("sanitize_path");
764 if (rlen) {
1d6b8f9a 765 memcpy(dest, rootdir, rlen);
84a63795
WD
766 if (rlen > 1)
767 dest[rlen++] = '/';
768 }
769 }
cb13abfe 770
84a63795 771 start = sanp = dest + rlen;
1b8e662a 772 while (*p != '\0') {
2d41264e
WD
773 /* discard leading or extra slashes */
774 if (*p == '/') {
775 p++;
776 continue;
777 }
b5f9e67d 778 /* this loop iterates once per filename component in p.
44e2e578 779 * both p (and sanp if the original had a slash) should
b5f9e67d
DD
780 * always be left pointing after a slash
781 */
c284f34a 782 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
b5f9e67d 783 /* skip "." component */
2d41264e 784 p++;
cb13abfe
DD
785 continue;
786 }
c284f34a 787 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
cb13abfe 788 /* ".." component followed by slash or end */
8e5f029e
WD
789 if (depth <= 0 || sanp != start) {
790 p += 2;
791 if (sanp != start) {
792 /* back up sanp one level */
793 --sanp; /* now pointing at slash */
794 while (sanp > start && sanp[-1] != '/') {
795 /* skip back up to slash */
796 sanp--;
797 }
b5f9e67d 798 }
8e5f029e 799 continue;
1b8e662a 800 }
8e5f029e
WD
801 /* allow depth levels of .. at the beginning */
802 depth--;
803 /* move the virtual beginning to leave the .. alone */
804 start = sanp + 3;
1b8e662a 805 }
2d41264e
WD
806 /* copy one component through next slash */
807 while (*p && (*sanp++ = *p++) != '/') {}
1b8e662a 808 }
84a63795 809 if (sanp == dest) {
b5f9e67d 810 /* ended up with nothing, so put in "." component */
44e2e578 811 *sanp++ = '.';
b5f9e67d 812 }
44e2e578 813 *sanp = '\0';
1b8e662a 814
84a63795 815 return dest;
14b61c63 816}
5243c216 817
4791825d 818char curr_dir[MAXPATHLEN];
4af8fe4e 819unsigned int curr_dir_len;
5243c216 820
4e5db0ad 821/**
a16d8f2b
WD
822 * Like chdir(), but it keeps track of the current directory (in the
823 * global "curr_dir"), and ensures that the path size doesn't overflow.
824 * Also cleans the path using the clean_fname() function.
4e5db0ad 825 **/
4af8fe4e 826int push_dir(char *dir)
5243c216 827{
5243c216 828 static int initialised;
4af8fe4e 829 unsigned int len;
5243c216
AT
830
831 if (!initialised) {
832 initialised = 1;
5cb37436 833 getcwd(curr_dir, sizeof curr_dir - 1);
4af8fe4e 834 curr_dir_len = strlen(curr_dir);
5243c216
AT
835 }
836
4af8fe4e
WD
837 if (!dir) /* this call was probably just to initialize */
838 return 0;
c226b7c2 839
4af8fe4e
WD
840 len = strlen(dir);
841 if (len == 1 && *dir == '.')
842 return 1;
5243c216 843
4af8fe4e
WD
844 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
845 return 0;
846
847 if (chdir(dir))
848 return 0;
5243c216
AT
849
850 if (*dir == '/') {
4af8fe4e
WD
851 memcpy(curr_dir, dir, len + 1);
852 curr_dir_len = len;
853 } else {
854 curr_dir[curr_dir_len++] = '/';
855 memcpy(curr_dir + curr_dir_len, dir, len + 1);
856 curr_dir_len += len;
5243c216
AT
857 }
858
b92693da 859 curr_dir_len = clean_fname(curr_dir, 1);
5243c216 860
4af8fe4e 861 return 1;
5243c216
AT
862}
863
a16d8f2b
WD
864/**
865 * Reverse a push_dir() call. You must pass in an absolute path
866 * that was copied from a prior value of "curr_dir".
867 **/
5243c216
AT
868int pop_dir(char *dir)
869{
4af8fe4e
WD
870 if (chdir(dir))
871 return 0;
5243c216 872
4af8fe4e
WD
873 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
874 if (curr_dir_len >= sizeof curr_dir)
875 curr_dir_len = sizeof curr_dir - 1;
5243c216 876
4af8fe4e 877 return 1;
5243c216 878}
aa9b77a5 879
b485e0c1
WD
880/* Return the filename, turning any non-printable characters into '?'s.
881 * This ensures that outputting it on a line of its own cannot generate an
882 * empty line. This function can return only MAX_SAFE_NAMES values at a
883 * time! The returned value can be longer than MAXPATHLEN (because we
884 * may be trying to output an error about a too-long filename)! */
820b6c9a
WD
885const char *safe_fname(const char *fname)
886{
f8cd88db
WD
887#define MAX_SAFE_NAMES 4
888 static char fbuf[MAX_SAFE_NAMES][MAXPATHLEN*2];
889 static int ndx = 0;
890 int limit = sizeof fbuf / MAX_SAFE_NAMES - 1;
891 char *t;
892
893 ndx = (ndx + 1) % MAX_SAFE_NAMES;
894 for (t = fbuf[ndx]; *fname; fname++) {
73253721 895 if (!isprint(*(uchar*)fname))
f8cd88db
WD
896 *t++ = '?';
897 else
898 *t++ = *fname;
899 if (--limit == 0)
900 break;
901 }
902 *t = '\0';
820b6c9a 903
f8cd88db 904 return fbuf[ndx];
820b6c9a
WD
905}
906
eb61be19
WD
907/**
908 * Return a quoted string with the full pathname of the indicated filename.
909 * The string " (in MODNAME)" may also be appended. The returned pointer
910 * remains valid until the next time full_fname() is called.
911 **/
9a5ade18 912char *full_fname(const char *fn)
eb61be19 913{
eb61be19
WD
914 static char *result = NULL;
915 char *m1, *m2, *m3;
916 char *p1, *p2;
917
918 if (result)
919 free(result);
920
af1a3f9b 921 fn = safe_fname(fn);
eb61be19
WD
922 if (*fn == '/')
923 p1 = p2 = "";
924 else {
925 p1 = curr_dir;
bc83274a
WD
926 for (p2 = p1; *p2 == '/'; p2++) {}
927 if (*p2)
928 p2 = "/";
eb61be19
WD
929 }
930 if (module_id >= 0) {
931 m1 = " (in ";
932 m2 = lp_name(module_id);
933 m3 = ")";
bc83274a 934 if (p1 == curr_dir) {
eb61be19
WD
935 if (!lp_use_chroot(module_id)) {
936 char *p = lp_path(module_id);
937 if (*p != '/' || p[1])
938 p1 += strlen(p);
939 }
eb61be19 940 }
eb61be19
WD
941 } else
942 m1 = m2 = m3 = "";
943
944 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
945
946 return result;
947}
948
a7260c40
WD
949static char partial_fname[MAXPATHLEN];
950
951char *partial_dir_fname(const char *fname)
952{
953 char *t = partial_fname;
954 int sz = sizeof partial_fname;
955 const char *fn;
956
957 if ((fn = strrchr(fname, '/')) != NULL) {
958 fn++;
959 if (*partial_dir != '/') {
960 int len = fn - fname;
961 strncpy(t, fname, len); /* safe */
962 t += len;
963 sz -= len;
964 }
965 } else
966 fn = fname;
967 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
968 return NULL;
5aa7b20a
WD
969 if (server_filter_list.head) {
970 static int len;
971 if (!len)
972 len = strlen(partial_dir);
973 t[len] = '\0';
974 if (check_filter(&server_filter_list, partial_fname, 1) < 0)
975 return NULL;
976 t[len] = '/';
977 if (check_filter(&server_filter_list, partial_fname, 0) < 0)
978 return NULL;
979 }
a7260c40
WD
980
981 return partial_fname;
982}
983
984/* If no --partial-dir option was specified, we don't need to do anything
985 * (the partial-dir is essentially '.'), so just return success. */
986int handle_partial_dir(const char *fname, int create)
987{
988 char *fn, *dir;
989
990 if (fname != partial_fname)
991 return 1;
992 if (!create && *partial_dir == '/')
993 return 1;
994 if (!(fn = strrchr(partial_fname, '/')))
995 return 1;
996
997 *fn = '\0';
998 dir = partial_fname;
999 if (create) {
1000 STRUCT_STAT st;
a7260c40 1001 int statret = do_lstat(dir, &st);
a7260c40
WD
1002 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1003 if (do_unlink(dir) < 0)
1004 return 0;
1005 statret = -1;
1006 }
1007 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1008 return 0;
1009 } else
1010 do_rmdir(dir);
1011 *fn = '/';
1012
1013 return 1;
1014}
1015
ac13ad10 1016/** We need to supply our own strcmp function for file list comparisons
aa9b77a5
AT
1017 to ensure that signed/unsigned usage is consistent between machines. */
1018int u_strcmp(const char *cs1, const char *cs2)
1019{
5a788ade
AT
1020 const uchar *s1 = (const uchar *)cs1;
1021 const uchar *s2 = (const uchar *)cs2;
aa9b77a5
AT
1022
1023 while (*s1 && *s2 && (*s1 == *s2)) {
1024 s1++; s2++;
1025 }
5cb37436 1026
aa9b77a5
AT
1027 return (int)*s1 - (int)*s2;
1028}
eb86d661 1029
4b957c22 1030
ac13ad10
MP
1031
1032/**
1033 * Determine if a symlink points outside the current directory tree.
036e70b0
MP
1034 * This is considered "unsafe" because e.g. when mirroring somebody
1035 * else's machine it might allow them to establish a symlink to
1036 * /etc/passwd, and then read it through a web server.
1037 *
4e5db0ad
MP
1038 * Null symlinks and absolute symlinks are always unsafe.
1039 *
1040 * Basically here we are concerned with symlinks whose target contains
1041 * "..", because this might cause us to walk back up out of the
1042 * transferred directory. We are not allowed to go back up and
1043 * reenter.
1044 *
036e70b0
MP
1045 * @param dest Target of the symlink in question.
1046 *
25d34a5c 1047 * @param src Top source directory currently applicable. Basically this
036e70b0 1048 * is the first parameter to rsync in a simple invocation, but it's
25d34a5c 1049 * modified by flist.c in slightly complex ways.
036e70b0
MP
1050 *
1051 * @retval True if unsafe
1052 * @retval False is unsafe
4e5db0ad
MP
1053 *
1054 * @sa t_unsafe.c
ac13ad10 1055 **/
7afa3a4a 1056int unsafe_symlink(const char *dest, const char *src)
4b957c22 1057{
7afa3a4a 1058 const char *name, *slash;
4b957c22
AT
1059 int depth = 0;
1060
1061 /* all absolute and null symlinks are unsafe */
b5bd5542
WD
1062 if (!dest || !*dest || *dest == '/')
1063 return 1;
4b957c22
AT
1064
1065 /* find out what our safety margin is */
7afa3a4a
WD
1066 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1067 if (strncmp(name, "../", 3) == 0) {
c284f34a 1068 depth = 0;
7afa3a4a 1069 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
1070 /* nothing */
1071 } else {
1072 depth++;
1073 }
1074 }
7afa3a4a
WD
1075 if (strcmp(name, "..") == 0)
1076 depth = 0;
4b957c22 1077
7afa3a4a
WD
1078 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1079 if (strncmp(name, "../", 3) == 0) {
1080 /* if at any point we go outside the current directory
1081 then stop - it is unsafe */
1082 if (--depth < 0)
1083 return 1;
1084 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
1085 /* nothing */
1086 } else {
1087 depth++;
1088 }
4b957c22 1089 }
7afa3a4a
WD
1090 if (strcmp(name, "..") == 0)
1091 depth--;
4b957c22 1092
4b957c22
AT
1093 return (depth < 0);
1094}
375a4556 1095
f7632fc6 1096
ac13ad10 1097/**
b4235b31
MP
1098 * Return the date and time as a string
1099 **/
f7632fc6
AT
1100char *timestring(time_t t)
1101{
1102 static char TimeBuf[200];
1103 struct tm *tm = localtime(&t);
1104
4f5b0756 1105#ifdef HAVE_STRFTIME
5cb37436 1106 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
f7632fc6 1107#else
5cb37436 1108 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
f7632fc6
AT
1109#endif
1110
1111 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1112 TimeBuf[strlen(TimeBuf)-1] = 0;
1113 }
1114
1115 return(TimeBuf);
1116}
1117
9ec16c83 1118
e1bd49d6
MP
1119/**
1120 * Sleep for a specified number of milliseconds.
1121 *
1122 * Always returns TRUE. (In the future it might return FALSE if
1123 * interrupted.)
1124 **/
1125int msleep(int t)
9ec16c83 1126{
c284f34a
WD
1127 int tdiff = 0;
1128 struct timeval tval, t1, t2;
9ec16c83
AT
1129
1130 gettimeofday(&t1, NULL);
5cb37436 1131
9ec16c83
AT
1132 while (tdiff < t) {
1133 tval.tv_sec = (t-tdiff)/1000;
1134 tval.tv_usec = 1000*((t-tdiff)%1000);
5cb37436 1135
9ec16c83
AT
1136 errno = 0;
1137 select(0,NULL,NULL, NULL, &tval);
1138
1139 gettimeofday(&t2, NULL);
5cb37436 1140 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
9ec16c83
AT
1141 (t2.tv_usec - t1.tv_usec)/1000;
1142 }
e1bd49d6
MP
1143
1144 return True;
9ec16c83
AT
1145}
1146
1147
ac13ad10
MP
1148/**
1149 * Determine if two file modification times are equivalent (either
1150 * exact or in the modification timestamp window established by
1151 * --modify-window).
1152 *
1153 * @retval 0 if the times should be treated as the same
1154 *
1155 * @retval +1 if the first is later
1156 *
1157 * @retval -1 if the 2nd is later
1158 **/
5b56cc19
AT
1159int cmp_modtime(time_t file1, time_t file2)
1160{
5b56cc19 1161 if (file2 > file1) {
bc6ebcd2
WD
1162 if (file2 - file1 <= modify_window)
1163 return 0;
5b56cc19
AT
1164 return -1;
1165 }
bc6ebcd2
WD
1166 if (file1 - file2 <= modify_window)
1167 return 0;
5b56cc19
AT
1168 return 1;
1169}
1170
1171
1172#ifdef __INSURE__XX
0f8f98c8
AT
1173#include <dlfcn.h>
1174
ac13ad10
MP
1175/**
1176 This routine is a trick to immediately catch errors when debugging
1177 with insure. A xterm with a gdb is popped up when insure catches
1178 a error. It is Linux specific.
1179**/
0f8f98c8
AT
1180int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1181{
1182 static int (*fn)();
1183 int ret;
8950ac03 1184 char *cmd;
0f8f98c8 1185
5cb37436 1186 asprintf(&cmd, "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; gdb /proc/%d/exe %d'",
0f8f98c8
AT
1187 getpid(), getpid(), getpid());
1188
1189 if (!fn) {
1190 static void *h;
1191 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1192 fn = dlsym(h, "_Insure_trap_error");
1193 }
1194
1195 ret = fn(a1, a2, a3, a4, a5, a6);
1196
1197 system(cmd);
1198
8950ac03
AT
1199 free(cmd);
1200
0f8f98c8
AT
1201 return ret;
1202}
1203#endif
58cadc86
WD
1204
1205
1206#define MALLOC_MAX 0x40000000
1207
1208void *_new_array(unsigned int size, unsigned long num)
1209{
1210 if (num >= MALLOC_MAX/size)
1211 return NULL;
1212 return malloc(size * num);
1213}
1214
1215void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1216{
1217 if (num >= MALLOC_MAX/size)
1218 return NULL;
1219 /* No realloc should need this, but just in case... */
1220 if (!ptr)
1221 return malloc(size * num);
1222 return realloc(ptr, size * num);
1223}
e64ae6d7
WD
1224
1225/* Take a filename and filename length and return the most significant
1226 * filename suffix we can find. This ignores suffixes such as "~",
1227 * ".bak", ".orig", ".~1~", etc. */
1228const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1229{
1230 const char *suf, *s;
1231 BOOL had_tilde;
1232 int s_len;
1233
1234 /* One or more dots at the start aren't a suffix. */
1235 while (fn_len && *fn == '.') fn++, fn_len--;
1236
1237 /* Ignore the ~ in a "foo~" filename. */
1238 if (fn_len > 1 && fn[fn_len-1] == '~')
1239 fn_len--, had_tilde = True;
1240 else
1241 had_tilde = False;
1242
1243 /* Assume we don't find an suffix. */
1244 suf = "";
1245 *len_ptr = 0;
1246
1247 /* Find the last significant suffix. */
1248 for (s = fn + fn_len; fn_len > 1; ) {
1249 while (*--s != '.' && s != fn) {}
1250 if (s == fn)
1251 break;
1252 s_len = fn_len - (s - fn);
1253 fn_len = s - fn;
1254 if (s_len == 3) {
1255 if (strcmp(s+1, "bak") == 0
1256 || strcmp(s+1, "old") == 0)
1257 continue;
1258 } else if (s_len == 4) {
1259 if (strcmp(s+1, "orig") == 0)
1260 continue;
1261 } else if (s_len > 2 && had_tilde
73253721 1262 && s[1] == '~' && isdigit(*(uchar*)(s+2)))
e64ae6d7
WD
1263 continue;
1264 *len_ptr = s_len;
1265 suf = s;
1266 if (s_len == 1)
1267 break;
1268 /* Determine if the suffix is all digits. */
1269 for (s++, s_len--; s_len > 0; s++, s_len--) {
73253721 1270 if (!isdigit(*(uchar*)s))
e64ae6d7
WD
1271 return suf;
1272 }
1273 /* An all-digit suffix may not be that signficant. */
1274 s = suf;
1275 }
1276
1277 return suf;
1278}
1279
1280/* This is an implementation of the Levenshtein distance algorithm. It
1281 * was implemented to avoid needing a two-dimensional matrix (to save
1282 * memory). It was also tweaked to try to factor in the ASCII distance
1283 * between changed characters as a minor distance quantity. The normal
1284 * Levenshtein units of distance (each signifying a single change between
1285 * the two strings) are defined as a "UNIT". */
1286
1287#define UNIT (1 << 16)
1288
1289uint32 fuzzy_distance(const char *s1, int len1, const char *s2, int len2)
1290{
1291 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1292 int32 cost;
1293 int i1, i2;
1294
1295 if (!len1 || !len2) {
1296 if (!len1) {
1297 s1 = s2;
1298 len1 = len2;
1299 }
1300 for (i1 = 0, cost = 0; i1 < len1; i1++)
1301 cost += s1[i1];
1302 return (int32)len1 * UNIT + cost;
1303 }
1304
1305 for (i2 = 0; i2 < len2; i2++)
1306 a[i2] = (i2+1) * UNIT;
1307
1308 for (i1 = 0; i1 < len1; i1++) {
1309 diag = i1 * UNIT;
1310 above = (i1+1) * UNIT;
1311 for (i2 = 0; i2 < len2; i2++) {
1312 left = a[i2];
1313 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1314 if (cost < 0)
1315 cost = UNIT - cost;
1316 else
1317 cost = UNIT + cost;
1318 }
1319 diag_inc = diag + cost;
1320 left_inc = left + UNIT + *((uchar*)s1+i1);
1321 above_inc = above + UNIT + *((uchar*)s2+i2);
1322 a[i2] = above = left < above
1323 ? (left_inc < diag_inc ? left_inc : diag_inc)
1324 : (above_inc < diag_inc ? above_inc : diag_inc);
1325 diag = left;
1326 }
1327 }
1328
1329 return a[len2-1];
1330}