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