2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2008 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * Bacula Director -- User Agent Database restore Command
31 * Creates a bootstrap file for restoring files and
32 * starts the restore job.
34 * Tree handling routines split into ua_tree.c July MMIII.
35 * BSR (bootstrap record) handling routines split into
38 * Kern Sibbald, July MMII
47 /* Imported functions */
48 extern void print_bsr(UAContext *ua, RBSR *bsr);
52 /* Forward referenced functions */
53 static int last_full_handler(void *ctx, int num_fields, char **row);
54 static int jobid_handler(void *ctx, int num_fields, char **row);
55 static int user_select_jobids_or_files(UAContext *ua, RESTORE_CTX *rx);
56 static int fileset_handler(void *ctx, int num_fields, char **row);
57 static void free_name_list(NAME_LIST *name_list);
58 static bool select_backups_before_date(UAContext *ua, RESTORE_CTX *rx, char *date);
59 static bool build_directory_tree(UAContext *ua, RESTORE_CTX *rx);
60 static void free_rx(RESTORE_CTX *rx);
61 static void split_path_and_filename(UAContext *ua, RESTORE_CTX *rx, char *fname);
62 static int jobid_fileindex_handler(void *ctx, int num_fields, char **row);
63 static bool insert_file_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *file,
65 static bool insert_dir_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *dir,
67 static void insert_one_file_or_dir(UAContext *ua, RESTORE_CTX *rx, char *date, bool dir);
68 static int get_client_name(UAContext *ua, RESTORE_CTX *rx);
69 static int get_restore_client_name(UAContext *ua, RESTORE_CTX &rx);
70 static int get_date(UAContext *ua, char *date, int date_len);
71 static int restore_count_handler(void *ctx, int num_fields, char **row);
72 static bool insert_table_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *table);
73 static void get_and_display_basejobs(UAContext *ua, RESTORE_CTX *rx);
79 int restore_cmd(UAContext *ua, const char *cmd)
81 RESTORE_CTX rx; /* restore context */
85 char *escaped_bsr_name = NULL;
86 char *escaped_where_name = NULL;
87 char *strip_prefix, *add_prefix, *add_suffix, *regexp;
88 strip_prefix = add_prefix = add_suffix = regexp = NULL;
90 memset(&rx, 0, sizeof(rx));
91 rx.path = get_pool_memory(PM_FNAME);
92 rx.fname = get_pool_memory(PM_FNAME);
93 rx.JobIds = get_pool_memory(PM_FNAME);
94 rx.BaseJobIds = get_pool_memory(PM_FNAME);
95 rx.query = get_pool_memory(PM_FNAME);
98 i = find_arg_with_value(ua, "where");
100 rx.where = ua->argv[i];
103 i = find_arg_with_value(ua, "strip_prefix");
105 strip_prefix = ua->argv[i];
108 i = find_arg_with_value(ua, "add_prefix");
110 add_prefix = ua->argv[i];
113 i = find_arg_with_value(ua, "add_suffix");
115 add_suffix = ua->argv[i];
118 i = find_arg_with_value(ua, "regexwhere");
120 rx.RegexWhere = ua->argv[i];
123 if (strip_prefix || add_suffix || add_prefix) {
124 int len = bregexp_get_build_where_size(strip_prefix, add_prefix, add_suffix);
125 regexp = (char *)bmalloc(len * sizeof(char));
127 bregexp_build_where(regexp, len, strip_prefix, add_prefix, add_suffix);
128 rx.RegexWhere = regexp;
131 /* TODO: add acl for regexwhere ? */
134 if (!acl_access_ok(ua, Where_ACL, rx.RegexWhere)) {
135 ua->error_msg(_("\"RegexWhere\" specification not authorized.\n"));
141 if (!acl_access_ok(ua, Where_ACL, rx.where)) {
142 ua->error_msg(_("\"where\" specification not authorized.\n"));
147 if (!open_client_db(ua)) {
151 /* Ensure there is at least one Restore Job */
153 foreach_res(job, R_JOB) {
154 if (job->JobType == JT_RESTORE) {
155 if (!rx.restore_job) {
156 rx.restore_job = job;
162 if (!rx.restore_jobs) {
164 "No Restore Job Resource found in bacula-dir.conf.\n"
165 "You must create at least one before running this command.\n"));
170 * Request user to select JobIds or files by various different methods
171 * last 20 jobs, where File saved, most recent backup, ...
172 * In the end, a list of files are pumped into
175 switch (user_select_jobids_or_files(ua, &rx)) {
178 case 1: /* selected by jobid */
179 get_and_display_basejobs(ua, &rx);
180 if (!build_directory_tree(ua, &rx)) {
181 ua->send_msg(_("Restore not done.\n"));
185 case 2: /* selected by filename, no tree needed */
190 uint32_t selected_files;
192 if (!complete_bsr(ua, rx.bsr)) { /* find Vol, SessId, SessTime from JobIds */
193 ua->error_msg(_("Unable to construct a valid BSR. Cannot continue.\n"));
196 if (!(selected_files = write_bsr_file(ua, rx))) {
197 ua->warning_msg(_("No files selected to be restored.\n"));
200 display_bsr_info(ua, rx); /* display vols needed, etc */
202 /* If no count of files, use bsr generated value (often wrong) */
203 if (rx.selected_files == 0) {
204 rx.selected_files = selected_files;
206 if (rx.selected_files==1) {
207 ua->info_msg(_("\n1 file selected to be restored.\n\n"));
210 ua->info_msg(_("\n%s files selected to be restored.\n\n"),
211 edit_uint64_with_commas(rx.selected_files, ed1));
214 ua->warning_msg(_("No files selected to be restored.\n"));
218 if (rx.restore_jobs == 1) {
219 job = rx.restore_job;
221 job = select_restore_job_resource(ua);
227 get_client_name(ua, &rx);
228 if (!rx.ClientName) {
229 ua->error_msg(_("No Client resource found!\n"));
232 get_restore_client_name(ua, rx);
234 escaped_bsr_name = escape_filename(jcr->RestoreBootstrap);
236 /* Build run command */
238 escaped_where_name = escape_filename(rx.RegexWhere);
240 "run job=\"%s\" client=\"%s\" restoreclient=\"%s\" storage=\"%s\""
241 " bootstrap=\"%s\" regexwhere=\"%s\" files=%u catalog=\"%s\"",
242 job->name(), rx.ClientName, rx.RestoreClientName,
243 rx.store?rx.store->name():"",
244 escaped_bsr_name ? escaped_bsr_name : jcr->RestoreBootstrap,
245 escaped_where_name ? escaped_where_name : rx.RegexWhere,
246 rx.selected_files, ua->catalog->name());
248 } else if (rx.where) {
249 escaped_where_name = escape_filename(rx.where);
251 "run job=\"%s\" client=\"%s\" restoreclient=\"%s\" storage=\"%s\""
252 " bootstrap=\"%s\" where=\"%s\" files=%u catalog=\"%s\"",
253 job->name(), rx.ClientName, rx.RestoreClientName,
254 rx.store?rx.store->name():"",
255 escaped_bsr_name ? escaped_bsr_name : jcr->RestoreBootstrap,
256 escaped_where_name ? escaped_where_name : rx.where,
257 rx.selected_files, ua->catalog->name());
261 "run job=\"%s\" client=\"%s\" restoreclient=\"%s\" storage=\"%s\""
262 " bootstrap=\"%s\" files=%u catalog=\"%s\"",
263 job->name(), rx.ClientName, rx.RestoreClientName,
264 rx.store?rx.store->name():"",
265 escaped_bsr_name ? escaped_bsr_name : jcr->RestoreBootstrap,
266 rx.selected_files, ua->catalog->name());
269 if (escaped_bsr_name != NULL) {
270 bfree(escaped_bsr_name);
273 if (escaped_where_name != NULL) {
274 bfree(escaped_where_name);
281 if (find_arg(ua, NT_("yes")) > 0) {
282 pm_strcat(ua->cmd, " yes"); /* pass it on to the run command */
284 Dmsg1(200, "Submitting: %s\n", ua->cmd);
286 run_cmd(ua, ua->cmd);
291 if (escaped_bsr_name != NULL) {
292 bfree(escaped_bsr_name);
295 if (escaped_where_name != NULL) {
296 bfree(escaped_where_name);
309 * Fill the rx->BaseJobIds and display the list
311 static void get_and_display_basejobs(UAContext *ua, RESTORE_CTX *rx)
313 rx->BaseJobIds[0] = '\0';
315 if (!db_get_used_base_jobids(ua->jcr, ua->db, rx->JobIds, rx->BaseJobIds)) {
316 ua->warning_msg("%s", db_strerror(ua->db));
319 if (*rx->BaseJobIds) {
321 Mmsg(q, uar_print_jobs, rx->BaseJobIds);
322 ua->send_msg(_("The restore will use the following job(s) as Base\n"));
323 db_list_sql_query(ua->jcr, ua->db, q.c_str(), prtit, ua, 1, HORZ_LIST);
327 static void free_rx(RESTORE_CTX *rx)
331 free_and_null_pool_memory(rx->JobIds);
332 free_and_null_pool_memory(rx->BaseJobIds);
333 free_and_null_pool_memory(rx->fname);
334 free_and_null_pool_memory(rx->path);
335 free_and_null_pool_memory(rx->query);
336 free_name_list(&rx->name_list);
339 static bool has_value(UAContext *ua, int i)
342 ua->error_msg(_("Missing value for keyword: %s\n"), ua->argk[i]);
349 * This gets the client name from which the backup was made
351 static int get_client_name(UAContext *ua, RESTORE_CTX *rx)
353 /* If no client name specified yet, get it now */
354 if (!rx->ClientName[0]) {
356 /* try command line argument */
357 int i = find_arg_with_value(ua, NT_("client"));
359 i = find_arg_with_value(ua, NT_("backupclient"));
362 if (!has_value(ua, i)) {
365 bstrncpy(rx->ClientName, ua->argv[i], sizeof(rx->ClientName));
368 memset(&cr, 0, sizeof(cr));
369 if (!get_client_dbr(ua, &cr)) {
372 bstrncpy(rx->ClientName, cr.Name, sizeof(rx->ClientName));
378 * This is where we pick up a client name to restore to.
380 static int get_restore_client_name(UAContext *ua, RESTORE_CTX &rx)
382 /* Start with same name as backup client */
383 bstrncpy(rx.RestoreClientName, rx.ClientName, sizeof(rx.RestoreClientName));
385 /* try command line argument */
386 int i = find_arg_with_value(ua, NT_("restoreclient"));
388 if (!has_value(ua, i)) {
391 bstrncpy(rx.RestoreClientName, ua->argv[i], sizeof(rx.RestoreClientName));
400 * The first step in the restore process is for the user to
401 * select a list of JobIds from which he will subsequently
402 * select which files are to be restored.
404 * Returns: 2 if filename list made
405 * 1 if jobid list made
408 static int user_select_jobids_or_files(UAContext *ua, RESTORE_CTX *rx)
411 char date[MAX_TIME_LENGTH];
412 bool have_date = false;
413 /* Include current second if using current time */
414 utime_t now = time(NULL) + 1;
416 JOB_DBR jr = { (JobId_t)-1 };
419 const char *list[] = {
420 _("List last 20 Jobs run"),
421 _("List Jobs where a given File is saved"),
422 _("Enter list of comma separated JobIds to select"),
423 _("Enter SQL list command"),
424 _("Select the most recent backup for a client"),
425 _("Select backup for a client before a specified time"),
426 _("Enter a list of files to restore"),
427 _("Enter a list of files to restore before a specified time"),
428 _("Find the JobIds of the most recent backup for a client"),
429 _("Find the JobIds for a backup for a client before a specified time"),
430 _("Enter a list of directories to restore for found JobIds"),
431 _("Select full restore to a specified JobId"),
436 /* These keywords are handled in a for loop */
446 /* The keyword below are handled by individual arg lookups */
452 "bootstrap", /* 13 */
454 "strip_prefix", /* 15 */
455 "add_prefix", /* 16 */
456 "add_suffix", /* 17 */
457 "regexwhere", /* 18 */
458 "restoreclient", /* 19 */
465 for (i=1; i<ua->argc; i++) { /* loop through arguments */
466 bool found_kw = false;
467 for (j=0; kw[j]; j++) { /* loop through keywords */
468 if (strcasecmp(kw[j], ua->argk[i]) == 0) {
474 ua->error_msg(_("Unknown keyword: %s\n"), ua->argk[i]);
477 /* Found keyword in kw[] list, process it */
480 if (!has_value(ua, i)) {
483 if (*rx->JobIds != 0) {
484 pm_strcat(rx->JobIds, ",");
486 pm_strcat(rx->JobIds, ua->argv[i]);
489 case 1: /* current */
491 * Note, we add one second here just to include any job
492 * that may have finished within the current second,
493 * which happens a lot in scripting small jobs.
495 bstrutime(date, sizeof(date), now);
499 if (have_date || !has_value(ua, i)) {
502 if (str_to_utime(ua->argv[i]) == 0) {
503 ua->error_msg(_("Improper date format: %s\n"), ua->argv[i]);
506 bstrncpy(date, ua->argv[i], sizeof(date));
511 if (!has_value(ua, i)) {
515 bstrutime(date, sizeof(date), now);
517 if (!get_client_name(ua, rx)) {
520 pm_strcpy(ua->cmd, ua->argv[i]);
521 insert_one_file_or_dir(ua, rx, date, j==4);
525 bstrutime(date, sizeof(date), now);
527 if (!select_backups_before_date(ua, rx, date)) {
532 case 6: /* pool specified */
533 if (!has_value(ua, i)) {
536 rx->pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
538 ua->error_msg(_("Error: Pool resource \"%s\" does not exist.\n"), ua->argv[i]);
541 if (!acl_access_ok(ua, Pool_ACL, ua->argv[i])) {
543 ua->error_msg(_("Error: Pool resource \"%s\" access not allowed.\n"), ua->argv[i]);
547 case 7: /* all specified */
551 * All keywords 7 or greater are ignored or handled by a select prompt
559 ua->send_msg(_("\nFirst you select one or more JobIds that contain files\n"
560 "to be restored. You will be presented several methods\n"
561 "of specifying the JobIds. Then you will be allowed to\n"
562 "select which files from those JobIds are to be restored.\n\n"));
565 /* If choice not already made above, prompt */
571 start_prompt(ua, _("To select the JobIds, you have the following choices:\n"));
572 for (int i=0; list[i]; i++) {
573 add_prompt(ua, list[i]);
576 switch (do_prompt(ua, "", _("Select item: "), NULL, 0)) {
577 case -1: /* error or cancel */
579 case 0: /* list last 20 Jobs run */
580 if (!acl_access_ok(ua, Command_ACL, NT_("sqlquery"), 8)) {
581 ua->error_msg(_("SQL query not authorized.\n"));
584 gui_save = ua->jcr->gui;
586 db_list_sql_query(ua->jcr, ua->db, uar_list_jobs, prtit, ua, 1, HORZ_LIST);
587 ua->jcr->gui = gui_save;
590 case 1: /* list where a file is saved */
591 if (!get_client_name(ua, rx)) {
594 if (!get_cmd(ua, _("Enter Filename (no path):"))) {
597 len = strlen(ua->cmd);
598 fname = (char *)malloc(len * 2 + 1);
599 db_escape_string(ua->jcr, ua->db, fname, ua->cmd, len);
600 Mmsg(rx->query, uar_file[db_type], rx->ClientName, fname);
602 gui_save = ua->jcr->gui;
604 db_list_sql_query(ua->jcr, ua->db, rx->query, prtit, ua, 1, HORZ_LIST);
605 ua->jcr->gui = gui_save;
608 case 2: /* enter a list of JobIds */
609 if (!get_cmd(ua, _("Enter JobId(s), comma separated, to restore: "))) {
612 pm_strcpy(rx->JobIds, ua->cmd);
614 case 3: /* Enter an SQL list command */
615 if (!acl_access_ok(ua, Command_ACL, NT_("sqlquery"), 8)) {
616 ua->error_msg(_("SQL query not authorized.\n"));
619 if (!get_cmd(ua, _("Enter SQL list command: "))) {
622 gui_save = ua->jcr->gui;
624 db_list_sql_query(ua->jcr, ua->db, ua->cmd, prtit, ua, 1, HORZ_LIST);
625 ua->jcr->gui = gui_save;
628 case 4: /* Select the most recent backups */
630 bstrutime(date, sizeof(date), now);
632 if (!select_backups_before_date(ua, rx, date)) {
636 case 5: /* select backup at specified time */
638 if (!get_date(ua, date, sizeof(date))) {
642 if (!select_backups_before_date(ua, rx, date)) {
646 case 6: /* Enter files */
648 bstrutime(date, sizeof(date), now);
650 if (!get_client_name(ua, rx)) {
653 ua->send_msg(_("Enter file names with paths, or < to enter a filename\n"
654 "containing a list of file names with paths, and terminate\n"
655 "them with a blank line.\n"));
657 if (!get_cmd(ua, _("Enter full filename: "))) {
660 len = strlen(ua->cmd);
664 insert_one_file_or_dir(ua, rx, date, false);
667 case 7: /* enter files backed up before specified time */
669 if (!get_date(ua, date, sizeof(date))) {
673 if (!get_client_name(ua, rx)) {
676 ua->send_msg(_("Enter file names with paths, or < to enter a filename\n"
677 "containing a list of file names with paths, and terminate\n"
678 "them with a blank line.\n"));
680 if (!get_cmd(ua, _("Enter full filename: "))) {
683 len = strlen(ua->cmd);
687 insert_one_file_or_dir(ua, rx, date, false);
691 case 8: /* Find JobIds for current backup */
693 bstrutime(date, sizeof(date), now);
695 if (!select_backups_before_date(ua, rx, date)) {
701 case 9: /* Find JobIds for give date */
703 if (!get_date(ua, date, sizeof(date))) {
707 if (!select_backups_before_date(ua, rx, date)) {
713 case 10: /* Enter directories */
714 if (*rx->JobIds != 0) {
715 ua->send_msg(_("You have already selected the following JobIds: %s\n"),
717 } else if (get_cmd(ua, _("Enter JobId(s), comma separated, to restore: "))) {
718 if (*rx->JobIds != 0 && *ua->cmd) {
719 pm_strcat(rx->JobIds, ",");
721 pm_strcat(rx->JobIds, ua->cmd);
723 if (*rx->JobIds == 0 || *rx->JobIds == '.') {
724 return 0; /* nothing entered, return */
727 bstrutime(date, sizeof(date), now);
729 if (!get_client_name(ua, rx)) {
732 ua->send_msg(_("Enter full directory names or start the name\n"
733 "with a < to indicate it is a filename containing a list\n"
734 "of directories and terminate them with a blank line.\n"));
736 if (!get_cmd(ua, _("Enter directory name: "))) {
739 len = strlen(ua->cmd);
743 /* Add trailing slash to end of directory names */
744 if (ua->cmd[0] != '<' && !IsPathSeparator(ua->cmd[len-1])) {
745 strcat(ua->cmd, "/");
747 insert_one_file_or_dir(ua, rx, date, true);
751 case 11: /* Choose a jobid and select jobs */
752 if (!get_cmd(ua, _("Enter JobId to restore: ")) ||
753 !is_an_integer(ua->cmd))
758 memset(&jr, 0, sizeof(JOB_DBR));
759 jr.JobId = str_to_int64(ua->cmd);
760 if (!db_get_job_record(ua->jcr, ua->db, &jr)) {
761 ua->error_msg(_("Unable to get Job record for JobId=%s: ERR=%s\n"),
762 ua->cmd, db_strerror(ua->db));
765 jr.JobLevel = L_INCREMENTAL; /* Take Full+Diff+Incr */
766 if (!db_accurate_get_jobids(ua->jcr, ua->db, &jr, rx->JobIds)) {
769 Dmsg1(30, "Item 12: jobids = %s\n", rx->JobIds);
771 case 12: /* Cancel or quit */
776 memset(&jr, 0, sizeof(JOB_DBR));
777 POOLMEM *JobIds = get_pool_memory(PM_FNAME);
781 * Find total number of files to be restored, and filter the JobId
782 * list to contain only ones permitted by the ACL conditions.
784 for (p=rx->JobIds; ; ) {
786 int stat = get_next_jobid_from_list(&p, &JobId);
788 ua->error_msg(_("Invalid JobId in list.\n"));
789 free_pool_memory(JobIds);
795 if (jr.JobId == JobId) {
796 continue; /* duplicate of last JobId */
798 memset(&jr, 0, sizeof(JOB_DBR));
800 if (!db_get_job_record(ua->jcr, ua->db, &jr)) {
801 ua->error_msg(_("Unable to get Job record for JobId=%s: ERR=%s\n"),
802 edit_int64(JobId, ed1), db_strerror(ua->db));
803 free_pool_memory(JobIds);
806 if (!acl_access_ok(ua, Job_ACL, jr.Name)) {
807 ua->error_msg(_("Access to JobId=%s (Job \"%s\") not authorized. Not selected.\n"),
808 edit_int64(JobId, ed1), jr.Name);
812 pm_strcat(JobIds, ",");
814 pm_strcat(JobIds, edit_int64(JobId, ed1));
815 rx->TotalFiles += jr.JobFiles;
817 free_pool_memory(rx->JobIds);
818 rx->JobIds = JobIds; /* Set ACL filtered list */
819 if (*rx->JobIds == 0) {
820 ua->warning_msg(_("No Jobs selected.\n"));
824 if (strchr(rx->JobIds,',')) {
825 ua->info_msg(_("You have selected the following JobIds: %s\n"), rx->JobIds);
827 ua->info_msg(_("You have selected the following JobId: %s\n"), rx->JobIds);
835 static int get_date(UAContext *ua, char *date, int date_len)
837 ua->send_msg(_("The restored files will the most current backup\n"
838 "BEFORE the date you specify below.\n\n"));
840 if (!get_cmd(ua, _("Enter date as YYYY-MM-DD HH:MM:SS :"))) {
843 if (str_to_utime(ua->cmd) != 0) {
846 ua->error_msg(_("Improper date format.\n"));
848 bstrncpy(date, ua->cmd, date_len);
853 * Insert a single file, or read a list of files from a file
855 static void insert_one_file_or_dir(UAContext *ua, RESTORE_CTX *rx, char *date, bool dir)
865 if ((ffd = fopen(p, "rb")) == NULL) {
867 ua->error_msg(_("Cannot open file %s: ERR=%s\n"),
871 while (fgets(file, sizeof(file), ffd)) {
874 if (!insert_dir_into_findex_list(ua, rx, file, date)) {
875 ua->error_msg(_("Error occurred on line %d of file \"%s\"\n"), line, p);
878 if (!insert_file_into_findex_list(ua, rx, file, date)) {
879 ua->error_msg(_("Error occurred on line %d of file \"%s\"\n"), line, p);
887 insert_table_into_findex_list(ua, rx, p);
891 insert_dir_into_findex_list(ua, rx, ua->cmd, date);
893 insert_file_into_findex_list(ua, rx, ua->cmd, date);
900 * For a given file (path+filename), split into path and file, then
901 * lookup the most recent backup in the catalog to get the JobId
902 * and FileIndex, then insert them into the findex list.
904 static bool insert_file_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *file,
907 strip_trailing_newline(file);
908 split_path_and_filename(ua, rx, file);
909 if (*rx->JobIds == 0) {
910 Mmsg(rx->query, uar_jobid_fileindex, date, rx->path, rx->fname,
913 Mmsg(rx->query, uar_jobids_fileindex, rx->JobIds, date,
914 rx->path, rx->fname, rx->ClientName);
917 /* Find and insert jobid and File Index */
918 if (!db_sql_query(ua->db, rx->query, jobid_fileindex_handler, (void *)rx)) {
919 ua->error_msg(_("Query failed: %s. ERR=%s\n"),
920 rx->query, db_strerror(ua->db));
923 ua->error_msg(_("No database record found for: %s\n"), file);
924 // ua->error_msg("Query=%s\n", rx->query);
931 * For a given path lookup the most recent backup in the catalog
932 * to get the JobId and FileIndexes of all files in that directory.
934 static bool insert_dir_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *dir,
937 strip_trailing_junk(dir);
938 if (*rx->JobIds == 0) {
939 ua->error_msg(_("No JobId specified cannot continue.\n"));
942 Mmsg(rx->query, uar_jobid_fileindex_from_dir[db_type], rx->JobIds, dir, rx->ClientName);
945 /* Find and insert jobid and File Index */
946 if (!db_sql_query(ua->db, rx->query, jobid_fileindex_handler, (void *)rx)) {
947 ua->error_msg(_("Query failed: %s. ERR=%s\n"),
948 rx->query, db_strerror(ua->db));
951 ua->error_msg(_("No database record found for: %s\n"), dir);
958 * Get the JobId and FileIndexes of all files in the specified table
960 static bool insert_table_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *table)
962 strip_trailing_junk(table);
963 Mmsg(rx->query, uar_jobid_fileindex_from_table, table);
966 /* Find and insert jobid and File Index */
967 if (!db_sql_query(ua->db, rx->query, jobid_fileindex_handler, (void *)rx)) {
968 ua->error_msg(_("Query failed: %s. ERR=%s\n"),
969 rx->query, db_strerror(ua->db));
972 ua->error_msg(_("No table found: %s\n"), table);
978 static void split_path_and_filename(UAContext *ua, RESTORE_CTX *rx, char *name)
982 /* Find path without the filename.
983 * I.e. everything after the last / is a "filename".
984 * OK, maybe it is a directory name, but we treat it like
985 * a filename. If we don't find a / then the whole name
986 * must be a path name (e.g. c:).
988 for (p=f=name; *p; p++) {
989 if (IsPathSeparator(*p)) {
990 f = p; /* set pos of last slash */
993 if (IsPathSeparator(*f)) { /* did we find a slash? */
994 f++; /* yes, point to filename */
995 } else { /* no, whole thing must be path name */
999 /* If filename doesn't exist (i.e. root directory), we
1000 * simply create a blank name consisting of a single
1001 * space. This makes handling zero length filenames
1006 rx->fname = check_pool_memory_size(rx->fname, 2*(rx->fnl)+1);
1007 db_escape_string(ua->jcr, ua->db, rx->fname, f, rx->fnl);
1015 rx->path = check_pool_memory_size(rx->path, 2*(rx->pnl)+1);
1016 db_escape_string(ua->jcr, ua->db, rx->path, name, rx->pnl);
1022 Dmsg2(100, "split path=%s file=%s\n", rx->path, rx->fname);
1025 static bool ask_for_fileregex(UAContext *ua, RESTORE_CTX *rx)
1027 if (find_arg(ua, NT_("all")) >= 0) { /* if user enters all on command line */
1028 return true; /* select everything */
1030 ua->send_msg(_("\n\nFor one or more of the JobIds selected, no files were found,\n"
1031 "so file selection is not possible.\n"
1032 "Most likely your retention policy pruned the files.\n"));
1033 if (get_yesno(ua, _("\nDo you want to restore all the files? (yes|no): "))) {
1034 if (ua->pint32_val == 1)
1036 while (get_cmd(ua, _("\nRegexp matching files to restore? (empty to abort): "))) {
1037 if (ua->cmd[0] == '\0') {
1040 regex_t *fileregex_re = NULL;
1042 char errmsg[500] = "";
1044 fileregex_re = (regex_t *)bmalloc(sizeof(regex_t));
1045 rc = regcomp(fileregex_re, ua->cmd, REG_EXTENDED|REG_NOSUB);
1047 regerror(rc, fileregex_re, errmsg, sizeof(errmsg));
1049 regfree(fileregex_re);
1052 ua->send_msg(_("Regex compile error: %s\n"), errmsg);
1054 rx->bsr->fileregex = bstrdup(ua->cmd);
1063 static bool build_directory_tree(UAContext *ua, RESTORE_CTX *rx)
1066 JobId_t JobId, last_JobId;
1071 memset(&tree, 0, sizeof(TREE_CTX));
1073 * Build the directory tree containing JobIds user selected
1075 tree.root = new_tree(rx->TotalFiles);
1080 * For display purposes, the same JobId, with different volumes may
1081 * appear more than once, however, we only insert it once.
1084 tree.FileEstimate = 0;
1085 if (get_next_jobid_from_list(&p, &JobId) > 0) {
1086 /* Use first JobId as estimate of the number of files to restore */
1087 Mmsg(rx->query, uar_count_files, edit_int64(JobId, ed1));
1088 if (!db_sql_query(ua->db, rx->query, restore_count_handler, (void *)rx)) {
1089 ua->error_msg("%s\n", db_strerror(ua->db));
1092 /* Add about 25% more than this job for over estimate */
1093 tree.FileEstimate = rx->JobId + (rx->JobId >> 2);
1094 tree.DeltaCount = rx->JobId/50; /* print 50 ticks */
1098 ua->info_msg(_("\nBuilding directory tree for JobId(s) %s ... "),
1101 #define new_get_file_list
1102 #ifdef new_get_file_list
1103 if (!db_get_file_list(ua->jcr, ua->db, rx->JobIds, insert_tree_handler, (void *)&tree)) {
1104 ua->error_msg("%s", db_strerror(ua->db));
1106 if (*rx->BaseJobIds) {
1107 pm_strcat(rx->JobIds, ",");
1108 pm_strcat(rx->JobIds, rx->BaseJobIds);
1111 for (p=rx->JobIds; get_next_jobid_from_list(&p, &JobId) > 0; ) {
1114 if (JobId == last_JobId) {
1115 continue; /* eliminate duplicate JobIds */
1119 * Find files for this JobId and insert them in the tree
1121 Mmsg(rx->query, uar_sel_files, edit_int64(JobId, ed1));
1122 if (!db_sql_query(ua->db, rx->query, insert_tree_handler, (void *)&tree)) {
1123 ua->error_msg("%s", db_strerror(ua->db));
1128 * Look at the first JobId on the list (presumably the oldest) and
1129 * if it is marked purged, don't do the manual selection because
1130 * the Job was pruned, so the tree is incomplete.
1132 if (tree.FileCount != 0) {
1133 /* Find out if any Job is purged */
1134 Mmsg(rx->query, "SELECT SUM(PurgedFiles) FROM Job WHERE JobId IN (%s)", rx->JobIds);
1135 if (!db_sql_query(ua->db, rx->query, restore_count_handler, (void *)rx)) {
1136 ua->error_msg("%s\n", db_strerror(ua->db));
1138 /* rx->JobId is the PurgedFiles flag */
1139 if (rx->found && rx->JobId > 0) {
1140 tree.FileCount = 0; /* set count to zero, no tree selection */
1143 if (tree.FileCount == 0) {
1144 OK = ask_for_fileregex(ua, rx);
1147 for (p=rx->JobIds; get_next_jobid_from_list(&p, &JobId) > 0; ) {
1148 if (JobId == last_JobId) {
1149 continue; /* eliminate duplicate JobIds */
1151 add_findex_all(rx->bsr, JobId);
1157 ua->info_msg(_("\n%s files inserted into the tree and marked for extraction.\n"),
1158 edit_uint64_with_commas(tree.FileCount, ec1));
1160 ua->info_msg(_("\n%s files inserted into the tree.\n"),
1161 edit_uint64_with_commas(tree.FileCount, ec1));
1164 if (find_arg(ua, NT_("done")) < 0) {
1165 /* Let the user interact in selecting which files to restore */
1166 OK = user_select_files_from_tree(&tree);
1170 * Walk down through the tree finding all files marked to be
1171 * extracted making a bootstrap file.
1174 for (TREE_NODE *node=first_tree_node(tree.root); node; node=next_tree_node(node)) {
1175 Dmsg2(400, "FI=%d node=0x%x\n", node->FileIndex, node);
1176 if (node->extract || node->extract_dir) {
1177 Dmsg3(400, "JobId=%lld type=%d FI=%d\n", (uint64_t)node->JobId, node->type, node->FileIndex);
1178 add_findex(rx->bsr, node->JobId, node->FileIndex);
1179 if (node->extract && node->type != TN_NEWDIR) {
1180 rx->selected_files++; /* count only saved files */
1187 free_tree(tree.root); /* free the directory tree */
1193 * This routine is used to get the current backup or a backup
1194 * before the specified date.
1196 static bool select_backups_before_date(UAContext *ua, RESTORE_CTX *rx, char *date)
1201 char fileset_name[MAX_NAME_LENGTH];
1202 char ed1[50], ed2[50];
1203 char pool_select[MAX_NAME_LENGTH];
1206 /* Create temp tables */
1207 db_sql_query(ua->db, uar_del_temp, NULL, NULL);
1208 db_sql_query(ua->db, uar_del_temp1, NULL, NULL);
1209 if (!db_sql_query(ua->db, uar_create_temp[db_type], NULL, NULL)) {
1210 ua->error_msg("%s\n", db_strerror(ua->db));
1212 if (!db_sql_query(ua->db, uar_create_temp1[db_type], NULL, NULL)) {
1213 ua->error_msg("%s\n", db_strerror(ua->db));
1216 * Select Client from the Catalog
1218 memset(&cr, 0, sizeof(cr));
1219 if (!get_client_dbr(ua, &cr)) {
1222 bstrncpy(rx->ClientName, cr.Name, sizeof(rx->ClientName));
1227 memset(&fsr, 0, sizeof(fsr));
1228 i = find_arg_with_value(ua, "FileSet");
1230 bstrncpy(fsr.FileSet, ua->argv[i], sizeof(fsr.FileSet));
1231 if (!db_get_fileset_record(ua->jcr, ua->db, &fsr)) {
1232 ua->error_msg(_("Error getting FileSet \"%s\": ERR=%s\n"), fsr.FileSet,
1233 db_strerror(ua->db));
1237 if (i < 0) { /* fileset not found */
1238 edit_int64(cr.ClientId, ed1);
1239 Mmsg(rx->query, uar_sel_fileset, ed1, ed1);
1240 start_prompt(ua, _("The defined FileSet resources are:\n"));
1241 if (!db_sql_query(ua->db, rx->query, fileset_handler, (void *)ua)) {
1242 ua->error_msg("%s\n", db_strerror(ua->db));
1244 if (do_prompt(ua, _("FileSet"), _("Select FileSet resource"),
1245 fileset_name, sizeof(fileset_name)) < 0) {
1246 ua->error_msg(_("No FileSet found for client \"%s\".\n"), cr.Name);
1250 bstrncpy(fsr.FileSet, fileset_name, sizeof(fsr.FileSet));
1251 if (!db_get_fileset_record(ua->jcr, ua->db, &fsr)) {
1252 ua->warning_msg(_("Error getting FileSet record: %s\n"), db_strerror(ua->db));
1253 ua->send_msg(_("This probably means you modified the FileSet.\n"
1254 "Continuing anyway.\n"));
1258 /* If Pool specified, add PoolId specification */
1262 memset(&pr, 0, sizeof(pr));
1263 bstrncpy(pr.Name, rx->pool->name(), sizeof(pr.Name));
1264 if (db_get_pool_record(ua->jcr, ua->db, &pr)) {
1265 bsnprintf(pool_select, sizeof(pool_select), "AND Media.PoolId=%s ",
1266 edit_int64(pr.PoolId, ed1));
1268 ua->warning_msg(_("Pool \"%s\" not found, using any pool.\n"), pr.Name);
1272 /* Find JobId of last Full backup for this client, fileset */
1273 edit_int64(cr.ClientId, ed1);
1274 Mmsg(rx->query, uar_last_full, ed1, ed1, date, fsr.FileSet,
1276 if (!db_sql_query(ua->db, rx->query, NULL, NULL)) {
1277 ua->error_msg("%s\n", db_strerror(ua->db));
1281 /* Find all Volumes used by that JobId */
1282 if (!db_sql_query(ua->db, uar_full, NULL, NULL)) {
1283 ua->error_msg("%s\n", db_strerror(ua->db));
1287 /* Note, this is needed because I don't seem to get the callback
1288 * from the call just above.
1291 if (!db_sql_query(ua->db, uar_sel_all_temp1, last_full_handler, (void *)rx)) {
1292 ua->warning_msg("%s\n", db_strerror(ua->db));
1294 if (rx->JobTDate == 0) {
1295 ua->error_msg(_("No Full backup before %s found.\n"), date);
1299 /* Now find most recent Differental Job after Full save, if any */
1300 Mmsg(rx->query, uar_dif, edit_uint64(rx->JobTDate, ed1), date,
1301 edit_int64(cr.ClientId, ed2), fsr.FileSet, pool_select);
1302 if (!db_sql_query(ua->db, rx->query, NULL, NULL)) {
1303 ua->warning_msg("%s\n", db_strerror(ua->db));
1305 /* Now update JobTDate to look into Differental, if any */
1307 if (!db_sql_query(ua->db, uar_sel_all_temp, last_full_handler, (void *)rx)) {
1308 ua->warning_msg("%s\n", db_strerror(ua->db));
1310 if (rx->JobTDate == 0) {
1311 ua->error_msg(_("No Full backup before %s found.\n"), date);
1315 /* Now find all Incremental Jobs after Full/dif save */
1316 Mmsg(rx->query, uar_inc, edit_uint64(rx->JobTDate, ed1), date,
1317 edit_int64(cr.ClientId, ed2), fsr.FileSet, pool_select);
1318 if (!db_sql_query(ua->db, rx->query, NULL, NULL)) {
1319 ua->warning_msg("%s\n", db_strerror(ua->db));
1322 /* Get the JobIds from that list */
1323 rx->last_jobid[0] = rx->JobIds[0] = 0;
1325 if (!db_sql_query(ua->db, uar_sel_jobid_temp, jobid_handler, (void *)rx)) {
1326 ua->warning_msg("%s\n", db_strerror(ua->db));
1329 if (rx->JobIds[0] != 0) {
1330 if (find_arg(ua, NT_("copies")) > 0) {
1331 /* Display a list of all copies */
1332 db_list_copies_records(ua->jcr, ua->db, 0, rx->JobIds,
1333 prtit, ua, HORZ_LIST);
1335 /* Display a list of Jobs selected for this restore */
1336 db_list_sql_query(ua->jcr, ua->db, uar_list_temp, prtit, ua, 1,HORZ_LIST);
1340 ua->warning_msg(_("No jobs found.\n"));
1344 db_sql_query(ua->db, uar_del_temp, NULL, NULL);
1345 db_sql_query(ua->db, uar_del_temp1, NULL, NULL);
1349 static int restore_count_handler(void *ctx, int num_fields, char **row)
1351 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1352 rx->JobId = str_to_int64(row[0]);
1358 * Callback handler to get JobId and FileIndex for files
1359 * can insert more than one depending on the caller.
1361 static int jobid_fileindex_handler(void *ctx, int num_fields, char **row)
1363 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1365 Dmsg2(200, "JobId=%s FileIndex=%s\n", row[0], row[1]);
1366 rx->JobId = str_to_int64(row[0]);
1367 add_findex(rx->bsr, rx->JobId, str_to_int64(row[1]));
1369 rx->selected_files++;
1374 * Callback handler make list of JobIds
1376 static int jobid_handler(void *ctx, int num_fields, char **row)
1378 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1380 if (strcmp(rx->last_jobid, row[0]) == 0) {
1381 return 0; /* duplicate id */
1383 bstrncpy(rx->last_jobid, row[0], sizeof(rx->last_jobid));
1384 if (rx->JobIds[0] != 0) {
1385 pm_strcat(rx->JobIds, ",");
1387 pm_strcat(rx->JobIds, row[0]);
1393 * Callback handler to pickup last Full backup JobTDate
1395 static int last_full_handler(void *ctx, int num_fields, char **row)
1397 RESTORE_CTX *rx = (RESTORE_CTX *)ctx;
1399 rx->JobTDate = str_to_int64(row[1]);
1404 * Callback handler build FileSet name prompt list
1406 static int fileset_handler(void *ctx, int num_fields, char **row)
1408 /* row[0] = FileSet (name) */
1410 add_prompt((UAContext *)ctx, row[0]);
1416 * Free names in the list
1418 static void free_name_list(NAME_LIST *name_list)
1420 for (int i=0; i < name_list->num_ids; i++) {
1421 free(name_list->name[i]);
1423 bfree_and_null(name_list->name);
1424 name_list->max_ids = 0;
1425 name_list->num_ids = 0;
1428 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType)
1433 Dmsg1(200, "Already have store=%s\n", rx.store->name());
1437 * Try looking up Storage by name
1440 foreach_res(store, R_STORAGE) {
1441 if (strcmp(Storage, store->name()) == 0) {
1442 if (acl_access_ok(ua, Storage_ACL, store->name())) {
1451 /* Check if an explicit storage resource is given */
1453 int i = find_arg_with_value(ua, "storage");
1455 store = (STORE *)GetResWithName(R_STORAGE, ua->argv[i]);
1456 if (store && !acl_access_ok(ua, Storage_ACL, store->name())) {
1460 if (store && (store != rx.store)) {
1461 ua->info_msg(_("Warning default storage overridden by \"%s\" on command line.\n"),
1464 Dmsg1(200, "Set store=%s\n", rx.store->name());
1469 /* If no storage resource, try to find one from MediaType */
1472 foreach_res(store, R_STORAGE) {
1473 if (strcmp(MediaType, store->media_type) == 0) {
1474 if (acl_access_ok(ua, Storage_ACL, store->name())) {
1476 Dmsg1(200, "Set store=%s\n", rx.store->name());
1477 ua->warning_msg(_("Storage \"%s\" not found, using Storage \"%s\" from MediaType \"%s\".\n"),
1478 Storage, store->name(), MediaType);
1485 ua->warning_msg(_("\nUnable to find Storage resource for\n"
1486 "MediaType \"%s\", needed by the Jobs you selected.\n"), MediaType);
1489 /* Take command line arg, or ask user if none */
1490 rx.store = get_storage_resource(ua, false /* don't use default */);
1492 Dmsg1(200, "Set store=%s\n", rx.store->name());