- Document the change to --copy-links.
[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;
bf6dcd17 35extern struct exclude_list_struct server_exclude_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
08f15335 82#if 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)) {
108 rprintf(FINFO, "\"%s\" ", *cmd);
109 } else {
110 rprintf(FINFO, "%s ", *cmd);
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 (dry_run)
134 return 0;
135
136 if (verbose > 2) {
137 rprintf(FINFO, "set modtime of %s to (%ld) %s",
b5bd5542 138 fname, (long)modtime,
404e813c
MP
139 asctime(localtime(&modtime)));
140 }
5cb37436 141
31e12522 142 {
1e9f155a 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);
c627d613 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 */
9dd891bb 200static int 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 *
248 * This is used in conjunction with the --temp-dir option */
950ab32d
AT
249int copy_file(char *source, char *dest, mode_t mode)
250{
251 int ifd;
252 int ofd;
253 char buf[1024 * 8];
254 int len; /* Number of bytes read into `buf'. */
255
8c9fd200 256 ifd = do_open(source, O_RDONLY, 0);
950ab32d 257 if (ifd == -1) {
d62bcc17 258 rsyserr(FERROR, errno, "open %s", full_fname(source));
950ab32d
AT
259 return -1;
260 }
261
c7c11a0d 262 if (robust_unlink(dest) && errno != ENOENT) {
d62bcc17 263 rsyserr(FERROR, errno, "unlink %s", full_fname(dest));
950ab32d
AT
264 return -1;
265 }
266
31e12522 267 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
c46ded46 268 if (ofd == -1) {
d62bcc17 269 rsyserr(FERROR, errno, "open %s", full_fname(dest));
950ab32d
AT
270 close(ifd);
271 return -1;
272 }
273
5cb37436 274 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
950ab32d 275 if (full_write(ofd, buf, len) < 0) {
d62bcc17 276 rsyserr(FERROR, errno, "write %s", full_fname(dest));
950ab32d
AT
277 close(ifd);
278 close(ofd);
279 return -1;
280 }
281 }
282
8b602edd 283 if (len < 0) {
d62bcc17 284 rsyserr(FERROR, errno, "read %s", full_fname(source));
8b602edd
WD
285 close(ifd);
286 close(ofd);
287 return -1;
288 }
289
9f27cd8c 290 if (close(ifd) < 0) {
d62bcc17
WD
291 rsyserr(FINFO, errno, "close failed on %s",
292 full_fname(source));
9f27cd8c
WD
293 }
294
295 if (close(ofd) < 0) {
d62bcc17
WD
296 rsyserr(FERROR, errno, "close failed on %s",
297 full_fname(dest));
9f27cd8c
WD
298 return -1;
299 }
950ab32d 300
950ab32d
AT
301 return 0;
302}
feaa89c4 303
c7c11a0d
DD
304/* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
305#define MAX_RENAMES_DIGITS 3
306#define MAX_RENAMES 1000
307
ac13ad10 308/**
b4235b31
MP
309 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
310 * rename to <path>/.rsyncNNN instead.
311 *
312 * Note that successive rsync runs will shuffle the filenames around a
313 * bit as long as the file is still busy; this is because this function
314 * does not know if the unlink call is due to a new file coming in, or
315 * --delete trying to remove old .rsyncNNN files, hence it renames it
316 * each time.
317 **/
c7c11a0d
DD
318int robust_unlink(char *fname)
319{
320#ifndef ETXTBSY
321 return do_unlink(fname);
322#else
323 static int counter = 1;
324 int rc, pos, start;
325 char path[MAXPATHLEN];
326
327 rc = do_unlink(fname);
c284f34a 328 if (rc == 0 || errno != ETXTBSY)
c7c11a0d
DD
329 return rc;
330
c284f34a
WD
331 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
332 pos = MAXPATHLEN - 1;
c7c11a0d 333
c284f34a
WD
334 while (pos > 0 && path[pos-1] != '/')
335 pos--;
5cb37436 336 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
c7c11a0d
DD
337
338 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
339 errno = ETXTBSY;
340 return -1;
341 }
342
343 /* start where the last one left off to reduce chance of clashes */
344 start = counter;
345 do {
346 sprintf(&path[pos], "%03d", counter);
347 if (++counter >= MAX_RENAMES)
348 counter = 1;
c284f34a 349 } while ((rc = access(path, 0)) == 0 && counter != start);
c7c11a0d 350
4791825d 351 if (verbose > 0) {
c7c11a0d 352 rprintf(FINFO,"renaming %s to %s because of text busy\n",
4791825d
WD
353 fname, path);
354 }
c7c11a0d
DD
355
356 /* maybe we should return rename()'s exit status? Nah. */
357 if (do_rename(fname, path) != 0) {
358 errno = ETXTBSY;
359 return -1;
360 }
361 return 0;
362#endif
363}
364
62c9e6b3
WD
365/* Returns 0 on success, -1 on most errors, and -2 if we got an error
366 * trying to copy the file across file systems. */
367int robust_rename(char *from, char *to, int mode)
c7c11a0d 368{
62c9e6b3
WD
369 int tries = 4;
370
371 while (tries--) {
372 if (do_rename(from, to) == 0)
373 return 0;
374
375 switch (errno) {
376#ifdef ETXTBSY
377 case ETXTBSY:
378 if (robust_unlink(to) != 0)
379 return -1;
380 break;
c7c11a0d 381#endif
62c9e6b3
WD
382 case EXDEV:
383 if (copy_file(from, to, mode) != 0)
384 return -2;
385 do_unlink(from);
386 return 0;
387 default:
388 return -1;
389 }
390 }
391 return -1;
feaa89c4 392}
3ba62a83
AT
393
394
395static pid_t all_pids[10];
396static int num_pids;
397
4cf64834 398/** Fork and record the pid of the child. **/
3ba62a83
AT
399pid_t do_fork(void)
400{
401 pid_t newpid = fork();
5cb37436 402
4cf64834 403 if (newpid != 0 && newpid != -1) {
3ba62a83
AT
404 all_pids[num_pids++] = newpid;
405 }
406 return newpid;
407}
408
4cf64834
MP
409/**
410 * Kill all children.
411 *
412 * @todo It would be kind of nice to make sure that they are actually
413 * all our children before we kill them, because their pids may have
414 * been recycled by some other process. Perhaps when we wait for a
415 * child, we should remove it from this array. Alternatively we could
416 * perhaps use process groups, but I think that would not work on
417 * ancient Unix versions that don't support them.
418 **/
3ba62a83
AT
419void kill_all(int sig)
420{
421 int i;
4cf64834
MP
422
423 for (i = 0; i < num_pids; i++) {
424 /* Let's just be a little careful where we
425 * point that gun, hey? See kill(2) for the
426 * magic caused by negative values. */
427 pid_t p = all_pids[i];
428
429 if (p == getpid())
430 continue;
431 if (p <= 0)
432 continue;
433
434 kill(p, sig);
3ba62a83
AT
435 }
436}
9486289c 437
4cf64834 438
ac13ad10 439/** Turn a user name into a uid */
8ef4ffd6
AT
440int name_to_uid(char *name, uid_t *uid)
441{
442 struct passwd *pass;
b5bd5542
WD
443 if (!name || !*name)
444 return 0;
8ef4ffd6
AT
445 pass = getpwnam(name);
446 if (pass) {
447 *uid = pass->pw_uid;
448 return 1;
449 }
450 return 0;
451}
452
ac13ad10 453/** Turn a group name into a gid */
8ef4ffd6
AT
454int name_to_gid(char *name, gid_t *gid)
455{
456 struct group *grp;
b5bd5542
WD
457 if (!name || !*name)
458 return 0;
8ef4ffd6
AT
459 grp = getgrnam(name);
460 if (grp) {
461 *gid = grp->gr_gid;
462 return 1;
463 }
464 return 0;
465}
466
ff8b29b8 467
ac13ad10 468/** Lock a byte range in a open file */
31593dd6 469int lock_range(int fd, int offset, int len)
0c515f17 470{
31593dd6 471 struct flock lock;
0c515f17 472
31593dd6
AT
473 lock.l_type = F_WRLCK;
474 lock.l_whence = SEEK_SET;
475 lock.l_start = offset;
476 lock.l_len = len;
477 lock.l_pid = 0;
5cb37436 478
31593dd6 479 return fcntl(fd,F_SETLK,&lock) == 0;
0c515f17 480}
874895d5 481
4791825d
WD
482static int exclude_server_path(char *arg)
483{
484 char *s;
4791825d 485
bf6dcd17 486 if (server_exclude_list.head) {
4791825d
WD
487 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
488 *s = '\0';
9fdb334e 489 if (check_exclude(&server_exclude_list, arg, 1) < 0) {
4791825d
WD
490 /* We must leave arg truncated! */
491 return 1;
492 }
493 *s++ = '/';
494 }
495 }
496 return 0;
497}
874895d5 498
b7061c82
WD
499static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
500 int *maxargs_ptr)
874895d5 501{
b7061c82 502 char **argv = *argv_ptr;
b5bd5542 503 int argc = *argc_ptr;
b7061c82 504 int maxargs = *maxargs_ptr;
932be9aa 505#if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
b7061c82
WD
506 if (argc == maxargs) {
507 maxargs += MAX_ARGS;
508 if (!(argv = realloc_array(argv, char *, maxargs)))
509 out_of_memory("glob_expand_one");
510 *argv_ptr = argv;
511 *maxargs_ptr = maxargs;
512 }
4135d091
WD
513 if (!*s)
514 s = ".";
b5bd5542 515 s = argv[argc++] = strdup(s);
4791825d 516 exclude_server_path(s);
874895d5
AT
517#else
518 glob_t globbuf;
519 int i;
520
b5bd5542
WD
521 if (maxargs <= argc)
522 return;
4135d091
WD
523 if (!*s)
524 s = ".";
e42c9458 525
b5bd5542 526 s = strdup(s);
4135d091 527 if (sanitize_paths)
4791825d 528 sanitize_path(s, NULL);
087bf010 529
5cb37436 530 memset(&globbuf, 0, sizeof globbuf);
4791825d
WD
531 if (!exclude_server_path(s))
532 glob(s, 0, NULL, &globbuf);
b7061c82
WD
533 if (MAX((int)globbuf.gl_pathc, 1) > maxargs - argc) {
534 maxargs += globbuf.gl_pathc + MAX_ARGS;
535 if (!(argv = realloc_array(argv, char *, maxargs)))
536 out_of_memory("glob_expand_one");
537 *argv_ptr = argv;
538 *maxargs_ptr = maxargs;
539 }
b5bd5542
WD
540 if (globbuf.gl_pathc == 0)
541 argv[argc++] = s;
542 else {
543 int j = globbuf.gl_pathc;
b5bd5542
WD
544 free(s);
545 for (i = 0; i < j; i++) {
546 if (!(argv[argc++] = strdup(globbuf.gl_pathv[i])))
547 out_of_memory("glob_expand_one");
548 }
874895d5
AT
549 }
550 globfree(&globbuf);
874895d5 551#endif
b5bd5542 552 *argc_ptr = argc;
874895d5 553}
5a96ee05 554
4791825d 555/* This routine is only used in daemon mode. */
b7061c82 556void glob_expand(char *base1, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
087bf010 557{
b7061c82 558 char *s = (*argv_ptr)[*argc_ptr];
087bf010 559 char *p, *q;
ba5e128d 560 char *base = base1;
4791825d 561 int base_len = strlen(base);
087bf010 562
b5bd5542
WD
563 if (!s || !*s)
564 return;
087bf010 565
4791825d
WD
566 if (strncmp(s, base, base_len) == 0)
567 s += base_len;
e42c9458 568
b5bd5542
WD
569 if (!(s = strdup(s)))
570 out_of_memory("glob_expand");
087bf010 571
b5bd5542
WD
572 if (asprintf(&base," %s/", base1) <= 0)
573 out_of_memory("glob_expand");
4791825d 574 base_len++;
ba5e128d 575
b5bd5542
WD
576 for (q = s; *q; q = p + base_len) {
577 if ((p = strstr(q, base)) != NULL)
578 *p = '\0'; /* split it at this point */
b7061c82 579 glob_expand_one(q, argv_ptr, argc_ptr, maxargs_ptr);
b5bd5542
WD
580 if (!p)
581 break;
087bf010
AT
582 }
583
087bf010 584 free(s);
ba5e128d 585 free(base);
087bf010 586}
5a96ee05 587
ac13ad10
MP
588/**
589 * Convert a string to lower case
590 **/
5a96ee05
AT
591void strlower(char *s)
592{
593 while (*s) {
b5bd5542
WD
594 if (isupper(*(unsigned char *)s))
595 *s = tolower(*(unsigned char *)s);
5a96ee05
AT
596 s++;
597 }
598}
e42c9458 599
368ad70e
WD
600/* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
601 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
a8f7e4b8
WD
602 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
603 * string fits into destsize. */
368ad70e
WD
604size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
605{
606 size_t len = strlcpy(dest, p1, destsize);
607 if (len < destsize - 1) {
608 if (!len || dest[len-1] != '/')
609 dest[len++] = '/';
610 if (len < destsize - 1)
611 len += strlcpy(dest + len, p2, destsize - len);
612 else {
613 dest[len] = '\0';
614 len += strlen(p2);
615 }
616 }
617 else
618 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
619 return len;
620}
621
622/* Join any number of strings together, putting them in "dest". The return
a8f7e4b8
WD
623 * value is the length of all the strings, regardless of whether the null-
624 * terminated whole fits in destsize. Your list of string pointers must end
625 * with a NULL to indicate the end of the list. */
368ad70e
WD
626size_t stringjoin(char *dest, size_t destsize, ...)
627{
5cb37436 628 va_list ap;
368ad70e
WD
629 size_t len, ret = 0;
630 const char *src;
631
632 va_start(ap, destsize);
633 while (1) {
634 if (!(src = va_arg(ap, const char *)))
635 break;
636 len = strlen(src);
637 ret += len;
638 if (destsize > 1) {
639 if (len >= destsize)
640 len = destsize - 1;
641 memcpy(dest, src, len);
642 destsize -= len;
643 dest += len;
644 }
645 }
646 *dest = '\0';
647 va_end(ap);
648
649 return ret;
650}
651
5243c216
AT
652void clean_fname(char *name)
653{
654 char *p;
655 int l;
656 int modified = 1;
657
b5bd5542
WD
658 if (!name)
659 return;
5243c216
AT
660
661 while (modified) {
662 modified = 0;
663
c284f34a 664 if ((p = strstr(name,"/./")) != NULL) {
5243c216
AT
665 modified = 1;
666 while (*p) {
667 p[0] = p[2];
668 p++;
669 }
670 }
671
c284f34a 672 if ((p = strstr(name,"//")) != NULL) {
5243c216
AT
673 modified = 1;
674 while (*p) {
675 p[0] = p[1];
676 p++;
677 }
678 }
679
c284f34a 680 if (strncmp(p = name, "./", 2) == 0) {
5243c216
AT
681 modified = 1;
682 do {
683 p[0] = p[2];
684 } while (*p++);
685 }
686
c284f34a 687 l = strlen(p = name);
5243c216
AT
688 if (l > 1 && p[l-1] == '/') {
689 modified = 1;
690 p[l-1] = 0;
691 }
692 }
693}
694
ac13ad10 695/**
1b8e662a 696 * Make path appear as if a chroot had occurred:
ac13ad10 697 *
b4235b31
MP
698 * @li 1. remove leading "/" (or replace with "." if at end)
699 *
700 * @li 2. remove leading ".." components (except those allowed by @p reldir)
701 *
702 * @li 3. delete any other "<dir>/.." (recursively)
ac13ad10 703 *
79452d46 704 * Can only shrink paths, so sanitizes in place.
ac13ad10 705 *
b5f9e67d 706 * While we're at it, remove double slashes and "." components like
b4235b31 707 * clean_fname() does, but DON'T remove a trailing slash because that
b5f9e67d 708 * is sometimes significant on command line arguments.
ac13ad10 709 *
b4235b31 710 * If @p reldir is non-null, it is a sanitized directory that the path will be
79452d46
DD
711 * relative to, so allow as many ".." at the beginning of the path as
712 * there are components in reldir. This is used for symbolic link targets.
713 * If reldir is non-null and the path began with "/", to be completely like
714 * a chroot we should add in depth levels of ".." at the beginning of the
715 * path, but that would blow the assumption that the path doesn't grow and
716 * it is not likely to end up being a valid symlink anyway, so just do
717 * the normal removal of the leading "/" instead.
ac13ad10 718 *
1b8e662a
DD
719 * Contributed by Dave Dykstra <dwd@bell-labs.com>
720 */
cb13abfe 721void sanitize_path(char *p, char *reldir)
1b8e662a 722{
44e2e578 723 char *start, *sanp;
cb13abfe
DD
724 int depth = 0;
725 int allowdotdot = 0;
726
727 if (reldir) {
f9e5a0cd 728 int new_component = 1;
cb13abfe 729 while (*reldir) {
f9e5a0cd
WD
730 if (*reldir++ == '/')
731 new_component = 1;
732 else if (new_component) {
733 new_component = 0;
cb13abfe
DD
734 depth++;
735 }
736 }
737 }
44e2e578
DD
738 start = p;
739 sanp = p;
b5f9e67d
DD
740 while (*p == '/') {
741 /* remove leading slashes */
742 p++;
743 }
1b8e662a 744 while (*p != '\0') {
b5f9e67d 745 /* this loop iterates once per filename component in p.
44e2e578 746 * both p (and sanp if the original had a slash) should
b5f9e67d
DD
747 * always be left pointing after a slash
748 */
c284f34a 749 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
b5f9e67d
DD
750 /* skip "." component */
751 while (*++p == '/') {
752 /* skip following slashes */
753 ;
754 }
cb13abfe
DD
755 continue;
756 }
757 allowdotdot = 0;
c284f34a 758 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
cb13abfe 759 /* ".." component followed by slash or end */
c284f34a 760 if (depth > 0 && sanp == start) {
cb13abfe
DD
761 /* allow depth levels of .. at the beginning */
762 --depth;
763 allowdotdot = 1;
764 } else {
765 p += 2;
766 if (*p == '/')
767 p++;
768 if (sanp != start) {
769 /* back up sanp one level */
770 --sanp; /* now pointing at slash */
c284f34a 771 while (sanp > start && sanp[-1] != '/') {
cb13abfe
DD
772 /* skip back up to slash */
773 sanp--;
774 }
b5f9e67d 775 }
cb13abfe 776 continue;
1b8e662a 777 }
cb13abfe
DD
778 }
779 while (1) {
780 /* copy one component through next slash */
781 *sanp++ = *p++;
42509417 782 if (*p == '\0' || p[-1] == '/') {
cb13abfe
DD
783 while (*p == '/') {
784 /* skip multiple slashes */
785 p++;
b5f9e67d 786 }
cb13abfe 787 break;
1b8e662a
DD
788 }
789 }
cb13abfe
DD
790 if (allowdotdot) {
791 /* move the virtual beginning to leave the .. alone */
792 start = sanp;
793 }
1b8e662a 794 }
c284f34a 795 if (sanp == start && !allowdotdot) {
b5f9e67d 796 /* ended up with nothing, so put in "." component */
79452d46
DD
797 /*
798 * note that the !allowdotdot doesn't prevent this from
799 * happening in all allowed ".." situations, but I didn't
800 * think it was worth putting in an extra variable to ensure
801 * it since an extra "." won't hurt in those situations.
802 */
44e2e578 803 *sanp++ = '.';
b5f9e67d 804 }
44e2e578 805 *sanp = '\0';
1b8e662a
DD
806}
807
14b61c63
WD
808/* Works much like sanitize_path(), with these differences: (1) a new buffer
809 * is allocated for the sanitized path rather than modifying it in-place; (2)
810 * a leading slash gets transformed into the rootdir value (which can be empty
811 * or NULL if you just want the slash to get dropped); (3) no "reldir" can be
812 * specified. */
813char *alloc_sanitize_path(const char *path, const char *rootdir)
814{
815 char *buf;
816 int rlen, plen = strlen(path);
817
b05b3c9b 818 if (*path == '/' && rootdir) {
14b61c63 819 rlen = strlen(rootdir);
b05b3c9b
WD
820 if (rlen == 1)
821 path++;
822 } else
14b61c63
WD
823 rlen = 0;
824 if (!(buf = new_array(char, rlen + plen + 1)))
825 out_of_memory("alloc_sanitize_path");
826 if (rlen)
827 memcpy(buf, rootdir, rlen);
828 memcpy(buf + rlen, path, plen + 1);
829
b05b3c9b 830 if (rlen > 1)
14b61c63
WD
831 rlen++;
832 sanitize_path(buf + rlen, NULL);
b05b3c9b
WD
833 if (rlen && buf[rlen] == '.' && buf[rlen+1] == '\0') {
834 if (rlen > 1)
835 rlen--;
836 buf[rlen] = '\0';
837 }
14b61c63
WD
838
839 return buf;
840}
5243c216 841
4791825d 842char curr_dir[MAXPATHLEN];
4af8fe4e 843unsigned int curr_dir_len;
5243c216 844
4e5db0ad 845/**
a16d8f2b
WD
846 * Like chdir(), but it keeps track of the current directory (in the
847 * global "curr_dir"), and ensures that the path size doesn't overflow.
848 * Also cleans the path using the clean_fname() function.
4e5db0ad 849 **/
4af8fe4e 850int push_dir(char *dir)
5243c216 851{
5243c216 852 static int initialised;
4af8fe4e 853 unsigned int len;
5243c216
AT
854
855 if (!initialised) {
856 initialised = 1;
5cb37436 857 getcwd(curr_dir, sizeof curr_dir - 1);
4af8fe4e 858 curr_dir_len = strlen(curr_dir);
5243c216
AT
859 }
860
4af8fe4e
WD
861 if (!dir) /* this call was probably just to initialize */
862 return 0;
c226b7c2 863
4af8fe4e
WD
864 len = strlen(dir);
865 if (len == 1 && *dir == '.')
866 return 1;
5243c216 867
4af8fe4e
WD
868 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
869 return 0;
870
871 if (chdir(dir))
872 return 0;
5243c216
AT
873
874 if (*dir == '/') {
4af8fe4e
WD
875 memcpy(curr_dir, dir, len + 1);
876 curr_dir_len = len;
877 } else {
878 curr_dir[curr_dir_len++] = '/';
879 memcpy(curr_dir + curr_dir_len, dir, len + 1);
880 curr_dir_len += len;
5243c216
AT
881 }
882
883 clean_fname(curr_dir);
884
4af8fe4e 885 return 1;
5243c216
AT
886}
887
a16d8f2b
WD
888/**
889 * Reverse a push_dir() call. You must pass in an absolute path
890 * that was copied from a prior value of "curr_dir".
891 **/
5243c216
AT
892int pop_dir(char *dir)
893{
4af8fe4e
WD
894 if (chdir(dir))
895 return 0;
5243c216 896
4af8fe4e
WD
897 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
898 if (curr_dir_len >= sizeof curr_dir)
899 curr_dir_len = sizeof curr_dir - 1;
5243c216 900
4af8fe4e 901 return 1;
5243c216 902}
aa9b77a5 903
820b6c9a
WD
904/**
905 * Return the filename, turning any newlines into '?'s. This ensures that
b4afd23c
WD
906 * outputting it on a line of its own cannot generate an empty line. This
907 * function can handle only 2 names at a time!
820b6c9a
WD
908 **/
909const char *safe_fname(const char *fname)
910{
b4afd23c
WD
911 static char fbuf1[MAXPATHLEN], fbuf2[MAXPATHLEN];
912 static char *fbuf = fbuf2;
820b6c9a
WD
913 char *nl = strchr(fname, '\n');
914
915 if (!nl)
916 return fname;
917
b4afd23c
WD
918 fbuf = fbuf == fbuf1 ? fbuf2 : fbuf1;
919 strlcpy(fbuf, fname, MAXPATHLEN);
820b6c9a
WD
920 nl = fbuf + (nl - (char *)fname);
921 do {
922 *nl = '?';
923 } while ((nl = strchr(nl+1, '\n')) != NULL);
924
925 return fbuf;
926}
927
eb61be19
WD
928/**
929 * Return a quoted string with the full pathname of the indicated filename.
930 * The string " (in MODNAME)" may also be appended. The returned pointer
931 * remains valid until the next time full_fname() is called.
932 **/
9a5ade18 933char *full_fname(const char *fn)
eb61be19 934{
eb61be19
WD
935 static char *result = NULL;
936 char *m1, *m2, *m3;
937 char *p1, *p2;
938
939 if (result)
940 free(result);
941
af1a3f9b 942 fn = safe_fname(fn);
eb61be19
WD
943 if (*fn == '/')
944 p1 = p2 = "";
945 else {
946 p1 = curr_dir;
947 p2 = "/";
948 }
949 if (module_id >= 0) {
950 m1 = " (in ";
951 m2 = lp_name(module_id);
952 m3 = ")";
953 if (*p1) {
954 if (!lp_use_chroot(module_id)) {
955 char *p = lp_path(module_id);
956 if (*p != '/' || p[1])
957 p1 += strlen(p);
958 }
959 if (!*p1)
960 p2++;
961 else
962 p1++;
963 }
964 else
965 fn++;
966 } else
967 m1 = m2 = m3 = "";
968
969 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
970
971 return result;
972}
973
a7260c40
WD
974static char partial_fname[MAXPATHLEN];
975
976char *partial_dir_fname(const char *fname)
977{
978 char *t = partial_fname;
979 int sz = sizeof partial_fname;
980 const char *fn;
981
982 if ((fn = strrchr(fname, '/')) != NULL) {
983 fn++;
984 if (*partial_dir != '/') {
985 int len = fn - fname;
986 strncpy(t, fname, len); /* safe */
987 t += len;
988 sz -= len;
989 }
990 } else
991 fn = fname;
992 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
993 return NULL;
994
995 return partial_fname;
996}
997
998/* If no --partial-dir option was specified, we don't need to do anything
999 * (the partial-dir is essentially '.'), so just return success. */
1000int handle_partial_dir(const char *fname, int create)
1001{
1002 char *fn, *dir;
1003
1004 if (fname != partial_fname)
1005 return 1;
1006 if (!create && *partial_dir == '/')
1007 return 1;
1008 if (!(fn = strrchr(partial_fname, '/')))
1009 return 1;
1010
1011 *fn = '\0';
1012 dir = partial_fname;
1013 if (create) {
1014 STRUCT_STAT st;
1015#if SUPPORT_LINKS
1016 int statret = do_lstat(dir, &st);
1017#else
1018 int statret = do_stat(dir, &st);
1019#endif
1020 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1021 if (do_unlink(dir) < 0)
1022 return 0;
1023 statret = -1;
1024 }
1025 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1026 return 0;
1027 } else
1028 do_rmdir(dir);
1029 *fn = '/';
1030
1031 return 1;
1032}
1033
ac13ad10 1034/** We need to supply our own strcmp function for file list comparisons
aa9b77a5
AT
1035 to ensure that signed/unsigned usage is consistent between machines. */
1036int u_strcmp(const char *cs1, const char *cs2)
1037{
5a788ade
AT
1038 const uchar *s1 = (const uchar *)cs1;
1039 const uchar *s2 = (const uchar *)cs2;
aa9b77a5
AT
1040
1041 while (*s1 && *s2 && (*s1 == *s2)) {
1042 s1++; s2++;
1043 }
5cb37436 1044
aa9b77a5
AT
1045 return (int)*s1 - (int)*s2;
1046}
eb86d661 1047
4b957c22 1048
ac13ad10
MP
1049
1050/**
1051 * Determine if a symlink points outside the current directory tree.
036e70b0
MP
1052 * This is considered "unsafe" because e.g. when mirroring somebody
1053 * else's machine it might allow them to establish a symlink to
1054 * /etc/passwd, and then read it through a web server.
1055 *
4e5db0ad
MP
1056 * Null symlinks and absolute symlinks are always unsafe.
1057 *
1058 * Basically here we are concerned with symlinks whose target contains
1059 * "..", because this might cause us to walk back up out of the
1060 * transferred directory. We are not allowed to go back up and
1061 * reenter.
1062 *
036e70b0
MP
1063 * @param dest Target of the symlink in question.
1064 *
25d34a5c 1065 * @param src Top source directory currently applicable. Basically this
036e70b0 1066 * is the first parameter to rsync in a simple invocation, but it's
25d34a5c 1067 * modified by flist.c in slightly complex ways.
036e70b0
MP
1068 *
1069 * @retval True if unsafe
1070 * @retval False is unsafe
4e5db0ad
MP
1071 *
1072 * @sa t_unsafe.c
ac13ad10 1073 **/
7afa3a4a 1074int unsafe_symlink(const char *dest, const char *src)
4b957c22 1075{
7afa3a4a 1076 const char *name, *slash;
4b957c22
AT
1077 int depth = 0;
1078
1079 /* all absolute and null symlinks are unsafe */
b5bd5542
WD
1080 if (!dest || !*dest || *dest == '/')
1081 return 1;
4b957c22
AT
1082
1083 /* find out what our safety margin is */
7afa3a4a
WD
1084 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1085 if (strncmp(name, "../", 3) == 0) {
c284f34a 1086 depth = 0;
7afa3a4a 1087 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
1088 /* nothing */
1089 } else {
1090 depth++;
1091 }
1092 }
7afa3a4a
WD
1093 if (strcmp(name, "..") == 0)
1094 depth = 0;
4b957c22 1095
7afa3a4a
WD
1096 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1097 if (strncmp(name, "../", 3) == 0) {
1098 /* if at any point we go outside the current directory
1099 then stop - it is unsafe */
1100 if (--depth < 0)
1101 return 1;
1102 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
1103 /* nothing */
1104 } else {
1105 depth++;
1106 }
4b957c22 1107 }
7afa3a4a
WD
1108 if (strcmp(name, "..") == 0)
1109 depth--;
4b957c22 1110
4b957c22
AT
1111 return (depth < 0);
1112}
375a4556 1113
f7632fc6 1114
ac13ad10 1115/**
b4235b31
MP
1116 * Return the date and time as a string
1117 **/
f7632fc6
AT
1118char *timestring(time_t t)
1119{
1120 static char TimeBuf[200];
1121 struct tm *tm = localtime(&t);
1122
1123#ifdef HAVE_STRFTIME
5cb37436 1124 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
f7632fc6 1125#else
5cb37436 1126 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
f7632fc6
AT
1127#endif
1128
1129 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1130 TimeBuf[strlen(TimeBuf)-1] = 0;
1131 }
1132
1133 return(TimeBuf);
1134}
1135
9ec16c83 1136
e1bd49d6
MP
1137/**
1138 * Sleep for a specified number of milliseconds.
1139 *
1140 * Always returns TRUE. (In the future it might return FALSE if
1141 * interrupted.)
1142 **/
1143int msleep(int t)
9ec16c83 1144{
c284f34a
WD
1145 int tdiff = 0;
1146 struct timeval tval, t1, t2;
9ec16c83
AT
1147
1148 gettimeofday(&t1, NULL);
5cb37436 1149
9ec16c83
AT
1150 while (tdiff < t) {
1151 tval.tv_sec = (t-tdiff)/1000;
1152 tval.tv_usec = 1000*((t-tdiff)%1000);
5cb37436 1153
9ec16c83
AT
1154 errno = 0;
1155 select(0,NULL,NULL, NULL, &tval);
1156
1157 gettimeofday(&t2, NULL);
5cb37436 1158 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
9ec16c83
AT
1159 (t2.tv_usec - t1.tv_usec)/1000;
1160 }
e1bd49d6
MP
1161
1162 return True;
9ec16c83
AT
1163}
1164
1165
ac13ad10
MP
1166/**
1167 * Determine if two file modification times are equivalent (either
1168 * exact or in the modification timestamp window established by
1169 * --modify-window).
1170 *
1171 * @retval 0 if the times should be treated as the same
1172 *
1173 * @retval +1 if the first is later
1174 *
1175 * @retval -1 if the 2nd is later
1176 **/
5b56cc19
AT
1177int cmp_modtime(time_t file1, time_t file2)
1178{
5b56cc19 1179 if (file2 > file1) {
bc6ebcd2
WD
1180 if (file2 - file1 <= modify_window)
1181 return 0;
5b56cc19
AT
1182 return -1;
1183 }
bc6ebcd2
WD
1184 if (file1 - file2 <= modify_window)
1185 return 0;
5b56cc19
AT
1186 return 1;
1187}
1188
1189
1190#ifdef __INSURE__XX
0f8f98c8
AT
1191#include <dlfcn.h>
1192
ac13ad10
MP
1193/**
1194 This routine is a trick to immediately catch errors when debugging
1195 with insure. A xterm with a gdb is popped up when insure catches
1196 a error. It is Linux specific.
1197**/
0f8f98c8
AT
1198int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1199{
1200 static int (*fn)();
1201 int ret;
8950ac03 1202 char *cmd;
0f8f98c8 1203
5cb37436 1204 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
1205 getpid(), getpid(), getpid());
1206
1207 if (!fn) {
1208 static void *h;
1209 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1210 fn = dlsym(h, "_Insure_trap_error");
1211 }
1212
1213 ret = fn(a1, a2, a3, a4, a5, a6);
1214
1215 system(cmd);
1216
8950ac03
AT
1217 free(cmd);
1218
0f8f98c8
AT
1219 return ret;
1220}
1221#endif
58cadc86
WD
1222
1223
1224#define MALLOC_MAX 0x40000000
1225
1226void *_new_array(unsigned int size, unsigned long num)
1227{
1228 if (num >= MALLOC_MAX/size)
1229 return NULL;
1230 return malloc(size * num);
1231}
1232
1233void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1234{
1235 if (num >= MALLOC_MAX/size)
1236 return NULL;
1237 /* No realloc should need this, but just in case... */
1238 if (!ptr)
1239 return malloc(size * num);
1240 return realloc(ptr, size * num);
1241}