1 /* -*- c-file-style: "linux" -*-
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>
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.
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.
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.
25 * Utilities used in rsync
32 int sanitize_paths = 0;
37 * Set a fd into nonblocking mode
39 void set_nonblocking(int fd)
43 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
45 if (!(val & NONBLOCK_FLAG)) {
47 fcntl(fd, F_SETFL, val);
52 * Set a fd into blocking mode
54 void set_blocking(int fd)
58 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
60 if (val & NONBLOCK_FLAG) {
61 val &= ~NONBLOCK_FLAG;
62 fcntl(fd, F_SETFL, val);
68 * Create a file descriptor pair - like pipe() but use socketpair if
69 * possible (because of blocking issues on pipes).
71 * Always set non-blocking.
73 int fd_pair(int fd[2])
78 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
84 set_nonblocking(fd[0]);
85 set_nonblocking(fd[1]);
92 void print_child_argv(char **cmd)
94 rprintf(FINFO, "opening connection using ");
96 /* Look for characters that ought to be quoted. This
97 * is not a great quoting algorithm, but it's
98 * sufficient for a log message. */
99 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
100 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
102 ",.-_=+@/") != strlen(*cmd)) {
103 rprintf(FINFO, "\"%s\" ", *cmd);
105 rprintf(FINFO, "%s ", *cmd);
108 rprintf(FINFO, "\n");
112 void out_of_memory(char *str)
114 rprintf(FERROR,"ERROR: out of memory in %s\n",str);
115 exit_cleanup(RERR_MALLOC);
118 void overflow(char *str)
120 rprintf(FERROR,"ERROR: buffer overflow in %s\n",str);
121 exit_cleanup(RERR_MALLOC);
126 int set_modtime(char *fname, time_t modtime)
133 rprintf(FINFO, "set modtime of %s to (%ld) %s",
134 fname, (long) modtime,
135 asctime(localtime(&modtime)));
141 tbuf.actime = time(NULL);
142 tbuf.modtime = modtime;
143 return utime(fname,&tbuf);
144 #elif defined(HAVE_UTIME)
148 return utime(fname,t);
151 t[0].tv_sec = time(NULL);
153 t[1].tv_sec = modtime;
155 return utimes(fname,t);
162 Create any necessary directories in fname. Unfortunately we don't know
163 what perms to give the directory when this is called so we need to rely
166 int create_directory_path(char *fname, int base_umask)
170 while (*fname == '/') fname++;
171 while (strncmp(fname,"./",2)==0) fname += 2;
174 while ((p=strchr(p,'/'))) {
176 do_mkdir(fname, 0777 & ~base_umask);
185 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
188 * @retval len upon success
190 * @retval <0 write's (negative) error code
192 * Derived from GNU C's cccp.c.
194 static int full_write(int desc, char *ptr, size_t len)
200 int written = write(desc, ptr, len);
206 total_written += written;
210 return total_written;
215 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
218 * @retval >0 the actual number of bytes read
222 * @retval <0 for an error.
224 * Derived from GNU C's cccp.c. */
225 static int safe_read(int desc, char *ptr, size_t len)
233 n_chars = read(desc, ptr, len);
234 } while (n_chars < 0 && errno == EINTR);
242 * This is used in conjunction with the --temp-dir option */
243 int copy_file(char *source, char *dest, mode_t mode)
248 int len; /* Number of bytes read into `buf'. */
250 ifd = do_open(source, O_RDONLY, 0);
252 rprintf(FERROR,"open %s: %s\n",
253 source,strerror(errno));
257 if (robust_unlink(dest) && errno != ENOENT) {
258 rprintf(FERROR,"unlink %s: %s\n",
259 dest,strerror(errno));
263 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
265 rprintf(FERROR,"open %s: %s\n",
266 dest,strerror(errno));
271 while ((len = safe_read(ifd, buf, sizeof(buf))) > 0) {
272 if (full_write(ofd, buf, len) < 0) {
273 rprintf(FERROR,"write %s: %s\n",
274 dest,strerror(errno));
285 rprintf(FERROR,"read %s: %s\n",
286 source,strerror(errno));
293 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
294 #define MAX_RENAMES_DIGITS 3
295 #define MAX_RENAMES 1000
298 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
299 * rename to <path>/.rsyncNNN instead.
301 * Note that successive rsync runs will shuffle the filenames around a
302 * bit as long as the file is still busy; this is because this function
303 * does not know if the unlink call is due to a new file coming in, or
304 * --delete trying to remove old .rsyncNNN files, hence it renames it
307 int robust_unlink(char *fname)
310 return do_unlink(fname);
312 static int counter = 1;
314 char path[MAXPATHLEN];
316 rc = do_unlink(fname);
317 if ((rc == 0) || (errno != ETXTBSY))
320 strlcpy(path, fname, MAXPATHLEN);
323 while((path[--pos] != '/') && (pos >= 0))
326 strlcpy(&path[pos], ".rsync", MAXPATHLEN-pos);
327 pos += sizeof(".rsync")-1;
329 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
334 /* start where the last one left off to reduce chance of clashes */
337 sprintf(&path[pos], "%03d", counter);
338 if (++counter >= MAX_RENAMES)
340 } while (((rc = access(path, 0)) == 0) && (counter != start));
343 rprintf(FINFO,"renaming %s to %s because of text busy\n",
347 /* maybe we should return rename()'s exit status? Nah. */
348 if (do_rename(fname, path) != 0) {
356 int robust_rename(char *from, char *to)
359 return do_rename(from, to);
361 int rc = do_rename(from, to);
362 if ((rc == 0) || (errno != ETXTBSY))
364 if (robust_unlink(to) != 0)
366 return do_rename(from, to);
371 static pid_t all_pids[10];
374 /** Fork and record the pid of the child. **/
377 pid_t newpid = fork();
379 if (newpid != 0 && newpid != -1) {
380 all_pids[num_pids++] = newpid;
388 * @todo It would be kind of nice to make sure that they are actually
389 * all our children before we kill them, because their pids may have
390 * been recycled by some other process. Perhaps when we wait for a
391 * child, we should remove it from this array. Alternatively we could
392 * perhaps use process groups, but I think that would not work on
393 * ancient Unix versions that don't support them.
395 void kill_all(int sig)
399 for (i = 0; i < num_pids; i++) {
400 /* Let's just be a little careful where we
401 * point that gun, hey? See kill(2) for the
402 * magic caused by negative values. */
403 pid_t p = all_pids[i];
415 /** Turn a user name into a uid */
416 int name_to_uid(char *name, uid_t *uid)
419 if (!name || !*name) return 0;
420 pass = getpwnam(name);
428 /** Turn a group name into a gid */
429 int name_to_gid(char *name, gid_t *gid)
432 if (!name || !*name) return 0;
433 grp = getgrnam(name);
442 /** Lock a byte range in a open file */
443 int lock_range(int fd, int offset, int len)
447 lock.l_type = F_WRLCK;
448 lock.l_whence = SEEK_SET;
449 lock.l_start = offset;
453 return fcntl(fd,F_SETLK,&lock) == 0;
456 static int exclude_server_path(char *arg)
459 extern struct exclude_struct **server_exclude_list;
461 if (server_exclude_list) {
462 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
464 if (check_exclude(server_exclude_list, arg, 1)) {
465 /* We must leave arg truncated! */
474 static void glob_expand_one(char *s, char **argv, int *argc, int maxargs)
476 #if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
478 s = argv[*argc] = strdup(s);
479 exclude_server_path(s);
482 extern int sanitize_paths;
488 s = argv[*argc] = strdup(s);
489 if (sanitize_paths) {
490 sanitize_path(s, NULL);
493 memset(&globbuf, 0, sizeof(globbuf));
494 if (!exclude_server_path(s))
495 glob(s, 0, NULL, &globbuf);
496 if (globbuf.gl_pathc == 0) {
501 for (i=0; i<(maxargs - (*argc)) && i < (int) globbuf.gl_pathc;i++) {
503 argv[(*argc) + i] = strdup(globbuf.gl_pathv[i]);
504 if (!argv[(*argc) + i]) out_of_memory("glob_expand");
511 /* This routine is only used in daemon mode. */
512 void glob_expand(char *base1, char **argv, int *argc, int maxargs)
514 char *s = argv[*argc];
517 int base_len = strlen(base);
519 if (!s || !*s) return;
521 if (strncmp(s, base, base_len) == 0)
525 if (!s) out_of_memory("glob_expand");
527 if (asprintf(&base," %s/", base1) <= 0) out_of_memory("glob_expand");
531 while ((p = strstr(q,base)) && ((*argc) < maxargs)) {
532 /* split it at this point */
534 glob_expand_one(q, argv, argc, maxargs);
538 if (*q && (*argc < maxargs)) glob_expand_one(q, argv, argc, maxargs);
545 * Convert a string to lower case
547 void strlower(char *s)
550 if (isupper(* (unsigned char *) s))
551 *s = tolower(* (unsigned char *) s);
556 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
557 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
558 * strings + 1 (if '/' was inserted), regardless of whether the whole thing
559 * fits into destsize (including the terminating '\0'). */
560 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
562 size_t len = strlcpy(dest, p1, destsize);
563 if (len < destsize - 1) {
564 if (!len || dest[len-1] != '/')
566 if (len < destsize - 1)
567 len += strlcpy(dest + len, p2, destsize - len);
574 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
578 /* Join any number of strings together, putting them in "dest". The return
579 * value is the length of all the strings, regardless of whether they fit in
580 * destsize (including the terminating '\0'). Your list of string pointers
581 * should end with a NULL to indicate the end of the list. */
582 size_t stringjoin(char *dest, size_t destsize, ...)
588 va_start(ap, destsize);
590 if (!(src = va_arg(ap, const char *)))
597 memcpy(dest, src, len);
608 void clean_fname(char *name)
619 if ((p=strstr(name,"/./"))) {
627 if ((p=strstr(name,"//"))) {
635 if (strncmp(p=name,"./",2) == 0) {
643 if (l > 1 && p[l-1] == '/') {
651 * Make path appear as if a chroot had occurred:
653 * @li 1. remove leading "/" (or replace with "." if at end)
655 * @li 2. remove leading ".." components (except those allowed by @p reldir)
657 * @li 3. delete any other "<dir>/.." (recursively)
659 * Can only shrink paths, so sanitizes in place.
661 * While we're at it, remove double slashes and "." components like
662 * clean_fname() does, but DON'T remove a trailing slash because that
663 * is sometimes significant on command line arguments.
665 * If @p reldir is non-null, it is a sanitized directory that the path will be
666 * relative to, so allow as many ".." at the beginning of the path as
667 * there are components in reldir. This is used for symbolic link targets.
668 * If reldir is non-null and the path began with "/", to be completely like
669 * a chroot we should add in depth levels of ".." at the beginning of the
670 * path, but that would blow the assumption that the path doesn't grow and
671 * it is not likely to end up being a valid symlink anyway, so just do
672 * the normal removal of the leading "/" instead.
674 * Contributed by Dave Dykstra <dwd@bell-labs.com>
676 void sanitize_path(char *p, char *reldir)
685 if (*reldir++ == '/') {
693 /* remove leading slashes */
697 /* this loop iterates once per filename component in p.
698 * both p (and sanp if the original had a slash) should
699 * always be left pointing after a slash
701 if ((*p == '.') && ((*(p+1) == '/') || (*(p+1) == '\0'))) {
702 /* skip "." component */
703 while (*++p == '/') {
704 /* skip following slashes */
710 if ((*p == '.') && (*(p+1) == '.') &&
711 ((*(p+2) == '/') || (*(p+2) == '\0'))) {
712 /* ".." component followed by slash or end */
713 if ((depth > 0) && (sanp == start)) {
714 /* allow depth levels of .. at the beginning */
722 /* back up sanp one level */
723 --sanp; /* now pointing at slash */
724 while ((sanp > start) && (*(sanp - 1) != '/')) {
725 /* skip back up to slash */
733 /* copy one component through next slash */
735 if ((*p == '\0') || (*(p-1) == '/')) {
737 /* skip multiple slashes */
744 /* move the virtual beginning to leave the .. alone */
748 if ((sanp == start) && !allowdotdot) {
749 /* ended up with nothing, so put in "." component */
751 * note that the !allowdotdot doesn't prevent this from
752 * happening in all allowed ".." situations, but I didn't
753 * think it was worth putting in an extra variable to ensure
754 * it since an extra "." won't hurt in those situations.
762 char curr_dir[MAXPATHLEN];
763 unsigned int curr_dir_len;
766 * Like chdir(), but it keeps track of the current directory (in the
767 * global "curr_dir"), and ensures that the path size doesn't overflow.
768 * Also cleans the path using the clean_fname() function.
770 int push_dir(char *dir)
772 static int initialised;
777 getcwd(curr_dir, sizeof(curr_dir)-1);
778 curr_dir_len = strlen(curr_dir);
781 if (!dir) /* this call was probably just to initialize */
785 if (len == 1 && *dir == '.')
788 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
795 memcpy(curr_dir, dir, len + 1);
798 curr_dir[curr_dir_len++] = '/';
799 memcpy(curr_dir + curr_dir_len, dir, len + 1);
803 clean_fname(curr_dir);
809 * Reverse a push_dir() call. You must pass in an absolute path
810 * that was copied from a prior value of "curr_dir".
812 int pop_dir(char *dir)
817 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
818 if (curr_dir_len >= sizeof curr_dir)
819 curr_dir_len = sizeof curr_dir - 1;
825 * Return a quoted string with the full pathname of the indicated filename.
826 * The string " (in MODNAME)" may also be appended. The returned pointer
827 * remains valid until the next time full_fname() is called.
829 char *full_fname(char *fn)
831 extern int module_id;
832 static char *result = NULL;
845 if (module_id >= 0) {
847 m2 = lp_name(module_id);
850 if (!lp_use_chroot(module_id)) {
851 char *p = lp_path(module_id);
852 if (*p != '/' || p[1])
865 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
870 /** We need to supply our own strcmp function for file list comparisons
871 to ensure that signed/unsigned usage is consistent between machines. */
872 int u_strcmp(const char *cs1, const char *cs2)
874 const uchar *s1 = (const uchar *)cs1;
875 const uchar *s2 = (const uchar *)cs2;
877 while (*s1 && *s2 && (*s1 == *s2)) {
881 return (int)*s1 - (int)*s2;
887 * Determine if a symlink points outside the current directory tree.
888 * This is considered "unsafe" because e.g. when mirroring somebody
889 * else's machine it might allow them to establish a symlink to
890 * /etc/passwd, and then read it through a web server.
892 * Null symlinks and absolute symlinks are always unsafe.
894 * Basically here we are concerned with symlinks whose target contains
895 * "..", because this might cause us to walk back up out of the
896 * transferred directory. We are not allowed to go back up and
899 * @param dest Target of the symlink in question.
901 * @param src Top source directory currently applicable. Basically this
902 * is the first parameter to rsync in a simple invocation, but it's
903 * modified by flist.c in slightly complex ways.
905 * @retval True if unsafe
906 * @retval False is unsafe
910 int unsafe_symlink(const char *dest, const char *src)
912 const char *name, *slash;
915 /* all absolute and null symlinks are unsafe */
916 if (!dest || !*dest || *dest == '/') return 1;
918 /* find out what our safety margin is */
919 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
920 if (strncmp(name, "../", 3) == 0) {
922 } else if (strncmp(name, "./", 2) == 0) {
928 if (strcmp(name, "..") == 0)
931 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
932 if (strncmp(name, "../", 3) == 0) {
933 /* if at any point we go outside the current directory
934 then stop - it is unsafe */
937 } else if (strncmp(name, "./", 2) == 0) {
943 if (strcmp(name, "..") == 0)
951 * Return the date and time as a string
953 char *timestring(time_t t)
955 static char TimeBuf[200];
956 struct tm *tm = localtime(&t);
959 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
961 strlcpy(TimeBuf, asctime(tm), sizeof(TimeBuf));
964 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
965 TimeBuf[strlen(TimeBuf)-1] = 0;
973 * Sleep for a specified number of milliseconds.
975 * Always returns TRUE. (In the future it might return FALSE if
981 struct timeval tval,t1,t2;
983 gettimeofday(&t1, NULL);
984 gettimeofday(&t2, NULL);
987 tval.tv_sec = (t-tdiff)/1000;
988 tval.tv_usec = 1000*((t-tdiff)%1000);
991 select(0,NULL,NULL, NULL, &tval);
993 gettimeofday(&t2, NULL);
994 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
995 (t2.tv_usec - t1.tv_usec)/1000;
1003 * Determine if two file modification times are equivalent (either
1004 * exact or in the modification timestamp window established by
1007 * @retval 0 if the times should be treated as the same
1009 * @retval +1 if the first is later
1011 * @retval -1 if the 2nd is later
1013 int cmp_modtime(time_t file1, time_t file2)
1015 extern int modify_window;
1017 if (file2 > file1) {
1018 if (file2 - file1 <= modify_window) return 0;
1021 if (file1 - file2 <= modify_window) return 0;
1030 This routine is a trick to immediately catch errors when debugging
1031 with insure. A xterm with a gdb is popped up when insure catches
1032 a error. It is Linux specific.
1034 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1040 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'",
1041 getpid(), getpid(), getpid());
1045 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1046 fn = dlsym(h, "_Insure_trap_error");
1049 ret = fn(a1, a2, a3, a4, a5, a6);
1060 #define MALLOC_MAX 0x40000000
1062 void *_new_array(unsigned int size, unsigned long num)
1064 if (num >= MALLOC_MAX/size)
1066 return malloc(size * num);
1069 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1071 if (num >= MALLOC_MAX/size)
1073 /* No realloc should need this, but just in case... */
1075 return malloc(size * num);
1076 return realloc(ptr, size * num);