util.c

   1 /*
   2  * Utility routines used in rsync.
   3  *
   4  * Copyright (C) 1996-2000 Andrew Tridgell
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
   7  * Copyright (C) 2003-2014 Wayne Davison
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, visit the http://fsf.org website.
  21  */
  22
  23 #include "rsync.h"
  24 #include "ifuncs.h"
  25 #include "itypes.h"
  26 #include "inums.h"
  27
  28 extern int dry_run;
  29 extern int module_id;
  30 extern int protect_args;
  31 extern int modify_window;
  32 extern int relative_paths;
  33 extern int preserve_times;
  34 extern int preserve_xattrs;
  35 extern int preallocate_files;
  36 extern char *module_dir;
  37 extern unsigned int module_dirlen;
  38 extern char *partial_dir;
  39 extern filter_rule_list daemon_filter_list;
  40
  41 int sanitize_paths = 0;
  42
  43 char curr_dir[MAXPATHLEN];
  44 unsigned int curr_dir_len;
  45 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
  46
  47 /* Set a fd into nonblocking mode. */
  48 void set_nonblocking(int fd)
  49 {
  50         int val;
  51
  52         if ((val = fcntl(fd, F_GETFL)) == -1)
  53                 return;
  54         if (!(val & NONBLOCK_FLAG)) {
  55                 val |= NONBLOCK_FLAG;
  56                 fcntl(fd, F_SETFL, val);
  57         }
  58 }
  59
  60 /* Set a fd into blocking mode. */
  61 void set_blocking(int fd)
  62 {
  63         int val;
  64
  65         if ((val = fcntl(fd, F_GETFL)) == -1)
  66                 return;
  67         if (val & NONBLOCK_FLAG) {
  68                 val &= ~NONBLOCK_FLAG;
  69                 fcntl(fd, F_SETFL, val);
  70         }
  71 }
  72
  73 /**
  74  * Create a file descriptor pair - like pipe() but use socketpair if
  75  * possible (because of blocking issues on pipes).
  76  *
  77  * Always set non-blocking.
  78  */
  79 int fd_pair(int fd[2])
  80 {
  81         int ret;
  82
  83 #ifdef HAVE_SOCKETPAIR
  84         ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
  85 #else
  86         ret = pipe(fd);
  87 #endif
  88
  89         if (ret == 0) {
  90                 set_nonblocking(fd[0]);
  91                 set_nonblocking(fd[1]);
  92         }
  93
  94         return ret;
  95 }
  96
  97 void print_child_argv(const char *prefix, char **cmd)
  98 {
  99         int cnt = 0;
 100         rprintf(FCLIENT, "%s ", prefix);
 101         for (; *cmd; cmd++) {
 102                 /* Look for characters that ought to be quoted.  This
 103                 * is not a great quoting algorithm, but it's
 104                 * sufficient for a log message. */
 105                 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
 106                            "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 107                            "0123456789"
 108                            ",.-_=+@/") != strlen(*cmd)) {
 109                         rprintf(FCLIENT, "\"%s\" ", *cmd);
 110                 } else {
 111                         rprintf(FCLIENT, "%s ", *cmd);
 112                 }
 113                 cnt++;
 114         }
 115         rprintf(FCLIENT, " (%d args)\n", cnt);
 116 }
 117
 118 /* This returns 0 for success, 1 for a symlink if symlink time-setting
 119  * is not possible, or -1 for any other error. */
 120 int set_modtime(const char *fname, time_t modtime, uint32 mod_nsec, mode_t mode)
 121 {
 122         static int switch_step = 0;
 123
 124         if (DEBUG_GTE(TIME, 1)) {
 125                 rprintf(FINFO, "set modtime of %s to (%ld) %s",
 126                         fname, (long)modtime,
 127                         asctime(localtime(&modtime)));
 128         }
 129
 130         switch (switch_step) {
 131 #ifdef HAVE_UTIMENSAT
 132 #include "case_N.h"
 133                 if (do_utimensat(fname, modtime, mod_nsec) == 0)
 134                         break;
 135                 if (errno != ENOSYS)
 136                         return -1;
 137                 switch_step++;
 138                 /* FALLTHROUGH */
 139 #endif
 140
 141 #ifdef HAVE_LUTIMES
 142 #include "case_N.h"
 143                 if (do_lutimes(fname, modtime, mod_nsec) == 0)
 144                         break;
 145                 if (errno != ENOSYS)
 146                         return -1;
 147                 switch_step++;
 148                 /* FALLTHROUGH */
 149 #endif
 150
 151 #include "case_N.h"
 152                 switch_step++;
 153                 if (preserve_times & PRESERVE_LINK_TIMES) {
 154                         preserve_times &= ~PRESERVE_LINK_TIMES;
 155                         if (S_ISLNK(mode))
 156                                 return 1;
 157                 }
 158                 /* FALLTHROUGH */
 159
 160 #include "case_N.h"
 161 #ifdef HAVE_UTIMES
 162                 if (do_utimes(fname, modtime, mod_nsec) == 0)
 163                         break;
 164 #else
 165                 if (do_utime(fname, modtime, mod_nsec) == 0)
 166                         break;
 167 #endif
 168
 169                 return -1;
 170         }
 171
 172         return 0;
 173 }
 174
 175 /* Create any necessary directories in fname.  Any missing directories are
 176  * created with default permissions.  Returns < 0 on error, or the number
 177  * of directories created. */
 178 int make_path(char *fname, int flags)
 179 {
 180         char *end, *p;
 181         int ret = 0;
 182
 183         if (flags & MKP_SKIP_SLASH) {
 184                 while (*fname == '/')
 185                         fname++;
 186         }
 187
 188         while (*fname == '.' && fname[1] == '/')
 189                 fname += 2;
 190
 191         if (flags & MKP_DROP_NAME) {
 192                 end = strrchr(fname, '/');
 193                 if (!end)
 194                         return 0;
 195                 *end = '\0';
 196         } else
 197                 end = fname + strlen(fname);
 198
 199         /* Try to find an existing dir, starting from the deepest dir. */
 200         for (p = end; ; ) {
 201                 if (dry_run) {
 202                         STRUCT_STAT st;
 203                         if (do_stat(fname, &st) == 0) {
 204                                 if (S_ISDIR(st.st_mode))
 205                                         errno = EEXIST;
 206                                 else
 207                                         errno = ENOTDIR;
 208                         }
 209                 } else if (do_mkdir(fname, ACCESSPERMS) == 0) {
 210                         ret++;
 211                         break;
 212                 }
 213                 if (errno != ENOENT) {
 214                         if (errno != EEXIST)
 215                                 ret = -ret - 1;
 216                         break;
 217                 }
 218                 while (1) {
 219                         if (p == fname) {
 220                                 /* We got a relative path that doesn't exist, so assume that '.'
 221                                  * is there and just break out and create the whole thing. */
 222                                 p = NULL;
 223                                 goto double_break;
 224                         }
 225                         if (*--p == '/') {
 226                                 if (p == fname) {
 227                                         /* We reached the "/" dir, which we assume is there. */
 228                                         goto double_break;
 229                                 }
 230                                 *p = '\0';
 231                                 break;
 232                         }
 233                 }
 234         }
 235   double_break:
 236
 237         /* Make all the dirs that we didn't find on the way here. */
 238         while (p != end) {
 239                 if (p)
 240                         *p = '/';
 241                 else
 242                         p = fname;
 243                 p += strlen(p);
 244                 if (ret < 0) /* Skip mkdir on error, but keep restoring the path. */
 245                         continue;
 246                 if (do_mkdir(fname, ACCESSPERMS) < 0)
 247                         ret = -ret - 1;
 248                 else
 249                         ret++;
 250         }
 251
 252         if (flags & MKP_DROP_NAME)
 253                 *end = '/';
 254
 255         return ret;
 256 }
 257
 258 /**
 259  * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
 260  * interrupted.
 261  *
 262  * @retval len upon success
 263  *
 264  * @retval <0 write's (negative) error code
 265  *
 266  * Derived from GNU C's cccp.c.
 267  */
 268 int full_write(int desc, const char *ptr, size_t len)
 269 {
 270         int total_written;
 271
 272         total_written = 0;
 273         while (len > 0) {
 274                 int written = write(desc, ptr, len);
 275                 if (written < 0)  {
 276                         if (errno == EINTR)
 277                                 continue;
 278                         return written;
 279                 }
 280                 total_written += written;
 281                 ptr += written;
 282                 len -= written;
 283         }
 284         return total_written;
 285 }
 286
 287 /**
 288  * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
 289  * interrupted.
 290  *
 291  * @retval >0 the actual number of bytes read
 292  *
 293  * @retval 0 for EOF
 294  *
 295  * @retval <0 for an error.
 296  *
 297  * Derived from GNU C's cccp.c. */
 298 static int safe_read(int desc, char *ptr, size_t len)
 299 {
 300         int n_chars;
 301
 302         if (len == 0)
 303                 return len;
 304
 305         do {
 306                 n_chars = read(desc, ptr, len);
 307         } while (n_chars < 0 && errno == EINTR);
 308
 309         return n_chars;
 310 }
 311
 312 /* Copy a file.  If ofd < 0, copy_file unlinks and opens the "dest" file.
 313  * Otherwise, it just writes to and closes the provided file descriptor.
 314  * In either case, if --xattrs are being preserved, the dest file will
 315  * have its xattrs set from the source file.
 316  *
 317  * This is used in conjunction with the --temp-dir, --backup, and
 318  * --copy-dest options. */
 319 int copy_file(const char *source, const char *dest, int ofd, mode_t mode)
 320 {
 321         int ifd;
 322         char buf[1024 * 8];
 323         int len;   /* Number of bytes read into `buf'. */
 324 #ifdef PREALLOCATE_NEEDS_TRUNCATE
 325         OFF_T preallocated_len = 0, offset = 0;
 326 #endif
 327
 328         if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
 329                 int save_errno = errno;
 330                 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
 331                 errno = save_errno;
 332                 return -1;
 333         }
 334
 335         if (ofd < 0) {
 336                 if (robust_unlink(dest) && errno != ENOENT) {
 337                         int save_errno = errno;
 338                         rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
 339                         errno = save_errno;
 340                         return -1;
 341                 }
 342
 343 #ifdef SUPPORT_XATTRS
 344                 if (preserve_xattrs)
 345                         mode |= S_IWUSR;
 346 #endif
 347                 mode &= INITACCESSPERMS;
 348                 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0) {
 349                         int save_errno = errno;
 350                         rsyserr(FERROR_XFER, save_errno, "open %s", full_fname(dest));
 351                         close(ifd);
 352                         errno = save_errno;
 353                         return -1;
 354                 }
 355         }
 356
 357 #ifdef SUPPORT_PREALLOCATION
 358         if (preallocate_files) {
 359                 STRUCT_STAT srcst;
 360
 361                 /* Try to preallocate enough space for file's eventual length.  Can
 362                  * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
 363                 if (do_fstat(ifd, &srcst) < 0)
 364                         rsyserr(FWARNING, errno, "fstat %s", full_fname(source));
 365                 else if (srcst.st_size > 0) {
 366                         if (do_fallocate(ofd, 0, srcst.st_size) == 0) {
 367 #ifdef PREALLOCATE_NEEDS_TRUNCATE
 368                                 preallocated_len = srcst.st_size;
 369 #endif
 370                         } else
 371                                 rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
 372                 }
 373         }
 374 #endif
 375
 376         while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
 377                 if (full_write(ofd, buf, len) < 0) {
 378                         int save_errno = errno;
 379                         rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
 380                         close(ifd);
 381                         close(ofd);
 382                         errno = save_errno;
 383                         return -1;
 384                 }
 385 #ifdef PREALLOCATE_NEEDS_TRUNCATE
 386                 offset += len;
 387 #endif
 388         }
 389
 390         if (len < 0) {
 391                 int save_errno = errno;
 392                 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
 393                 close(ifd);
 394                 close(ofd);
 395                 errno = save_errno;
 396                 return -1;
 397         }
 398
 399         if (close(ifd) < 0) {
 400                 rsyserr(FWARNING, errno, "close failed on %s",
 401                         full_fname(source));
 402         }
 403
 404 #ifdef PREALLOCATE_NEEDS_TRUNCATE
 405         /* Source file might have shrunk since we fstatted it.
 406          * Cut off any extra preallocated zeros from dest file. */
 407         if (offset < preallocated_len && do_ftruncate(ofd, offset) < 0) {
 408                 /* If we fail to truncate, the dest file may be wrong, so we
 409                  * must trigger the "partial transfer" error. */
 410                 rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
 411         }
 412 #endif
 413
 414         if (close(ofd) < 0) {
 415                 int save_errno = errno;
 416                 rsyserr(FERROR_XFER, errno, "close failed on %s",
 417                         full_fname(dest));
 418                 errno = save_errno;
 419                 return -1;
 420         }
 421
 422 #ifdef SUPPORT_XATTRS
 423         if (preserve_xattrs)
 424                 copy_xattrs(source, dest);
 425 #endif
 426
 427         return 0;
 428 }
 429
 430 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
 431 #define MAX_RENAMES_DIGITS 3
 432 #define MAX_RENAMES 1000
 433
 434 /**
 435  * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
 436  * rename to <path>/.rsyncNNN instead.
 437  *
 438  * Note that successive rsync runs will shuffle the filenames around a
 439  * bit as long as the file is still busy; this is because this function
 440  * does not know if the unlink call is due to a new file coming in, or
 441  * --delete trying to remove old .rsyncNNN files, hence it renames it
 442  * each time.
 443  **/
 444 int robust_unlink(const char *fname)
 445 {
 446 #ifndef ETXTBSY
 447         return do_unlink(fname);
 448 #else
 449         static int counter = 1;
 450         int rc, pos, start;
 451         char path[MAXPATHLEN];
 452
 453         rc = do_unlink(fname);
 454         if (rc == 0 || errno != ETXTBSY)
 455                 return rc;
 456
 457         if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
 458                 pos = MAXPATHLEN - 1;
 459
 460         while (pos > 0 && path[pos-1] != '/')
 461                 pos--;
 462         pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
 463
 464         if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
 465                 errno = ETXTBSY;
 466                 return -1;
 467         }
 468
 469         /* start where the last one left off to reduce chance of clashes */
 470         start = counter;
 471         do {
 472                 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
 473                 if (++counter >= MAX_RENAMES)
 474                         counter = 1;
 475         } while ((rc = access(path, 0)) == 0 && counter != start);
 476
 477         if (INFO_GTE(MISC, 1)) {
 478                 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
 479                         fname, path);
 480         }
 481
 482         /* maybe we should return rename()'s exit status? Nah. */
 483         if (do_rename(fname, path) != 0) {
 484                 errno = ETXTBSY;
 485                 return -1;
 486         }
 487         return 0;
 488 #endif
 489 }
 490
 491 /* Returns 0 on successful rename, 1 if we successfully copied the file
 492  * across filesystems, -2 if copy_file() failed, and -1 on other errors.
 493  * If partialptr is not NULL and we need to do a copy, copy the file into
 494  * the active partial-dir instead of over the destination file. */
 495 int robust_rename(const char *from, const char *to, const char *partialptr,
 496                   int mode)
 497 {
 498         int tries = 4;
 499
 500         while (tries--) {
 501                 if (do_rename(from, to) == 0)
 502                         return 0;
 503
 504                 switch (errno) {
 505 #ifdef ETXTBSY
 506                 case ETXTBSY:
 507                         if (robust_unlink(to) != 0) {
 508                                 errno = ETXTBSY;
 509                                 return -1;
 510                         }
 511                         errno = ETXTBSY;
 512                         break;
 513 #endif
 514                 case EXDEV:
 515                         if (partialptr) {
 516                                 if (!handle_partial_dir(partialptr,PDIR_CREATE))
 517                                         return -2;
 518                                 to = partialptr;
 519                         }
 520                         if (copy_file(from, to, -1, mode) != 0)
 521                                 return -2;
 522                         do_unlink(from);
 523                         return 1;
 524                 default:
 525                         return -1;
 526                 }
 527         }
 528         return -1;
 529 }
 530
 531 static pid_t all_pids[10];
 532 static int num_pids;
 533
 534 /** Fork and record the pid of the child. **/
 535 pid_t do_fork(void)
 536 {
 537         pid_t newpid = fork();
 538
 539         if (newpid != 0  &&  newpid != -1) {
 540                 all_pids[num_pids++] = newpid;
 541         }
 542         return newpid;
 543 }
 544
 545 /**
 546  * Kill all children.
 547  *
 548  * @todo It would be kind of nice to make sure that they are actually
 549  * all our children before we kill them, because their pids may have
 550  * been recycled by some other process.  Perhaps when we wait for a
 551  * child, we should remove it from this array.  Alternatively we could
 552  * perhaps use process groups, but I think that would not work on
 553  * ancient Unix versions that don't support them.
 554  **/
 555 void kill_all(int sig)
 556 {
 557         int i;
 558
 559         for (i = 0; i < num_pids; i++) {
 560                 /* Let's just be a little careful where we
 561                  * point that gun, hey?  See kill(2) for the
 562                  * magic caused by negative values. */
 563                 pid_t p = all_pids[i];
 564
 565                 if (p == getpid())
 566                         continue;
 567                 if (p <= 0)
 568                         continue;
 569
 570                 kill(p, sig);
 571         }
 572 }
 573
 574 /** Lock a byte range in a open file */
 575 int lock_range(int fd, int offset, int len)
 576 {
 577         struct flock lock;
 578
 579         lock.l_type = F_WRLCK;
 580         lock.l_whence = SEEK_SET;
 581         lock.l_start = offset;
 582         lock.l_len = len;
 583         lock.l_pid = 0;
 584
 585         return fcntl(fd,F_SETLK,&lock) == 0;
 586 }
 587
 588 #define ENSURE_MEMSPACE(buf, type, sz, req) \
 589         if ((req) > sz && !(buf = realloc_array(buf, type, sz = MAX(sz * 2, req)))) \
 590                 out_of_memory("glob_expand")
 591
 592 static inline void call_glob_match(const char *name, int len, int from_glob,
 593                                    char *arg, int abpos, int fbpos);
 594
 595 static struct glob_data {
 596         char *arg_buf, *filt_buf, **argv;
 597         int absize, fbsize, maxargs, argc;
 598 } glob;
 599
 600 static void glob_match(char *arg, int abpos, int fbpos)
 601 {
 602         int len;
 603         char *slash;
 604
 605         while (*arg == '.' && arg[1] == '/') {
 606                 if (fbpos < 0) {
 607                         ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
 608                         memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
 609                         fbpos = abpos;
 610                 }
 611                 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
 612                 glob.arg_buf[abpos++] = *arg++;
 613                 glob.arg_buf[abpos++] = *arg++;
 614                 glob.arg_buf[abpos] = '\0';
 615         }
 616         if ((slash = strchr(arg, '/')) != NULL) {
 617                 *slash = '\0';
 618                 len = slash - arg;
 619         } else
 620                 len = strlen(arg);
 621         if (strpbrk(arg, "*?[")) {
 622                 struct dirent *di;
 623                 DIR *d;
 624
 625                 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
 626                         return;
 627                 while ((di = readdir(d)) != NULL) {
 628                         char *dname = d_name(di);
 629                         if (dname[0] == '.' && (dname[1] == '\0'
 630                           || (dname[1] == '.' && dname[2] == '\0')))
 631                                 continue;
 632                         if (!wildmatch(arg, dname))
 633                                 continue;
 634                         call_glob_match(dname, strlen(dname), 1,
 635                                         slash ? arg + len + 1 : NULL,
 636                                         abpos, fbpos);
 637                 }
 638                 closedir(d);
 639         } else {
 640                 call_glob_match(arg, len, 0,
 641                                 slash ? arg + len + 1 : NULL,
 642                                 abpos, fbpos);
 643         }
 644         if (slash)
 645                 *slash = '/';
 646 }
 647
 648 static inline void call_glob_match(const char *name, int len, int from_glob,
 649                                    char *arg, int abpos, int fbpos)
 650 {
 651         char *use_buf;
 652
 653         ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
 654         memcpy(glob.arg_buf + abpos, name, len);
 655         abpos += len;
 656         glob.arg_buf[abpos] = '\0';
 657
 658         if (fbpos >= 0) {
 659                 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
 660                 memcpy(glob.filt_buf + fbpos, name, len);
 661                 fbpos += len;
 662                 glob.filt_buf[fbpos] = '\0';
 663                 use_buf = glob.filt_buf;
 664         } else
 665                 use_buf = glob.arg_buf;
 666
 667         if (from_glob || (arg && len)) {
 668                 STRUCT_STAT st;
 669                 int is_dir;
 670
 671                 if (do_stat(glob.arg_buf, &st) != 0)
 672                         return;
 673                 is_dir = S_ISDIR(st.st_mode) != 0;
 674                 if (arg && !is_dir)
 675                         return;
 676
 677                 if (daemon_filter_list.head
 678                  && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
 679                         return;
 680         }
 681
 682         if (arg) {
 683                 glob.arg_buf[abpos++] = '/';
 684                 glob.arg_buf[abpos] = '\0';
 685                 if (fbpos >= 0) {
 686                         glob.filt_buf[fbpos++] = '/';
 687                         glob.filt_buf[fbpos] = '\0';
 688                 }
 689                 glob_match(arg, abpos, fbpos);
 690         } else {
 691                 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
 692                 if (!(glob.argv[glob.argc++] = strdup(glob.arg_buf)))
 693                         out_of_memory("glob_match");
 694         }
 695 }
 696
 697 /* This routine performs wild-card expansion of the pathname in "arg".  Any
 698  * daemon-excluded files/dirs will not be matched by the wildcards.  Returns 0
 699  * if a wild-card string is the only returned item (due to matching nothing). */
 700 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
 701 {
 702         int ret, save_argc;
 703         char *s;
 704
 705         if (!arg) {
 706                 if (glob.filt_buf)
 707                         free(glob.filt_buf);
 708                 free(glob.arg_buf);
 709                 memset(&glob, 0, sizeof glob);
 710                 return -1;
 711         }
 712
 713         if (sanitize_paths)
 714                 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
 715         else {
 716                 s = strdup(arg);
 717                 if (!s)
 718                         out_of_memory("glob_expand");
 719                 clean_fname(s, CFN_KEEP_DOT_DIRS
 720                              | CFN_KEEP_TRAILING_SLASH
 721                              | CFN_COLLAPSE_DOT_DOT_DIRS);
 722         }
 723
 724         ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
 725         *glob.arg_buf = '\0';
 726
 727         glob.argc = save_argc = *argc_p;
 728         glob.argv = *argv_p;
 729         glob.maxargs = *maxargs_p;
 730
 731         ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
 732
 733         glob_match(s, 0, -1);
 734
 735         /* The arg didn't match anything, so add the failed arg to the list. */
 736         if (glob.argc == save_argc) {
 737                 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
 738                 glob.argv[glob.argc++] = s;
 739                 ret = 0;
 740         } else {
 741                 free(s);
 742                 ret = 1;
 743         }
 744
 745         *maxargs_p = glob.maxargs;
 746         *argv_p = glob.argv;
 747         *argc_p = glob.argc;
 748
 749         return ret;
 750 }
 751
 752 /* This routine is only used in daemon mode. */
 753 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
 754 {
 755         char *p, *s;
 756         char *base = base1;
 757         int base_len = strlen(base);
 758
 759         if (!arg || !*arg)
 760                 return;
 761
 762         if (strncmp(arg, base, base_len) == 0)
 763                 arg += base_len;
 764
 765         if (protect_args) {
 766                 glob_expand(arg, argv_p, argc_p, maxargs_p);
 767                 return;
 768         }
 769
 770         if (!(arg = strdup(arg)))
 771                 out_of_memory("glob_expand_module");
 772
 773         if (asprintf(&base," %s/", base1) < 0)
 774                 out_of_memory("glob_expand_module");
 775         base_len++;
 776
 777         for (s = arg; *s; s = p + base_len) {
 778                 if ((p = strstr(s, base)) != NULL)
 779                         *p = '\0'; /* split it at this point */
 780                 glob_expand(s, argv_p, argc_p, maxargs_p);
 781                 if (!p)
 782                         break;
 783         }
 784
 785         free(arg);
 786         free(base);
 787 }
 788
 789 /**
 790  * Convert a string to lower case
 791  **/
 792 void strlower(char *s)
 793 {
 794         while (*s) {
 795                 if (isUpper(s))
 796                         *s = toLower(s);
 797                 s++;
 798         }
 799 }
 800
 801 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them.  (If
 802  * p1 ends with a '/', no extra '/' is inserted.)  Returns the length of both
 803  * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
 804  * string fits into destsize. */
 805 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
 806 {
 807         size_t len = strlcpy(dest, p1, destsize);
 808         if (len < destsize - 1) {
 809                 if (!len || dest[len-1] != '/')
 810                         dest[len++] = '/';
 811                 if (len < destsize - 1)
 812                         len += strlcpy(dest + len, p2, destsize - len);
 813                 else {
 814                         dest[len] = '\0';
 815                         len += strlen(p2);
 816                 }
 817         }
 818         else
 819                 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
 820         return len;
 821 }
 822
 823 /* Join any number of strings together, putting them in "dest".  The return
 824  * value is the length of all the strings, regardless of whether the null-
 825  * terminated whole fits in destsize.  Your list of string pointers must end
 826  * with a NULL to indicate the end of the list. */
 827 size_t stringjoin(char *dest, size_t destsize, ...)
 828 {
 829         va_list ap;
 830         size_t len, ret = 0;
 831         const char *src;
 832
 833         va_start(ap, destsize);
 834         while (1) {
 835                 if (!(src = va_arg(ap, const char *)))
 836                         break;
 837                 len = strlen(src);
 838                 ret += len;
 839                 if (destsize > 1) {
 840                         if (len >= destsize)
 841                                 len = destsize - 1;
 842                         memcpy(dest, src, len);
 843                         destsize -= len;
 844                         dest += len;
 845                 }
 846         }
 847         *dest = '\0';
 848         va_end(ap);
 849
 850         return ret;
 851 }
 852
 853 int count_dir_elements(const char *p)
 854 {
 855         int cnt = 0, new_component = 1;
 856         while (*p) {
 857                 if (*p++ == '/')
 858                         new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
 859                 else if (new_component) {
 860                         new_component = 0;
 861                         cnt++;
 862                 }
 863         }
 864         return cnt;
 865 }
 866
 867 /* Turns multiple adjacent slashes into a single slash (possible exception:
 868  * the preserving of two leading slashes at the start), drops all leading or
 869  * interior "." elements unless CFN_KEEP_DOT_DIRS is flagged.  Will also drop
 870  * a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is flagged, removes
 871  * a trailing slash (perhaps after removing the aforementioned dot) unless
 872  * CFN_KEEP_TRAILING_SLASH is flagged, and will also collapse ".." elements
 873  * (except at the start) if CFN_COLLAPSE_DOT_DOT_DIRS is flagged.  If the
 874  * resulting name would be empty, returns ".". */
 875 int clean_fname(char *name, int flags)
 876 {
 877         char *limit = name - 1, *t = name, *f = name;
 878         int anchored;
 879
 880         if (!name)
 881                 return 0;
 882
 883 #define DOT_IS_DOT_DOT_DIR(bp) (bp[1] == '.' && (bp[2] == '/' || !bp[2]))
 884
 885         if ((anchored = *f == '/') != 0) {
 886                 *t++ = *f++;
 887 #ifdef __CYGWIN__
 888                 /* If there are exactly 2 slashes at the start, preserve
 889                  * them.  Would break daemon excludes unless the paths are
 890                  * really treated differently, so used this sparingly. */
 891                 if (*f == '/' && f[1] != '/')
 892                         *t++ = *f++;
 893 #endif
 894         } else if (flags & CFN_KEEP_DOT_DIRS && *f == '.' && f[1] == '/') {
 895                 *t++ = *f++;
 896                 *t++ = *f++;
 897         } else if (flags & CFN_REFUSE_DOT_DOT_DIRS && *f == '.' && DOT_IS_DOT_DOT_DIR(f))
 898                 return -1;
 899         while (*f) {
 900                 /* discard extra slashes */
 901                 if (*f == '/') {
 902                         f++;
 903                         continue;
 904                 }
 905                 if (*f == '.') {
 906                         /* discard interior "." dirs */
 907                         if (f[1] == '/' && !(flags & CFN_KEEP_DOT_DIRS)) {
 908                                 f += 2;
 909                                 continue;
 910                         }
 911                         if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
 912                                 break;
 913                         /* collapse ".." dirs */
 914                         if (flags & (CFN_COLLAPSE_DOT_DOT_DIRS|CFN_REFUSE_DOT_DOT_DIRS) && DOT_IS_DOT_DOT_DIR(f)) {
 915                                 char *s = t - 1;
 916                                 if (flags & CFN_REFUSE_DOT_DOT_DIRS)
 917                                         return -1;
 918                                 if (s == name && anchored) {
 919                                         f += 2;
 920                                         continue;
 921                                 }
 922                                 while (s > limit && *--s != '/') {}
 923                                 if (s != t - 1 && (s < name || *s == '/')) {
 924                                         t = s + 1;
 925                                         f += 2;
 926                                         continue;
 927                                 }
 928                                 limit = t + 2;
 929                         }
 930                 }
 931                 while (*f && (*t++ = *f++) != '/') {}
 932         }
 933
 934         if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
 935                 t--;
 936         if (t == name)
 937                 *t++ = '.';
 938         *t = '\0';
 939
 940 #undef DOT_IS_DOT_DOT_DIR
 941
 942         return t - name;
 943 }
 944
 945 /* Make path appear as if a chroot had occurred.  This handles a leading
 946  * "/" (either removing it or expanding it) and any leading or embedded
 947  * ".." components that attempt to escape past the module's top dir.
 948  *
 949  * If dest is NULL, a buffer is allocated to hold the result.  It is legal
 950  * to call with the dest and the path (p) pointing to the same buffer, but
 951  * rootdir will be ignored to avoid expansion of the string.
 952  *
 953  * The rootdir string contains a value to use in place of a leading slash.
 954  * Specify NULL to get the default of "module_dir".
 955  *
 956  * The depth var is a count of how many '..'s to allow at the start of the
 957  * path.
 958  *
 959  * We also clean the path in a manner similar to clean_fname() but with a
 960  * few differences:
 961  *
 962  * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
 963  * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
 964  * ALWAYS collapses ".." elements (except for those at the start of the
 965  * string up to "depth" deep).  If the resulting name would be empty,
 966  * change it into a ".". */
 967 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth,
 968                     int flags)
 969 {
 970         char *start, *sanp;
 971         int rlen = 0, drop_dot_dirs = !relative_paths || !(flags & SP_KEEP_DOT_DIRS);
 972
 973         if (dest != p) {
 974                 int plen = strlen(p);
 975                 if (*p == '/') {
 976                         if (!rootdir)
 977                                 rootdir = module_dir;
 978                         rlen = strlen(rootdir);
 979                         depth = 0;
 980                         p++;
 981                 }
 982                 if (dest) {
 983                         if (rlen + plen + 1 >= MAXPATHLEN)
 984                                 return NULL;
 985                 } else if (!(dest = new_array(char, rlen + plen + 1)))
 986                         out_of_memory("sanitize_path");
 987                 if (rlen) {
 988                         memcpy(dest, rootdir, rlen);
 989                         if (rlen > 1)
 990                                 dest[rlen++] = '/';
 991                 }
 992         }
 993
 994         if (drop_dot_dirs) {
 995                 while (*p == '.' && p[1] == '/')
 996                         p += 2;
 997         }
 998
 999         start = sanp = dest + rlen;
1000         /* This loop iterates once per filename component in p, pointing at
1001          * the start of the name (past any prior slash) for each iteration. */
1002         while (*p) {
1003                 /* discard leading or extra slashes */
1004                 if (*p == '/') {
1005                         p++;
1006                         continue;
1007                 }
1008                 if (drop_dot_dirs) {
1009                         if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
1010                                 /* skip "." component */
1011                                 p++;
1012                                 continue;
1013                         }
1014                 }
1015                 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
1016                         /* ".." component followed by slash or end */
1017                         if (depth <= 0 || sanp != start) {
1018                                 p += 2;
1019                                 if (sanp != start) {
1020                                         /* back up sanp one level */
1021                                         --sanp; /* now pointing at slash */
1022                                         while (sanp > start && sanp[-1] != '/')
1023                                                 sanp--;
1024                                 }
1025                                 continue;
1026                         }
1027                         /* allow depth levels of .. at the beginning */
1028                         depth--;
1029                         /* move the virtual beginning to leave the .. alone */
1030                         start = sanp + 3;
1031                 }
1032                 /* copy one component through next slash */
1033                 while (*p && (*sanp++ = *p++) != '/') {}
1034         }
1035         if (sanp == dest) {
1036                 /* ended up with nothing, so put in "." component */
1037                 *sanp++ = '.';
1038         }
1039         *sanp = '\0';
1040
1041         return dest;
1042 }
1043
1044 /* Like chdir(), but it keeps track of the current directory (in the
1045  * global "curr_dir"), and ensures that the path size doesn't overflow.
1046  * Also cleans the path using the clean_fname() function. */
1047 int change_dir(const char *dir, int set_path_only)
1048 {
1049         static int initialised, skipped_chdir;
1050         unsigned int len;
1051
1052         if (!initialised) {
1053                 initialised = 1;
1054                 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1055                         rsyserr(FERROR, errno, "getcwd()");
1056                         exit_cleanup(RERR_FILESELECT);
1057                 }
1058                 curr_dir_len = strlen(curr_dir);
1059         }
1060
1061         if (!dir)       /* this call was probably just to initialize */
1062                 return 0;
1063
1064         len = strlen(dir);
1065         if (len == 1 && *dir == '.' && (!skipped_chdir || set_path_only))
1066                 return 1;
1067
1068         if (*dir == '/') {
1069                 if (len >= sizeof curr_dir) {
1070                         errno = ENAMETOOLONG;
1071                         return 0;
1072                 }
1073                 if (!set_path_only && chdir(dir))
1074                         return 0;
1075                 skipped_chdir = set_path_only;
1076                 memcpy(curr_dir, dir, len + 1);
1077         } else {
1078                 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1079                         errno = ENAMETOOLONG;
1080                         return 0;
1081                 }
1082                 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1083                         curr_dir[curr_dir_len++] = '/';
1084                 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1085
1086                 if (!set_path_only && chdir(curr_dir)) {
1087                         curr_dir[curr_dir_len] = '\0';
1088                         return 0;
1089                 }
1090                 skipped_chdir = set_path_only;
1091         }
1092
1093         curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1094         if (sanitize_paths) {
1095                 if (module_dirlen > curr_dir_len)
1096                         module_dirlen = curr_dir_len;
1097                 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1098         }
1099
1100         if (DEBUG_GTE(CHDIR, 1) && !set_path_only)
1101                 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1102
1103         return 1;
1104 }
1105
1106 /* This will make a relative path absolute and clean it up via clean_fname().
1107  * Returns the string, which might be newly allocated, or NULL on error. */
1108 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1109 {
1110         unsigned int len;
1111
1112         if (*path != '/') { /* Make path absolute. */
1113                 int len = strlen(path);
1114                 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1115                         return NULL;
1116                 curr_dir[curr_dir_len] = '/';
1117                 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1118                 if (!(path = strdup(curr_dir)))
1119                         out_of_memory("normalize_path");
1120                 curr_dir[curr_dir_len] = '\0';
1121         } else if (force_newbuf) {
1122                 if (!(path = strdup(path)))
1123                         out_of_memory("normalize_path");
1124         }
1125
1126         len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1127
1128         if (len_ptr)
1129                 *len_ptr = len;
1130
1131         return path;
1132 }
1133
1134 /**
1135  * Return a quoted string with the full pathname of the indicated filename.
1136  * The string " (in MODNAME)" may also be appended.  The returned pointer
1137  * remains valid until the next time full_fname() is called.
1138  **/
1139 char *full_fname(const char *fn)
1140 {
1141         static char *result = NULL;
1142         char *m1, *m2, *m3;
1143         char *p1, *p2;
1144
1145         if (result)
1146                 free(result);
1147
1148         if (*fn == '/')
1149                 p1 = p2 = "";
1150         else {
1151                 p1 = curr_dir + module_dirlen;
1152                 for (p2 = p1; *p2 == '/'; p2++) {}
1153                 if (*p2)
1154                         p2 = "/";
1155         }
1156         if (module_id >= 0) {
1157                 m1 = " (in ";
1158                 m2 = lp_name(module_id);
1159                 m3 = ")";
1160         } else
1161                 m1 = m2 = m3 = "";
1162
1163         if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) < 0)
1164                 out_of_memory("full_fname");
1165
1166         return result;
1167 }
1168
1169 static char partial_fname[MAXPATHLEN];
1170
1171 char *partial_dir_fname(const char *fname)
1172 {
1173         char *t = partial_fname;
1174         int sz = sizeof partial_fname;
1175         const char *fn;
1176
1177         if ((fn = strrchr(fname, '/')) != NULL) {
1178                 fn++;
1179                 if (*partial_dir != '/') {
1180                         int len = fn - fname;
1181                         strncpy(t, fname, len); /* safe */
1182                         t += len;
1183                         sz -= len;
1184                 }
1185         } else
1186                 fn = fname;
1187         if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1188                 return NULL;
1189         if (daemon_filter_list.head) {
1190                 t = strrchr(partial_fname, '/');
1191                 *t = '\0';
1192                 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1193                         return NULL;
1194                 *t = '/';
1195                 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1196                         return NULL;
1197         }
1198
1199         return partial_fname;
1200 }
1201
1202 /* If no --partial-dir option was specified, we don't need to do anything
1203  * (the partial-dir is essentially '.'), so just return success. */
1204 int handle_partial_dir(const char *fname, int create)
1205 {
1206         char *fn, *dir;
1207
1208         if (fname != partial_fname)
1209                 return 1;
1210         if (!create && *partial_dir == '/')
1211                 return 1;
1212         if (!(fn = strrchr(partial_fname, '/')))
1213                 return 1;
1214
1215         *fn = '\0';
1216         dir = partial_fname;
1217         if (create) {
1218                 STRUCT_STAT st;
1219                 int statret = do_lstat(dir, &st);
1220                 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1221                         if (do_unlink(dir) < 0) {
1222                                 *fn = '/';
1223                                 return 0;
1224                         }
1225                         statret = -1;
1226                 }
1227                 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1228                         *fn = '/';
1229                         return 0;
1230                 }
1231         } else
1232                 do_rmdir(dir);
1233         *fn = '/';
1234
1235         return 1;
1236 }
1237
1238 /* Determine if a symlink points outside the current directory tree.
1239  * This is considered "unsafe" because e.g. when mirroring somebody
1240  * else's machine it might allow them to establish a symlink to
1241  * /etc/passwd, and then read it through a web server.
1242  *
1243  * Returns 1 if unsafe, 0 if safe.
1244  *
1245  * Null symlinks and absolute symlinks are always unsafe.
1246  *
1247  * Basically here we are concerned with symlinks whose target contains
1248  * "..", because this might cause us to walk back up out of the
1249  * transferred directory.  We are not allowed to go back up and
1250  * reenter.
1251  *
1252  * "dest" is the target of the symlink in question.
1253  *
1254  * "src" is the top source directory currently applicable at the level
1255  * of the referenced symlink.  This is usually the symlink's full path
1256  * (including its name), as referenced from the root of the transfer. */
1257 int unsafe_symlink(const char *dest, const char *src)
1258 {
1259         const char *name, *slash;
1260         int depth = 0;
1261
1262         /* all absolute and null symlinks are unsafe */
1263         if (!dest || !*dest || *dest == '/')
1264                 return 1;
1265
1266         /* find out what our safety margin is */
1267         for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1268                 /* ".." segment starts the count over.  "." segment is ignored. */
1269                 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1270                         if (name[1] == '.')
1271                                 depth = 0;
1272                 } else
1273                         depth++;
1274                 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1275         }
1276         if (*name == '.' && name[1] == '.' && name[2] == '\0')
1277                 depth = 0;
1278
1279         for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1280                 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1281                         if (name[1] == '.') {
1282                                 /* if at any point we go outside the current directory
1283                                    then stop - it is unsafe */
1284                                 if (--depth < 0)
1285                                         return 1;
1286                         }
1287                 } else
1288                         depth++;
1289                 while (slash[1] == '/') slash++;
1290         }
1291         if (*name == '.' && name[1] == '.' && name[2] == '\0')
1292                 depth--;
1293
1294         return depth < 0;
1295 }
1296
1297 /* Return the date and time as a string.  Some callers tweak returned buf. */
1298 char *timestring(time_t t)
1299 {
1300         static char TimeBuf[200];
1301         struct tm *tm = localtime(&t);
1302         char *p;
1303
1304 #ifdef HAVE_STRFTIME
1305         strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1306 #else
1307         strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1308 #endif
1309
1310         if ((p = strchr(TimeBuf, '\n')) != NULL)
1311                 *p = '\0';
1312
1313         return TimeBuf;
1314 }
1315
1316 /* Determine if two time_t values are equivalent (either exact, or in
1317  * the modification timestamp window established by --modify-window).
1318  *
1319  * @retval 0 if the times should be treated as the same
1320  *
1321  * @retval +1 if the first is later
1322  *
1323  * @retval -1 if the 2nd is later
1324  **/
1325 int cmp_time(time_t file1, time_t file2)
1326 {
1327         if (file2 > file1) {
1328                 /* The final comparison makes sure that modify_window doesn't overflow a
1329                  * time_t, which would mean that file2 must be in the equality window. */
1330                 if (!modify_window || (file2 > file1 + modify_window && file1 + modify_window > file1))
1331                         return -1;
1332         } else if (file1 > file2) {
1333                 if (!modify_window || (file1 > file2 + modify_window && file2 + modify_window > file2))
1334                         return 1;
1335         }
1336         return 0;
1337 }
1338
1339 #ifdef __INSURE__XX
1340 #include <dlfcn.h>
1341
1342 /**
1343    This routine is a trick to immediately catch errors when debugging
1344    with insure. A xterm with a gdb is popped up when insure catches
1345    a error. It is Linux specific.
1346 **/
1347 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1348 {
1349         static int (*fn)();
1350         int ret, pid_int = getpid();
1351         char *cmd;
1352
1353         if (asprintf(&cmd,
1354             "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; "
1355             "gdb /proc/%d/exe %d'", pid_int, pid_int, pid_int) < 0)
1356                 return -1;
1357
1358         if (!fn) {
1359                 static void *h;
1360                 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1361                 fn = dlsym(h, "_Insure_trap_error");
1362         }
1363
1364         ret = fn(a1, a2, a3, a4, a5, a6);
1365
1366         system(cmd);
1367
1368         free(cmd);
1369
1370         return ret;
1371 }
1372 #endif
1373
1374 /* Take a filename and filename length and return the most significant
1375  * filename suffix we can find.  This ignores suffixes such as "~",
1376  * ".bak", ".orig", ".~1~", etc. */
1377 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1378 {
1379         const char *suf, *s;
1380         BOOL had_tilde;
1381         int s_len;
1382
1383         /* One or more dots at the start aren't a suffix. */
1384         while (fn_len && *fn == '.') fn++, fn_len--;
1385
1386         /* Ignore the ~ in a "foo~" filename. */
1387         if (fn_len > 1 && fn[fn_len-1] == '~')
1388                 fn_len--, had_tilde = True;
1389         else
1390                 had_tilde = False;
1391
1392         /* Assume we don't find an suffix. */
1393         suf = "";
1394         *len_ptr = 0;
1395
1396         /* Find the last significant suffix. */
1397         for (s = fn + fn_len; fn_len > 1; ) {
1398                 while (*--s != '.' && s != fn) {}
1399                 if (s == fn)
1400                         break;
1401                 s_len = fn_len - (s - fn);
1402                 fn_len = s - fn;
1403                 if (s_len == 4) {
1404                         if (strcmp(s+1, "bak") == 0
1405                          || strcmp(s+1, "old") == 0)
1406                                 continue;
1407                 } else if (s_len == 5) {
1408                         if (strcmp(s+1, "orig") == 0)
1409                                 continue;
1410                 } else if (s_len > 2 && had_tilde
1411                     && s[1] == '~' && isDigit(s + 2))
1412                         continue;
1413                 *len_ptr = s_len;
1414                 suf = s;
1415                 if (s_len == 1)
1416                         break;
1417                 /* Determine if the suffix is all digits. */
1418                 for (s++, s_len--; s_len > 0; s++, s_len--) {
1419                         if (!isDigit(s))
1420                                 return suf;
1421                 }
1422                 /* An all-digit suffix may not be that signficant. */
1423                 s = suf;
1424         }
1425
1426         return suf;
1427 }
1428
1429 /* This is an implementation of the Levenshtein distance algorithm.  It
1430  * was implemented to avoid needing a two-dimensional matrix (to save
1431  * memory).  It was also tweaked to try to factor in the ASCII distance
1432  * between changed characters as a minor distance quantity.  The normal
1433  * Levenshtein units of distance (each signifying a single change between
1434  * the two strings) are defined as a "UNIT". */
1435
1436 #define UNIT (1 << 16)
1437
1438 uint32 fuzzy_distance(const char *s1, unsigned len1, const char *s2, unsigned len2)
1439 {
1440         uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1441         int32 cost;
1442         unsigned i1, i2;
1443
1444         if (!len1 || !len2) {
1445                 if (!len1) {
1446                         s1 = s2;
1447                         len1 = len2;
1448                 }
1449                 for (i1 = 0, cost = 0; i1 < len1; i1++)
1450                         cost += s1[i1];
1451                 return (int32)len1 * UNIT + cost;
1452         }
1453
1454         for (i2 = 0; i2 < len2; i2++)
1455                 a[i2] = (i2+1) * UNIT;
1456
1457         for (i1 = 0; i1 < len1; i1++) {
1458                 diag = i1 * UNIT;
1459                 above = (i1+1) * UNIT;
1460                 for (i2 = 0; i2 < len2; i2++) {
1461                         left = a[i2];
1462                         if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1463                                 if (cost < 0)
1464                                         cost = UNIT - cost;
1465                                 else
1466                                         cost = UNIT + cost;
1467                         }
1468                         diag_inc = diag + cost;
1469                         left_inc = left + UNIT + *((uchar*)s1+i1);
1470                         above_inc = above + UNIT + *((uchar*)s2+i2);
1471                         a[i2] = above = left < above
1472                               ? (left_inc < diag_inc ? left_inc : diag_inc)
1473                               : (above_inc < diag_inc ? above_inc : diag_inc);
1474                         diag = left;
1475                 }
1476         }
1477
1478         return a[len2-1];
1479 }
1480
1481 #define BB_SLOT_SIZE     (16*1024)          /* Desired size in bytes */
1482 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1483 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1484
1485 struct bitbag {
1486     uint32 **bits;
1487     int slot_cnt;
1488 };
1489
1490 struct bitbag *bitbag_create(int max_ndx)
1491 {
1492         struct bitbag *bb = new(struct bitbag);
1493         bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1494
1495         if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1496                 out_of_memory("bitbag_create");
1497
1498         return bb;
1499 }
1500
1501 void bitbag_set_bit(struct bitbag *bb, int ndx)
1502 {
1503         int slot = ndx / BB_PER_SLOT_BITS;
1504         ndx %= BB_PER_SLOT_BITS;
1505
1506         if (!bb->bits[slot]) {
1507                 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1508                         out_of_memory("bitbag_set_bit");
1509         }
1510
1511         bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1512 }
1513
1514 #if 0 /* not needed yet */
1515 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1516 {
1517         int slot = ndx / BB_PER_SLOT_BITS;
1518         ndx %= BB_PER_SLOT_BITS;
1519
1520         if (!bb->bits[slot])
1521                 return;
1522
1523         bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1524 }
1525
1526 int bitbag_check_bit(struct bitbag *bb, int ndx)
1527 {
1528         int slot = ndx / BB_PER_SLOT_BITS;
1529         ndx %= BB_PER_SLOT_BITS;
1530
1531         if (!bb->bits[slot])
1532                 return 0;
1533
1534         return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1535 }
1536 #endif
1537
1538 /* Call this with -1 to start checking from 0.  Returns -1 at the end. */
1539 int bitbag_next_bit(struct bitbag *bb, int after)
1540 {
1541         uint32 bits, mask;
1542         int i, ndx = after + 1;
1543         int slot = ndx / BB_PER_SLOT_BITS;
1544         ndx %= BB_PER_SLOT_BITS;
1545
1546         mask = (1u << (ndx % 32)) - 1;
1547         for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1548                 if (!bb->bits[slot])
1549                         continue;
1550                 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1551                         if (!(bits = bb->bits[slot][i] & ~mask))
1552                                 continue;
1553                         /* The xor magic figures out the lowest enabled bit in
1554                          * bits, and the switch quickly computes log2(bit). */
1555                         switch (bits ^ (bits & (bits-1))) {
1556 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1557                             LOG2(0);  LOG2(1);  LOG2(2);  LOG2(3);
1558                             LOG2(4);  LOG2(5);  LOG2(6);  LOG2(7);
1559                             LOG2(8);  LOG2(9);  LOG2(10); LOG2(11);
1560                             LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1561                             LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1562                             LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1563                             LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1564                             LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1565                         }
1566                         return -1; /* impossible... */
1567                 }
1568         }
1569
1570         return -1;
1571 }
1572
1573 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1574 {
1575         struct flist_ndx_item *item;
1576
1577         if (!(item = new(struct flist_ndx_item)))
1578                 out_of_memory("flist_ndx_push");
1579         item->next = NULL;
1580         item->ndx = ndx;
1581         if (lp->tail)
1582                 lp->tail->next = item;
1583         else
1584                 lp->head = item;
1585         lp->tail = item;
1586 }
1587
1588 int flist_ndx_pop(flist_ndx_list *lp)
1589 {
1590         struct flist_ndx_item *next;
1591         int ndx;
1592
1593         if (!lp->head)
1594                 return -1;
1595
1596         ndx = lp->head->ndx;
1597         next = lp->head->next;
1598         free(lp->head);
1599         lp->head = next;
1600         if (!next)
1601                 lp->tail = NULL;
1602
1603         return ndx;
1604 }
1605
1606 void *expand_item_list(item_list *lp, size_t item_size,
1607                        const char *desc, int incr)
1608 {
1609         /* First time through, 0 <= 0, so list is expanded. */
1610         if (lp->malloced <= lp->count) {
1611                 void *new_ptr;
1612                 size_t new_size = lp->malloced;
1613                 if (incr < 0)
1614                         new_size += -incr; /* increase slowly */
1615                 else if (new_size < (size_t)incr)
1616                         new_size += incr;
1617                 else
1618                         new_size *= 2;
1619                 if (new_size < lp->malloced)
1620                         overflow_exit("expand_item_list");
1621                 /* Using _realloc_array() lets us pass the size, not a type. */
1622                 new_ptr = _realloc_array(lp->items, item_size, new_size);
1623                 if (DEBUG_GTE(FLIST, 3)) {
1624                         rprintf(FINFO, "[%s] expand %s to %s bytes, did%s move\n",
1625                                 who_am_i(), desc, big_num(new_size * item_size),
1626                                 new_ptr == lp->items ? " not" : "");
1627                 }
1628                 if (!new_ptr)
1629                         out_of_memory("expand_item_list");
1630
1631                 lp->items = new_ptr;
1632                 lp->malloced = new_size;
1633         }
1634         return (char*)lp->items + (lp->count++ * item_size);
1635 }