-
Notifications
You must be signed in to change notification settings - Fork 256
/
message.cc
1653 lines (1451 loc) · 43.1 KB
/
message.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2000-2012 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2022 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/*
* BAREOS message handling routines
*
* NOTE: don't use any Jmsg or Qmsg calls within this file,
* except in q_msg or j_msg (setup routines),
* otherwise you may get into recursive calls if there are
* errors, and that can lead to looping or deadlocks.
*
* Kern Sibbald, April 2000
*/
#include <vector>
#include "include/bareos.h"
#include "include/jcr.h"
#include "lib/berrno.h"
#include "lib/bsock.h"
#include "lib/util.h"
#include "lib/watchdog.h"
#include "lib/recent_job_results_list.h"
#include "lib/messages_resource.h"
#include "lib/message_destination_info.h"
#include "lib/message_queue_item.h"
#include "lib/thread_specific_data.h"
// globals
const char* working_directory = NULL; /* working directory path stored here */
int verbose = 0; /* increase User messages */
int debug_level = 0; /* debug level */
bool dbg_timestamp = false; /* print timestamp in debug output */
bool prt_kaboom = false; /* Print kaboom output */
utime_t daemon_start_time = 0; /* Daemon start time */
char my_name[128] = {0}; /* daemon name is stored here */
char host_name[256] = {0}; /* host machine name */
char* exepath = (char*)NULL;
char* exename = (char*)NULL;
int console_msg_pending = false;
char con_fname[500]; /* Console filename */
FILE* con_fd = NULL; /* Console file descriptor */
brwlock_t con_lock; /* Console lock structure */
job_code_callback_t message_job_code_callback = NULL; // Only used by director
/* Exclude spaces but require .mail at end */
#define MAIL_REGEX "^[^ ]+\\.mail$"
static MessagesResource* daemon_msgs; /* Global messages */
static char* catalog_db = NULL; /* Database type */
static const char* log_timestamp_format = "%d-%b %H:%M";
static void (*message_callback)(int type, const char* msg) = NULL;
static FILE* trace_fd = NULL;
#if defined(HAVE_WIN32)
static bool trace = true;
#else
static bool trace = false;
#endif
static bool hangup = false;
static int MessageTypeToLogPriority(int message_type);
/*
* Walk back in a string from end looking for a
* path separator.
*
* This routine is passed the start of the string and
* the end of the string, it returns either the beginning
* of the string or where it found a path separator.
*/
static const char* bstrrpath(const char* start, const char* end)
{
while (end > start) {
end--;
if (IsPathSeparator(*end)) { break; }
}
return end;
}
static void DeliveryError(const char* fmt, ...)
{
va_list ap;
int i, len, maxlen;
POOLMEM* pool_buf;
char dt[MAX_TIME_LENGTH];
pool_buf = GetPoolMemory(PM_EMSG);
bstrftime(dt, sizeof(dt), time(NULL), log_timestamp_format);
bstrncat(dt, " ", sizeof(dt));
i = Mmsg(pool_buf, "%s Message delivery ERROR: ", dt);
while (1) {
maxlen = SizeofPoolMemory(pool_buf) - i - 1;
va_start(ap, fmt);
len = Bvsnprintf(pool_buf + i, maxlen, fmt, ap);
va_end(ap);
if (len < 0 || len >= (maxlen - 5)) {
pool_buf = ReallocPoolMemory(pool_buf, maxlen + i + maxlen / 2);
continue;
}
break;
}
fputs(pool_buf, stdout); /* print this here to INSURE that it is printed */
fflush(stdout);
syslog(LOG_DAEMON | LOG_ERR, "%s", pool_buf);
FreeMemory(pool_buf);
}
void RegisterMessageCallback(void msg_callback(int type, const char* msg))
{
message_callback = msg_callback;
}
/*
* Set daemon name. Also, find canonical execution
* path. Note, exepath has spare room for tacking on
* the exename so that we can reconstruct the full name.
*
* Note, this routine can get called multiple times
* The second time is to put the name as found in the
* Resource record. On the second call, generally,
* argv is NULL to avoid doing the path code twice.
*/
void MyNameIs(int argc, char* argv[], const char* name)
{
char *l, *p, *q;
char cpath[1024];
int len;
if (gethostname(host_name, sizeof(host_name)) != 0) {
bstrncpy(host_name, "Hostname unknown", sizeof(host_name));
}
bstrncpy(my_name, name, sizeof(my_name));
if (argc > 0 && argv && argv[0]) {
// Strip trailing filename and save exepath
for (l = p = argv[0]; *p; p++) {
if (IsPathSeparator(*p)) { l = p; /* set pos of last slash */ }
}
if (IsPathSeparator(*l)) {
l++;
} else {
l = argv[0];
#if defined(HAVE_WIN32)
// On Windows allow c: drive specification
if (l[1] == ':') { l += 2; }
#endif
}
len = strlen(l) + 1;
if (exename) { free(exename); }
exename = (char*)malloc(len);
strcpy(exename, l);
if (exepath) { free(exepath); }
exepath = (char*)malloc(strlen(argv[0]) + 1 + len);
for (p = argv[0], q = exepath; p < l;) { *q++ = *p++; }
*q = 0;
if (strchr(exepath, '.') || !IsPathSeparator(exepath[0])) {
if (getcwd(cpath, sizeof(cpath))) {
free(exepath);
exepath = (char*)malloc(strlen(cpath) + 1 + len);
strcpy(exepath, cpath);
}
}
Dmsg2(500, "exepath=%s\nexename=%s\n", exepath, exename);
}
}
void SetDbType(const char* name)
{
if (catalog_db != NULL) { free(catalog_db); }
catalog_db = strdup(name);
}
/*
* Initialize message handler for a daemon or a Job
* We make a copy of the MessagesResource resource passed, so it belongs
* to the job or daemon and thus can be modified.
*
* NULL for jcr -> initialize global messages for daemon
* non-NULL -> initialize jcr using Message resource
*/
void InitMsg(JobControlRecord* jcr,
MessagesResource* msg,
job_code_callback_t job_code_callback)
{
int i;
if (jcr == NULL && msg == NULL) {
/*
* Setup a daemon key then set invalid jcr
* Maybe we should give the daemon a jcr???
*/
SetJcrInThreadSpecificData(nullptr);
}
message_job_code_callback = job_code_callback;
if (!msg) {
// initialize default chain for stdout and syslog
daemon_msgs = new MessagesResource;
for (i = 1; i <= M_MAX; i++) {
daemon_msgs->AddMessageDestination(MessageDestinationCode::kStdout, i,
std::string(), std::string(),
std::string());
}
Dmsg1(050, "Create daemon global message resource %p\n", daemon_msgs);
return;
}
if (jcr) {
jcr->jcr_msgs = new MessagesResource;
msg->DuplicateResourceTo(*jcr->jcr_msgs);
} else {
// replace the defaults
if (daemon_msgs) { delete daemon_msgs; }
daemon_msgs = new MessagesResource;
msg->DuplicateResourceTo(*daemon_msgs);
}
Dmsg2(250, "Copied message resource %p\n", msg);
}
/*
* Initialize so that the console (User Agent) can receive messages -- stored in
* a file.
*/
void InitConsoleMsg(const char* wd)
{
int fd;
Bsnprintf(con_fname, sizeof(con_fname), "%s%c%s.conmsg", wd, PathSeparator,
my_name);
fd = open(con_fname, O_CREAT | O_RDWR | O_BINARY, 0600);
if (fd == -1) {
BErrNo be;
Emsg2(M_ERROR_TERM, 0,
_("Could not open console message file %s: ERR=%s\n"), con_fname,
be.bstrerror());
}
if (lseek(fd, 0, SEEK_END) > 0) { console_msg_pending = 1; }
close(fd);
con_fd = fopen(con_fname, "a+b");
if (!con_fd) {
BErrNo be;
Emsg2(M_ERROR, 0, _("Could not open console message file %s: ERR=%s\n"),
con_fname, be.bstrerror());
}
if (RwlInit(&con_lock) != 0) {
BErrNo be;
Emsg1(M_ERROR_TERM, 0, _("Could not get con mutex: ERR=%s\n"),
be.bstrerror());
}
}
static void MakeUniqueMailFilename(JobControlRecord* jcr,
POOLMEM*& name,
MessageDestinationInfo* d)
{
if (jcr) {
Mmsg(name, "%s/%s.%s.%d.mail", working_directory, my_name, jcr->Job,
(int)(intptr_t)d);
} else {
Mmsg(name, "%s/%s.%s.%d.mail", working_directory, my_name, my_name,
(int)(intptr_t)d);
}
Dmsg1(850, "mailname=%s\n", name);
}
static Bpipe* open_mail_pipe(JobControlRecord* jcr,
POOLMEM*& cmd,
MessageDestinationInfo* d)
{
Bpipe* bpipe;
if (!d->mail_cmd_.empty()) {
cmd = edit_job_codes(jcr, cmd, d->mail_cmd_.c_str(), d->where_.c_str(),
message_job_code_callback);
} else {
Mmsg(cmd, "/usr/lib/sendmail -F BAREOS %s", d->where_.c_str());
}
if ((bpipe = OpenBpipe(cmd, 120, "rw"))) {
// If we had to use sendmail, add subject
if (d->mail_cmd_.empty()) {
fprintf(bpipe->wfd, "Subject: %s\r\n\r\n", _("BAREOS Message"));
}
} else {
BErrNo be;
DeliveryError(_("open mail pipe %s failed: ERR=%s\n"), cmd, be.bstrerror());
}
return bpipe;
}
/*
* Close the messages for this Messages resource, which means to close
* any open files, and dispatch any pending email messages.
*/
void CloseMsg(JobControlRecord* jcr)
{
MessagesResource* msgs;
Bpipe* bpipe;
POOLMEM *cmd, *line;
int len, status;
Dmsg1(580, "Close_msg jcr=%p\n", jcr);
if (jcr == NULL) { /* NULL -> global chain */
msgs = daemon_msgs;
} else {
msgs = jcr->jcr_msgs;
jcr->jcr_msgs = NULL;
}
if (msgs == NULL) { return; }
// Wait for item to be not in use, then mark closing
if (msgs->IsClosing()) { return; }
msgs->WaitNotInUse(); /* leaves fides_mutex set */
// Note GetClosing() does not lock because we are already locked
if (msgs->GetClosing()) {
msgs->Unlock();
return;
}
msgs->SetClosing();
msgs->Unlock();
Dmsg1(850, "===Begin close msg resource at %p\n", msgs);
cmd = GetPoolMemory(PM_MESSAGE);
for (MessageDestinationInfo* d : msgs->dest_chain_) {
if (d->file_pointer_) {
switch (d->dest_code_) {
case MessageDestinationCode::kFile:
case MessageDestinationCode::kAppend:
if (d->file_pointer_) {
fclose(d->file_pointer_); /* close open file descriptor */
d->file_pointer_ = NULL;
}
break;
case MessageDestinationCode::kMail:
case MessageDestinationCode::KMailOnError:
case MessageDestinationCode::kMailOnSuccess:
Dmsg0(850, "Got kMail, KMailOnError or kMailOnSuccess\n");
if (!d->file_pointer_) { break; }
switch (d->dest_code_) {
case MessageDestinationCode::KMailOnError:
if (jcr) {
switch (jcr->JobStatus) {
case JS_Terminated:
case JS_Warnings:
goto rem_temp_file;
default:
break;
}
}
break;
case MessageDestinationCode::kMailOnSuccess:
if (jcr) {
switch (jcr->JobStatus) {
case JS_Terminated:
case JS_Warnings:
break;
default:
goto rem_temp_file;
}
}
break;
default:
break;
}
if (!(bpipe = open_mail_pipe(jcr, cmd, d))) {
Pmsg0(000, _("open mail pipe failed.\n"));
goto rem_temp_file;
}
Dmsg0(850, "Opened mail pipe\n");
len = d->max_len_ + 10;
line = GetMemory(len);
rewind(d->file_pointer_);
while (fgets(line, len, d->file_pointer_)) {
fputs(line, bpipe->wfd);
}
if (!CloseWpipe(bpipe)) { /* close write pipe sending mail */
BErrNo be;
Pmsg1(000, _("close error: ERR=%s\n"), be.bstrerror());
}
/*
* Since we are closing all messages, before "recursing"
* make sure we are not closing the daemon messages, otherwise
* kaboom.
*/
if (msgs != daemon_msgs) {
// Read what mail prog returned -- should be nothing
while (fgets(line, len, bpipe->rfd)) {
DeliveryError(_("Mail prog: %s"), line);
}
}
status = CloseBpipe(bpipe);
if (status != 0 && msgs != daemon_msgs) {
BErrNo be;
be.SetErrno(status);
Dmsg1(850, "Calling emsg. CMD=%s\n", cmd);
DeliveryError(_("Mail program terminated in error.\n"
"CMD=%s\n"
"ERR=%s\n"),
cmd, be.bstrerror());
}
FreeMemory(line);
rem_temp_file:
// Remove temp file
if (d->file_pointer_) {
fclose(d->file_pointer_);
d->file_pointer_ = NULL;
}
if (!d->mail_filename_.empty()) {
// Exclude spaces in mail_filename
SaferUnlink(d->mail_filename_.c_str(), MAIL_REGEX);
d->mail_filename_.clear();
}
Dmsg0(850, "end mail or mail on error\n");
break;
default:
break;
}
d->file_pointer_ = NULL;
}
}
FreePoolMemory(cmd);
Dmsg0(850, "Done walking message chain.\n");
if (jcr) {
delete msgs;
msgs = NULL;
} else {
msgs->ClearClosing();
}
Dmsg0(850, "===End close msg resource\n");
}
/*
* Terminate the message handler for good.
* Release the global destination chain.
*
* Also, clean up a few other items (cons, exepath). Note,
* these really should be done elsewhere.
*/
void TermMsg()
{
Dmsg0(850, "Enter TermMsg\n");
CloseMsg(NULL); /* close global chain */
delete daemon_msgs; /* f ree the resources */
daemon_msgs = NULL;
if (con_fd) {
fflush(con_fd);
fclose(con_fd);
con_fd = NULL;
}
if (exepath) {
free(exepath);
exepath = NULL;
}
if (exename) {
free(exename);
exename = NULL;
}
if (trace_fd) {
fclose(trace_fd);
trace_fd = NULL;
}
if (catalog_db) {
free(catalog_db);
catalog_db = NULL;
}
RecentJobResultsList::Cleanup();
CleanupJcrChain();
}
static inline bool OpenDestFile(MessageDestinationInfo* d, const char* mode)
{
d->file_pointer_ = fopen(d->where_.c_str(), mode);
if (!d->file_pointer_) {
BErrNo be;
DeliveryError(_("fopen %s failed: ERR=%s\n"), d->where_.c_str(),
be.bstrerror());
return false;
}
return true;
}
static struct syslog_facility_name {
const char* name;
int facility;
} syslog_facility_names[] = {
{"kern", LOG_KERN}, {"user", LOG_USER}, {"mail", LOG_MAIL},
{"daemon", LOG_DAEMON}, {"auth", LOG_AUTH}, {"syslog", LOG_SYSLOG},
{"lpr", LOG_LPR}, {"news", LOG_NEWS}, {"uucp", LOG_UUCP},
#ifdef LOG_CRON
{"cron", LOG_CRON},
#endif
#ifdef LOG_AUTHPRIV
{"authpriv", LOG_AUTHPRIV},
#endif
#ifdef LOG_FTP
{"ftp", LOG_FTP},
#endif
#ifdef LOG_NTP
{"ntp", LOG_NTP},
#endif
#ifdef LOG_AUDIT
{"audit", LOG_AUDIT},
#endif
#ifdef LOG_SECURITY
{"security", LOG_SECURITY},
#endif
#ifdef LOG_CONSOLE
{"console", LOG_CONSOLE},
#endif
{"local0", LOG_LOCAL0}, {"local1", LOG_LOCAL1}, {"local2", LOG_LOCAL2},
{"local3", LOG_LOCAL3}, {"local4", LOG_LOCAL4}, {"local5", LOG_LOCAL5},
{"local6", LOG_LOCAL6}, {"local7", LOG_LOCAL7}, {NULL, -1}};
static inline bool SetSyslogFacility(JobControlRecord* jcr,
MessageDestinationInfo* d)
{
int i;
if (!d->where_.empty()) {
for (i = 0; syslog_facility_names[i].name; i++) {
if (Bstrcasecmp(d->where_.c_str(), syslog_facility_names[i].name)) {
d->syslog_facility_ = syslog_facility_names[i].facility;
i = 0;
break;
}
}
// Make sure we got a match otherwise fallback to LOG_DAEMON
if (i != 0) { d->syslog_facility_ = LOG_DAEMON; }
} else {
d->syslog_facility_ = LOG_DAEMON;
}
return true;
}
/*
* Split the output for syslog (it converts \n to ' ' and is
* limited to 1024 characters per syslog message
*/
static void SendToSyslog_(int mode, const char* msg)
{
int len;
char buf[1024];
const char* p2;
const char* p = msg;
while (*p && ((p2 = strchr(p, '\n')) != NULL)) {
len = MIN((int)sizeof(buf) - 1, p2 - p + 1); /* Add 1 to keep \n */
strncpy(buf, p, len);
buf[len] = 0;
syslog(mode, "%s", buf);
p = p2 + 1; /* skip \n */
}
if (*p != 0) { /* no \n at the end ? */
syslog(mode, "%s", p);
}
}
static SyslogCallback SendToSyslog{SendToSyslog_};
void RegisterSyslogCallback(SyslogCallback c) { SendToSyslog = c; }
static DbLogInsertCallback SendToDbLog = NULL;
void SetDbLogInsertCallback(DbLogInsertCallback f) { SendToDbLog = f; }
// Handle sending the message to the appropriate place
void DispatchMessage(JobControlRecord* jcr,
int type,
utime_t mtime,
const char* msg)
{
char dt[MAX_TIME_LENGTH];
POOLMEM* mcmd;
int len, dtlen;
MessagesResource* msgs;
Bpipe* bpipe;
const char* mode;
bool dt_conversion = false;
Dmsg2(850, "Enter DispatchMessage type=%d msg=%s", type, msg);
/*
* Most messages are prefixed by a date and time. If mtime is
* zero, then we use the current time. If mtime is 1 (special
* kludge), we do not prefix the date and time. Otherwise,
* we assume mtime is a utime_t and use it.
*/
if (mtime == 0) { mtime = time(NULL); }
*dt = 0;
dtlen = 0;
if (mtime == 1) {
mtime = time(NULL); /* Get time for SQL log */
} else {
dt_conversion = true;
}
// If the program registered a callback, send it there
if (message_callback) {
message_callback(type, msg);
return;
}
// For serious errors make sure message is printed or logged
if (type == M_ABORT || type == M_ERROR_TERM) {
fputs(dt, stdout);
fputs(msg, stdout);
fflush(stdout);
if (type == M_ABORT) { syslog(LOG_DAEMON | LOG_ERR, "%s", msg); }
}
// Now figure out where to send the message
msgs = NULL;
if (!jcr) { jcr = GetJcrFromThreadSpecificData(); }
if (jcr) {
// See if we need to suppress the messages.
if (jcr->suppress_output) {
/*
* See if this JobControlRecord has a controlling JobControlRecord and if
* so redirect this message to the controlling JobControlRecord.
*/
if (jcr->cjcr) {
jcr = jcr->cjcr;
} else {
// Ignore this Job Message.
return;
}
}
msgs = jcr->jcr_msgs;
}
if (msgs == NULL) { msgs = daemon_msgs; }
if (!msgs) {
Dmsg1(100, "Could not dispatch message: %s", msg);
return;
}
// If closing this message resource, print and send to syslog, then get out.
if (msgs->IsClosing()) {
if (dt_conversion) {
bstrftime(dt, sizeof(dt), mtime, log_timestamp_format);
bstrncat(dt, " ", sizeof(dt));
}
fputs(dt, stdout);
fputs(msg, stdout);
fflush(stdout);
syslog(LOG_DAEMON | LOG_ERR, "%s", msg);
return;
}
for (MessageDestinationInfo* d : msgs->dest_chain_) {
if (BitIsSet(type, d->msg_types_)) {
/*
* See if a specific timestamp format was specified for this log resource.
* Otherwise apply the global setting in log_timestamp_format.
*/
if (dt_conversion) {
if (!d->timestamp_format_.empty()) {
bstrftime(dt, sizeof(dt), mtime, d->timestamp_format_.c_str());
} else {
bstrftime(dt, sizeof(dt), mtime, log_timestamp_format);
}
bstrncat(dt, " ", sizeof(dt));
dtlen = strlen(dt);
}
switch (d->dest_code_) {
case MessageDestinationCode::kCatalog:
if (!jcr || !jcr->db) { break; }
if (SendToDbLog) {
if (!SendToDbLog(jcr, mtime, msg)) {
DeliveryError(
_("Msg delivery error: Unable to store data in database.\n"));
}
}
break;
case MessageDestinationCode::kConsole:
Dmsg1(850, "CONSOLE for following msg: %s", msg);
if (!con_fd) {
con_fd = fopen(con_fname, "a+b");
Dmsg0(850, "Console file not open.\n");
}
if (con_fd) {
Pw(con_lock); /* get write lock on console message file */
errno = 0;
if (dtlen) { (void)fwrite(dt, dtlen, 1, con_fd); }
len = strlen(msg);
if (len > 0) {
(void)fwrite(msg, len, 1, con_fd);
if (msg[len - 1] != '\n') { (void)fwrite("\n", 2, 1, con_fd); }
} else {
(void)fwrite("\n", 2, 1, con_fd);
}
fflush(con_fd);
console_msg_pending = true;
Vw(con_lock);
}
break;
case MessageDestinationCode::kSyslog:
Dmsg1(850, "SYSLOG for following msg: %s\n", msg);
if (!d->syslog_facility_ && !SetSyslogFacility(jcr, d)) {
msgs->ClearInUse();
break;
}
/*
* Dispatch based on our internal message type to a matching syslog
* one.
*/
SendToSyslog(d->syslog_facility_ | MessageTypeToLogPriority(type),
msg);
break;
case MessageDestinationCode::kOperator:
Dmsg1(850, "OPERATOR for following msg: %s\n", msg);
mcmd = GetPoolMemory(PM_MESSAGE);
if ((bpipe = open_mail_pipe(jcr, mcmd, d))) {
int status;
fputs(dt, bpipe->wfd);
fputs(msg, bpipe->wfd);
// Messages to the operator go one at a time
status = CloseBpipe(bpipe);
if (status != 0) {
BErrNo be;
be.SetErrno(status);
DeliveryError(_("Msg delivery error: Operator mail program "
"terminated in error.\n"
"CMD=%s\nERR=%s\n"),
mcmd, be.bstrerror());
}
}
FreePoolMemory(mcmd);
break;
case MessageDestinationCode::kMail:
case MessageDestinationCode::KMailOnError:
case MessageDestinationCode::kMailOnSuccess:
Dmsg1(850, "MAIL for following msg: %s", msg);
if (msgs->IsClosing()) { break; }
msgs->SetInUse();
if (!d->file_pointer_) {
POOLMEM* name = GetPoolMemory(PM_MESSAGE);
MakeUniqueMailFilename(jcr, name, d);
d->file_pointer_ = fopen(name, "w+b");
if (!d->file_pointer_) {
BErrNo be;
DeliveryError(_("Msg delivery error: fopen %s failed: ERR=%s\n"),
name, be.bstrerror());
FreePoolMemory(name);
msgs->ClearInUse();
break;
}
d->mail_filename_ = name;
FreePoolMemory(name);
}
fputs(dt, d->file_pointer_);
len = strlen(msg) + dtlen;
if (len > d->max_len_) {
d->max_len_ = len; /* keep max line length */
}
fputs(msg, d->file_pointer_);
msgs->ClearInUse();
break;
case MessageDestinationCode::kAppend:
Dmsg1(850, "APPEND for following msg: %s", msg);
mode = "ab";
goto send_to_file;
case MessageDestinationCode::kFile:
Dmsg1(850, "FILE for following msg: %s", msg);
mode = "w+b";
send_to_file:
if (msgs->IsClosing()) { break; }
msgs->SetInUse();
if (!d->file_pointer_ && !OpenDestFile(d, mode)) {
msgs->ClearInUse();
break;
}
fputs(dt, d->file_pointer_);
fputs(msg, d->file_pointer_);
// On error, we close and reopen to handle log rotation
if (ferror(d->file_pointer_)) {
fclose(d->file_pointer_);
d->file_pointer_ = NULL;
if (OpenDestFile(d, mode)) {
fputs(dt, d->file_pointer_);
fputs(msg, d->file_pointer_);
}
}
fflush(d->file_pointer_);
msgs->ClearInUse();
break;
case MessageDestinationCode::kDirector:
Dmsg1(850, "DIRECTOR for following msg: %s", msg);
if (jcr && jcr->dir_bsock && !jcr->dir_bsock->errors) {
jcr->dir_bsock->fsend("Jmsg Job=%s type=%d level=%lld %s", jcr->Job,
type, mtime, msg);
} else {
Dmsg1(800, "no jcr for following msg: %s", msg);
}
break;
case MessageDestinationCode::kStdout:
Dmsg1(850, "STDOUT for following msg: %s", msg);
if (type != M_ABORT && type != M_ERROR_TERM) { /* already printed */
fputs(dt, stdout);
fputs(msg, stdout);
fflush(stdout);
}
break;
case MessageDestinationCode::kStderr:
Dmsg1(850, "STDERR for following msg: %s", msg);
fputs(dt, stderr);
fputs(msg, stderr);
fflush(stdout);
break;
default:
break;
}
}
}
}
/*
* This subroutine returns the filename portion of a path.
* It is used because some compilers set __FILE__
* to the full path. Try to return base + next higher path.
*/
const char* get_basename(const char* pathname)
{
const char* basename;
if ((basename = bstrrpath(pathname, pathname + strlen(pathname)))
== pathname) {
/* empty */
} else if ((basename = bstrrpath(pathname, basename - 1)) == pathname) {
/* empty */
} else {
basename++;
}
return basename;
}
// Print or write output to trace file
static void pt_out(char* buf)
{
/*
* Used the "trace on" command in the console to turn on
* output to the trace file. "trace off" will close the file.
*/
if (trace) {
if (!trace_fd) {
PoolMem fn(PM_FNAME);
Mmsg(fn, "%s/%s.trace", TRACEFILEDIRECTORY, my_name);
trace_fd = fopen(fn.c_str(), "a+b");
}
if (trace_fd) {
fputs(buf, trace_fd);
fflush(trace_fd);
return;
} else {
// Some problem, turn off tracing
trace = false;
}
}
// Not tracing
fputs(buf, stdout);
fflush(stdout);
}
/*
* This subroutine prints a debug message if the level number is less than or
* equal the debug_level. File and line numbers are included for more detail if
* desired, but not currently printed.
*
* If the level is negative, the details of file and line number are not
* printed.
*/
void d_msg(const char* file, int line, int level, const char* fmt, ...)
{
va_list ap;
char ed1[50];
int len, maxlen;
btime_t mtime;
uint32_t usecs;
bool details = true;
PoolMem buf(PM_EMSG), more(PM_EMSG);
if (level < 0) {
details = false;
level = -level;
}
if (level <= debug_level) {
if (dbg_timestamp) {
mtime = GetCurrentBtime();
usecs = mtime % 1000000;
Mmsg(buf, "%s.%06d ", bstrftimes(ed1, sizeof(ed1), BtimeToUtime(mtime)),
usecs);
pt_out(buf.c_str());
}
if (details) {
Mmsg(buf, "%s (%d): %s:%d-%u ", my_name, level, get_basename(file), line,
GetJobIdFromThreadSpecificData());
}
while (1) {
maxlen = more.MaxSize() - 1;
va_start(ap, fmt);
len = Bvsnprintf(more.c_str(), maxlen, fmt, ap);
va_end(ap);
if (len < 0 || len >= (maxlen - 5)) {
more.ReallocPm(maxlen + maxlen / 2);
continue;
}
break;
}
if (details) { pt_out(buf.c_str()); }
pt_out(more.c_str());
}
}
// Set trace flag on/off. If argument is negative, there is no change
void SetTrace(int trace_flag)
{
if (trace_flag < 0) {
return;
} else if (trace_flag > 0) {
trace = true;
} else {
trace = false;
}
if (!trace && trace_fd) {
FILE* ltrace_fd = trace_fd;
trace_fd = NULL;
Bmicrosleep(0, 100000); /* yield to prevent seg faults */
fclose(ltrace_fd);
}
}
void SetHangup(int hangup_value)
{
if (hangup_value < 0) {
return;
} else {
hangup = hangup_value;
}
}
void SetTimestamp(int timestamp_flag)
{
if (timestamp_flag < 0) {
return;
} else if (timestamp_flag > 0) {
dbg_timestamp = true;
} else {