Added a description arg to check_exclude().
[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
DD
30extern int verbose;
31
0ecfbf27
MP
32int sanitize_paths = 0;
33
34
f0359dd0 35
ac13ad10 36/**
0ecfbf27
MP
37 * Set a fd into nonblocking mode
38 **/
f0359dd0
AT
39void set_nonblocking(int fd)
40{
41 int val;
42
0ecfbf27 43 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
f0359dd0
AT
44 return;
45 if (!(val & NONBLOCK_FLAG)) {
46 val |= NONBLOCK_FLAG;
47 fcntl(fd, F_SETFL, val);
48 }
49}
50
ac13ad10 51/**
0ecfbf27
MP
52 * Set a fd into blocking mode
53 **/
36349ea0
AT
54void set_blocking(int fd)
55{
56 int val;
57
0ecfbf27 58 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
36349ea0
AT
59 return;
60 if (val & NONBLOCK_FLAG) {
61 val &= ~NONBLOCK_FLAG;
62 fcntl(fd, F_SETFL, val);
63 }
64}
65
f0359dd0 66
ac13ad10 67/**
0ecfbf27
MP
68 * Create a file descriptor pair - like pipe() but use socketpair if
69 * possible (because of blocking issues on pipes).
5cb37436 70 *
0ecfbf27 71 * Always set non-blocking.
f0359dd0 72 */
08f15335
AT
73int fd_pair(int fd[2])
74{
f0359dd0
AT
75 int ret;
76
08f15335 77#if HAVE_SOCKETPAIR
f0359dd0 78 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
08f15335 79#else
f0359dd0 80 ret = pipe(fd);
08f15335 81#endif
f0359dd0
AT
82
83 if (ret == 0) {
84 set_nonblocking(fd[0]);
85 set_nonblocking(fd[1]);
86 }
0ecfbf27 87
f0359dd0 88 return ret;
08f15335
AT
89}
90
91
0ecfbf27 92void print_child_argv(char **cmd)
5ad0e46f 93{
1bbd10fe 94 rprintf(FINFO, "opening connection using ");
5ad0e46f
MP
95 for (; *cmd; cmd++) {
96 /* Look for characters that ought to be quoted. This
97 * is not a great quoting algorithm, but it's
98 * sufficient for a log message. */
99 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
100 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
101 "0123456789"
102 ",.-_=+@/") != strlen(*cmd)) {
103 rprintf(FINFO, "\"%s\" ", *cmd);
104 } else {
105 rprintf(FINFO, "%s ", *cmd);
106 }
107 }
108 rprintf(FINFO, "\n");
109}
110
111
c627d613
AT
112void out_of_memory(char *str)
113{
c284f34a
WD
114 rprintf(FERROR, "ERROR: out of memory in %s\n", str);
115 exit_cleanup(RERR_MALLOC);
575f2fca
AT
116}
117
118void overflow(char *str)
119{
c284f34a
WD
120 rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
121 exit_cleanup(RERR_MALLOC);
c627d613
AT
122}
123
124
c627d613 125
404e813c 126int set_modtime(char *fname, time_t modtime)
c627d613 127{
31e12522 128 extern int dry_run;
404e813c
MP
129 if (dry_run)
130 return 0;
131
132 if (verbose > 2) {
133 rprintf(FINFO, "set modtime of %s to (%ld) %s",
134 fname, (long) modtime,
135 asctime(localtime(&modtime)));
136 }
5cb37436 137
31e12522 138 {
1e9f155a 139#ifdef HAVE_UTIMBUF
5cb37436 140 struct utimbuf tbuf;
31e12522
AT
141 tbuf.actime = time(NULL);
142 tbuf.modtime = modtime;
143 return utime(fname,&tbuf);
c627d613 144#elif defined(HAVE_UTIME)
31e12522
AT
145 time_t t[2];
146 t[0] = time(NULL);
147 t[1] = modtime;
148 return utime(fname,t);
c627d613 149#else
31e12522
AT
150 struct timeval t[2];
151 t[0].tv_sec = time(NULL);
152 t[0].tv_usec = 0;
153 t[1].tv_sec = modtime;
154 t[1].tv_usec = 0;
155 return utimes(fname,t);
c627d613 156#endif
31e12522 157 }
c627d613 158}
94481d91 159
720b47f2 160
ac13ad10
MP
161/**
162 Create any necessary directories in fname. Unfortunately we don't know
163 what perms to give the directory when this is called so we need to rely
164 on the umask
165**/
0ecfbf27 166int create_directory_path(char *fname, int base_umask)
6574b4f7 167{
6574b4f7
AT
168 char *p;
169
c284f34a
WD
170 while (*fname == '/')
171 fname++;
172 while (strncmp(fname, "./", 2) == 0)
173 fname += 2;
6574b4f7
AT
174
175 p = fname;
c284f34a 176 while ((p = strchr(p,'/')) != NULL) {
6574b4f7 177 *p = 0;
5cb37436 178 do_mkdir(fname, 0777 & ~base_umask);
6574b4f7
AT
179 *p = '/';
180 p++;
181 }
182 return 0;
183}
950ab32d
AT
184
185
ac13ad10
MP
186/**
187 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
188 * interrupted.
189 *
190 * @retval len upon success
191 *
192 * @retval <0 write's (negative) error code
193 *
194 * Derived from GNU C's cccp.c.
195 */
9dd891bb 196static int full_write(int desc, char *ptr, size_t len)
950ab32d
AT
197{
198 int total_written;
5cb37436 199
950ab32d
AT
200 total_written = 0;
201 while (len > 0) {
5c1b7bfd 202 int written = write(desc, ptr, len);
950ab32d 203 if (written < 0) {
950ab32d
AT
204 if (errno == EINTR)
205 continue;
950ab32d
AT
206 return written;
207 }
208 total_written += written;
209 ptr += written;
210 len -= written;
211 }
212 return total_written;
213}
214
950ab32d 215
ac13ad10
MP
216/**
217 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
218 * interrupted.
219 *
220 * @retval >0 the actual number of bytes read
221 *
222 * @retval 0 for EOF
223 *
224 * @retval <0 for an error.
225 *
226 * Derived from GNU C's cccp.c. */
9dd891bb 227static int safe_read(int desc, char *ptr, size_t len)
950ab32d
AT
228{
229 int n_chars;
5cb37436 230
9dd891bb 231 if (len == 0)
950ab32d 232 return len;
5cb37436 233
950ab32d
AT
234 do {
235 n_chars = read(desc, ptr, len);
236 } while (n_chars < 0 && errno == EINTR);
5cb37436 237
950ab32d
AT
238 return n_chars;
239}
240
241
ac13ad10
MP
242/** Copy a file.
243 *
244 * This is used in conjunction with the --temp-dir option */
950ab32d
AT
245int copy_file(char *source, char *dest, mode_t mode)
246{
247 int ifd;
248 int ofd;
249 char buf[1024 * 8];
250 int len; /* Number of bytes read into `buf'. */
251
8c9fd200 252 ifd = do_open(source, O_RDONLY, 0);
950ab32d 253 if (ifd == -1) {
9486289c 254 rprintf(FERROR,"open %s: %s\n",
950ab32d
AT
255 source,strerror(errno));
256 return -1;
257 }
258
c7c11a0d 259 if (robust_unlink(dest) && errno != ENOENT) {
9486289c 260 rprintf(FERROR,"unlink %s: %s\n",
950ab32d
AT
261 dest,strerror(errno));
262 return -1;
263 }
264
31e12522 265 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
c46ded46 266 if (ofd == -1) {
9486289c 267 rprintf(FERROR,"open %s: %s\n",
950ab32d
AT
268 dest,strerror(errno));
269 close(ifd);
270 return -1;
271 }
272
5cb37436 273 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
950ab32d 274 if (full_write(ofd, buf, len) < 0) {
9486289c 275 rprintf(FERROR,"write %s: %s\n",
950ab32d
AT
276 dest,strerror(errno));
277 close(ifd);
278 close(ofd);
279 return -1;
280 }
281 }
282
283 close(ifd);
284 close(ofd);
285
286 if (len < 0) {
9486289c 287 rprintf(FERROR,"read %s: %s\n",
950ab32d
AT
288 source,strerror(errno));
289 return -1;
290 }
291
292 return 0;
293}
feaa89c4 294
c7c11a0d
DD
295/* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
296#define MAX_RENAMES_DIGITS 3
297#define MAX_RENAMES 1000
298
ac13ad10 299/**
b4235b31
MP
300 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
301 * rename to <path>/.rsyncNNN instead.
302 *
303 * Note that successive rsync runs will shuffle the filenames around a
304 * bit as long as the file is still busy; this is because this function
305 * does not know if the unlink call is due to a new file coming in, or
306 * --delete trying to remove old .rsyncNNN files, hence it renames it
307 * each time.
308 **/
c7c11a0d
DD
309int robust_unlink(char *fname)
310{
311#ifndef ETXTBSY
312 return do_unlink(fname);
313#else
314 static int counter = 1;
315 int rc, pos, start;
316 char path[MAXPATHLEN];
317
318 rc = do_unlink(fname);
c284f34a 319 if (rc == 0 || errno != ETXTBSY)
c7c11a0d
DD
320 return rc;
321
c284f34a
WD
322 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
323 pos = MAXPATHLEN - 1;
c7c11a0d 324
c284f34a
WD
325 while (pos > 0 && path[pos-1] != '/')
326 pos--;
5cb37436 327 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
c7c11a0d
DD
328
329 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
330 errno = ETXTBSY;
331 return -1;
332 }
333
334 /* start where the last one left off to reduce chance of clashes */
335 start = counter;
336 do {
337 sprintf(&path[pos], "%03d", counter);
338 if (++counter >= MAX_RENAMES)
339 counter = 1;
c284f34a 340 } while ((rc = access(path, 0)) == 0 && counter != start);
c7c11a0d 341
4791825d 342 if (verbose > 0) {
c7c11a0d 343 rprintf(FINFO,"renaming %s to %s because of text busy\n",
4791825d
WD
344 fname, path);
345 }
c7c11a0d
DD
346
347 /* maybe we should return rename()'s exit status? Nah. */
348 if (do_rename(fname, path) != 0) {
349 errno = ETXTBSY;
350 return -1;
351 }
352 return 0;
353#endif
354}
355
62c9e6b3
WD
356/* Returns 0 on success, -1 on most errors, and -2 if we got an error
357 * trying to copy the file across file systems. */
358int robust_rename(char *from, char *to, int mode)
c7c11a0d 359{
62c9e6b3
WD
360 int tries = 4;
361
362 while (tries--) {
363 if (do_rename(from, to) == 0)
364 return 0;
365
366 switch (errno) {
367#ifdef ETXTBSY
368 case ETXTBSY:
369 if (robust_unlink(to) != 0)
370 return -1;
371 break;
c7c11a0d 372#endif
62c9e6b3
WD
373 case EXDEV:
374 if (copy_file(from, to, mode) != 0)
375 return -2;
376 do_unlink(from);
377 return 0;
378 default:
379 return -1;
380 }
381 }
382 return -1;
feaa89c4 383}
3ba62a83
AT
384
385
386static pid_t all_pids[10];
387static int num_pids;
388
4cf64834 389/** Fork and record the pid of the child. **/
3ba62a83
AT
390pid_t do_fork(void)
391{
392 pid_t newpid = fork();
5cb37436 393
4cf64834 394 if (newpid != 0 && newpid != -1) {
3ba62a83
AT
395 all_pids[num_pids++] = newpid;
396 }
397 return newpid;
398}
399
4cf64834
MP
400/**
401 * Kill all children.
402 *
403 * @todo It would be kind of nice to make sure that they are actually
404 * all our children before we kill them, because their pids may have
405 * been recycled by some other process. Perhaps when we wait for a
406 * child, we should remove it from this array. Alternatively we could
407 * perhaps use process groups, but I think that would not work on
408 * ancient Unix versions that don't support them.
409 **/
3ba62a83
AT
410void kill_all(int sig)
411{
412 int i;
4cf64834
MP
413
414 for (i = 0; i < num_pids; i++) {
415 /* Let's just be a little careful where we
416 * point that gun, hey? See kill(2) for the
417 * magic caused by negative values. */
418 pid_t p = all_pids[i];
419
420 if (p == getpid())
421 continue;
422 if (p <= 0)
423 continue;
424
425 kill(p, sig);
3ba62a83
AT
426 }
427}
9486289c 428
4cf64834 429
ac13ad10 430/** Turn a user name into a uid */
8ef4ffd6
AT
431int name_to_uid(char *name, uid_t *uid)
432{
433 struct passwd *pass;
434 if (!name || !*name) return 0;
435 pass = getpwnam(name);
436 if (pass) {
437 *uid = pass->pw_uid;
438 return 1;
439 }
440 return 0;
441}
442
ac13ad10 443/** Turn a group name into a gid */
8ef4ffd6
AT
444int name_to_gid(char *name, gid_t *gid)
445{
446 struct group *grp;
447 if (!name || !*name) return 0;
448 grp = getgrnam(name);
449 if (grp) {
450 *gid = grp->gr_gid;
451 return 1;
452 }
453 return 0;
454}
455
ff8b29b8 456
ac13ad10 457/** Lock a byte range in a open file */
31593dd6 458int lock_range(int fd, int offset, int len)
0c515f17 459{
31593dd6 460 struct flock lock;
0c515f17 461
31593dd6
AT
462 lock.l_type = F_WRLCK;
463 lock.l_whence = SEEK_SET;
464 lock.l_start = offset;
465 lock.l_len = len;
466 lock.l_pid = 0;
5cb37436 467
31593dd6 468 return fcntl(fd,F_SETLK,&lock) == 0;
0c515f17 469}
874895d5 470
4791825d
WD
471static int exclude_server_path(char *arg)
472{
473 char *s;
474 extern struct exclude_struct **server_exclude_list;
475
476 if (server_exclude_list) {
477 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
478 *s = '\0';
5387514e
WD
479 if (check_exclude(server_exclude_list, arg, 1,
480 "server pattern")) {
4791825d
WD
481 /* We must leave arg truncated! */
482 return 1;
483 }
484 *s++ = '/';
485 }
486 }
487 return 0;
488}
874895d5 489
cb13abfe 490static void glob_expand_one(char *s, char **argv, int *argc, int maxargs)
874895d5 491{
932be9aa 492#if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
e42c9458 493 if (!*s) s = ".";
4791825d
WD
494 s = argv[*argc] = strdup(s);
495 exclude_server_path(s);
874895d5 496 (*argc)++;
874895d5 497#else
cb13abfe 498 extern int sanitize_paths;
874895d5
AT
499 glob_t globbuf;
500 int i;
501
e42c9458
AT
502 if (!*s) s = ".";
503
4791825d 504 s = argv[*argc] = strdup(s);
cb13abfe 505 if (sanitize_paths) {
4791825d 506 sanitize_path(s, NULL);
cb13abfe 507 }
087bf010 508
5cb37436 509 memset(&globbuf, 0, sizeof globbuf);
4791825d
WD
510 if (!exclude_server_path(s))
511 glob(s, 0, NULL, &globbuf);
874895d5
AT
512 if (globbuf.gl_pathc == 0) {
513 (*argc)++;
514 globfree(&globbuf);
515 return;
516 }
c284f34a
WD
517 for (i = 0; i < maxargs - *argc && i < (int)globbuf.gl_pathc; i++) {
518 if (i == 0)
519 free(s);
520 argv[*argc + i] = strdup(globbuf.gl_pathv[i]);
521 if (!argv[*argc + i])
522 out_of_memory("glob_expand");
874895d5
AT
523 }
524 globfree(&globbuf);
c284f34a 525 *argc += i;
874895d5
AT
526#endif
527}
5a96ee05 528
4791825d 529/* This routine is only used in daemon mode. */
cb13abfe 530void glob_expand(char *base1, char **argv, int *argc, int maxargs)
087bf010
AT
531{
532 char *s = argv[*argc];
533 char *p, *q;
ba5e128d 534 char *base = base1;
4791825d 535 int base_len = strlen(base);
087bf010
AT
536
537 if (!s || !*s) return;
538
4791825d
WD
539 if (strncmp(s, base, base_len) == 0)
540 s += base_len;
e42c9458 541
087bf010
AT
542 s = strdup(s);
543 if (!s) out_of_memory("glob_expand");
544
8950ac03 545 if (asprintf(&base," %s/", base1) <= 0) out_of_memory("glob_expand");
4791825d 546 base_len++;
ba5e128d 547
087bf010 548 q = s;
c284f34a 549 while ((p = strstr(q,base)) != NULL && *argc < maxargs) {
ba5e128d
AT
550 /* split it at this point */
551 *p = 0;
cb13abfe 552 glob_expand_one(q, argv, argc, maxargs);
4791825d 553 q = p + base_len;
087bf010
AT
554 }
555
c284f34a
WD
556 if (*q && *argc < maxargs)
557 glob_expand_one(q, argv, argc, maxargs);
087bf010
AT
558
559 free(s);
ba5e128d 560 free(base);
087bf010 561}
5a96ee05 562
ac13ad10
MP
563/**
564 * Convert a string to lower case
565 **/
5a96ee05
AT
566void strlower(char *s)
567{
568 while (*s) {
32f76175
MP
569 if (isupper(* (unsigned char *) s))
570 *s = tolower(* (unsigned char *) s);
5a96ee05
AT
571 s++;
572 }
573}
e42c9458 574
368ad70e
WD
575/* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
576 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
a8f7e4b8
WD
577 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
578 * string fits into destsize. */
368ad70e
WD
579size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
580{
581 size_t len = strlcpy(dest, p1, destsize);
582 if (len < destsize - 1) {
583 if (!len || dest[len-1] != '/')
584 dest[len++] = '/';
585 if (len < destsize - 1)
586 len += strlcpy(dest + len, p2, destsize - len);
587 else {
588 dest[len] = '\0';
589 len += strlen(p2);
590 }
591 }
592 else
593 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
594 return len;
595}
596
597/* Join any number of strings together, putting them in "dest". The return
a8f7e4b8
WD
598 * value is the length of all the strings, regardless of whether the null-
599 * terminated whole fits in destsize. Your list of string pointers must end
600 * with a NULL to indicate the end of the list. */
368ad70e
WD
601size_t stringjoin(char *dest, size_t destsize, ...)
602{
5cb37436 603 va_list ap;
368ad70e
WD
604 size_t len, ret = 0;
605 const char *src;
606
607 va_start(ap, destsize);
608 while (1) {
609 if (!(src = va_arg(ap, const char *)))
610 break;
611 len = strlen(src);
612 ret += len;
613 if (destsize > 1) {
614 if (len >= destsize)
615 len = destsize - 1;
616 memcpy(dest, src, len);
617 destsize -= len;
618 dest += len;
619 }
620 }
621 *dest = '\0';
622 va_end(ap);
623
624 return ret;
625}
626
5243c216
AT
627void clean_fname(char *name)
628{
629 char *p;
630 int l;
631 int modified = 1;
632
633 if (!name) return;
634
635 while (modified) {
636 modified = 0;
637
c284f34a 638 if ((p = strstr(name,"/./")) != NULL) {
5243c216
AT
639 modified = 1;
640 while (*p) {
641 p[0] = p[2];
642 p++;
643 }
644 }
645
c284f34a 646 if ((p = strstr(name,"//")) != NULL) {
5243c216
AT
647 modified = 1;
648 while (*p) {
649 p[0] = p[1];
650 p++;
651 }
652 }
653
c284f34a 654 if (strncmp(p = name, "./", 2) == 0) {
5243c216
AT
655 modified = 1;
656 do {
657 p[0] = p[2];
658 } while (*p++);
659 }
660
c284f34a 661 l = strlen(p = name);
5243c216
AT
662 if (l > 1 && p[l-1] == '/') {
663 modified = 1;
664 p[l-1] = 0;
665 }
666 }
667}
668
ac13ad10 669/**
1b8e662a 670 * Make path appear as if a chroot had occurred:
ac13ad10 671 *
b4235b31
MP
672 * @li 1. remove leading "/" (or replace with "." if at end)
673 *
674 * @li 2. remove leading ".." components (except those allowed by @p reldir)
675 *
676 * @li 3. delete any other "<dir>/.." (recursively)
ac13ad10 677 *
79452d46 678 * Can only shrink paths, so sanitizes in place.
ac13ad10 679 *
b5f9e67d 680 * While we're at it, remove double slashes and "." components like
b4235b31 681 * clean_fname() does, but DON'T remove a trailing slash because that
b5f9e67d 682 * is sometimes significant on command line arguments.
ac13ad10 683 *
b4235b31 684 * If @p reldir is non-null, it is a sanitized directory that the path will be
79452d46
DD
685 * relative to, so allow as many ".." at the beginning of the path as
686 * there are components in reldir. This is used for symbolic link targets.
687 * If reldir is non-null and the path began with "/", to be completely like
688 * a chroot we should add in depth levels of ".." at the beginning of the
689 * path, but that would blow the assumption that the path doesn't grow and
690 * it is not likely to end up being a valid symlink anyway, so just do
691 * the normal removal of the leading "/" instead.
ac13ad10 692 *
1b8e662a
DD
693 * Contributed by Dave Dykstra <dwd@bell-labs.com>
694 */
cb13abfe 695void sanitize_path(char *p, char *reldir)
1b8e662a 696{
44e2e578 697 char *start, *sanp;
cb13abfe
DD
698 int depth = 0;
699 int allowdotdot = 0;
700
701 if (reldir) {
702 depth++;
703 while (*reldir) {
704 if (*reldir++ == '/') {
705 depth++;
706 }
707 }
708 }
44e2e578
DD
709 start = p;
710 sanp = p;
b5f9e67d
DD
711 while (*p == '/') {
712 /* remove leading slashes */
713 p++;
714 }
1b8e662a 715 while (*p != '\0') {
b5f9e67d 716 /* this loop iterates once per filename component in p.
44e2e578 717 * both p (and sanp if the original had a slash) should
b5f9e67d
DD
718 * always be left pointing after a slash
719 */
c284f34a 720 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
b5f9e67d
DD
721 /* skip "." component */
722 while (*++p == '/') {
723 /* skip following slashes */
724 ;
725 }
cb13abfe
DD
726 continue;
727 }
728 allowdotdot = 0;
c284f34a 729 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
cb13abfe 730 /* ".." component followed by slash or end */
c284f34a 731 if (depth > 0 && sanp == start) {
cb13abfe
DD
732 /* allow depth levels of .. at the beginning */
733 --depth;
734 allowdotdot = 1;
735 } else {
736 p += 2;
737 if (*p == '/')
738 p++;
739 if (sanp != start) {
740 /* back up sanp one level */
741 --sanp; /* now pointing at slash */
c284f34a 742 while (sanp > start && sanp[-1] != '/') {
cb13abfe
DD
743 /* skip back up to slash */
744 sanp--;
745 }
b5f9e67d 746 }
cb13abfe 747 continue;
1b8e662a 748 }
cb13abfe
DD
749 }
750 while (1) {
751 /* copy one component through next slash */
752 *sanp++ = *p++;
42509417 753 if (*p == '\0' || p[-1] == '/') {
cb13abfe
DD
754 while (*p == '/') {
755 /* skip multiple slashes */
756 p++;
b5f9e67d 757 }
cb13abfe 758 break;
1b8e662a
DD
759 }
760 }
cb13abfe
DD
761 if (allowdotdot) {
762 /* move the virtual beginning to leave the .. alone */
763 start = sanp;
764 }
1b8e662a 765 }
c284f34a 766 if (sanp == start && !allowdotdot) {
b5f9e67d 767 /* ended up with nothing, so put in "." component */
79452d46
DD
768 /*
769 * note that the !allowdotdot doesn't prevent this from
770 * happening in all allowed ".." situations, but I didn't
771 * think it was worth putting in an extra variable to ensure
772 * it since an extra "." won't hurt in those situations.
773 */
44e2e578 774 *sanp++ = '.';
b5f9e67d 775 }
44e2e578 776 *sanp = '\0';
1b8e662a
DD
777}
778
14b61c63
WD
779/* Works much like sanitize_path(), with these differences: (1) a new buffer
780 * is allocated for the sanitized path rather than modifying it in-place; (2)
781 * a leading slash gets transformed into the rootdir value (which can be empty
782 * or NULL if you just want the slash to get dropped); (3) no "reldir" can be
783 * specified. */
784char *alloc_sanitize_path(const char *path, const char *rootdir)
785{
786 char *buf;
787 int rlen, plen = strlen(path);
788
789 if (*path == '/' && rootdir)
790 rlen = strlen(rootdir);
791 else
792 rlen = 0;
793 if (!(buf = new_array(char, rlen + plen + 1)))
794 out_of_memory("alloc_sanitize_path");
795 if (rlen)
796 memcpy(buf, rootdir, rlen);
797 memcpy(buf + rlen, path, plen + 1);
798
799 if (rlen)
800 rlen++;
801 sanitize_path(buf + rlen, NULL);
802 if (rlen && buf[rlen] == '.' && buf[rlen+1] == '\0')
803 buf[rlen-1] = '\0';
804
805 return buf;
806}
5243c216 807
4791825d 808char curr_dir[MAXPATHLEN];
4af8fe4e 809unsigned int curr_dir_len;
5243c216 810
4e5db0ad 811/**
a16d8f2b
WD
812 * Like chdir(), but it keeps track of the current directory (in the
813 * global "curr_dir"), and ensures that the path size doesn't overflow.
814 * Also cleans the path using the clean_fname() function.
4e5db0ad 815 **/
4af8fe4e 816int push_dir(char *dir)
5243c216 817{
5243c216 818 static int initialised;
4af8fe4e 819 unsigned int len;
5243c216
AT
820
821 if (!initialised) {
822 initialised = 1;
5cb37436 823 getcwd(curr_dir, sizeof curr_dir - 1);
4af8fe4e 824 curr_dir_len = strlen(curr_dir);
5243c216
AT
825 }
826
4af8fe4e
WD
827 if (!dir) /* this call was probably just to initialize */
828 return 0;
c226b7c2 829
4af8fe4e
WD
830 len = strlen(dir);
831 if (len == 1 && *dir == '.')
832 return 1;
5243c216 833
4af8fe4e
WD
834 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
835 return 0;
836
837 if (chdir(dir))
838 return 0;
5243c216
AT
839
840 if (*dir == '/') {
4af8fe4e
WD
841 memcpy(curr_dir, dir, len + 1);
842 curr_dir_len = len;
843 } else {
844 curr_dir[curr_dir_len++] = '/';
845 memcpy(curr_dir + curr_dir_len, dir, len + 1);
846 curr_dir_len += len;
5243c216
AT
847 }
848
849 clean_fname(curr_dir);
850
4af8fe4e 851 return 1;
5243c216
AT
852}
853
a16d8f2b
WD
854/**
855 * Reverse a push_dir() call. You must pass in an absolute path
856 * that was copied from a prior value of "curr_dir".
857 **/
5243c216
AT
858int pop_dir(char *dir)
859{
4af8fe4e
WD
860 if (chdir(dir))
861 return 0;
5243c216 862
4af8fe4e
WD
863 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
864 if (curr_dir_len >= sizeof curr_dir)
865 curr_dir_len = sizeof curr_dir - 1;
5243c216 866
4af8fe4e 867 return 1;
5243c216 868}
aa9b77a5 869
eb61be19
WD
870/**
871 * Return a quoted string with the full pathname of the indicated filename.
872 * The string " (in MODNAME)" may also be appended. The returned pointer
873 * remains valid until the next time full_fname() is called.
874 **/
875char *full_fname(char *fn)
876{
877 extern int module_id;
878 static char *result = NULL;
879 char *m1, *m2, *m3;
880 char *p1, *p2;
881
882 if (result)
883 free(result);
884
885 if (*fn == '/')
886 p1 = p2 = "";
887 else {
888 p1 = curr_dir;
889 p2 = "/";
890 }
891 if (module_id >= 0) {
892 m1 = " (in ";
893 m2 = lp_name(module_id);
894 m3 = ")";
895 if (*p1) {
896 if (!lp_use_chroot(module_id)) {
897 char *p = lp_path(module_id);
898 if (*p != '/' || p[1])
899 p1 += strlen(p);
900 }
901 if (!*p1)
902 p2++;
903 else
904 p1++;
905 }
906 else
907 fn++;
908 } else
909 m1 = m2 = m3 = "";
910
911 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
912
913 return result;
914}
915
ac13ad10 916/** We need to supply our own strcmp function for file list comparisons
aa9b77a5
AT
917 to ensure that signed/unsigned usage is consistent between machines. */
918int u_strcmp(const char *cs1, const char *cs2)
919{
5a788ade
AT
920 const uchar *s1 = (const uchar *)cs1;
921 const uchar *s2 = (const uchar *)cs2;
aa9b77a5
AT
922
923 while (*s1 && *s2 && (*s1 == *s2)) {
924 s1++; s2++;
925 }
5cb37436 926
aa9b77a5
AT
927 return (int)*s1 - (int)*s2;
928}
eb86d661 929
4b957c22 930
ac13ad10
MP
931
932/**
933 * Determine if a symlink points outside the current directory tree.
036e70b0
MP
934 * This is considered "unsafe" because e.g. when mirroring somebody
935 * else's machine it might allow them to establish a symlink to
936 * /etc/passwd, and then read it through a web server.
937 *
4e5db0ad
MP
938 * Null symlinks and absolute symlinks are always unsafe.
939 *
940 * Basically here we are concerned with symlinks whose target contains
941 * "..", because this might cause us to walk back up out of the
942 * transferred directory. We are not allowed to go back up and
943 * reenter.
944 *
036e70b0
MP
945 * @param dest Target of the symlink in question.
946 *
25d34a5c 947 * @param src Top source directory currently applicable. Basically this
036e70b0 948 * is the first parameter to rsync in a simple invocation, but it's
25d34a5c 949 * modified by flist.c in slightly complex ways.
036e70b0
MP
950 *
951 * @retval True if unsafe
952 * @retval False is unsafe
4e5db0ad
MP
953 *
954 * @sa t_unsafe.c
ac13ad10 955 **/
7afa3a4a 956int unsafe_symlink(const char *dest, const char *src)
4b957c22 957{
7afa3a4a 958 const char *name, *slash;
4b957c22
AT
959 int depth = 0;
960
961 /* all absolute and null symlinks are unsafe */
7afa3a4a 962 if (!dest || !*dest || *dest == '/') return 1;
4b957c22
AT
963
964 /* find out what our safety margin is */
7afa3a4a
WD
965 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
966 if (strncmp(name, "../", 3) == 0) {
c284f34a 967 depth = 0;
7afa3a4a 968 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
969 /* nothing */
970 } else {
971 depth++;
972 }
973 }
7afa3a4a
WD
974 if (strcmp(name, "..") == 0)
975 depth = 0;
4b957c22 976
7afa3a4a
WD
977 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
978 if (strncmp(name, "../", 3) == 0) {
979 /* if at any point we go outside the current directory
980 then stop - it is unsafe */
981 if (--depth < 0)
982 return 1;
983 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
984 /* nothing */
985 } else {
986 depth++;
987 }
4b957c22 988 }
7afa3a4a
WD
989 if (strcmp(name, "..") == 0)
990 depth--;
4b957c22 991
4b957c22
AT
992 return (depth < 0);
993}
375a4556 994
f7632fc6 995
ac13ad10 996/**
b4235b31
MP
997 * Return the date and time as a string
998 **/
f7632fc6
AT
999char *timestring(time_t t)
1000{
1001 static char TimeBuf[200];
1002 struct tm *tm = localtime(&t);
1003
1004#ifdef HAVE_STRFTIME
5cb37436 1005 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
f7632fc6 1006#else
5cb37436 1007 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
f7632fc6
AT
1008#endif
1009
1010 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1011 TimeBuf[strlen(TimeBuf)-1] = 0;
1012 }
1013
1014 return(TimeBuf);
1015}
1016
9ec16c83 1017
e1bd49d6
MP
1018/**
1019 * Sleep for a specified number of milliseconds.
1020 *
1021 * Always returns TRUE. (In the future it might return FALSE if
1022 * interrupted.)
1023 **/
1024int msleep(int t)
9ec16c83 1025{
c284f34a
WD
1026 int tdiff = 0;
1027 struct timeval tval, t1, t2;
9ec16c83
AT
1028
1029 gettimeofday(&t1, NULL);
1030 gettimeofday(&t2, NULL);
5cb37436 1031
9ec16c83
AT
1032 while (tdiff < t) {
1033 tval.tv_sec = (t-tdiff)/1000;
1034 tval.tv_usec = 1000*((t-tdiff)%1000);
5cb37436 1035
9ec16c83
AT
1036 errno = 0;
1037 select(0,NULL,NULL, NULL, &tval);
1038
1039 gettimeofday(&t2, NULL);
5cb37436 1040 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
9ec16c83
AT
1041 (t2.tv_usec - t1.tv_usec)/1000;
1042 }
e1bd49d6
MP
1043
1044 return True;
9ec16c83
AT
1045}
1046
1047
ac13ad10
MP
1048/**
1049 * Determine if two file modification times are equivalent (either
1050 * exact or in the modification timestamp window established by
1051 * --modify-window).
1052 *
1053 * @retval 0 if the times should be treated as the same
1054 *
1055 * @retval +1 if the first is later
1056 *
1057 * @retval -1 if the 2nd is later
1058 **/
5b56cc19
AT
1059int cmp_modtime(time_t file1, time_t file2)
1060{
5b56cc19
AT
1061 extern int modify_window;
1062
1063 if (file2 > file1) {
1064 if (file2 - file1 <= modify_window) return 0;
1065 return -1;
1066 }
1067 if (file1 - file2 <= modify_window) return 0;
1068 return 1;
1069}
1070
1071
1072#ifdef __INSURE__XX
0f8f98c8
AT
1073#include <dlfcn.h>
1074
ac13ad10
MP
1075/**
1076 This routine is a trick to immediately catch errors when debugging
1077 with insure. A xterm with a gdb is popped up when insure catches
1078 a error. It is Linux specific.
1079**/
0f8f98c8
AT
1080int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1081{
1082 static int (*fn)();
1083 int ret;
8950ac03 1084 char *cmd;
0f8f98c8 1085
5cb37436 1086 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
1087 getpid(), getpid(), getpid());
1088
1089 if (!fn) {
1090 static void *h;
1091 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1092 fn = dlsym(h, "_Insure_trap_error");
1093 }
1094
1095 ret = fn(a1, a2, a3, a4, a5, a6);
1096
1097 system(cmd);
1098
8950ac03
AT
1099 free(cmd);
1100
0f8f98c8
AT
1101 return ret;
1102}
1103#endif
58cadc86
WD
1104
1105
1106#define MALLOC_MAX 0x40000000
1107
1108void *_new_array(unsigned int size, unsigned long num)
1109{
1110 if (num >= MALLOC_MAX/size)
1111 return NULL;
1112 return malloc(size * num);
1113}
1114
1115void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1116{
1117 if (num >= MALLOC_MAX/size)
1118 return NULL;
1119 /* No realloc should need this, but just in case... */
1120 if (!ptr)
1121 return malloc(size * num);
1122 return realloc(ptr, size * num);
1123}