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 debug_level = 5; /* debug level */
38 time_t daemon_start_time = 0; /* Daemon start time */
40 char my_name[20]; /* daemon name is stored here */
41 char *exepath = (char *)NULL;
42 char *exename = (char *)NULL;
43 int console_msg_pending = 0;
49 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. ****FIXME***** segfault on memcpy
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 daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
188 memset(daemon_msgs, 0, sizeof(MSGS));
189 daemon_msgs->dest_chain = temp_chain;
190 memcpy(daemon_msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
192 Dmsg2(050, "Copy message resource 0x%x to 0x%x\n", msg, temp_chain);
196 /* Initialize so that the console (User Agent) can
197 * receive messages -- stored in a file.
199 void init_console_msg(char *wd)
203 sprintf(con_fname, "%s/%s.conmsg", wd, my_name);
204 fd = open(con_fname, O_CREAT|O_RDWR|O_BINARY, 0600);
206 Emsg2(M_ERROR_TERM, 0, _("Could not open console message file %s: ERR=%s\n"),
207 con_fname, strerror(errno));
209 if (lseek(fd, 0, SEEK_END) > 0) {
210 console_msg_pending = 1;
213 con_fd = fopen(con_fname, "a+");
215 Emsg2(M_ERROR, 0, _("Could not open console message file %s: ERR=%s\n"),
216 con_fname, strerror(errno));
218 if (rwl_init(&con_lock) != 0) {
219 Emsg1(M_ERROR_TERM, 0, _("Could not get con mutex: ERR=%s\n"),
225 * Called only during parsing of the config file.
227 * Add a message destination. I.e. associate a message type with
228 * a destination (code).
229 * Note, where in the case of dest_code FILE is a filename,
230 * but in the case of MAIL is a space separated list of
231 * email addresses, ...
233 void add_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where, char *mail_cmd)
237 * First search the existing chain and see if we
238 * can simply add this msg_type to an existing entry.
240 for (d=msg->dest_chain; d; d=d->next) {
241 if (dest_code == d->dest_code && ((where == NULL && d->where == NULL) ||
242 (strcmp(where, d->where) == 0))) {
243 Dmsg4(200, "Add to existing d=%x msgtype=%d destcode=%d where=%s\n",
244 d, msg_type, dest_code, NPRT(where));
245 set_bit(msg_type, d->msg_types);
246 set_bit(msg_type, msg->send_msg); /* set msg_type bit in our local */
250 /* Not found, create a new entry */
251 d = (DEST *)malloc(sizeof(DEST));
252 memset(d, 0, sizeof(DEST));
253 d->next = msg->dest_chain;
254 d->dest_code = dest_code;
255 set_bit(msg_type, d->msg_types); /* set type bit in structure */
256 set_bit(msg_type, msg->send_msg); /* set type bit in our local */
258 d->where = bstrdup(where);
261 d->mail_cmd = bstrdup(mail_cmd);
263 Dmsg5(200, "add new d=%x msgtype=%d destcode=%d where=%s mailcmd=%s\n",
264 d, msg_type, dest_code, NPRT(where), NPRT(d->mail_cmd));
269 * Called only during parsing of the config file.
271 * Remove a message destination
273 void rem_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where)
277 for (d=msg->dest_chain; d; d=d->next) {
278 Dmsg2(200, "Remove_msg_dest d=%x where=%s\n", d, NPRT(d->where));
279 if (bit_is_set(msg_type, d->msg_types) && (dest_code == d->dest_code) &&
280 ((where == NULL && d->where == NULL) ||
281 (strcmp(where, d->where) == 0))) {
282 Dmsg3(200, "Found for remove d=%x msgtype=%d destcode=%d\n",
283 d, msg_type, dest_code);
284 clear_bit(msg_type, d->msg_types);
285 Dmsg0(200, "Return rem_msg_dest\n");
293 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
295 Mmsg(name, "%s/%s.spool.%s.%d", working_directory, my_name,
299 int open_spool_file(void *vjcr, BSOCK *bs)
301 POOLMEM *name = get_pool_memory(PM_MESSAGE);
302 JCR *jcr = (JCR *)vjcr;
304 make_unique_spool_filename(jcr, &name, bs->fd);
305 bs->spool_fd = fopen(name, "w+");
307 Jmsg(jcr, M_ERROR, 0, "fopen spool file %s failed: ERR=%s\n", name, strerror(errno));
308 free_pool_memory(name);
311 free_pool_memory(name);
315 int close_spool_file(void *vjcr, BSOCK *bs)
317 POOLMEM *name = get_pool_memory(PM_MESSAGE);
318 JCR *jcr = (JCR *)vjcr;
320 make_unique_spool_filename(jcr, &name, bs->fd);
321 fclose(bs->spool_fd);
323 free_pool_memory(name);
331 * Create a unique filename for the mail command
333 static void make_unique_mail_filename(JCR *jcr, POOLMEM **name, DEST *d)
336 Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
339 Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
342 Dmsg1(200, "mailname=%s\n", *name);
348 static BPIPE *open_mail_pipe(JCR *jcr, POOLMEM **cmd, DEST *d)
352 if (d->mail_cmd && jcr) {
353 *cmd = edit_job_codes(jcr, *cmd, d->mail_cmd, d->where);
355 Mmsg(cmd, "mail -s \"Bacula Message\" %s", d->where);
359 if (!(bpipe = open_bpipe(*cmd, 120, "rw"))) {
360 Jmsg(jcr, M_ERROR, 0, "open mail pipe %s failed: ERR=%s\n", *cmd, strerror(errno));
366 * Close the messages for this Messages resource, which means to close
367 * any open files, and dispatch any pending email messages.
369 void close_msg(void *vjcr)
372 JCR *jcr = (JCR *)vjcr;
378 Dmsg1(050, "Close_msg jcr=0x%x\n", jcr);
380 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");
465 Dmsg0(150, "===End close msg resource\n");
469 * Free memory associated with Messages resource
471 void free_msgs_res(MSGS *msgs)
475 for (d=msgs->dest_chain; d; ) {
482 old = d; /* save pointer to release */
483 d = d->next; /* point to next buffer */
484 free(old); /* free the destination item */
486 msgs->dest_chain = NULL;
492 * Terminate the message handler for good.
493 * Release the global destination chain.
495 * Also, clean up a few other items (cons, exepath). Note,
496 * these really should be done elsewhere.
500 Dmsg0(100, "Enter term_msg\n");
501 close_msg(NULL); /* close global chain */
525 * Handle sending the message to the appropriate place
527 void dispatch_message(void *vjcr, int type, int level, char *msg)
530 char dt[MAX_TIME_LENGTH];
532 JCR *jcr = (JCR *) vjcr;
537 Dmsg2(200, "Enter dispatch_msg type=%d msg=%s\n", type, msg);
539 if (type == M_ABORT || type == M_ERROR_TERM) {
540 fputs(msg, stdout); /* print this here to INSURE that it is printed */
543 /* Now figure out where to send the message */
546 msgs = jcr->jcr_msgs;
551 for (d=msgs->dest_chain; d; d=d->next) {
552 if (bit_is_set(type, d->msg_types)) {
553 switch (d->dest_code) {
555 Dmsg1(400, "CONSOLE for following msg: %s", msg);
557 con_fd = fopen(con_fname, "a+");
558 Dmsg0(200, "Console file not open.\n");
561 Pw(con_lock); /* get write lock on console message file */
563 bstrftime(dt, sizeof(dt), time(NULL));
566 fwrite(dt, len, 1, con_fd);
569 fwrite(msg, len, 1, con_fd);
570 if (msg[len-1] != '\n') {
571 fwrite("\n", 2, 1, con_fd);
574 fwrite("\n", 2, 1, con_fd);
577 console_msg_pending = TRUE;
582 Dmsg1(400, "SYSLOG for collowing msg: %s\n", msg);
583 /* We really should do an openlog() here */
584 syslog(LOG_DAEMON|LOG_ERR, msg);
587 Dmsg1(400, "OPERATOR for collowing msg: %s\n", msg);
588 mcmd = get_pool_memory(PM_MESSAGE);
589 if ((bpipe=open_mail_pipe(jcr, &mcmd, d))) {
591 fputs(msg, bpipe->wfd);
592 /* Messages to the operator go one at a time */
593 stat = close_bpipe(bpipe);
595 Emsg1(M_ERROR, 0, _("Operator mail program terminated in error.\nCMD=%s\n"),
599 free_pool_memory(mcmd);
602 case MD_MAIL_ON_ERROR:
603 Dmsg1(400, "MAIL for following msg: %s", msg);
605 POOLMEM *name = get_pool_memory(PM_MESSAGE);
606 make_unique_mail_filename(jcr, &name, d);
607 d->fd = fopen(name, "w+");
610 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", name, strerror(errno));
612 free_pool_memory(name);
615 d->mail_filename = name;
618 if (len > d->max_len) {
619 d->max_len = len; /* keep max line length */
624 Dmsg1(400, "FILE for following msg: %s", msg);
626 d->fd = fopen(d->where, "w+");
629 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
637 Dmsg1(400, "APPEND for following msg: %s", msg);
639 d->fd = fopen(d->where, "a");
642 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
650 Dmsg1(400, "DIRECTOR for following msg: %s", msg);
651 if (jcr && jcr->dir_bsock && !jcr->dir_bsock->errors) {
653 jcr->dir_bsock->msglen = Mmsg(&(jcr->dir_bsock->msg),
654 "Jmsg Job=%s type=%d level=%d %s", jcr->Job,
655 type, level, msg) + 1;
656 bnet_send(jcr->dir_bsock);
660 Dmsg1(400, "STDOUT for following msg: %s", msg);
661 if (type != M_ABORT && type != M_ERROR_TERM) /* already printed */
665 Dmsg1(400, "STDERR for following msg: %s", msg);
676 /*********************************************************************
678 * subroutine prints a debug message if the level number
679 * is less than or equal the debug_level. File and line numbers
680 * are included for more detail if desired, but not currently
683 * If the level is negative, the details of file and line number
687 d_msg(char *file, int line, int level, char *fmt,...)
699 if (level <= debug_level) {
702 len= sprintf(buf, "%s: %s:%d ", my_name, file, line);
709 va_start(arg_ptr, fmt);
710 bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
718 /*********************************************************************
720 * subroutine writes a debug message to the trace file if the level number
721 * is less than or equal the debug_level. File and line numbers
722 * are included for more detail if desired, but not currently
725 * If the level is negative, the details of file and line number
729 t_msg(char *file, int line, int level, char *fmt,...)
743 if (level <= debug_level) {
745 trace_fd = fopen("bacula.trace", "a+");
747 Emsg1(M_ABORT, 0, _("Cannot open bacula.trace: ERR=%s\n"),
754 len = sprintf(buf, "%s: %s:%d ", my_name, file, line);
761 va_start(arg_ptr, fmt);
762 bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
765 fputs(buf, trace_fd);
772 /* *********************************************************
774 * print an error message
778 e_msg(char *file, int line, int type, int level, char *fmt,...)
785 * Check if we have a message destination defined.
786 * We always report M_ABORT and M_ERROR_TERM
788 if (!daemon_msgs || ((type != M_ABORT && type != M_ERROR_TERM) &&
789 !bit_is_set(type, daemon_msgs->send_msg))) {
790 return; /* no destination */
794 len = sprintf(buf, "%s: ABORTING due to ERROR in %s:%d\n",
795 my_name, file, line);
798 len = sprintf(buf, "%s: ERROR TERMINATION at %s:%d\n",
799 my_name, file, line);
802 if (level == -1) /* skip details */
803 len = sprintf(buf, "%s: Fatal Error because: ", my_name);
805 len = sprintf(buf, "%s: Fatal Error at %s:%d because:\n", my_name, file, line);
808 if (level == -1) /* skip details */
809 len = sprintf(buf, "%s: Error: ", my_name);
811 len = sprintf(buf, "%s: Error in %s:%d ", my_name, file, line);
814 len = sprintf(buf, "%s: Warning: ", my_name);
817 len = sprintf(buf, "%s: ", my_name);
821 va_start(arg_ptr, fmt);
822 bvsnprintf(buf+len, sizeof(buf)-len, (char *)fmt, arg_ptr);
825 dispatch_message(NULL, type, level, buf);
827 if (type == M_ABORT) {
829 p[0] = 0; /* generate segmentation violation */
831 if (type == M_ERROR_TERM) {
836 /* *********************************************************
838 * Generate a Job message
842 Jmsg(void *vjcr, int type, int level, char *fmt,...)
847 JCR *jcr = (JCR *)vjcr;
852 Dmsg1(200, "Enter Jmsg type=%d\n", type);
857 msgs = jcr->jcr_msgs;
861 msgs = daemon_msgs; /* if no jcr, we use daemon handler */
864 job = ""; /* Set null job name if none */
868 * Check if we have a message destination defined.
869 * We always report M_ABORT and M_ERROR_TERM
872 /* There is an apparent compiler bug with the following if
873 * statement, so the set_jcr... is simply a noop to reload
876 set_jcr_job_status(jcr, jcr->JobStatus);
877 if (msgs && (type != M_ABORT && type != M_ERROR_TERM) &&
878 !bit_is_set(type, msgs->send_msg)) {
879 return; /* no destination */
883 len = sprintf(rbuf, "%s ABORTING due to ERROR\n", my_name);
886 len = sprintf(rbuf, "%s ERROR TERMINATION\n", my_name);
889 len = sprintf(rbuf, "%s: %s Fatal error: ", my_name, job);
891 set_jcr_job_status(jcr, JS_FatalError);
895 len = sprintf(rbuf, "%s: %s Error: ", my_name, job);
901 len = sprintf(rbuf, "%s: %s Warning: ", my_name, job);
904 len = sprintf(rbuf, "%s: ", my_name);
908 va_start(arg_ptr, fmt);
909 bvsnprintf(rbuf+len, sizeof(rbuf)-len, fmt, arg_ptr);
912 dispatch_message(jcr, type, level, rbuf);
914 if (type == M_ABORT){
916 p[0] = 0; /* generate segmentation violation */
918 if (type == M_ERROR_TERM) {
924 * Edit a message into a Pool memory buffer, with file:lineno
926 int m_msg(char *file, int line, POOLMEM **pool_buf, char *fmt, ...)
931 i = sprintf(*pool_buf, "%s:%d ", file, line);
934 maxlen = sizeof_pool_memory(*pool_buf) - i - 1;
935 va_start(arg_ptr, fmt);
936 len = bvsnprintf(*pool_buf+i, maxlen, fmt, arg_ptr);
938 if (len < 0 || len >= maxlen) {
939 *pool_buf = realloc_pool_memory(*pool_buf, maxlen + i + 200);
946 * Edit a message into a Pool Memory buffer NO file:lineno
947 * Returns: string length of what was edited.
949 int Mmsg(POOLMEM **pool_buf, char *fmt, ...)
955 maxlen = sizeof_pool_memory(*pool_buf) - 1;
956 va_start(arg_ptr, fmt);
957 len = bvsnprintf(*pool_buf, maxlen, fmt, arg_ptr);
959 if (len < 0 || len >= maxlen) {
960 *pool_buf = realloc_pool_memory(*pool_buf, maxlen + 200);
968 * If we come here, prefix the message with the file:line-number,
969 * then pass it on to the normal Jmsg routine.
971 void j_msg(char *file, int line, void *jcr, int type, int level, char *fmt,...)
977 pool_buf = get_pool_memory(PM_EMSG);
978 i = sprintf(pool_buf, "%s:%d ", file, line);
981 maxlen = sizeof_pool_memory(pool_buf) - i - 1;
982 va_start(arg_ptr, fmt);
983 len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
985 if (len < 0 || len >= maxlen) {
986 pool_buf = realloc_pool_memory(pool_buf, maxlen + i + 200);
990 Jmsg(jcr, type, level, "%s", pool_buf);
991 free_memory(pool_buf);