]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/message.c
Implement berrno for bpipes and run_program
[bacula/bacula] / bacula / src / lib / message.c
1 /*
2  * Bacula message handling routines
3  *
4  *   Kern Sibbald, April 2000 
5  *
6  *   Version $Id$
7  *
8  */
9
10 /*
11    Copyright (C) 2000-2004 Kern Sibbald and John Walker
12
13    This program is free software; you can redistribute it and/or
14    modify it under the terms of the GNU General Public License as
15    published by the Free Software Foundation; either version 2 of
16    the License, or (at your option) any later version.
17
18    This program is distributed in the hope that it will be useful,
19    but WITHOUT ANY WARRANTY; without even the implied warranty of
20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21    General Public License for more details.
22
23    You should have received a copy of the GNU General Public
24    License along with this program; if not, write to the Free
25    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
26    MA 02111-1307, USA.
27
28  */
29
30
31 #include "bacula.h"
32 #include "jcr.h"
33
34 #if !defined(HAVE_CONSOLE)
35 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
36 #include <windows.h>
37 #endif
38 #endif
39
40 #define FULL_LOCATION 1               /* set for file:line in Debug messages */
41
42 /* 
43  *  This is where we define "Globals" because all the
44  *    daemons include this file.
45  */
46 const char *working_directory = NULL;       /* working directory path stored here */
47 int verbose = 0;                      /* increase User messages */
48 int debug_level = 0;                  /* debug level */
49 time_t daemon_start_time = 0;         /* Daemon start time */
50 const char *version = VERSION " (" BDATE ")";
51 char my_name[30];                     /* daemon name is stored here */
52 char *exepath = (char *)NULL;
53 char *exename = (char *)NULL;
54 int console_msg_pending = 0;
55 char con_fname[500];                  /* Console filename */
56 FILE *con_fd = NULL;                  /* Console file descriptor */
57 brwlock_t con_lock;                   /* Console lock structure */
58
59 #ifdef HAVE_POSTGRESQL
60 char catalog_db[] = "PostgreSQL";
61 #else
62 #ifdef HAVE_MYSQL
63 char catalog_db[] = "MySQL";
64 #else 
65 #ifdef HAVE_SQLITE
66 char catalog_db[] = "SQLite";
67 #else
68 char catalog_db[] = "Internal";
69 #endif
70 #endif
71 #endif
72
73 const char *host_os = HOST_OS;
74 const char *distname = DISTNAME;
75 const char *distver = DISTVER;
76 static FILE *trace_fd = NULL;
77 #ifdef HAVE_WIN32
78 static bool trace = true;
79 #else
80 static bool trace = false;
81 #endif
82
83 /* Forward referenced functions */
84
85 /* Imported functions */
86
87
88 /* Static storage */
89
90 static MSGS *daemon_msgs;              /* global messages */
91
92 /* Define if e_msg must exit when M_ERROR_TERM is received */
93 static int exit_on_error = 1;
94
95 /* 
96  * Set daemon name. Also, find canonical execution
97  *  path.  Note, exepath has spare room for tacking on
98  *  the exename so that we can reconstruct the full name.
99  *
100  * Note, this routine can get called multiple times
101  *  The second time is to put the name as found in the
102  *  Resource record. On the second call, generally,
103  *  argv is NULL to avoid doing the path code twice.
104  */
105 #define BTRACE_EXTRA 20
106 void my_name_is(int argc, char *argv[], const char *name)
107 {
108    char *l, *p, *q;
109    char cpath[400], npath[400];
110    int len;
111
112    bstrncpy(my_name, name, sizeof(my_name));
113    if (argc>0 && argv && argv[0]) {
114       /* strip trailing filename and save exepath */
115       for (l=p=argv[0]; *p; p++) {
116          if (*p == '/') {
117             l = p;                       /* set pos of last slash */
118          }
119       }
120       if (*l == '/') {
121          l++;
122       } else {
123          l = argv[0];
124 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
125          /* On Windows allow c: junk */
126          if (l[1] == ':') {
127             l += 2;
128          }
129 #endif
130       }
131       len = strlen(l) + 1;
132       if (exename) {
133          free(exename);
134       }
135       exename = (char *)malloc(len);
136       strcpy(exename, l);
137
138       if (exepath) {
139          free(exepath);
140       }
141       exepath = (char *)malloc(strlen(argv[0]) + 1 + len);
142       for (p=argv[0],q=exepath; p < l; ) {
143          *q++ = *p++;
144       }
145       *q = 0;
146       Dmsg1(200, "exepath=%s\n", exepath);
147       if (strchr(exepath, '.') || exepath[0] != '/') {
148          npath[0] = 0;
149          if (getcwd(cpath, sizeof(cpath))) {
150             if (chdir(exepath) == 0) {
151                if (!getcwd(npath, sizeof(npath))) {
152                   npath[0] = 0;
153                }
154                chdir(cpath);
155             }
156             if (npath[0]) {
157                free(exepath);
158                exepath = (char *)malloc(strlen(npath) + 1 + len);
159                strcpy(exepath, npath);
160             }
161          }
162          Dmsg1(200, "Normalized exepath=%s\n", exepath);
163       }
164    }
165 }
166
167 /* 
168  * Initialize message handler for a daemon or a Job
169  *   We make a copy of the MSGS resource passed, so it belows
170  *   to the job or daemon and thus can be modified.
171  * 
172  *   NULL for jcr -> initialize global messages for daemon
173  *   non-NULL     -> initialize jcr using Message resource
174  */
175 void
176 init_msg(JCR *jcr, MSGS *msg)
177 {
178    DEST *d, *dnew, *temp_chain = NULL;
179    int i;
180
181    if (jcr == NULL && msg == NULL) {
182       init_last_jobs_list();
183    }
184
185 #ifndef HAVE_WIN32
186    /*
187     * Make sure we have fd's 0, 1, 2 open
188     *  If we don't do this one of our sockets may open
189     *  there and if we then use stdout, it could
190     *  send total garbage to our socket.
191     *
192     */
193    int fd;
194    fd = open("/dev/null", O_RDONLY, 0644);
195    if (fd > 2) {
196       close(fd);
197    } else {
198       for(i=1; fd + i <= 2; i++) {
199          dup2(fd, fd+i);
200       }
201    }
202
203 #endif
204    /*
205     * If msg is NULL, initialize global chain for STDOUT and syslog
206     */
207    if (msg == NULL) {
208       daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
209       memset(daemon_msgs, 0, sizeof(MSGS));
210       for (i=1; i<=M_MAX; i++) {
211 #ifndef WIN32
212          add_msg_dest(daemon_msgs, MD_STDOUT, i, NULL, NULL);
213 #endif
214          add_msg_dest(daemon_msgs, MD_SYSLOG, i, NULL, NULL);
215       }
216       Dmsg1(050, "Create daemon global message resource 0x%x\n", daemon_msgs);
217       return;
218    }
219
220    /*
221     * Walk down the message resource chain duplicating it
222     * for the current Job.
223     */
224    for (d=msg->dest_chain; d; d=d->next) {
225       dnew = (DEST *)malloc(sizeof(DEST));
226       memcpy(dnew, d, sizeof(DEST));
227       dnew->next = temp_chain;
228       dnew->fd = NULL;
229       dnew->mail_filename = NULL;
230       if (d->mail_cmd) {
231          dnew->mail_cmd = bstrdup(d->mail_cmd);
232       }
233       if (d->where) {
234          dnew->where = bstrdup(d->where);
235       }
236       temp_chain = dnew;
237    }
238
239    if (jcr) {
240       jcr->jcr_msgs = (MSGS *)malloc(sizeof(MSGS));
241       memset(jcr->jcr_msgs, 0, sizeof(MSGS));
242       jcr->jcr_msgs->dest_chain = temp_chain;
243       memcpy(jcr->jcr_msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
244    } else {
245       /* If we have default values, release them now */
246       if (daemon_msgs) {
247          free_msgs_res(daemon_msgs);
248       }
249       daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
250       memset(daemon_msgs, 0, sizeof(MSGS));
251       daemon_msgs->dest_chain = temp_chain;
252       memcpy(daemon_msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
253    }
254    Dmsg2(050, "Copy message resource 0x%x to 0x%x\n", msg, temp_chain);
255
256 }
257
258 /* Initialize so that the console (User Agent) can
259  * receive messages -- stored in a file.
260  */
261 void init_console_msg(const char *wd)
262 {
263    int fd;
264
265    bsnprintf(con_fname, sizeof(con_fname), "%s/%s.conmsg", wd, my_name);
266    fd = open(con_fname, O_CREAT|O_RDWR|O_BINARY, 0600);
267    if (fd == -1) {
268       Emsg2(M_ERROR_TERM, 0, _("Could not open console message file %s: ERR=%s\n"),
269           con_fname, strerror(errno));
270    }
271    if (lseek(fd, 0, SEEK_END) > 0) {
272       console_msg_pending = 1;
273    }
274    close(fd);
275    con_fd = fopen(con_fname, "a+");
276    if (!con_fd) {
277       Emsg2(M_ERROR, 0, _("Could not open console message file %s: ERR=%s\n"),
278           con_fname, strerror(errno));
279    }
280    if (rwl_init(&con_lock) != 0) {
281       Emsg1(M_ERROR_TERM, 0, _("Could not get con mutex: ERR=%s\n"), 
282          strerror(errno));
283    }
284 }
285
286 /* 
287  * Called only during parsing of the config file.
288  *
289  * Add a message destination. I.e. associate a message type with
290  *  a destination (code).
291  * Note, where in the case of dest_code FILE is a filename,
292  *  but in the case of MAIL is a space separated list of
293  *  email addresses, ...
294  */
295 void add_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where, char *mail_cmd)
296 {
297    DEST *d; 
298    /*
299     * First search the existing chain and see if we
300     * can simply add this msg_type to an existing entry.
301     */
302    for (d=msg->dest_chain; d; d=d->next) {
303       if (dest_code == d->dest_code && ((where == NULL && d->where == NULL) ||
304                      (strcmp(where, d->where) == 0))) {  
305          Dmsg4(200, "Add to existing d=%x msgtype=%d destcode=%d where=%s\n", 
306              d, msg_type, dest_code, NPRT(where));
307          set_bit(msg_type, d->msg_types);
308          set_bit(msg_type, msg->send_msg);  /* set msg_type bit in our local */
309          return;
310       }
311    }
312    /* Not found, create a new entry */
313    d = (DEST *)malloc(sizeof(DEST));
314    memset(d, 0, sizeof(DEST));
315    d->next = msg->dest_chain;
316    d->dest_code = dest_code;
317    set_bit(msg_type, d->msg_types);      /* set type bit in structure */
318    set_bit(msg_type, msg->send_msg);     /* set type bit in our local */
319    if (where) {
320       d->where = bstrdup(where);
321    }
322    if (mail_cmd) {
323       d->mail_cmd = bstrdup(mail_cmd);
324    }
325    Dmsg5(200, "add new d=%x msgtype=%d destcode=%d where=%s mailcmd=%s\n", 
326           d, msg_type, dest_code, NPRT(where), NPRT(d->mail_cmd));
327    msg->dest_chain = d;
328 }
329
330 /* 
331  * Called only during parsing of the config file.
332  *
333  * Remove a message destination   
334  */
335 void rem_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where)
336 {
337    DEST *d;
338
339    for (d=msg->dest_chain; d; d=d->next) {
340       Dmsg2(200, "Remove_msg_dest d=%x where=%s\n", d, NPRT(d->where));
341       if (bit_is_set(msg_type, d->msg_types) && (dest_code == d->dest_code) &&
342           ((where == NULL && d->where == NULL) ||
343                      (strcmp(where, d->where) == 0))) {  
344          Dmsg3(200, "Found for remove d=%x msgtype=%d destcode=%d\n", 
345                d, msg_type, dest_code);
346          clear_bit(msg_type, d->msg_types);
347          Dmsg0(200, "Return rem_msg_dest\n");
348          return;
349       }
350    }
351 }
352
353
354 /*
355  * Create a unique filename for the mail command
356  */
357 static void make_unique_mail_filename(JCR *jcr, POOLMEM **name, DEST *d)
358 {
359    if (jcr) {
360       Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
361                  jcr->Job, (int)(long)d);
362    } else {
363       Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
364                  my_name, (int)(long)d);
365    }
366    Dmsg1(200, "mailname=%s\n", *name);
367 }
368
369 /*
370  * Open a mail pipe
371  */
372 static BPIPE *open_mail_pipe(JCR *jcr, POOLMEM **cmd, DEST *d)
373 {
374    BPIPE *bpipe;
375    int use_bsmtp = (d->mail_cmd && jcr);
376        
377    if (use_bsmtp) {
378       *cmd = edit_job_codes(jcr, *cmd, d->mail_cmd, d->where);
379    } else {
380 #if 1
381       Mmsg(cmd, "/usr/lib/sendmail -F Bacula %s", d->where);
382 #else
383       Mmsg(cmd, "mail -s \"Bacula Message\" %s", d->where);
384 #endif
385    }
386    fflush(stdout);
387
388    if (!(bpipe = open_bpipe(*cmd, 120, "rw"))) {
389       Jmsg(jcr, M_ERROR, 0, "open mail pipe %s failed: ERR=%s\n", 
390          *cmd, strerror(errno));
391    }
392
393 #if 1
394    if (!use_bsmtp) {
395        fprintf(bpipe->wfd, "Subject: Bacula Message\r\n\r\n");
396    }
397 #endif
398    
399    return bpipe;
400 }
401
402 /* 
403  * Close the messages for this Messages resource, which means to close
404  *  any open files, and dispatch any pending email messages.
405  */
406 void close_msg(JCR *jcr)
407 {
408    MSGS *msgs;
409    DEST *d;
410    BPIPE *bpipe;
411    POOLMEM *cmd, *line;
412    int len, stat;
413    
414    Dmsg1(050, "Close_msg jcr=0x%x\n", jcr);
415
416    if (jcr == NULL) {                /* NULL -> global chain */
417       msgs = daemon_msgs;
418    } else {
419       msgs = jcr->jcr_msgs;
420       jcr->jcr_msgs = NULL;
421    }
422    if (msgs == NULL) {
423       return;
424    }
425    Dmsg1(150, "===Begin close msg resource at 0x%x\n", msgs);
426    cmd = get_pool_memory(PM_MESSAGE);
427    for (d=msgs->dest_chain; d; ) {
428       if (d->fd) {
429          switch (d->dest_code) {
430          case MD_FILE:
431          case MD_APPEND:
432             if (d->fd) {
433                fclose(d->fd);            /* close open file descriptor */
434             }
435             break;
436          case MD_MAIL:
437          case MD_MAIL_ON_ERROR:
438             Dmsg0(150, "Got MD_MAIL or MD_MAIL_ON_ERROR\n");
439             if (!d->fd) {
440                break;
441             }
442             if (d->dest_code == MD_MAIL_ON_ERROR && jcr &&
443                 jcr->JobStatus == JS_Terminated) {
444                goto rem_temp_file;
445             }
446             
447             if (!(bpipe=open_mail_pipe(jcr, &cmd, d))) {
448                Pmsg0(000, "open mail pipe failed.\n");
449                goto rem_temp_file;
450             }
451             Dmsg0(150, "Opened mail pipe\n");
452             len = d->max_len+10;
453             line = get_memory(len);
454             rewind(d->fd);
455             while (fgets(mp_chr(line), len, d->fd)) {
456                fputs(line, bpipe->wfd);
457             }
458             if (!close_wpipe(bpipe)) {       /* close write pipe sending mail */
459                Pmsg1(000, "close error: ERR=%s\n", strerror(errno));
460             }
461
462             /*
463              * Since we are closing all messages, before "recursing"
464              * make sure we are not closing the daemon messages, otherwise
465              * kaboom.
466              */
467             if (msgs != daemon_msgs) {
468                /* read what mail prog returned -- should be nothing */
469                while (fgets(mp_chr(line), len, bpipe->rfd)) {
470                   Jmsg1(jcr, M_INFO, 0, _("Mail prog: %s"), line);
471                }
472             }
473
474             stat = close_bpipe(bpipe);
475             if (stat != 0 && msgs != daemon_msgs) {
476                berrno be;
477                be.set_errno(stat);
478                Dmsg1(150, "Calling emsg. CMD=%s\n", cmd);
479                Jmsg2(jcr, M_ERROR, 0, _("Mail program terminated in error.\n"
480                                         "CMD=%s\n"
481                                         "ERR=%s\n"), cmd, be.strerror());
482             }
483             free_memory(line);
484 rem_temp_file:
485             /* Remove temp file */
486             fclose(d->fd);
487             unlink(mp_chr(d->mail_filename));
488             free_pool_memory(d->mail_filename);
489             d->mail_filename = NULL;
490             Dmsg0(150, "end mail or mail on error\n");
491             break;
492          default:
493             break;
494          }
495          d->fd = NULL;
496       }
497       d = d->next;                    /* point to next buffer */
498    }
499    free_pool_memory(cmd);
500    Dmsg0(150, "Done walking message chain.\n");
501    if (jcr) {
502       free_msgs_res(msgs);
503       msgs = NULL;
504    }
505    Dmsg0(150, "===End close msg resource\n");
506 }
507
508 /*
509  * Free memory associated with Messages resource  
510  */
511 void free_msgs_res(MSGS *msgs)
512 {
513    DEST *d, *old;
514
515    /* Walk down the message chain releasing allocated buffers */
516    for (d=msgs->dest_chain; d; ) {
517       if (d->where) {
518          free(d->where);
519       }
520       if (d->mail_cmd) {
521          free(d->mail_cmd);
522       }
523       old = d;                        /* save pointer to release */
524       d = d->next;                    /* point to next buffer */
525       free(old);                      /* free the destination item */
526    }
527    msgs->dest_chain = NULL;
528    free(msgs);                        /* free the head */
529 }
530
531
532 /* 
533  * Terminate the message handler for good. 
534  * Release the global destination chain.
535  * 
536  * Also, clean up a few other items (cons, exepath). Note,
537  *   these really should be done elsewhere.
538  */
539 void term_msg()
540 {
541    Dmsg0(100, "Enter term_msg\n");
542    close_msg(NULL);                   /* close global chain */
543    free_msgs_res(daemon_msgs);        /* free the resources */
544    daemon_msgs = NULL;
545    if (con_fd) {
546       fflush(con_fd);
547       fclose(con_fd);
548       con_fd = NULL;
549    }
550    if (exepath) {
551       free(exepath);
552       exepath = NULL;
553    }
554    if (exename) {
555       free(exename);
556       exename = NULL;
557    }
558    if (trace_fd) {
559       fclose(trace_fd);
560       trace_fd = NULL;
561    }
562    term_last_jobs_list();
563 }
564
565
566
567 /*
568  * Handle sending the message to the appropriate place
569  */
570 void dispatch_message(JCR *jcr, int type, int level, char *msg)
571 {
572     DEST *d;   
573     char dt[MAX_TIME_LENGTH];
574     POOLMEM *mcmd;
575     int len;
576     MSGS *msgs;
577     BPIPE *bpipe;
578
579     Dmsg2(800, "Enter dispatch_msg type=%d msg=%s\n", type, msg);
580
581     if (type == M_ABORT || type == M_ERROR_TERM) {
582 #ifndef HAVE_WIN32
583        fputs(msg, stdout);         /* print this here to INSURE that it is printed */
584        fflush(stdout);
585 #endif
586 #if !defined(HAVE_CONSOLE)
587 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
588        /* If we don't exit on error, error messages are parsed by UA */
589        if (exit_on_error) {
590           MessageBox(NULL, msg, "Bacula", MB_OK);
591        }
592 #endif
593 #endif
594     }
595
596     /* Now figure out where to send the message */
597     msgs = NULL;
598     if (jcr) {
599        msgs = jcr->jcr_msgs;
600     } 
601     if (msgs == NULL) {
602        msgs = daemon_msgs;
603     }
604     for (d=msgs->dest_chain; d; d=d->next) {
605        if (bit_is_set(type, d->msg_types)) {
606           switch (d->dest_code) {
607              case MD_CONSOLE:
608                 Dmsg1(800, "CONSOLE for following msg: %s", msg);
609                 if (!con_fd) {
610                    con_fd = fopen(con_fname, "a+");
611                    Dmsg0(800, "Console file not open.\n");
612                 }
613                 if (con_fd) {
614                    Pw(con_lock);      /* get write lock on console message file */
615                    errno = 0;
616                    bstrftime(dt, sizeof(dt), time(NULL));
617                    len = strlen(dt);
618                    dt[len++] = ' ';
619                    fwrite(dt, len, 1, con_fd);
620                    len = strlen(msg);
621                    if (len > 0) {
622                       fwrite(msg, len, 1, con_fd);
623                       if (msg[len-1] != '\n') {
624                          fwrite("\n", 2, 1, con_fd);
625                       }
626                    } else {
627                       fwrite("\n", 2, 1, con_fd);
628                    }
629                    fflush(con_fd);
630                    console_msg_pending = TRUE;
631                    Vw(con_lock);
632                 }
633                 break;
634              case MD_SYSLOG:
635                 Dmsg1(800, "SYSLOG for collowing msg: %s\n", msg);
636                 /*
637                  * We really should do an openlog() here.  
638                  */
639                 syslog(LOG_DAEMON|LOG_ERR, "%s", msg);
640                 break;
641              case MD_OPERATOR:
642                 Dmsg1(800, "OPERATOR for collowing msg: %s\n", msg);
643                 mcmd = get_pool_memory(PM_MESSAGE);
644                 if ((bpipe=open_mail_pipe(jcr, &mcmd, d))) {
645                    int stat;
646                    fputs(msg, bpipe->wfd);
647                    /* Messages to the operator go one at a time */
648                    stat = close_bpipe(bpipe);
649                    if (stat != 0) {
650                       berrno be;
651                       be.set_errno(stat);
652                       Jmsg2(jcr, M_ERROR, 0, _("Operator mail program terminated in error.\n"
653                             "CMD=%s\n"
654                             "ERR=%s\n"), mcmd, be.strerror());
655                    }
656                 }
657                 free_pool_memory(mcmd);
658                 break;
659              case MD_MAIL:
660              case MD_MAIL_ON_ERROR:
661                 Dmsg1(800, "MAIL for following msg: %s", msg);
662                 if (!d->fd) {
663                    POOLMEM *name = get_pool_memory(PM_MESSAGE);
664                    make_unique_mail_filename(jcr, &mp_chr(name), d);
665                    d->fd = fopen(mp_chr(name), "w+");
666                    if (!d->fd) {
667                       d->fd = stdout;
668                       Jmsg2(jcr, M_ERROR, 0, "fopen %s failed: ERR=%s\n", name, strerror(errno));
669                       d->fd = NULL;
670                       free_pool_memory(name);
671                       break;
672                    }
673                    d->mail_filename = name;
674                 }
675                 len = strlen(msg);
676                 if (len > d->max_len) {
677                    d->max_len = len;      /* keep max line length */
678                 }
679                 fputs(msg, d->fd);
680                 break;
681              case MD_FILE:
682                 Dmsg1(800, "FILE for following msg: %s", msg);
683                 if (!d->fd) {
684                    d->fd = fopen(d->where, "w+");
685                    if (!d->fd) {
686                       d->fd = stdout;
687                       Jmsg2(jcr, M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
688                       d->fd = NULL;
689                       break;
690                    }
691                 }
692                 fputs(msg, d->fd);
693                 break;
694              case MD_APPEND:
695                 Dmsg1(800, "APPEND for following msg: %s", msg);
696                 if (!d->fd) {
697                    d->fd = fopen(d->where, "a");
698                    if (!d->fd) {
699                       d->fd = stdout;
700                       Jmsg2(jcr, M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
701                       d->fd = NULL;
702                       break;
703                    }
704                 }
705                 fputs(msg, d->fd);
706                 break;
707              case MD_DIRECTOR:
708                 Dmsg1(800, "DIRECTOR for following msg: %s", msg);
709                 if (jcr && jcr->dir_bsock && !jcr->dir_bsock->errors) {
710                    bnet_fsend(jcr->dir_bsock, "Jmsg Job=%s type=%d level=%d %s", 
711                       jcr->Job, type, level, msg);
712                 }
713                 break;
714              case MD_STDOUT:
715                 Dmsg1(800, "STDOUT for following msg: %s", msg);
716                 if (type != M_ABORT && type != M_ERROR_TERM) { /* already printed */
717                    fputs(msg, stdout);
718                 }
719                 break;
720              case MD_STDERR:
721                 Dmsg1(800, "STDERR for following msg: %s", msg);
722                 fputs(msg, stderr);
723                 break;
724              default:
725                 break;
726           }
727        }
728     }
729 }
730
731
732 /*********************************************************************
733  *
734  *  This subroutine prints a debug message if the level number
735  *  is less than or equal the debug_level. File and line numbers
736  *  are included for more detail if desired, but not currently
737  *  printed.
738  *  
739  *  If the level is negative, the details of file and line number
740  *  are not printed.
741  */
742 void 
743 d_msg(const char *file, int line, int level, const char *fmt,...)
744 {
745     char      buf[5000];
746     int       len;
747     va_list   arg_ptr;
748     int       details = TRUE;
749
750     if (level < 0) {
751        details = FALSE;
752        level = -level;
753     }
754
755     if (level <= debug_level) {
756 #ifdef FULL_LOCATION
757        if (details) {
758           /* visual studio passes the whole path to the file as well
759            * which makes for very long lines
760            */
761           const char *f = strrchr(file, '\\');
762           if (f) file = f + 1;
763           len = bsnprintf(buf, sizeof(buf), "%s: %s:%d ", my_name, file, line);
764        } else {
765           len = 0;
766        }
767 #else
768        len = 0;
769 #endif
770        va_start(arg_ptr, fmt);
771        bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
772        va_end(arg_ptr);
773
774        /* 
775         * Used the "trace on" command in the console to turn on
776         *  output to the trace file.  "trace off" will close the file.
777         */
778        if (trace) {
779           if (!trace_fd) {
780              bsnprintf(buf, sizeof(buf), "%s/bacula.trace", working_directory ? working_directory : ".");
781              trace_fd = fopen(buf, "a+");
782           }
783           if (trace_fd) {
784              fputs(buf, trace_fd);
785              fflush(trace_fd);
786           }
787        } else {   /* not tracing */
788           fputs(buf, stdout);
789        }
790     }
791 }
792
793 /*
794  * Set trace flag on/off. If argument is negative, there is no change 
795  */
796 void set_trace(int trace_flag)
797 {
798    if (trace_flag < 0) {
799       return;
800    } else if (trace_flag > 0) {
801       trace = true;
802    } else {
803       trace = false;
804    }
805    if (!trace && trace_fd) {
806       FILE *ltrace_fd = trace_fd;
807       trace_fd = NULL;
808       bmicrosleep(0, 100000);         /* yield to prevent seg faults */
809       fclose(ltrace_fd);
810    }
811 }
812
813 /*********************************************************************
814  *
815  *  This subroutine prints a message regardless of the debug level
816  *  
817  *  If the level is negative, the details of file and line number
818  *  are not printed.
819  */
820 void 
821 p_msg(const char *file, int line, int level, const char *fmt,...)
822 {
823     char      buf[5000];
824     int       len;
825     va_list   arg_ptr;
826
827 #ifdef FULL_LOCATION
828     if (level >= 0) {
829        len = bsnprintf(buf, sizeof(buf), "%s: %s:%d ", my_name, file, line);
830     } else {
831        len = 0;
832     }
833 #else
834     len = 0;
835 #endif
836     va_start(arg_ptr, fmt);
837     bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
838     va_end(arg_ptr);
839     fputs(buf, stdout);
840 }
841
842
843 /*********************************************************************
844  *
845  *  subroutine writes a debug message to the trace file if the level number
846  *  is less than or equal the debug_level. File and line numbers
847  *  are included for more detail if desired, but not currently
848  *  printed.
849  *  
850  *  If the level is negative, the details of file and line number
851  *  are not printed.
852  */
853 void 
854 t_msg(const char *file, int line, int level, const char *fmt,...)
855 {
856     char      buf[5000];
857     int       len;
858     va_list   arg_ptr;
859     int       details = TRUE;
860
861     if (level < 0) {
862        details = FALSE;
863        level = -level;
864     }
865
866     if (level <= debug_level) {
867        if (!trace_fd) {
868           bsnprintf(buf, sizeof(buf), "%s/bacula.trace", working_directory);
869           trace_fd = fopen(buf, "a+");
870        }
871     
872 #ifdef FULL_LOCATION
873        if (details) {
874           len = bsnprintf(buf, sizeof(buf), "%s: %s:%d ", my_name, file, line);
875        } else {
876           len = 0;
877        }
878 #else
879        len = 0;
880 #endif
881        va_start(arg_ptr, fmt);
882        bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
883        va_end(arg_ptr);
884        if (trace_fd != NULL) {
885            fputs(buf, trace_fd);
886            fflush(trace_fd);
887        }
888    }
889 }
890
891
892
893 /* *********************************************************
894  *
895  * print an error message
896  *
897  */
898 void 
899 e_msg(const char *file, int line, int type, int level, const char *fmt,...)
900 {
901     char     buf[5000];
902     va_list   arg_ptr;
903     int len;
904
905     /* 
906      * Check if we have a message destination defined.  
907      * We always report M_ABORT and M_ERROR_TERM 
908      */
909     if (!daemon_msgs || ((type != M_ABORT && type != M_ERROR_TERM) && 
910                          !bit_is_set(type, daemon_msgs->send_msg))) {
911        return;                        /* no destination */
912     }
913     switch (type) {
914     case M_ABORT:
915        len = bsnprintf(buf, sizeof(buf), "%s: ABORTING due to ERROR in %s:%d\n", 
916                my_name, file, line);
917        break;
918     case M_ERROR_TERM:
919        len = bsnprintf(buf, sizeof(buf), "%s: ERROR TERMINATION at %s:%d\n", 
920                my_name, file, line);
921        break;
922     case M_FATAL:
923        if (level == -1)            /* skip details */
924           len = bsnprintf(buf, sizeof(buf), "%s: Fatal Error because: ", my_name);
925        else
926           len = bsnprintf(buf, sizeof(buf), "%s: Fatal Error at %s:%d because:\n", my_name, file, line);
927        break;
928     case M_ERROR:
929        if (level == -1)            /* skip details */
930           len = bsnprintf(buf, sizeof(buf), "%s: ERROR: ", my_name);
931        else
932           len = bsnprintf(buf, sizeof(buf), "%s: ERROR in %s:%d ", my_name, file, line);
933        break;
934     case M_WARNING:
935        len = bsnprintf(buf, sizeof(buf), "%s: Warning: ", my_name);
936        break;
937     case M_SECURITY:
938        len = bsnprintf(buf, sizeof(buf), "%s: Security violation: ", my_name);
939        break;
940     default:
941        len = bsnprintf(buf, sizeof(buf), "%s: ", my_name);
942        break;
943     }
944
945     va_start(arg_ptr, fmt);
946     bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
947     va_end(arg_ptr);
948
949     dispatch_message(NULL, type, level, buf);
950
951     if (type == M_ABORT) {
952        char *p = 0;
953        p[0] = 0;                      /* generate segmentation violation */
954     }
955     if ((type == M_ERROR_TERM) && exit_on_error) {
956        exit(1);
957     }
958 }
959
960 /* *********************************************************
961  *
962  * Generate a Job message
963  *
964  */
965 void 
966 Jmsg(JCR *jcr, int type, int level, const char *fmt,...)
967 {
968     char     rbuf[5000];
969     va_list   arg_ptr;
970     int len;
971     MSGS *msgs;
972     const char *job;
973
974     
975     Dmsg1(800, "Enter Jmsg type=%d\n", type);
976
977     /* Special case for the console, which has a dir_bsock and JobId==0,
978      *  in that case, we send the message directly back to the
979      *  dir_bsock.  
980      */
981     if (jcr && jcr->JobId == 0 && jcr->dir_bsock) {
982        BSOCK *dir = jcr->dir_bsock;
983        va_start(arg_ptr, fmt);
984        dir->msglen = bvsnprintf(mp_chr(dir->msg), sizeof_pool_memory(dir->msg), 
985                                 fmt, arg_ptr);
986        va_end(arg_ptr);
987        bnet_send(jcr->dir_bsock);
988        return;
989     }
990
991     msgs = NULL;
992     job = NULL;
993     if (jcr) {
994        msgs = jcr->jcr_msgs;
995        job = jcr->Job;
996     } 
997     if (!msgs) {
998        msgs = daemon_msgs;            /* if no jcr, we use daemon handler */
999     }
1000     if (!job) {
1001        job = "";                      /* Set null job name if none */
1002     }
1003
1004     /* 
1005      * Check if we have a message destination defined.  
1006      * We always report M_ABORT and M_ERROR_TERM 
1007      */
1008     if (msgs && (type != M_ABORT && type != M_ERROR_TERM) &&
1009          !bit_is_set(type, msgs->send_msg)) {
1010        return;                        /* no destination */
1011     }
1012     switch (type) {
1013     case M_ABORT:
1014        len = bsnprintf(rbuf, sizeof(rbuf), "%s ABORTING due to ERROR\n", my_name);
1015        break;
1016     case M_ERROR_TERM:
1017        len = bsnprintf(rbuf, sizeof(rbuf), "%s ERROR TERMINATION\n", my_name);
1018        break;
1019     case M_FATAL:
1020        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Fatal error: ", my_name, job);
1021        if (jcr) {
1022           set_jcr_job_status(jcr, JS_FatalError);
1023        }
1024        break;
1025     case M_ERROR:
1026        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Error: ", my_name, job);
1027        if (jcr) {
1028           jcr->Errors++;
1029        }
1030        break;
1031     case M_WARNING:
1032        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Warning: ", my_name, job);
1033        break;
1034     case M_SECURITY:
1035        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Security violation: ", my_name, job);
1036        break;
1037     default:
1038        len = bsnprintf(rbuf, sizeof(rbuf), "%s: ", my_name);
1039        break;
1040     }
1041
1042     va_start(arg_ptr, fmt);
1043     bvsnprintf(rbuf+len,  sizeof(rbuf)-len, fmt, arg_ptr);
1044     va_end(arg_ptr);
1045
1046     dispatch_message(jcr, type, level, rbuf);
1047
1048     if (type == M_ABORT){
1049        char *p = 0;
1050        p[0] = 0;                      /* generate segmentation violation */
1051     }
1052     if ((type == M_ERROR_TERM) && exit_on_error) {
1053        exit(1);
1054     }
1055 }
1056
1057 /*
1058  * If we come here, prefix the message with the file:line-number,
1059  *  then pass it on to the normal Jmsg routine.
1060  */
1061 void j_msg(const char *file, int line, JCR *jcr, int type, int level, const char *fmt,...)
1062 {
1063    va_list   arg_ptr;
1064    int i, len, maxlen;
1065    POOLMEM *pool_buf;
1066
1067    pool_buf = get_pool_memory(PM_EMSG);
1068    i = Mmsg(&pool_buf, "%s:%d ", file, line);
1069
1070    for (;;) {
1071       maxlen = sizeof_pool_memory(pool_buf) - i - 1; 
1072       va_start(arg_ptr, fmt);
1073       len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
1074       va_end(arg_ptr);
1075       if (len < 0 || len >= (maxlen-5)) {
1076          pool_buf = realloc_pool_memory(pool_buf, maxlen + i + maxlen/2);
1077          continue;
1078       }
1079       break;
1080    }
1081
1082    Jmsg(jcr, type, level, "%s", pool_buf);
1083    free_memory(pool_buf);
1084 }
1085
1086
1087 /*
1088  * Edit a message into a Pool memory buffer, with file:lineno
1089  */                                                  
1090 int m_msg(const char *file, int line, POOLMEM **pool_buf, const char *fmt, ...)
1091 {
1092    va_list   arg_ptr;
1093    int i, len, maxlen;
1094
1095    i = sprintf(mp_chr(*pool_buf), "%s:%d ", file, line);
1096
1097    for (;;) {
1098       maxlen = sizeof_pool_memory(*pool_buf) - i - 1; 
1099       va_start(arg_ptr, fmt);
1100       len = bvsnprintf(*pool_buf+i, maxlen, fmt, arg_ptr);
1101       va_end(arg_ptr);
1102       if (len < 0 || len >= (maxlen-5)) {
1103          *pool_buf = realloc_pool_memory(*pool_buf, maxlen + i + maxlen/2);
1104          continue;
1105       }
1106       break;
1107    }
1108    return len;
1109 }
1110
1111 /*
1112  * Edit a message into a Pool Memory buffer NO file:lineno
1113  *  Returns: string length of what was edited.
1114  */
1115 int Mmsg(POOLMEM **pool_buf, const char *fmt, ...)
1116 {
1117    va_list   arg_ptr;
1118    int len, maxlen;
1119
1120    for (;;) {
1121       maxlen = sizeof_pool_memory(*pool_buf) - 1; 
1122       va_start(arg_ptr, fmt);
1123       len = bvsnprintf(*pool_buf, maxlen, fmt, arg_ptr);
1124       va_end(arg_ptr);
1125       if (len < 0 || len >= (maxlen-5)) {
1126          *pool_buf = realloc_pool_memory(*pool_buf, maxlen + maxlen/2);
1127          continue;
1128       }
1129       break;
1130    }
1131    return len;
1132 }
1133
1134 static pthread_mutex_t msg_queue_mutex = PTHREAD_MUTEX_INITIALIZER;
1135
1136 /*
1137  * We queue messages rather than print them directly. This
1138  *  is generally used in low level routines (msg handler, bnet)
1139  *  to prevent recursion (i.e. if you are in the middle of 
1140  *  sending a message, it is a bit messy to recursively call
1141  *  yourself when the bnet packet is not reentrant).
1142  */
1143 void Qmsg(JCR *jcr, int type, int level, const char *fmt,...)
1144 {
1145    va_list   arg_ptr;
1146    int len, maxlen;
1147    POOLMEM *pool_buf;
1148    MQUEUE_ITEM *item;
1149
1150    pool_buf = get_pool_memory(PM_EMSG);
1151
1152    for (;;) {
1153       maxlen = sizeof_pool_memory(pool_buf) - 1; 
1154       va_start(arg_ptr, fmt);
1155       len = bvsnprintf(pool_buf, maxlen, fmt, arg_ptr);
1156       va_end(arg_ptr);
1157       if (len < 0 || len >= (maxlen-5)) {
1158          pool_buf = realloc_pool_memory(pool_buf, maxlen + maxlen/2);
1159          continue;
1160       }
1161       break;
1162    }
1163    item = (MQUEUE_ITEM *)malloc(sizeof(MQUEUE_ITEM) + strlen(pool_buf) + 1);
1164    item->type = type;
1165    item->level = level;
1166    strcpy(item->msg, pool_buf);  
1167    P(msg_queue_mutex);
1168    /* If no jcr or dequeuing send to daemon to avoid recursion */
1169    if (!jcr || jcr->dequeuing) {
1170       /* jcr==NULL => daemon message, safe to send now */
1171       Jmsg(NULL, item->type, item->level, "%s", item->msg);
1172       free(item);
1173    } else {
1174       /* Queue message for later sending */
1175       jcr->msg_queue->append(item);
1176 //    Dmsg1(000, "queue item=%lu\n", (long unsigned)item);
1177    }
1178    V(msg_queue_mutex);
1179    free_memory(pool_buf);
1180 }
1181
1182 /*
1183  * Dequeue messages 
1184  */
1185 void dequeue_messages(JCR *jcr)
1186 {
1187    MQUEUE_ITEM *item;
1188    P(msg_queue_mutex);
1189    jcr->dequeuing = true;
1190    foreach_dlist(item, jcr->msg_queue) {
1191 //    Dmsg1(000, "dequeue item=%lu\n", (long unsigned)item);
1192       Jmsg(jcr, item->type, item->level, "%s", item->msg);
1193    }
1194    jcr->msg_queue->destroy();
1195    jcr->dequeuing = false;
1196    V(msg_queue_mutex);
1197 }                                                 
1198
1199
1200 /*
1201  * If we come here, prefix the message with the file:line-number,
1202  *  then pass it on to the normal Qmsg routine.
1203  */
1204 void q_msg(const char *file, int line, JCR *jcr, int type, int level, const char *fmt,...)
1205 {
1206    va_list   arg_ptr;
1207    int i, len, maxlen;
1208    POOLMEM *pool_buf;
1209
1210    pool_buf = get_pool_memory(PM_EMSG);
1211    i = Mmsg(&pool_buf, "%s:%d ", file, line);
1212
1213    for (;;) {
1214       maxlen = sizeof_pool_memory(pool_buf) - i - 1; 
1215       va_start(arg_ptr, fmt);
1216       len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
1217       va_end(arg_ptr);
1218       if (len < 0 || len >= (maxlen-5)) {
1219          pool_buf = realloc_pool_memory(pool_buf, maxlen + i + maxlen/2);
1220          continue;
1221       }
1222       break;
1223    }
1224
1225    Qmsg(jcr, type, level, "%s", pool_buf);
1226    free_memory(pool_buf);
1227 }
1228
1229 /* 
1230  * Define if e_msg must exit when M_ERROR_TERM is received
1231  */
1232 void set_exit_on_error(int value) {
1233    exit_on_error = value;
1234 }