3 * Bacula Director -- User Agent Database File tree for Restore
4 * command. This file interacts with the user implementing the
7 * Kern Sibbald, July MMII
13 Copyright (C) 2002-2005 Kern Sibbald
15 This program is free software; you can redistribute it and/or
16 modify it under the terms of the GNU General Public License as
17 published by the Free Software Foundation; either version 2 of
18 the License, or (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 General Public License for more details.
25 You should have received a copy of the GNU General Public
26 License along with this program; if not, write to the Free
27 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 #include "lib/fnmatch.h"
39 #include "findlib/find.h"
42 /* Forward referenced commands */
44 static int markcmd(UAContext *ua, TREE_CTX *tree);
45 static int markdircmd(UAContext *ua, TREE_CTX *tree);
46 static int countcmd(UAContext *ua, TREE_CTX *tree);
47 static int findcmd(UAContext *ua, TREE_CTX *tree);
48 static int lscmd(UAContext *ua, TREE_CTX *tree);
49 static int lsmarkcmd(UAContext *ua, TREE_CTX *tree);
50 static int dircmd(UAContext *ua, TREE_CTX *tree);
51 static int estimatecmd(UAContext *ua, TREE_CTX *tree);
52 static int helpcmd(UAContext *ua, TREE_CTX *tree);
53 static int cdcmd(UAContext *ua, TREE_CTX *tree);
54 static int pwdcmd(UAContext *ua, TREE_CTX *tree);
55 static int unmarkcmd(UAContext *ua, TREE_CTX *tree);
56 static int unmarkdircmd(UAContext *ua, TREE_CTX *tree);
57 static int quitcmd(UAContext *ua, TREE_CTX *tree);
58 static int donecmd(UAContext *ua, TREE_CTX *tree);
61 struct cmdstruct { const char *key; int (*func)(UAContext *ua, TREE_CTX *tree); const char *help; };
62 static struct cmdstruct commands[] = {
63 { N_("cd"), cdcmd, _("change current directory")},
64 { N_("count"), countcmd, _("count marked files in and below the cd")},
65 { N_("dir"), dircmd, _("long list current directory, wildcards allowed")},
66 { N_("done"), donecmd, _("leave file selection mode")},
67 { N_("estimate"), estimatecmd, _("estimate restore size")},
68 { N_("exit"), donecmd, _("same as done command")},
69 { N_("find"), findcmd, _("find files, wildcards allowed")},
70 { N_("help"), helpcmd, _("print help")},
71 { N_("ls"), lscmd, _("list current directory, wildcards allowed")},
72 { N_("lsmark"), lsmarkcmd, _("list the marked files in and below the cd")},
73 { N_("mark"), markcmd, _("mark dir/file to be restored recursively in dirs")},
74 { N_("markdir"), markdircmd, _("mark directory name to be restored (no files)")},
75 { N_("pwd"), pwdcmd, _("print current working directory")},
76 { N_("unmark"), unmarkcmd, _("unmark dir/file to be restored recursively in dir")},
77 { N_("unmarkdir"), unmarkdircmd, _("unmark directory name only no recursion")},
78 { N_("quit"), quitcmd, _("quit and do not do restore")},
79 { N_("?"), helpcmd, _("print help")},
81 #define comsize (sizeof(commands)/sizeof(struct cmdstruct))
85 * Enter a prompt mode where the user can select/deselect
86 * files to be restored. This is sort of like a mini-shell
87 * that allows "cd", "pwd", "add", "rm", ...
89 bool user_select_files_from_tree(TREE_CTX *tree)
93 /* Get a new context so we don't destroy restore command args */
94 UAContext *ua = new_ua_context(tree->ua->jcr);
95 ua->UA_sock = tree->ua->UA_sock; /* patch in UA socket */
98 "\nYou are now entering file selection mode where you add (mark) and\n"
99 "remove (unmark) files to be restored. No files are initially added, unless\n"
100 "you used the \"all\" keyword on the command line.\n"
101 "Enter \"done\" to leave this mode.\n\n"));
103 * Enter interactive command handler allowing selection
104 * of individual files.
106 tree->node = (TREE_NODE *)tree->root;
107 tree_getpath(tree->node, cwd, sizeof(cwd));
108 bsendmsg(tree->ua, _("cwd is: %s\n"), cwd);
111 if (!get_cmd(ua, "$ ")) {
119 len = strlen(ua->argk[0]);
122 for (i=0; i<(int)comsize; i++) /* search for command */
123 if (strncasecmp(ua->argk[0], _(commands[i].key), len) == 0) {
124 stat = (*commands[i].func)(ua, tree); /* go execute command */
129 bsendmsg(tree->ua, _("Illegal command. Enter \"done\" to exit.\n"));
136 ua->UA_sock = NULL; /* don't release restore socket */
139 free_ua_context(ua); /* get rid of temp UA context */
145 * This callback routine is responsible for inserting the
146 * items it gets into the directory tree. For each JobId selected
147 * this routine is called once for each file. We do not allow
148 * duplicate filenames, but instead keep the info from the most
149 * recent file entered (i.e. the JobIds are assumed to be sorted)
151 * See uar_sel_files in sql_cmds.c for query that calls us.
152 * row[0]=Path, row[1]=Filename, row[2]=FileIndex
153 * row[3]=JobId row[4]=LStat
155 int insert_tree_handler(void *ctx, int num_fields, char **row)
158 TREE_CTX *tree = (TREE_CTX *)ctx;
165 if (*row[1] == 0) { /* no filename => directory */
166 if (*row[0] != '/') { /* Must be Win32 directory */
174 hard_link = (decode_LinkFI(row[4], &statp) != 0);
175 node = insert_tree_node(row[0], row[1], type, tree->root, NULL);
176 JobId = str_to_int64(row[3]);
177 FileIndex = str_to_int64(row[2]);
179 * - The first time we see a file (node->inserted==true), we accept it.
180 * - In the same JobId, we accept only the first copy of a
181 * hard linked file (the others are simply pointers).
182 * - In the same JobId, we accept the last copy of any other
183 * file -- in particular directories.
185 * All the code to set ok could be condensed to a single
186 * line, but it would be even harder to read.
189 if (!node->inserted && JobId == node->JobId) {
190 if ((hard_link && FileIndex > node->FileIndex) ||
191 (!hard_link && FileIndex < node->FileIndex)) {
196 node->hard_link = hard_link;
197 node->FileIndex = FileIndex;
200 node->soft_link = S_ISLNK(statp.st_mode) != 0;
202 node->extract = true; /* extract all by default */
203 if (type == TN_DIR || type == TN_DIR_NLS) {
204 node->extract_dir = true; /* if dir, extract it */
208 if (node->inserted) {
210 if (tree->DeltaCount > 0 && (tree->FileCount-tree->LastCount) > tree->DeltaCount) {
211 bsendmsg(tree->ua, "+");
212 tree->LastCount = tree->FileCount;
221 * Set extract to value passed. We recursively walk
222 * down the tree setting all children if the
223 * node is a directory.
225 static int set_extract(UAContext *ua, TREE_NODE *node, TREE_CTX *tree, bool extract)
232 node->extract = extract;
233 if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
234 node->extract_dir = extract; /* set/clear dir too */
236 if (node->type != TN_NEWDIR) {
239 /* For a non-file (i.e. directory), we see all the children */
240 if (node->type != TN_FILE || (node->soft_link && tree_node_has_child(node))) {
241 /* Recursive set children within directory */
242 foreach_child(n, node) {
243 count += set_extract(ua, n, tree, extract);
246 * Walk up tree marking any unextracted parent to be
250 while (node->parent && !node->parent->extract_dir) {
252 node->extract_dir = true;
255 } else if (extract) {
258 * Ordinary file, we get the full path, look up the
259 * attributes, decode them, and if we are hard linked to
260 * a file that was saved, we must load that file too.
262 tree_getpath(node, cwd, sizeof(cwd));
264 fdbr.JobId = node->JobId;
265 if (node->hard_link && db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
267 decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
269 * If we point to a hard linked file, traverse the tree to
270 * find that file, and mark it to be restored as well. It
271 * must have the Link we just obtained and the same JobId.
274 for (n=first_tree_node(tree->root); n; n=next_tree_node(n)) {
275 if (n->FileIndex == LinkFI && n->JobId == node->JobId) {
277 if (n->type == TN_DIR || n->type == TN_DIR_NLS) {
278 n->extract_dir = true;
290 * Recursively mark the current directory to be restored as
291 * well as all directories and files below it.
293 static int markcmd(UAContext *ua, TREE_CTX *tree)
299 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
300 bsendmsg(ua, _("No files marked.\n"));
303 for (int i=1; i < ua->argc; i++) {
304 foreach_child(node, tree->node) {
305 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
306 count += set_extract(ua, node, tree, true);
311 bsendmsg(ua, _("No files marked.\n"));
313 bsendmsg(ua, _("%s file%s marked.\n"),
314 edit_uint64_with_commas(count, ec1), count==0?"":"s");
319 static int markdircmd(UAContext *ua, TREE_CTX *tree)
325 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
326 bsendmsg(ua, _("No files marked.\n"));
329 for (int i=1; i < ua->argc; i++) {
330 foreach_child(node, tree->node) {
331 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
332 if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
333 node->extract_dir = true;
340 bsendmsg(ua, _("No directories marked.\n"));
342 bsendmsg(ua, _("%s director%s marked.\n"),
343 edit_uint64_with_commas(count, ec1), count==1?"y":"ies");
349 static int countcmd(UAContext *ua, TREE_CTX *tree)
351 int total, num_extract;
352 char ec1[50], ec2[50];
354 total = num_extract = 0;
355 for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
356 if (node->type != TN_NEWDIR) {
358 if (node->extract || node->extract_dir) {
363 bsendmsg(ua, "%s total files/dirs. %s marked to be restored.\n",
364 edit_uint64_with_commas(total, ec1),
365 edit_uint64_with_commas(num_extract, ec2));
369 static int findcmd(UAContext *ua, TREE_CTX *tree)
374 bsendmsg(ua, _("No file specification given.\n"));
378 for (int i=1; i < ua->argc; i++) {
379 for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
380 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
382 tree_getpath(node, cwd, sizeof(cwd));
385 } else if (node->extract_dir) {
390 bsendmsg(ua, "%s%s\n", tag, cwd);
399 static int lscmd(UAContext *ua, TREE_CTX *tree)
403 if (!tree_node_has_child(tree->node)) {
406 foreach_child(node, tree->node) {
407 if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
411 } else if (node->extract_dir) {
416 bsendmsg(ua, "%s%s%s\n", tag, node->fname, tree_node_has_child(node)?"/":"");
423 * Ls command that lists only the marked files
425 static void rlsmark(UAContext *ua, TREE_NODE *tnode)
428 if (!tree_node_has_child(tnode)) {
431 foreach_child(node, tnode) {
432 if ((ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) &&
433 (node->extract || node->extract_dir)) {
437 } else if (node->extract_dir) {
442 bsendmsg(ua, "%s%s%s\n", tag, node->fname, tree_node_has_child(node)?"/":"");
443 if (tree_node_has_child(node)) {
450 static int lsmarkcmd(UAContext *ua, TREE_CTX *tree)
452 rlsmark(ua, tree->node);
458 extern char *getuser(uid_t uid, char *name, int len);
459 extern char *getgroup(gid_t gid, char *name, int len);
462 * This is actually the long form used for "dir"
464 static void ls_output(char *buf, const char *fname, const char *tag, struct stat *statp)
469 char en1[30], en2[30];
472 p = encode_mode(statp->st_mode, buf);
473 n = sprintf(p, " %2d ", (uint32_t)statp->st_nlink);
475 n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid, en1, sizeof(en1)),
476 getgroup(statp->st_gid, en2, sizeof(en2)));
478 n = sprintf(p, "%8.8s ", edit_uint64(statp->st_size, ec1));
480 p = encode_time(statp->st_ctime, p);
483 for (f=fname; *f; ) {
491 * Like ls command, but give more detail on each file
493 static int dircmd(UAContext *ua, TREE_CTX *tree)
499 char cwd[1100], *pcwd;
501 if (!tree_node_has_child(tree->node)) {
502 bsendmsg(ua, "Node %s has no children.\n", tree->node->fname);
506 foreach_child(node, tree->node) {
508 if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
511 } else if (node->extract_dir) {
516 tree_getpath(node, cwd, sizeof(cwd));
518 fdbr.JobId = node->JobId;
520 * Strip / from soft links to directories.
521 * This is because soft links to files have a trailing slash
522 * when returned from tree_getpath, but db_get_file_attr...
523 * treats soft links as files, so they do not have a trailing
524 * slash like directory names.
526 if (node->type == TN_FILE && tree_node_has_child(node)) {
527 bstrncpy(buf, cwd, sizeof(buf));
529 int len = strlen(buf);
531 buf[len-1] = 0; /* strip trailing / */
536 if (db_get_file_attributes_record(ua->jcr, ua->db, pcwd, NULL, &fdbr)) {
538 decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
540 /* Something went wrong getting attributes -- print name */
541 memset(&statp, 0, sizeof(statp));
543 ls_output(buf, cwd, tag, &statp);
544 bsendmsg(ua, "%s\n", buf);
551 static int estimatecmd(UAContext *ua, TREE_CTX *tree)
553 int total, num_extract;
554 uint64_t total_bytes = 0;
560 total = num_extract = 0;
561 for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
562 if (node->type != TN_NEWDIR) {
564 /* If regular file, get size */
565 if (node->extract && node->type == TN_FILE) {
567 tree_getpath(node, cwd, sizeof(cwd));
569 fdbr.JobId = node->JobId;
570 if (db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
572 decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
573 if (S_ISREG(statp.st_mode) && statp.st_size > 0) {
574 total_bytes += statp.st_size;
577 /* Directory, count only */
578 } else if (node->extract || node->extract_dir) {
583 bsendmsg(ua, "%d total files; %d marked to be restored; %s bytes.\n",
584 total, num_extract, edit_uint64_with_commas(total_bytes, ec1));
590 static int helpcmd(UAContext *ua, TREE_CTX *tree)
594 bsendmsg(ua, _(" Command Description\n ======= ===========\n"));
595 for (i=0; i<comsize; i++) {
596 bsendmsg(ua, _(" %-10s %s\n"), _(commands[i].key), _(commands[i].help));
603 * Change directories. Note, if the user specifies x: and it fails,
604 * we assume it is a Win32 absolute cd rather than relative and
605 * try a second time with /x: ... Win32 kludge.
607 static int cdcmd(UAContext *ua, TREE_CTX *tree)
615 node = tree_cwd(ua->argk[1], tree->root, tree->node);
617 /* Try once more if Win32 drive -- make absolute */
618 if (ua->argk[1][1] == ':') { /* win32 drive */
619 bstrncpy(cwd, "/", sizeof(cwd));
620 bstrncat(cwd, ua->argk[1], sizeof(cwd));
621 node = tree_cwd(cwd, tree->root, tree->node);
624 bsendmsg(ua, _("Invalid path given.\n"));
631 tree_getpath(tree->node, cwd, sizeof(cwd));
632 bsendmsg(ua, _("cwd is: %s\n"), cwd);
636 static int pwdcmd(UAContext *ua, TREE_CTX *tree)
639 tree_getpath(tree->node, cwd, sizeof(cwd));
640 bsendmsg(ua, _("cwd is: %s\n"), cwd);
645 static int unmarkcmd(UAContext *ua, TREE_CTX *tree)
650 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
651 bsendmsg(ua, _("No files unmarked.\n"));
654 for (int i=1; i < ua->argc; i++) {
655 foreach_child(node, tree->node) {
656 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
657 count += set_extract(ua, node, tree, false);
662 bsendmsg(ua, _("No files unmarked.\n"));
664 bsendmsg(ua, _("%d file%s unmarked.\n"), count, count==0?"":"s");
669 static int unmarkdircmd(UAContext *ua, TREE_CTX *tree)
674 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
675 bsendmsg(ua, _("No directories unmarked.\n"));
679 for (int i=1; i < ua->argc; i++) {
680 foreach_child(node, tree->node) {
681 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
682 if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
683 node->extract_dir = false;
691 bsendmsg(ua, _("No directories unmarked.\n"));
693 bsendmsg(ua, _("%d director%s unmarked.\n"), count, count==1?"y":"ies");
699 static int donecmd(UAContext *ua, TREE_CTX *tree)
704 static int quitcmd(UAContext *ua, TREE_CTX *tree)