]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/message.c
93e82570a4c391ff3131e0b22205c2c3562af292
[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                Dmsg1(150, "Calling emsg. CMD=%s\n", cmd);
477                Jmsg3(jcr, M_ERROR, 0, _("Mail program terminated in error. stat=%d\n"
478                                         "CMD=%s\n"
479                                         "ERR=%s\n"), stat, cmd, strerror(stat));
480             }
481             free_memory(line);
482 rem_temp_file:
483             /* Remove temp file */
484             fclose(d->fd);
485             unlink(mp_chr(d->mail_filename));
486             free_pool_memory(d->mail_filename);
487             d->mail_filename = NULL;
488             Dmsg0(150, "end mail or mail on error\n");
489             break;
490          default:
491             break;
492          }
493          d->fd = NULL;
494       }
495       d = d->next;                    /* point to next buffer */
496    }
497    free_pool_memory(cmd);
498    Dmsg0(150, "Done walking message chain.\n");
499    if (jcr) {
500       free_msgs_res(msgs);
501       msgs = NULL;
502    }
503    Dmsg0(150, "===End close msg resource\n");
504 }
505
506 /*
507  * Free memory associated with Messages resource  
508  */
509 void free_msgs_res(MSGS *msgs)
510 {
511    DEST *d, *old;
512
513    /* Walk down the message chain releasing allocated buffers */
514    for (d=msgs->dest_chain; d; ) {
515       if (d->where) {
516          free(d->where);
517       }
518       if (d->mail_cmd) {
519          free(d->mail_cmd);
520       }
521       old = d;                        /* save pointer to release */
522       d = d->next;                    /* point to next buffer */
523       free(old);                      /* free the destination item */
524    }
525    msgs->dest_chain = NULL;
526    free(msgs);                        /* free the head */
527 }
528
529
530 /* 
531  * Terminate the message handler for good. 
532  * Release the global destination chain.
533  * 
534  * Also, clean up a few other items (cons, exepath). Note,
535  *   these really should be done elsewhere.
536  */
537 void term_msg()
538 {
539    Dmsg0(100, "Enter term_msg\n");
540    close_msg(NULL);                   /* close global chain */
541    free_msgs_res(daemon_msgs);        /* free the resources */
542    daemon_msgs = NULL;
543    if (con_fd) {
544       fflush(con_fd);
545       fclose(con_fd);
546       con_fd = NULL;
547    }
548    if (exepath) {
549       free(exepath);
550       exepath = NULL;
551    }
552    if (exename) {
553       free(exename);
554       exename = NULL;
555    }
556    if (trace_fd) {
557       fclose(trace_fd);
558       trace_fd = NULL;
559    }
560    term_last_jobs_list();
561 }
562
563
564
565 /*
566  * Handle sending the message to the appropriate place
567  */
568 void dispatch_message(JCR *jcr, int type, int level, char *msg)
569 {
570     DEST *d;   
571     char dt[MAX_TIME_LENGTH];
572     POOLMEM *mcmd;
573     int len;
574     MSGS *msgs;
575     BPIPE *bpipe;
576
577     Dmsg2(800, "Enter dispatch_msg type=%d msg=%s\n", type, msg);
578
579     if (type == M_ABORT || type == M_ERROR_TERM) {
580 #ifndef HAVE_WIN32
581        fputs(msg, stdout);         /* print this here to INSURE that it is printed */
582        fflush(stdout);
583 #endif
584 #if !defined(HAVE_CONSOLE)
585 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
586        /* If we don't exit on error, error messages are parsed by UA */
587        if (exit_on_error) {
588           MessageBox(NULL, msg, "Bacula", MB_OK);
589        }
590 #endif
591 #endif
592     }
593
594     /* Now figure out where to send the message */
595     msgs = NULL;
596     if (jcr) {
597        msgs = jcr->jcr_msgs;
598     } 
599     if (msgs == NULL) {
600        msgs = daemon_msgs;
601     }
602     for (d=msgs->dest_chain; d; d=d->next) {
603        if (bit_is_set(type, d->msg_types)) {
604           switch (d->dest_code) {
605              case MD_CONSOLE:
606                 Dmsg1(800, "CONSOLE for following msg: %s", msg);
607                 if (!con_fd) {
608                    con_fd = fopen(con_fname, "a+");
609                    Dmsg0(800, "Console file not open.\n");
610                 }
611                 if (con_fd) {
612                    Pw(con_lock);      /* get write lock on console message file */
613                    errno = 0;
614                    bstrftime(dt, sizeof(dt), time(NULL));
615                    len = strlen(dt);
616                    dt[len++] = ' ';
617                    fwrite(dt, len, 1, con_fd);
618                    len = strlen(msg);
619                    if (len > 0) {
620                       fwrite(msg, len, 1, con_fd);
621                       if (msg[len-1] != '\n') {
622                          fwrite("\n", 2, 1, con_fd);
623                       }
624                    } else {
625                       fwrite("\n", 2, 1, con_fd);
626                    }
627                    fflush(con_fd);
628                    console_msg_pending = TRUE;
629                    Vw(con_lock);
630                 }
631                 break;
632              case MD_SYSLOG:
633                 Dmsg1(800, "SYSLOG for collowing msg: %s\n", msg);
634                 /*
635                  * We really should do an openlog() here.  
636                  */
637                 syslog(LOG_DAEMON|LOG_ERR, "%s", msg);
638                 break;
639              case MD_OPERATOR:
640                 Dmsg1(800, "OPERATOR for collowing msg: %s\n", msg);
641                 mcmd = get_pool_memory(PM_MESSAGE);
642                 if ((bpipe=open_mail_pipe(jcr, &mcmd, d))) {
643                    int stat;
644                    fputs(msg, bpipe->wfd);
645                    /* Messages to the operator go one at a time */
646                    stat = close_bpipe(bpipe);
647                    if (stat != 0) {
648                       Jmsg2(jcr, M_ERROR, 0, _("Operator mail program terminated in error.\n"
649                             "CMD=%s\n"
650                             "ERR=%s\n"), mcmd, strerror(stat));
651                    }
652                 }
653                 free_pool_memory(mcmd);
654                 break;
655              case MD_MAIL:
656              case MD_MAIL_ON_ERROR:
657                 Dmsg1(800, "MAIL for following msg: %s", msg);
658                 if (!d->fd) {
659                    POOLMEM *name = get_pool_memory(PM_MESSAGE);
660                    make_unique_mail_filename(jcr, &mp_chr(name), d);
661                    d->fd = fopen(mp_chr(name), "w+");
662                    if (!d->fd) {
663                       d->fd = stdout;
664                       Jmsg2(jcr, M_ERROR, 0, "fopen %s failed: ERR=%s\n", name, strerror(errno));
665                       d->fd = NULL;
666                       free_pool_memory(name);
667                       break;
668                    }
669                    d->mail_filename = name;
670                 }
671                 len = strlen(msg);
672                 if (len > d->max_len) {
673                    d->max_len = len;      /* keep max line length */
674                 }
675                 fputs(msg, d->fd);
676                 break;
677              case MD_FILE:
678                 Dmsg1(800, "FILE for following msg: %s", msg);
679                 if (!d->fd) {
680                    d->fd = fopen(d->where, "w+");
681                    if (!d->fd) {
682                       d->fd = stdout;
683                       Jmsg2(jcr, M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
684                       d->fd = NULL;
685                       break;
686                    }
687                 }
688                 fputs(msg, d->fd);
689                 break;
690              case MD_APPEND:
691                 Dmsg1(800, "APPEND for following msg: %s", msg);
692                 if (!d->fd) {
693                    d->fd = fopen(d->where, "a");
694                    if (!d->fd) {
695                       d->fd = stdout;
696                       Jmsg2(jcr, M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
697                       d->fd = NULL;
698                       break;
699                    }
700                 }
701                 fputs(msg, d->fd);
702                 break;
703              case MD_DIRECTOR:
704                 Dmsg1(800, "DIRECTOR for following msg: %s", msg);
705                 if (jcr && jcr->dir_bsock && !jcr->dir_bsock->errors) {
706                    bnet_fsend(jcr->dir_bsock, "Jmsg Job=%s type=%d level=%d %s", 
707                       jcr->Job, type, level, msg);
708                 }
709                 break;
710              case MD_STDOUT:
711                 Dmsg1(800, "STDOUT for following msg: %s", msg);
712                 if (type != M_ABORT && type != M_ERROR_TERM) { /* already printed */
713                    fputs(msg, stdout);
714                 }
715                 break;
716              case MD_STDERR:
717                 Dmsg1(800, "STDERR for following msg: %s", msg);
718                 fputs(msg, stderr);
719                 break;
720              default:
721                 break;
722           }
723        }
724     }
725 }
726
727
728 /*********************************************************************
729  *
730  *  This subroutine prints a debug message if the level number
731  *  is less than or equal the debug_level. File and line numbers
732  *  are included for more detail if desired, but not currently
733  *  printed.
734  *  
735  *  If the level is negative, the details of file and line number
736  *  are not printed.
737  */
738 void 
739 d_msg(const char *file, int line, int level, const char *fmt,...)
740 {
741     char      buf[5000];
742     int       len;
743     va_list   arg_ptr;
744     int       details = TRUE;
745
746     if (level < 0) {
747        details = FALSE;
748        level = -level;
749     }
750
751     if (level <= debug_level) {
752 #ifdef FULL_LOCATION
753        if (details) {
754           /* visual studio passes the whole path to the file as well
755            * which makes for very long lines
756            */
757           const char *f = strrchr(file, '\\');
758           if (f) file = f + 1;
759           len = bsnprintf(buf, sizeof(buf), "%s: %s:%d ", my_name, file, line);
760        } else {
761           len = 0;
762        }
763 #else
764        len = 0;
765 #endif
766        va_start(arg_ptr, fmt);
767        bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
768        va_end(arg_ptr);
769
770        /* 
771         * Used the "trace on" command in the console to turn on
772         *  output to the trace file.  "trace off" will close the file.
773         */
774        if (trace) {
775           if (!trace_fd) {
776              bsnprintf(buf, sizeof(buf), "%s/bacula.trace", working_directory ? working_directory : ".");
777              trace_fd = fopen(buf, "a+");
778           }
779           if (trace_fd) {
780              fputs(buf, trace_fd);
781              fflush(trace_fd);
782           }
783        } else {   /* not tracing */
784           fputs(buf, stdout);
785        }
786     }
787 }
788
789 /*
790  * Set trace flag on/off. If argument is negative, there is no change 
791  */
792 void set_trace(int trace_flag)
793 {
794    if (trace_flag < 0) {
795       return;
796    } else if (trace_flag > 0) {
797       trace = true;
798    } else {
799       trace = false;
800    }
801    if (!trace && trace_fd) {
802       FILE *ltrace_fd = trace_fd;
803       trace_fd = NULL;
804       bmicrosleep(0, 100000);         /* yield to prevent seg faults */
805       fclose(ltrace_fd);
806    }
807 }
808
809 /*********************************************************************
810  *
811  *  This subroutine prints a message regardless of the debug level
812  *  
813  *  If the level is negative, the details of file and line number
814  *  are not printed.
815  */
816 void 
817 p_msg(const char *file, int line, int level, const char *fmt,...)
818 {
819     char      buf[5000];
820     int       len;
821     va_list   arg_ptr;
822
823 #ifdef FULL_LOCATION
824     if (level >= 0) {
825        len = bsnprintf(buf, sizeof(buf), "%s: %s:%d ", my_name, file, line);
826     } else {
827        len = 0;
828     }
829 #else
830     len = 0;
831 #endif
832     va_start(arg_ptr, fmt);
833     bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
834     va_end(arg_ptr);
835     fputs(buf, stdout);
836 }
837
838
839 /*********************************************************************
840  *
841  *  subroutine writes a debug message to the trace file if the level number
842  *  is less than or equal the debug_level. File and line numbers
843  *  are included for more detail if desired, but not currently
844  *  printed.
845  *  
846  *  If the level is negative, the details of file and line number
847  *  are not printed.
848  */
849 void 
850 t_msg(const char *file, int line, int level, const char *fmt,...)
851 {
852     char      buf[5000];
853     int       len;
854     va_list   arg_ptr;
855     int       details = TRUE;
856
857     if (level < 0) {
858        details = FALSE;
859        level = -level;
860     }
861
862     if (level <= debug_level) {
863        if (!trace_fd) {
864           bsnprintf(buf, sizeof(buf), "%s/bacula.trace", working_directory);
865           trace_fd = fopen(buf, "a+");
866        }
867     
868 #ifdef FULL_LOCATION
869        if (details) {
870           len = bsnprintf(buf, sizeof(buf), "%s: %s:%d ", my_name, file, line);
871        } else {
872           len = 0;
873        }
874 #else
875        len = 0;
876 #endif
877        va_start(arg_ptr, fmt);
878        bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
879        va_end(arg_ptr);
880        if (trace_fd != NULL) {
881            fputs(buf, trace_fd);
882            fflush(trace_fd);
883        }
884    }
885 }
886
887
888
889 /* *********************************************************
890  *
891  * print an error message
892  *
893  */
894 void 
895 e_msg(const char *file, int line, int type, int level, const char *fmt,...)
896 {
897     char     buf[5000];
898     va_list   arg_ptr;
899     int len;
900
901     /* 
902      * Check if we have a message destination defined.  
903      * We always report M_ABORT and M_ERROR_TERM 
904      */
905     if (!daemon_msgs || ((type != M_ABORT && type != M_ERROR_TERM) && 
906                          !bit_is_set(type, daemon_msgs->send_msg))) {
907        return;                        /* no destination */
908     }
909     switch (type) {
910     case M_ABORT:
911        len = bsnprintf(buf, sizeof(buf), "%s: ABORTING due to ERROR in %s:%d\n", 
912                my_name, file, line);
913        break;
914     case M_ERROR_TERM:
915        len = bsnprintf(buf, sizeof(buf), "%s: ERROR TERMINATION at %s:%d\n", 
916                my_name, file, line);
917        break;
918     case M_FATAL:
919        if (level == -1)            /* skip details */
920           len = bsnprintf(buf, sizeof(buf), "%s: Fatal Error because: ", my_name);
921        else
922           len = bsnprintf(buf, sizeof(buf), "%s: Fatal Error at %s:%d because:\n", my_name, file, line);
923        break;
924     case M_ERROR:
925        if (level == -1)            /* skip details */
926           len = bsnprintf(buf, sizeof(buf), "%s: ERROR: ", my_name);
927        else
928           len = bsnprintf(buf, sizeof(buf), "%s: ERROR in %s:%d ", my_name, file, line);
929        break;
930     case M_WARNING:
931        len = bsnprintf(buf, sizeof(buf), "%s: Warning: ", my_name);
932        break;
933     case M_SECURITY:
934        len = bsnprintf(buf, sizeof(buf), "%s: Security violation: ", my_name);
935        break;
936     default:
937        len = bsnprintf(buf, sizeof(buf), "%s: ", my_name);
938        break;
939     }
940
941     va_start(arg_ptr, fmt);
942     bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
943     va_end(arg_ptr);
944
945     dispatch_message(NULL, type, level, buf);
946
947     if (type == M_ABORT) {
948        char *p = 0;
949        p[0] = 0;                      /* generate segmentation violation */
950     }
951     if ((type == M_ERROR_TERM) && exit_on_error) {
952        exit(1);
953     }
954 }
955
956 /* *********************************************************
957  *
958  * Generate a Job message
959  *
960  */
961 void 
962 Jmsg(JCR *jcr, int type, int level, const char *fmt,...)
963 {
964     char     rbuf[5000];
965     va_list   arg_ptr;
966     int len;
967     MSGS *msgs;
968     const char *job;
969
970     
971     Dmsg1(800, "Enter Jmsg type=%d\n", type);
972
973     /* Special case for the console, which has a dir_bsock and JobId==0,
974      *  in that case, we send the message directly back to the
975      *  dir_bsock.  
976      */
977     if (jcr && jcr->JobId == 0 && jcr->dir_bsock) {
978        BSOCK *dir = jcr->dir_bsock;
979        va_start(arg_ptr, fmt);
980        dir->msglen = bvsnprintf(mp_chr(dir->msg), sizeof_pool_memory(dir->msg), 
981                                 fmt, arg_ptr);
982        va_end(arg_ptr);
983        bnet_send(jcr->dir_bsock);
984        return;
985     }
986
987     msgs = NULL;
988     job = NULL;
989     if (jcr) {
990        msgs = jcr->jcr_msgs;
991        job = jcr->Job;
992     } 
993     if (!msgs) {
994        msgs = daemon_msgs;            /* if no jcr, we use daemon handler */
995     }
996     if (!job) {
997        job = "";                      /* Set null job name if none */
998     }
999
1000     /* 
1001      * Check if we have a message destination defined.  
1002      * We always report M_ABORT and M_ERROR_TERM 
1003      */
1004     if (msgs && (type != M_ABORT && type != M_ERROR_TERM) &&
1005          !bit_is_set(type, msgs->send_msg)) {
1006        return;                        /* no destination */
1007     }
1008     switch (type) {
1009     case M_ABORT:
1010        len = bsnprintf(rbuf, sizeof(rbuf), "%s ABORTING due to ERROR\n", my_name);
1011        break;
1012     case M_ERROR_TERM:
1013        len = bsnprintf(rbuf, sizeof(rbuf), "%s ERROR TERMINATION\n", my_name);
1014        break;
1015     case M_FATAL:
1016        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Fatal error: ", my_name, job);
1017        if (jcr) {
1018           set_jcr_job_status(jcr, JS_FatalError);
1019        }
1020        break;
1021     case M_ERROR:
1022        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Error: ", my_name, job);
1023        if (jcr) {
1024           jcr->Errors++;
1025        }
1026        break;
1027     case M_WARNING:
1028        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Warning: ", my_name, job);
1029        break;
1030     case M_SECURITY:
1031        len = bsnprintf(rbuf, sizeof(rbuf), "%s: %s Security violation: ", my_name, job);
1032        break;
1033     default:
1034        len = bsnprintf(rbuf, sizeof(rbuf), "%s: ", my_name);
1035        break;
1036     }
1037
1038     va_start(arg_ptr, fmt);
1039     bvsnprintf(rbuf+len,  sizeof(rbuf)-len, fmt, arg_ptr);
1040     va_end(arg_ptr);
1041
1042     dispatch_message(jcr, type, level, rbuf);
1043
1044     if (type == M_ABORT){
1045        char *p = 0;
1046        p[0] = 0;                      /* generate segmentation violation */
1047     }
1048     if ((type == M_ERROR_TERM) && exit_on_error) {
1049        exit(1);
1050     }
1051 }
1052
1053 /*
1054  * If we come here, prefix the message with the file:line-number,
1055  *  then pass it on to the normal Jmsg routine.
1056  */
1057 void j_msg(const char *file, int line, JCR *jcr, int type, int level, const char *fmt,...)
1058 {
1059    va_list   arg_ptr;
1060    int i, len, maxlen;
1061    POOLMEM *pool_buf;
1062
1063    pool_buf = get_pool_memory(PM_EMSG);
1064    i = Mmsg(&pool_buf, "%s:%d ", file, line);
1065
1066    for (;;) {
1067       maxlen = sizeof_pool_memory(pool_buf) - i - 1; 
1068       va_start(arg_ptr, fmt);
1069       len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
1070       va_end(arg_ptr);
1071       if (len < 0 || len >= (maxlen-5)) {
1072          pool_buf = realloc_pool_memory(pool_buf, maxlen + i + maxlen/2);
1073          continue;
1074       }
1075       break;
1076    }
1077
1078    Jmsg(jcr, type, level, "%s", pool_buf);
1079    free_memory(pool_buf);
1080 }
1081
1082
1083 /*
1084  * Edit a message into a Pool memory buffer, with file:lineno
1085  */                                                  
1086 int m_msg(const char *file, int line, POOLMEM **pool_buf, const char *fmt, ...)
1087 {
1088    va_list   arg_ptr;
1089    int i, len, maxlen;
1090
1091    i = sprintf(mp_chr(*pool_buf), "%s:%d ", file, line);
1092
1093    for (;;) {
1094       maxlen = sizeof_pool_memory(*pool_buf) - i - 1; 
1095       va_start(arg_ptr, fmt);
1096       len = bvsnprintf(*pool_buf+i, maxlen, fmt, arg_ptr);
1097       va_end(arg_ptr);
1098       if (len < 0 || len >= (maxlen-5)) {
1099          *pool_buf = realloc_pool_memory(*pool_buf, maxlen + i + maxlen/2);
1100          continue;
1101       }
1102       break;
1103    }
1104    return len;
1105 }
1106
1107 /*
1108  * Edit a message into a Pool Memory buffer NO file:lineno
1109  *  Returns: string length of what was edited.
1110  */
1111 int Mmsg(POOLMEM **pool_buf, const char *fmt, ...)
1112 {
1113    va_list   arg_ptr;
1114    int len, maxlen;
1115
1116    for (;;) {
1117       maxlen = sizeof_pool_memory(*pool_buf) - 1; 
1118       va_start(arg_ptr, fmt);
1119       len = bvsnprintf(*pool_buf, maxlen, fmt, arg_ptr);
1120       va_end(arg_ptr);
1121       if (len < 0 || len >= (maxlen-5)) {
1122          *pool_buf = realloc_pool_memory(*pool_buf, maxlen + maxlen/2);
1123          continue;
1124       }
1125       break;
1126    }
1127    return len;
1128 }
1129
1130 static pthread_mutex_t msg_queue_mutex = PTHREAD_MUTEX_INITIALIZER;
1131
1132 /*
1133  * We queue messages rather than print them directly. This
1134  *  is generally used in low level routines (msg handler, bnet)
1135  *  to prevent recursion (i.e. if you are in the middle of 
1136  *  sending a message, it is a bit messy to recursively call
1137  *  yourself when the bnet packet is not reentrant).
1138  */
1139 void Qmsg(JCR *jcr, int type, int level, const char *fmt,...)
1140 {
1141    va_list   arg_ptr;
1142    int len, maxlen;
1143    POOLMEM *pool_buf;
1144    MQUEUE_ITEM *item;
1145
1146    pool_buf = get_pool_memory(PM_EMSG);
1147
1148    for (;;) {
1149       maxlen = sizeof_pool_memory(pool_buf) - 1; 
1150       va_start(arg_ptr, fmt);
1151       len = bvsnprintf(pool_buf, maxlen, fmt, arg_ptr);
1152       va_end(arg_ptr);
1153       if (len < 0 || len >= (maxlen-5)) {
1154          pool_buf = realloc_pool_memory(pool_buf, maxlen + maxlen/2);
1155          continue;
1156       }
1157       break;
1158    }
1159    item = (MQUEUE_ITEM *)malloc(sizeof(MQUEUE_ITEM) + strlen(pool_buf) + 1);
1160    item->type = type;
1161    item->level = level;
1162    strcpy(item->msg, pool_buf);  
1163    P(msg_queue_mutex);
1164    /* If no jcr or dequeuing send to daemon to avoid recursion */
1165    if (!jcr || jcr->dequeuing) {
1166       /* jcr==NULL => daemon message, safe to send now */
1167       Jmsg(NULL, item->type, item->level, "%s", item->msg);
1168       free(item);
1169    } else {
1170       /* Queue message for later sending */
1171       jcr->msg_queue->append(item);
1172 //    Dmsg1(000, "queue item=%lu\n", (long unsigned)item);
1173    }
1174    V(msg_queue_mutex);
1175    free_memory(pool_buf);
1176 }
1177
1178 /*
1179  * Dequeue messages 
1180  */
1181 void dequeue_messages(JCR *jcr)
1182 {
1183    MQUEUE_ITEM *item;
1184    P(msg_queue_mutex);
1185    jcr->dequeuing = true;
1186    foreach_dlist(item, jcr->msg_queue) {
1187 //    Dmsg1(000, "dequeue item=%lu\n", (long unsigned)item);
1188       Jmsg(jcr, item->type, item->level, "%s", item->msg);
1189    }
1190    jcr->msg_queue->destroy();
1191    jcr->dequeuing = false;
1192    V(msg_queue_mutex);
1193 }                                                 
1194
1195
1196 /*
1197  * If we come here, prefix the message with the file:line-number,
1198  *  then pass it on to the normal Qmsg routine.
1199  */
1200 void q_msg(const char *file, int line, JCR *jcr, int type, int level, const char *fmt,...)
1201 {
1202    va_list   arg_ptr;
1203    int i, len, maxlen;
1204    POOLMEM *pool_buf;
1205
1206    pool_buf = get_pool_memory(PM_EMSG);
1207    i = Mmsg(&pool_buf, "%s:%d ", file, line);
1208
1209    for (;;) {
1210       maxlen = sizeof_pool_memory(pool_buf) - i - 1; 
1211       va_start(arg_ptr, fmt);
1212       len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
1213       va_end(arg_ptr);
1214       if (len < 0 || len >= (maxlen-5)) {
1215          pool_buf = realloc_pool_memory(pool_buf, maxlen + i + maxlen/2);
1216          continue;
1217       }
1218       break;
1219    }
1220
1221    Qmsg(jcr, type, level, "%s", pool_buf);
1222    free_memory(pool_buf);
1223 }
1224
1225 /* 
1226  * Define if e_msg must exit when M_ERROR_TERM is received
1227  */
1228 void set_exit_on_error(int value) {
1229    exit_on_error = value;
1230 }