bin/pax/ftree.c

   1 /*-
   2  * Copyright (c) 1992 Keith Muller.
   3  * Copyright (c) 1992, 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * Keith Muller of the University of California, San Diego.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the University of
  20  *      California, Berkeley and its contributors.
  21  * 4. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  * @(#)ftree.c  8.2 (Berkeley) 4/18/94
  38  * $FreeBSD: src/bin/pax/ftree.c,v 1.13.2.1 2001/08/01 05:03:11 obrien Exp $
  39  * $DragonFly: src/bin/pax/ftree.c,v 1.2 2003/06/17 04:22:50 dillon Exp $
  40  */
  41
  42 #include <sys/types.h>
  43 #include <sys/time.h>
  44 #include <sys/stat.h>
  45 #include <unistd.h>
  46 #include <string.h>
  47 #include <stdio.h>
  48 #include <errno.h>
  49 #include <stdlib.h>
  50 #include <fts.h>
  51 #include "pax.h"
  52 #include "ftree.h"
  53 #include "extern.h"
  54
  55 /*
  56  * routines to interface with the fts library function.
  57  *
  58  * file args supplied to pax are stored on a single linked list (of type FTREE)
  59  * and given to fts to be processed one at a time. pax "selects" files from
  60  * the expansion of each arg into the corresponding file tree (if the arg is a
  61  * directory, otherwise the node itself is just passed to pax). The selection
  62  * is modified by the -n and -u flags. The user is informed when a specific
  63  * file arg does not generate any selected files. -n keeps expanding the file
  64  * tree arg until one of its files is selected, then skips to the next file
  65  * arg. when the user does not supply the file trees as command line args to
  66  * pax, they are read from stdin
  67  */
  68
  69 static FTS *ftsp = NULL;                /* current FTS handle */
  70 static int ftsopts;                     /* options to be used on fts_open */
  71 static char *farray[2];                 /* array for passing each arg to fts */
  72 static FTREE *fthead = NULL;            /* head of linked list of file args */
  73 static FTREE *fttail = NULL;            /* tail of linked list of file args */
  74 static FTREE *ftcur = NULL;             /* current file arg being processed */
  75 static FTSENT *ftent = NULL;            /* current file tree entry */
  76 static int ftree_skip;                  /* when set skip to next file arg */
  77
  78 static int ftree_arg __P((void));
  79
  80 /*
  81  * ftree_start()
  82  *      initialize the options passed to fts_open() during this run of pax
  83  *      options are based on the selection of pax options by the user
  84  *      fts_start() also calls fts_arg() to open the first valid file arg. We
  85  *      also attempt to reset directory access times when -t (tflag) is set.
  86  * Return:
  87  *      0 if there is at least one valid file arg to process, -1 otherwise
  88  */
  89
  90 #ifdef __STDC__
  91 int
  92 ftree_start(void)
  93 #else
  94 int
  95 ftree_start()
  96 #endif
  97 {
  98         /*
  99          * set up the operation mode of fts, open the first file arg. We must
 100          * use FTS_NOCHDIR, as the user may have to open multiple archives and
 101          * if fts did a chdir off into the boondocks, we may create an archive
 102          * volume in an place where the user did not expect to.
 103          */
 104         ftsopts = FTS_NOCHDIR;
 105
 106         /*
 107          * optional user flags that effect file traversal
 108          * -H command line symlink follow only (half follow)
 109          * -L follow sylinks (logical)
 110          * -P do not follow sylinks (physical). This is the default.
 111          * -X do not cross over mount points
 112          * -t preserve access times on files read.
 113          * -n select only the first member of a file tree when a match is found
 114          * -d do not extract subtrees rooted at a directory arg.
 115          */
 116         if (Lflag)
 117                 ftsopts |= FTS_LOGICAL;
 118         else
 119                 ftsopts |= FTS_PHYSICAL;
 120         if (Hflag)
 121 #       ifdef NET2_FTS
 122                 paxwarn(0, "The -H flag is not supported on this version");
 123 #       else
 124                 ftsopts |= FTS_COMFOLLOW;
 125 #       endif
 126         if (Xflag)
 127                 ftsopts |= FTS_XDEV;
 128
 129         if ((fthead == NULL) && ((farray[0] = malloc(PAXPATHLEN+2)) == NULL)) {
 130                 paxwarn(1, "Unable to allocate memory for file name buffer");
 131                 return(-1);
 132         }
 133
 134         if (ftree_arg() < 0)
 135                 return(-1);
 136         if (tflag && (atdir_start() < 0))
 137                 return(-1);
 138         return(0);
 139 }
 140
 141 /*
 142  * ftree_add()
 143  *      add the arg to the linked list of files to process. Each will be
 144  *      processed by fts one at a time
 145  * Return:
 146  *      0 if added to the linked list, -1 if failed
 147  */
 148
 149 #ifdef __STDC__
 150 int
 151 ftree_add(register char *str, int chflg)
 152 #else
 153 int
 154 ftree_add(str, chflg)
 155         register char *str;
 156         int chflg;
 157 #endif
 158 {
 159         register FTREE *ft;
 160         register int len;
 161
 162         /*
 163          * simple check for bad args
 164          */
 165         if ((str == NULL) || (*str == '\0')) {
 166                 paxwarn(0, "Invalid file name argument");
 167                 return(-1);
 168         }
 169
 170         /*
 171          * allocate FTREE node and add to the end of the linked list (args are
 172          * processed in the same order they were passed to pax). Get rid of any
 173          * trailing / the user may pass us. (watch out for / by itself).
 174          */
 175         if ((ft = (FTREE *)malloc(sizeof(FTREE))) == NULL) {
 176                 paxwarn(0, "Unable to allocate memory for filename");
 177                 return(-1);
 178         }
 179
 180         if (((len = strlen(str) - 1) > 0) && (str[len] == '/'))
 181                 str[len] = '\0';
 182         ft->fname = str;
 183         ft->refcnt = 0;
 184         ft->chflg = chflg;
 185         ft->fow = NULL;
 186         if (fthead == NULL) {
 187                 fttail = fthead = ft;
 188                 return(0);
 189         }
 190         fttail->fow = ft;
 191         fttail = ft;
 192         return(0);
 193 }
 194
 195 /*
 196  * ftree_sel()
 197  *      this entry has been selected by pax. bump up reference count and handle
 198  *      -n and -d processing.
 199  */
 200
 201 #ifdef __STDC__
 202 void
 203 ftree_sel(register ARCHD *arcn)
 204 #else
 205 void
 206 ftree_sel(arcn)
 207         register ARCHD *arcn;
 208 #endif
 209 {
 210         /*
 211          * set reference bit for this pattern. This linked list is only used
 212          * when file trees are supplied pax as args. The list is not used when
 213          * the trees are read from stdin.
 214          */
 215         if (ftcur != NULL)
 216                 ftcur->refcnt = 1;
 217
 218         /*
 219          * if -n we are done with this arg, force a skip to the next arg when
 220          * pax asks for the next file in next_file().
 221          * if -d we tell fts only to match the directory (if the arg is a dir)
 222          * and not the entire file tree rooted at that point.
 223          */
 224         if (nflag)
 225                 ftree_skip = 1;
 226
 227         if (!dflag || (arcn->type != PAX_DIR))
 228                 return;
 229
 230         if (ftent != NULL)
 231                 (void)fts_set(ftsp, ftent, FTS_SKIP);
 232 }
 233
 234 /*
 235  * ftree_chk()
 236  *      called at end on pax execution. Prints all those file args that did not
 237  *      have a selected member (reference count still 0)
 238  */
 239
 240 #ifdef __STDC__
 241 void
 242 ftree_chk(void)
 243 #else
 244 void
 245 ftree_chk()
 246 #endif
 247 {
 248         register FTREE *ft;
 249         register int wban = 0;
 250
 251         /*
 252          * make sure all dir access times were reset.
 253          */
 254         if (tflag)
 255                 atdir_end();
 256
 257         /*
 258          * walk down list and check reference count. Print out those members
 259          * that never had a match
 260          */
 261         for (ft = fthead; ft != NULL; ft = ft->fow) {
 262                 if ((ft->refcnt > 0) || ft->chflg)
 263                         continue;
 264                 if (wban == 0) {
 265                         paxwarn(1,"WARNING! These file names were not selected:");
 266                         ++wban;
 267                 }
 268                 (void)fprintf(stderr, "%s\n", ft->fname);
 269         }
 270 }
 271
 272 /*
 273  * ftree_arg()
 274  *      Get the next file arg for fts to process. Can be from either the linked
 275  *      list or read from stdin when the user did not them as args to pax. Each
 276  *      arg is processed until the first successful fts_open().
 277  * Return:
 278  *      0 when the next arg is ready to go, -1 if out of file args (or EOF on
 279  *      stdin).
 280  */
 281
 282 #ifdef __STDC__
 283 static int
 284 ftree_arg(void)
 285 #else
 286 static int
 287 ftree_arg()
 288 #endif
 289 {
 290         register char *pt;
 291
 292         /*
 293          * close off the current file tree
 294          */
 295         if (ftsp != NULL) {
 296                 (void)fts_close(ftsp);
 297                 ftsp = NULL;
 298         }
 299
 300         /*
 301          * keep looping until we get a valid file tree to process. Stop when we
 302          * reach the end of the list (or get an eof on stdin)
 303          */
 304         for(;;) {
 305                 if (fthead == NULL) {
 306                         /*
 307                          * the user didn't supply any args, get the file trees
 308                          * to process from stdin;
 309                          */
 310                         if (fgets(farray[0], PAXPATHLEN+1, stdin) == NULL)
 311                                 return(-1);
 312                         if ((pt = strchr(farray[0], '\n')) != NULL)
 313                                 *pt = '\0';
 314                 } else {
 315                         /*
 316                          * the user supplied the file args as arguments to pax
 317                          */
 318                         if (ftcur == NULL)
 319                                 ftcur = fthead;
 320                         else if ((ftcur = ftcur->fow) == NULL)
 321                                 return(-1);
 322                         if (ftcur->chflg) {
 323                                 /* First fchdir() back... */
 324                                 if (fchdir(cwdfd) < 0) {
 325                                         syswarn(1, errno,
 326                                           "Can't fchdir to starting directory");
 327                                         return(-1);
 328                                 }
 329                                 if (chdir(ftcur->fname) < 0) {
 330                                         syswarn(1, errno, "Can't chdir to %s",
 331                                             ftcur->fname);
 332                                         return(-1);
 333                                 }
 334                                 continue;
 335                         } else
 336                                 farray[0] = ftcur->fname;
 337                 }
 338
 339                 /*
 340                  * watch it, fts wants the file arg stored in a array of char
 341                  * ptrs, with the last one a null. we use a two element array
 342                  * and set farray[0] to point at the buffer with the file name
 343                  * in it. We cannot pass all the file args to fts at one shot
 344                  * as we need to keep a handle on which file arg generates what
 345                  * files (the -n and -d flags need this). If the open is
 346                  * successful, return a 0.
 347                  */
 348                 if ((ftsp = fts_open(farray, ftsopts, NULL)) != NULL)
 349                         break;
 350         }
 351         return(0);
 352 }
 353
 354 /*
 355  * next_file()
 356  *      supplies the next file to process in the supplied archd structure.
 357  * Return:
 358  *      0 when contents of arcn have been set with the next file, -1 when done.
 359  */
 360
 361 #ifdef __STDC__
 362 int
 363 next_file(register ARCHD *arcn)
 364 #else
 365 int
 366 next_file(arcn)
 367         register ARCHD *arcn;
 368 #endif
 369 {
 370         register int cnt;
 371         time_t atime;
 372         time_t mtime;
 373
 374         /*
 375          * ftree_sel() might have set the ftree_skip flag if the user has the
 376          * -n option and a file was selected from this file arg tree. (-n says
 377          * only one member is matched for each pattern) ftree_skip being 1
 378          * forces us to go to the next arg now.
 379          */
 380         if (ftree_skip) {
 381                 /*
 382                  * clear and go to next arg
 383                  */
 384                 ftree_skip = 0;
 385                 if (ftree_arg() < 0)
 386                         return(-1);
 387         }
 388
 389         /*
 390          * loop until we get a valid file to process
 391          */
 392         for(;;) {
 393                 if ((ftent = fts_read(ftsp)) == NULL) {
 394                         /*
 395                          * out of files in this tree, go to next arg, if none
 396                          * we are done
 397                          */
 398                         if (ftree_arg() < 0)
 399                                 return(-1);
 400                         continue;
 401                 }
 402
 403                 /*
 404                  * handle each type of fts_read() flag
 405                  */
 406                 switch(ftent->fts_info) {
 407                 case FTS_D:
 408                 case FTS_DEFAULT:
 409                 case FTS_F:
 410                 case FTS_SL:
 411                 case FTS_SLNONE:
 412                         /*
 413                          * these are all ok
 414                          */
 415                         break;
 416                 case FTS_DP:
 417                         /*
 418                          * already saw this directory. If the user wants file
 419                          * access times reset, we use this to restore the
 420                          * access time for this directory since this is the
 421                          * last time we will see it in this file subtree
 422                          * remember to force the time (this is -t on a read
 423                          * directory, not a created directory).
 424                          */
 425 #                       ifdef NET2_FTS
 426                         if (!tflag || (get_atdir(ftent->fts_statb.st_dev,
 427                             ftent->fts_statb.st_ino, &mtime, &atime) < 0))
 428 #                       else
 429                         if (!tflag || (get_atdir(ftent->fts_statp->st_dev,
 430                             ftent->fts_statp->st_ino, &mtime, &atime) < 0))
 431 #                       endif
 432                                 continue;
 433                         set_ftime(ftent->fts_path, mtime, atime, 1);
 434                         continue;
 435                 case FTS_DC:
 436                         /*
 437                          * fts claims a file system cycle
 438                          */
 439                         paxwarn(1,"File system cycle found at %s",ftent->fts_path);
 440                         continue;
 441                 case FTS_DNR:
 442 #                       ifdef NET2_FTS
 443                         syswarn(1, errno,
 444 #                       else
 445                         syswarn(1, ftent->fts_errno,
 446 #                       endif
 447                             "Unable to read directory %s", ftent->fts_path);
 448                         continue;
 449                 case FTS_ERR:
 450 #                       ifdef NET2_FTS
 451                         syswarn(1, errno,
 452 #                       else
 453                         syswarn(1, ftent->fts_errno,
 454 #                       endif
 455                             "File system traversal error");
 456                         continue;
 457                 case FTS_NS:
 458                 case FTS_NSOK:
 459 #                       ifdef NET2_FTS
 460                         syswarn(1, errno,
 461 #                       else
 462                         syswarn(1, ftent->fts_errno,
 463 #                       endif
 464                             "Unable to access %s", ftent->fts_path);
 465                         continue;
 466                 }
 467
 468                 /*
 469                  * ok got a file tree node to process. copy info into arcn
 470                  * structure (initialize as required)
 471                  */
 472                 arcn->skip = 0;
 473                 arcn->pad = 0;
 474                 arcn->ln_nlen = 0;
 475                 arcn->ln_name[0] = '\0';
 476 #               ifdef NET2_FTS
 477                 arcn->sb = ftent->fts_statb;
 478 #               else
 479                 arcn->sb = *(ftent->fts_statp);
 480 #               endif
 481
 482                 /*
 483                  * file type based set up and copy into the arcn struct
 484                  * SIDE NOTE:
 485                  * we try to reset the access time on all files and directories
 486                  * we may read when the -t flag is specified. files are reset
 487                  * when we close them after copying. we reset the directories
 488                  * when we are done with their file tree (we also clean up at
 489                  * end in case we cut short a file tree traversal). However
 490                  * there is no way to reset access times on symlinks.
 491                  */
 492                 switch(S_IFMT & arcn->sb.st_mode) {
 493                 case S_IFDIR:
 494                         arcn->type = PAX_DIR;
 495                         if (!tflag)
 496                                 break;
 497                         add_atdir(ftent->fts_path, arcn->sb.st_dev,
 498                             arcn->sb.st_ino, arcn->sb.st_mtime,
 499                             arcn->sb.st_atime);
 500                         break;
 501                 case S_IFCHR:
 502                         arcn->type = PAX_CHR;
 503                         break;
 504                 case S_IFBLK:
 505                         arcn->type = PAX_BLK;
 506                         break;
 507                 case S_IFREG:
 508                         /*
 509                          * only regular files with have data to store on the
 510                          * archive. all others will store a zero length skip.
 511                          * the skip field is used by pax for actual data it has
 512                          * to read (or skip over).
 513                          */
 514                         arcn->type = PAX_REG;
 515                         arcn->skip = arcn->sb.st_size;
 516                         break;
 517                 case S_IFLNK:
 518                         arcn->type = PAX_SLK;
 519                         /*
 520                          * have to read the symlink path from the file
 521                          */
 522                         if ((cnt = readlink(ftent->fts_path, arcn->ln_name,
 523                             PAXPATHLEN - 1)) < 0) {
 524                                 syswarn(1, errno, "Unable to read symlink %s",
 525                                     ftent->fts_path);
 526                                 continue;
 527                         }
 528                         /*
 529                          * set link name length, watch out readlink does not
 530                          * always NUL terminate the link path
 531                          */
 532                         arcn->ln_name[cnt] = '\0';
 533                         arcn->ln_nlen = cnt;
 534                         break;
 535                 case S_IFSOCK:
 536                         /*
 537                          * under BSD storing a socket is senseless but we will
 538                          * let the format specific write function make the
 539                          * decision of what to do with it.
 540                          */
 541                         arcn->type = PAX_SCK;
 542                         break;
 543                 case S_IFIFO:
 544                         arcn->type = PAX_FIF;
 545                         break;
 546                 }
 547                 break;
 548         }
 549
 550         /*
 551          * copy file name, set file name length
 552          */
 553         arcn->nlen = l_strncpy(arcn->name, ftent->fts_path, sizeof(arcn->name) - 1);
 554         arcn->name[arcn->nlen] = '\0';
 555         arcn->org_name = ftent->fts_path;
 556         return(0);
 557 }