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