util.c

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