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