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