2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2014 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from many
7 others, a complete list can be found in the file AUTHORS.
9 You may use this file and others of this release according to the
10 license defined in the LICENSE file, which includes the Affero General
11 Public License, v3.0 ("AGPLv3") and some additional permissions and
12 terms pursuant to its AGPLv3 Section 7.
14 Bacula® is a registered trademark of Kern Sibbald.
18 * Bacula Director -- User Agent Database restore Command
19 * Creates a bootstrap file for restoring files and
20 * starts the restore job.
22 * Tree handling routines split into ua_tree.c July MMIII.
23 * BSR (bootstrap record) handling routines split into
26 * Kern Sibbald, July MMII
33 /* Imported functions */
34 extern void print_bsr(UAContext *ua, RBSR *bsr);
37 /* Forward referenced functions */
38 static int last_full_handler(void *ctx, int num_fields, char **row);
39 static int jobid_handler(void *ctx, int num_fields, char **row);
40 static int user_select_jobids_or_files(UAContext *ua, RESTORE_CTX *rx);
41 static int fileset_handler(void *ctx, int num_fields, char **row);
42 static void free_name_list(NAME_LIST *name_list);
43 static bool select_backups_before_date(UAContext *ua, RESTORE_CTX *rx, char *date);
44 static bool build_directory_tree(UAContext *ua, RESTORE_CTX *rx);
45 static void free_rx(RESTORE_CTX *rx);
46 static void split_path_and_filename(UAContext *ua, RESTORE_CTX *rx, char *fname);
47 static int jobid_fileindex_handler(void *ctx, int num_fields, char **row);
48 static bool insert_file_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *file,
50 static bool insert_dir_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *dir,
52 static void insert_one_file_or_dir(UAContext *ua, RESTORE_CTX *rx, char *date, bool dir);
53 static int get_client_name(UAContext *ua, RESTORE_CTX *rx);
54 static int get_restore_client_name(UAContext *ua, RESTORE_CTX &rx);
55 static bool get_date(UAContext *ua, char *date, int date_len);
56 static int restore_count_handler(void *ctx, int num_fields, char **row);
57 static bool insert_table_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *table);
58 static void get_and_display_basejobs(UAContext *ua, RESTORE_CTX *rx);
64 int restore_cmd(UAContext *ua, const char *cmd)
66 RESTORE_CTX rx; /* restore context */
71 char *escaped_bsr_name = NULL;
72 char *escaped_where_name = NULL;
73 char *strip_prefix, *add_prefix, *add_suffix, *regexp;
74 strip_prefix = add_prefix = add_suffix = regexp = NULL;
76 memset(&rx, 0, sizeof(rx));
77 rx.path = get_pool_memory(PM_FNAME);
78 rx.fname = get_pool_memory(PM_FNAME);
79 rx.JobIds = get_pool_memory(PM_FNAME);
81 rx.BaseJobIds = get_pool_memory(PM_FNAME);
82 rx.query = get_pool_memory(PM_FNAME);
84 rx.hardlinks_in_mem = true;
86 if (!open_new_client_db(ua)) {
90 for (i = 0; i < ua->argc ; i++) {
92 continue; /* skip if no value given */
94 if (strcasecmp(ua->argk[i], "comment") == 0) {
95 rx.comment = ua->argv[i];
96 if (!is_comment_legal(ua, rx.comment)) {
100 } else if (strcasecmp(ua->argk[i], "where") == 0) {
101 rx.where = ua->argv[i];
103 } else if (strcasecmp(ua->argk[i], "replace") == 0) {
104 rx.replace = ua->argv[i];
106 } else if (strcasecmp(ua->argk[i], "strip_prefix") == 0) {
107 strip_prefix = ua->argv[i];
109 } else if (strcasecmp(ua->argk[i], "add_prefix") == 0) {
110 add_prefix = ua->argv[i];
112 } else if (strcasecmp(ua->argk[i], "add_suffix") == 0) {
113 add_suffix = ua->argv[i];
115 } else if (strcasecmp(ua->argk[i], "regexwhere") == 0) {
116 rx.RegexWhere = ua->argv[i];
118 } else if (strcasecmp(ua->argk[i], "optimizespeed") == 0) {
119 if (strcasecmp(ua->argv[i], "0") || strcasecmp(ua->argv[i], "no") ||
120 strcasecmp(ua->argv[i], "false")) {
121 rx.hardlinks_in_mem = false;
126 if (strip_prefix || add_suffix || add_prefix) {
127 int len = bregexp_get_build_where_size(strip_prefix, add_prefix, add_suffix);
128 regexp = (char *)bmalloc(len * sizeof(char));
130 bregexp_build_where(regexp, len, strip_prefix, add_prefix, add_suffix);
131 rx.RegexWhere = regexp;
134 /* TODO: add acl for regexwhere ? */
137 if (!acl_access_ok(ua, Where_ACL, rx.RegexWhere)) {
138 ua->error_msg(_("\"RegexWhere\" specification not authorized.\n"));
144 if (!acl_access_ok(ua, Where_ACL, rx.where)) {
145 ua->error_msg(_("\"where\" specification not authorized.\n"));
150 /* Ensure there is at least one Restore Job */
152 foreach_res(job, R_JOB) {
153 if (job->JobType == JT_RESTORE) {
154 if (!rx.restore_job) {
155 rx.restore_job = job;
161 if (!rx.restore_jobs) {
163 "No Restore Job Resource found in bacula-dir.conf.\n"
164 "You must create at least one before running this command.\n"));
169 * Request user to select JobIds or files by various different methods
170 * last 20 jobs, where File saved, most recent backup, ...
171 * In the end, a list of files are pumped into
174 switch (user_select_jobids_or_files(ua, &rx)) {
177 case 1: /* selected by jobid */
178 get_and_display_basejobs(ua, &rx);
179 if (!build_directory_tree(ua, &rx)) {
180 ua->send_msg(_("Restore not done.\n"));
184 case 2: /* selected by filename, no tree needed */
190 if (!complete_bsr(ua, rx.bsr)) { /* find Vol, SessId, SessTime from JobIds */
191 ua->error_msg(_("Unable to construct a valid BSR. Cannot continue.\n"));
194 if (!(rx.selected_files = write_bsr_file(ua, rx))) {
195 ua->warning_msg(_("No files selected to be restored.\n"));
198 display_bsr_info(ua, rx); /* display vols needed, etc */
200 if (rx.selected_files==1) {
201 ua->info_msg(_("\n1 file selected to be restored.\n\n"));
203 ua->info_msg(_("\n%s files selected to be restored.\n\n"),
204 edit_uint64_with_commas(rx.selected_files, ed1));
207 ua->warning_msg(_("No files selected to be restored.\n"));
211 if (rx.restore_jobs == 1) {
212 job = rx.restore_job;
214 job = get_restore_job(ua);
220 get_client_name(ua, &rx);
221 if (!rx.ClientName) {
222 ua->error_msg(_("No Client resource found!\n"));
225 get_restore_client_name(ua, rx);
227 escaped_bsr_name = escape_filename(jcr->RestoreBootstrap);
230 "run job=\"%s\" client=\"%s\" restoreclient=\"%s\" storage=\"%s\""
231 " bootstrap=\"%s\" files=%u catalog=\"%s\"",
232 job->name(), rx.ClientName, rx.RestoreClientName,
233 rx.store?rx.store->name():"",
234 escaped_bsr_name ? escaped_bsr_name : jcr->RestoreBootstrap,
235 rx.selected_files, ua->catalog->name());
237 /* Build run command */
239 if (rx.RestoreMediaType[0]) {
240 Mmsg(buf, " mediatype=\"%s\"", rx.RestoreMediaType);
241 pm_strcat(ua->cmd, buf);
245 escaped_where_name = escape_filename(rx.RegexWhere);
246 Mmsg(buf, " regexwhere=\"%s\"",
247 escaped_where_name ? escaped_where_name : rx.RegexWhere);
249 } else if (rx.where) {
250 escaped_where_name = escape_filename(rx.where);
251 Mmsg(buf," where=\"%s\"",
252 escaped_where_name ? escaped_where_name : rx.where);
254 pm_strcat(ua->cmd, buf);
257 Mmsg(buf, " replace=%s", rx.replace);
258 pm_strcat(ua->cmd, buf);
262 Mmsg(buf, " comment=\"%s\"", rx.comment);
263 pm_strcat(ua->cmd, buf);
266 if (escaped_bsr_name != NULL) {
267 bfree(escaped_bsr_name);
270 if (escaped_where_name != NULL) {
271 bfree(escaped_where_name);
278 if (find_arg(ua, NT_("yes")) > 0) {
279 pm_strcat(ua->cmd, " yes"); /* pass it on to the run command */
281 Dmsg1(200, "Submitting: %s\n", ua->cmd);
283 * Transfer jobids, to jcr to
284 * pass to run_cmd(). Note, these are fields and
285 * other things that are not passed on the command
288 /* ***FIXME*** pass jobids on command line */
289 jcr->JobIds = rx.JobIds;
292 run_cmd(ua, ua->cmd);
294 garbage_collect_memory(); /* release unused memory */
298 if (escaped_bsr_name != NULL) {
299 bfree(escaped_bsr_name);
302 if (escaped_where_name != NULL) {
303 bfree(escaped_where_name);
311 garbage_collect_memory(); /* release unused memory */
317 * Fill the rx->BaseJobIds and display the list
319 static void get_and_display_basejobs(UAContext *ua, RESTORE_CTX *rx)
323 if (!db_get_used_base_jobids(ua->jcr, ua->db, rx->JobIds, &jobids)) {
324 ua->warning_msg("%s", db_strerror(ua->db));
329 Mmsg(q, uar_print_jobs, jobids.list);
330 ua->send_msg(_("The restore will use the following job(s) as Base\n"));
331 db_list_sql_query(ua->jcr, ua->db, q.c_str(), prtit, ua, 1, HORZ_LIST);
333 pm_strcpy(rx->BaseJobIds, jobids.list);
336 static void free_rx(RESTORE_CTX *rx)
340 free_and_null_pool_memory(rx->JobIds);
341 free_and_null_pool_memory(rx->BaseJobIds);
342 free_and_null_pool_memory(rx->fname);
343 free_and_null_pool_memory(rx->path);
344 free_and_null_pool_memory(rx->query);
345 free_name_list(&rx->name_list);
348 static bool has_value(UAContext *ua, int i)
351 ua->error_msg(_("Missing value for keyword: %s\n"), ua->argk[i]);
358 * This gets the client name from which the backup was made
360 static int get_client_name(UAContext *ua, RESTORE_CTX *rx)
362 /* If no client name specified yet, get it now */
363 if (!rx->ClientName[0]) {
365 /* try command line argument */
366 int i = find_arg_with_value(ua, NT_("client"));
368 i = find_arg_with_value(ua, NT_("backupclient"));
371 if (!is_name_valid(ua->argv[i], &ua->errmsg)) {
372 ua->error_msg("%s argument: %s", ua->argk[i], ua->errmsg);
375 bstrncpy(rx->ClientName, ua->argv[i], sizeof(rx->ClientName));
378 memset(&cr, 0, sizeof(cr));
379 if (!get_client_dbr(ua, &cr)) {
382 bstrncpy(rx->ClientName, cr.Name, sizeof(rx->ClientName));
388 * This is where we pick up a client name to restore to.
390 static int get_restore_client_name(UAContext *ua, RESTORE_CTX &rx)
392 /* Start with same name as backup client */
393 bstrncpy(rx.RestoreClientName, rx.ClientName, sizeof(rx.RestoreClientName));
395 /* try command line argument */
396 int i = find_arg_with_value(ua, NT_("restoreclient"));
398 if (!is_name_valid(ua->argv[i], &ua->errmsg)) {
399 ua->error_msg("%s argument: %s", ua->argk[i], ua->errmsg);
402 bstrncpy(rx.RestoreClientName, ua->argv[i], sizeof(rx.RestoreClientName));
411 * The first step in the restore process is for the user to
412 * select a list of JobIds from which he will subsequently
413 * select which files are to be restored.
415 * Returns: 2 if filename list made
416 * 1 if jobid list made
419 static int user_select_jobids_or_files(UAContext *ua, RESTORE_CTX *rx)
422 char date[MAX_TIME_LENGTH];
423 bool have_date = false;
424 /* Include current second if using current time */
425 utime_t now = time(NULL) + 1;
427 JOB_DBR jr = { (JobId_t)-1 };
430 const char *list[] = {
431 _("List last 20 Jobs run"),
432 _("List Jobs where a given File is saved"),
433 _("Enter list of comma separated JobIds to select"),
434 _("Enter SQL list command"),
435 _("Select the most recent backup for a client"),
436 _("Select backup for a client before a specified time"),
437 _("Enter a list of files to restore"),
438 _("Enter a list of files to restore before a specified time"),
439 _("Find the JobIds of the most recent backup for a client"),
440 _("Find the JobIds for a backup for a client before a specified time"),
441 _("Enter a list of directories to restore for found JobIds"),
442 _("Select full restore to a specified Job date"),
447 /* These keywords are handled in a for loop */
457 /* The keyword below are handled by individual arg lookups */
463 "bootstrap", /* 13 */
465 "strip_prefix", /* 15 */
466 "add_prefix", /* 16 */
467 "add_suffix", /* 17 */
468 "regexwhere", /* 18 */
469 "restoreclient", /* 19 */
472 "restorejob", /* 22 */
479 for (i=1; i<ua->argc; i++) { /* loop through arguments */
480 bool found_kw = false;
481 for (j=0; kw[j]; j++) { /* loop through keywords */
482 if (strcasecmp(kw[j], ua->argk[i]) == 0) {
489 ua->error_msg(_("Unknown keyword: %s\n"), ua->argk[i]);
492 /* Found keyword in kw[] list, process it */
495 if (!has_value(ua, i)) {
498 if (*rx->JobIds != 0) {
499 pm_strcat(rx->JobIds, ",");
501 pm_strcat(rx->JobIds, ua->argv[i]);
504 case 1: /* current */
506 * Note, we add one second here just to include any job
507 * that may have finished within the current second,
508 * which happens a lot in scripting small jobs.
510 bstrutime(date, sizeof(date), now);
514 if (have_date || !has_value(ua, i)) {
517 if (str_to_utime(ua->argv[i]) == 0) {
518 ua->error_msg(_("Improper date format: %s\n"), ua->argv[i]);
521 bstrncpy(date, ua->argv[i], sizeof(date));
526 if (!has_value(ua, i)) {
530 bstrutime(date, sizeof(date), now);
532 if (!get_client_name(ua, rx)) {
535 pm_strcpy(ua->cmd, ua->argv[i]);
536 insert_one_file_or_dir(ua, rx, date, j==4);
540 bstrutime(date, sizeof(date), now);
542 if (!select_backups_before_date(ua, rx, date)) {
547 case 6: /* pool specified */
548 if (!has_value(ua, i)) {
551 rx->pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
553 ua->error_msg(_("Error: Pool resource \"%s\" does not exist.\n"), ua->argv[i]);
556 if (!acl_access_ok(ua, Pool_ACL, ua->argv[i])) {
558 ua->error_msg(_("Error: Pool resource \"%s\" access not allowed.\n"), ua->argv[i]);
562 case 7: /* all specified */
566 * All keywords 7 or greater are ignored or handled by a select prompt
574 ua->send_msg(_("\nFirst you select one or more JobIds that contain files\n"
575 "to be restored. You will be presented several methods\n"
576 "of specifying the JobIds. Then you will be allowed to\n"
577 "select which files from those JobIds are to be restored.\n\n"));
580 /* If choice not already made above, prompt */
587 start_prompt(ua, _("To select the JobIds, you have the following choices:\n"));
588 for (int i=0; list[i]; i++) {
589 add_prompt(ua, list[i]);
592 switch (do_prompt(ua, "", _("Select item: "), NULL, 0)) {
593 case -1: /* error or cancel */
595 case 0: /* list last 20 Jobs run */
596 if (!acl_access_ok(ua, Command_ACL, NT_("sqlquery"), 8)) {
597 ua->error_msg(_("SQL query not authorized.\n"));
600 gui_save = ua->jcr->gui;
602 db_list_sql_query(ua->jcr, ua->db, uar_list_jobs, prtit, ua, 1, HORZ_LIST);
603 ua->jcr->gui = gui_save;
606 case 1: /* list where a file is saved */
607 if (!get_client_name(ua, rx)) {
610 if (!get_cmd(ua, _("Enter Filename (no path):"))) {
613 len = strlen(ua->cmd);
614 fname = (char *)malloc(len * 2 + 1);
615 db_escape_string(ua->jcr, ua->db, fname, ua->cmd, len);
616 Mmsg(rx->query, uar_file[db_get_type_index(ua->db)], rx->ClientName, fname);
618 gui_save = ua->jcr->gui;
620 db_list_sql_query(ua->jcr, ua->db, rx->query, prtit, ua, 1, HORZ_LIST);
621 ua->jcr->gui = gui_save;
624 case 2: /* enter a list of JobIds */
625 if (!get_cmd(ua, _("Enter JobId(s), comma separated, to restore: "))) {
628 pm_strcpy(rx->JobIds, ua->cmd);
630 case 3: /* Enter an SQL list command */
631 if (!acl_access_ok(ua, Command_ACL, NT_("sqlquery"), 8)) {
632 ua->error_msg(_("SQL query not authorized.\n"));
635 if (!get_cmd(ua, _("Enter SQL list command: "))) {
638 gui_save = ua->jcr->gui;
640 db_list_sql_query(ua->jcr, ua->db, ua->cmd, prtit, ua, 1, HORZ_LIST);
641 ua->jcr->gui = gui_save;
644 case 4: /* Select the most recent backups */
646 bstrutime(date, sizeof(date), now);
648 if (!select_backups_before_date(ua, rx, date)) {
652 case 5: /* select backup at specified time */
654 if (!get_date(ua, date, sizeof(date))) {
658 if (!select_backups_before_date(ua, rx, date)) {
662 case 6: /* Enter files */
664 bstrutime(date, sizeof(date), now);
666 if (!get_client_name(ua, rx)) {
669 ua->send_msg(_("Enter file names with paths, or < to enter a filename\n"
670 "containing a list of file names with paths, and terminate\n"
671 "them with a blank line.\n"));
673 if (!get_cmd(ua, _("Enter full filename: "))) {
676 len = strlen(ua->cmd);
680 insert_one_file_or_dir(ua, rx, date, false);
683 case 7: /* enter files backed up before specified time */
685 if (!get_date(ua, date, sizeof(date))) {
689 if (!get_client_name(ua, rx)) {
692 ua->send_msg(_("Enter file names with paths, or < to enter a filename\n"
693 "containing a list of file names with paths, and terminate\n"
694 "them with a blank line.\n"));
696 if (!get_cmd(ua, _("Enter full filename: "))) {
699 len = strlen(ua->cmd);
703 insert_one_file_or_dir(ua, rx, date, false);
707 case 8: /* Find JobIds for current backup */
709 bstrutime(date, sizeof(date), now);
711 if (!select_backups_before_date(ua, rx, date)) {
717 case 9: /* Find JobIds for give date */
719 if (!get_date(ua, date, sizeof(date))) {
723 if (!select_backups_before_date(ua, rx, date)) {
729 case 10: /* Enter directories */
730 if (*rx->JobIds != 0) {
731 ua->send_msg(_("You have already selected the following JobIds: %s\n"),
733 } else if (get_cmd(ua, _("Enter JobId(s), comma separated, to restore: "))) {
734 if (*rx->JobIds != 0 && *ua->cmd) {
735 pm_strcat(rx->JobIds, ",");
737 pm_strcat(rx->JobIds, ua->cmd);
739 if (*rx->JobIds == 0 || *rx->JobIds == '.') {
741 return 0; /* nothing entered, return */
744 bstrutime(date, sizeof(date), now);
746 if (!get_client_name(ua, rx)) {
749 ua->send_msg(_("Enter full directory names or start the name\n"
750 "with a < to indicate it is a filename containing a list\n"
751 "of directories and terminate them with a blank line.\n"));
753 if (!get_cmd(ua, _("Enter directory name: "))) {
756 len = strlen(ua->cmd);
760 /* Add trailing slash to end of directory names */
761 if (ua->cmd[0] != '<' && !IsPathSeparator(ua->cmd[len-1])) {
762 strcat(ua->cmd, "/");
764 insert_one_file_or_dir(ua, rx, date, true);
768 case 11: /* Choose a jobid and select jobs */
769 if (!get_cmd(ua, _("Enter JobId to get the state to restore: ")) ||
770 !is_an_integer(ua->cmd))
775 memset(&jr, 0, sizeof(JOB_DBR));
776 jr.JobId = str_to_int64(ua->cmd);
777 if (!db_get_job_record(ua->jcr, ua->db, &jr)) {
778 ua->error_msg(_("Unable to get Job record for JobId=%s: ERR=%s\n"),
779 ua->cmd, db_strerror(ua->db));
782 ua->send_msg(_("Selecting jobs to build the Full state at %s\n"),
784 jr.JobLevel = L_INCREMENTAL; /* Take Full+Diff+Incr */
785 if (!db_accurate_get_jobids(ua->jcr, ua->db, &jr, &jobids)) {
788 pm_strcpy(rx->JobIds, jobids.list);
789 Dmsg1(30, "Item 12: jobids = %s\n", rx->JobIds);
791 case 12: /* Cancel or quit */
796 memset(&jr, 0, sizeof(JOB_DBR));
797 POOLMEM *JobIds = get_pool_memory(PM_FNAME);
801 * Find total number of files to be restored, and filter the JobId
802 * list to contain only ones permitted by the ACL conditions.
804 for (p=rx->JobIds; ; ) {
806 int stat = get_next_jobid_from_list(&p, &JobId);
808 ua->error_msg(_("Invalid JobId in list.\n"));
809 free_pool_memory(JobIds);
815 if (jr.JobId == JobId) {
816 continue; /* duplicate of last JobId */
818 memset(&jr, 0, sizeof(JOB_DBR));
820 if (!db_get_job_record(ua->jcr, ua->db, &jr)) {
821 ua->error_msg(_("Unable to get Job record for JobId=%s: ERR=%s\n"),
822 edit_int64(JobId, ed1), db_strerror(ua->db));
823 free_pool_memory(JobIds);
826 if (!acl_access_ok(ua, Job_ACL, jr.Name)) {
827 ua->error_msg(_("Access to JobId=%s (Job \"%s\") not authorized. Not selected.\n"),
828 edit_int64(JobId, ed1), jr.Name);
832 pm_strcat(JobIds, ",");
834 pm_strcat(JobIds, edit_int64(JobId, ed1));
835 rx->TotalFiles += jr.JobFiles;
837 free_pool_memory(rx->JobIds);
838 rx->JobIds = JobIds; /* Set ACL filtered list */
839 if (*rx->JobIds == 0) {
840 ua->warning_msg(_("No Jobs selected.\n"));
844 if (strchr(rx->JobIds,',')) {
845 ua->info_msg(_("You have selected the following JobIds: %s\n"), rx->JobIds);
847 ua->info_msg(_("You have selected the following JobId: %s\n"), rx->JobIds);
855 static bool get_date(UAContext *ua, char *date, int date_len)
857 ua->send_msg(_("The restored files will the most current backup\n"
858 "BEFORE the date you specify below.\n\n"));
860 if (!get_cmd(ua, _("Enter date as YYYY-MM-DD HH:MM:SS :"))) {
863 if (str_to_utime(ua->cmd) != 0) {
866 ua->error_msg(_("Improper date format.\n"));
868 bstrncpy(date, ua->cmd, date_len);
873 * Insert a single file, or read a list of files from a file
875 static void insert_one_file_or_dir(UAContext *ua, RESTORE_CTX *rx, char *date, bool dir)
885 if ((ffd = fopen(p, "rb")) == NULL) {
887 ua->error_msg(_("Cannot open file %s: ERR=%s\n"),
891 while (fgets(file, sizeof(file), ffd)) {
894 if (!insert_dir_into_findex_list(ua, rx, file, date)) {
895 ua->error_msg(_("Error occurred on line %d of file \"%s\"\n"), line, p);
898 if (!insert_file_into_findex_list(ua, rx, file, date)) {
899 ua->error_msg(_("Error occurred on line %d of file \"%s\"\n"), line, p);
907 insert_table_into_findex_list(ua, rx, p);
911 insert_dir_into_findex_list(ua, rx, ua->cmd, date);
913 insert_file_into_findex_list(ua, rx, ua->cmd, date);
920 * For a given file (path+filename), split into path and file, then
921 * lookup the most recent backup in the catalog to get the JobId
922 * and FileIndex, then insert them into the findex list.
924 static bool insert_file_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *file,
927 strip_trailing_newline(file);
928 split_path_and_filename(ua, rx, file);
929 if (*rx->JobIds == 0) {
930 Mmsg(rx->query, uar_jobid_fileindex, date, rx->path, rx->fname,
933 Mmsg(rx->query, uar_jobids_fileindex, rx->JobIds, date,
934 rx->path, rx->fname, rx->ClientName);
937 /* Find and insert jobid and File Index */
938 if (!db_sql_query(ua->db, rx->query, jobid_fileindex_handler, (void *)rx)) {
939 ua->error_msg(_("Query failed: %s. ERR=%s\n"),
940 rx->query, db_strerror(ua->db));
943 ua->error_msg(_("No database record found for: %s\n"), file);
944 // ua->error_msg("Query=%s\n", rx->query);
951 * For a given path lookup the most recent backup in the catalog
952 * to get the JobId and FileIndexes of all files in that directory.
954 static bool insert_dir_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *dir,
957 strip_trailing_junk(dir);
958 if (*rx->JobIds == 0) {
959 ua->error_msg(_("No JobId specified cannot continue.\n"));
962 Mmsg(rx->query, uar_jobid_fileindex_from_dir[db_get_type_index(ua->db)], rx->JobIds, dir, rx->ClientName);
965 /* Find and insert jobid and File Index */
966 if (!db_sql_query(ua->db, rx->query, jobid_fileindex_handler, (void *)rx)) {
967 ua->error_msg(_("Query failed: %s. ERR=%s\n"),
968 rx->query, db_strerror(ua->db));
971 ua->error_msg(_("No database record found for: %s\n"), dir);
978 * Get the JobId and FileIndexes of all files in the specified table
980 static bool insert_table_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *table)
982 strip_trailing_junk(table);
983 Mmsg(rx->query, uar_jobid_fileindex_from_table, table);
986 /* Find and insert jobid and File Index */
987 if (!db_sql_query(ua->db, rx->query, jobid_fileindex_handler, (void *)rx)) {
988 ua->error_msg(_("Query failed: %s. ERR=%s\n"),
989 rx->query, db_strerror(ua->db));
992 ua->error_msg(_("No table found: %s\n"), table);
998 static void split_path_and_filename(UAContext *ua, RESTORE_CTX *rx, char *name)
1002 /* Find path without the filename.
1003 * I.e. everything after the last / is a "filename".
1004 * OK, maybe it is a directory name, but we treat it like
1005 * a filename. If we don't find a / then the whole name
1006 * must be a path name (e.g. c:).
1008 for (p=f=name; *p; p++) {
1009 if (IsPathSeparator(*p)) {
1010 f = p; /* set pos of last slash */
1013 if (IsPathSeparator(*f)) { /* did we find a slash? */
1014 f++; /* yes, point to filename */
1015 } else { /* no, whole thing must be path name */
1019 /* If filename doesn't exist (i.e. root directory), we
1020 * simply create a blank name consisting of a single
1021 * space. This makes handling zero length filenames
1026 rx->fname = check_pool_memory_size(rx->fname, 2*(rx->fnl)+1);
1027 db_escape_string(ua->jcr, ua->db, rx->fname, f, rx->fnl);
1035 rx->path = check_pool_memory_size(rx->path, 2*(rx->pnl)+1);
1036 db_escape_string(ua->jcr, ua->db, rx->path, name, rx->pnl);
1042 Dmsg2(100, "split path=%s file=%s\n", rx->path, rx->fname);
1045 static bool ask_for_fileregex(UAContext *ua, RESTORE_CTX *rx)
1047 if (find_arg(ua, NT_("all")) >= 0) { /* if user enters all on command line */
1048 return true; /* select everything */
1050 ua->send_msg(_("\n\nFor one or more of the JobIds selected, no files were found,\n"
1051 "so file selection is not possible.\n"
1052 "Most likely your retention policy pruned the files.\n"));
1053 if (get_yesno(ua, _("\nDo you want to restore all the files? (yes|no): "))) {
1054 if (ua->pint32_val == 1)
1056 while (get_cmd(ua, _("\nRegexp matching files to restore? (empty to abort): "))) {
1057 if (ua->cmd[0] == '\0') {
1060 regex_t *fileregex_re = NULL;
1062 char errmsg[500] = "";
1064 fileregex_re = (regex_t *)bmalloc(sizeof(regex_t));
1065 rc = regcomp(fileregex_re, ua->cmd, REG_EXTENDED|REG_NOSUB);
1067 regerror(rc, fileregex_re, errmsg, sizeof(errmsg));
1069 regfree(fileregex_re);
1072 ua->send_msg(_("Regex compile error: %s\n"), errmsg);
1074 rx->bsr->fileregex = bstrdup(ua->cmd);
1083 /* Walk on the delta_list of a TREE_NODE item and insert all parts
1084 * TODO: Optimize for bootstrap creation, remove recursion
1085 * 6 -> 5 -> 4 -> 3 -> 2 -> 1 -> 0
1087 * 0, 1, 2, 3, 4, 5, 6
1089 static void add_delta_list_findex(RESTORE_CTX *rx, struct delta_list *lst)
1095 add_delta_list_findex(rx, lst->next);
1097 add_findex(rx->bsr, lst->JobId, lst->FileIndex);
1101 static bool build_directory_tree(UAContext *ua, RESTORE_CTX *rx)
1104 JobId_t JobId, last_JobId;
1109 memset(&tree, 0, sizeof(TREE_CTX));
1111 * Build the directory tree containing JobIds user selected
1113 tree.root = new_tree(rx->TotalFiles);
1116 tree.hardlinks_in_mem = rx->hardlinks_in_mem;
1119 * For display purposes, the same JobId, with different volumes may
1120 * appear more than once, however, we only insert it once.
1123 tree.FileEstimate = 0;
1124 if (get_next_jobid_from_list(&p, &JobId) > 0) {
1125 /* Use first JobId as estimate of the number of files to restore */
1126 Mmsg(rx->query, uar_count_files, edit_int64(JobId, ed1));
1127 if (!db_sql_query(ua->db, rx->query, restore_count_handler, (void *)rx)) {
1128 ua->error_msg("%s\n", db_strerror(ua->db));
1131 /* Add about 25% more than this job for over estimate */
1132 tree.FileEstimate = rx->JobId + (rx->JobId >> 2);
1133 tree.DeltaCount = rx->JobId/50; /* print 50 ticks */
1137 ua->info_msg(_("\nBuilding directory tree for JobId(s) %s ... "),
1140 #define new_get_file_list
1141 #ifdef new_get_file_list
1142 if (!db_get_file_list(ua->jcr, ua->db,
1143 rx->JobIds, false /* do not use md5 */,
1144 true /* get delta */,
1145 insert_tree_handler, (void *)&tree))
1147 ua->error_msg("%s", db_strerror(ua->db));
1149 if (*rx->BaseJobIds) {
1150 pm_strcat(rx->JobIds, ",");
1151 pm_strcat(rx->JobIds, rx->BaseJobIds);
1154 for (p=rx->JobIds; get_next_jobid_from_list(&p, &JobId) > 0; ) {
1157 if (JobId == last_JobId) {
1158 continue; /* eliminate duplicate JobIds */
1162 * Find files for this JobId and insert them in the tree
1164 Mmsg(rx->query, uar_sel_files, edit_int64(JobId, ed1));
1165 if (!db_sql_query(ua->db, rx->query, insert_tree_handler, (void *)&tree)) {
1166 ua->error_msg("%s", db_strerror(ua->db));
1171 * At this point, the tree is built, so we can garbage collect
1172 * any memory released by the SQL engine that RedHat has
1173 * not returned to the OS :-(
1175 garbage_collect_memory();
1178 * Look at the first JobId on the list (presumably the oldest) and
1179 * if it is marked purged, don't do the manual selection because
1180 * the Job was pruned, so the tree is incomplete.
1182 if (tree.FileCount != 0) {
1183 /* Find out if any Job is purged */
1184 Mmsg(rx->query, "SELECT SUM(PurgedFiles) FROM Job WHERE JobId IN (%s)", rx->JobIds);
1185 if (!db_sql_query(ua->db, rx->query, restore_count_handler, (void *)rx)) {
1186 ua->error_msg("%s\n", db_strerror(ua->db));
1188 /* rx->JobId is the PurgedFiles flag */
1189 if (rx->found && rx->JobId > 0) {
1190 tree.FileCount = 0; /* set count to zero, no tree selection */
1193 if (tree.FileCount == 0) {
1194 OK = ask_for_fileregex(ua, rx);
1197 for (p=rx->JobIds; get_next_jobid_from_list(&p, &JobId) > 0; ) {
1198 if (JobId == last_JobId) {
1199 continue; /* eliminate duplicate JobIds */
1201 add_findex_all(rx->bsr, JobId);
1207 ua->info_msg(_("\n%s files inserted into the tree and marked for extraction.\n"),
1208 edit_uint64_with_commas(tree.FileCount, ec1));
1210 ua->info_msg(_("\n%s files inserted into the tree.\n"),
1211 edit_uint64_with_commas(tree.FileCount, ec1));
1214 if (find_arg(ua, NT_("done")) < 0) {
1215 /* Let the user interact in selecting which files to restore */
1216 OK = user_select_files_from_tree(&tree);
1220 * Walk down through the tree finding all files marked to be
1221 * extracted making a bootstrap file.
1224 for (TREE_NODE *node=first_tree_node(tree.root); node; node=next_tree_node(node)) {
1225 Dmsg2(400, "FI=%d node=0x%x\n", node->FileIndex, node);
1226 if (node->extract || node->extract_dir) {
1227 Dmsg3(400, "JobId=%lld type=%d FI=%d\n", (uint64_t)node->JobId, node->type, node->FileIndex);
1228 /* TODO: optimize bsr insertion when jobid are non sorted */
1229 add_delta_list_findex(rx, node->delta_list);
1230 add_findex(rx->bsr, node->JobId, node->FileIndex);
1231 if (node->extract && node->type != TN_NEWDIR) {
1232 rx->selected_files++; /* count only saved files */
1239 free_tree(tree.root); /* free the directory tree */
1245 * This routine is used to get the current backup or a backup
1246 * before the specified date.
1248 static bool select_backups_before_date(UAContext *ua, RESTORE_CTX *rx, char *date)
1253 char fileset_name[MAX_NAME_LENGTH];
1254 char ed1[50], ed2[50];
1255 char pool_select[MAX_NAME_LENGTH];
1258 /* Create temp tables */
1259 db_sql_query(ua->db, uar_del_temp, NULL, NULL);
1260 db_sql_query(ua->db, uar_del_temp1, NULL, NULL);
1261 if (!db_sql_query(ua->db, uar_create_temp[db_get_type_index(ua->db)], NULL, NULL)) {
1262 ua->error_msg("%s\n", db_strerror(ua->db));
1264 if (!db_sql_query(ua->db, uar_create_temp1[db_get_type_index(ua->db)], NULL, NULL)) {
1265 ua->error_msg("%s\n", db_strerror(ua->db));
1268 * Select Client from the Catalog
1270 memset(&cr, 0, sizeof(cr));
1271 if (!get_client_dbr(ua, &cr)) {
1274 bstrncpy(rx->ClientName, cr.Name, sizeof(rx->ClientName));
1279 memset(&fsr, 0, sizeof(fsr));
1280 i = find_arg_with_value(ua, "FileSet");
1282 if (i >= 0 && is_name_valid(ua->argv[i], &ua->errmsg)) {
1283 bstrncpy(fsr.FileSet, ua->argv[i], sizeof(fsr.FileSet));
1284 if (!db_get_fileset_record(ua->jcr, ua->db, &fsr)) {
1285 ua->error_msg(_("Error getting FileSet \"%s\": ERR=%s\n"), fsr.FileSet,
1286 db_strerror(ua->db));
1289 } else if (i >= 0) { /* name is invalid */
1290 ua->error_msg(_("FileSet argument: %s\n"), ua->errmsg);
1293 if (i < 0) { /* fileset not found */
1294 edit_int64(cr.ClientId, ed1);
1295 Mmsg(rx->query, uar_sel_fileset, ed1, ed1);
1296 start_prompt(ua, _("The defined FileSet resources are:\n"));
1297 if (!db_sql_query(ua->db, rx->query, fileset_handler, (void *)ua)) {
1298 ua->error_msg("%s\n", db_strerror(ua->db));
1300 if (do_prompt(ua, _("FileSet"), _("Select FileSet resource"),
1301 fileset_name, sizeof(fileset_name)) < 0) {
1302 ua->error_msg(_("No FileSet found for client \"%s\".\n"), cr.Name);
1306 bstrncpy(fsr.FileSet, fileset_name, sizeof(fsr.FileSet));
1307 if (!db_get_fileset_record(ua->jcr, ua->db, &fsr)) {
1308 ua->warning_msg(_("Error getting FileSet record: %s\n"), db_strerror(ua->db));
1309 ua->send_msg(_("This probably means you modified the FileSet.\n"
1310 "Continuing anyway.\n"));
1314 /* If Pool specified, add PoolId specification */
1318 memset(&pr, 0, sizeof(pr));
1319 bstrncpy(pr.Name, rx->pool->name(), sizeof(pr.Name));
1320 if (db_get_pool_record(ua->jcr, ua->db, &pr)) {
1321 bsnprintf(pool_select, sizeof(pool_select), "AND Media.PoolId=%s ",
1322 edit_int64(pr.PoolId, ed1));
1324 ua->warning_msg(_("Pool \"%s\" not found, using any pool.\n"), pr.Name);
1328 /* Find JobId of last Full backup for this client, fileset */
1329 edit_int64(cr.ClientId, ed1);
1330 Mmsg(rx->query, uar_last_full, ed1, ed1, date, fsr.FileSet,
1332 if (!db_sql_query(ua->db, rx->query, NULL, NULL)) {
1333 ua->error_msg("%s\n", db_strerror(ua->db));
1337 /* Find all Volumes used by that JobId */
1338 if (!db_sql_query(ua->db, uar_full, NULL, NULL)) {
1339 ua->error_msg("%s\n", db_strerror(ua->db));
1343 /* Note, this is needed because I don't seem to get the callback
1344 * from the call just above.
1347 if (!db_sql_query(ua->db, uar_sel_all_temp1, last_full_handler, (void *)rx)) {
1348 ua->warning_msg("%s\n", db_strerror(ua->db));
1350 if (rx->JobTDate == 0) {
1351 ua->error_msg(_("No Full backup before %s found.\n"), date);
1355 /* Now find most recent Differental Job after Full save, if any */
1356 Mmsg(rx->query, uar_dif, edit_uint64(rx->JobTDate, ed1), date,
1357 edit_int64(cr.ClientId, ed2), fsr.FileSet, pool_select);
1358 if (!db_sql_query(ua->db, rx->query, NULL, NULL)) {
1359 ua->warning_msg("%s\n", db_strerror(ua->db));
1361 /* Now update JobTDate to look into Differental, if any */
1363 if (!db_sql_query(ua->db, uar_sel_all_temp, last_full_handler, (void *)rx)) {
1364 ua->warning_msg("%s\n", db_strerror(ua->db));
1366 if (rx->JobTDate == 0) {
1367 ua->error_msg(_("No Full backup before %s found.\n"), date);
1371 /* Now find all Incremental Jobs after Full/dif save */
1372 Mmsg(rx->query, uar_inc, edit_uint64(rx->JobTDate, ed1), date,
1373 edit_int64(cr.ClientId, ed2), fsr.FileSet, pool_select);
1374 if (!db_sql_query(ua->db, rx->query, NULL, NULL)) {
1375 ua->warning_msg("%s\n", db_strerror(ua->db));
1378 /* Get the JobIds from that list */
1379 rx->last_jobid[0] = rx->JobIds[0] = 0;
1381 if (!db_sql_query(ua->db, uar_sel_jobid_temp, jobid_handler, (void *)rx)) {
1382 ua->warning_msg("%s\n", db_strerror(ua->db));
1385 if (rx->JobIds[0] != 0) {
1386 if (find_arg(ua, NT_("copies")) > 0) {
1387 /* Display a list of all copies */
1388 db_list_copies_records(ua->jcr, ua->db, 0, rx->JobIds,
1389 prtit, ua, HORZ_LIST);
1391 /* Display a list of Jobs selected for this restore */
1392 db_list_sql_query(ua->jcr, ua->db, uar_list_temp, prtit, ua, 1,HORZ_LIST);
1396 ua->warning_msg(_("No jobs found.\n"));
1400 db_sql_query(ua->db, uar_del_temp, NULL, NULL);
1401 db_sql_query(ua->db, uar_del_temp1, NULL, NULL);
1405 static int restore_count_handler(void *ctx, int num_fields, char **row)
1407 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1408 rx->JobId = str_to_int64(row[0]);
1414 * Callback handler to get JobId and FileIndex for files
1415 * can insert more than one depending on the caller.
1417 static int jobid_fileindex_handler(void *ctx, int num_fields, char **row)
1419 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1420 JobId_t JobId = str_to_int64(row[0]);
1422 Dmsg3(200, "JobId=%s JobIds=%s FileIndex=%s\n", row[0], rx->JobIds, row[1]);
1424 /* New JobId, add it to JobIds
1425 * The list is sorted by JobId, so we need a cache for the previous value
1427 * It will permit to find restore objects to send during the restore
1429 if (rx->JobId != JobId) {
1431 pm_strcat(rx->JobIds, ",");
1433 pm_strcat(rx->JobIds, row[0]);
1437 add_findex(rx->bsr, rx->JobId, str_to_int64(row[1]));
1439 rx->selected_files++;
1444 * Callback handler make list of JobIds
1446 static int jobid_handler(void *ctx, int num_fields, char **row)
1448 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1450 if (strcmp(rx->last_jobid, row[0]) == 0) {
1451 return 0; /* duplicate id */
1453 bstrncpy(rx->last_jobid, row[0], sizeof(rx->last_jobid));
1454 if (rx->JobIds[0] != 0) {
1455 pm_strcat(rx->JobIds, ",");
1457 pm_strcat(rx->JobIds, row[0]);
1463 * Callback handler to pickup last Full backup JobTDate
1465 static int last_full_handler(void *ctx, int num_fields, char **row)
1467 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1469 rx->JobTDate = str_to_int64(row[1]);
1474 * Callback handler build FileSet name prompt list
1476 static int fileset_handler(void *ctx, int num_fields, char **row)
1478 /* row[0] = FileSet (name) */
1480 add_prompt((UAContext *)ctx, row[0]);
1486 * Free names in the list
1488 static void free_name_list(NAME_LIST *name_list)
1490 for (int i=0; i < name_list->num_ids; i++) {
1491 free(name_list->name[i]);
1493 bfree_and_null(name_list->name);
1494 name_list->max_ids = 0;
1495 name_list->num_ids = 0;
1498 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType)
1503 Dmsg1(200, "Already have store=%s\n", rx.store->name());
1507 * Try looking up Storage by name
1510 foreach_res(store, R_STORAGE) {
1511 if (strcmp(Storage, store->name()) == 0) {
1512 if (acl_access_ok(ua, Storage_ACL, store->name())) {
1521 /* Check if an explicit storage resource is given */
1523 int i = find_arg_with_value(ua, "storage");
1525 store = (STORE *)GetResWithName(R_STORAGE, ua->argv[i]);
1526 if (store && !acl_access_ok(ua, Storage_ACL, store->name())) {
1530 if (store && (store != rx.store)) {
1531 ua->info_msg(_("\nWarning Storage is overridden by \"%s\" on the command line.\n"),
1534 bstrncpy(rx.RestoreMediaType, MediaType, sizeof(rx.RestoreMediaType));
1535 if (strcmp(MediaType, store->media_type) != 0) {
1536 ua->info_msg(_("This may not work because of two different MediaTypes:\n"
1537 " Storage MediaType=\"%s\"\n"
1538 " Volume MediaType=\"%s\".\n\n"),
1539 store->media_type, MediaType);
1541 Dmsg2(200, "Set store=%s MediaType=%s\n", rx.store->name(), rx.RestoreMediaType);
1546 /* If no storage resource, try to find one from MediaType */
1549 foreach_res(store, R_STORAGE) {
1550 if (strcmp(MediaType, store->media_type) == 0) {
1551 if (acl_access_ok(ua, Storage_ACL, store->name())) {
1553 Dmsg1(200, "Set store=%s\n", rx.store->name());
1554 if (Storage == NULL) {
1555 ua->warning_msg(_("Using Storage \"%s\" from MediaType \"%s\".\n"),
1556 store->name(), MediaType);
1558 ua->warning_msg(_("Storage \"%s\" not found, using Storage \"%s\" from MediaType \"%s\".\n"),
1559 Storage, store->name(), MediaType);
1567 ua->warning_msg(_("\nUnable to find Storage resource for\n"
1568 "MediaType \"%s\", needed by the Jobs you selected.\n"), MediaType);
1571 /* Take command line arg, or ask user if none */
1572 rx.store = get_storage_resource(ua, false /* don't use default */);
1574 Dmsg1(200, "Set store=%s\n", rx.store->name());