If there is no lchown(), don't try to set the user & group of a symlink.
[rsync/rsync.git] / util.c
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
30 extern int verbose;
31 extern int dry_run;
32 extern int module_id;
33 extern int modify_window;
34 extern char *partial_dir;
35 extern struct exclude_list_struct server_exclude_list;
36
37 int sanitize_paths = 0;
38
39
40
41 /**
42  * Set a fd into nonblocking mode
43  **/
44 void 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  **/
59 void 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  */
78 int 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
97 void 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
117 void out_of_memory(char *str)
118 {
119         rprintf(FERROR, "ERROR: out of memory in %s\n", str);
120         exit_cleanup(RERR_MALLOC);
121 }
122
123 void overflow(char *str)
124 {
125         rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
126         exit_cleanup(RERR_MALLOC);
127 }
128
129
130
131 int 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 **/
170 int 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  */
200 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. */
231 static 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 and --backup options */
249 int 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  **/
318 int 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 successful rename, 1 if we successfully copied the file
366  * across filesystems, -2 if copy_file() failed, and -1 on other errors. */
367 int 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 1;
387                 default:
388                         return -1;
389                 }
390         }
391         return -1;
392 }
393
394
395 static pid_t all_pids[10];
396 static int num_pids;
397
398 /** Fork and record the pid of the child. **/
399 pid_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  **/
419 void 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 */
440 int 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 */
454 int 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 */
469 int 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
482 static 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
499 static 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, "", 0);
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. */
557 void 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  **/
592 void 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. */
605 size_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. */
627 size_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
653 int 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
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 ".". */
671 unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
672 {
673         char *limit = name - 1, *t = name, *f = name;
674         int anchored;
675
676         if (!name)
677                 return 0;
678
679         if ((anchored = *f == '/') != 0)
680                 *t++ = *f++;
681         while (*f) {
682                 /* discard extra slashes */
683                 if (*f == '/') {
684                         f++;
685                         continue;
686                 }
687                 if (*f == '.') {
688                         /* discard "." dirs (but NOT a trailing '.'!) */
689                         if (f[1] == '/') {
690                                 f += 2;
691                                 continue;
692                         }
693                         /* collapse ".." dirs */
694                         if (collapse_dot_dot
695                             && f[1] == '.' && (f[2] == '/' || !f[2])) {
696                                 char *s = t - 1;
697                                 if (s == name && anchored) {
698                                         f += 2;
699                                         continue;
700                                 }
701                                 while (s > limit && *--s != '/') {}
702                                 if (s != t - 1 && (s < name || *s == '/')) {
703                                         t = s + 1;
704                                         f += 2;
705                                         continue;
706                                 }
707                                 limit = t + 2;
708                         }
709                 }
710                 while (*f && (*t++ = *f++) != '/') {}
711         }
712
713         if (t > name+anchored && t[-1] == '/')
714                 t--;
715         if (t == name)
716                 *t++ = '.';
717         *t = '\0';
718
719         return t - name;
720 }
721
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.
725  *
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.
729  *
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).
732  *
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.
735  *
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 ".". */
744 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
745 {
746         char *start, *sanp;
747         int rlen = 0;
748
749         if (dest != p) {
750                 int plen = strlen(p);
751                 if (*p == '/') {
752                         if (!rootdir)
753                                 rootdir = lp_path(module_id);
754                         rlen = strlen(rootdir);
755                         depth = 0;
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) {
764                         memcpy(dest, rootdir, rlen);
765                         if (rlen > 1)
766                                 dest[rlen++] = '/';
767                 }
768         }
769
770         start = sanp = dest + rlen;
771         while (*p != '\0') {
772                 /* discard leading or extra slashes */
773                 if (*p == '/') {
774                         p++;
775                         continue;
776                 }
777                 /* this loop iterates once per filename component in p.
778                  * both p (and sanp if the original had a slash) should
779                  * always be left pointing after a slash
780                  */
781                 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
782                         /* skip "." component */
783                         p++;
784                         continue;
785                 }
786                 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
787                         /* ".." component followed by slash or end */
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                                         }
797                                 }
798                                 continue;
799                         }
800                         /* allow depth levels of .. at the beginning */
801                         depth--;
802                         /* move the virtual beginning to leave the .. alone */
803                         start = sanp + 3;
804                 }
805                 /* copy one component through next slash */
806                 while (*p && (*sanp++ = *p++) != '/') {}
807         }
808         if (sanp == dest) {
809                 /* ended up with nothing, so put in "." component */
810                 *sanp++ = '.';
811         }
812         *sanp = '\0';
813
814         return dest;
815 }
816
817 char curr_dir[MAXPATHLEN];
818 unsigned int curr_dir_len;
819
820 /**
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.
824  **/
825 int push_dir(char *dir)
826 {
827         static int initialised;
828         unsigned int len;
829
830         if (!initialised) {
831                 initialised = 1;
832                 getcwd(curr_dir, sizeof curr_dir - 1);
833                 curr_dir_len = strlen(curr_dir);
834         }
835
836         if (!dir)       /* this call was probably just to initialize */
837                 return 0;
838
839         len = strlen(dir);
840         if (len == 1 && *dir == '.')
841                 return 1;
842
843         if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
844                 return 0;
845
846         if (chdir(dir))
847                 return 0;
848
849         if (*dir == '/') {
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;
856         }
857
858         curr_dir_len = clean_fname(curr_dir, 1);
859
860         return 1;
861 }
862
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  **/
867 int pop_dir(char *dir)
868 {
869         if (chdir(dir))
870                 return 0;
871
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;
875
876         return 1;
877 }
878
879 /**
880  * Return the filename, turning any newlines into '?'s.  This ensures that
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!
883  **/
884 const char *safe_fname(const char *fname)
885 {
886         static char fbuf1[MAXPATHLEN], fbuf2[MAXPATHLEN];
887         static char *fbuf = fbuf2;
888         char *nl = strchr(fname, '\n');
889
890         if (!nl)
891                 return fname;
892
893         fbuf = fbuf == fbuf1 ? fbuf2 : fbuf1;
894         strlcpy(fbuf, fname, MAXPATHLEN);
895         nl = fbuf + (nl - (char *)fname);
896         do {
897                 *nl = '?';
898         } while ((nl = strchr(nl+1, '\n')) != NULL);
899
900         return fbuf;
901 }
902
903 /**
904  * Return a quoted string with the full pathname of the indicated filename.
905  * The string " (in MODNAME)" may also be appended.  The returned pointer
906  * remains valid until the next time full_fname() is called.
907  **/
908 char *full_fname(const char *fn)
909 {
910         static char *result = NULL;
911         char *m1, *m2, *m3;
912         char *p1, *p2;
913
914         if (result)
915                 free(result);
916
917         fn = safe_fname(fn);
918         if (*fn == '/')
919                 p1 = p2 = "";
920         else {
921                 p1 = curr_dir;
922                 p2 = "/";
923         }
924         if (module_id >= 0) {
925                 m1 = " (in ";
926                 m2 = lp_name(module_id);
927                 m3 = ")";
928                 if (*p1) {
929                         if (!lp_use_chroot(module_id)) {
930                                 char *p = lp_path(module_id);
931                                 if (*p != '/' || p[1])
932                                         p1 += strlen(p);
933                         }
934                         if (!*p1)
935                                 p2++;
936                         else
937                                 p1++;
938                 }
939                 else
940                         fn++;
941         } else
942                 m1 = m2 = m3 = "";
943
944         asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
945
946         return result;
947 }
948
949 static char partial_fname[MAXPATHLEN];
950
951 char *partial_dir_fname(const char *fname)
952 {
953         char *t = partial_fname;
954         int sz = sizeof partial_fname;
955         const char *fn;
956
957         if ((fn = strrchr(fname, '/')) != NULL) {
958                 fn++;
959                 if (*partial_dir != '/') {
960                         int len = fn - fname;
961                         strncpy(t, fname, len); /* safe */
962                         t += len;
963                         sz -= len;
964                 }
965         } else
966                 fn = fname;
967         if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
968                 return NULL;
969         if (server_exclude_list.head
970             && check_exclude(&server_exclude_list, partial_fname, 0) < 0)
971                 return NULL;
972
973         return partial_fname;
974 }
975
976 /* If no --partial-dir option was specified, we don't need to do anything
977  * (the partial-dir is essentially '.'), so just return success. */
978 int handle_partial_dir(const char *fname, int create)
979 {
980         char *fn, *dir;
981
982         if (fname != partial_fname)
983                 return 1;
984         if (!create && *partial_dir == '/')
985                 return 1;
986         if (!(fn = strrchr(partial_fname, '/')))
987                 return 1;
988
989         *fn = '\0';
990         dir = partial_fname;
991         if (create) {
992                 STRUCT_STAT st;
993 #if SUPPORT_LINKS
994                 int statret = do_lstat(dir, &st);
995 #else
996                 int statret = do_stat(dir, &st);
997 #endif
998                 if (statret == 0 && !S_ISDIR(st.st_mode)) {
999                         if (do_unlink(dir) < 0)
1000                                 return 0;
1001                         statret = -1;
1002                 }
1003                 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1004                         return 0;
1005         } else
1006                 do_rmdir(dir);
1007         *fn = '/';
1008
1009         return 1;
1010 }
1011
1012 /** We need to supply our own strcmp function for file list comparisons
1013    to ensure that signed/unsigned usage is consistent between machines. */
1014 int u_strcmp(const char *cs1, const char *cs2)
1015 {
1016         const uchar *s1 = (const uchar *)cs1;
1017         const uchar *s2 = (const uchar *)cs2;
1018
1019         while (*s1 && *s2 && (*s1 == *s2)) {
1020                 s1++; s2++;
1021         }
1022
1023         return (int)*s1 - (int)*s2;
1024 }
1025
1026
1027
1028 /**
1029  * Determine if a symlink points outside the current directory tree.
1030  * This is considered "unsafe" because e.g. when mirroring somebody
1031  * else's machine it might allow them to establish a symlink to
1032  * /etc/passwd, and then read it through a web server.
1033  *
1034  * Null symlinks and absolute symlinks are always unsafe.
1035  *
1036  * Basically here we are concerned with symlinks whose target contains
1037  * "..", because this might cause us to walk back up out of the
1038  * transferred directory.  We are not allowed to go back up and
1039  * reenter.
1040  *
1041  * @param dest Target of the symlink in question.
1042  *
1043  * @param src Top source directory currently applicable.  Basically this
1044  * is the first parameter to rsync in a simple invocation, but it's
1045  * modified by flist.c in slightly complex ways.
1046  *
1047  * @retval True if unsafe
1048  * @retval False is unsafe
1049  *
1050  * @sa t_unsafe.c
1051  **/
1052 int unsafe_symlink(const char *dest, const char *src)
1053 {
1054         const char *name, *slash;
1055         int depth = 0;
1056
1057         /* all absolute and null symlinks are unsafe */
1058         if (!dest || !*dest || *dest == '/')
1059                 return 1;
1060
1061         /* find out what our safety margin is */
1062         for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1063                 if (strncmp(name, "../", 3) == 0) {
1064                         depth = 0;
1065                 } else if (strncmp(name, "./", 2) == 0) {
1066                         /* nothing */
1067                 } else {
1068                         depth++;
1069                 }
1070         }
1071         if (strcmp(name, "..") == 0)
1072                 depth = 0;
1073
1074         for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1075                 if (strncmp(name, "../", 3) == 0) {
1076                         /* if at any point we go outside the current directory
1077                            then stop - it is unsafe */
1078                         if (--depth < 0)
1079                                 return 1;
1080                 } else if (strncmp(name, "./", 2) == 0) {
1081                         /* nothing */
1082                 } else {
1083                         depth++;
1084                 }
1085         }
1086         if (strcmp(name, "..") == 0)
1087                 depth--;
1088
1089         return (depth < 0);
1090 }
1091
1092
1093 /**
1094  * Return the date and time as a string
1095  **/
1096 char *timestring(time_t t)
1097 {
1098         static char TimeBuf[200];
1099         struct tm *tm = localtime(&t);
1100
1101 #ifdef HAVE_STRFTIME
1102         strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1103 #else
1104         strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1105 #endif
1106
1107         if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1108                 TimeBuf[strlen(TimeBuf)-1] = 0;
1109         }
1110
1111         return(TimeBuf);
1112 }
1113
1114
1115 /**
1116  * Sleep for a specified number of milliseconds.
1117  *
1118  * Always returns TRUE.  (In the future it might return FALSE if
1119  * interrupted.)
1120  **/
1121 int msleep(int t)
1122 {
1123         int tdiff = 0;
1124         struct timeval tval, t1, t2;
1125
1126         gettimeofday(&t1, NULL);
1127
1128         while (tdiff < t) {
1129                 tval.tv_sec = (t-tdiff)/1000;
1130                 tval.tv_usec = 1000*((t-tdiff)%1000);
1131
1132                 errno = 0;
1133                 select(0,NULL,NULL, NULL, &tval);
1134
1135                 gettimeofday(&t2, NULL);
1136                 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1137                         (t2.tv_usec - t1.tv_usec)/1000;
1138         }
1139
1140         return True;
1141 }
1142
1143
1144 /**
1145  * Determine if two file modification times are equivalent (either
1146  * exact or in the modification timestamp window established by
1147  * --modify-window).
1148  *
1149  * @retval 0 if the times should be treated as the same
1150  *
1151  * @retval +1 if the first is later
1152  *
1153  * @retval -1 if the 2nd is later
1154  **/
1155 int cmp_modtime(time_t file1, time_t file2)
1156 {
1157         if (file2 > file1) {
1158                 if (file2 - file1 <= modify_window)
1159                         return 0;
1160                 return -1;
1161         }
1162         if (file1 - file2 <= modify_window)
1163                 return 0;
1164         return 1;
1165 }
1166
1167
1168 #ifdef __INSURE__XX
1169 #include <dlfcn.h>
1170
1171 /**
1172    This routine is a trick to immediately catch errors when debugging
1173    with insure. A xterm with a gdb is popped up when insure catches
1174    a error. It is Linux specific.
1175 **/
1176 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1177 {
1178         static int (*fn)();
1179         int ret;
1180         char *cmd;
1181
1182         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'",
1183                 getpid(), getpid(), getpid());
1184
1185         if (!fn) {
1186                 static void *h;
1187                 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1188                 fn = dlsym(h, "_Insure_trap_error");
1189         }
1190
1191         ret = fn(a1, a2, a3, a4, a5, a6);
1192
1193         system(cmd);
1194
1195         free(cmd);
1196
1197         return ret;
1198 }
1199 #endif
1200
1201
1202 #define MALLOC_MAX 0x40000000
1203
1204 void *_new_array(unsigned int size, unsigned long num)
1205 {
1206         if (num >= MALLOC_MAX/size)
1207                 return NULL;
1208         return malloc(size * num);
1209 }
1210
1211 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1212 {
1213         if (num >= MALLOC_MAX/size)
1214                 return NULL;
1215         /* No realloc should need this, but just in case... */
1216         if (!ptr)
1217                 return malloc(size * num);
1218         return realloc(ptr, size * num);
1219 }