An improved clean_fname() routine that is more efficient and will also
[rsync/rsync.git] / util.c
... / ...
CommitLineData
1/* -*- c-file-style: "linux" -*-
2 *
3 * Copyright (C) 1996-2000 by Andrew Tridgell
4 * Copyright (C) Paul Mackerras 1996
5 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
6 *
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.
11 *
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.
16 *
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 */
21
22/**
23 * @file
24 *
25 * Utilities used in rsync
26 **/
27
28#include "rsync.h"
29
30extern int verbose;
31extern int dry_run;
32extern int module_id;
33extern int modify_window;
34extern char *partial_dir;
35extern struct exclude_list_struct server_exclude_list;
36
37int sanitize_paths = 0;
38
39
40
41/**
42 * Set a fd into nonblocking mode
43 **/
44void set_nonblocking(int fd)
45{
46 int val;
47
48 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
49 return;
50 if (!(val & NONBLOCK_FLAG)) {
51 val |= NONBLOCK_FLAG;
52 fcntl(fd, F_SETFL, val);
53 }
54}
55
56/**
57 * Set a fd into blocking mode
58 **/
59void set_blocking(int fd)
60{
61 int val;
62
63 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
64 return;
65 if (val & NONBLOCK_FLAG) {
66 val &= ~NONBLOCK_FLAG;
67 fcntl(fd, F_SETFL, val);
68 }
69}
70
71
72/**
73 * Create a file descriptor pair - like pipe() but use socketpair if
74 * possible (because of blocking issues on pipes).
75 *
76 * Always set non-blocking.
77 */
78int fd_pair(int fd[2])
79{
80 int ret;
81
82#if HAVE_SOCKETPAIR
83 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
84#else
85 ret = pipe(fd);
86#endif
87
88 if (ret == 0) {
89 set_nonblocking(fd[0]);
90 set_nonblocking(fd[1]);
91 }
92
93 return ret;
94}
95
96
97void print_child_argv(char **cmd)
98{
99 rprintf(FINFO, "opening connection using ");
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
117void out_of_memory(char *str)
118{
119 rprintf(FERROR, "ERROR: out of memory in %s\n", str);
120 exit_cleanup(RERR_MALLOC);
121}
122
123void overflow(char *str)
124{
125 rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
126 exit_cleanup(RERR_MALLOC);
127}
128
129
130
131int set_modtime(char *fname, time_t modtime)
132{
133 if (dry_run)
134 return 0;
135
136 if (verbose > 2) {
137 rprintf(FINFO, "set modtime of %s to (%ld) %s",
138 fname, (long)modtime,
139 asctime(localtime(&modtime)));
140 }
141
142 {
143#ifdef HAVE_UTIMBUF
144 struct utimbuf tbuf;
145 tbuf.actime = time(NULL);
146 tbuf.modtime = modtime;
147 return utime(fname,&tbuf);
148#elif defined(HAVE_UTIME)
149 time_t t[2];
150 t[0] = time(NULL);
151 t[1] = modtime;
152 return utime(fname,t);
153#else
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);
160#endif
161 }
162}
163
164
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**/
170int create_directory_path(char *fname, int base_umask)
171{
172 char *p;
173
174 while (*fname == '/')
175 fname++;
176 while (strncmp(fname, "./", 2) == 0)
177 fname += 2;
178
179 p = fname;
180 while ((p = strchr(p,'/')) != NULL) {
181 *p = 0;
182 do_mkdir(fname, 0777 & ~base_umask);
183 *p = '/';
184 p++;
185 }
186 return 0;
187}
188
189
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 */
200static int full_write(int desc, char *ptr, size_t len)
201{
202 int total_written;
203
204 total_written = 0;
205 while (len > 0) {
206 int written = write(desc, ptr, len);
207 if (written < 0) {
208 if (errno == EINTR)
209 continue;
210 return written;
211 }
212 total_written += written;
213 ptr += written;
214 len -= written;
215 }
216 return total_written;
217}
218
219
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. */
231static int safe_read(int desc, char *ptr, size_t len)
232{
233 int n_chars;
234
235 if (len == 0)
236 return len;
237
238 do {
239 n_chars = read(desc, ptr, len);
240 } while (n_chars < 0 && errno == EINTR);
241
242 return n_chars;
243}
244
245
246/** Copy a file.
247 *
248 * This is used in conjunction with the --temp-dir option */
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
256 ifd = do_open(source, O_RDONLY, 0);
257 if (ifd == -1) {
258 rsyserr(FERROR, errno, "open %s", full_fname(source));
259 return -1;
260 }
261
262 if (robust_unlink(dest) && errno != ENOENT) {
263 rsyserr(FERROR, errno, "unlink %s", full_fname(dest));
264 return -1;
265 }
266
267 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
268 if (ofd == -1) {
269 rsyserr(FERROR, errno, "open %s", full_fname(dest));
270 close(ifd);
271 return -1;
272 }
273
274 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
275 if (full_write(ofd, buf, len) < 0) {
276 rsyserr(FERROR, errno, "write %s", full_fname(dest));
277 close(ifd);
278 close(ofd);
279 return -1;
280 }
281 }
282
283 if (len < 0) {
284 rsyserr(FERROR, errno, "read %s", full_fname(source));
285 close(ifd);
286 close(ofd);
287 return -1;
288 }
289
290 if (close(ifd) < 0) {
291 rsyserr(FINFO, errno, "close failed on %s",
292 full_fname(source));
293 }
294
295 if (close(ofd) < 0) {
296 rsyserr(FERROR, errno, "close failed on %s",
297 full_fname(dest));
298 return -1;
299 }
300
301 return 0;
302}
303
304/* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
305#define MAX_RENAMES_DIGITS 3
306#define MAX_RENAMES 1000
307
308/**
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 **/
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);
328 if (rc == 0 || errno != ETXTBSY)
329 return rc;
330
331 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
332 pos = MAXPATHLEN - 1;
333
334 while (pos > 0 && path[pos-1] != '/')
335 pos--;
336 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
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;
349 } while ((rc = access(path, 0)) == 0 && counter != start);
350
351 if (verbose > 0) {
352 rprintf(FINFO,"renaming %s to %s because of text busy\n",
353 fname, path);
354 }
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
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)
368{
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;
381#endif
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;
392}
393
394
395static pid_t all_pids[10];
396static int num_pids;
397
398/** Fork and record the pid of the child. **/
399pid_t do_fork(void)
400{
401 pid_t newpid = fork();
402
403 if (newpid != 0 && newpid != -1) {
404 all_pids[num_pids++] = newpid;
405 }
406 return newpid;
407}
408
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 **/
419void kill_all(int sig)
420{
421 int i;
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);
435 }
436}
437
438
439/** Turn a user name into a uid */
440int name_to_uid(char *name, uid_t *uid)
441{
442 struct passwd *pass;
443 if (!name || !*name)
444 return 0;
445 pass = getpwnam(name);
446 if (pass) {
447 *uid = pass->pw_uid;
448 return 1;
449 }
450 return 0;
451}
452
453/** Turn a group name into a gid */
454int name_to_gid(char *name, gid_t *gid)
455{
456 struct group *grp;
457 if (!name || !*name)
458 return 0;
459 grp = getgrnam(name);
460 if (grp) {
461 *gid = grp->gr_gid;
462 return 1;
463 }
464 return 0;
465}
466
467
468/** Lock a byte range in a open file */
469int lock_range(int fd, int offset, int len)
470{
471 struct flock lock;
472
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;
478
479 return fcntl(fd,F_SETLK,&lock) == 0;
480}
481
482static int exclude_server_path(char *arg)
483{
484 char *s;
485
486 if (server_exclude_list.head) {
487 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
488 *s = '\0';
489 if (check_exclude(&server_exclude_list, arg, 1) < 0) {
490 /* We must leave arg truncated! */
491 return 1;
492 }
493 *s++ = '/';
494 }
495 }
496 return 0;
497}
498
499static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
500 int *maxargs_ptr)
501{
502 char **argv = *argv_ptr;
503 int argc = *argc_ptr;
504 int maxargs = *maxargs_ptr;
505#if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
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 }
513 if (!*s)
514 s = ".";
515 s = argv[argc++] = strdup(s);
516 exclude_server_path(s);
517#else
518 glob_t globbuf;
519 int i;
520
521 if (maxargs <= argc)
522 return;
523 if (!*s)
524 s = ".";
525
526 if (sanitize_paths)
527 s = sanitize_path(NULL, s, NULL);
528 else
529 s = strdup(s);
530
531 memset(&globbuf, 0, sizeof globbuf);
532 if (!exclude_server_path(s))
533 glob(s, 0, NULL, &globbuf);
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 }
541 if (globbuf.gl_pathc == 0)
542 argv[argc++] = s;
543 else {
544 int j = globbuf.gl_pathc;
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 }
550 }
551 globfree(&globbuf);
552#endif
553 *argc_ptr = argc;
554}
555
556/* This routine is only used in daemon mode. */
557void glob_expand(char *base1, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
558{
559 char *s = (*argv_ptr)[*argc_ptr];
560 char *p, *q;
561 char *base = base1;
562 int base_len = strlen(base);
563
564 if (!s || !*s)
565 return;
566
567 if (strncmp(s, base, base_len) == 0)
568 s += base_len;
569
570 if (!(s = strdup(s)))
571 out_of_memory("glob_expand");
572
573 if (asprintf(&base," %s/", base1) <= 0)
574 out_of_memory("glob_expand");
575 base_len++;
576
577 for (q = s; *q; q = p + base_len) {
578 if ((p = strstr(q, base)) != NULL)
579 *p = '\0'; /* split it at this point */
580 glob_expand_one(q, argv_ptr, argc_ptr, maxargs_ptr);
581 if (!p)
582 break;
583 }
584
585 free(s);
586 free(base);
587}
588
589/**
590 * Convert a string to lower case
591 **/
592void strlower(char *s)
593{
594 while (*s) {
595 if (isupper(*(unsigned char *)s))
596 *s = tolower(*(unsigned char *)s);
597 s++;
598 }
599}
600
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
603 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
604 * string fits into destsize. */
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
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. */
627size_t stringjoin(char *dest, size_t destsize, ...)
628{
629 va_list ap;
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
653void clean_fname(char *name)
654{
655 char *limit = name, *t = name, *f = name;
656 int anchored;
657
658 if (!name)
659 return;
660
661 if ((anchored = *f == '/') != 0)
662 *t++ = *f++;
663 while (*f) {
664 /* discard extra slashes */
665 if (*f == '/') {
666 f++;
667 continue;
668 }
669 if (*f == '.') {
670 /* discard "." dirs (but NOT a trailing '.'!) */
671 if (f[1] == '/') {
672 f++; /* not += 2! */
673 continue;
674 }
675 /* collapse ".." dirs */
676 if (f[1] == '.' && (f[2] == '/' || !f[2])) {
677 char *s = t - 1;
678 if (s == name && anchored) {
679 f += 2;
680 continue;
681 }
682 while (s > limit && *--s != '/') {}
683 if (s != t - 1 && *s == '/') {
684 t = s + 1;
685 f += 2;
686 continue;
687 }
688 *t++ = *f++;
689 *t++ = *f++;
690 limit = t;
691 }
692 }
693 while (*f && (*t++ = *f++) != '/') {}
694 }
695
696 if (t > name+anchored && t[-1] == '/')
697 t--;
698 if (t == name)
699 *t++ = '.';
700 *t = '\0';
701}
702
703/* Make path appear as if a chroot had occurred. This handles a leading
704 * "/" (either removing it or expanding it) and any leading or embedded
705 * ".." components that attempt to escape past the module's top dir.
706 *
707 * If dest is NULL, a buffer is allocated to hold the result. If dest is
708 * the same buffer as p (the path) OR if reldir is NULL, a leading slash
709 * is dropped instead of being expanded to be the module's top dir.
710 *
711 * If reldir is non-NULL (and non-empty), it is a sanitized directory that
712 * the path will be relative to, so allow as many '..'s at the beginning of
713 * the path as there are components in reldir. This is used for symbolic
714 * link targets. If reldir is non-null and the path began with "/", to be
715 * completely like a chroot we should add in depth levels of ".." at the
716 * beginning of the path, but that would blow the assumption that the path
717 * doesn't grow and it is not likely to end up being a valid symlink
718 * anyway, so just do the normal removal of the leading "/" instead.
719 *
720 * While we're at it, remove double slashes and "." components like
721 * clean_fname() does, but DON'T remove a trailing slash because that is
722 * sometimes significant on command line arguments.
723 *
724 * If the resulting path would be empty, change it into ".".
725 */
726char *sanitize_path(char *dest, const char *p, const char *reldir)
727{
728 char *start, *sanp;
729 int depth = 0;
730 int allowdotdot = 0;
731 int rlen = 0;
732
733 if (dest != p) {
734 int plen = strlen(p);
735 if (*p == '/' && reldir) {
736 rlen = strlen(lp_path(module_id));
737 reldir = NULL;
738 p++;
739 }
740 if (dest) {
741 if (rlen + plen + 1 >= MAXPATHLEN)
742 return NULL;
743 } else if (!(dest = new_array(char, rlen + plen + 1)))
744 out_of_memory("sanitize_path");
745 if (rlen) {
746 memcpy(dest, lp_path(module_id), rlen);
747 if (rlen > 1)
748 dest[rlen++] = '/';
749 }
750 }
751
752 if (reldir) {
753 int new_component = 1;
754 while (*reldir) {
755 if (*reldir++ == '/')
756 new_component = 1;
757 else if (new_component) {
758 new_component = 0;
759 depth++;
760 }
761 }
762 }
763
764 start = sanp = dest + rlen;
765 while (*p == '/') {
766 /* remove leading slashes */
767 p++;
768 }
769 while (*p != '\0') {
770 /* this loop iterates once per filename component in p.
771 * both p (and sanp if the original had a slash) should
772 * always be left pointing after a slash
773 */
774 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
775 /* skip "." component */
776 while (*++p == '/') {
777 /* skip following slashes */
778 ;
779 }
780 continue;
781 }
782 allowdotdot = 0;
783 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
784 /* ".." component followed by slash or end */
785 if (depth > 0 && sanp == start) {
786 /* allow depth levels of .. at the beginning */
787 --depth;
788 allowdotdot = 1;
789 } else {
790 p += 2;
791 if (*p == '/')
792 p++;
793 if (sanp != start) {
794 /* back up sanp one level */
795 --sanp; /* now pointing at slash */
796 while (sanp > start && sanp[-1] != '/') {
797 /* skip back up to slash */
798 sanp--;
799 }
800 }
801 continue;
802 }
803 }
804 while (1) {
805 /* copy one component through next slash */
806 *sanp++ = *p++;
807 if (*p == '\0' || p[-1] == '/') {
808 while (*p == '/') {
809 /* skip multiple slashes */
810 p++;
811 }
812 break;
813 }
814 }
815 if (allowdotdot) {
816 /* move the virtual beginning to leave the .. alone */
817 start = sanp;
818 }
819 }
820 if (sanp == dest) {
821 /* ended up with nothing, so put in "." component */
822 *sanp++ = '.';
823 }
824 *sanp = '\0';
825
826 return dest;
827}
828
829char curr_dir[MAXPATHLEN];
830unsigned int curr_dir_len;
831
832/**
833 * Like chdir(), but it keeps track of the current directory (in the
834 * global "curr_dir"), and ensures that the path size doesn't overflow.
835 * Also cleans the path using the clean_fname() function.
836 **/
837int push_dir(char *dir)
838{
839 static int initialised;
840 unsigned int len;
841
842 if (!initialised) {
843 initialised = 1;
844 getcwd(curr_dir, sizeof curr_dir - 1);
845 curr_dir_len = strlen(curr_dir);
846 }
847
848 if (!dir) /* this call was probably just to initialize */
849 return 0;
850
851 len = strlen(dir);
852 if (len == 1 && *dir == '.')
853 return 1;
854
855 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
856 return 0;
857
858 if (chdir(dir))
859 return 0;
860
861 if (*dir == '/') {
862 memcpy(curr_dir, dir, len + 1);
863 curr_dir_len = len;
864 } else {
865 curr_dir[curr_dir_len++] = '/';
866 memcpy(curr_dir + curr_dir_len, dir, len + 1);
867 curr_dir_len += len;
868 }
869
870 clean_fname(curr_dir);
871
872 return 1;
873}
874
875/**
876 * Reverse a push_dir() call. You must pass in an absolute path
877 * that was copied from a prior value of "curr_dir".
878 **/
879int pop_dir(char *dir)
880{
881 if (chdir(dir))
882 return 0;
883
884 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
885 if (curr_dir_len >= sizeof curr_dir)
886 curr_dir_len = sizeof curr_dir - 1;
887
888 return 1;
889}
890
891/**
892 * Return the filename, turning any newlines into '?'s. This ensures that
893 * outputting it on a line of its own cannot generate an empty line. This
894 * function can handle only 2 names at a time!
895 **/
896const char *safe_fname(const char *fname)
897{
898 static char fbuf1[MAXPATHLEN], fbuf2[MAXPATHLEN];
899 static char *fbuf = fbuf2;
900 char *nl = strchr(fname, '\n');
901
902 if (!nl)
903 return fname;
904
905 fbuf = fbuf == fbuf1 ? fbuf2 : fbuf1;
906 strlcpy(fbuf, fname, MAXPATHLEN);
907 nl = fbuf + (nl - (char *)fname);
908 do {
909 *nl = '?';
910 } while ((nl = strchr(nl+1, '\n')) != NULL);
911
912 return fbuf;
913}
914
915/**
916 * Return a quoted string with the full pathname of the indicated filename.
917 * The string " (in MODNAME)" may also be appended. The returned pointer
918 * remains valid until the next time full_fname() is called.
919 **/
920char *full_fname(const char *fn)
921{
922 static char *result = NULL;
923 char *m1, *m2, *m3;
924 char *p1, *p2;
925
926 if (result)
927 free(result);
928
929 fn = safe_fname(fn);
930 if (*fn == '/')
931 p1 = p2 = "";
932 else {
933 p1 = curr_dir;
934 p2 = "/";
935 }
936 if (module_id >= 0) {
937 m1 = " (in ";
938 m2 = lp_name(module_id);
939 m3 = ")";
940 if (*p1) {
941 if (!lp_use_chroot(module_id)) {
942 char *p = lp_path(module_id);
943 if (*p != '/' || p[1])
944 p1 += strlen(p);
945 }
946 if (!*p1)
947 p2++;
948 else
949 p1++;
950 }
951 else
952 fn++;
953 } else
954 m1 = m2 = m3 = "";
955
956 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
957
958 return result;
959}
960
961static char partial_fname[MAXPATHLEN];
962
963char *partial_dir_fname(const char *fname)
964{
965 char *t = partial_fname;
966 int sz = sizeof partial_fname;
967 const char *fn;
968
969 if ((fn = strrchr(fname, '/')) != NULL) {
970 fn++;
971 if (*partial_dir != '/') {
972 int len = fn - fname;
973 strncpy(t, fname, len); /* safe */
974 t += len;
975 sz -= len;
976 }
977 } else
978 fn = fname;
979 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
980 return NULL;
981 if (server_exclude_list.head
982 && check_exclude(&server_exclude_list, partial_fname, 0) < 0)
983 return NULL;
984
985 return partial_fname;
986}
987
988/* If no --partial-dir option was specified, we don't need to do anything
989 * (the partial-dir is essentially '.'), so just return success. */
990int handle_partial_dir(const char *fname, int create)
991{
992 char *fn, *dir;
993
994 if (fname != partial_fname)
995 return 1;
996 if (!create && *partial_dir == '/')
997 return 1;
998 if (!(fn = strrchr(partial_fname, '/')))
999 return 1;
1000
1001 *fn = '\0';
1002 dir = partial_fname;
1003 if (create) {
1004 STRUCT_STAT st;
1005#if SUPPORT_LINKS
1006 int statret = do_lstat(dir, &st);
1007#else
1008 int statret = do_stat(dir, &st);
1009#endif
1010 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1011 if (do_unlink(dir) < 0)
1012 return 0;
1013 statret = -1;
1014 }
1015 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1016 return 0;
1017 } else
1018 do_rmdir(dir);
1019 *fn = '/';
1020
1021 return 1;
1022}
1023
1024/** We need to supply our own strcmp function for file list comparisons
1025 to ensure that signed/unsigned usage is consistent between machines. */
1026int u_strcmp(const char *cs1, const char *cs2)
1027{
1028 const uchar *s1 = (const uchar *)cs1;
1029 const uchar *s2 = (const uchar *)cs2;
1030
1031 while (*s1 && *s2 && (*s1 == *s2)) {
1032 s1++; s2++;
1033 }
1034
1035 return (int)*s1 - (int)*s2;
1036}
1037
1038
1039
1040/**
1041 * Determine if a symlink points outside the current directory tree.
1042 * This is considered "unsafe" because e.g. when mirroring somebody
1043 * else's machine it might allow them to establish a symlink to
1044 * /etc/passwd, and then read it through a web server.
1045 *
1046 * Null symlinks and absolute symlinks are always unsafe.
1047 *
1048 * Basically here we are concerned with symlinks whose target contains
1049 * "..", because this might cause us to walk back up out of the
1050 * transferred directory. We are not allowed to go back up and
1051 * reenter.
1052 *
1053 * @param dest Target of the symlink in question.
1054 *
1055 * @param src Top source directory currently applicable. Basically this
1056 * is the first parameter to rsync in a simple invocation, but it's
1057 * modified by flist.c in slightly complex ways.
1058 *
1059 * @retval True if unsafe
1060 * @retval False is unsafe
1061 *
1062 * @sa t_unsafe.c
1063 **/
1064int unsafe_symlink(const char *dest, const char *src)
1065{
1066 const char *name, *slash;
1067 int depth = 0;
1068
1069 /* all absolute and null symlinks are unsafe */
1070 if (!dest || !*dest || *dest == '/')
1071 return 1;
1072
1073 /* find out what our safety margin is */
1074 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1075 if (strncmp(name, "../", 3) == 0) {
1076 depth = 0;
1077 } else if (strncmp(name, "./", 2) == 0) {
1078 /* nothing */
1079 } else {
1080 depth++;
1081 }
1082 }
1083 if (strcmp(name, "..") == 0)
1084 depth = 0;
1085
1086 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1087 if (strncmp(name, "../", 3) == 0) {
1088 /* if at any point we go outside the current directory
1089 then stop - it is unsafe */
1090 if (--depth < 0)
1091 return 1;
1092 } else if (strncmp(name, "./", 2) == 0) {
1093 /* nothing */
1094 } else {
1095 depth++;
1096 }
1097 }
1098 if (strcmp(name, "..") == 0)
1099 depth--;
1100
1101 return (depth < 0);
1102}
1103
1104
1105/**
1106 * Return the date and time as a string
1107 **/
1108char *timestring(time_t t)
1109{
1110 static char TimeBuf[200];
1111 struct tm *tm = localtime(&t);
1112
1113#ifdef HAVE_STRFTIME
1114 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1115#else
1116 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1117#endif
1118
1119 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1120 TimeBuf[strlen(TimeBuf)-1] = 0;
1121 }
1122
1123 return(TimeBuf);
1124}
1125
1126
1127/**
1128 * Sleep for a specified number of milliseconds.
1129 *
1130 * Always returns TRUE. (In the future it might return FALSE if
1131 * interrupted.)
1132 **/
1133int msleep(int t)
1134{
1135 int tdiff = 0;
1136 struct timeval tval, t1, t2;
1137
1138 gettimeofday(&t1, NULL);
1139
1140 while (tdiff < t) {
1141 tval.tv_sec = (t-tdiff)/1000;
1142 tval.tv_usec = 1000*((t-tdiff)%1000);
1143
1144 errno = 0;
1145 select(0,NULL,NULL, NULL, &tval);
1146
1147 gettimeofday(&t2, NULL);
1148 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1149 (t2.tv_usec - t1.tv_usec)/1000;
1150 }
1151
1152 return True;
1153}
1154
1155
1156/**
1157 * Determine if two file modification times are equivalent (either
1158 * exact or in the modification timestamp window established by
1159 * --modify-window).
1160 *
1161 * @retval 0 if the times should be treated as the same
1162 *
1163 * @retval +1 if the first is later
1164 *
1165 * @retval -1 if the 2nd is later
1166 **/
1167int cmp_modtime(time_t file1, time_t file2)
1168{
1169 if (file2 > file1) {
1170 if (file2 - file1 <= modify_window)
1171 return 0;
1172 return -1;
1173 }
1174 if (file1 - file2 <= modify_window)
1175 return 0;
1176 return 1;
1177}
1178
1179
1180#ifdef __INSURE__XX
1181#include <dlfcn.h>
1182
1183/**
1184 This routine is a trick to immediately catch errors when debugging
1185 with insure. A xterm with a gdb is popped up when insure catches
1186 a error. It is Linux specific.
1187**/
1188int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1189{
1190 static int (*fn)();
1191 int ret;
1192 char *cmd;
1193
1194 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'",
1195 getpid(), getpid(), getpid());
1196
1197 if (!fn) {
1198 static void *h;
1199 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1200 fn = dlsym(h, "_Insure_trap_error");
1201 }
1202
1203 ret = fn(a1, a2, a3, a4, a5, a6);
1204
1205 system(cmd);
1206
1207 free(cmd);
1208
1209 return ret;
1210}
1211#endif
1212
1213
1214#define MALLOC_MAX 0x40000000
1215
1216void *_new_array(unsigned int size, unsigned long num)
1217{
1218 if (num >= MALLOC_MAX/size)
1219 return NULL;
1220 return malloc(size * num);
1221}
1222
1223void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1224{
1225 if (num >= MALLOC_MAX/size)
1226 return NULL;
1227 /* No realloc should need this, but just in case... */
1228 if (!ptr)
1229 return malloc(size * num);
1230 return realloc(ptr, size * num);
1231}