2 * Copyright (c) 1992 Keith Muller.
3 * Copyright (c) 1992, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * Keith Muller of the University of California, San Diego.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
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.7 2006/09/27 19:18:00 pavalos Exp $
42 #include <sys/types.h>
56 * routines to interface with the fts library function.
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
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 */
78 static int ftree_arg (void);
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.
87 * 0 if there is at least one valid file arg to process, -1 otherwise
94 * set up the operation mode of fts, open the first file arg. We must
95 * use FTS_NOCHDIR, as the user may have to open multiple archives and
96 * if fts did a chdir off into the boondocks, we may create an archive
97 * volume in an place where the user did not expect to.
99 ftsopts = FTS_NOCHDIR;
102 * optional user flags that effect file traversal
103 * -H command line symlink follow only (half follow)
104 * -L follow sylinks (logical)
105 * -P do not follow sylinks (physical). This is the default.
106 * -X do not cross over mount points
107 * -t preserve access times on files read.
108 * -n select only the first member of a file tree when a match is found
109 * -d do not extract subtrees rooted at a directory arg.
112 ftsopts |= FTS_LOGICAL;
114 ftsopts |= FTS_PHYSICAL;
116 ftsopts |= FTS_COMFOLLOW;
120 if ((fthead == NULL) && ((farray[0] = malloc(PAXPATHLEN+2)) == NULL)) {
121 paxwarn(1, "Unable to allocate memory for file name buffer");
127 if (tflag && (atdir_start() < 0))
134 * add the arg to the linked list of files to process. Each will be
135 * processed by fts one at a time
137 * 0 if added to the linked list, -1 if failed
141 ftree_add(char *str, int chflg)
147 * simple check for bad args
149 if ((str == NULL) || (*str == '\0')) {
150 paxwarn(0, "Invalid file name argument");
155 * allocate FTREE node and add to the end of the linked list (args are
156 * processed in the same order they were passed to pax). Get rid of any
157 * trailing / the user may pass us. (watch out for / by itself).
159 if ((ft = (FTREE *)malloc(sizeof(FTREE))) == NULL) {
160 paxwarn(0, "Unable to allocate memory for filename");
164 if (((len = strlen(str) - 1) > 0) && (str[len] == '/'))
170 if (fthead == NULL) {
171 fttail = fthead = ft;
181 * this entry has been selected by pax. bump up reference count and handle
182 * -n and -d processing.
186 ftree_sel(ARCHD *arcn)
189 * set reference bit for this pattern. This linked list is only used
190 * when file trees are supplied pax as args. The list is not used when
191 * the trees are read from stdin.
197 * if -n we are done with this arg, force a skip to the next arg when
198 * pax asks for the next file in next_file().
199 * if -d we tell fts only to match the directory (if the arg is a dir)
200 * and not the entire file tree rooted at that point.
205 if (!dflag || (arcn->type != PAX_DIR))
209 fts_set(ftsp, ftent, FTS_SKIP);
214 * called at end on pax execution. Prints all those file args that did not
215 * have a selected member (reference count still 0)
225 * make sure all dir access times were reset.
231 * walk down list and check reference count. Print out those members
232 * that never had a match
234 for (ft = fthead; ft != NULL; ft = ft->fow) {
235 if ((ft->refcnt > 0) || ft->chflg)
238 paxwarn(1,"WARNING! These file names were not selected:");
241 fprintf(stderr, "%s\n", ft->fname);
247 * Get the next file arg for fts to process. Can be from either the linked
248 * list or read from stdin when the user did not them as args to pax. Each
249 * arg is processed until the first successful fts_open().
251 * 0 when the next arg is ready to go, -1 if out of file args (or EOF on
261 * close off the current file tree
269 * keep looping until we get a valid file tree to process. Stop when we
270 * reach the end of the list (or get an eof on stdin)
273 if (fthead == NULL) {
275 * the user didn't supply any args, get the file trees
276 * to process from stdin;
278 if (fgets(farray[0], PAXPATHLEN+1, stdin) == NULL)
280 if ((pt = strchr(farray[0], '\n')) != NULL)
284 * the user supplied the file args as arguments to pax
288 else if ((ftcur = ftcur->fow) == NULL)
291 /* First fchdir() back... */
292 if (fchdir(cwdfd) < 0) {
294 "Can't fchdir to starting directory");
297 if (chdir(ftcur->fname) < 0) {
298 syswarn(1, errno, "Can't chdir to %s",
304 farray[0] = ftcur->fname;
308 * watch it, fts wants the file arg stored in a array of char
309 * ptrs, with the last one a null. we use a two element array
310 * and set farray[0] to point at the buffer with the file name
311 * in it. We cannot pass all the file args to fts at one shot
312 * as we need to keep a handle on which file arg generates what
313 * files (the -n and -d flags need this). If the open is
314 * successful, return a 0.
316 if ((ftsp = fts_open(farray, ftsopts, NULL)) != NULL)
324 * supplies the next file to process in the supplied archd structure.
326 * 0 when contents of arcn have been set with the next file, -1 when done.
330 next_file(ARCHD *arcn)
337 * ftree_sel() might have set the ftree_skip flag if the user has the
338 * -n option and a file was selected from this file arg tree. (-n says
339 * only one member is matched for each pattern) ftree_skip being 1
340 * forces us to go to the next arg now.
344 * clear and go to next arg
352 * loop until we get a valid file to process
355 if ((ftent = fts_read(ftsp)) == NULL) {
357 * out of files in this tree, go to next arg, if none
366 * handle each type of fts_read() flag
368 switch(ftent->fts_info) {
380 * already saw this directory. If the user wants file
381 * access times reset, we use this to restore the
382 * access time for this directory since this is the
383 * last time we will see it in this file subtree
384 * remember to force the time (this is -t on a read
385 * directory, not a created directory).
387 if (!tflag || (get_atdir(ftent->fts_statp->st_dev,
388 ftent->fts_statp->st_ino, &mtime, &atime) < 0))
390 set_ftime(ftent->fts_path, mtime, atime, 1);
394 * fts claims a file system cycle
396 paxwarn(1,"File system cycle found at %s",ftent->fts_path);
399 syswarn(1, ftent->fts_errno,
400 "Unable to read directory %s", ftent->fts_path);
403 syswarn(1, ftent->fts_errno,
404 "File system traversal error");
408 syswarn(1, ftent->fts_errno,
409 "Unable to access %s", ftent->fts_path);
414 * ok got a file tree node to process. copy info into arcn
415 * structure (initialize as required)
420 arcn->ln_name[0] = '\0';
421 arcn->sb = *(ftent->fts_statp);
424 * file type based set up and copy into the arcn struct
426 * we try to reset the access time on all files and directories
427 * we may read when the -t flag is specified. files are reset
428 * when we close them after copying. we reset the directories
429 * when we are done with their file tree (we also clean up at
430 * end in case we cut short a file tree traversal). However
431 * there is no way to reset access times on symlinks.
433 switch(S_IFMT & arcn->sb.st_mode) {
435 arcn->type = PAX_DIR;
438 add_atdir(ftent->fts_path, arcn->sb.st_dev,
439 arcn->sb.st_ino, arcn->sb.st_mtime,
443 arcn->type = PAX_CHR;
446 arcn->type = PAX_BLK;
450 * only regular files with have data to store on the
451 * archive. all others will store a zero length skip.
452 * the skip field is used by pax for actual data it has
453 * to read (or skip over).
455 arcn->type = PAX_REG;
456 arcn->skip = arcn->sb.st_size;
459 arcn->type = PAX_SLK;
461 * have to read the symlink path from the file
463 if ((cnt = readlink(ftent->fts_path, arcn->ln_name,
464 PAXPATHLEN - 1)) < 0) {
465 syswarn(1, errno, "Unable to read symlink %s",
470 * set link name length, watch out readlink does not
471 * always NUL terminate the link path
473 arcn->ln_name[cnt] = '\0';
478 * under BSD storing a socket is senseless but we will
479 * let the format specific write function make the
480 * decision of what to do with it.
482 arcn->type = PAX_SCK;
485 arcn->type = PAX_FIF;
492 * copy file name, set file name length
494 arcn->nlen = l_strncpy(arcn->name, ftent->fts_path, sizeof(arcn->name) - 1);
495 arcn->name[arcn->nlen] = '\0';
496 arcn->org_name = ftent->fts_path;