]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/fd_cmds.c
efb5596dc6d892dd69ec7260818f45a4c39ce559
[bacula/bacula] / bacula / src / dird / fd_cmds.c
1 /*
2    Bacula(R) - The Network Backup Solution
3
4    Copyright (C) 2000-2015 Kern Sibbald
5
6    The original author of Bacula is Kern Sibbald, with contributions
7    from many others, a complete list can be found in the file AUTHORS.
8
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.
13
14    This notice must be preserved when any source code is 
15    conveyed and/or propagated.
16
17    Bacula(R) is a registered trademark of Kern Sibbald.
18 */
19 /*
20  *
21  *   Bacula Director -- fd_cmds.c -- send commands to File daemon
22  *
23  *     Kern Sibbald, October MM
24  *
25  *    This routine is run as a separate thread.  There may be more
26  *    work to be done to make it totally reentrant!!!!
27  *
28  *  Utility functions for sending info to File Daemon.
29  *   These functions are used by both backup and verify.
30  *
31  */
32
33 #include "bacula.h"
34 #include "dird.h"
35 #include "findlib/find.h"
36
37 const int dbglvl = 400;
38
39 /* Commands sent to File daemon */
40 static char filesetcmd[]  = "fileset%s%s\n"; /* set full fileset */
41 static char jobcmd[]      = "JobId=%s Job=%s SDid=%u SDtime=%u Authorization=%s\n";
42 /* Note, mtime_only is not used here -- implemented as file option */
43 static char levelcmd[]    = "level = %s%s%s mtime_only=%d %s%s\n";
44 static char runscript[]   = "Run OnSuccess=%u OnFailure=%u AbortOnError=%u When=%u Command=%s\n";
45 static char runbeforenow[]= "RunBeforeNow\n";
46 static char bandwidthcmd[] = "setbandwidth=%lld Job=%s\n";
47 static char component_info[] = "component_info\n";
48
49 /* Responses received from File daemon */
50 static char OKinc[]          = "2000 OK include\n";
51 static char OKjob[]          = "2000 OK Job";
52 static char OKlevel[]        = "2000 OK level\n";
53 static char OKRunScript[]    = "2000 OK RunScript\n";
54 static char OKRunBeforeNow[] = "2000 OK RunBeforeNow\n";
55 static char OKRestoreObject[] = "2000 OK ObjectRestored\n";
56 static char OKComponentInfo[] = "2000 OK ComponentInfo\n";
57 static char OKBandwidth[]    = "2000 OK Bandwidth\n";
58
59 /* Forward referenced functions */
60 static bool send_list_item(JCR *jcr, const char *code, char *item, BSOCK *fd);
61
62 /* External functions */
63 extern DIRRES *director;
64 extern int FDConnectTimeout;
65
66 #define INC_LIST 0
67 #define EXC_LIST 1
68
69 /*
70  * Open connection with File daemon.
71  * Try connecting every retry_interval (default 10 sec), and
72  *   give up after max_retry_time (default 30 mins).
73  */
74
75 int connect_to_file_daemon(JCR *jcr, int retry_interval, int max_retry_time,
76                            int verbose)
77 {
78    BSOCK   *fd = jcr->file_bsock;
79    char ed1[30];
80    utime_t heart_beat;
81
82    if (!jcr->client) {
83       Jmsg(jcr, M_FATAL, 0, _("File daemon not defined for current Job\n"));
84       Dmsg0(10, "No Client defined for the job.\n");
85       return 0;
86    }
87
88    if (jcr->client->heartbeat_interval) {
89       heart_beat = jcr->client->heartbeat_interval;
90    } else {
91       heart_beat = director->heartbeat_interval;
92    }
93
94    if (!is_bsock_open(jcr->file_bsock)) {
95       char name[MAX_NAME_LENGTH + 100];
96
97       if (!fd) {
98          fd = jcr->file_bsock = new_bsock();
99       }
100       bstrncpy(name, _("Client: "), sizeof(name));
101       bstrncat(name, jcr->client->name(), sizeof(name));
102
103       fd->set_source_address(director->DIRsrc_addr);
104       if (!fd->connect(jcr,retry_interval,max_retry_time, heart_beat, name, jcr->client->address,
105            NULL, jcr->client->FDport, verbose)) {
106          fd->close();
107          jcr->setJobStatus(JS_ErrorTerminated);
108          return 0;
109       }
110       Dmsg0(10, "Opened connection with File daemon\n");
111    }
112    fd->res = (RES *)jcr->client;      /* save resource in BSOCK */
113    jcr->setJobStatus(JS_Running);
114
115    if (!authenticate_file_daemon(jcr)) {
116       jcr->setJobStatus(JS_ErrorTerminated);
117       Dmsg0(10, "Authentication error with FD.\n");
118       return 0;
119    }
120
121    /*
122     * Now send JobId and authorization key
123     */
124    if (jcr->sd_auth_key == NULL) {
125       jcr->sd_auth_key = bstrdup("dummy");
126    }
127    fd->fsend(jobcmd, edit_int64(jcr->JobId, ed1), jcr->Job, jcr->VolSessionId,
128              jcr->VolSessionTime, jcr->sd_auth_key);
129    if (!jcr->keep_sd_auth_key && strcmp(jcr->sd_auth_key, "dummy")) {
130       memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
131    }
132    Dmsg1(100, ">filed: %s", fd->msg);
133    if (bget_dirmsg(fd) > 0) {
134        Dmsg1(110, "<filed: %s", fd->msg);
135        if (strncmp(fd->msg, OKjob, strlen(OKjob)) != 0) {
136           Jmsg(jcr, M_FATAL, 0, _("File daemon \"%s\" rejected Job command: %s\n"),
137              jcr->client->hdr.name, fd->msg);
138           jcr->setJobStatus(JS_ErrorTerminated);
139           return 0;
140        } else if (jcr->db) {
141           CLIENT_DBR cr;
142           memset(&cr, 0, sizeof(cr));
143           bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
144           cr.AutoPrune = jcr->client->AutoPrune;
145           cr.FileRetention = jcr->client->FileRetention;
146           cr.JobRetention = jcr->client->JobRetention;
147           bstrncpy(cr.Uname, fd->msg+strlen(OKjob)+1, sizeof(cr.Uname));
148           if (!db_update_client_record(jcr, jcr->db, &cr)) {
149              Jmsg(jcr, M_WARNING, 0, _("Error updating Client record. ERR=%s\n"),
150                 db_strerror(jcr->db));
151           }
152        }
153    } else {
154       Jmsg(jcr, M_FATAL, 0, _("FD gave bad response to JobId command: %s\n"),
155          fd->bstrerror());
156       jcr->setJobStatus(JS_ErrorTerminated);
157       return 0;
158    }
159    return 1;
160 }
161
162 /*
163  * This subroutine edits the last job start time into a
164  *   "since=date/time" buffer that is returned in the
165  *   variable since.  This is used for display purposes in
166  *   the job report.  The time in jcr->stime is later
167  *   passed to tell the File daemon what to do.
168  */
169 void get_level_since_time(JCR *jcr, char *since, int since_len)
170 {
171    int JobLevel;
172    bool have_full;
173    bool do_full = false;
174    bool do_vfull = false;
175    bool do_diff = false;
176    utime_t now;
177    utime_t last_full_time = 0;
178    utime_t last_diff_time;
179    char prev_job[MAX_NAME_LENGTH];
180
181    since[0] = 0;
182    /* If job cloned and a since time already given, use it */
183    if (jcr->cloned && jcr->stime && jcr->stime[0]) {
184       bstrncpy(since, _(", since="), since_len);
185       bstrncat(since, jcr->stime, since_len);
186       return;
187    }
188    /* Make sure stime buffer is allocated */
189    if (!jcr->stime) {
190       jcr->stime = get_pool_memory(PM_MESSAGE);
191    }
192    jcr->PrevJob[0] = jcr->stime[0] = 0;
193    /*
194     * Lookup the last FULL backup job to get the time/date for a
195     * differential or incremental save.
196     */
197    switch (jcr->getJobLevel()) {
198    case L_DIFFERENTIAL:
199    case L_INCREMENTAL:
200       POOLMEM *stime = get_pool_memory(PM_MESSAGE);
201       /* Look up start time of last Full job */
202       now = (utime_t)time(NULL);
203       jcr->jr.JobId = 0;     /* flag to return since time */
204       /*
205        * This is probably redundant, but some of the code below
206        * uses jcr->stime, so don't remove unless you are sure.
207        */
208       if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime, jcr->PrevJob)) {
209          do_full = true;
210       }
211       have_full = db_find_last_job_start_time(jcr, jcr->db, &jcr->jr,
212                                               &stime, prev_job, L_FULL);
213       if (have_full) {
214          last_full_time = str_to_utime(stime);
215       } else {
216          do_full = true;               /* No full, upgrade to one */
217       }
218       Dmsg4(50, "have_full=%d do_full=%d now=%lld full_time=%lld\n", have_full,
219             do_full, now, last_full_time);
220       /* Make sure the last diff is recent enough */
221       if (have_full && jcr->getJobLevel() == L_INCREMENTAL && jcr->job->MaxDiffInterval > 0) {
222          /* Lookup last diff job */
223          if (db_find_last_job_start_time(jcr, jcr->db, &jcr->jr,
224                                          &stime, prev_job, L_DIFFERENTIAL)) {
225             last_diff_time = str_to_utime(stime);
226             /* If no Diff since Full, use Full time */
227             if (last_diff_time < last_full_time) {
228                last_diff_time = last_full_time;
229             }
230             Dmsg2(50, "last_diff_time=%lld last_full_time=%lld\n", last_diff_time,
231                   last_full_time);
232          } else {
233             /* No last differential, so use last full time */
234             last_diff_time = last_full_time;
235             Dmsg1(50, "No last_diff_time setting to full_time=%lld\n", last_full_time);
236          }
237          do_diff = ((now - last_diff_time) >= jcr->job->MaxDiffInterval);
238          Dmsg2(50, "do_diff=%d diffInter=%lld\n", do_diff, jcr->job->MaxDiffInterval);
239       }
240       /* Note, do_full takes precedence over do_vfull and do_diff */
241       if (have_full && jcr->job->MaxFullInterval > 0) {
242          do_full = ((now - last_full_time) >= jcr->job->MaxFullInterval);
243       }
244       else
245       if (have_full && jcr->job->MaxVirtualFullInterval > 0) {
246          do_vfull = ((now - last_full_time) >= jcr->job->MaxVirtualFullInterval);
247       }
248       
249       free_pool_memory(stime);
250
251       if (do_full) {
252          /* No recent Full job found, so upgrade this one to Full */
253          Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
254          Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found in catalog. Doing FULL backup.\n"));
255          bsnprintf(since, since_len, _(" (upgraded from %s)"),
256             level_to_str(jcr->getJobLevel()));
257          jcr->setJobLevel(jcr->jr.JobLevel = L_FULL);
258       } else if (do_vfull) {
259          /* No recent Full job found, and MaxVirtualFull is set so upgrade this one to Virtual Full */
260          Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
261          Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found in catalog. Doing Virtual FULL backup.\n"));
262          bsnprintf(since, since_len, _(" (upgraded from %s)"),
263             level_to_str(jcr->getJobLevel()));
264          jcr->setJobLevel(jcr->jr.JobLevel = L_VIRTUAL_FULL);
265       } else if (do_diff) {
266          /* No recent diff job found, so upgrade this one to Diff */
267          Jmsg(jcr, M_INFO, 0, _("No prior or suitable Differential backup found in catalog. Doing Differential backup.\n"));
268          bsnprintf(since, since_len, _(" (upgraded from %s)"),
269             level_to_str(jcr->getJobLevel()));
270          jcr->setJobLevel(jcr->jr.JobLevel = L_DIFFERENTIAL);
271       } else {
272          if (jcr->job->rerun_failed_levels) {
273
274             POOLMEM *etime = get_pool_memory(PM_MESSAGE);
275
276             /* Get the end time of our most recent successfull backup for this job */
277             /* This will be used to see if there have been any failures since then */
278             if (db_find_last_job_end_time(jcr, jcr->db, &jcr->jr, &etime, prev_job)) {
279
280                /* See if there are any failed Differential/Full backups since the completion */
281                /* of our last successful backup for this job                                 */
282                if (db_find_failed_job_since(jcr, jcr->db, &jcr->jr,
283                                          etime, JobLevel)) {
284                  /* If our job is an Incremental and we have a failed job then upgrade.              */
285                  /* If our job is a Differential and the failed job is a Full then upgrade.          */
286                  /* Otherwise there is no reason to upgrade.                                         */
287                  if ((jcr->getJobLevel() == L_INCREMENTAL) || 
288                      ((jcr->getJobLevel() == L_DIFFERENTIAL) && (JobLevel == L_FULL))) {
289                     Jmsg(jcr, M_INFO, 0, _("Prior failed job found in catalog. Upgrading to %s.\n"),
290                        level_to_str(JobLevel));
291                     bsnprintf(since, since_len, _(" (upgraded from %s)"),
292                              level_to_str(jcr->getJobLevel()));
293                     jcr->setJobLevel(jcr->jr.JobLevel = JobLevel);
294                     jcr->jr.JobId = jcr->JobId;
295                     break;
296                  }
297                }
298             }
299             free_pool_memory(etime);
300          }
301          bstrncpy(since, _(", since="), since_len);
302          bstrncat(since, jcr->stime, since_len);
303       }
304       jcr->jr.JobId = jcr->JobId;
305       break;
306    }
307    Dmsg3(100, "Level=%c last start time=%s job=%s\n",
308          jcr->getJobLevel(), jcr->stime, jcr->PrevJob);
309 }
310
311 static void send_since_time(JCR *jcr)
312 {
313    BSOCK   *fd = jcr->file_bsock;
314    utime_t stime;
315    char ed1[50];
316
317    stime = str_to_utime(jcr->stime);
318    fd->fsend(levelcmd, "", NT_("since_utime "), edit_uint64(stime, ed1), 0,
319              NT_("prev_job="), jcr->PrevJob);
320    while (bget_dirmsg(fd) >= 0) {  /* allow him to poll us to sync clocks */
321       Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
322    }
323 }
324
325 bool send_bwlimit(JCR *jcr, const char *Job)
326 {
327    BSOCK *fd = jcr->file_bsock;
328    if (jcr->FDVersion >= 4) {
329       fd->fsend(bandwidthcmd, jcr->max_bandwidth, Job);
330       if (!response(jcr, fd, OKBandwidth, "Bandwidth", DISPLAY_ERROR)) {
331          jcr->max_bandwidth = 0;      /* can't set bandwidth limit */
332          return false;
333       }
334    }
335    return true;
336 }
337
338 /*
339  * Send level command to FD.
340  * Used for backup jobs and estimate command.
341  */
342 bool send_level_command(JCR *jcr)
343 {
344    BSOCK   *fd = jcr->file_bsock;
345    const char *accurate = jcr->accurate?"accurate_":"";
346    const char *not_accurate = "";
347    const char *rerunning = jcr->rerunning?" rerunning ":" ";
348    /*
349     * Send Level command to File daemon
350     */
351    switch (jcr->getJobLevel()) {
352    case L_BASE:
353       fd->fsend(levelcmd, not_accurate, "base", rerunning, 0, "", "");
354       break;
355    /* L_NONE is the console, sending something off to the FD */
356    case L_NONE:
357    case L_FULL:
358       fd->fsend(levelcmd, not_accurate, "full", rerunning, 0, "", "");
359       break;
360    case L_DIFFERENTIAL:
361       fd->fsend(levelcmd, accurate, "differential", rerunning, 0, "", "");
362       send_since_time(jcr);
363       break;
364    case L_INCREMENTAL:
365       fd->fsend(levelcmd, accurate, "incremental", rerunning, 0, "", "");
366       send_since_time(jcr);
367       break;
368    case L_SINCE:
369    default:
370       Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
371          jcr->getJobLevel(), jcr->getJobLevel());
372       return 0;
373    }
374    Dmsg1(120, ">filed: %s", fd->msg);
375    if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
376       return false;
377    }
378    return true;
379 }
380
381 /*
382  * Send either an Included or an Excluded list to FD
383  */
384 static bool send_fileset(JCR *jcr)
385 {
386    FILESET *fileset = jcr->fileset;
387    BSOCK   *fd = jcr->file_bsock;
388    STORE   *store = jcr->wstore;
389    int num;
390    bool include = true;
391
392    for ( ;; ) {
393       if (include) {
394          num = fileset->num_includes;
395       } else {
396          num = fileset->num_excludes;
397       }
398       for (int i=0; i<num; i++) {
399          char *item;
400          INCEXE *ie;
401          int j, k;
402
403          if (include) {
404             ie = fileset->include_items[i];
405             fd->fsend("I\n");
406          } else {
407             ie = fileset->exclude_items[i];
408             fd->fsend("E\n");
409          }
410          if (ie->ignoredir) {
411             fd->fsend("Z %s\n", ie->ignoredir);
412          }
413          for (j=0; j<ie->num_opts; j++) {
414             FOPTS *fo = ie->opts_list[j];
415             bool enhanced_wild = false;
416             bool stripped_opts = false;
417             bool compress_disabled = false;
418             char newopts[MAX_FOPTS];
419
420             for (k=0; fo->opts[k]!='\0'; k++) {
421                if (fo->opts[k]=='W') {
422                   enhanced_wild = true;
423                   break;
424                }
425             }
426
427             /*
428              * Strip out compression option Zn if disallowed
429              *  for this Storage.
430              * Strip out dedup option dn if old FD
431              */
432             bool strip_compress = store && !store->AllowCompress;
433             if (strip_compress || jcr->FDVersion >= 11) {
434                int j = 0;
435                for (k=0; fo->opts[k]!='\0'; k++) {
436                   /* Z compress option is followed by the single-digit compress level or 'o' */
437                   if (strip_compress && fo->opts[k]=='Z') {
438                      stripped_opts = true;
439                      compress_disabled = true;
440                      k++;                /* skip level */
441                   } else if (jcr->FDVersion < 11 && fo->opts[k]=='d') {
442                      stripped_opts = true;
443                      k++;              /* skip level */
444                   } else {
445                      newopts[j] = fo->opts[k];
446                      j++;
447                   }
448                }
449                newopts[j] = '\0';
450                if (compress_disabled) {
451                   Jmsg(jcr, M_INFO, 0,
452                       _("FD compression disabled for this Job because AllowCompress=No in Storage resource.\n") );
453                }
454             }
455             if (stripped_opts) {
456                /* Send the new trimmed option set without overwriting fo->opts */
457                fd->fsend("O %s\n", newopts);
458             } else {
459                /* Send the original options */
460                fd->fsend("O %s\n", fo->opts);
461             }
462             for (k=0; k<fo->regex.size(); k++) {
463                fd->fsend("R %s\n", fo->regex.get(k));
464             }
465             for (k=0; k<fo->regexdir.size(); k++) {
466                fd->fsend("RD %s\n", fo->regexdir.get(k));
467             }
468             for (k=0; k<fo->regexfile.size(); k++) {
469                fd->fsend("RF %s\n", fo->regexfile.get(k));
470             }
471             for (k=0; k<fo->wild.size(); k++) {
472                fd->fsend("W %s\n", fo->wild.get(k));
473             }
474             for (k=0; k<fo->wilddir.size(); k++) {
475                fd->fsend("WD %s\n", fo->wilddir.get(k));
476             }
477             for (k=0; k<fo->wildfile.size(); k++) {
478                fd->fsend("WF %s\n", fo->wildfile.get(k));
479             }
480             for (k=0; k<fo->wildbase.size(); k++) {
481                fd->fsend("W%c %s\n", enhanced_wild ? 'B' : 'F', fo->wildbase.get(k));
482             }
483             for (k=0; k<fo->base.size(); k++) {
484                fd->fsend("B %s\n", fo->base.get(k));
485             }
486             for (k=0; k<fo->fstype.size(); k++) {
487                fd->fsend("X %s\n", fo->fstype.get(k));
488             }
489             for (k=0; k<fo->drivetype.size(); k++) {
490                fd->fsend("XD %s\n", fo->drivetype.get(k));
491             }
492             if (fo->plugin) {
493                fd->fsend("G %s\n", fo->plugin);
494             }
495             if (fo->reader) {
496                fd->fsend("D %s\n", fo->reader);
497             }
498             if (fo->writer) {
499                fd->fsend("T %s\n", fo->writer);
500             }
501             fd->fsend("N\n");
502          }
503
504          for (j=0; j<ie->name_list.size(); j++) {
505             item = (char *)ie->name_list.get(j);
506             if (!send_list_item(jcr, "F ", item, fd)) {
507                goto bail_out;
508             }
509          }
510          fd->fsend("N\n");
511          for (j=0; j<ie->plugin_list.size(); j++) {
512             item = (char *)ie->plugin_list.get(j);
513             if (!send_list_item(jcr, "P ", item, fd)) {
514                goto bail_out;
515             }
516          }
517          fd->fsend("N\n");
518       }
519       if (!include) {                 /* If we just did excludes */
520          break;                       /*   all done */
521       }
522       include = false;                /* Now do excludes */
523    }
524
525    fd->signal(BNET_EOD);              /* end of data */
526    if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
527       goto bail_out;
528    }
529    return true;
530
531 bail_out:
532    jcr->setJobStatus(JS_ErrorTerminated);
533    return false;
534
535 }
536
537 static bool send_list_item(JCR *jcr, const char *code, char *item, BSOCK *fd)
538 {
539    BPIPE *bpipe;
540    FILE *ffd;
541    char buf[2000];
542    int optlen, stat;
543    char *p = item;
544
545    switch (*p) {
546    case '|':
547       p++;                      /* skip over the | */
548       fd->msg = edit_job_codes(jcr, fd->msg, p, "");
549       bpipe = open_bpipe(fd->msg, 0, "r");
550       if (!bpipe) {
551          berrno be;
552          Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
553             p, be.bstrerror());
554          return false;
555       }
556       bstrncpy(buf, code, sizeof(buf));
557       Dmsg1(500, "code=%s\n", buf);
558       optlen = strlen(buf);
559       while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
560          fd->msglen = Mmsg(fd->msg, "%s", buf);
561          Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
562          if (!fd->send()) {
563             close_bpipe(bpipe);
564             Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
565             return false;
566          }
567       }
568       if ((stat=close_bpipe(bpipe)) != 0) {
569          berrno be;
570          Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
571             p, be.bstrerror(stat));
572          return false;
573       }
574       break;
575    case '<':
576       p++;                      /* skip over < */
577       if ((ffd = fopen(p, "rb")) == NULL) {
578          berrno be;
579          Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
580             p, be.bstrerror());
581          return false;
582       }
583       bstrncpy(buf, code, sizeof(buf));
584       Dmsg1(500, "code=%s\n", buf);
585       optlen = strlen(buf);
586       while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
587          fd->msglen = Mmsg(fd->msg, "%s", buf);
588          if (!fd->send()) {
589             fclose(ffd);
590             Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
591             return false;
592          }
593       }
594       fclose(ffd);
595       break;
596    case '\\':
597       p++;                      /* skip over \ */
598       /* Note, fall through wanted */
599    default:
600       pm_strcpy(fd->msg, code);
601       fd->msglen = pm_strcat(fd->msg, p);
602       Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
603       if (!fd->send()) {
604          Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
605          return false;
606       }
607       break;
608    }
609    return true;
610 }
611
612
613 /*
614  * Send include list to File daemon
615  */
616 bool send_include_list(JCR *jcr)
617 {
618    BSOCK *fd = jcr->file_bsock;
619    if (jcr->fileset->new_include) {
620       fd->fsend(filesetcmd,
621                 jcr->fileset->enable_vss ? " vss=1" : "",
622                 jcr->fileset->enable_snapshot ? " snap=1" : "");
623       return send_fileset(jcr);
624    }
625    return true;
626 }
627
628 /*
629  * Send exclude list to File daemon
630  *   Under the new scheme, the Exclude list
631  *   is part of the FileSet sent with the
632  *   "include_list" above.
633  */
634 bool send_exclude_list(JCR *jcr)
635 {
636    return true;
637 }
638
639 /* TODO: drop this with runscript.old_proto in bacula 1.42 */
640 static char runbefore[]   = "RunBeforeJob %s\n";
641 static char runafter[]    = "RunAfterJob %s\n";
642 static char OKRunBefore[] = "2000 OK RunBefore\n";
643 static char OKRunAfter[]  = "2000 OK RunAfter\n";
644
645 int send_runscript_with_old_proto(JCR *jcr, int when, POOLMEM *msg)
646 {
647    int ret;
648    Dmsg1(120, "bdird: sending old runcommand to fd '%s'\n",msg);
649    if (when & SCRIPT_Before) {
650       jcr->file_bsock->fsend(runbefore, msg);
651       ret = response(jcr, jcr->file_bsock, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR);
652    } else {
653       jcr->file_bsock->fsend(runafter, msg);
654       ret = response(jcr, jcr->file_bsock, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR);
655    }
656    return ret;
657 } /* END OF TODO */
658
659 /*
660  * Send RunScripts to File daemon
661  * 1) We send all runscript to FD, they can be executed Before, After, or twice
662  * 2) Then, we send a "RunBeforeNow" command to the FD to tell him to do the
663  *    first run_script() call. (ie ClientRunBeforeJob)
664  */
665 int send_runscripts_commands(JCR *jcr)
666 {
667    POOLMEM *msg = get_pool_memory(PM_FNAME);
668    BSOCK *fd = jcr->file_bsock;
669    RUNSCRIPT *cmd;
670    bool launch_before_cmd = false;
671    POOLMEM *ehost = get_pool_memory(PM_FNAME);
672    int result;
673
674    Dmsg0(120, "bdird: sending runscripts to fd\n");
675    if (!jcr->job->RunScripts) {
676       goto norunscript;
677    }
678    foreach_alist(cmd, jcr->job->RunScripts) {
679       if (cmd->can_run_at_level(jcr->getJobLevel()) && cmd->target) {
680          ehost = edit_job_codes(jcr, ehost, cmd->target, "");
681          Dmsg2(200, "bdird: runscript %s -> %s\n", cmd->target, ehost);
682
683          if (strcmp(ehost, jcr->client->name()) == 0) {
684             pm_strcpy(msg, cmd->command);
685             bash_spaces(msg);
686
687             Dmsg1(120, "bdird: sending runscripts to fd '%s'\n", cmd->command);
688
689             /* TODO: remove this with bacula 1.42 */
690             if (cmd->old_proto) {
691                result = send_runscript_with_old_proto(jcr, cmd->when, msg);
692
693             } else {
694                fd->fsend(runscript, cmd->on_success,
695                                     cmd->on_failure,
696                                     cmd->fail_on_error,
697                                     cmd->when,
698                                     msg);
699
700                result = response(jcr, fd, OKRunScript, "RunScript", DISPLAY_ERROR);
701                launch_before_cmd = true;
702             }
703
704             if (!result) {
705                goto bail_out;
706             }
707          }
708          /* TODO : we have to play with other client */
709          /*
710            else {
711            send command to an other client
712            }
713          */
714       }
715    }
716
717    /* Tell the FD to execute the ClientRunBeforeJob */
718    if (launch_before_cmd) {
719       fd->fsend(runbeforenow);
720       if (!response(jcr, fd, OKRunBeforeNow, "RunBeforeNow", DISPLAY_ERROR)) {
721         goto bail_out;
722       }
723    }
724 norunscript:
725    free_pool_memory(msg);
726    free_pool_memory(ehost);
727    return 1;
728
729 bail_out:
730    Jmsg(jcr, M_FATAL, 0, _("Client \"%s\" RunScript failed.\n"), ehost);
731    free_pool_memory(msg);
732    free_pool_memory(ehost);
733    return 0;
734 }
735
736 struct OBJ_CTX {
737    JCR *jcr;
738    int count;
739 };
740
741 static int restore_object_handler(void *ctx, int num_fields, char **row)
742 {
743    OBJ_CTX *octx = (OBJ_CTX *)ctx;
744    JCR *jcr = octx->jcr;
745    BSOCK *fd;
746
747    fd = jcr->file_bsock;
748    if (jcr->is_job_canceled()) {
749       return 1;
750    }
751    /* Old File Daemon doesn't handle restore objects */
752    if (jcr->FDVersion < 3) {
753       Jmsg(jcr, M_WARNING, 0, _("Client \"%s\" may not be used to restore "
754                                 "this job. Please upgrade your client.\n"),
755            jcr->client->name());
756       return 1;
757    }
758
759    if (jcr->FDVersion < 5) {    /* Old version without PluginName */
760       fd->fsend("restoreobject JobId=%s %s,%s,%s,%s,%s,%s\n",
761                 row[0], row[1], row[2], row[3], row[4], row[5], row[6]);
762    } else {
763       /* bash spaces from PluginName */
764       bash_spaces(row[9]);
765       fd->fsend("restoreobject JobId=%s %s,%s,%s,%s,%s,%s,%s\n",
766                 row[0], row[1], row[2], row[3], row[4], row[5], row[6], row[9]);
767    }
768    Dmsg1(010, "Send obj hdr=%s", fd->msg);
769
770    fd->msglen = pm_strcpy(fd->msg, row[7]);
771    fd->send();                            /* send Object name */
772
773    Dmsg1(010, "Send obj: %s\n", fd->msg);
774
775 //   fd->msglen = str_to_uint64(row[1]);   /* object length */
776 //   Dmsg1(000, "obj size: %lld\n", (uint64_t)fd->msglen);
777
778    /* object */
779    db_unescape_object(jcr, jcr->db,
780                       row[8],                /* Object  */
781                       str_to_uint64(row[1]), /* Object length */
782                       &fd->msg, &fd->msglen);
783    fd->send();                           /* send object */
784    octx->count++;
785
786    if (debug_level > 100) {
787       for (int i=0; i < fd->msglen; i++)
788          if (!fd->msg[i])
789             fd->msg[i] = ' ';
790       Dmsg1(000, "Send obj: %s\n", fd->msg);
791    }
792
793    return 0;
794 }
795
796 /*
797  * Send the plugin Restore Objects, which allow the
798  *  plugin to get information early in the restore
799  *  process.  The RestoreObjects were created during
800  *  the backup by the plugin.
801  */
802 bool send_restore_objects(JCR *jcr)
803 {
804    char ed1[50];
805    POOL_MEM query(PM_MESSAGE);
806    BSOCK *fd;
807    OBJ_CTX octx;
808
809    if (!jcr->JobIds || !jcr->JobIds[0]) {
810       return true;
811    }
812    octx.jcr = jcr;
813    octx.count = 0;
814
815    /* restore_object_handler is called for each file found */
816
817    /* send restore objects for all jobs involved  */
818    Mmsg(query, get_restore_objects, jcr->JobIds, FT_RESTORE_FIRST);
819    db_sql_query(jcr->db, query.c_str(), restore_object_handler, (void *)&octx);
820
821    /* send config objects for the current restore job */
822    Mmsg(query, get_restore_objects,
823         edit_uint64(jcr->JobId, ed1), FT_PLUGIN_CONFIG_FILLED);
824    db_sql_query(jcr->db, query.c_str(), restore_object_handler, (void *)&octx);
825
826    /*
827     * Send to FD only if we have at least one restore object.
828     * This permits backward compatibility with older FDs.
829     */
830    if (octx.count > 0) {
831       fd = jcr->file_bsock;
832       fd->fsend("restoreobject end\n");
833       if (!response(jcr, fd, OKRestoreObject, "RestoreObject", DISPLAY_ERROR)) {
834          Jmsg(jcr, M_FATAL, 0, _("RestoreObject failed.\n"));
835          return false;
836       }
837    }
838    return true;
839 }
840
841 /*
842  * Send the plugin a list of component info files.  These
843  *  were files that were created during the backup for
844  *  the VSS plugin.  The list is a list of those component
845  *  files that have been chosen for restore.  We
846  *  send them before the Restore Objects.
847  */
848 bool send_component_info(JCR *jcr)
849 {
850    BSOCK *fd;
851    char buf[2000];
852    bool ok = true;
853
854    if (!jcr->component_fd) {
855       return true;           /* nothing to send */
856    }
857    /* Don't send if old version FD */
858    if (jcr->FDVersion < 6) {
859       goto bail_out;
860    }
861
862    rewind(jcr->component_fd);
863    fd = jcr->file_bsock;
864    fd->fsend(component_info);
865    while (fgets(buf, sizeof(buf), jcr->component_fd)) {
866       fd->fsend("%s", buf);
867       Dmsg1(050, "Send component_info to FD: %s\n", buf);
868    }
869    fd->signal(BNET_EOD);
870    if (!response(jcr, fd, OKComponentInfo, "ComponentInfo", DISPLAY_ERROR)) {
871       Jmsg(jcr, M_FATAL, 0, _("ComponentInfo failed.\n"));
872       ok = false;
873    }
874
875 bail_out:
876    fclose(jcr->component_fd);
877    jcr->component_fd = NULL;
878    unlink(jcr->component_fname);
879    free_and_null_pool_memory(jcr->component_fname);
880    return ok;
881 }
882
883 /*
884  * Read the attributes from the File daemon for
885  * a Verify job and store them in the catalog.
886  */
887 int get_attributes_and_put_in_catalog(JCR *jcr)
888 {
889    BSOCK   *fd;
890    int n = 0;
891    ATTR_DBR *ar = NULL;
892    char digest[MAXSTRING];
893
894    fd = jcr->file_bsock;
895    jcr->jr.FirstIndex = 1;
896    jcr->FileIndex = 0;
897    /* Start transaction allocates jcr->attr and jcr->ar if needed */
898    db_start_transaction(jcr, jcr->db);     /* start transaction if not already open */
899    ar = jcr->ar;
900
901    Dmsg0(120, "bdird: waiting to receive file attributes\n");
902    /* Pickup file attributes and digest */
903    while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
904       uint32_t file_index;
905       int stream, len;
906       char *p, *fn;
907       char Digest[MAXSTRING];      /* either Verify opts or MD5/SHA1 digest */
908
909       /* Stop here if canceled */
910       if (jcr->is_job_canceled()) {
911          jcr->cached_attribute = false;
912          return 0;
913       }
914
915       if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Digest)) != 3) {
916          Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n"
917 "msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
918          jcr->setJobStatus(JS_ErrorTerminated);
919          jcr->cached_attribute = false;
920          return 0;
921       }
922       p = fd->msg;
923       /* The following three fields were sscanf'ed above so skip them */
924       skip_nonspaces(&p);             /* skip FileIndex */
925       skip_spaces(&p);
926       skip_nonspaces(&p);             /* skip Stream */
927       skip_spaces(&p);
928       skip_nonspaces(&p);             /* skip Opts_Digest */
929       p++;                            /* skip space */
930       Dmsg1(dbglvl, "Stream=%d\n", stream);
931       if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
932          if (jcr->cached_attribute) {
933             Dmsg3(dbglvl, "Cached attr. Stream=%d fname=%s\n", ar->Stream, ar->fname,
934                ar->attr);
935             if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
936                Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
937             }
938             jcr->cached_attribute = false;
939          }
940          /* Any cached attr is flushed so we can reuse jcr->attr and jcr->ar */
941          fn = jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
942          while (*p != 0) {
943             *fn++ = *p++;                /* copy filename */
944          }
945          *fn = *p++;                     /* term filename and point p to attribs */
946          pm_strcpy(jcr->attr, p);        /* save attributes */
947          jcr->JobFiles++;
948          jcr->FileIndex = file_index;
949          ar->attr = jcr->attr;
950          ar->fname = jcr->fname;
951          ar->FileIndex = file_index;
952          ar->Stream = stream;
953          ar->link = NULL;
954          ar->JobId = jcr->JobId;
955          ar->ClientId = jcr->ClientId;
956          ar->PathId = 0;
957          ar->FilenameId = 0;
958          ar->Digest = NULL;
959          ar->DigestType = CRYPTO_DIGEST_NONE;
960          ar->DeltaSeq = 0;
961          jcr->cached_attribute = true;
962
963          Dmsg2(dbglvl, "dird<filed: stream=%d %s\n", stream, jcr->fname);
964          Dmsg1(dbglvl, "dird<filed: attr=%s\n", ar->attr);
965          jcr->FileId = ar->FileId;
966       /*
967        * First, get STREAM_UNIX_ATTRIBUTES and fill ATTR_DBR structure
968        * Next, we CAN have a CRYPTO_DIGEST, so we fill ATTR_DBR with it (or not)
969        * When we get a new STREAM_UNIX_ATTRIBUTES, we known that we can add file to the catalog
970        * At the end, we have to add the last file
971        */
972       } else if (crypto_digest_stream_type(stream) != CRYPTO_DIGEST_NONE) {
973          if (jcr->FileIndex != (uint32_t)file_index) {
974             Jmsg3(jcr, M_ERROR, 0, _("%s index %d not same as attributes %d\n"),
975                stream_to_ascii(stream), file_index, jcr->FileIndex);
976             continue;
977          }
978          ar->Digest = digest;
979          ar->DigestType = crypto_digest_stream_type(stream);
980          db_escape_string(jcr, jcr->db, digest, Digest, strlen(Digest));
981          Dmsg4(dbglvl, "stream=%d DigestLen=%d Digest=%s type=%d\n", stream,
982                strlen(digest), digest, ar->DigestType);
983       }
984       jcr->jr.JobFiles = jcr->JobFiles = file_index;
985       jcr->jr.LastIndex = file_index;
986    }
987    if (fd->is_error()) {
988       Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
989             fd->bstrerror());
990       jcr->cached_attribute = false;
991       return 0;
992    }
993    if (jcr->cached_attribute) {
994       Dmsg3(dbglvl, "Cached attr with digest. Stream=%d fname=%s attr=%s\n", ar->Stream,
995          ar->fname, ar->attr);
996       if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
997          Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
998       }
999       jcr->cached_attribute = false;
1000    }
1001    jcr->setJobStatus(JS_Terminated);
1002    return 1;
1003 }