]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_tree.c
Restore all/done updates
[bacula/bacula] / bacula / src / dird / ua_tree.c
1 /*
2  *
3  *   Bacula Director -- User Agent Database File tree for Restore
4  *      command. This file interacts with the user implementing the
5  *      UA tree commands.
6  *
7  *     Kern Sibbald, July MMII
8  *
9  *   Version $Id$
10  */
11
12 /*
13    Copyright (C) 2002-2004 Kern Sibbald and John Walker
14
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.
19
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.
24
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,
28    MA 02111-1307, USA.
29
30  */
31
32 #include "bacula.h"
33 #include "dird.h"
34 #include <fnmatch.h>
35 #include "findlib/find.h"
36
37
38 /* Forward referenced commands */
39
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);
55
56
57 struct cmdstruct { char *key; int (*func)(UAContext *ua, TREE_CTX *tree); 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")},    
76              };
77 #define comsize (sizeof(commands)/sizeof(struct cmdstruct))
78
79
80 /*
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", ...
84  */
85 bool user_select_files_from_tree(TREE_CTX *tree)
86 {
87    char cwd[2000];
88    bool stat;
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 */
92
93    bsendmsg(tree->ua, _( 
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"));
97    /*
98     * Enter interactive command handler allowing selection
99     *  of individual files.
100     */
101    tree->node = (TREE_NODE *)tree->root;
102    tree_getpath(tree->node, cwd, sizeof(cwd));
103    bsendmsg(tree->ua, _("cwd is: %s\n"), cwd);
104    for ( ;; ) {       
105       int found, len, i;
106       if (!get_cmd(ua, "$ ")) {
107          break;
108       }
109       parse_ua_args(ua);
110       if (ua->argc == 0) {
111          break;
112       }
113
114       len = strlen(ua->argk[0]);
115       found = 0;
116       stat = false;
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 */
120             found = 1;
121             break;
122          }
123       if (!found) {
124          bsendmsg(tree->ua, _("Illegal command. Enter \"done\" to exit.\n"));
125          continue;
126       }
127       if (!stat) {
128          break;
129       }
130    }
131    ua->UA_sock = NULL;                /* don't release restore socket */
132    stat = !ua->quit;
133    ua->quit = false;
134    free_ua_context(ua);               /* get rid of temp UA context */
135    return stat;
136 }
137
138
139 /*
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)
145  *
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
149  */
150 int insert_tree_handler(void *ctx, int num_fields, char **row)
151 {
152    struct stat statp;
153    TREE_CTX *tree = (TREE_CTX *)ctx;
154    char fname[5000];
155    TREE_NODE *node, *new_node;
156    int type;
157    bool hard_link;
158
159    strip_trailing_junk(row[1]);
160    if (*row[1] == 0) {                /* no filename => directory */
161       if (*row[0] != '/') {           /* Must be Win32 directory */
162          type = TN_DIR_NLS;
163       } else {
164          type = TN_DIR;
165       }
166    } else {
167       type = TN_FILE;
168    }
169    if (tree->avail_node) {
170       node = tree->avail_node;        /* if prev node avail use it */
171    } else {
172       node = new_tree_node(tree->root, type);  /* get new node */
173       tree->avail_node = node;
174    }
175    hard_link = (decode_LinkFI(row[4], &statp) != 0);
176    bsnprintf(fname, sizeof(fname), "%s%s%s", row[0], row[1], "");
177 //    S_ISLNK(statp.st_mode)?" ->":"");
178    Dmsg3(200, "FI=%d type=%d fname=%s\n", node->FileIndex, type, fname);
179    new_node = insert_tree_node(fname, node, tree->root, NULL);
180    /* Note, if node already exists, save new one for next time */
181    if (new_node != node) {
182       tree->avail_node = node;        /* node already exists */
183    } else {
184       tree->avail_node = NULL;        /* added node to tree */
185    }
186    /*
187     * If the user has backed up a hard linked file twice, the
188     *  second copy will be a pointer (i.e. hard link will be set),
189     *  so we do not overwrite the original file with a pointer file.
190     */
191    if (!new_node->hard_link || hard_link) {
192       new_node->hard_link = hard_link;
193       new_node->FileIndex = atoi(row[2]);
194       new_node->JobId = (JobId_t)str_to_int64(row[3]);
195       new_node->type = type;
196       new_node->soft_link = S_ISLNK(statp.st_mode) != 0;
197       if (tree->all) {
198          new_node->extract = true;          /* extract all by default */
199          if (type == TN_DIR || type == TN_DIR_NLS) {
200             new_node->extract_dir = true;   /* if dir, extract it */
201          }
202       }
203    }
204    tree->cnt++;
205    return 0;
206 }
207
208
209 /*
210  * Set extract to value passed. We recursively walk
211  *  down the tree setting all children if the 
212  *  node is a directory.
213  */
214 static int set_extract(UAContext *ua, TREE_NODE *node, TREE_CTX *tree, bool extract)
215 {
216    TREE_NODE *n;
217    FILE_DBR fdbr;
218    struct stat statp;
219    int count = 0;
220
221    node->extract = extract;
222    if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
223       node->extract_dir = extract;    /* set/clear dir too */
224    }
225    if (node->type != TN_NEWDIR) {
226       count++;
227    }
228    /* For a non-file (i.e. directory), we see all the children */
229    if (node->type != TN_FILE || (node->soft_link && node->child)) {
230       /* Recursive set children within directory */
231       for (n=node->child; n; n=n->sibling) {
232          count += set_extract(ua, n, tree, extract);
233       }
234       /*
235        * Walk up tree marking any unextracted parent to be
236        * extracted.
237        */
238       if (extract) {
239          while (node->parent && !node->parent->extract_dir) {
240             node = node->parent;
241             node->extract_dir = true;
242          }
243       }
244    } else if (extract) {
245       char cwd[2000];
246       /*
247        * Ordinary file, we get the full path, look up the
248        * attributes, decode them, and if we are hard linked to
249        * a file that was saved, we must load that file too.
250        */
251       tree_getpath(node, cwd, sizeof(cwd));
252       fdbr.FileId = 0;
253       fdbr.JobId = node->JobId;
254       if (node->hard_link && db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
255          int32_t LinkFI;
256          decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
257          /*
258           * If we point to a hard linked file, traverse the tree to
259           * find that file, and mark it to be restored as well. It
260           * must have the Link we just obtained and the same JobId.
261           */
262          if (LinkFI) {
263             for (n=first_tree_node(tree->root); n; n=next_tree_node(n)) {
264                if (n->FileIndex == LinkFI && n->JobId == node->JobId) {
265                   n->extract = true;
266                   if (n->type == TN_DIR || n->type == TN_DIR_NLS) {
267                      n->extract_dir = true;
268                   }
269                   break;
270                }
271             }
272          }
273       }
274    }
275    return count;
276 }
277
278 /*
279  * Recursively mark the current directory to be restored as 
280  *  well as all directories and files below it.
281  */
282 static int markcmd(UAContext *ua, TREE_CTX *tree)
283 {
284    TREE_NODE *node;
285    int count = 0;
286
287    if (ua->argc < 2 || !tree->node->child) {
288       bsendmsg(ua, _("No files marked.\n"));
289       return 1;
290    }
291    for (int i=1; i < ua->argc; i++) {
292       for (node = tree->node->child; node; node=node->sibling) {
293          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
294             count += set_extract(ua, node, tree, true);
295          }
296       }
297    }
298    if (count == 0) {
299       bsendmsg(ua, _("No files marked.\n"));
300    } else {
301       bsendmsg(ua, _("%d file%s marked.\n"), count, count==0?"":"s");
302    }
303    return 1;
304 }
305
306 static int markdircmd(UAContext *ua, TREE_CTX *tree)
307 {
308    TREE_NODE *node;
309    int count = 0;
310
311    if (ua->argc < 2 || !tree->node->child) {
312       bsendmsg(ua, _("No files marked.\n"));
313       return 1;
314    }
315    for (int i=1; i < ua->argc; i++) {
316       for (node = tree->node->child; node; node=node->sibling) {
317          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
318             if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
319                node->extract_dir = true;
320                count++;
321             }
322          }
323       }
324    }
325    if (count == 0) {
326       bsendmsg(ua, _("No directories marked.\n"));
327    } else {
328       bsendmsg(ua, _("%d director%s marked.\n"), count, count==1?"y":"ies");
329    }
330    return 1;
331 }
332
333
334 static int countcmd(UAContext *ua, TREE_CTX *tree)
335 {
336    int total, num_extract;
337
338    total = num_extract = 0;
339    for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
340       if (node->type != TN_NEWDIR) {
341          total++;
342          if (node->extract || node->extract_dir) {
343             num_extract++;
344          }
345       }
346    }
347    bsendmsg(ua, "%d total files/dirs. %d marked to be restored.\n", total, num_extract);
348    return 1;
349 }
350
351 static int findcmd(UAContext *ua, TREE_CTX *tree)
352 {
353    char cwd[2000];
354
355    if (ua->argc == 1) {
356       bsendmsg(ua, _("No file specification given.\n"));
357       return 0;
358    }
359    
360    for (int i=1; i < ua->argc; i++) {
361       for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
362          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
363             char *tag;
364             tree_getpath(node, cwd, sizeof(cwd));
365             if (node->extract) {
366                tag = "*";
367             } else if (node->extract_dir) {
368                tag = "+";
369             } else {
370                tag = "";
371             }
372             bsendmsg(ua, "%s%s\n", tag, cwd);
373          }
374       }
375    }
376    return 1;
377 }
378
379
380
381 static int lscmd(UAContext *ua, TREE_CTX *tree)
382 {
383    TREE_NODE *node;
384
385    if (!tree->node->child) {     
386       return 1;
387    }
388    for (node = tree->node->child; node; node=node->sibling) {
389       if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
390          char *tag;
391          if (node->extract) {
392             tag = "*";
393          } else if (node->extract_dir) {
394             tag = "+";
395          } else {
396             tag = "";
397          }
398          bsendmsg(ua, "%s%s%s\n", tag, node->fname, node->child?"/":"");
399       }
400    }
401    return 1;
402 }
403
404 /*
405  * Ls command that lists only the marked files
406  */
407 static void rlsmark(UAContext *ua, TREE_NODE *node) 
408 {
409    if (!node->child) {     
410       return;
411    }
412    for (node = node->child; node; node=node->sibling) {
413       if ((ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) &&
414           (node->extract || node->extract_dir)) {
415          char *tag;
416          if (node->extract) {
417             tag = "*";
418          } else if (node->extract_dir) {
419             tag = "+";
420          } else {
421             tag = "";
422          }
423          bsendmsg(ua, "%s%s%s\n", tag, node->fname, node->child?"/":"");
424          if (node->child) {
425             rlsmark(ua, node);
426          }
427       }
428    }
429 }
430
431 static int lsmarkcmd(UAContext *ua, TREE_CTX *tree)
432 {
433    rlsmark(ua, tree->node);
434    return 1;
435 }
436
437
438
439 extern char *getuser(uid_t uid);
440 extern char *getgroup(gid_t gid);
441
442 /*
443  * This is actually the long form used for "dir"
444  */
445 static void ls_output(char *buf, char *fname, char *tag, struct stat *statp)
446 {
447    char *p, *f;
448    char ec1[30];
449    int n;
450
451    p = encode_mode(statp->st_mode, buf);
452    n = sprintf(p, "  %2d ", (uint32_t)statp->st_nlink);
453    p += n;
454    n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid), getgroup(statp->st_gid));
455    p += n;
456    n = sprintf(p, "%8.8s  ", edit_uint64(statp->st_size, ec1));
457    p += n;
458    p = encode_time(statp->st_ctime, p);
459    *p++ = ' ';
460    *p++ = *tag;
461    for (f=fname; *f; ) {
462       *p++ = *f++;
463    }
464    *p = 0;
465 }
466
467
468 /*
469  * Like ls command, but give more detail on each file
470  */
471 static int dircmd(UAContext *ua, TREE_CTX *tree)
472 {
473    TREE_NODE *node;
474    FILE_DBR fdbr;
475    struct stat statp;
476    char buf[1100];
477    char cwd[1100], *pcwd;
478
479    if (!tree->node->child) {     
480       return 1;
481    }
482    for (node = tree->node->child; node; node=node->sibling) {
483       char *tag;
484       if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
485          if (node->extract) {
486             tag = "*";
487          } else if (node->extract_dir) {
488             tag = "+";
489          } else {
490             tag = " ";
491          }
492          tree_getpath(node, cwd, sizeof(cwd));
493          fdbr.FileId = 0;
494          fdbr.JobId = node->JobId;
495          /*
496           * Strip / from soft links to directories.
497           *   This is because soft links to files have a trailing slash
498           *   when returned from tree_getpath, but db_get_file_attr...
499           *   treats soft links as files, so they do not have a trailing
500           *   slash like directory names.
501           */
502          if (node->type == TN_FILE && node->child) {
503             bstrncpy(buf, cwd, sizeof(buf));
504             pcwd = buf;
505             int len = strlen(buf);
506             if (len > 1) {
507                buf[len-1] = 0;        /* strip trailing / */
508             }
509          } else {
510             pcwd = cwd;
511          }
512          if (db_get_file_attributes_record(ua->jcr, ua->db, pcwd, NULL, &fdbr)) {
513             int32_t LinkFI;
514             decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
515          } else {
516             /* Something went wrong getting attributes -- print name */
517             memset(&statp, 0, sizeof(statp));
518          }
519          ls_output(buf, cwd, tag, &statp);
520          bsendmsg(ua, "%s\n", buf);
521       }
522    }
523    return 1;
524 }
525
526
527 static int estimatecmd(UAContext *ua, TREE_CTX *tree)
528 {
529    int total, num_extract;
530    uint64_t total_bytes = 0;
531    FILE_DBR fdbr;
532    struct stat statp;
533    char cwd[1100];
534    char ec1[50];
535
536    total = num_extract = 0;
537    for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
538       if (node->type != TN_NEWDIR) {
539          total++;
540          /* If regular file, get size */
541          if (node->extract && node->type == TN_FILE) {
542             num_extract++;
543             tree_getpath(node, cwd, sizeof(cwd));
544             fdbr.FileId = 0;
545             fdbr.JobId = node->JobId;
546             if (db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
547                int32_t LinkFI;
548                decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
549                if (S_ISREG(statp.st_mode) && statp.st_size > 0) {
550                   total_bytes += statp.st_size;
551                }
552             }
553          /* Directory, count only */
554          } else if (node->extract || node->extract_dir) {
555             num_extract++;
556          }
557       }
558    }
559    bsendmsg(ua, "%d total files; %d marked to be restored; %s bytes.\n", 
560             total, num_extract, edit_uint64_with_commas(total_bytes, ec1));
561    return 1;
562 }
563
564
565
566 static int helpcmd(UAContext *ua, TREE_CTX *tree) 
567 {
568    unsigned int i;
569
570 /* usage(); */
571    bsendmsg(ua, _("  Command    Description\n  =======    ===========\n"));
572    for (i=0; i<comsize; i++) {
573       bsendmsg(ua, _("  %-10s %s\n"), _(commands[i].key), _(commands[i].help));
574    }
575    bsendmsg(ua, "\n");
576    return 1;
577 }
578
579 /*
580  * Change directories.  Note, if the user specifies x: and it fails,
581  *   we assume it is a Win32 absolute cd rather than relative and
582  *   try a second time with /x: ...  Win32 kludge.
583  */
584 static int cdcmd(UAContext *ua, TREE_CTX *tree) 
585 {
586    TREE_NODE *node;
587    char cwd[2000];
588
589    if (ua->argc != 2) {
590       return 1;
591    }
592    node = tree_cwd(ua->argk[1], tree->root, tree->node);
593    if (!node) {
594       /* Try once more if Win32 drive -- make absolute */
595       if (ua->argk[1][1] == ':') {  /* win32 drive */
596          bstrncpy(cwd, "/", sizeof(cwd));
597          bstrncat(cwd, ua->argk[1], sizeof(cwd));
598          node = tree_cwd(cwd, tree->root, tree->node);
599       }
600       if (!node) {
601          bsendmsg(ua, _("Invalid path given.\n"));
602       } else {
603          tree->node = node;
604       }
605    } else {
606       tree->node = node;
607    }
608    tree_getpath(tree->node, cwd, sizeof(cwd));
609    bsendmsg(ua, _("cwd is: %s\n"), cwd);
610    return 1;
611 }
612
613 static int pwdcmd(UAContext *ua, TREE_CTX *tree) 
614 {
615    char cwd[2000];
616    tree_getpath(tree->node, cwd, sizeof(cwd));
617    bsendmsg(ua, _("cwd is: %s\n"), cwd);
618    return 1;
619 }
620
621
622 static int unmarkcmd(UAContext *ua, TREE_CTX *tree)
623 {
624    TREE_NODE *node;
625    int count = 0;
626
627    if (ua->argc < 2 || !tree->node->child) {     
628       bsendmsg(ua, _("No files unmarked.\n"));
629       return 1;
630    }
631    for (int i=1; i < ua->argc; i++) {
632       for (node = tree->node->child; node; node=node->sibling) {
633          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
634             count += set_extract(ua, node, tree, false);
635          }
636       }
637    }
638    if (count == 0) {
639       bsendmsg(ua, _("No files unmarked.\n"));
640    } else {
641       bsendmsg(ua, _("%d file%s unmarked.\n"), count, count==0?"":"s");
642    }
643    return 1;
644 }
645
646 static int unmarkdircmd(UAContext *ua, TREE_CTX *tree)
647 {
648    TREE_NODE *node;
649    int count = 0;
650
651    if (ua->argc < 2 || !tree->node->child) {
652       bsendmsg(ua, _("No directories unmarked.\n"));
653       return 1;
654    }
655
656    for (int i=1; i < ua->argc; i++) {
657       for (node = tree->node->child; node; node=node->sibling) {
658          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
659             if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
660                node->extract_dir = false;
661                count++;
662             }
663          }
664       }
665    }
666
667    if (count == 0) {
668       bsendmsg(ua, _("No directories unmarked.\n"));
669    } else {
670       bsendmsg(ua, _("%d director%s unmarked.\n"), count, count==1?"y":"ies");
671    }
672    return 1;
673 }
674
675
676 static int donecmd(UAContext *ua, TREE_CTX *tree) 
677 {
678    return 0;
679 }
680
681 static int quitcmd(UAContext *ua, TREE_CTX *tree) 
682 {
683    ua->quit = true;
684    return 0;
685 }