2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1985, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 static char sccsid[] = "@(#)interactive.c 8.5 (Berkeley) 5/1/95";
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
44 #include <ufs/ufs/dinode.h>
45 #include <ufs/ufs/dir.h>
46 #include <protocols/dumprestore.h>
61 * Things to handle interruptions.
65 static char *nextarg = NULL;
68 * Structure and routines associated with listing directories.
71 ino_t fnum; /* inode number of file */
72 char *fname; /* file name */
73 short len; /* name length */
74 char prefix; /* prefix character */
75 char postfix; /* postfix character */
78 int freeglob; /* glob structure needs to be freed */
79 int argcnt; /* next globbed argument to return */
80 glob_t glob; /* globbing information */
81 char *cmd; /* the current command */
84 static char *copynext(char *, char *);
85 static int fcmp(const void *, const void *);
86 static void formatf(struct afile *, int);
87 static void getcmd(char *, char *, char *, size_t, struct arglist *);
88 struct dirent *glob_readdir(void *);
89 static int glob_stat(const char *, struct stat *);
90 static void mkentry(char *, struct direct *, struct afile *);
91 static void printlist(char *, char *);
94 * Read and execute commands from the terminal.
101 struct arglist arglist;
102 char curdir[MAXPATHLEN];
103 char name[MAXPATHLEN];
106 arglist.freeglob = 0;
108 arglist.glob.gl_flags = GLOB_ALTDIRFUNC;
109 arglist.glob.gl_opendir = rst_opendir;
110 arglist.glob.gl_readdir = glob_readdir;
111 arglist.glob.gl_closedir = rst_closedir;
112 arglist.glob.gl_lstat = glob_stat;
113 arglist.glob.gl_stat = glob_stat;
114 canon("/", curdir, sizeof(curdir));
116 if (setjmp(reset) != 0) {
117 if (arglist.freeglob != 0) {
118 arglist.freeglob = 0;
120 globfree(&arglist.glob);
126 getcmd(curdir, cmd, name, sizeof(name), &arglist);
129 * Add elements to the extraction list.
132 if (strncmp(cmd, "add", strlen(cmd)) != 0)
134 ino = dirlookup(name);
139 treescan(name, ino, addfile);
142 * Change working directory.
145 if (strncmp(cmd, "cd", strlen(cmd)) != 0)
147 ino = dirlookup(name);
150 if (inodetype(ino) == LEAF) {
151 fprintf(stderr, "%s: not a directory\n", name);
154 (void) strcpy(curdir, name);
157 * Delete elements from the extraction list.
160 if (strncmp(cmd, "delete", strlen(cmd)) != 0)
162 np = lookupname(name);
163 if (np == NULL || (np->e_flags & NEW) == 0) {
164 fprintf(stderr, "%s: not on extraction list\n", name);
167 treescan(name, np->e_ino, deletefile);
170 * Extract the requested list.
173 if (strncmp(cmd, "extract", strlen(cmd)) != 0)
183 * List available commands.
186 if (strncmp(cmd, "help", strlen(cmd)) != 0)
189 fprintf(stderr, "%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s",
190 "Available commands are:\n",
191 "\tls [arg] - list directory\n",
192 "\tcd arg - change directory\n",
193 "\tpwd - print current directory\n",
194 "\tadd [arg] - add `arg' to list of",
195 " files to be extracted\n",
196 "\tdelete [arg] - delete `arg' from",
197 " list of files to be extracted\n",
198 "\textract - extract requested files\n",
199 "\tsetmodes - set modes of requested directories\n",
200 "\tquit - immediately exit program\n",
201 "\twhat - list dump header information\n",
202 "\tverbose - toggle verbose flag",
203 " (useful with ``ls'')\n",
204 "\thelp or `?' - print this list\n",
205 "If no `arg' is supplied, the current",
206 " directory is used\n");
212 if (strncmp(cmd, "ls", strlen(cmd)) != 0)
214 printlist(name, curdir);
217 * Print current directory.
220 if (strncmp(cmd, "pwd", strlen(cmd)) != 0)
222 if (curdir[1] == '\0')
223 fprintf(stderr, "/\n");
225 fprintf(stderr, "%s\n", &curdir[1]);
231 if (strncmp(cmd, "quit", strlen(cmd)) != 0)
235 if (strncmp(cmd, "xit", strlen(cmd)) != 0)
239 * Toggle verbose mode.
242 if (strncmp(cmd, "verbose", strlen(cmd)) != 0)
245 fprintf(stderr, "verbose mode off\n");
249 fprintf(stderr, "verbose mode on\n");
253 * Just restore requested directory modes.
256 if (strncmp(cmd, "setmodes", strlen(cmd)) != 0)
261 * Print out dump header information.
264 if (strncmp(cmd, "what", strlen(cmd)) != 0)
272 if (strncmp(cmd, "Debug", strlen(cmd)) != 0)
275 fprintf(stderr, "debugging mode off\n");
279 fprintf(stderr, "debugging mode on\n");
287 fprintf(stderr, "%s: unknown command; type ? for help\n", cmd);
294 * Read and parse an interactive command.
295 * The first word on the line is assigned to "cmd". If
296 * there are no arguments on the command line, then "curdir"
297 * is returned as the argument. If there are arguments
298 * on the line they are returned one at a time on each
299 * successive call to getcmd. Each argument is first assigned
300 * to "name". If it does not start with "/" the pathname in
301 * "curdir" is prepended to it. Finally "canon" is called to
302 * eliminate any embedded ".." components.
305 getcmd(char *curdir, char *cmd, char *name, size_t size, struct arglist *ap)
308 static char input[BUFSIZ];
310 # define rawname input /* save space by reusing input buffer */
313 * Check to see if still processing arguments.
320 * Read a command line and trim off trailing white space.
323 fprintf(stderr, "restore > ");
324 (void) fflush(stderr);
325 if (fgets(input, BUFSIZ, terminal) == NULL) {
329 } while (input[0] == '\n');
330 for (cp = &input[strlen(input) - 2]; *cp == ' ' || *cp == '\t'; cp--)
331 /* trim off trailing white space and newline */;
334 * Copy the command into "cmd".
336 cp = copynext(input, cmd);
339 * If no argument, use curdir as the default.
342 (void) strncpy(name, curdir, size);
343 name[size - 1] = '\0';
348 * Find the next argument.
351 cp = copynext(nextarg, rawname);
357 * If it is an absolute pathname, canonicalize it and return it.
359 if (rawname[0] == '/') {
360 canon(rawname, name, size);
363 * For relative pathnames, prepend the current directory to
364 * it then canonicalize and return it.
366 snprintf(output, sizeof(output), "%s/%s", curdir, rawname);
367 canon(output, name, size);
369 switch (glob(name, GLOB_ALTDIRFUNC, NULL, &ap->glob)) {
371 fprintf(stderr, "%s: out of memory\n", ap->cmd);
374 fprintf(stderr, "%s %s: no such file or directory\n", ap->cmd, name);
377 if (ap->glob.gl_pathc == 0)
380 ap->argcnt = ap->glob.gl_pathc;
383 strncpy(name, ap->glob.gl_pathv[ap->glob.gl_pathc - ap->argcnt], size);
384 name[size - 1] = '\0';
385 if (--ap->argcnt == 0) {
393 * Strip off the next token of the input.
396 copynext(char *input, char *output)
401 for (cp = input; *cp == ' ' || *cp == '\t'; cp++)
402 /* skip to argument */;
404 while (*cp != ' ' && *cp != '\t' && *cp != '\0') {
406 * Handle back slashes.
411 "command lines cannot be continued\n");
418 * The usual unquoted case.
420 if (*cp != '\'' && *cp != '"') {
425 * Handle single and double quotes.
428 while (*cp != quote && *cp != '\0')
431 fprintf(stderr, "missing %c\n", quote);
441 * Canonicalize file names to always start with ``./'' and
442 * remove any embedded "." and ".." components.
445 canon(char *rawname, char *canonname, size_t len)
449 if (strcmp(rawname, ".") == 0 || strncmp(rawname, "./", 2) == 0)
450 (void) strcpy(canonname, "");
451 else if (rawname[0] == '/')
452 (void) strcpy(canonname, ".");
454 (void) strcpy(canonname, "./");
455 if (strlen(canonname) + strlen(rawname) >= len) {
456 fprintf(stderr, "canonname: not enough buffer space\n");
460 (void) strcat(canonname, rawname);
462 * Eliminate multiple and trailing '/'s
464 for (cp = np = canonname; *np != '\0'; cp++) {
466 while (*cp == '/' && *np == '/')
473 * Eliminate extraneous "." and ".." from pathnames.
475 for (np = canonname; *np != '\0'; ) {
478 while (*np != '/' && *np != '\0')
480 if (np - cp == 1 && *cp == '.') {
482 (void) strcpy(cp, np);
485 if (np - cp == 2 && strncmp(cp, "..", 2) == 0) {
487 while (cp > &canonname[1] && *--cp != '/')
488 /* find beginning of name */;
489 (void) strcpy(cp, np);
496 * Do an "ls" style listing of a directory
499 printlist(char *name, char *basename)
501 struct afile *fp, *list, *listp;
505 int entries, len, namelen;
506 char locname[MAXPATHLEN];
508 dp = pathsearch(name);
509 if (dp == NULL || (!dflag && TSTINO(dp->d_ino, dumpmap) == 0) ||
510 (!vflag && dp->d_ino == UFS_WINO))
512 if ((dirp = rst_opendir(name)) == NULL) {
515 mkentry(name, dp, list);
516 len = strlen(basename) + 1;
517 if (strlen(name) - len > single.len) {
518 freename(single.fname);
519 single.fname = savename(&name[len]);
520 single.len = strlen(single.fname);
524 while ((dp = rst_readdir(dirp)))
527 list = (struct afile *)malloc(entries * sizeof(struct afile));
529 fprintf(stderr, "ls: out of memory\n");
532 if ((dirp = rst_opendir(name)) == NULL)
533 panic("directory reopen failed\n");
534 fprintf(stderr, "%s:\n", name);
537 (void)strlcpy(locname, name, MAXPATHLEN);
538 (void)strlcat(locname, "/", MAXPATHLEN);
539 namelen = strlen(locname);
540 while ((dp = rst_readdir(dirp))) {
543 if (!dflag && TSTINO(dp->d_ino, dumpmap) == 0)
545 if (!vflag && (dp->d_ino == UFS_WINO ||
546 strcmp(dp->d_name, ".") == 0 ||
547 strcmp(dp->d_name, "..") == 0))
549 locname[namelen] = '\0';
550 if (namelen + dp->d_namlen >= MAXPATHLEN) {
551 fprintf(stderr, "%s%s: name exceeds %d char\n",
552 locname, dp->d_name, MAXPATHLEN);
554 (void)strlcat(locname, dp->d_name, MAXPATHLEN);
555 mkentry(locname, dp, listp++);
561 fprintf(stderr, "\n");
565 qsort((char *)list, entries, sizeof(struct afile), fcmp);
567 formatf(list, entries);
569 for (fp = listp - 1; fp >= list; fp--)
571 fprintf(stderr, "\n");
577 * Read the contents of a directory.
580 mkentry(char *name, struct direct *dp, struct afile *fp)
585 fp->fnum = dp->d_ino;
586 fp->fname = savename(dp->d_name);
587 for (cp = fp->fname; *cp; cp++)
588 if (!vflag && !isprint((unsigned char)*cp))
590 fp->len = cp - fp->fname;
591 if (dflag && TSTINO(fp->fnum, dumpmap) == 0)
593 else if ((np = lookupname(name)) != NULL && (np->e_flags & NEW))
600 fprintf(stderr, "Warning: undefined file type %d\n",
627 if (inodetype(dp->d_ino) == NODE)
637 * Print out a pretty listing of a directory
640 formatf(struct afile *list, int nentry)
642 struct afile *fp, *endlist;
643 int width, bigino, haveprefix, havepostfix;
644 int i, j, w, precision, columns, lines;
649 bigino = UFS_ROOTINO;
650 endlist = &list[nentry];
651 for (fp = &list[0]; fp < endlist; fp++) {
652 if (bigino < fp->fnum)
656 if (fp->prefix != ' ')
658 if (fp->postfix != ' ')
666 for (precision = 0, i = bigino; i > 0; i /= 10)
668 width += precision + 1;
671 columns = 81 / width;
674 lines = howmany(nentry, columns);
675 for (i = 0; i < lines; i++) {
676 for (j = 0; j < columns; j++) {
677 fp = &list[j * lines + i];
679 fprintf(stderr, "%*ju ",
680 precision, (uintmax_t)fp->fnum);
681 fp->len += precision + 1;
684 putc(fp->prefix, stderr);
687 fprintf(stderr, "%s", fp->fname);
689 putc(fp->postfix, stderr);
692 if (fp + lines >= endlist) {
693 fprintf(stderr, "\n");
696 for (w = fp->len; w < width; w++)
703 * Skip over directory entries that are not on the tape
705 * First have to get definition of a dirent.
712 glob_readdir(void *dirp)
715 static struct dirent adirent;
717 while ((dp = rst_readdir(dirp)) != NULL) {
718 if (!vflag && dp->d_ino == UFS_WINO)
720 if (dflag || TSTINO(dp->d_ino, dumpmap))
725 adirent.d_fileno = dp->d_ino;
726 adirent.d_namlen = dp->d_namlen;
727 memmove(adirent.d_name, dp->d_name, dp->d_namlen + 1);
732 * Return st_mode information in response to stat or lstat calls
735 glob_stat(const char *name, struct stat *stp)
739 dp = pathsearch(name);
740 if (dp == NULL || (!dflag && TSTINO(dp->d_ino, dumpmap) == 0) ||
741 (!vflag && dp->d_ino == UFS_WINO))
743 if (inodetype(dp->d_ino) == NODE)
744 stp->st_mode = IFDIR;
746 stp->st_mode = IFREG;
751 * Comparison routine for qsort.
754 fcmp(const void *f1, const void *f2)
756 return (strcoll(((struct afile *)f1)->fname,
757 ((struct afile *)f2)->fname));
761 * respond to interrupts
764 onintr(int signo __unused)
766 if (command == 'i' && runshell)
768 if (reply("restore interrupted, continue") == FAIL)