John E. Malmberg convinced me to standardize on #ifs for defined
[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 *
6566d205 248 * This is used in conjunction with the --temp-dir and --backup options */
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",
f8cd88db 353 safe_fname(fname), safe_fname(path));
4791825d 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
630f548f
WD
365/* Returns 0 on successful rename, 1 if we successfully copied the file
366 * across filesystems, -2 if copy_file() failed, and -1 on other errors. */
62c9e6b3 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);
630f548f 386 return 1;
62c9e6b3
WD
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
7842418b 482static int filter_server_path(char *arg)
4791825d
WD
483{
484 char *s;
4791825d 485
7842418b 486 if (server_filter_list.head) {
4791825d
WD
487 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
488 *s = '\0';
7842418b 489 if (check_filter(&server_filter_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;
4f5b0756 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);
7842418b 516 filter_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
4135d091 526 if (sanitize_paths)
1d6b8f9a 527 s = sanitize_path(NULL, s, "", 0);
84a63795
WD
528 else
529 s = strdup(s);
087bf010 530
5cb37436 531 memset(&globbuf, 0, sizeof globbuf);
7842418b 532 if (!filter_server_path(s))
4791825d 533 glob(s, 0, NULL, &globbuf);
b7061c82
WD
534 if (MAX((int)globbuf.gl_pathc, 1) > maxargs - argc) {
535 maxargs += globbuf.gl_pathc + MAX_ARGS;
536 if (!(argv = realloc_array(argv, char *, maxargs)))
537 out_of_memory("glob_expand_one");
538 *argv_ptr = argv;
539 *maxargs_ptr = maxargs;
540 }
b5bd5542
WD
541 if (globbuf.gl_pathc == 0)
542 argv[argc++] = s;
543 else {
544 int j = globbuf.gl_pathc;
b5bd5542
WD
545 free(s);
546 for (i = 0; i < j; i++) {
547 if (!(argv[argc++] = strdup(globbuf.gl_pathv[i])))
548 out_of_memory("glob_expand_one");
549 }
874895d5
AT
550 }
551 globfree(&globbuf);
874895d5 552#endif
b5bd5542 553 *argc_ptr = argc;
874895d5 554}
5a96ee05 555
4791825d 556/* This routine is only used in daemon mode. */
b7061c82 557void glob_expand(char *base1, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
087bf010 558{
b7061c82 559 char *s = (*argv_ptr)[*argc_ptr];
087bf010 560 char *p, *q;
ba5e128d 561 char *base = base1;
4791825d 562 int base_len = strlen(base);
087bf010 563
b5bd5542
WD
564 if (!s || !*s)
565 return;
087bf010 566
4791825d
WD
567 if (strncmp(s, base, base_len) == 0)
568 s += base_len;
e42c9458 569
b5bd5542
WD
570 if (!(s = strdup(s)))
571 out_of_memory("glob_expand");
087bf010 572
b5bd5542
WD
573 if (asprintf(&base," %s/", base1) <= 0)
574 out_of_memory("glob_expand");
4791825d 575 base_len++;
ba5e128d 576
b5bd5542
WD
577 for (q = s; *q; q = p + base_len) {
578 if ((p = strstr(q, base)) != NULL)
579 *p = '\0'; /* split it at this point */
b7061c82 580 glob_expand_one(q, argv_ptr, argc_ptr, maxargs_ptr);
b5bd5542
WD
581 if (!p)
582 break;
087bf010
AT
583 }
584
087bf010 585 free(s);
ba5e128d 586 free(base);
087bf010 587}
5a96ee05 588
ac13ad10
MP
589/**
590 * Convert a string to lower case
591 **/
5a96ee05
AT
592void strlower(char *s)
593{
594 while (*s) {
b5bd5542
WD
595 if (isupper(*(unsigned char *)s))
596 *s = tolower(*(unsigned char *)s);
5a96ee05
AT
597 s++;
598 }
599}
e42c9458 600
368ad70e
WD
601/* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
602 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
a8f7e4b8
WD
603 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
604 * string fits into destsize. */
368ad70e
WD
605size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
606{
607 size_t len = strlcpy(dest, p1, destsize);
608 if (len < destsize - 1) {
609 if (!len || dest[len-1] != '/')
610 dest[len++] = '/';
611 if (len < destsize - 1)
612 len += strlcpy(dest + len, p2, destsize - len);
613 else {
614 dest[len] = '\0';
615 len += strlen(p2);
616 }
617 }
618 else
619 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
620 return len;
621}
622
623/* Join any number of strings together, putting them in "dest". The return
a8f7e4b8
WD
624 * value is the length of all the strings, regardless of whether the null-
625 * terminated whole fits in destsize. Your list of string pointers must end
626 * with a NULL to indicate the end of the list. */
368ad70e
WD
627size_t stringjoin(char *dest, size_t destsize, ...)
628{
5cb37436 629 va_list ap;
368ad70e
WD
630 size_t len, ret = 0;
631 const char *src;
632
633 va_start(ap, destsize);
634 while (1) {
635 if (!(src = va_arg(ap, const char *)))
636 break;
637 len = strlen(src);
638 ret += len;
639 if (destsize > 1) {
640 if (len >= destsize)
641 len = destsize - 1;
642 memcpy(dest, src, len);
643 destsize -= len;
644 dest += len;
645 }
646 }
647 *dest = '\0';
648 va_end(ap);
649
650 return ret;
651}
652
1d6b8f9a
WD
653int count_dir_elements(const char *p)
654{
655 int cnt = 0, new_component = 1;
656 while (*p) {
657 if (*p++ == '/')
658 new_component = 1;
659 else if (new_component) {
660 new_component = 0;
661 cnt++;
662 }
663 }
664 return cnt;
665}
666
b92693da
WD
667/* Turns multiple adjacent slashes into a single slash, gets rid of "./"
668 * elements (but not a trailing dot dir), removes a trailing slash, and
669 * optionally collapses ".." elements (except for those at the start of the
670 * string). If the resulting name would be empty, change it into a ".". */
671unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
5243c216 672{
e012b94f 673 char *limit = name - 1, *t = name, *f = name;
ebdd24d6 674 int anchored;
5243c216 675
b5bd5542 676 if (!name)
3104620c 677 return 0;
5243c216 678
ebdd24d6
WD
679 if ((anchored = *f == '/') != 0)
680 *t++ = *f++;
681 while (*f) {
682 /* discard extra slashes */
683 if (*f == '/') {
684 f++;
685 continue;
5243c216 686 }
ebdd24d6
WD
687 if (*f == '.') {
688 /* discard "." dirs (but NOT a trailing '.'!) */
689 if (f[1] == '/') {
e012b94f 690 f += 2;
ebdd24d6
WD
691 continue;
692 }
693 /* collapse ".." dirs */
b92693da
WD
694 if (collapse_dot_dot
695 && f[1] == '.' && (f[2] == '/' || !f[2])) {
ebdd24d6
WD
696 char *s = t - 1;
697 if (s == name && anchored) {
698 f += 2;
699 continue;
700 }
701 while (s > limit && *--s != '/') {}
e012b94f 702 if (s != t - 1 && (s < name || *s == '/')) {
ebdd24d6
WD
703 t = s + 1;
704 f += 2;
705 continue;
706 }
f55c2dfc 707 limit = t + 2;
5243c216
AT
708 }
709 }
ebdd24d6 710 while (*f && (*t++ = *f++) != '/') {}
5243c216 711 }
ebdd24d6
WD
712
713 if (t > name+anchored && t[-1] == '/')
714 t--;
715 if (t == name)
716 *t++ = '.';
717 *t = '\0';
3104620c
WD
718
719 return t - name;
5243c216
AT
720}
721
84a63795
WD
722/* Make path appear as if a chroot had occurred. This handles a leading
723 * "/" (either removing it or expanding it) and any leading or embedded
724 * ".." components that attempt to escape past the module's top dir.
b4235b31 725 *
1d6b8f9a
WD
726 * If dest is NULL, a buffer is allocated to hold the result. It is legal
727 * to call with the dest and the path (p) pointing to the same buffer, but
728 * rootdir will be ignored to avoid expansion of the string.
b4235b31 729 *
1d6b8f9a
WD
730 * The rootdir string contains a value to use in place of a leading slash.
731 * Specify NULL to get the default of lp_path(module_id).
ac13ad10 732 *
5886edfa
WD
733 * If depth is >= 0, it is a count of how many '..'s to allow at the start
734 * of the path. Use -1 to allow unlimited depth.
ac13ad10 735 *
b92693da
WD
736 * We also clean the path in a manner similar to clean_fname() but with a
737 * few differences:
738 *
739 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
740 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
741 * ALWAYS collapses ".." elements (except for those at the start of the
742 * string up to "depth" deep). If the resulting name would be empty,
743 * change it into a ".". */
1d6b8f9a 744char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
1b8e662a 745{
44e2e578 746 char *start, *sanp;
84a63795
WD
747 int rlen = 0;
748
749 if (dest != p) {
750 int plen = strlen(p);
1d6b8f9a
WD
751 if (*p == '/') {
752 if (!rootdir)
753 rootdir = lp_path(module_id);
754 rlen = strlen(rootdir);
755 depth = 0;
84a63795
WD
756 p++;
757 }
758 if (dest) {
759 if (rlen + plen + 1 >= MAXPATHLEN)
760 return NULL;
761 } else if (!(dest = new_array(char, rlen + plen + 1)))
762 out_of_memory("sanitize_path");
763 if (rlen) {
1d6b8f9a 764 memcpy(dest, rootdir, rlen);
84a63795
WD
765 if (rlen > 1)
766 dest[rlen++] = '/';
767 }
768 }
cb13abfe 769
84a63795 770 start = sanp = dest + rlen;
1b8e662a 771 while (*p != '\0') {
2d41264e
WD
772 /* discard leading or extra slashes */
773 if (*p == '/') {
774 p++;
775 continue;
776 }
b5f9e67d 777 /* this loop iterates once per filename component in p.
44e2e578 778 * both p (and sanp if the original had a slash) should
b5f9e67d
DD
779 * always be left pointing after a slash
780 */
c284f34a 781 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
b5f9e67d 782 /* skip "." component */
2d41264e 783 p++;
cb13abfe
DD
784 continue;
785 }
c284f34a 786 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
cb13abfe 787 /* ".." component followed by slash or end */
8e5f029e
WD
788 if (depth <= 0 || sanp != start) {
789 p += 2;
790 if (sanp != start) {
791 /* back up sanp one level */
792 --sanp; /* now pointing at slash */
793 while (sanp > start && sanp[-1] != '/') {
794 /* skip back up to slash */
795 sanp--;
796 }
b5f9e67d 797 }
8e5f029e 798 continue;
1b8e662a 799 }
8e5f029e
WD
800 /* allow depth levels of .. at the beginning */
801 depth--;
802 /* move the virtual beginning to leave the .. alone */
803 start = sanp + 3;
1b8e662a 804 }
2d41264e
WD
805 /* copy one component through next slash */
806 while (*p && (*sanp++ = *p++) != '/') {}
1b8e662a 807 }
84a63795 808 if (sanp == dest) {
b5f9e67d 809 /* ended up with nothing, so put in "." component */
44e2e578 810 *sanp++ = '.';
b5f9e67d 811 }
44e2e578 812 *sanp = '\0';
1b8e662a 813
84a63795 814 return dest;
14b61c63 815}
5243c216 816
4791825d 817char curr_dir[MAXPATHLEN];
4af8fe4e 818unsigned int curr_dir_len;
5243c216 819
4e5db0ad 820/**
a16d8f2b
WD
821 * Like chdir(), but it keeps track of the current directory (in the
822 * global "curr_dir"), and ensures that the path size doesn't overflow.
823 * Also cleans the path using the clean_fname() function.
4e5db0ad 824 **/
4af8fe4e 825int push_dir(char *dir)
5243c216 826{
5243c216 827 static int initialised;
4af8fe4e 828 unsigned int len;
5243c216
AT
829
830 if (!initialised) {
831 initialised = 1;
5cb37436 832 getcwd(curr_dir, sizeof curr_dir - 1);
4af8fe4e 833 curr_dir_len = strlen(curr_dir);
5243c216
AT
834 }
835
4af8fe4e
WD
836 if (!dir) /* this call was probably just to initialize */
837 return 0;
c226b7c2 838
4af8fe4e
WD
839 len = strlen(dir);
840 if (len == 1 && *dir == '.')
841 return 1;
5243c216 842
4af8fe4e
WD
843 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
844 return 0;
845
846 if (chdir(dir))
847 return 0;
5243c216
AT
848
849 if (*dir == '/') {
4af8fe4e
WD
850 memcpy(curr_dir, dir, len + 1);
851 curr_dir_len = len;
852 } else {
853 curr_dir[curr_dir_len++] = '/';
854 memcpy(curr_dir + curr_dir_len, dir, len + 1);
855 curr_dir_len += len;
5243c216
AT
856 }
857
b92693da 858 curr_dir_len = clean_fname(curr_dir, 1);
5243c216 859
4af8fe4e 860 return 1;
5243c216
AT
861}
862
a16d8f2b
WD
863/**
864 * Reverse a push_dir() call. You must pass in an absolute path
865 * that was copied from a prior value of "curr_dir".
866 **/
5243c216
AT
867int pop_dir(char *dir)
868{
4af8fe4e
WD
869 if (chdir(dir))
870 return 0;
5243c216 871
4af8fe4e
WD
872 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
873 if (curr_dir_len >= sizeof curr_dir)
874 curr_dir_len = sizeof curr_dir - 1;
5243c216 875
4af8fe4e 876 return 1;
5243c216 877}
aa9b77a5 878
820b6c9a
WD
879/**
880 * Return the filename, turning any newlines into '?'s. This ensures that
b4afd23c
WD
881 * outputting it on a line of its own cannot generate an empty line. This
882 * function can handle only 2 names at a time!
820b6c9a
WD
883 **/
884const char *safe_fname(const char *fname)
885{
f8cd88db
WD
886#define MAX_SAFE_NAMES 4
887 static char fbuf[MAX_SAFE_NAMES][MAXPATHLEN*2];
888 static int ndx = 0;
889 int limit = sizeof fbuf / MAX_SAFE_NAMES - 1;
890 char *t;
891
892 ndx = (ndx + 1) % MAX_SAFE_NAMES;
893 for (t = fbuf[ndx]; *fname; fname++) {
894 if (!isprint(*fname))
895 *t++ = '?';
896 else
897 *t++ = *fname;
898 if (--limit == 0)
899 break;
900 }
901 *t = '\0';
820b6c9a 902
f8cd88db 903 return fbuf[ndx];
820b6c9a
WD
904}
905
eb61be19
WD
906/**
907 * Return a quoted string with the full pathname of the indicated filename.
908 * The string " (in MODNAME)" may also be appended. The returned pointer
909 * remains valid until the next time full_fname() is called.
910 **/
9a5ade18 911char *full_fname(const char *fn)
eb61be19 912{
eb61be19
WD
913 static char *result = NULL;
914 char *m1, *m2, *m3;
915 char *p1, *p2;
916
917 if (result)
918 free(result);
919
af1a3f9b 920 fn = safe_fname(fn);
eb61be19
WD
921 if (*fn == '/')
922 p1 = p2 = "";
923 else {
924 p1 = curr_dir;
925 p2 = "/";
926 }
927 if (module_id >= 0) {
928 m1 = " (in ";
929 m2 = lp_name(module_id);
930 m3 = ")";
931 if (*p1) {
932 if (!lp_use_chroot(module_id)) {
933 char *p = lp_path(module_id);
934 if (*p != '/' || p[1])
935 p1 += strlen(p);
936 }
937 if (!*p1)
938 p2++;
939 else
940 p1++;
941 }
942 else
943 fn++;
944 } else
945 m1 = m2 = m3 = "";
946
947 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
948
949 return result;
950}
951
a7260c40
WD
952static char partial_fname[MAXPATHLEN];
953
954char *partial_dir_fname(const char *fname)
955{
956 char *t = partial_fname;
957 int sz = sizeof partial_fname;
958 const char *fn;
959
960 if ((fn = strrchr(fname, '/')) != NULL) {
961 fn++;
962 if (*partial_dir != '/') {
963 int len = fn - fname;
964 strncpy(t, fname, len); /* safe */
965 t += len;
966 sz -= len;
967 }
968 } else
969 fn = fname;
970 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
971 return NULL;
5aa7b20a
WD
972 if (server_filter_list.head) {
973 static int len;
974 if (!len)
975 len = strlen(partial_dir);
976 t[len] = '\0';
977 if (check_filter(&server_filter_list, partial_fname, 1) < 0)
978 return NULL;
979 t[len] = '/';
980 if (check_filter(&server_filter_list, partial_fname, 0) < 0)
981 return NULL;
982 }
a7260c40
WD
983
984 return partial_fname;
985}
986
987/* If no --partial-dir option was specified, we don't need to do anything
988 * (the partial-dir is essentially '.'), so just return success. */
989int handle_partial_dir(const char *fname, int create)
990{
991 char *fn, *dir;
992
993 if (fname != partial_fname)
994 return 1;
995 if (!create && *partial_dir == '/')
996 return 1;
997 if (!(fn = strrchr(partial_fname, '/')))
998 return 1;
999
1000 *fn = '\0';
1001 dir = partial_fname;
1002 if (create) {
1003 STRUCT_STAT st;
a7260c40 1004 int statret = do_lstat(dir, &st);
a7260c40
WD
1005 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1006 if (do_unlink(dir) < 0)
1007 return 0;
1008 statret = -1;
1009 }
1010 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1011 return 0;
1012 } else
1013 do_rmdir(dir);
1014 *fn = '/';
1015
1016 return 1;
1017}
1018
ac13ad10 1019/** We need to supply our own strcmp function for file list comparisons
aa9b77a5
AT
1020 to ensure that signed/unsigned usage is consistent between machines. */
1021int u_strcmp(const char *cs1, const char *cs2)
1022{
5a788ade
AT
1023 const uchar *s1 = (const uchar *)cs1;
1024 const uchar *s2 = (const uchar *)cs2;
aa9b77a5
AT
1025
1026 while (*s1 && *s2 && (*s1 == *s2)) {
1027 s1++; s2++;
1028 }
5cb37436 1029
aa9b77a5
AT
1030 return (int)*s1 - (int)*s2;
1031}
eb86d661 1032
4b957c22 1033
ac13ad10
MP
1034
1035/**
1036 * Determine if a symlink points outside the current directory tree.
036e70b0
MP
1037 * This is considered "unsafe" because e.g. when mirroring somebody
1038 * else's machine it might allow them to establish a symlink to
1039 * /etc/passwd, and then read it through a web server.
1040 *
4e5db0ad
MP
1041 * Null symlinks and absolute symlinks are always unsafe.
1042 *
1043 * Basically here we are concerned with symlinks whose target contains
1044 * "..", because this might cause us to walk back up out of the
1045 * transferred directory. We are not allowed to go back up and
1046 * reenter.
1047 *
036e70b0
MP
1048 * @param dest Target of the symlink in question.
1049 *
25d34a5c 1050 * @param src Top source directory currently applicable. Basically this
036e70b0 1051 * is the first parameter to rsync in a simple invocation, but it's
25d34a5c 1052 * modified by flist.c in slightly complex ways.
036e70b0
MP
1053 *
1054 * @retval True if unsafe
1055 * @retval False is unsafe
4e5db0ad
MP
1056 *
1057 * @sa t_unsafe.c
ac13ad10 1058 **/
7afa3a4a 1059int unsafe_symlink(const char *dest, const char *src)
4b957c22 1060{
7afa3a4a 1061 const char *name, *slash;
4b957c22
AT
1062 int depth = 0;
1063
1064 /* all absolute and null symlinks are unsafe */
b5bd5542
WD
1065 if (!dest || !*dest || *dest == '/')
1066 return 1;
4b957c22
AT
1067
1068 /* find out what our safety margin is */
7afa3a4a
WD
1069 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1070 if (strncmp(name, "../", 3) == 0) {
c284f34a 1071 depth = 0;
7afa3a4a 1072 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
1073 /* nothing */
1074 } else {
1075 depth++;
1076 }
1077 }
7afa3a4a
WD
1078 if (strcmp(name, "..") == 0)
1079 depth = 0;
4b957c22 1080
7afa3a4a
WD
1081 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1082 if (strncmp(name, "../", 3) == 0) {
1083 /* if at any point we go outside the current directory
1084 then stop - it is unsafe */
1085 if (--depth < 0)
1086 return 1;
1087 } else if (strncmp(name, "./", 2) == 0) {
4b957c22
AT
1088 /* nothing */
1089 } else {
1090 depth++;
1091 }
4b957c22 1092 }
7afa3a4a
WD
1093 if (strcmp(name, "..") == 0)
1094 depth--;
4b957c22 1095
4b957c22
AT
1096 return (depth < 0);
1097}
375a4556 1098
f7632fc6 1099
ac13ad10 1100/**
b4235b31
MP
1101 * Return the date and time as a string
1102 **/
f7632fc6
AT
1103char *timestring(time_t t)
1104{
1105 static char TimeBuf[200];
1106 struct tm *tm = localtime(&t);
1107
4f5b0756 1108#ifdef HAVE_STRFTIME
5cb37436 1109 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
f7632fc6 1110#else
5cb37436 1111 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
f7632fc6
AT
1112#endif
1113
1114 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1115 TimeBuf[strlen(TimeBuf)-1] = 0;
1116 }
1117
1118 return(TimeBuf);
1119}
1120
9ec16c83 1121
e1bd49d6
MP
1122/**
1123 * Sleep for a specified number of milliseconds.
1124 *
1125 * Always returns TRUE. (In the future it might return FALSE if
1126 * interrupted.)
1127 **/
1128int msleep(int t)
9ec16c83 1129{
c284f34a
WD
1130 int tdiff = 0;
1131 struct timeval tval, t1, t2;
9ec16c83
AT
1132
1133 gettimeofday(&t1, NULL);
5cb37436 1134
9ec16c83
AT
1135 while (tdiff < t) {
1136 tval.tv_sec = (t-tdiff)/1000;
1137 tval.tv_usec = 1000*((t-tdiff)%1000);
5cb37436 1138
9ec16c83
AT
1139 errno = 0;
1140 select(0,NULL,NULL, NULL, &tval);
1141
1142 gettimeofday(&t2, NULL);
5cb37436 1143 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
9ec16c83
AT
1144 (t2.tv_usec - t1.tv_usec)/1000;
1145 }
e1bd49d6
MP
1146
1147 return True;
9ec16c83
AT
1148}
1149
1150
ac13ad10
MP
1151/**
1152 * Determine if two file modification times are equivalent (either
1153 * exact or in the modification timestamp window established by
1154 * --modify-window).
1155 *
1156 * @retval 0 if the times should be treated as the same
1157 *
1158 * @retval +1 if the first is later
1159 *
1160 * @retval -1 if the 2nd is later
1161 **/
5b56cc19
AT
1162int cmp_modtime(time_t file1, time_t file2)
1163{
5b56cc19 1164 if (file2 > file1) {
bc6ebcd2
WD
1165 if (file2 - file1 <= modify_window)
1166 return 0;
5b56cc19
AT
1167 return -1;
1168 }
bc6ebcd2
WD
1169 if (file1 - file2 <= modify_window)
1170 return 0;
5b56cc19
AT
1171 return 1;
1172}
1173
1174
1175#ifdef __INSURE__XX
0f8f98c8
AT
1176#include <dlfcn.h>
1177
ac13ad10
MP
1178/**
1179 This routine is a trick to immediately catch errors when debugging
1180 with insure. A xterm with a gdb is popped up when insure catches
1181 a error. It is Linux specific.
1182**/
0f8f98c8
AT
1183int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1184{
1185 static int (*fn)();
1186 int ret;
8950ac03 1187 char *cmd;
0f8f98c8 1188
5cb37436 1189 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
1190 getpid(), getpid(), getpid());
1191
1192 if (!fn) {
1193 static void *h;
1194 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1195 fn = dlsym(h, "_Insure_trap_error");
1196 }
1197
1198 ret = fn(a1, a2, a3, a4, a5, a6);
1199
1200 system(cmd);
1201
8950ac03
AT
1202 free(cmd);
1203
0f8f98c8
AT
1204 return ret;
1205}
1206#endif
58cadc86
WD
1207
1208
1209#define MALLOC_MAX 0x40000000
1210
1211void *_new_array(unsigned int size, unsigned long num)
1212{
1213 if (num >= MALLOC_MAX/size)
1214 return NULL;
1215 return malloc(size * num);
1216}
1217
1218void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1219{
1220 if (num >= MALLOC_MAX/size)
1221 return NULL;
1222 /* No realloc should need this, but just in case... */
1223 if (!ptr)
1224 return malloc(size * num);
1225 return realloc(ptr, size * num);
1226}