2 * Copyright (c) 1985, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)interactive.c 8.5 (Berkeley) 5/1/95
30 * $FreeBSD: src/sbin/restore/interactive.c,v 1.8.2.1 2001/01/03 14:36:08 iedowse Exp $
33 #include <sys/param.h>
36 #include <vfs/ufs/dinode.h>
37 #include <vfs/ufs/dir.h>
38 #include <protocols/dumprestore.h>
50 * Things to handle interruptions.
54 static char *nextarg
= NULL
;
57 * Structure and routines associated with listing directories.
60 ufs1_ino_t fnum
; /* inode number of file */
61 char *fname
; /* file name */
62 short len
; /* name length */
63 char prefix
; /* prefix character */
64 char postfix
; /* postfix character */
67 int freeglob
; /* glob structure needs to be freed */
68 int argcnt
; /* next globbed argument to return */
69 glob_t glob
; /* globbing information */
70 char *cmd
; /* the current command */
73 static char *copynext(char *, char *);
74 static int fcmp(const void *, const void *);
75 static void formatf(struct afile
*, int);
76 static void getcmd(char *, char *, char *, size_t, struct arglist
*);
77 struct dirent
*glob_readdir(RST_DIR
*dirp
);
78 static int glob_stat(const char *, struct stat
*);
79 static void mkentry(const char *, struct direct
*, struct afile
*);
80 static void printlist(const char *, char *);
83 * Read and execute commands from the terminal.
90 struct arglist arglist
;
91 char curdir
[MAXPATHLEN
];
92 char name
[MAXPATHLEN
];
97 arglist
.glob
.gl_flags
= GLOB_ALTDIRFUNC
;
98 arglist
.glob
.gl_opendir
= (void *)rst_opendir
;
99 arglist
.glob
.gl_readdir
= (void *)glob_readdir
;
100 arglist
.glob
.gl_closedir
= (void *)rst_closedir
;
101 arglist
.glob
.gl_lstat
= glob_stat
;
102 arglist
.glob
.gl_stat
= glob_stat
;
103 canon("/", curdir
, sizeof(curdir
));
105 if (setjmp(reset
) != 0) {
106 if (arglist
.freeglob
!= 0) {
107 arglist
.freeglob
= 0;
109 globfree(&arglist
.glob
);
115 getcmd(curdir
, cmd
, name
, sizeof(name
), &arglist
);
118 * Add elements to the extraction list.
121 if (strncmp(cmd
, "add", strlen(cmd
)) != 0)
123 ino
= dirlookup(name
);
128 treescan(name
, ino
, addfile
);
131 * Change working directory.
134 if (strncmp(cmd
, "cd", strlen(cmd
)) != 0)
136 ino
= dirlookup(name
);
139 if (inodetype(ino
) == LEAF
) {
140 fprintf(stderr
, "%s: not a directory\n", name
);
143 strcpy(curdir
, name
);
146 * Delete elements from the extraction list.
149 if (strncmp(cmd
, "delete", strlen(cmd
)) != 0)
151 np
= lookupname(name
);
152 if (np
== NULL
|| (np
->e_flags
& NEW
) == 0) {
153 fprintf(stderr
, "%s: not on extraction list\n", name
);
156 treescan(name
, np
->e_ino
, deletefile
);
159 * Extract the requested list.
162 if (strncmp(cmd
, "extract", strlen(cmd
)) != 0)
172 * List available commands.
175 if (strncmp(cmd
, "help", strlen(cmd
)) != 0)
178 fprintf(stderr
, "%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s",
179 "Available commands are:\n",
180 "\tls [arg] - list directory\n",
181 "\tcd arg - change directory\n",
182 "\tpwd - print current directory\n",
183 "\tadd [arg] - add `arg' to list of",
184 " files to be extracted\n",
185 "\tdelete [arg] - delete `arg' from",
186 " list of files to be extracted\n",
187 "\textract - extract requested files\n",
188 "\tsetmodes - set modes of requested directories\n",
189 "\tquit - immediately exit program\n",
190 "\twhat - list dump header information\n",
191 "\tverbose - toggle verbose flag",
192 " (useful with ``ls'')\n",
193 "\thelp or `?' - print this list\n",
194 "If no `arg' is supplied, the current",
195 " directory is used\n");
201 if (strncmp(cmd
, "ls", strlen(cmd
)) != 0)
203 printlist(name
, curdir
);
206 * Print current directory.
209 if (strncmp(cmd
, "pwd", strlen(cmd
)) != 0)
211 if (curdir
[1] == '\0')
212 fprintf(stderr
, "/\n");
214 fprintf(stderr
, "%s\n", &curdir
[1]);
220 if (strncmp(cmd
, "quit", strlen(cmd
)) != 0)
224 if (strncmp(cmd
, "xit", strlen(cmd
)) != 0)
228 * Toggle verbose mode.
231 if (strncmp(cmd
, "verbose", strlen(cmd
)) != 0)
234 fprintf(stderr
, "verbose mode off\n");
238 fprintf(stderr
, "verbose mode on\n");
242 * Just restore requested directory modes.
245 if (strncmp(cmd
, "setmodes", strlen(cmd
)) != 0)
250 * Print out dump header information.
253 if (strncmp(cmd
, "what", strlen(cmd
)) != 0)
261 if (strncmp(cmd
, "Debug", strlen(cmd
)) != 0)
264 fprintf(stderr
, "debugging mode off\n");
268 fprintf(stderr
, "debugging mode on\n");
276 fprintf(stderr
, "%s: unknown command; type ? for help\n", cmd
);
283 * Read and parse an interactive command.
284 * The first word on the line is assigned to "cmd". If
285 * there are no arguments on the command line, then "curdir"
286 * is returned as the argument. If there are arguments
287 * on the line they are returned one at a time on each
288 * successive call to getcmd. Each argument is first assigned
289 * to "name". If it does not start with "/" the pathname in
290 * "curdir" is prepended to it. Finally "canon" is called to
291 * eliminate any embedded ".." components.
294 getcmd(char *curdir
, char *cmd
, char *name
, size_t size
, struct arglist
*ap
)
297 static char input
[BUFSIZ
];
299 # define rawname input /* save space by reusing input buffer */
302 * Check to see if still processing arguments.
309 * Read a command line and trim off trailing white space.
312 fprintf(stderr
, "restore > ");
314 if (fgets(input
, BUFSIZ
, terminal
) == NULL
) {
318 } while (input
[0] == '\n');
319 for (cp
= &input
[strlen(input
) - 2]; *cp
== ' ' || *cp
== '\t'; cp
--)
320 /* trim off trailing white space and newline */;
323 * Copy the command into "cmd".
325 cp
= copynext(input
, cmd
);
328 * If no argument, use curdir as the default.
331 strncpy(name
, curdir
, size
);
332 name
[size
- 1] = '\0';
337 * Find the next argument.
340 cp
= copynext(nextarg
, rawname
);
346 * If it is an absolute pathname, canonicalize it and return it.
348 if (rawname
[0] == '/') {
349 canon(rawname
, name
, size
);
352 * For relative pathnames, prepend the current directory to
353 * it then canonicalize and return it.
355 snprintf(output
, sizeof(output
), "%s/%s", curdir
, rawname
);
356 canon(output
, name
, size
);
358 if (glob(name
, GLOB_ALTDIRFUNC
, NULL
, &ap
->glob
) < 0)
359 fprintf(stderr
, "%s: out of memory\n", ap
->cmd
);
360 if (ap
->glob
.gl_pathc
== 0)
363 ap
->argcnt
= ap
->glob
.gl_pathc
;
366 strncpy(name
, ap
->glob
.gl_pathv
[ap
->glob
.gl_pathc
- ap
->argcnt
], size
);
367 name
[size
- 1] = '\0';
368 if (--ap
->argcnt
== 0) {
376 * Strip off the next token of the input.
379 copynext(char *input
, char *output
)
384 for (cp
= input
; *cp
== ' ' || *cp
== '\t'; cp
++)
385 /* skip to argument */;
387 while (*cp
!= ' ' && *cp
!= '\t' && *cp
!= '\0') {
389 * Handle back slashes.
394 "command lines cannot be continued\n");
401 * The usual unquoted case.
403 if (*cp
!= '\'' && *cp
!= '"') {
408 * Handle single and double quotes.
411 while (*cp
!= quote
&& *cp
!= '\0')
412 *bp
++ = *cp
++ | 0200;
414 fprintf(stderr
, "missing %c\n", quote
);
424 * Canonicalize file names to always start with ``./'' and
425 * remove any embedded "." and ".." components.
428 canon(const char *rawname
, char *canonname
, size_t len
)
432 if (strcmp(rawname
, ".") == 0 || strncmp(rawname
, "./", 2) == 0)
433 strcpy(canonname
, "");
434 else if (rawname
[0] == '/')
435 strcpy(canonname
, ".");
437 strcpy(canonname
, "./");
438 if (strlen(canonname
) + strlen(rawname
) >= len
) {
439 fprintf(stderr
, "canonname: not enough buffer space\n");
443 strcat(canonname
, rawname
);
445 * Eliminate multiple and trailing '/'s
447 for (cp
= np
= canonname
; *np
!= '\0'; cp
++) {
449 while (*cp
== '/' && *np
== '/')
456 * Eliminate extraneous "." and ".." from pathnames.
458 for (np
= canonname
; *np
!= '\0'; ) {
461 while (*np
!= '/' && *np
!= '\0')
463 if (np
- cp
== 1 && *cp
== '.') {
468 if (np
- cp
== 2 && strncmp(cp
, "..", 2) == 0) {
470 while (cp
> &canonname
[1] && *--cp
!= '/')
471 /* find beginning of name */;
479 * Do an "ls" style listing of a directory
482 printlist(const char *name
, char *basename
)
484 struct afile
*fp
, *list
, *listp
= NULL
;
488 int entries
, len
, namelen
;
489 char locname
[MAXPATHLEN
+ 1];
491 dp
= pathsearch(name
);
492 if (dp
== NULL
|| (!dflag
&& TSTINO(dp
->d_ino
, dumpmap
) == 0) ||
493 (!vflag
&& dp
->d_ino
== WINO
))
495 if ((dirp
= rst_opendir(name
)) == NULL
) {
498 mkentry(name
, dp
, list
);
499 len
= strlen(basename
) + 1;
500 if (strlen(name
) - len
> (unsigned short)single
.len
) {
501 freename(single
.fname
);
502 single
.fname
= savename(&name
[len
]);
503 single
.len
= strlen(single
.fname
);
507 while ((dp
= rst_readdir(dirp
)))
510 list
= (struct afile
*)malloc(entries
* sizeof(struct afile
));
512 fprintf(stderr
, "ls: out of memory\n");
515 if ((dirp
= rst_opendir(name
)) == NULL
)
516 panic("directory reopen failed\n");
517 fprintf(stderr
, "%s:\n", name
);
520 strncpy(locname
, name
, MAXPATHLEN
);
521 strncat(locname
, "/", MAXPATHLEN
);
522 namelen
= strlen(locname
);
523 while ((dp
= rst_readdir(dirp
))) {
526 if (!dflag
&& TSTINO(dp
->d_ino
, dumpmap
) == 0)
528 if (!vflag
&& (dp
->d_ino
== WINO
||
529 strcmp(dp
->d_name
, ".") == 0 ||
530 strcmp(dp
->d_name
, "..") == 0))
532 locname
[namelen
] = '\0';
533 if (namelen
+ dp
->d_namlen
>= MAXPATHLEN
) {
534 fprintf(stderr
, "%s%s: name exceeds %d char\n",
535 locname
, dp
->d_name
, MAXPATHLEN
);
537 strncat(locname
, dp
->d_name
, (int)dp
->d_namlen
);
538 mkentry(locname
, dp
, listp
++);
544 fprintf(stderr
, "\n");
548 qsort((char *)list
, entries
, sizeof(struct afile
), fcmp
);
550 formatf(list
, entries
);
552 for (fp
= listp
- 1; fp
>= list
; fp
--)
554 fprintf(stderr
, "\n");
560 * Read the contents of a directory.
563 mkentry(const char *name
, struct direct
*dp
, struct afile
*fp
)
568 fp
->fnum
= dp
->d_ino
;
569 fp
->fname
= savename(dp
->d_name
);
570 for (cp
= fp
->fname
; *cp
; cp
++)
571 if (!vflag
&& (*cp
< ' ' || *cp
>= 0177))
573 fp
->len
= cp
- fp
->fname
;
574 if (dflag
&& TSTINO(fp
->fnum
, dumpmap
) == 0)
576 else if ((np
= lookupname(name
)) != NULL
&& (np
->e_flags
& NEW
))
583 fprintf(stderr
, "Warning: undefined file type %d\n",
610 if (inodetype(dp
->d_ino
) == NODE
)
620 * Print out a pretty listing of a directory
623 formatf(struct afile
*list
, int nentry
)
625 struct afile
*fp
, *endlist
;
627 int width
, haveprefix
, havepostfix
;
628 int i
, j
, w
, precision
= 0, columns
, lines
;
634 endlist
= &list
[nentry
];
635 for (fp
= &list
[0]; fp
< endlist
; fp
++) {
636 if (bigino
< fp
->fnum
)
640 if (fp
->prefix
!= ' ')
642 if (fp
->postfix
!= ' ')
650 for (precision
= 0, i
= bigino
; i
> 0; i
/= 10)
652 width
+= precision
+ 1;
655 columns
= 81 / width
;
658 lines
= (nentry
+ columns
- 1) / columns
;
659 for (i
= 0; i
< lines
; i
++) {
660 for (j
= 0; j
< columns
; j
++) {
661 fp
= &list
[j
* lines
+ i
];
663 fprintf(stderr
, "%*d ", precision
, fp
->fnum
);
664 fp
->len
+= precision
+ 1;
667 putc(fp
->prefix
, stderr
);
670 fprintf(stderr
, "%s", fp
->fname
);
672 putc(fp
->postfix
, stderr
);
675 if (fp
+ lines
>= endlist
) {
676 fprintf(stderr
, "\n");
679 for (w
= fp
->len
; w
< width
; w
++)
686 * Skip over directory entries that are not on the tape
688 * First have to get definition of a dirent.
695 glob_readdir(RST_DIR
*dirp
)
698 ADIRENT_STORAGE_LEN
= _DIRENT_RECLEN(NAME_MAX
),
701 uint8_t storage
[ADIRENT_STORAGE_LEN
];
702 struct dirent alignment
;
707 while ((dp
= rst_readdir(dirp
)) != NULL
) {
708 if (!vflag
&& dp
->d_ino
== WINO
)
710 if (dflag
|| TSTINO(dp
->d_ino
, dumpmap
))
715 adp
= (struct dirent
*)&adirent
;
716 adp
->d_fileno
= dp
->d_ino
;
717 adp
->d_namlen
= dp
->d_namlen
;
718 strcpy(adp
->d_name
, dp
->d_name
);
723 * Return st_mode information in response to stat or lstat calls
726 glob_stat(const char *name
, struct stat
*stp
)
730 dp
= pathsearch(name
);
731 if (dp
== NULL
|| (!dflag
&& TSTINO(dp
->d_ino
, dumpmap
) == 0) ||
732 (!vflag
&& dp
->d_ino
== WINO
))
734 if (inodetype(dp
->d_ino
) == NODE
)
735 stp
->st_mode
= IFDIR
;
737 stp
->st_mode
= IFREG
;
742 * Comparison routine for qsort.
745 fcmp(const void *f1
, const void *f2
)
747 return (strcmp(((const struct afile
*)f1
)->fname
,
748 ((const struct afile
*)f2
)->fname
));
752 * respond to interrupts
755 onintr(int signo __unused
)
757 if (command
== 'i' && runshell
)
759 if (reply("restore interrupted, continue") == FAIL
)