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