]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_tree.c
Fix typo
[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->extract = true;          /* extract all by default */
197       new_node->soft_link = S_ISLNK(statp.st_mode) != 0;
198       if (type == TN_DIR || type == TN_DIR_NLS) {
199          new_node->extract_dir = true;   /* if dir, extract it */
200       }
201    }
202    tree->cnt++;
203    return 0;
204 }
205
206
207 /*
208  * Set extract to value passed. We recursively walk
209  *  down the tree setting all children if the 
210  *  node is a directory.
211  */
212 static int set_extract(UAContext *ua, TREE_NODE *node, TREE_CTX *tree, bool extract)
213 {
214    TREE_NODE *n;
215    FILE_DBR fdbr;
216    struct stat statp;
217    int count = 0;
218
219    node->extract = extract;
220    if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
221       node->extract_dir = extract;    /* set/clear dir too */
222    }
223    if (node->type != TN_NEWDIR) {
224       count++;
225    }
226    /* For a non-file (i.e. directory), we see all the children */
227    if (node->type != TN_FILE || (node->soft_link && node->child)) {
228       /* Recursive set children within directory */
229       for (n=node->child; n; n=n->sibling) {
230          count += set_extract(ua, n, tree, extract);
231       }
232       /*
233        * Walk up tree marking any unextracted parent to be
234        * extracted.
235        */
236       if (extract) {
237          while (node->parent && !node->parent->extract_dir) {
238             node = node->parent;
239             node->extract_dir = true;
240          }
241       }
242    } else if (extract) {
243       char cwd[2000];
244       /*
245        * Ordinary file, we get the full path, look up the
246        * attributes, decode them, and if we are hard linked to
247        * a file that was saved, we must load that file too.
248        */
249       tree_getpath(node, cwd, sizeof(cwd));
250       fdbr.FileId = 0;
251       fdbr.JobId = node->JobId;
252       if (node->hard_link && db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
253          int32_t LinkFI;
254          decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
255          /*
256           * If we point to a hard linked file, traverse the tree to
257           * find that file, and mark it to be restored as well. It
258           * must have the Link we just obtained and the same JobId.
259           */
260          if (LinkFI) {
261             for (n=first_tree_node(tree->root); n; n=next_tree_node(n)) {
262                if (n->FileIndex == LinkFI && n->JobId == node->JobId) {
263                   n->extract = true;
264                   if (n->type == TN_DIR || n->type == TN_DIR_NLS) {
265                      n->extract_dir = true;
266                   }
267                   break;
268                }
269             }
270          }
271       }
272    }
273    return count;
274 }
275
276 /*
277  * Recursively mark the current directory to be restored as 
278  *  well as all directories and files below it.
279  */
280 static int markcmd(UAContext *ua, TREE_CTX *tree)
281 {
282    TREE_NODE *node;
283    int count = 0;
284
285    if (ua->argc < 2 || !tree->node->child) {
286       bsendmsg(ua, _("No files marked.\n"));
287       return 1;
288    }
289    for (int i=1; i < ua->argc; i++) {
290       for (node = tree->node->child; node; node=node->sibling) {
291          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
292             count += set_extract(ua, node, tree, true);
293          }
294       }
295    }
296    if (count == 0) {
297       bsendmsg(ua, _("No files marked.\n"));
298    } else {
299       bsendmsg(ua, _("%d file%s marked.\n"), count, count==0?"":"s");
300    }
301    return 1;
302 }
303
304 static int markdircmd(UAContext *ua, TREE_CTX *tree)
305 {
306    TREE_NODE *node;
307    int count = 0;
308
309    if (ua->argc < 2 || !tree->node->child) {
310       bsendmsg(ua, _("No files marked.\n"));
311       return 1;
312    }
313    for (int i=1; i < ua->argc; i++) {
314       for (node = tree->node->child; node; node=node->sibling) {
315          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
316             if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
317                node->extract_dir = true;
318                count++;
319             }
320          }
321       }
322    }
323    if (count == 0) {
324       bsendmsg(ua, _("No directories marked.\n"));
325    } else {
326       bsendmsg(ua, _("%d director%s marked.\n"), count, count==1?"y":"ies");
327    }
328    return 1;
329 }
330
331
332 static int countcmd(UAContext *ua, TREE_CTX *tree)
333 {
334    int total, num_extract;
335
336    total = num_extract = 0;
337    for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
338       if (node->type != TN_NEWDIR) {
339          total++;
340          if (node->extract || node->extract_dir) {
341             num_extract++;
342          }
343       }
344    }
345    bsendmsg(ua, "%d total files/dirs. %d marked to be restored.\n", total, num_extract);
346    return 1;
347 }
348
349 static int findcmd(UAContext *ua, TREE_CTX *tree)
350 {
351    char cwd[2000];
352
353    if (ua->argc == 1) {
354       bsendmsg(ua, _("No file specification given.\n"));
355       return 0;
356    }
357    
358    for (int i=1; i < ua->argc; i++) {
359       for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
360          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
361             char *tag;
362             tree_getpath(node, cwd, sizeof(cwd));
363             if (node->extract) {
364                tag = "*";
365             } else if (node->extract_dir) {
366                tag = "+";
367             } else {
368                tag = "";
369             }
370             bsendmsg(ua, "%s%s\n", tag, cwd);
371          }
372       }
373    }
374    return 1;
375 }
376
377
378
379 static int lscmd(UAContext *ua, TREE_CTX *tree)
380 {
381    TREE_NODE *node;
382
383    if (!tree->node->child) {     
384       return 1;
385    }
386    for (node = tree->node->child; node; node=node->sibling) {
387       if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
388          char *tag;
389          if (node->extract) {
390             tag = "*";
391          } else if (node->extract_dir) {
392             tag = "+";
393          } else {
394             tag = "";
395          }
396          bsendmsg(ua, "%s%s%s\n", tag, node->fname, node->child?"/":"");
397       }
398    }
399    return 1;
400 }
401
402 /*
403  * Ls command that lists only the marked files
404  */
405 static int lsmarkcmd(UAContext *ua, TREE_CTX *tree)
406 {
407    TREE_NODE *node;
408
409    if (!tree->node->child) {     
410       return 1;
411    }
412    for (node = tree->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       }
425    }
426    return 1;
427 }
428
429
430 extern char *getuser(uid_t uid);
431 extern char *getgroup(gid_t gid);
432
433 /*
434  * This is actually the long form used for "dir"
435  */
436 static void ls_output(char *buf, char *fname, char *tag, struct stat *statp)
437 {
438    char *p, *f;
439    char ec1[30];
440    int n;
441
442    p = encode_mode(statp->st_mode, buf);
443    n = sprintf(p, "  %2d ", (uint32_t)statp->st_nlink);
444    p += n;
445    n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid), getgroup(statp->st_gid));
446    p += n;
447    n = sprintf(p, "%8.8s  ", edit_uint64(statp->st_size, ec1));
448    p += n;
449    p = encode_time(statp->st_ctime, p);
450    *p++ = ' ';
451    *p++ = *tag;
452    for (f=fname; *f; ) {
453       *p++ = *f++;
454    }
455    *p = 0;
456 }
457
458
459 /*
460  * Like ls command, but give more detail on each file
461  */
462 static int dircmd(UAContext *ua, TREE_CTX *tree)
463 {
464    TREE_NODE *node;
465    FILE_DBR fdbr;
466    struct stat statp;
467    char buf[1100];
468    char cwd[1100], *pcwd;
469
470    if (!tree->node->child) {     
471       return 1;
472    }
473    for (node = tree->node->child; node; node=node->sibling) {
474       char *tag;
475       if (ua->argc == 1 || fnmatch(ua->argk[1], node->fname, 0) == 0) {
476          if (node->extract) {
477             tag = "*";
478          } else if (node->extract_dir) {
479             tag = "+";
480          } else {
481             tag = " ";
482          }
483          tree_getpath(node, cwd, sizeof(cwd));
484          fdbr.FileId = 0;
485          fdbr.JobId = node->JobId;
486          /*
487           * Strip / from soft links to directories.
488           *   This is because soft links to files have a trailing slash
489           *   when returned from tree_getpath, but db_get_file_attr...
490           *   treats soft links as files, so they do not have a trailing
491           *   slash like directory names.
492           */
493          if (node->type == TN_FILE && node->child) {
494             bstrncpy(buf, cwd, sizeof(buf));
495             pcwd = buf;
496             int len = strlen(buf);
497             if (len > 1) {
498                buf[len-1] = 0;        /* strip trailing / */
499             }
500          } else {
501             pcwd = cwd;
502          }
503          if (db_get_file_attributes_record(ua->jcr, ua->db, pcwd, NULL, &fdbr)) {
504             int32_t LinkFI;
505             decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
506          } else {
507             /* Something went wrong getting attributes -- print name */
508             memset(&statp, 0, sizeof(statp));
509          }
510          ls_output(buf, cwd, tag, &statp);
511          bsendmsg(ua, "%s\n", buf);
512       }
513    }
514    return 1;
515 }
516
517
518 static int estimatecmd(UAContext *ua, TREE_CTX *tree)
519 {
520    int total, num_extract;
521    uint64_t total_bytes = 0;
522    FILE_DBR fdbr;
523    struct stat statp;
524    char cwd[1100];
525    char ec1[50];
526
527    total = num_extract = 0;
528    for (TREE_NODE *node=first_tree_node(tree->root); node; node=next_tree_node(node)) {
529       if (node->type != TN_NEWDIR) {
530          total++;
531          /* If regular file, get size */
532          if (node->extract && node->type == TN_FILE) {
533             num_extract++;
534             tree_getpath(node, cwd, sizeof(cwd));
535             fdbr.FileId = 0;
536             fdbr.JobId = node->JobId;
537             if (db_get_file_attributes_record(ua->jcr, ua->db, cwd, NULL, &fdbr)) {
538                int32_t LinkFI;
539                decode_stat(fdbr.LStat, &statp, &LinkFI); /* decode stat pkt */
540                if (S_ISREG(statp.st_mode) && statp.st_size > 0) {
541                   total_bytes += statp.st_size;
542                }
543             }
544          /* Directory, count only */
545          } else if (node->extract || node->extract_dir) {
546             num_extract++;
547          }
548       }
549    }
550    bsendmsg(ua, "%d total files; %d marked to be restored; %s bytes.\n", 
551             total, num_extract, edit_uint64_with_commas(total_bytes, ec1));
552    return 1;
553 }
554
555
556
557 static int helpcmd(UAContext *ua, TREE_CTX *tree) 
558 {
559    unsigned int i;
560
561 /* usage(); */
562    bsendmsg(ua, _("  Command    Description\n  =======    ===========\n"));
563    for (i=0; i<comsize; i++) {
564       bsendmsg(ua, _("  %-10s %s\n"), _(commands[i].key), _(commands[i].help));
565    }
566    bsendmsg(ua, "\n");
567    return 1;
568 }
569
570 /*
571  * Change directories.  Note, if the user specifies x: and it fails,
572  *   we assume it is a Win32 absolute cd rather than relative and
573  *   try a second time with /x: ...  Win32 kludge.
574  */
575 static int cdcmd(UAContext *ua, TREE_CTX *tree) 
576 {
577    TREE_NODE *node;
578    char cwd[2000];
579
580    if (ua->argc != 2) {
581       return 1;
582    }
583    node = tree_cwd(ua->argk[1], tree->root, tree->node);
584    if (!node) {
585       /* Try once more if Win32 drive -- make absolute */
586       if (ua->argk[1][1] == ':') {  /* win32 drive */
587          bstrncpy(cwd, "/", sizeof(cwd));
588          bstrncat(cwd, ua->argk[1], sizeof(cwd));
589          node = tree_cwd(cwd, tree->root, tree->node);
590       }
591       if (!node) {
592          bsendmsg(ua, _("Invalid path given.\n"));
593       } else {
594          tree->node = node;
595       }
596    } else {
597       tree->node = node;
598    }
599    tree_getpath(tree->node, cwd, sizeof(cwd));
600    bsendmsg(ua, _("cwd is: %s\n"), cwd);
601    return 1;
602 }
603
604 static int pwdcmd(UAContext *ua, TREE_CTX *tree) 
605 {
606    char cwd[2000];
607    tree_getpath(tree->node, cwd, sizeof(cwd));
608    bsendmsg(ua, _("cwd is: %s\n"), cwd);
609    return 1;
610 }
611
612
613 static int unmarkcmd(UAContext *ua, TREE_CTX *tree)
614 {
615    TREE_NODE *node;
616    int count = 0;
617
618    if (ua->argc < 2 || !tree->node->child) {     
619       bsendmsg(ua, _("No files unmarked.\n"));
620       return 1;
621    }
622    for (int i=1; i < ua->argc; i++) {
623       for (node = tree->node->child; node; node=node->sibling) {
624          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
625             count += set_extract(ua, node, tree, false);
626          }
627       }
628    }
629    if (count == 0) {
630       bsendmsg(ua, _("No files unmarked.\n"));
631    } else {
632       bsendmsg(ua, _("%d file%s unmarked.\n"), count, count==0?"":"s");
633    }
634    return 1;
635 }
636
637 static int unmarkdircmd(UAContext *ua, TREE_CTX *tree)
638 {
639    TREE_NODE *node;
640    int count = 0;
641
642    if (ua->argc < 2 || !tree->node->child) {
643       bsendmsg(ua, _("No directories unmarked.\n"));
644       return 1;
645    }
646
647    for (int i=1; i < ua->argc; i++) {
648       for (node = tree->node->child; node; node=node->sibling) {
649          if (fnmatch(ua->argk[i], node->fname, 0) == 0) {
650             if (node->type == TN_DIR || node->type == TN_DIR_NLS) {
651                node->extract_dir = false;
652                count++;
653             }
654          }
655       }
656    }
657
658    if (count == 0) {
659       bsendmsg(ua, _("No directories unmarked.\n"));
660    } else {
661       bsendmsg(ua, _("%d director%s unmarked.\n"), count, count==1?"y":"ies");
662    }
663    return 1;
664 }
665
666
667 static int donecmd(UAContext *ua, TREE_CTX *tree) 
668 {
669    return 0;
670 }
671
672 static int quitcmd(UAContext *ua, TREE_CTX *tree) 
673 {
674    ua->quit = true;
675    return 0;
676 }