util1.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) {
 410 #ifdef HAVE_FTRUNCATE
 411                 /* If we fail to truncate, the dest file may be wrong, so we
 412                  * must trigger the "partial transfer" error. */
 413                 if (do_ftruncate(ofd, offset) < 0)
 414                         rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
 415 #else
 416                 rprintf(FERROR_XFER, "no ftruncate for over-long pre-alloc: %s", full_fname(dest));
 417 #endif
 418         }
 419
 420         if (close(ofd) < 0) {
 421                 int save_errno = errno;
 422                 rsyserr(FERROR_XFER, errno, "close failed on %s",
 423                         full_fname(dest));
 424                 errno = save_errno;
 425                 return -1;
 426         }
 427
 428 #ifdef SUPPORT_XATTRS
 429         if (preserve_xattrs)
 430                 copy_xattrs(source, dest);
 431 #endif
 432
 433         return 0;
 434 }
 435
 436 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
 437 #define MAX_RENAMES_DIGITS 3
 438 #define MAX_RENAMES 1000
 439
 440 /**
 441  * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
 442  * rename to <path>/.rsyncNNN instead.
 443  *
 444  * Note that successive rsync runs will shuffle the filenames around a
 445  * bit as long as the file is still busy; this is because this function
 446  * does not know if the unlink call is due to a new file coming in, or
 447  * --delete trying to remove old .rsyncNNN files, hence it renames it
 448  * each time.
 449  **/
 450 int robust_unlink(const char *fname)
 451 {
 452 #ifndef ETXTBSY
 453         return do_unlink(fname);
 454 #else
 455         static int counter = 1;
 456         int rc, pos, start;
 457         char path[MAXPATHLEN];
 458
 459         rc = do_unlink(fname);
 460         if (rc == 0 || errno != ETXTBSY)
 461                 return rc;
 462
 463         if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
 464                 pos = MAXPATHLEN - 1;
 465
 466         while (pos > 0 && path[pos-1] != '/')
 467                 pos--;
 468         pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
 469
 470         if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
 471                 errno = ETXTBSY;
 472                 return -1;
 473         }
 474
 475         /* start where the last one left off to reduce chance of clashes */
 476         start = counter;
 477         do {
 478                 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
 479                 if (++counter >= MAX_RENAMES)
 480                         counter = 1;
 481         } while ((rc = access(path, 0)) == 0 && counter != start);
 482
 483         if (INFO_GTE(MISC, 1)) {
 484                 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
 485                         fname, path);
 486         }
 487
 488         /* maybe we should return rename()'s exit status? Nah. */
 489         if (do_rename(fname, path) != 0) {
 490                 errno = ETXTBSY;
 491                 return -1;
 492         }
 493         return 0;
 494 #endif
 495 }
 496
 497 /* Returns 0 on successful rename, 1 if we successfully copied the file
 498  * across filesystems, -2 if copy_file() failed, and -1 on other errors.
 499  * If partialptr is not NULL and we need to do a copy, copy the file into
 500  * the active partial-dir instead of over the destination file. */
 501 int robust_rename(const char *from, const char *to, const char *partialptr,
 502                   int mode)
 503 {
 504         int tries = 4;
 505
 506         /* A resumed in-place partial-dir transfer might call us with from and
 507          * to pointing to the same buf if the transfer failed yet again. */
 508         if (from == to)
 509                 return 0;
 510
 511         while (tries--) {
 512                 if (do_rename(from, to) == 0)
 513                         return 0;
 514
 515                 switch (errno) {
 516 #ifdef ETXTBSY
 517                 case ETXTBSY:
 518                         if (robust_unlink(to) != 0) {
 519                                 errno = ETXTBSY;
 520                                 return -1;
 521                         }
 522                         errno = ETXTBSY;
 523                         break;
 524 #endif
 525                 case EXDEV:
 526                         if (partialptr) {
 527                                 if (!handle_partial_dir(partialptr,PDIR_CREATE))
 528                                         return -2;
 529                                 to = partialptr;
 530                         }
 531                         if (copy_file(from, to, -1, mode) != 0)
 532                                 return -2;
 533                         do_unlink(from);
 534                         return 1;
 535                 default:
 536                         return -1;
 537                 }
 538         }
 539         return -1;
 540 }
 541
 542 static pid_t all_pids[10];
 543 static int num_pids;
 544
 545 /** Fork and record the pid of the child. **/
 546 pid_t do_fork(void)
 547 {
 548         pid_t newpid = fork();
 549
 550         if (newpid != 0  &&  newpid != -1) {
 551                 all_pids[num_pids++] = newpid;
 552         }
 553         return newpid;
 554 }
 555
 556 /**
 557  * Kill all children.
 558  *
 559  * @todo It would be kind of nice to make sure that they are actually
 560  * all our children before we kill them, because their pids may have
 561  * been recycled by some other process.  Perhaps when we wait for a
 562  * child, we should remove it from this array.  Alternatively we could
 563  * perhaps use process groups, but I think that would not work on
 564  * ancient Unix versions that don't support them.
 565  **/
 566 void kill_all(int sig)
 567 {
 568         int i;
 569
 570         for (i = 0; i < num_pids; i++) {
 571                 /* Let's just be a little careful where we
 572                  * point that gun, hey?  See kill(2) for the
 573                  * magic caused by negative values. */
 574                 pid_t p = all_pids[i];
 575
 576                 if (p == getpid())
 577                         continue;
 578                 if (p <= 0)
 579                         continue;
 580
 581                 kill(p, sig);
 582         }
 583 }
 584
 585 /** Lock a byte range in a open file */
 586 int lock_range(int fd, int offset, int len)
 587 {
 588         struct flock lock;
 589
 590         lock.l_type = F_WRLCK;
 591         lock.l_whence = SEEK_SET;
 592         lock.l_start = offset;
 593         lock.l_len = len;
 594         lock.l_pid = 0;
 595
 596         return fcntl(fd,F_SETLK,&lock) == 0;
 597 }
 598
 599 #define ENSURE_MEMSPACE(buf, type, sz, req) \
 600         do { if ((req) > sz) buf = realloc_array(buf, type, sz = MAX(sz * 2, req)); } while(0)
 601
 602 static inline void call_glob_match(const char *name, int len, int from_glob,
 603                                    char *arg, int abpos, int fbpos);
 604
 605 static struct glob_data {
 606         char *arg_buf, *filt_buf, **argv;
 607         int absize, fbsize, maxargs, argc;
 608 } glob;
 609
 610 static void glob_match(char *arg, int abpos, int fbpos)
 611 {
 612         int len;
 613         char *slash;
 614
 615         while (*arg == '.' && arg[1] == '/') {
 616                 if (fbpos < 0) {
 617                         ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
 618                         memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
 619                         fbpos = abpos;
 620                 }
 621                 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
 622                 glob.arg_buf[abpos++] = *arg++;
 623                 glob.arg_buf[abpos++] = *arg++;
 624                 glob.arg_buf[abpos] = '\0';
 625         }
 626         if ((slash = strchr(arg, '/')) != NULL) {
 627                 *slash = '\0';
 628                 len = slash - arg;
 629         } else
 630                 len = strlen(arg);
 631         if (strpbrk(arg, "*?[")) {
 632                 struct dirent *di;
 633                 DIR *d;
 634
 635                 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
 636                         return;
 637                 while ((di = readdir(d)) != NULL) {
 638                         char *dname = d_name(di);
 639                         if (dname[0] == '.' && (dname[1] == '\0'
 640                           || (dname[1] == '.' && dname[2] == '\0')))
 641                                 continue;
 642                         if (!wildmatch(arg, dname))
 643                                 continue;
 644                         call_glob_match(dname, strlen(dname), 1,
 645                                         slash ? arg + len + 1 : NULL,
 646                                         abpos, fbpos);
 647                 }
 648                 closedir(d);
 649         } else {
 650                 call_glob_match(arg, len, 0,
 651                                 slash ? arg + len + 1 : NULL,
 652                                 abpos, fbpos);
 653         }
 654         if (slash)
 655                 *slash = '/';
 656 }
 657
 658 static inline void call_glob_match(const char *name, int len, int from_glob,
 659                                    char *arg, int abpos, int fbpos)
 660 {
 661         char *use_buf;
 662
 663         ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
 664         memcpy(glob.arg_buf + abpos, name, len);
 665         abpos += len;
 666         glob.arg_buf[abpos] = '\0';
 667
 668         if (fbpos >= 0) {
 669                 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
 670                 memcpy(glob.filt_buf + fbpos, name, len);
 671                 fbpos += len;
 672                 glob.filt_buf[fbpos] = '\0';
 673                 use_buf = glob.filt_buf;
 674         } else
 675                 use_buf = glob.arg_buf;
 676
 677         if (from_glob || (arg && len)) {
 678                 STRUCT_STAT st;
 679                 int is_dir;
 680
 681                 if (do_stat(glob.arg_buf, &st) != 0)
 682                         return;
 683                 is_dir = S_ISDIR(st.st_mode) != 0;
 684                 if (arg && !is_dir)
 685                         return;
 686
 687                 if (daemon_filter_list.head
 688                  && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
 689                         return;
 690         }
 691
 692         if (arg) {
 693                 glob.arg_buf[abpos++] = '/';
 694                 glob.arg_buf[abpos] = '\0';
 695                 if (fbpos >= 0) {
 696                         glob.filt_buf[fbpos++] = '/';
 697                         glob.filt_buf[fbpos] = '\0';
 698                 }
 699                 glob_match(arg, abpos, fbpos);
 700         } else {
 701                 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
 702                 glob.argv[glob.argc++] = strdup(glob.arg_buf);
 703         }
 704 }
 705
 706 /* This routine performs wild-card expansion of the pathname in "arg".  Any
 707  * daemon-excluded files/dirs will not be matched by the wildcards.  Returns 0
 708  * if a wild-card string is the only returned item (due to matching nothing). */
 709 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
 710 {
 711         int ret, save_argc;
 712         char *s;
 713
 714         if (!arg) {
 715                 if (glob.filt_buf)
 716                         free(glob.filt_buf);
 717                 free(glob.arg_buf);
 718                 memset(&glob, 0, sizeof glob);
 719                 return -1;
 720         }
 721
 722         if (sanitize_paths)
 723                 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
 724         else {
 725                 s = strdup(arg);
 726                 clean_fname(s, CFN_KEEP_DOT_DIRS | CFN_KEEP_TRAILING_SLASH | CFN_COLLAPSE_DOT_DOT_DIRS);
 727         }
 728
 729         ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
 730         *glob.arg_buf = '\0';
 731
 732         glob.argc = save_argc = *argc_p;
 733         glob.argv = *argv_p;
 734         glob.maxargs = *maxargs_p;
 735
 736         ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
 737
 738         glob_match(s, 0, -1);
 739
 740         /* The arg didn't match anything, so add the failed arg to the list. */
 741         if (glob.argc == save_argc) {
 742                 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
 743                 glob.argv[glob.argc++] = s;
 744                 ret = 0;
 745         } else {
 746                 free(s);
 747                 ret = 1;
 748         }
 749
 750         *maxargs_p = glob.maxargs;
 751         *argv_p = glob.argv;
 752         *argc_p = glob.argc;
 753
 754         return ret;
 755 }
 756
 757 /* This routine is only used in daemon mode. */
 758 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
 759 {
 760         char *p, *s;
 761         char *base = base1;
 762         int base_len = strlen(base);
 763
 764         if (!arg || !*arg)
 765                 return;
 766
 767         if (strncmp(arg, base, base_len) == 0)
 768                 arg += base_len;
 769
 770         if (protect_args) {
 771                 glob_expand(arg, argv_p, argc_p, maxargs_p);
 772                 return;
 773         }
 774
 775         arg = strdup(arg);
 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                         dest = new_array(char, MAX(rlen + plen + 1, 2));
1022                 else if (rlen + plen + 1 >= MAXPATHLEN)
1023                         return NULL;
1024                 if (rlen) { /* only true if p previously started with a slash */
1025                         memcpy(dest, rootdir, rlen);
1026                         if (rlen > 1) /* a rootdir of len 1 is "/", so this avoids a 2nd slash */
1027                                 dest[rlen++] = '/';
1028                 }
1029         }
1030
1031         if (drop_dot_dirs) {
1032                 while (*p == '.' && p[1] == '/')
1033                         p += 2;
1034         }
1035
1036         start = sanp = dest + rlen;
1037         /* This loop iterates once per filename component in p, pointing at
1038          * the start of the name (past any prior slash) for each iteration. */
1039         while (*p) {
1040                 /* discard leading or extra slashes */
1041                 if (*p == '/') {
1042                         p++;
1043                         continue;
1044                 }
1045                 if (drop_dot_dirs) {
1046                         if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
1047                                 /* skip "." component */
1048                                 p++;
1049                                 continue;
1050                         }
1051                 }
1052                 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
1053                         /* ".." component followed by slash or end */
1054                         if (depth <= 0 || sanp != start) {
1055                                 p += 2;
1056                                 if (sanp != start) {
1057                                         /* back up sanp one level */
1058                                         --sanp; /* now pointing at slash */
1059                                         while (sanp > start && sanp[-1] != '/')
1060                                                 sanp--;
1061                                 }
1062                                 continue;
1063                         }
1064                         /* allow depth levels of .. at the beginning */
1065                         depth--;
1066                         /* move the virtual beginning to leave the .. alone */
1067                         start = sanp + 3;
1068                 }
1069                 /* copy one component through next slash */
1070                 while (*p && (*sanp++ = *p++) != '/') {}
1071         }
1072         if (sanp == dest) {
1073                 /* ended up with nothing, so put in "." component */
1074                 *sanp++ = '.';
1075         }
1076         *sanp = '\0';
1077
1078         return dest;
1079 }
1080
1081 /* Like chdir(), but it keeps track of the current directory (in the
1082  * global "curr_dir"), and ensures that the path size doesn't overflow.
1083  * Also cleans the path using the clean_fname() function. */
1084 int change_dir(const char *dir, int set_path_only)
1085 {
1086         static int initialised, skipped_chdir;
1087         unsigned int len;
1088
1089         if (!initialised) {
1090                 initialised = 1;
1091                 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1092                         rsyserr(FERROR, errno, "getcwd()");
1093                         exit_cleanup(RERR_FILESELECT);
1094                 }
1095                 curr_dir_len = strlen(curr_dir);
1096         }
1097
1098         if (!dir)       /* this call was probably just to initialize */
1099                 return 0;
1100
1101         len = strlen(dir);
1102         if (len == 1 && *dir == '.' && (!skipped_chdir || set_path_only))
1103                 return 1;
1104
1105         if (*dir == '/') {
1106                 if (len >= sizeof curr_dir) {
1107                         errno = ENAMETOOLONG;
1108                         return 0;
1109                 }
1110                 if (!set_path_only && chdir(dir))
1111                         return 0;
1112                 skipped_chdir = set_path_only;
1113                 memcpy(curr_dir, dir, len + 1);
1114         } else {
1115                 unsigned int save_dir_len = curr_dir_len;
1116                 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1117                         errno = ENAMETOOLONG;
1118                         return 0;
1119                 }
1120                 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1121                         curr_dir[curr_dir_len++] = '/';
1122                 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1123
1124                 if (!set_path_only && chdir(curr_dir)) {
1125                         curr_dir_len = save_dir_len;
1126                         curr_dir[curr_dir_len] = '\0';
1127                         return 0;
1128                 }
1129                 skipped_chdir = set_path_only;
1130         }
1131
1132         curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1133         if (sanitize_paths) {
1134                 if (module_dirlen > curr_dir_len)
1135                         module_dirlen = curr_dir_len;
1136                 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1137         }
1138
1139         if (DEBUG_GTE(CHDIR, 1) && !set_path_only)
1140                 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1141
1142         return 1;
1143 }
1144
1145 /* This will make a relative path absolute and clean it up via clean_fname().
1146  * Returns the string, which might be newly allocated, or NULL on error. */
1147 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1148 {
1149         unsigned int len;
1150
1151         if (*path != '/') { /* Make path absolute. */
1152                 int len = strlen(path);
1153                 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1154                         return NULL;
1155                 curr_dir[curr_dir_len] = '/';
1156                 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1157                 path = strdup(curr_dir);
1158                 curr_dir[curr_dir_len] = '\0';
1159         } else if (force_newbuf)
1160                 path = strdup(path);
1161
1162         len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1163
1164         if (len_ptr)
1165                 *len_ptr = len;
1166
1167         return path;
1168 }
1169
1170 /**
1171  * Return a quoted string with the full pathname of the indicated filename.
1172  * The string " (in MODNAME)" may also be appended.  The returned pointer
1173  * remains valid until the next time full_fname() is called.
1174  **/
1175 char *full_fname(const char *fn)
1176 {
1177         static char *result = NULL;
1178         char *m1, *m2, *m3;
1179         char *p1, *p2;
1180
1181         if (result)
1182                 free(result);
1183
1184         if (*fn == '/')
1185                 p1 = p2 = "";
1186         else {
1187                 p1 = curr_dir + module_dirlen;
1188                 for (p2 = p1; *p2 == '/'; p2++) {}
1189                 if (*p2)
1190                         p2 = "/";
1191         }
1192         if (module_id >= 0) {
1193                 m1 = " (in ";
1194                 m2 = lp_name(module_id);
1195                 m3 = ")";
1196         } else
1197                 m1 = m2 = m3 = "";
1198
1199         if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) < 0)
1200                 out_of_memory("full_fname");
1201
1202         return result;
1203 }
1204
1205 static char partial_fname[MAXPATHLEN];
1206
1207 char *partial_dir_fname(const char *fname)
1208 {
1209         char *t = partial_fname;
1210         int sz = sizeof partial_fname;
1211         const char *fn;
1212
1213         if ((fn = strrchr(fname, '/')) != NULL) {
1214                 fn++;
1215                 if (*partial_dir != '/') {
1216                         int len = fn - fname;
1217                         strncpy(t, fname, len); /* safe */
1218                         t += len;
1219                         sz -= len;
1220                 }
1221         } else
1222                 fn = fname;
1223         if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1224                 return NULL;
1225         if (daemon_filter_list.head) {
1226                 t = strrchr(partial_fname, '/');
1227                 *t = '\0';
1228                 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1229                         return NULL;
1230                 *t = '/';
1231                 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1232                         return NULL;
1233         }
1234
1235         return partial_fname;
1236 }
1237
1238 /* If no --partial-dir option was specified, we don't need to do anything
1239  * (the partial-dir is essentially '.'), so just return success. */
1240 int handle_partial_dir(const char *fname, int create)
1241 {
1242         char *fn, *dir;
1243
1244         if (fname != partial_fname)
1245                 return 1;
1246         if (!create && *partial_dir == '/')
1247                 return 1;
1248         if (!(fn = strrchr(partial_fname, '/')))
1249                 return 1;
1250
1251         *fn = '\0';
1252         dir = partial_fname;
1253         if (create) {
1254                 STRUCT_STAT st;
1255                 int statret = do_lstat(dir, &st);
1256                 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1257                         if (do_unlink(dir) < 0) {
1258                                 *fn = '/';
1259                                 return 0;
1260                         }
1261                         statret = -1;
1262                 }
1263                 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1264                         *fn = '/';
1265                         return 0;
1266                 }
1267         } else
1268                 do_rmdir(dir);
1269         *fn = '/';
1270
1271         return 1;
1272 }
1273
1274 /* Determine if a symlink points outside the current directory tree.
1275  * This is considered "unsafe" because e.g. when mirroring somebody
1276  * else's machine it might allow them to establish a symlink to
1277  * /etc/passwd, and then read it through a web server.
1278  *
1279  * Returns 1 if unsafe, 0 if safe.
1280  *
1281  * Null symlinks and absolute symlinks are always unsafe.
1282  *
1283  * Basically here we are concerned with symlinks whose target contains
1284  * "..", because this might cause us to walk back up out of the
1285  * transferred directory.  We are not allowed to go back up and
1286  * reenter.
1287  *
1288  * "dest" is the target of the symlink in question.
1289  *
1290  * "src" is the top source directory currently applicable at the level
1291  * of the referenced symlink.  This is usually the symlink's full path
1292  * (including its name), as referenced from the root of the transfer. */
1293 int unsafe_symlink(const char *dest, const char *src)
1294 {
1295         const char *name, *slash;
1296         int depth = 0;
1297
1298         /* all absolute and null symlinks are unsafe */
1299         if (!dest || !*dest || *dest == '/')
1300                 return 1;
1301
1302         /* find out what our safety margin is */
1303         for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1304                 /* ".." segment starts the count over.  "." segment is ignored. */
1305                 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1306                         if (name[1] == '.')
1307                                 depth = 0;
1308                 } else
1309                         depth++;
1310                 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1311         }
1312         if (*name == '.' && name[1] == '.' && name[2] == '\0')
1313                 depth = 0;
1314
1315         for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1316                 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1317                         if (name[1] == '.') {
1318                                 /* if at any point we go outside the current directory
1319                                    then stop - it is unsafe */
1320                                 if (--depth < 0)
1321                                         return 1;
1322                         }
1323                 } else
1324                         depth++;
1325                 while (slash[1] == '/') slash++;
1326         }
1327         if (*name == '.' && name[1] == '.' && name[2] == '\0')
1328                 depth--;
1329
1330         return depth < 0;
1331 }
1332
1333 /* Return the date and time as a string.  Some callers tweak returned buf. */
1334 char *timestring(time_t t)
1335 {
1336         static int ndx = 0;
1337         static char buffers[4][20]; /* We support 4 simultaneous timestring results. */
1338         char *TimeBuf = buffers[ndx = (ndx + 1) % 4];
1339         struct tm *tm = localtime(&t);
1340         int len = snprintf(TimeBuf, sizeof buffers[0], "%4d/%02d/%02d %02d:%02d:%02d",
1341                  (int)tm->tm_year + 1900, (int)tm->tm_mon + 1, (int)tm->tm_mday,
1342                  (int)tm->tm_hour, (int)tm->tm_min, (int)tm->tm_sec);
1343         assert(len > 0); /* Silence gcc warning */
1344
1345         return TimeBuf;
1346 }
1347
1348 /* Determine if two time_t values are equivalent (either exact, or in
1349  * the modification timestamp window established by --modify-window).
1350  * Returns 1 if the times the "same", or 0 if they are different. */
1351 int same_time(time_t f1_sec, unsigned long f1_nsec, time_t f2_sec, unsigned long f2_nsec)
1352 {
1353         if (modify_window == 0)
1354                 return f1_sec == f2_sec;
1355         if (modify_window < 0)
1356                 return f1_sec == f2_sec && f1_nsec == f2_nsec;
1357         /* The nanoseconds do not figure into these checks -- time windows don't care about that. */
1358         if (f2_sec > f1_sec)
1359                 return f2_sec - f1_sec <= modify_window;
1360         return f1_sec - f2_sec <= modify_window;
1361 }
1362
1363 #ifdef __INSURE__XX
1364 #include <dlfcn.h>
1365
1366 /**
1367    This routine is a trick to immediately catch errors when debugging
1368    with insure. A xterm with a gdb is popped up when insure catches
1369    a error. It is Linux specific.
1370 **/
1371 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1372 {
1373         static int (*fn)();
1374         int ret, pid_int = getpid();
1375         char *cmd;
1376
1377         if (asprintf(&cmd,
1378             "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; "
1379             "gdb /proc/%d/exe %d'", pid_int, pid_int, pid_int) < 0)
1380                 return -1;
1381
1382         if (!fn) {
1383                 static void *h;
1384                 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1385                 fn = dlsym(h, "_Insure_trap_error");
1386         }
1387
1388         ret = fn(a1, a2, a3, a4, a5, a6);
1389
1390         system(cmd);
1391
1392         free(cmd);
1393
1394         return ret;
1395 }
1396 #endif
1397
1398 /* Take a filename and filename length and return the most significant
1399  * filename suffix we can find.  This ignores suffixes such as "~",
1400  * ".bak", ".orig", ".~1~", etc. */
1401 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1402 {
1403         const char *suf, *s;
1404         BOOL had_tilde;
1405         int s_len;
1406
1407         /* One or more dots at the start aren't a suffix. */
1408         while (fn_len && *fn == '.') fn++, fn_len--;
1409
1410         /* Ignore the ~ in a "foo~" filename. */
1411         if (fn_len > 1 && fn[fn_len-1] == '~')
1412                 fn_len--, had_tilde = True;
1413         else
1414                 had_tilde = False;
1415
1416         /* Assume we don't find an suffix. */
1417         suf = "";
1418         *len_ptr = 0;
1419
1420         /* Find the last significant suffix. */
1421         for (s = fn + fn_len; fn_len > 1; ) {
1422                 while (*--s != '.' && s != fn) {}
1423                 if (s == fn)
1424                         break;
1425                 s_len = fn_len - (s - fn);
1426                 fn_len = s - fn;
1427                 if (s_len == 4) {
1428                         if (strcmp(s+1, "bak") == 0
1429                          || strcmp(s+1, "old") == 0)
1430                                 continue;
1431                 } else if (s_len == 5) {
1432                         if (strcmp(s+1, "orig") == 0)
1433                                 continue;
1434                 } else if (s_len > 2 && had_tilde && s[1] == '~' && isDigit(s + 2))
1435                         continue;
1436                 *len_ptr = s_len;
1437                 suf = s;
1438                 if (s_len == 1)
1439                         break;
1440                 /* Determine if the suffix is all digits. */
1441                 for (s++, s_len--; s_len > 0; s++, s_len--) {
1442                         if (!isDigit(s))
1443                                 return suf;
1444                 }
1445                 /* An all-digit suffix may not be that significant. */
1446                 s = suf;
1447         }
1448
1449         return suf;
1450 }
1451
1452 /* This is an implementation of the Levenshtein distance algorithm.  It
1453  * was implemented to avoid needing a two-dimensional matrix (to save
1454  * memory).  It was also tweaked to try to factor in the ASCII distance
1455  * between changed characters as a minor distance quantity.  The normal
1456  * Levenshtein units of distance (each signifying a single change between
1457  * the two strings) are defined as a "UNIT". */
1458
1459 #define UNIT (1 << 16)
1460
1461 uint32 fuzzy_distance(const char *s1, unsigned len1, const char *s2, unsigned len2)
1462 {
1463         uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1464         int32 cost;
1465         unsigned i1, i2;
1466
1467         if (!len1 || !len2) {
1468                 if (!len1) {
1469                         s1 = s2;
1470                         len1 = len2;
1471                 }
1472                 for (i1 = 0, cost = 0; i1 < len1; i1++)
1473                         cost += s1[i1];
1474                 return (int32)len1 * UNIT + cost;
1475         }
1476
1477         for (i2 = 0; i2 < len2; i2++)
1478                 a[i2] = (i2+1) * UNIT;
1479
1480         for (i1 = 0; i1 < len1; i1++) {
1481                 diag = i1 * UNIT;
1482                 above = (i1+1) * UNIT;
1483                 for (i2 = 0; i2 < len2; i2++) {
1484                         left = a[i2];
1485                         if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1486                                 if (cost < 0)
1487                                         cost = UNIT - cost;
1488                                 else
1489                                         cost = UNIT + cost;
1490                         }
1491                         diag_inc = diag + cost;
1492                         left_inc = left + UNIT + *((uchar*)s1+i1);
1493                         above_inc = above + UNIT + *((uchar*)s2+i2);
1494                         a[i2] = above = left < above
1495                               ? (left_inc < diag_inc ? left_inc : diag_inc)
1496                               : (above_inc < diag_inc ? above_inc : diag_inc);
1497                         diag = left;
1498                 }
1499         }
1500
1501         return a[len2-1];
1502 }
1503
1504 #define BB_SLOT_SIZE     (16*1024)          /* Desired size in bytes */
1505 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1506 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1507
1508 struct bitbag {
1509         uint32 **bits;
1510         int slot_cnt;
1511 };
1512
1513 struct bitbag *bitbag_create(int max_ndx)
1514 {
1515         struct bitbag *bb = new(struct bitbag);
1516         bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1517
1518         bb->bits = new_array0(uint32*, bb->slot_cnt);
1519
1520         return bb;
1521 }
1522
1523 void bitbag_set_bit(struct bitbag *bb, int ndx)
1524 {
1525         int slot = ndx / BB_PER_SLOT_BITS;
1526         ndx %= BB_PER_SLOT_BITS;
1527
1528         if (!bb->bits[slot])
1529                 bb->bits[slot] = new_array0(uint32, BB_PER_SLOT_INTS);
1530
1531         bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1532 }
1533
1534 #if 0 /* not needed yet */
1535 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1536 {
1537         int slot = ndx / BB_PER_SLOT_BITS;
1538         ndx %= BB_PER_SLOT_BITS;
1539
1540         if (!bb->bits[slot])
1541                 return;
1542
1543         bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1544 }
1545
1546 int bitbag_check_bit(struct bitbag *bb, int ndx)
1547 {
1548         int slot = ndx / BB_PER_SLOT_BITS;
1549         ndx %= BB_PER_SLOT_BITS;
1550
1551         if (!bb->bits[slot])
1552                 return 0;
1553
1554         return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1555 }
1556 #endif
1557
1558 /* Call this with -1 to start checking from 0.  Returns -1 at the end. */
1559 int bitbag_next_bit(struct bitbag *bb, int after)
1560 {
1561         uint32 bits, mask;
1562         int i, ndx = after + 1;
1563         int slot = ndx / BB_PER_SLOT_BITS;
1564         ndx %= BB_PER_SLOT_BITS;
1565
1566         mask = (1u << (ndx % 32)) - 1;
1567         for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1568                 if (!bb->bits[slot])
1569                         continue;
1570                 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1571                         if (!(bits = bb->bits[slot][i] & ~mask))
1572                                 continue;
1573                         /* The xor magic figures out the lowest enabled bit in
1574                          * bits, and the switch quickly computes log2(bit). */
1575                         switch (bits ^ (bits & (bits-1))) {
1576 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1577                             LOG2(0);  LOG2(1);  LOG2(2);  LOG2(3);
1578                             LOG2(4);  LOG2(5);  LOG2(6);  LOG2(7);
1579                             LOG2(8);  LOG2(9);  LOG2(10); LOG2(11);
1580                             LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1581                             LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1582                             LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1583                             LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1584                             LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1585                         }
1586                         return -1; /* impossible... */
1587                 }
1588         }
1589
1590         return -1;
1591 }
1592
1593 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1594 {
1595         struct flist_ndx_item *item;
1596
1597         item = new(struct flist_ndx_item);
1598         item->next = NULL;
1599         item->ndx = ndx;
1600         if (lp->tail)
1601                 lp->tail->next = item;
1602         else
1603                 lp->head = item;
1604         lp->tail = item;
1605 }
1606
1607 int flist_ndx_pop(flist_ndx_list *lp)
1608 {
1609         struct flist_ndx_item *next;
1610         int ndx;
1611
1612         if (!lp->head)
1613                 return -1;
1614
1615         ndx = lp->head->ndx;
1616         next = lp->head->next;
1617         free(lp->head);
1618         lp->head = next;
1619         if (!next)
1620                 lp->tail = NULL;
1621
1622         return ndx;
1623 }
1624
1625 /* Make sure there is room for one more item in the item list.  If there
1626  * is not, expand the list as indicated by the value of "incr":
1627  *  - if incr < 0 then increase the malloced size by -1 * incr
1628  *  - if incr >= 0 then either make the malloced size equal to "incr"
1629  *    or (if that's not large enough) double the malloced size
1630  * After the size check, the list's count is incremented by 1 and a pointer
1631  * to the "new" list item is returned.
1632  */
1633 void *expand_item_list(item_list *lp, size_t item_size, const char *desc, int incr)
1634 {
1635         /* First time through, 0 <= 0, so list is expanded. */
1636         if (lp->malloced <= lp->count) {
1637                 void *new_ptr;
1638                 size_t expand_size;
1639                 if (incr < 0)
1640                         expand_size = -incr; /* increase slowly */
1641                 else if (lp->malloced < (size_t)incr)
1642                         expand_size = incr - lp->malloced;
1643                 else if (lp->malloced)
1644                         expand_size = lp->malloced; /* double in size */
1645                 else
1646                         expand_size = 1;
1647                 if (SIZE_MAX/item_size - expand_size < lp->malloced)
1648                         overflow_exit("expand_item_list");
1649                 expand_size += lp->malloced;
1650                 new_ptr = realloc_buf(lp->items, expand_size * item_size);
1651                 if (DEBUG_GTE(FLIST, 3)) {
1652                         rprintf(FINFO, "[%s] expand %s to %s bytes, did%s move\n",
1653                                 who_am_i(), desc, big_num(expand_size * item_size),
1654                                 new_ptr == lp->items ? " not" : "");
1655                 }
1656
1657                 lp->items = new_ptr;
1658                 lp->malloced = expand_size;
1659         }
1660         return (char*)lp->items + (lp->count++ * item_size);
1661 }
1662
1663 /* This zeroing of memory won't be optimized away by the compiler. */
1664 void force_memzero(void *buf, size_t len)
1665 {
1666         volatile uchar *z = buf;
1667         while (len-- > 0)
1668                 *z++ = '\0';
1669 }