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