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-2004 Kern Sibbald and John Walker
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,
35 #include "findlib/find.h"
38 /* Forward referenced commands */
40 static int markcmd(UAContext *ua, TREE_CTX *tree);
41 static int markdircmd(UAContext *ua, TREE_CTX *tree);
42 static int countcmd(UAContext *ua, TREE_CTX *tree);
43 static int findcmd(UAContext *ua, TREE_CTX *tree);
44 static int lscmd(UAContext *ua, TREE_CTX *tree);
45 static int lsmarkcmd(UAContext *ua, TREE_CTX *tree);
46 static int dircmd(UAContext *ua, TREE_CTX *tree);
47 static int estimatecmd(UAContext *ua, TREE_CTX *tree);
48 static int helpcmd(UAContext *ua, TREE_CTX *tree);
49 static int cdcmd(UAContext *ua, TREE_CTX *tree);
50 static int pwdcmd(UAContext *ua, TREE_CTX *tree);
51 static int unmarkcmd(UAContext *ua, TREE_CTX *tree);
52 static int unmarkdircmd(UAContext *ua, TREE_CTX *tree);
53 static int quitcmd(UAContext *ua, TREE_CTX *tree);
54 static int donecmd(UAContext *ua, TREE_CTX *tree);
57 struct cmdstruct { const char *key; int (*func)(UAContext *ua, TREE_CTX *tree); const char *help; };
58 static struct cmdstruct commands[] = {
59 { N_("cd"), cdcmd, _("change current directory")},
60 { N_("count"), countcmd, _("count marked files in and below the cd")},
61 { N_("dir"), dircmd, _("list current directory")},
62 { N_("done"), donecmd, _("leave file selection mode")},
63 { N_("estimate"), estimatecmd, _("estimate restore size")},
64 { N_("exit"), donecmd, _("exit = done")},
65 { N_("find"), findcmd, _("find files -- wildcards allowed")},
66 { N_("help"), helpcmd, _("print help")},
67 { N_("ls"), lscmd, _("list current directory -- wildcards allowed")},
68 { N_("lsmark"), lsmarkcmd, _("list the marked files in and below the cd")},
69 { N_("mark"), markcmd, _("mark file to be restored")},
70 { N_("markdir"), markdircmd, _("mark directory entry to be restored -- nonrecursive")},
71 { N_("pwd"), pwdcmd, _("print current working directory")},
72 { N_("unmark"), unmarkcmd, _("unmark file to be restored")},
73 { N_("unmarkdir"), unmarkdircmd, _("unmark directory -- no recursion")},
74 { N_("quit"), quitcmd, _("quit")},
75 { N_("?"), helpcmd, _("print help")},
77 #define comsize (sizeof(commands)/sizeof(struct cmdstruct))
81 * Enter a prompt mode where the user can select/deselect
82 * files to be restored. This is sort of like a mini-shell
83 * that allows "cd", "pwd", "add", "rm", ...
85 bool user_select_files_from_tree(TREE_CTX *tree)
89 /* Get a new context so we don't destroy restore command args */
90 UAContext *ua = new_ua_context(tree->ua->jcr);
91 ua->UA_sock = tree->ua->UA_sock; /* patch in UA socket */
94 "\nYou are now entering file selection mode where you add and\n"
95 "remove files to be restored. All files are initially added.\n"
96 "Enter \"done\" to leave this mode.\n\n"));
98 * Enter interactive command handler allowing selection
99 * of individual files.
101 tree->node = (TREE_NODE *)tree->root;
102 tree_getpath(tree->node, cwd, sizeof(cwd));
103 bsendmsg(tree->ua, _("cwd is: %s\n"), cwd);
106 if (!get_cmd(ua, "$ ")) {
114 len = strlen(ua->argk[0]);
117 for (i=0; i<(int)comsize; i++) /* search for command */
118 if (strncasecmp(ua->argk[0], _(commands[i].key), len) == 0) {
119 stat = (*commands[i].func)(ua, tree); /* go execute command */
124 bsendmsg(tree->ua, _("Illegal command. Enter \"done\" to exit.\n"));
131 ua->UA_sock = NULL; /* don't release restore socket */
134 free_ua_context(ua); /* get rid of temp UA context */
140 * This callback routine is responsible for inserting the
141 * items it gets into the directory tree. For each JobId selected
142 * this routine is called once for each file. We do not allow
143 * duplicate filenames, but instead keep the info from the most
144 * recent file entered (i.e. the JobIds are assumed to be sorted)
146 * See uar_sel_files in sql_cmds.c for query that calls us.
147 * row[0]=Path, row[1]=Filename, row[2]=FileIndex
148 * row[3]=JobId row[4]=LStat
150 int insert_tree_handler(void *ctx, int num_fields, char **row)
153 TREE_CTX *tree = (TREE_CTX *)ctx;
160 strip_trailing_junk(row[1]);
161 if (*row[1] == 0) { /* no filename => directory */
162 if (*row[0] != '/') { /* Must be Win32 directory */
170 hard_link = (decode_LinkFI(row[4], &statp) != 0);
171 node = insert_tree_node(row[0], row[1], NULL, tree->root, NULL);
172 /* Note, if node already exists, save new one for next time */
173 JobId = (JobId_t)str_to_int64(row[3]);
174 FileIndex = atoi(row[2]);
176 * - The first time we see a file (node->inserted==true), we accept it.
177 * - In the same JobId, we accept only the first copy of a
178 * hard linked file (the others are simply pointers).
179 * - In the same JobId, we accept the last copy of any other
180 * file -- in particular directories.
182 * All the code to set ok could be condensed to a single
183 * line, but it would be even harder to read.
186 if (!node->inserted && JobId == node->JobId) {
187 if ((hard_link && FileIndex > node->FileIndex) ||
188 (!hard_link && FileIndex < node->FileIndex)) {
193 node->hard_link = hard_link;
194 node->FileIndex = FileIndex;
197 node->soft_link = S_ISLNK(statp.st_mode) != 0;
199 node->extract = true; /* extract all by default */
200 if (type == TN_DIR || type == TN_DIR_NLS) {
201 node->extract_dir = true; /* if dir, extract it */
211 * Set extract to value passed. We recursively walk
212 * down the tree setting all children if the
213 * node is a directory.
215 static int set_extract(UAContext *ua, TREE_NODE *node, TREE_CTX *tree, bool extract)
222 node->extract = extract;
223 if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
224 node->extract_dir = extract; /* set/clear dir too */
226 if (node->type != TN_NEWDIR) {
229 /* For a non-file (i.e. directory), we see all the children */
230 if (node->type != TN_FILE || (node->soft_link && tree_node_has_child(node))) {
231 /* Recursive set children within directory */
232 foreach_child(n, node) {
233 count += set_extract(ua, n, tree, extract);
236 * Walk up tree marking any unextracted parent to be
240 while (node->parent && !node->parent->extract_dir) {
242 node->extract_dir = true;
245 } else if (extract) {
248 * Ordinary file, we get the full path, look up the
249 * attributes, decode them, and if we are hard linked to
250 * a file that was saved, we must load that file too.
252 tree_getpath(node, cwd, sizeof(cwd));
254 fdbr.JobId = node->JobId;
255 if (node->hard_link && db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
257 decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
259 * If we point to a hard linked file, traverse the tree to
260 * find that file, and mark it to be restored as well. It
261 * must have the Link we just obtained and the same JobId.
264 for (n=first_tree_node(tree->root); n; n=next_tree_node(n)) {
265 if (n->FileIndex == LinkFI && n->JobId == node->JobId) {
267 if (n->type == TN_DIR || n->type == TN_DIR_NLS) {
268 n->extract_dir = true;
280 * Recursively mark the current directory to be restored as
281 * well as all directories and files below it.
283 static int markcmd(UAContext *ua, TREE_CTX *tree)
288 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
289 bsendmsg(ua, _("No files marked.\n"));
292 for (int i=1; i < ua->argc; i++) {
293 foreach_child(node, tree->node) {
294 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
295 count += set_extract(ua, node, tree, true);
300 bsendmsg(ua, _("No files marked.\n"));
302 bsendmsg(ua, _("%d file%s marked.\n"), count, count==0?"":"s");
307 static int markdircmd(UAContext *ua, TREE_CTX *tree)
312 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
313 bsendmsg(ua, _("No files marked.\n"));
316 for (int i=1; i < ua->argc; i++) {
317 foreach_child(node, tree->node) {
318 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
319 if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
320 node->extract_dir = true;
327 bsendmsg(ua, _("No directories marked.\n"));
329 bsendmsg(ua, _("%d director%s marked.\n"), count, count==1?"y":"ies");
335 static int countcmd(UAContext *ua, TREE_CTX *tree)
337 int total, num_extract;
339 total = num_extract = 0;
340 for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
341 if (node->type != TN_NEWDIR) {
343 if (node->extract || node->extract_dir) {
348 bsendmsg(ua, "%d total files/dirs. %d marked to be restored.\n", total, num_extract);
352 static int findcmd(UAContext *ua, TREE_CTX *tree)
357 bsendmsg(ua, _("No file specification given.\n"));
361 for (int i=1; i < ua->argc; i++) {
362 for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
363 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
365 tree_getpath(node, cwd, sizeof(cwd));
368 } else if (node->extract_dir) {
373 bsendmsg(ua, "%s%s\n", tag, cwd);
382 static int lscmd(UAContext *ua, TREE_CTX *tree)
386 if (!tree_node_has_child(tree->node)) {
389 foreach_child(node, tree->node) {
390 if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
394 } else if (node->extract_dir) {
399 bsendmsg(ua, "%s%s%s\n", tag, node->fname, tree_node_has_child(node)?"/":"");
406 * Ls command that lists only the marked files
408 static void rlsmark(UAContext *ua, TREE_NODE *node)
410 if (!tree_node_has_child(node)) {
413 foreach_child(node, node) {
414 if ((ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) &&
415 (node->extract || node->extract_dir)) {
419 } else if (node->extract_dir) {
424 bsendmsg(ua, "%s%s%s\n", tag, node->fname, tree_node_has_child(node)?"/":"");
425 if (tree_node_has_child(node)) {
432 static int lsmarkcmd(UAContext *ua, TREE_CTX *tree)
434 rlsmark(ua, tree->node);
440 extern char *getuser(uid_t uid);
441 extern char *getgroup(gid_t gid);
444 * This is actually the long form used for "dir"
446 static void ls_output(char *buf, const char *fname, const char *tag, struct stat *statp)
453 p = encode_mode(statp->st_mode, buf);
454 n = sprintf(p, " %2d ", (uint32_t)statp->st_nlink);
456 n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid), getgroup(statp->st_gid));
458 n = sprintf(p, "%8.8s ", edit_uint64(statp->st_size, ec1));
460 p = encode_time(statp->st_ctime, p);
463 for (f=fname; *f; ) {
471 * Like ls command, but give more detail on each file
473 static int dircmd(UAContext *ua, TREE_CTX *tree)
479 char cwd[1100], *pcwd;
481 if (!tree_node_has_child(tree->node)) {
482 bsendmsg(ua, "Node %s has no children.\n", tree->node->fname);
486 foreach_child(node, tree->node) {
488 if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
491 } else if (node->extract_dir) {
496 tree_getpath(node, cwd, sizeof(cwd));
498 fdbr.JobId = node->JobId;
500 * Strip / from soft links to directories.
501 * This is because soft links to files have a trailing slash
502 * when returned from tree_getpath, but db_get_file_attr...
503 * treats soft links as files, so they do not have a trailing
504 * slash like directory names.
506 if (node->type == TN_FILE && tree_node_has_child(node)) {
507 bstrncpy(buf, cwd, sizeof(buf));
509 int len = strlen(buf);
511 buf[len-1] = 0; /* strip trailing / */
516 if (db_get_file_attributes_record(ua->jcr, ua->db, pcwd, NULL, &fdbr)) {
518 decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
520 /* Something went wrong getting attributes -- print name */
521 memset(&statp, 0, sizeof(statp));
523 ls_output(buf, cwd, tag, &statp);
524 bsendmsg(ua, "%s\n", buf);
531 static int estimatecmd(UAContext *ua, TREE_CTX *tree)
533 int total, num_extract;
534 uint64_t total_bytes = 0;
540 total = num_extract = 0;
541 for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
542 if (node->type != TN_NEWDIR) {
544 /* If regular file, get size */
545 if (node->extract && node->type == TN_FILE) {
547 tree_getpath(node, cwd, sizeof(cwd));
549 fdbr.JobId = node->JobId;
550 if (db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
552 decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
553 if (S_ISREG(statp.st_mode) && statp.st_size > 0) {
554 total_bytes += statp.st_size;
557 /* Directory, count only */
558 } else if (node->extract || node->extract_dir) {
563 bsendmsg(ua, "%d total files; %d marked to be restored; %s bytes.\n",
564 total, num_extract, edit_uint64_with_commas(total_bytes, ec1));
570 static int helpcmd(UAContext *ua, TREE_CTX *tree)
575 bsendmsg(ua, _(" Command Description\n ======= ===========\n"));
576 for (i=0; i<comsize; i++) {
577 bsendmsg(ua, _(" %-10s %s\n"), _(commands[i].key), _(commands[i].help));
584 * Change directories. Note, if the user specifies x: and it fails,
585 * we assume it is a Win32 absolute cd rather than relative and
586 * try a second time with /x: ... Win32 kludge.
588 static int cdcmd(UAContext *ua, TREE_CTX *tree)
596 node = tree_cwd(ua->argk[1], tree->root, tree->node);
598 /* Try once more if Win32 drive -- make absolute */
599 if (ua->argk[1][1] == ':') { /* win32 drive */
600 bstrncpy(cwd, "/", sizeof(cwd));
601 bstrncat(cwd, ua->argk[1], sizeof(cwd));
602 node = tree_cwd(cwd, tree->root, tree->node);
605 bsendmsg(ua, _("Invalid path given.\n"));
612 tree_getpath(tree->node, cwd, sizeof(cwd));
613 bsendmsg(ua, _("cwd is: %s\n"), cwd);
617 static int pwdcmd(UAContext *ua, TREE_CTX *tree)
620 tree_getpath(tree->node, cwd, sizeof(cwd));
621 bsendmsg(ua, _("cwd is: %s\n"), cwd);
626 static int unmarkcmd(UAContext *ua, TREE_CTX *tree)
631 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
632 bsendmsg(ua, _("No files unmarked.\n"));
635 for (int i=1; i < ua->argc; i++) {
636 foreach_child(node, tree->node) {
637 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
638 count += set_extract(ua, node, tree, false);
643 bsendmsg(ua, _("No files unmarked.\n"));
645 bsendmsg(ua, _("%d file%s unmarked.\n"), count, count==0?"":"s");
650 static int unmarkdircmd(UAContext *ua, TREE_CTX *tree)
655 if (ua->argc < 2 || !tree_node_has_child(tree->node)) {
656 bsendmsg(ua, _("No directories unmarked.\n"));
660 for (int i=1; i < ua->argc; i++) {
661 foreach_child(node, tree->node) {
662 if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
663 if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
664 node->extract_dir = false;
672 bsendmsg(ua, _("No directories unmarked.\n"));
674 bsendmsg(ua, _("%d director%s unmarked.\n"), count, count==1?"y":"ies");
680 static int donecmd(UAContext *ua, TREE_CTX *tree)
685 static int quitcmd(UAContext *ua, TREE_CTX *tree)