2 * Bacula message handling routines
4 * Kern Sibbald, April 2000
11 Copyright (C) 2000, 2001, 2002 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;
46 pthread_mutex_t con_mutex = PTHREAD_MUTEX_INITIALIZER;
48 /* Forward referenced functions */
50 /* Imported functions */
55 static MSGS *daemon_msgs; /* global messages */
58 * Set daemon name. Also, find canonical execution
59 * path. Note, exepath has spare room for tacking on
60 * the exename so that we can reconstruct the full name.
62 * Note, this routine can get called multiple times
63 * The second time is to put the name as found in the
64 * Resource record. On the second call, generally,
65 * argv is NULL to avoid doing the path code twice.
67 #define BTRACE_EXTRA 20
68 void my_name_is(int argc, char *argv[], char *name)
71 char cpath[400], npath[400];
74 strncpy(my_name, name, sizeof(my_name));
75 my_name[sizeof(my_name)-1] = 0;
76 if (argc>0 && argv && argv[0]) {
77 /* strip trailing filename and save exepath */
78 for (l=p=argv[0]; *p; p++) {
80 l = p; /* set pos of last slash */
88 /* On Windows allow c: junk */
98 exename = (char *)malloc(len);
104 exepath = (char *)malloc(strlen(argv[0]) + 1 + len);
105 for (p=argv[0],q=exepath; p < l; ) {
109 Dmsg1(200, "exepath=%s\n", exepath);
110 if (strchr(exepath, '.') || exepath[0] != '/') {
112 if (getcwd(cpath, sizeof(cpath))) {
113 if (chdir(exepath) == 0) {
114 if (!getcwd(npath, sizeof(npath))) {
121 exepath = (char *)malloc(strlen(npath) + 1 + len);
122 strcpy(exepath, npath);
125 Dmsg1(200, "Normalized exepath=%s\n", exepath);
131 * Initialize message handler for a daemon or a Job
133 * NULL for jcr -> initialize global messages for daemon
134 * non-NULL -> initialize jcr using Message resource
137 init_msg(void *vjcr, MSGS *msg)
139 DEST *d, *dnew, *temp_chain = NULL;
140 JCR *jcr = (JCR *)vjcr;
143 * If msg is NULL, initialize global chain for STDOUT and syslog
147 daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
148 memset(daemon_msgs, 0, sizeof(MSGS));
149 for (i=1; i<=M_MAX; i++) {
150 add_msg_dest(daemon_msgs, MD_STDOUT, i, NULL, NULL);
151 add_msg_dest(daemon_msgs, MD_SYSLOG, i, NULL, NULL);
153 Dmsg1(050, "Create daemon global message resource 0x%x\n", daemon_msgs);
158 * Walk down the message resource chain duplicating it
159 * for the current Job. ****FIXME***** segfault on memcpy
161 for (d=msg->dest_chain; d; d=d->next) {
162 dnew = (DEST *)malloc(sizeof(DEST));
163 memcpy(dnew, d, sizeof(DEST));
164 dnew->next = temp_chain;
166 dnew->mail_filename = NULL;
168 dnew->mail_cmd = bstrdup(d->mail_cmd);
171 dnew->where = bstrdup(d->where);
177 jcr->msgs = (MSGS *)malloc(sizeof(MSGS));
178 memset(jcr->msgs, 0, sizeof(MSGS));
179 jcr->msgs->dest_chain = temp_chain;
180 memcpy(jcr->msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
182 daemon_msgs = (MSGS *)malloc(sizeof(MSGS));
183 memset(daemon_msgs, 0, sizeof(MSGS));
184 daemon_msgs->dest_chain = temp_chain;
185 memcpy(daemon_msgs->send_msg, msg->send_msg, sizeof(msg->send_msg));
187 Dmsg2(050, "Copy message resource 0x%x to 0x%x\n", msg, temp_chain);
190 /* Initialize so that the console (User Agent) can
191 * receive messages -- stored in a file.
193 void init_console_msg(char *wd)
197 sprintf(con_fname, "%s/%s.conmsg", wd, my_name);
198 fd = open(con_fname, O_CREAT|O_RDWR|O_BINARY, 0600);
200 Emsg2(M_ERROR_TERM, 0, "Could not open console message file %s: ERR=%s\n",
201 con_fname, strerror(errno));
203 if (lseek(fd, 0, SEEK_END) > 0) {
204 console_msg_pending = 1;
207 con_fd = fopen(con_fname, "a+");
209 Emsg2(M_ERROR, 0, "Could not open console message file %s: ERR=%s\n",
210 con_fname, strerror(errno));
215 * Called only during parsing of the config file.
217 * Add a message destination. I.e. associate a message type with
218 * a destination (code).
219 * Note, where in the case of dest_code FILE is a filename,
220 * but in the case of MAIL is a space separated list of
221 * email addresses, ...
223 void add_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where, char *mail_cmd)
227 * First search the existing chain and see if we
228 * can simply add this msg_type to an existing entry.
230 for (d=msg->dest_chain; d; d=d->next) {
231 if (dest_code == d->dest_code && ((where == NULL && d->where == NULL) ||
232 (strcmp(where, d->where) == 0))) {
233 Dmsg4(200, "Add to existing d=%x msgtype=%d destcode=%d where=%s\n",
234 d, msg_type, dest_code, NPRT(where));
235 set_bit(msg_type, d->msg_types);
236 set_bit(msg_type, msg->send_msg); /* set msg_type bit in our local */
240 /* Not found, create a new entry */
241 d = (DEST *)malloc(sizeof(DEST));
242 memset(d, 0, sizeof(DEST));
243 d->next = msg->dest_chain;
244 d->dest_code = dest_code;
245 set_bit(msg_type, d->msg_types); /* set type bit in structure */
246 set_bit(msg_type, msg->send_msg); /* set type bit in our local */
248 d->where = bstrdup(where);
251 d->mail_cmd = bstrdup(mail_cmd);
253 Dmsg5(200, "add new d=%x msgtype=%d destcode=%d where=%s mailcmd=%s\n",
254 d, msg_type, dest_code, NPRT(where), NPRT(d->mail_cmd));
259 * Called only during parsing of the config file.
261 * Remove a message destination
263 void rem_msg_dest(MSGS *msg, int dest_code, int msg_type, char *where)
267 for (d=msg->dest_chain; d; d=d->next) {
268 Dmsg2(200, "Remove_msg_dest d=%x where=%s\n", d, NPRT(d->where));
269 if (bit_is_set(msg_type, d->msg_types) && (dest_code == d->dest_code) &&
270 ((where == NULL && d->where == NULL) ||
271 (strcmp(where, d->where) == 0))) {
272 Dmsg3(200, "Found for remove d=%x msgtype=%d destcode=%d\n",
273 d, msg_type, dest_code);
274 clear_bit(msg_type, d->msg_types);
275 Dmsg0(200, "Return rem_msg_dest\n");
285 * Edit job codes into main command line
288 * %t = Job type (Backup, ...)
294 * %d = Director's name
296 * omsg = edited output message
297 * imsg = input string containing edit codes (%x)
298 * to = recepients list
301 static char *edit_job_codes(JCR *jcr, char *omsg, char *imsg, char *to)
306 Dmsg1(200, "edit_job_codes: %s\n", imsg);
309 for (p=imsg; *p; p++) {
318 str = jcr->client_name;
324 str = my_name; /* Director's name */
327 str = job_status_to_str(jcr->JobStatus);
330 sprintf(add, "%d", jcr->JobId);
333 case 'j': /* Job name */
337 str = job_level_to_str(jcr->JobLevel);
343 str = job_type_to_str(jcr->JobType);
356 Dmsg1(200, "add_str %s\n", str);
357 add_str_to_pool_mem(&omsg, &o, str);
359 Dmsg1(200, "omsg=%s\n", omsg);
365 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
367 Mmsg(name, "%s/%s.spool.%s.%d", working_directory, my_name,
371 int open_spool_file(void *vjcr, BSOCK *bs)
373 POOLMEM *name = get_pool_memory(PM_MESSAGE);
374 JCR *jcr = (JCR *)vjcr;
376 make_unique_spool_filename(jcr, &name, bs->fd);
377 bs->spool_fd = fopen(name, "w+");
379 Jmsg(jcr, M_ERROR, 0, "fopen spool file %s failed: ERR=%s\n", name, strerror(errno));
380 free_pool_memory(name);
383 free_pool_memory(name);
387 int close_spool_file(void *vjcr, BSOCK *bs)
389 POOLMEM *name = get_pool_memory(PM_MESSAGE);
390 JCR *jcr = (JCR *)vjcr;
392 make_unique_spool_filename(jcr, &name, bs->fd);
393 fclose(bs->spool_fd);
395 free_pool_memory(name);
403 * Create a unique filename for the mail command
405 static void make_unique_mail_filename(JCR *jcr, POOLMEM **name, DEST *d)
408 Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
411 Mmsg(name, "%s/%s.mail.%s.%d", working_directory, my_name,
414 Dmsg1(200, "mailname=%s\n", *name);
420 static FILE *open_mail_pipe(JCR *jcr, char **cmd, DEST *d)
424 if (d->mail_cmd && jcr) {
425 *cmd = edit_job_codes(jcr, *cmd, d->mail_cmd, d->where);
427 Mmsg(cmd, "mail -s \"Bacula Message\" %s", d->where);
429 Dmsg1(200, "mailcmd=%s\n", cmd);
430 pfd = popen(*cmd, "w");
432 Jmsg(jcr, M_ERROR, 0, "mail popen %s failed: ERR=%s\n", cmd, strerror(errno));
438 * Close the messages for this Messages resource, which means to close
439 * any open files, and dispatch any pending email messages.
441 void close_msg(void *vjcr)
444 JCR *jcr = (JCR *)vjcr;
450 Dmsg1(050, "Close_msg jcr=0x%x\n", jcr);
452 if (jcr == NULL) { /* NULL -> global chain */
462 Dmsg1(050, "close msg resource at 0x%x\n", msgs);
463 cmd = get_pool_memory(PM_MESSAGE);
464 for (d=msgs->dest_chain; d; ) {
466 switch (d->dest_code) {
470 fclose(d->fd); /* close open file descriptor */
474 case MD_MAIL_ON_ERROR:
478 if (d->dest_code == MD_MAIL_ON_ERROR && jcr &&
479 jcr->JobStatus == JS_Terminated) {
483 pfd = open_mail_pipe(jcr, &cmd, d);
488 line = get_memory(len);
490 while (fgets(line, len, d->fd)) {
493 stat = pclose(pfd); /* close pipe, sending mail */
495 * Since we are closing all messages, before "recursing"
496 * make sure we are not closing the daemon messages, otherwise
499 if (stat < 0 && msgs != daemon_msgs) {
500 Emsg0(M_ERROR, 0, _("Mail program terminated in error.\n"));
504 /* Remove temp file */
506 unlink(d->mail_filename);
507 free_pool_memory(d->mail_filename);
508 d->mail_filename = NULL;
515 d = d->next; /* point to next buffer */
517 free_pool_memory(cmd);
524 * Free memory associated with Messages resource
526 void free_msgs_res(MSGS *msgs)
530 for (d=msgs->dest_chain; d; ) {
537 old = d; /* save pointer to release */
538 d = d->next; /* point to next buffer */
539 free(old); /* free the destination item */
541 msgs->dest_chain = NULL;
547 * Terminate the message handler for good.
548 * Release the global destination chain.
550 * Also, clean up a few other items (cons, exepath). Note,
551 * these really should be done elsewhere.
555 Dmsg0(100, "Enter term_msg\n");
556 close_msg(NULL); /* close global chain */
576 * Handle sending the message to the appropriate place
578 void dispatch_message(void *vjcr, int type, int level, char *msg)
583 JCR *jcr = (JCR *) vjcr;
587 Dmsg2(200, "Enter dispatch_msg type=%d msg=%s\n", type, msg);
589 if (type == M_ABORT || type == M_ERROR_TERM) {
590 fprintf(stdout, msg); /* print this here to INSURE that it is printed */
593 /* Now figure out where to send the message */
601 for (d=msgs->dest_chain; d; d=d->next) {
602 if (bit_is_set(type, d->msg_types)) {
603 switch (d->dest_code) {
605 Dmsg1(200, "CONSOLE for following err: %s\n", msg);
607 con_fd = fopen(con_fname, "a+");
608 Dmsg0(200, "Console file not open.\n");
613 bstrftime(cmd, sizeof(cmd), time(NULL));
616 fwrite(cmd, len, 1, con_fd);
618 if (len > 0 && msg[len-1] != '\n') {
622 fwrite(msg, len, 1, con_fd);
624 console_msg_pending = TRUE;
629 Dmsg1(200, "SYSLOG for following err: %s\n", msg);
630 /* We really should do an openlog() here */
631 syslog(LOG_DAEMON|LOG_ERR, msg);
634 Dmsg1(200, "OPERATOR for following err: %s\n", msg);
635 mcmd = get_pool_memory(PM_MESSAGE);
636 d->fd = open_mail_pipe(jcr, &mcmd, d);
637 free_pool_memory(mcmd);
641 /* Messages to the operator go one at a time */
642 stat = pclose(d->fd);
645 Emsg0(M_ERROR, 0, _("Operator mail program terminated in error.\n"));
650 case MD_MAIL_ON_ERROR:
651 Dmsg1(200, "MAIL for following err: %s\n", msg);
653 POOLMEM *name = get_pool_memory(PM_MESSAGE);
654 make_unique_mail_filename(jcr, &name, d);
655 d->fd = fopen(name, "w+");
658 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", name, strerror(errno));
660 free_pool_memory(name);
663 d->mail_filename = name;
666 if (len > d->max_len) {
667 d->max_len = len; /* keep max line length */
672 Dmsg1(200, "FILE for following err: %s\n", msg);
674 d->fd = fopen(d->where, "w+");
677 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
685 Dmsg1(200, "APPEND for following err: %s\n", msg);
687 d->fd = fopen(d->where, "a");
690 Emsg2(M_ERROR, 0, "fopen %s failed: ERR=%s\n", d->where, strerror(errno));
698 Dmsg1(200, "DIRECTOR for following err: %s\n", msg);
699 if (jcr && jcr->dir_bsock && !jcr->dir_bsock->errors) {
701 jcr->dir_bsock->msglen = Mmsg(&(jcr->dir_bsock->msg),
702 "Jmsg Job=%s type=%d level=%d %s", jcr->Job,
703 type, level, msg) + 1;
704 bnet_send(jcr->dir_bsock);
708 Dmsg1(200, "STDOUT for following err: %s\n", msg);
709 if (type != M_ABORT && type != M_ERROR_TERM) /* already printed */
710 fprintf(stdout, msg);
713 Dmsg1(200, "STDERR for following err: %s\n", msg);
714 fprintf(stderr, msg);
724 /*********************************************************************
726 * subroutine prints a debug message if the level number
727 * is less than or equal the debug_level. File and line numbers
728 * are included for more detail if desired, but not currently
731 * If the level is negative, the details of file and line number
735 d_msg(char *file, int line, int level, char *fmt,...)
747 if (level <= debug_level) {
750 sprintf(buf, "%s: %s:%d ", my_name, file, line);
758 va_start(arg_ptr, fmt);
759 bvsnprintf(buf+i, sizeof(buf)-i, (char *)fmt, arg_ptr);
762 fprintf(stdout, buf);
767 /* *********************************************************
769 * print an error message
773 e_msg(char *file, int line, int type, int level, char *fmt,...)
780 * Check if we have a message destination defined.
781 * We always report M_ABORT and M_ERROR_TERM
783 if (!daemon_msgs || ((type != M_ABORT && type != M_ERROR_TERM) &&
784 !bit_is_set(type, daemon_msgs->send_msg)))
785 return; /* no destination */
788 sprintf(buf, "%s ABORTING due to ERROR in %s:%d\n",
789 my_name, file, line);
792 sprintf(buf, "%s ERROR TERMINATING at %s:%d\n",
793 my_name, file, line);
796 if (level == -1) /* skip details */
797 sprintf(buf, "%s: Fatal Error because: ", my_name);
799 sprintf(buf, "%s: Fatal Error at %s:%d because:\n", my_name, file, line);
802 if (level == -1) /* skip details */
803 sprintf(buf, "%s: Error: ", my_name);
805 sprintf(buf, "%s: Error in %s:%d ", my_name, file, line);
808 sprintf(buf, "%s: Warning: ", my_name);
811 sprintf(buf, "%s: ", my_name);
816 va_start(arg_ptr, fmt);
817 bvsnprintf(buf+i, sizeof(buf)-i, (char *)fmt, arg_ptr);
820 dispatch_message(NULL, type, level, buf);
822 if (type == M_ABORT) {
824 p[0] = 0; /* generate segmentation violation */
826 if (type == M_ERROR_TERM) {
831 /* *********************************************************
833 * Generate a Job message
837 Jmsg(void *vjcr, int type, int level, char *fmt,...)
843 JCR *jcr = (JCR *)vjcr;
848 Dmsg1(200, "Enter Jmsg type=%d\n", type);
863 buf = rbuf; /* we are the Director */
865 * Check if we have a message destination defined.
866 * We always report M_ABORT and M_ERROR_TERM
868 if ((type != M_ABORT && type != M_ERROR_TERM) && msgs && !bit_is_set(type, msgs->send_msg)) {
869 Dmsg1(200, "No bit set for type %d\n", type);
870 return; /* no destination */
874 sprintf(buf, "%s ABORTING due to ERROR\n", my_name);
877 sprintf(buf, "%s ERROR TERMINATING\n", my_name);
880 sprintf(buf, "%s: Job %s Fatal error: ", my_name, job);
882 jcr->JobStatus = JS_FatalError;
886 sprintf(buf, "%s: Job %s Error: ", my_name, job);
892 sprintf(buf, "%s: Job %s Warning: ", my_name, job);
895 sprintf(buf, "%s: ", my_name);
900 va_start(arg_ptr, fmt);
901 len = bvsnprintf(buf+i, sizeof(rbuf)-i, fmt, arg_ptr);
904 dispatch_message(jcr, type, level, rbuf);
906 Dmsg3(500, "i=%d sizeof(rbuf)-i=%d len=%d\n", i, sizeof(rbuf)-i, len);
908 if (type == M_ABORT){
910 p[0] = 0; /* generate segmentation violation */
912 if (type == M_ERROR_TERM) {
918 * Edit a message into a Pool memory buffer, with file:lineno
920 int m_msg(char *file, int line, POOLMEM **pool_buf, char *fmt, ...)
925 sprintf(*pool_buf, "%s:%d ", file, line);
926 i = strlen(*pool_buf);
929 maxlen = sizeof_pool_memory(*pool_buf) - i - 1;
930 va_start(arg_ptr, fmt);
931 len = bvsnprintf(*pool_buf+i, maxlen, fmt, arg_ptr);
933 if (len < 0 || len >= maxlen) {
934 *pool_buf = realloc_pool_memory(*pool_buf, maxlen + i + 200);
941 * Edit a message into a Pool Memory buffer NO file:lineno
942 * Returns: string length of what was edited.
944 int Mmsg(POOLMEM **pool_buf, char *fmt, ...)
950 maxlen = sizeof_pool_memory(*pool_buf) - 1;
951 va_start(arg_ptr, fmt);
952 len = bvsnprintf(*pool_buf, maxlen, fmt, arg_ptr);
954 if (len < 0 || len >= maxlen) {
955 *pool_buf = realloc_pool_memory(*pool_buf, maxlen + 200);
963 * If we come here, prefix the message with the file:line-number,
964 * then pass it on to the normal Jmsg routine.
966 void j_msg(char *file, int line, void *jcr, int type, int level, char *fmt,...)
972 pool_buf = get_pool_memory(PM_EMSG);
973 sprintf(pool_buf, "%s:%d ", file, line);
974 i = strlen(pool_buf);
977 maxlen = sizeof_pool_memory(pool_buf) - i - 1;
978 va_start(arg_ptr, fmt);
979 len = bvsnprintf(pool_buf+i, maxlen, fmt, arg_ptr);
981 if (len < 0 || len >= maxlen) {
982 pool_buf = realloc_pool_memory(pool_buf, maxlen + i + 200);
986 Jmsg(jcr, type, level, pool_buf);
987 free_memory(pool_buf);