util.c

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