2 * Bacula message handling routines
4 * Kern Sibbald, April 2000
11 Copyright (C) 2000-2003 Kern Sibbald and John Walker
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.
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.
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,
34 #define FULL_LOCATION 1 /* set for file:line in Debug messages */
36 char *working_directory = NULL; /* working directory path stored here */
37 int verbose = 0; /* increase User messages */
38 int debug_level = 0; /* debug level */
39 time_t daemon_start_time = 0; /* Daemon start time */
40 char *version = VERSION " (" BDATE ")";
42 char my_name[20]; /* daemon name is stored here */
43 char *exepath = (char *)NULL;
44 char *exename = (char *)NULL;
45 int console_msg_pending = 0;
46 char con_fname[500]; /* Console filename */
47 FILE *con_fd = NULL; /* Console file descriptor */
48 brwlock_t con_lock; /* Console lock structure */
50 FILE *trace_fd = NULL;
52 /* Forward referenced functions */
54 /* Imported functions */
59 static MSGS *daemon_msgs; /* global messages */
62 * Set daemon name. Also, find canonical execution
63 * path. Note, exepath has spare room for tacking on
64 * the exename so that we can reconstruct the full name.
66 * Note, this routine can get called multiple times
67 * The second time is to put the name as found in the
68 * Resource record. On the second call, generally,
69 * argv is NULL to avoid doing the path code twice.
71 #define BTRACE_EXTRA 20
72 void my_name_is(int argc, char *argv[], char *name)
75 char cpath[400], npath[400];
78 bstrncpy(my_name, name, sizeof(my_name));
79 if (argc>0 && argv && argv[0]) {
80 /* strip trailing filename and save exepath */
81 for (l=p=argv[0]; *p; p++) {
83 l = p; /* set pos of last slash */
91 /* On Windows allow c: junk */
101 exename = (char *)malloc(len);
107 exepath = (char *)malloc(strlen(argv[0]) + 1 + len);
108 for (p=argv[0],q=exepath; p < l; ) {
112 Dmsg1(200, "exepath=%s\n", exepath);
113 if (strchr(exepath, '.') || exepath[0] != '/') {
115 if (getcwd(cpath, sizeof(cpath))) {
116 if (chdir(exepath) == 0) {
117 if (!getcwd(npath, sizeof(npath))) {
124 exepath = (char *)malloc(strlen(npath) + 1 + len);
125 strcpy(exepath, npath);
128 Dmsg1(200, "Normalized exepath=%s\n", exepath);
134 * Initialize message handler for a daemon or a Job
135 * We make a copy of the MSGS resource passed, so it belows
136 * to the job or daemon and thus can be modified.
138 * NULL for jcr -> initialize global messages for daemon
139 * non-NULL -> initialize jcr using Message resource
142 init_msg(void *vjcr, MSGS *msg)
144 DEST *d, *dnew, *temp_chain = NULL;
145 JCR *jcr = (JCR *)vjcr;
148 * If msg is NULL, initialize global chain for STDOUT and syslog
152 daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
153 memset(daemon_msgs, 0, sizeof(MSGS));
154 for (i=1; i<=M_MAX; i++) {
155 add_msg_dest(daemon_msgs, MD_STDOUT, i, NULL, NULL);
156 add_msg_dest(daemon_msgs, MD_SYSLOG, i, NULL, NULL);
158 Dmsg1(050, "Create daemon global message resource 0x%x\n", daemon_msgs);
163 * Walk down the message resource chain duplicating it
164 * for the current Job.
166 for (d=msg->dest_chain; d; d=d->next) {
167 dnew = (DEST *)malloc(sizeof(DEST));
168 memcpy(dnew, d, sizeof(DEST));
169 dnew->next = temp_chain;
171 dnew->mail_filename = NULL;
173 dnew->mail_cmd = bstrdup(d->mail_cmd);
176 dnew->where = bstrdup(d->where);
182 jcr->jcr_msgs = (MSGS *)malloc(sizeof(MSGS));
183 memset(jcr->jcr_msgs, 0, sizeof(MSGS));
184 jcr->jcr_msgs->dest_chain = temp_chain;
185 memcpy(jcr->jcr_msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
187 /* If we have default values, release them now */
189 free_msgs_res(daemon_msgs);
191 daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
192 memset(daemon_msgs, 0, sizeof(MSGS));
193 daemon_msgs->dest_chain = temp_chain;
194 memcpy(daemon_msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
196 Dmsg2(050, "Copy message resource 0x%x to 0x%x\n", msg, temp_chain);
200 /* Initialize so that the console (User Agent) can
201 * receive messages -- stored in a file.
203 void init_console_msg(char *wd)
207 bsnprintf(con_fname, sizeof(con_fname), "%s/%s.conmsg", wd, my_name);
208 fd = open(con_fname, O_CREAT|O_RDWR|O_BINARY, 0600);
210 Emsg2(M_ERROR_TERM, 0, _("Could not open console message file %s: ERR=%s\n"),
211 con_fname, strerror(errno));
213 if (lseek(fd, 0, SEEK_END) > 0) {
214 console_msg_pending = 1;
217 con_fd = fopen(con_fname, "a+");
219 Emsg2(M_ERROR, 0, _("Could not open console message file %s: ERR=%s\n"),
220 con_fname, strerror(errno));
222 if (rwl_init(&con_lock) != 0) {
223 Emsg1(M_ERROR_TERM, 0, _("Could not get con mutex: ERR=%s\n"),
229 * Called only during parsing of the config file.
231 * Add a message destination. I.e. associate a message type with
232 * a destination (code).
233 * Note, where in the case of dest_code FILE is a filename,
234 * but in the case of MAIL is a space separated list of
235 * email addresses, ...
237 void add_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where, char *mail_cmd)
241 * First search the existing chain and see if we
242 * can simply add this msg_type to an existing entry.
244 for (d=msg->dest_chain; d; d=d->next) {
245 if (dest_code == d->dest_code && ((where == NULL && d->where == NULL) ||
246 (strcmp(where, d->where) == 0))) {
247 Dmsg4(200, "Add to existing d=%x msgtype=%d destcode=%d where=%s\n",
248 d, msg_type, dest_code, NPRT(where));
249 set_bit(msg_type, d->msg_types);
250 set_bit(msg_type, msg->send_msg); /* set msg_type bit in our local */
254 /* Not found, create a new entry */
255 d = (DEST *)malloc(sizeof(DEST));
256 memset(d, 0, sizeof(DEST));
257 d->next = msg->dest_chain;
258 d->dest_code = dest_code;
259 set_bit(msg_type, d->msg_types); /* set type bit in structure */
260 set_bit(msg_type, msg->send_msg); /* set type bit in our local */
262 d->where = bstrdup(where);
265 d->mail_cmd = bstrdup(mail_cmd);
267 Dmsg5(200, "add new d=%x msgtype=%d destcode=%d where=%s mailcmd=%s\n",
268 d, msg_type, dest_code, NPRT(where), NPRT(d->mail_cmd));
273 * Called only during parsing of the config file.
275 * Remove a message destination
277 void rem_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where)
281 for (d=msg->dest_chain; d; d=d->next) {
282 Dmsg2(200, "Remove_msg_dest d=%x where=%s\n", d, NPRT(d->where));
283 if (bit_is_set(msg_type, d->msg_types) && (dest_code == d->dest_code) &&
284 ((where == NULL && d->where == NULL) ||
285 (strcmp(where, d->where) == 0))) {
286 Dmsg3(200, "Found for remove d=%x msgtype=%d destcode=%d\n",
287 d, msg_type, dest_code);
288 clear_bit(msg_type, d->msg_types);
289 Dmsg0(200, "Return rem_msg_dest\n");
295 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
297 Mmsg(name, "%s/%s.spool.%s.%d", working_directory, my_name,
301 int open_spool_file(void *vjcr, BSOCK *bs)
303 POOLMEM *name = get_pool_memory(PM_MESSAGE);
304 JCR *jcr = (JCR *)vjcr;
306 make_unique_spool_filename(jcr, &name, bs->fd);
307 bs->spool_fd = fopen(name, "w+");
309 Jmsg(jcr, M_ERROR, 0, "fopen spool file %s failed: ERR=%s\n", name, strerror(errno));
310 free_pool_memory(name);
313 free_pool_memory(name);
317 int close_spool_file(void *vjcr, BSOCK *bs)
319 POOLMEM *name = get_pool_memory(PM_MESSAGE);
320 JCR *jcr = (JCR *)vjcr;
322 make_unique_spool_filename(jcr, &name, bs->fd);
323 fclose(bs->spool_fd);
325 free_pool_memory(name);
332 * Create a unique filename for the mail command
334 static void make_unique_mail_filename(JCR *jcr, POOLMEM **name, DEST *d)
337 Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
340 Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
343 Dmsg1(200, "mailname=%s\n", *name);
349 static BPIPE *open_mail_pipe(JCR *jcr, POOLMEM **cmd, DEST *d)
353 if (d->mail_cmd && jcr) {
354 *cmd = edit_job_codes(jcr, *cmd, d->mail_cmd, d->where);
356 Mmsg(cmd, "mail -s \"Bacula Message\" %s", d->where);
360 if (!(bpipe = open_bpipe(*cmd, 120, "rw"))) {
361 Jmsg(jcr, M_ERROR, 0, "open mail pipe %s failed: ERR=%s\n", *cmd, strerror(errno));
367 * Close the messages for this Messages resource, which means to close
368 * any open files, and dispatch any pending email messages.
370 void close_msg(void *vjcr)
373 JCR *jcr = (JCR *)vjcr;
379 Dmsg1(050, "Close_msg jcr=0x%x\n", jcr);
381 if (jcr == NULL) { /* NULL -> global chain */
384 msgs = jcr->jcr_msgs;
385 jcr->jcr_msgs = NULL;
390 Dmsg1(150, "===Begin close msg resource at 0x%x\n", msgs);
391 cmd = get_pool_memory(PM_MESSAGE);
392 for (d=msgs->dest_chain; d; ) {
394 switch (d->dest_code) {
398 fclose(d->fd); /* close open file descriptor */
402 case MD_MAIL_ON_ERROR:
403 Dmsg0(150, "Got MD_MAIL or MD_MAIL_ON_ERROR\n");
407 if (d->dest_code == MD_MAIL_ON_ERROR && jcr &&
408 jcr->JobStatus == JS_Terminated) {
412 if (!(bpipe=open_mail_pipe(jcr, &cmd, d))) {
413 Dmsg0(000, "open mail pipe failed.\n");
416 Dmsg0(150, "Opened mail pipe\n");
418 line = get_memory(len);
420 while (fgets(line, len, d->fd)) {
421 fputs(line, bpipe->wfd);
423 if (!close_wpipe(bpipe)) { /* close write pipe sending mail */
424 Dmsg1(000, "close error: ERR=%s\n", strerror(errno));
428 * Since we are closing all messages, before "recursing"
429 * make sure we are not closing the daemon messages, otherwise
432 if (msgs != daemon_msgs) {
433 /* read what mail prog returned -- should be nothing */
434 while (fgets(line, len, bpipe->rfd)) {
435 Jmsg1(jcr, M_INFO, 0, _("Mail prog: %s"), line);
439 stat = close_bpipe(bpipe);
440 if (stat != 0 && msgs != daemon_msgs) {
441 Dmsg1(150, "Calling emsg. CMD=%s\n", cmd);
442 Jmsg2(jcr, M_ERROR, 0, _("Mail program terminated in error. stat=%d\n"
443 "CMD=%s\n"), stat, cmd);
447 /* Remove temp file */
449 unlink(d->mail_filename);
450 free_pool_memory(d->mail_filename);
451 d->mail_filename = NULL;
452 Dmsg0(150, "end mail or mail on error\n");
459 d = d->next; /* point to next buffer */
461 free_pool_memory(cmd);
462 Dmsg0(150, "Done walking message chain.\n");
467 Dmsg0(150, "===End close msg resource\n");
471 * Free memory associated with Messages resource
473 void free_msgs_res(MSGS *msgs)
477 /* Walk down the message chain releasing allocated buffers */
478 for (d=msgs->dest_chain; d; ) {
485 old = d; /* save pointer to release */
486 d = d->next; /* point to next buffer */
487 free(old); /* free the destination item */
489 msgs->dest_chain = NULL;
490 free(msgs); /* free the head */
495 * Terminate the message handler for good.
496 * Release the global destination chain.
498 * Also, clean up a few other items (cons, exepath). Note,
499 * these really should be done elsewhere.
503 Dmsg0(100, "Enter term_msg\n");
504 close_msg(NULL); /* close global chain */
505 free_msgs_res(daemon_msgs); /* free the resources */
529 * Handle sending the message to the appropriate place
531 void dispatch_message(void *vjcr, int type, int level, char *msg)
534 char dt[MAX_TIME_LENGTH];
536 JCR *jcr = (JCR *) vjcr;
541 Dmsg2(800, "Enter dispatch_msg type=%d msg=%s\n", type, msg);
543 if (type == M_ABORT || type == M_ERROR_TERM) {
544 fputs(msg, stdout); /* print this here to INSURE that it is printed */
547 /* Now figure out where to send the message */
550 msgs = jcr->jcr_msgs;
555 for (d=msgs->dest_chain; d; d=d->next) {
556 if (bit_is_set(type, d->msg_types)) {
557 switch (d->dest_code) {
559 Dmsg1(800, "CONSOLE for following msg: %s", msg);
561 con_fd = fopen(con_fname, "a+");
562 Dmsg0(800, "Console file not open.\n");
565 Pw(con_lock); /* get write lock on console message file */
567 bstrftime(dt, sizeof(dt), time(NULL));
570 fwrite(dt, len, 1, con_fd);
573 fwrite(msg, len, 1, con_fd);
574 if (msg[len-1] != '\n') {
575 fwrite("\n", 2, 1, con_fd);
578 fwrite("\n", 2, 1, con_fd);
581 console_msg_pending = TRUE;
586 Dmsg1(800, "SYSLOG for collowing msg: %s\n", msg);
588 * We really should do an openlog() here.
590 syslog(LOG_DAEMON|LOG_ERR, "%s", msg);
593 Dmsg1(800, "OPERATOR for collowing msg: %s\n", msg);
594 mcmd = get_pool_memory(PM_MESSAGE);
595 if ((bpipe=open_mail_pipe(jcr, &mcmd, d))) {
597 fputs(msg, bpipe->wfd);
598 /* Messages to the operator go one at a time */
599 stat = close_bpipe(bpipe);
601 Emsg1(M_ERROR, 0, _("Operator mail program terminated in error.\nCMD=%s\n"),
605 free_pool_memory(mcmd);
608 case MD_MAIL_ON_ERROR:
609 Dmsg1(800, "MAIL for following msg: %s", msg);
611 POOLMEM *name = get_pool_memory(PM_MESSAGE);
612 make_unique_mail_filename(jcr, &name, d);
613 d->fd = fopen(name, "w+");
616 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", name, strerror(errno));
618 free_pool_memory(name);
621 d->mail_filename = name;
624 if (len > d->max_len) {
625 d->max_len = len; /* keep max line length */
630 Dmsg1(800, "FILE for following msg: %s", msg);
632 d->fd = fopen(d->where, "w+");
635 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
643 Dmsg1(800, "APPEND for following msg: %s", msg);
645 d->fd = fopen(d->where, "a");
648 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
656 Dmsg1(800, "DIRECTOR for following msg: %s", msg);
657 if (jcr && jcr->dir_bsock && !jcr->dir_bsock->errors) {
659 jcr->dir_bsock->msglen = Mmsg(&(jcr->dir_bsock->msg),
660 "Jmsg Job=%s type=%d level=%d %s", jcr->Job,
661 type, level, msg) + 1;
662 bnet_send(jcr->dir_bsock);
666 Dmsg1(800, "STDOUT for following msg: %s", msg);
667 if (type != M_ABORT && type != M_ERROR_TERM) { /* already printed */
672 Dmsg1(800, "STDERR for following msg: %s", msg);
683 /*********************************************************************
685 * subroutine prints a debug message if the level number
686 * is less than or equal the debug_level. File and line numbers
687 * are included for more detail if desired, but not currently
690 * If the level is negative, the details of file and line number
694 d_msg(char *file, int line, int level, char *fmt,...)
707 if (level <= debug_level) {
708 #ifdef SEND_DMSG_TO_FILE
710 bsnprintf(buf, sizeof(buf), "%s/bacula.trace", working_directory);
711 trace_fd = fopen(buf, "a+");
713 Emsg2(M_ABORT, 0, _("Cannot open %s: ERR=%s\n"),
714 buf, strerror(errno));
720 len= sprintf(buf, "%s: %s:%d ", my_name, file, line);
727 va_start(arg_ptr, fmt);
728 bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
731 #ifdef SEND_DMSG_TO_FILE
732 fputs(buf, trace_fd);
741 /*********************************************************************
743 * subroutine writes a debug message to the trace file if the level number
744 * is less than or equal the debug_level. File and line numbers
745 * are included for more detail if desired, but not currently
748 * If the level is negative, the details of file and line number
752 t_msg(char *file, int line, int level, char *fmt,...)
766 if (level <= debug_level) {
768 bsnprintf(buf, sizeof(buf), "%s/bacula.trace", working_directory);
769 trace_fd = fopen(buf, "a+");
771 Emsg2(M_ABORT, 0, _("Cannot open %s: ERR=%s\n"),
772 buf, strerror(errno));
778 len = sprintf(buf, "%s: %s:%d ", my_name, file, line);
785 va_start(arg_ptr, fmt);
786 bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
789 fputs(buf, trace_fd);
796 /* *********************************************************
798 * print an error message
802 e_msg(char *file, int line, int type, int level, char *fmt,...)
809 * Check if we have a message destination defined.
810 * We always report M_ABORT and M_ERROR_TERM
812 if (!daemon_msgs || ((type != M_ABORT && type != M_ERROR_TERM) &&
813 !bit_is_set(type, daemon_msgs->send_msg))) {
814 return; /* no destination */
818 len = sprintf(buf, "%s: ABORTING due to ERROR in %s:%d\n",
819 my_name, file, line);
822 len = sprintf(buf, "%s: ERROR TERMINATION at %s:%d\n",
823 my_name, file, line);
826 if (level == -1) /* skip details */
827 len = sprintf(buf, "%s: Fatal Error because: ", my_name);
829 len = sprintf(buf, "%s: Fatal Error at %s:%d because:\n", my_name, file, line);
832 if (level == -1) /* skip details */
833 len = sprintf(buf, "%s: Error: ", my_name);
835 len = sprintf(buf, "%s: Error in %s:%d ", my_name, file, line);
838 len = sprintf(buf, "%s: Warning: ", my_name);
841 len = sprintf(buf, "%s: ", my_name);
845 va_start(arg_ptr, fmt);
846 bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
849 dispatch_message(NULL, type, level, buf);
851 if (type == M_ABORT) {
853 p[0] = 0; /* generate segmentation violation */
855 if (type == M_ERROR_TERM) {
860 /* *********************************************************
862 * Generate a Job message
866 Jmsg(void *vjcr, int type, int level, char *fmt,...)
871 JCR *jcr = (JCR *)vjcr;
876 Dmsg1(800, "Enter Jmsg type=%d\n", type);
878 /* Special case for the console, which has a dir_bsock and JobId==0,
879 * in that case, we send the message directly back to the
882 if (jcr && jcr->JobId == 0 && jcr->dir_bsock) {
883 BSOCK *dir = jcr->dir_bsock;
884 va_start(arg_ptr, fmt);
885 dir->msglen = bvsnprintf(dir->msg, sizeof_pool_memory(dir->msg), fmt, arg_ptr);
887 bnet_send(jcr->dir_bsock);
894 msgs = jcr->jcr_msgs;
898 msgs = daemon_msgs; /* if no jcr, we use daemon handler */
901 job = ""; /* Set null job name if none */
905 * Check if we have a message destination defined.
906 * We always report M_ABORT and M_ERROR_TERM
908 if (msgs && (type != M_ABORT && type != M_ERROR_TERM) &&
909 !bit_is_set(type, msgs->send_msg)) {
910 return; /* no destination */
914 len = sprintf(rbuf, "%s ABORTING due to ERROR\n", my_name);
917 len = sprintf(rbuf, "%s ERROR TERMINATION\n", my_name);
920 len = sprintf(rbuf, "%s: %s Fatal error: ", my_name, job);
922 set_jcr_job_status(jcr, JS_FatalError);
926 len = sprintf(rbuf, "%s: %s Error: ", my_name, job);
932 len = sprintf(rbuf, "%s: %s Warning: ", my_name, job);
935 len = sprintf(rbuf, "%s: ", my_name);
939 va_start(arg_ptr, fmt);
940 bvsnprintf(rbuf+len, sizeof(rbuf)-len, fmt, arg_ptr);
943 dispatch_message(jcr, type, level, rbuf);
945 if (type == M_ABORT){
947 p[0] = 0; /* generate segmentation violation */
949 if (type == M_ERROR_TERM) {
955 * Edit a message into a Pool memory buffer, with file:lineno
957 int m_msg(char *file, int line, POOLMEM **pool_buf, char *fmt, ...)
962 i = sprintf(*pool_buf, "%s:%d ", file, line);
965 maxlen = sizeof_pool_memory(*pool_buf) - i - 1;
966 va_start(arg_ptr, fmt);
967 len = bvsnprintf(*pool_buf+i, maxlen, fmt, arg_ptr);
969 if (len < 0 || len >= maxlen) {
970 *pool_buf = realloc_pool_memory(*pool_buf, maxlen + i + 200);
977 * Edit a message into a Pool Memory buffer NO file:lineno
978 * Returns: string length of what was edited.
980 int Mmsg(POOLMEM **pool_buf, char *fmt, ...)
986 maxlen = sizeof_pool_memory(*pool_buf) - 1;
987 va_start(arg_ptr, fmt);
988 len = bvsnprintf(*pool_buf, maxlen, fmt, arg_ptr);
990 if (len < 0 || len >= maxlen) {
991 *pool_buf = realloc_pool_memory(*pool_buf, maxlen + 200);
999 * If we come here, prefix the message with the file:line-number,
1000 * then pass it on to the normal Jmsg routine.
1002 void j_msg(char *file, int line, void *jcr, int type, int level, char *fmt,...)
1008 pool_buf = get_pool_memory(PM_EMSG);
1009 i = sprintf(pool_buf, "%s:%d ", file, line);
1012 maxlen = sizeof_pool_memory(pool_buf) - i - 1;
1013 va_start(arg_ptr, fmt);
1014 len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
1016 if (len < 0 || len >= maxlen) {
1017 pool_buf = realloc_pool_memory(pool_buf, maxlen + i + 200);
1021 Jmsg(jcr, type, level, "%s", pool_buf);
1022 free_memory(pool_buf);