util.c

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