Add retry type "lookup". Bug 1566
[exim.git] / src / src / log.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5a66c31b 5/* Copyright (c) University of Cambridge 1995 - 2014 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* Functions for writing log files. The code for maintaining datestamped
9log files was originally contributed by Tony Sheen. */
10
11
12#include "exim.h"
13
14#define LOG_NAME_SIZE 256
15#define MAX_SYSLOG_LEN 870
16
17#define LOG_MODE_FILE 1
18#define LOG_MODE_SYSLOG 2
19
921b12ca 20enum { lt_main, lt_reject, lt_panic, lt_debug };
059ec3d9 21
921b12ca 22static uschar *log_names[] = { US"main", US"reject", US"panic", US"debug" };
059ec3d9
PH
23
24
25
26/*************************************************
27* Local static variables *
28*************************************************/
29
30static uschar mainlog_name[LOG_NAME_SIZE];
31static uschar rejectlog_name[LOG_NAME_SIZE];
ed7f7860 32static uschar debuglog_name[LOG_NAME_SIZE];
059ec3d9
PH
33
34static uschar *mainlog_datestamp = NULL;
35static uschar *rejectlog_datestamp = NULL;
36
37static int mainlogfd = -1;
38static int rejectlogfd = -1;
39static ino_t mainlog_inode = 0;
40static ino_t rejectlog_inode = 0;
41
42static uschar *panic_save_buffer = NULL;
43static BOOL panic_recurseflag = FALSE;
44
45static BOOL syslog_open = FALSE;
46static BOOL path_inspected = FALSE;
47static int logging_mode = LOG_MODE_FILE;
48static uschar *file_path = US"";
49
50
51
52
53/*************************************************
54* Write to syslog *
55*************************************************/
56
57/* The given string is split into sections according to length, or at embedded
58newlines, and syslogged as a numbered sequence if it is overlong or if there is
9675b384
PH
59more than one line. However, if we are running in the test harness, do not do
60anything. (The test harness doesn't use syslog - for obvious reasons - but we
61can get here if there is a failure to open the panic log.)
059ec3d9
PH
62
63Arguments:
64 priority syslog priority
65 s the string to be written
66
67Returns: nothing
68*/
69
70static void
71write_syslog(int priority, uschar *s)
72{
73int len, pass;
74int linecount = 0;
75
9675b384
PH
76if (running_in_test_harness) return;
77
059ec3d9
PH
78if (!syslog_timestamp) s += log_timezone? 26 : 20;
79
80len = Ustrlen(s);
81
82#ifndef NO_OPENLOG
83if (!syslog_open)
84 {
85 #ifdef SYSLOG_LOG_PID
86 openlog(CS syslog_processname, LOG_PID|LOG_CONS, syslog_facility);
87 #else
88 openlog(CS syslog_processname, LOG_CONS, syslog_facility);
89 #endif
90 syslog_open = TRUE;
91 }
92#endif
93
94/* First do a scan through the message in order to determine how many lines
95it is going to end up as. Then rescan to output it. */
96
97for (pass = 0; pass < 2; pass++)
98 {
99 int i;
100 int tlen;
101 uschar *ss = s;
102 for (i = 1, tlen = len; tlen > 0; i++)
103 {
104 int plen = tlen;
105 uschar *nlptr = Ustrchr(ss, '\n');
106 if (nlptr != NULL) plen = nlptr - ss;
107 #ifndef SYSLOG_LONG_LINES
108 if (plen > MAX_SYSLOG_LEN) plen = MAX_SYSLOG_LEN;
109 #endif
110 tlen -= plen;
111 if (ss[plen] == '\n') tlen--; /* chars left */
112
113 if (pass == 0) linecount++; else
114 {
115 if (linecount == 1)
116 syslog(priority, "%.*s", plen, ss);
117 else
118 syslog(priority, "[%d%c%d] %.*s", i,
119 (ss[plen] == '\n' && tlen != 0)? '\\' : '/',
120 linecount, plen, ss);
121 }
122 ss += plen;
123 if (*ss == '\n') ss++;
124 }
125 }
126}
127
128
129
130/*************************************************
131* Die tidily *
132*************************************************/
133
134/* This is called when Exim is dying as a result of something going wrong in
135the logging, or after a log call with LOG_PANIC_DIE set. Optionally write a
136message to debug_file or a stderr file, if they exist. Then, if in the middle
8f128379
PH
137of accepting a message, throw it away tidily by calling receive_bomb_out();
138this will attempt to send an SMTP response if appropriate. Passing NULL as the
139first argument stops it trying to run the NOTQUIT ACL (which might try further
140logging and thus cause problems). Otherwise, try to close down an outstanding
141SMTP call tidily.
059ec3d9
PH
142
143Arguments:
144 s1 Error message to write to debug_file and/or stderr and syslog
145 s2 Error message for any SMTP call that is in progress
146Returns: The function does not return
147*/
148
149static void
150die(uschar *s1, uschar *s2)
151{
152if (s1 != NULL)
153 {
154 write_syslog(LOG_CRIT, s1);
155 if (debug_file != NULL) debug_printf("%s\n", s1);
156 if (log_stderr != NULL && log_stderr != debug_file)
157 fprintf(log_stderr, "%s\n", s1);
158 }
8f128379 159if (receive_call_bombout) receive_bomb_out(NULL, s2); /* does not return */
059ec3d9
PH
160if (smtp_input) smtp_closedown(s2);
161exim_exit(EXIT_FAILURE);
162}
163
164
165
166/*************************************************
167* Create a log file *
168*************************************************/
169
170/* This function is called to create and open a log file. It may be called in a
171subprocess when the original process is root.
172
173Arguments:
174 name the file name
175
176The file name has been build in a working buffer, so it is permissible to
177overwrite it temporarily if it is necessary to create the directory.
178
179Returns: a file descriptor, or < 0 on failure (errno set)
180*/
181
4840604e 182int
921b12ca 183log_create(uschar *name)
059ec3d9
PH
184{
185int fd = Uopen(name, O_CREAT|O_APPEND|O_WRONLY, LOG_MODE);
186
187/* If creation failed, attempt to build a log directory in case that is the
188problem. */
189
190if (fd < 0 && errno == ENOENT)
191 {
192 BOOL created;
193 uschar *lastslash = Ustrrchr(name, '/');
194 *lastslash = 0;
195 created = directory_make(NULL, name, LOG_DIRECTORY_MODE, FALSE);
196 DEBUG(D_any) debug_printf("%s log directory %s\n",
197 created? "created" : "failed to create", name);
198 *lastslash = '/';
199 if (created) fd = Uopen(name, O_CREAT|O_APPEND|O_WRONLY, LOG_MODE);
200 }
201
202return fd;
203}
204
205
206
921b12ca
TF
207/*************************************************
208* Create a log file as the exim user *
209*************************************************/
210
211/* This function is called when we are root to spawn an exim:exim subprocess
212in which we can create a log file. It must be signal-safe since it is called
213by the usr1_handler().
214
215Arguments:
216 name the file name
217
218Returns: a file descriptor, or < 0 on failure (errno set)
219*/
220
221int
222log_create_as_exim(uschar *name)
223{
224pid_t pid = fork();
225int status = 1;
226int fd = -1;
227
228/* In the subprocess, change uid/gid and do the creation. Return 0 from the
229subprocess on success. If we don't check for setuid failures, then the file
230can be created as root, so vulnerabilities which cause setuid to fail mean
231that the Exim user can use symlinks to cause a file to be opened/created as
232root. We always open for append, so can't nuke existing content but it would
233still be Rather Bad. */
234
235if (pid == 0)
236 {
237 if (setgid(exim_gid) < 0)
238 die(US"exim: setgid for log-file creation failed, aborting",
239 US"Unexpected log failure, please try later");
240 if (setuid(exim_uid) < 0)
241 die(US"exim: setuid for log-file creation failed, aborting",
242 US"Unexpected log failure, please try later");
243 _exit((log_create(name) < 0)? 1 : 0);
244 }
245
246/* If we created a subprocess, wait for it. If it succeeded, try the open. */
247
248while (pid > 0 && waitpid(pid, &status, 0) != pid);
249if (status == 0) fd = Uopen(name, O_APPEND|O_WRONLY, LOG_MODE);
250
251/* If we failed to create a subprocess, we are in a bad way. We return
252with fd still < 0, and errno set, letting the caller handle the error. */
253
254return fd;
255}
256
257
258
059ec3d9
PH
259
260/*************************************************
261* Open a log file *
262*************************************************/
263
921b12ca
TF
264/* This function opens one of a number of logs, creating the log directory if
265it does not exist. This may be called recursively on failure, in order to open
266the panic log.
059ec3d9
PH
267
268The directory is in the static variable file_path. This is static so that it
269the work of sorting out the path is done just once per Exim process.
270
271Exim is normally configured to avoid running as root wherever possible, the log
272files must be owned by the non-privileged exim user. To ensure this, first try
273an open without O_CREAT - most of the time this will succeed. If it fails, try
274to create the file; if running as root, this must be done in a subprocess to
275avoid races.
276
277Arguments:
278 fd where to return the resulting file descriptor
921b12ca 279 type lt_main, lt_reject, lt_panic, or lt_debug
ed7f7860 280 tag optional tag to include in the name (only hooked up for debug)
059ec3d9
PH
281
282Returns: nothing
283*/
284
285static void
ed7f7860 286open_log(int *fd, int type, uschar *tag)
059ec3d9
PH
287{
288uid_t euid;
ed7f7860 289BOOL ok, ok2;
059ec3d9
PH
290uschar buffer[LOG_NAME_SIZE];
291
921b12ca
TF
292/* The names of the log files are controlled by file_path. The panic log is
293written to the same directory as the main and reject logs, but its name does
f1e5fef5
PP
294not have a datestamp. The use of datestamps is indicated by %D/%M in file_path.
295When opening the panic log, if %D or %M is present, we remove the datestamp
296from the generated name; if it is at the start, remove a following
297non-alphanumeric character as well; otherwise, remove a preceding
298non-alphanumeric character. This is definitely kludgy, but it sort of does what
299people want, I hope. */
059ec3d9 300
921b12ca
TF
301ok = string_format(buffer, sizeof(buffer), CS file_path, log_names[type]);
302
303/* Save the name of the mainlog for rollover processing. Without a datestamp,
304it gets statted to see if it has been cycled. With a datestamp, the datestamp
305will be compared. The static slot for saving it is the same size as buffer,
306and the text has been checked above to fit, so this use of strcpy() is OK. */
307
308if (type == lt_main)
059ec3d9 309 {
921b12ca
TF
310 Ustrcpy(mainlog_name, buffer);
311 mainlog_datestamp = mainlog_name + string_datestamp_offset;
312 }
059ec3d9 313
921b12ca 314/* Ditto for the reject log */
059ec3d9 315
921b12ca
TF
316else if (type == lt_reject)
317 {
318 Ustrcpy(rejectlog_name, buffer);
319 rejectlog_datestamp = rejectlog_name + string_datestamp_offset;
320 }
059ec3d9 321
921b12ca
TF
322/* and deal with the debug log (which keeps the datestamp, but does not
323update it) */
059ec3d9 324
921b12ca
TF
325else if (type == lt_debug)
326 {
327 Ustrcpy(debuglog_name, buffer);
328 if (tag)
059ec3d9 329 {
921b12ca
TF
330 /* this won't change the offset of the datestamp */
331 ok2 = string_format(buffer, sizeof(buffer), "%s%s",
332 debuglog_name, tag);
333 if (ok2)
334 Ustrcpy(debuglog_name, buffer);
059ec3d9 335 }
921b12ca 336 }
059ec3d9 337
921b12ca
TF
338/* Remove any datestamp if this is the panic log. This is rare, so there's no
339need to optimize getting the datestamp length. We remove one non-alphanumeric
340char afterwards if at the start, otherwise one before. */
ed7f7860 341
921b12ca
TF
342else if (string_datestamp_offset >= 0)
343 {
344 uschar *from = buffer + string_datestamp_offset;
345 uschar *to = from + string_datestamp_length;
346 if (from == buffer || from[-1] == '/')
ed7f7860 347 {
921b12ca 348 if (!isalnum(*to)) to++;
ed7f7860 349 }
921b12ca 350 else
059ec3d9 351 {
921b12ca
TF
352 if (!isalnum(from[-1])) from--;
353 }
059ec3d9 354
921b12ca 355 /* This strcpy is ok, because we know that to is a substring of from. */
059ec3d9 356
921b12ca 357 Ustrcpy(from, to);
059ec3d9
PH
358 }
359
360/* If the file name is too long, it is an unrecoverable disaster */
361
362if (!ok)
363 {
364 die(US"exim: log file path too long: aborting",
365 US"Logging failure; please try later");
366 }
367
368/* We now have the file name. Try to open an existing file. After a successful
369open, arrange for automatic closure on exec(), and then return. */
370
371*fd = Uopen(buffer, O_APPEND|O_WRONLY, LOG_MODE);
372
373if (*fd >= 0)
374 {
ff790e47 375 (void)fcntl(*fd, F_SETFD, fcntl(*fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
376 return;
377 }
378
379/* Open was not successful: try creating the file. If this is a root process,
380we must do the creating in a subprocess set to exim:exim in order to ensure
381that the file is created with the right ownership. Otherwise, there can be a
901f42cb
PH
382race if another Exim process is trying to write to the log at the same time.
383The use of SIGUSR1 by the exiwhat utility can provoke a lot of simultaneous
384writing. */
059ec3d9
PH
385
386euid = geteuid();
387
388/* If we are already running as the Exim user (even if that user is root),
389we can go ahead and create in the current process. */
390
921b12ca 391if (euid == exim_uid) *fd = log_create(buffer);
059ec3d9
PH
392
393/* Otherwise, if we are root, do the creation in an exim:exim subprocess. If we
394are neither exim nor root, creation is not attempted. */
395
921b12ca 396else if (euid == root_uid) *fd = log_create_as_exim(buffer);
059ec3d9
PH
397
398/* If we now have an open file, set the close-on-exec flag and return. */
399
400if (*fd >= 0)
401 {
ff790e47 402 (void)fcntl(*fd, F_SETFD, fcntl(*fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
403 return;
404 }
405
406/* Creation failed. There are some circumstances in which we get here when
407the effective uid is not root or exim, which is the problem. (For example, a
408non-setuid binary with log_arguments set, called in certain ways.) Rather than
409just bombing out, force the log to stderr and carry on if stderr is available.
410*/
411
412if (euid != root_uid && euid != exim_uid && log_stderr != NULL)
413 {
414 *fd = fileno(log_stderr);
415 return;
416 }
417
418/* Otherwise this is a disaster. This call is deliberately ONLY to the panic
419log. If possible, save a copy of the original line that was being logged. If we
420are recursing (can't open the panic log either), the pointer will already be
421set. */
422
423if (panic_save_buffer == NULL)
424 {
425 panic_save_buffer = (uschar *)malloc(LOG_BUFFER_SIZE);
426 if (panic_save_buffer != NULL)
427 memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
428 }
429
430log_write(0, LOG_PANIC_DIE, "Cannot open %s log file \"%s\": %s: "
431 "euid=%d egid=%d", log_names[type], buffer, strerror(errno), euid, getegid());
432/* Never returns */
433}
434
435
436
437/*************************************************
438* Add configuration file info to log line *
439*************************************************/
440
441/* This is put in a function because it's needed twice (once for debugging,
442once for real).
443
444Arguments:
445 ptr pointer to the end of the line we are building
446 flags log flags
447
448Returns: updated pointer
449*/
450
451static uschar *
452log_config_info(uschar *ptr, int flags)
453{
454Ustrcpy(ptr, "Exim configuration error");
455ptr += 24;
456
457if ((flags & (LOG_CONFIG_FOR & ~LOG_CONFIG)) != 0)
458 {
459 Ustrcpy(ptr, " for ");
460 return ptr + 5;
461 }
462
463if ((flags & (LOG_CONFIG_IN & ~LOG_CONFIG)) != 0)
464 {
465 sprintf(CS ptr, " in line %d of %s", config_lineno, config_filename);
466 while (*ptr) ptr++;
467 }
468
469Ustrcpy(ptr, ":\n ");
470return ptr + 4;
471}
472
473
474/*************************************************
475* A write() operation failed *
476*************************************************/
477
478/* This function is called when write() fails on anything other than the panic
479log, which can happen if a disk gets full or a file gets too large or whatever.
480We try to save the relevant message in the panic_save buffer before crashing
481out.
482
23ecb73d
PP
483The potential invoker should probably not call us for EINTR -1 writes. But
484otherwise, short writes are bad as we don't do non-blocking writes to fds
485subject to flow control. (If we do, that's new and the logic of this should
486be reconsidered).
487
059ec3d9
PH
488Arguments:
489 name the name of the log being written
490 length the string length being written
491 rc the return value from write()
492
493Returns: does not return
494*/
495
496static void
497log_write_failed(uschar *name, int length, int rc)
498{
499int save_errno = errno;
500
501if (panic_save_buffer == NULL)
502 {
503 panic_save_buffer = (uschar *)malloc(LOG_BUFFER_SIZE);
504 if (panic_save_buffer != NULL)
505 memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
506 }
507
508log_write(0, LOG_PANIC_DIE, "failed to write to %s: length=%d result=%d "
509 "errno=%d (%s)", name, length, rc, save_errno,
510 (save_errno == 0)? "write incomplete" : strerror(save_errno));
511/* Never returns */
512}
513
514
515
516/*************************************************
0599f9cf
PP
517* Write to an fd, retrying after signals *
518*************************************************/
519
520/* Basic write to fd for logs, handling EINTR.
521
522Arguments:
523 fd the fd to write to
524 buf the string to write
525 length the string length being written
526
527Returns:
528 length actually written, persisting an errno from write()
529*/
530ssize_t
17c76198 531write_to_fd_buf(int fd, const uschar *buf, size_t length)
0599f9cf
PP
532{
533ssize_t wrote;
534size_t total_written = 0;
17c76198 535const uschar *p = buf;
0599f9cf
PP
536size_t left = length;
537
538while (1)
539 {
540 wrote = write(fd, p, left);
541 if (wrote == (ssize_t)-1)
542 {
543 if (errno == EINTR) continue;
544 return wrote;
545 }
546 total_written += wrote;
547 if (wrote == left)
548 break;
549 else
550 {
551 p += wrote;
552 left -= wrote;
553 }
554 }
555return total_written;
556}
557
558
559/*************************************************
059ec3d9
PH
560* Write message to log file *
561*************************************************/
562
563/* Exim can be configured to log to local files, or use syslog, or both. This
564is controlled by the setting of log_file_path. The following cases are
565recognized:
566
567 log_file_path = "" write files in the spool/log directory
568 log_file_path = "xxx" write files in the xxx directory
569 log_file_path = "syslog" write to syslog
570 log_file_path = "syslog : xxx" write to syslog and to files (any order)
571
059ec3d9
PH
572The message always gets '\n' added on the end of it, since more than one
573process may be writing to the log at once and we don't want intermingling to
574happen in the middle of lines. To be absolutely sure of this we write the data
575into a private buffer and then put it out in a single write() call.
576
577The flags determine which log(s) the message is written to, or for syslogging,
578which priority to use, and in the case of the panic log, whether the process
579should die afterwards.
580
581The variable really_exim is TRUE only when exim is running in privileged state
582(i.e. not with a changed configuration or with testing options such as -brw).
583If it is not, don't try to write to the log because permission will probably be
584denied.
585
586Avoid actually writing to the logs when exim is called with -bv or -bt to
587test an address, but take other actions, such as panicing.
588
589In Exim proper, the buffer for building the message is got at start-up, so that
590nothing gets done if it can't be got. However, some functions that are also
591used in utilities occasionally obey log_write calls in error situations, and it
592is simplest to put a single malloc() here rather than put one in each utility.
593Malloc is used directly because the store functions may call log_write().
594
595If a message_id exists, we include it after the timestamp.
596
597Arguments:
598 selector write to main log or LOG_INFO only if this value is zero, or if
599 its bit is set in log_write_selector
600 flags each bit indicates some independent action:
601 LOG_SENDER add raw sender to the message
602 LOG_RECIPIENTS add raw recipients list to message
603 LOG_CONFIG add "Exim configuration error"
604 LOG_CONFIG_FOR add " for " instead of ":\n "
605 LOG_CONFIG_IN add " in line x[ of file y]"
606 LOG_MAIN write to main log or syslog LOG_INFO
607 LOG_REJECT write to reject log or syslog LOG_NOTICE
608 LOG_PANIC write to panic log or syslog LOG_ALERT
609 LOG_PANIC_DIE write to panic log or LOG_ALERT and then crash
059ec3d9
PH
610 format a printf() format
611 ... arguments for format
612
613Returns: nothing
614*/
615
616void
1ba28e2b 617log_write(unsigned int selector, int flags, const char *format, ...)
059ec3d9
PH
618{
619uschar *ptr;
0599f9cf 620int length;
059ec3d9 621int paniclogfd;
23ecb73d 622ssize_t written_len;
059ec3d9
PH
623va_list ap;
624
625/* If panic_recurseflag is set, we have failed to open the panic log. This is
626the ultimate disaster. First try to write the message to a debug file and/or
627stderr and also to syslog. If panic_save_buffer is not NULL, it contains the
628original log line that caused the problem. Afterwards, expire. */
629
630if (panic_recurseflag)
631 {
632 uschar *extra = (panic_save_buffer == NULL)? US"" : panic_save_buffer;
633 if (debug_file != NULL) debug_printf("%s%s", extra, log_buffer);
634 if (log_stderr != NULL && log_stderr != debug_file)
635 fprintf(log_stderr, "%s%s", extra, log_buffer);
636 if (*extra != 0) write_syslog(LOG_CRIT, extra);
637 write_syslog(LOG_CRIT, log_buffer);
638 die(US"exim: could not open panic log - aborting: see message(s) above",
639 US"Unexpected log failure, please try later");
640 }
641
642/* Ensure we have a buffer (see comment above); this should never be obeyed
643when running Exim proper, only when running utilities. */
644
645if (log_buffer == NULL)
646 {
647 log_buffer = (uschar *)malloc(LOG_BUFFER_SIZE);
648 if (log_buffer == NULL)
649 {
650 fprintf(stderr, "exim: failed to get store for log buffer\n");
651 exim_exit(EXIT_FAILURE);
652 }
653 }
654
655/* If we haven't already done so, inspect the setting of log_file_path to
656determine whether to log to files and/or to syslog. Bits in logging_mode
657control this, and for file logging, the path must end up in file_path. This
658variable must be in permanent store because it may be required again later in
659the process. */
660
661if (!path_inspected)
662 {
663 BOOL multiple = FALSE;
664 int old_pool = store_pool;
665
666 store_pool = POOL_PERM;
667
668 /* If nothing has been set, don't waste effort... the default values for the
669 statics are file_path="" and logging_mode = LOG_MODE_FILE. */
670
671 if (log_file_path[0] != 0)
672 {
673 int sep = ':'; /* Fixed separator - outside use */
674 uschar *s;
55414b25 675 const uschar *ss = log_file_path;
059ec3d9 676 logging_mode = 0;
55414b25 677 while ((s = string_nextinlist(&ss, &sep, log_buffer, LOG_BUFFER_SIZE)))
059ec3d9
PH
678 {
679 if (Ustrcmp(s, "syslog") == 0)
680 logging_mode |= LOG_MODE_SYSLOG;
681 else if ((logging_mode & LOG_MODE_FILE) != 0) multiple = TRUE;
682 else
683 {
684 logging_mode |= LOG_MODE_FILE;
685
686 /* If a non-empty path is given, use it */
687
688 if (s[0] != 0)
689 {
690 file_path = string_copy(s);
691 }
692
693 /* If the path is empty, we want to use the first non-empty, non-
694 syslog item in LOG_FILE_PATH, if there is one, since the value of
695 log_file_path may have been set at runtime. If there is no such item,
696 use the ultimate default in the spool directory. */
697
698 else
699 {
700 uschar *t;
55414b25
JH
701 const uschar *tt = US LOG_FILE_PATH;
702 while ((t = string_nextinlist(&tt, &sep, log_buffer, LOG_BUFFER_SIZE)))
059ec3d9
PH
703 {
704 if (Ustrcmp(t, "syslog") == 0 || t[0] == 0) continue;
705 file_path = string_copy(t);
706 break;
707 }
708 } /* Empty item in log_file_path */
709 } /* First non-syslog item in log_file_path */
710 } /* Scan of log_file_path */
711 }
712
713 /* If no modes have been selected, it is a major disaster */
714
715 if (logging_mode == 0)
716 die(US"Neither syslog nor file logging set in log_file_path",
717 US"Unexpected logging failure");
718
719 /* Set up the ultimate default if necessary. Then revert to the old store
720 pool, and record that we've sorted out the path. */
721
722 if ((logging_mode & LOG_MODE_FILE) != 0 && file_path[0] == 0)
723 file_path = string_sprintf("%s/log/%%slog", spool_directory);
724 store_pool = old_pool;
725 path_inspected = TRUE;
726
727 /* If more than one file path was given, log a complaint. This recursive call
728 should work since we have now set up the routing. */
729
730 if (multiple)
731 {
732 log_write(0, LOG_MAIN|LOG_PANIC,
733 "More than one path given in log_file_path: using %s", file_path);
734 }
735 }
736
737/* If debugging, show all log entries, but don't show headers. Do it all
738in one go so that it doesn't get split when multi-processing. */
739
740DEBUG(D_any|D_v)
741 {
742 int i;
743 ptr = log_buffer;
744
745 Ustrcpy(ptr, "LOG:");
746 ptr += 4;
747
748 /* Show the options that were passed into the call. These are those whose
749 flag values do not have the 0x80000000 bit in them. Note that this
750 automatically exclude the "all" setting. */
751
752 for (i = 0; i < log_options_count; i++)
753 {
754 unsigned int bit = log_options[i].bit;
755 if ((bit & 0x80000000) != 0) continue;
756 if ((selector & bit) != 0)
757 {
758 *ptr++ = ' ';
759 Ustrcpy(ptr, log_options[i].name);
760 while (*ptr) ptr++;
761 }
762 }
763
d690cbdc 764 sprintf(CS ptr, "%s%s%s%s\n ",
059ec3d9
PH
765 ((flags & LOG_MAIN) != 0)? " MAIN" : "",
766 ((flags & LOG_PANIC) != 0)? " PANIC" : "",
767 ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE)? " DIE" : "",
059ec3d9
PH
768 ((flags & LOG_REJECT) != 0)? " REJECT" : "");
769
770 while(*ptr) ptr++;
771 if ((flags & LOG_CONFIG) != 0) ptr = log_config_info(ptr, flags);
772
773 va_start(ap, format);
774 if (!string_vformat(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer)-1, format, ap))
775 Ustrcpy(ptr, "**** log string overflowed log buffer ****");
776 va_end(ap);
777
778 while(*ptr) ptr++;
779 Ustrcat(ptr, "\n");
780 debug_printf("%s", log_buffer);
781 }
782
783/* If no log file is specified, we are in a mess. */
784
921b12ca 785if ((flags & (LOG_MAIN|LOG_PANIC|LOG_REJECT)) == 0)
059ec3d9
PH
786 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_write called with no log "
787 "flags set");
788
789/* There are some weird circumstances in which logging is disabled. */
790
791if (disable_logging)
792 {
793 DEBUG(D_any) debug_printf("log writing disabled\n");
794 return;
795 }
796
a7d7aa58
PH
797/* Handle disabled reject log */
798
799if (!write_rejectlog) flags &= ~LOG_REJECT;
800
921b12ca
TF
801/* Create the main message in the log buffer. Do not include the message id
802when called by a utility. */
059ec3d9
PH
803
804ptr = log_buffer;
f3f065bb
PH
805sprintf(CS ptr, "%s ", tod_stamp(tod_log));
806while(*ptr) ptr++;
807
808if ((log_extra_selector & LX_pid) != 0)
809 {
810 sprintf(CS ptr, "[%d] ", (int)getpid());
811 while (*ptr) ptr++;
812 }
813
921b12ca 814if (really_exim && message_id[0] != 0)
f3f065bb
PH
815 {
816 sprintf(CS ptr, "%s ", message_id);
817 while(*ptr) ptr++;
818 }
059ec3d9 819
059ec3d9
PH
820if ((flags & LOG_CONFIG) != 0) ptr = log_config_info(ptr, flags);
821
822va_start(ap, format);
823if (!string_vformat(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer)-1, format, ap))
824 Ustrcpy(ptr, "**** log string overflowed log buffer ****\n");
825while(*ptr) ptr++;
826va_end(ap);
827
828/* Add the raw, unrewritten, sender to the message if required. This is done
829this way because it kind of fits with LOG_RECIPIENTS. */
830
831if ((flags & LOG_SENDER) != 0 &&
ccfdb010 832 ptr < log_buffer + LOG_BUFFER_SIZE - 10 - Ustrlen(raw_sender))
059ec3d9
PH
833 {
834 sprintf(CS ptr, " from <%s>", raw_sender);
835 while (*ptr) ptr++;
836 }
837
838/* Add list of recipients to the message if required; the raw list,
839before rewriting, was saved in raw_recipients. There may be none, if an ACL
840discarded them all. */
841
842if ((flags & LOG_RECIPIENTS) != 0 && ptr < log_buffer + LOG_BUFFER_SIZE - 6 &&
843 raw_recipients_count > 0)
844 {
845 int i;
846 sprintf(CS ptr, " for");
847 while (*ptr) ptr++;
848 for (i = 0; i < raw_recipients_count; i++)
849 {
850 uschar *s = raw_recipients[i];
851 if (log_buffer + LOG_BUFFER_SIZE - ptr < Ustrlen(s) + 3) break;
852 sprintf(CS ptr, " %s", s);
853 while (*ptr) ptr++;
854 }
855 }
856
857sprintf(CS ptr, "\n");
858while(*ptr) ptr++;
859length = ptr - log_buffer;
860
861/* Handle loggable errors when running a utility, or when address testing.
862Write to log_stderr unless debugging (when it will already have been written),
863or unless there is no log_stderr (expn called from daemon, for example). */
864
865if (!really_exim || log_testing_mode)
866 {
867 if (debug_selector == 0 && log_stderr != NULL &&
868 (selector == 0 || (selector & log_write_selector) != 0))
869 {
870 if (host_checking)
871 fprintf(log_stderr, "LOG: %s", CS(log_buffer + 20)); /* no timestamp */
872 else
873 fprintf(log_stderr, "%s", CS log_buffer);
874 }
875 if ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE) exim_exit(EXIT_FAILURE);
876 return;
877 }
878
879/* Handle the main log. We know that either syslog or file logging (or both) is
880set up. A real file gets left open during reception or delivery once it has
881been opened, but we don't want to keep on writing to it for too long after it
882has been renamed. Therefore, do a stat() and see if the inode has changed, and
883if so, re-open. */
884
885if ((flags & LOG_MAIN) != 0 &&
886 (selector == 0 || (selector & log_write_selector) != 0))
887 {
888 if ((logging_mode & LOG_MODE_SYSLOG) != 0 &&
889 (syslog_duplication || (flags & (LOG_REJECT|LOG_PANIC)) == 0))
890 write_syslog(LOG_INFO, log_buffer);
891
892 if ((logging_mode & LOG_MODE_FILE) != 0)
893 {
894 struct stat statbuf;
895
896 /* Check for a change to the mainlog file name when datestamping is in
897 operation. This happens at midnight, at which point we want to roll over
898 the file. Closing it has the desired effect. */
899
900 if (mainlog_datestamp != NULL)
901 {
f1e5fef5 902 uschar *nowstamp = tod_stamp(string_datestamp_type);
059ec3d9
PH
903 if (Ustrncmp (mainlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
904 {
f1e894f3 905 (void)close(mainlogfd); /* Close the file */
059ec3d9
PH
906 mainlogfd = -1; /* Clear the file descriptor */
907 mainlog_inode = 0; /* Unset the inode */
908 mainlog_datestamp = NULL; /* Clear the datestamp */
909 }
910 }
911
912 /* Otherwise, we want to check whether the file has been renamed by a
913 cycling script. This could be "if else", but for safety's sake, leave it as
914 "if" so that renaming the log starts a new file even when datestamping is
915 happening. */
916
917 if (mainlogfd >= 0)
918 {
919 if (Ustat(mainlog_name, &statbuf) < 0 || statbuf.st_ino != mainlog_inode)
920 {
f1e894f3 921 (void)close(mainlogfd);
059ec3d9
PH
922 mainlogfd = -1;
923 mainlog_inode = 0;
924 }
925 }
926
927 /* If the log is closed, open it. Then write the line. */
928
929 if (mainlogfd < 0)
930 {
ed7f7860 931 open_log(&mainlogfd, lt_main, NULL); /* No return on error */
059ec3d9
PH
932 if (fstat(mainlogfd, &statbuf) >= 0) mainlog_inode = statbuf.st_ino;
933 }
934
935 /* Failing to write to the log is disastrous */
936
0599f9cf 937 written_len = write_to_fd_buf(mainlogfd, log_buffer, length);
23ecb73d 938 if (written_len != length)
059ec3d9 939 {
23ecb73d 940 log_write_failed(US"main log", length, written_len);
059ec3d9
PH
941 /* That function does not return */
942 }
943 }
944 }
945
a7d7aa58
PH
946/* Handle the log for rejected messages. This can be globally disabled, in
947which case the flags are altered above. If there are any header lines (i.e. if
948the rejection is happening after the DATA phase), log the recipients and the
949headers. */
059ec3d9 950
a7d7aa58 951if ((flags & LOG_REJECT) != 0)
059ec3d9
PH
952 {
953 header_line *h;
954
955 if (header_list != NULL && (log_extra_selector & LX_rejected_header) != 0)
956 {
957 if (recipients_count > 0)
958 {
959 int i;
960
961 /* List the sender */
962
963 string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
964 "Envelope-from: <%s>\n", sender_address);
965 while (*ptr) ptr++;
966
967 /* List up to 5 recipients */
968
969 string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
970 "Envelope-to: <%s>\n", recipients_list[0].address);
971 while (*ptr) ptr++;
972
973 for (i = 1; i < recipients_count && i < 5; i++)
974 {
975 string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer), " <%s>\n",
976 recipients_list[i].address);
977 while (*ptr) ptr++;
978 }
979
980 if (i < recipients_count)
981 {
982 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
983 " ...\n");
984 while (*ptr) ptr++;
985 }
986 }
987
988 /* A header with a NULL text is an unfilled in Received: header */
989
990 for (h = header_list; h != NULL; h = h->next)
991 {
992 BOOL fitted;
993 if (h->text == NULL) continue;
994 fitted = string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
995 "%c %s", h->type, h->text);
996 while(*ptr) ptr++;
997 if (!fitted) /* Buffer is full; truncate */
998 {
999 ptr -= 100; /* For message and separator */
1000 if (ptr[-1] == '\n') ptr--;
1001 Ustrcpy(ptr, "\n*** truncated ***\n");
1002 while (*ptr) ptr++;
1003 break;
1004 }
1005 }
1006
1007 length = ptr - log_buffer;
1008 }
1009
1010 /* Write to syslog or to a log file */
1011
1012 if ((logging_mode & LOG_MODE_SYSLOG) != 0 &&
1013 (syslog_duplication || (flags & LOG_PANIC) == 0))
1014 write_syslog(LOG_NOTICE, log_buffer);
1015
1016 /* Check for a change to the rejectlog file name when datestamping is in
1017 operation. This happens at midnight, at which point we want to roll over
1018 the file. Closing it has the desired effect. */
1019
1020 if ((logging_mode & LOG_MODE_FILE) != 0)
1021 {
1022 struct stat statbuf;
1023
1024 if (rejectlog_datestamp != NULL)
1025 {
f1e5fef5 1026 uschar *nowstamp = tod_stamp(string_datestamp_type);
059ec3d9
PH
1027 if (Ustrncmp (rejectlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1028 {
f1e894f3 1029 (void)close(rejectlogfd); /* Close the file */
059ec3d9
PH
1030 rejectlogfd = -1; /* Clear the file descriptor */
1031 rejectlog_inode = 0; /* Unset the inode */
1032 rejectlog_datestamp = NULL; /* Clear the datestamp */
1033 }
1034 }
1035
1036 /* Otherwise, we want to check whether the file has been renamed by a
1037 cycling script. This could be "if else", but for safety's sake, leave it as
1038 "if" so that renaming the log starts a new file even when datestamping is
1039 happening. */
1040
1041 if (rejectlogfd >= 0)
1042 {
1043 if (Ustat(rejectlog_name, &statbuf) < 0 ||
1044 statbuf.st_ino != rejectlog_inode)
1045 {
f1e894f3 1046 (void)close(rejectlogfd);
059ec3d9
PH
1047 rejectlogfd = -1;
1048 rejectlog_inode = 0;
1049 }
1050 }
1051
1052 /* Open the file if necessary, and write the data */
1053
1054 if (rejectlogfd < 0)
1055 {
ed7f7860 1056 open_log(&rejectlogfd, lt_reject, NULL); /* No return on error */
059ec3d9
PH
1057 if (fstat(rejectlogfd, &statbuf) >= 0) rejectlog_inode = statbuf.st_ino;
1058 }
1059
0599f9cf
PP
1060 written_len = write_to_fd_buf(rejectlogfd, log_buffer, length);
1061 if (written_len != length)
059ec3d9 1062 {
0599f9cf 1063 log_write_failed(US"reject log", length, written_len);
059ec3d9
PH
1064 /* That function does not return */
1065 }
1066 }
1067 }
1068
1069
059ec3d9
PH
1070/* Handle the panic log, which is not kept open like the others. If it fails to
1071open, there will be a recursive call to log_write(). We detect this above and
1072attempt to write to the system log as a last-ditch try at telling somebody. In
47c7a64a 1073all cases except mua_wrapper, try to write to log_stderr. */
059ec3d9
PH
1074
1075if ((flags & LOG_PANIC) != 0)
1076 {
47c7a64a 1077 if (log_stderr != NULL && log_stderr != debug_file && !mua_wrapper)
059ec3d9
PH
1078 fprintf(log_stderr, "%s", CS log_buffer);
1079
1080 if ((logging_mode & LOG_MODE_SYSLOG) != 0)
1081 {
1082 write_syslog(LOG_ALERT, log_buffer);
1083 }
1084
1085 /* If this panic logging was caused by a failure to open the main log,
1086 the original log line is in panic_save_buffer. Make an attempt to write it. */
1087
1088 if ((logging_mode & LOG_MODE_FILE) != 0)
1089 {
1090 panic_recurseflag = TRUE;
ed7f7860 1091 open_log(&paniclogfd, lt_panic, NULL); /* Won't return on failure */
059ec3d9
PH
1092 panic_recurseflag = FALSE;
1093
1094 if (panic_save_buffer != NULL)
1ac6b2e7
JH
1095 {
1096 int i = write(paniclogfd, panic_save_buffer, Ustrlen(panic_save_buffer));
1097 i = i; /* compiler quietening */
1098 }
059ec3d9 1099
0599f9cf
PP
1100 written_len = write_to_fd_buf(paniclogfd, log_buffer, length);
1101 if (written_len != length)
059ec3d9
PH
1102 {
1103 int save_errno = errno;
1104 write_syslog(LOG_CRIT, log_buffer);
1105 sprintf(CS log_buffer, "write failed on panic log: length=%d result=%d "
0599f9cf 1106 "errno=%d (%s)", length, (int)written_len, save_errno, strerror(save_errno));
059ec3d9
PH
1107 write_syslog(LOG_CRIT, log_buffer);
1108 flags |= LOG_PANIC_DIE;
1109 }
1110
f1e894f3 1111 (void)close(paniclogfd);
059ec3d9
PH
1112 }
1113
1114 /* Give up if the DIE flag is set */
1115
1116 if ((flags & LOG_PANIC_DIE) != LOG_PANIC)
1117 die(NULL, US"Unexpected failure, please try later");
1118 }
1119}
1120
1121
1122
1123/*************************************************
1124* Close any open log files *
1125*************************************************/
1126
1127void
1128log_close_all(void)
1129{
1130if (mainlogfd >= 0)
f1e894f3 1131 { (void)close(mainlogfd); mainlogfd = -1; }
059ec3d9 1132if (rejectlogfd >= 0)
f1e894f3 1133 { (void)close(rejectlogfd); rejectlogfd = -1; }
059ec3d9
PH
1134closelog();
1135syslog_open = FALSE;
1136}
1137
ed7f7860
PP
1138
1139
1140/*************************************************
1141* Decode bit settings for log/debug *
1142*************************************************/
1143
1144/* This function decodes a string containing bit settings in the form of +name
1145and/or -name sequences, and sets/unsets bits in a bit string accordingly. It
1146also recognizes a numeric setting of the form =<number>, but this is not
1147intended for user use. It's an easy way for Exim to pass the debug settings
1148when it is re-exec'ed.
1149
1150The log options are held in two unsigned ints (because there became too many
1151for one). The top bit in the table means "put in 2nd selector". This does not
1152yet apply to debug options, so the "=" facility sets only the first selector.
1153
1154The "all" selector, which must be equal to 0xffffffff, is recognized specially.
1155It sets all the bits in both selectors. However, there is a facility for then
1156unsetting certain bits, because we want to turn off "memory" in the debug case.
1157
1158The action taken for bad values varies depending upon why we're here.
1159For log messages, or if the debugging is triggered from config, then we write
1160to the log on the way out. For debug setting triggered from the command-line,
1161we treat it as an unknown option: error message to stderr and die.
1162
1163Arguments:
1164 selector1 address of the first bit string
1165 selector2 address of the second bit string, or NULL
1166 notall1 bits to exclude from "all" for selector1
1167 notall2 bits to exclude from "all" for selector2
1168 string the configured string
1169 options the table of option names
1170 count size of table
1171 which "log" or "debug"
1172 flags DEBUG_FROM_CONFIG
1173
1174Returns: nothing on success - bomb out on failure
1175*/
1176
1177void
1178decode_bits(unsigned int *selector1, unsigned int *selector2, int notall1,
1179 int notall2, uschar *string, bit_table *options, int count, uschar *which,
1180 int flags)
1181{
1182uschar *errmsg;
1183if (string == NULL) return;
1184
1185if (*string == '=')
1186 {
1187 char *end; /* Not uschar */
1188 *selector1 = strtoul(CS string+1, &end, 0);
1189 if (*end == 0) return;
1190 errmsg = string_sprintf("malformed numeric %s_selector setting: %s", which,
1191 string);
1192 goto ERROR_RETURN;
1193 }
1194
1195/* Handle symbolic setting */
1196
1197else for(;;)
1198 {
1199 BOOL adding;
1200 uschar *s;
1201 int len;
1202 bit_table *start, *end;
1203
1204 while (isspace(*string)) string++;
1205 if (*string == 0) return;
1206
1207 if (*string != '+' && *string != '-')
1208 {
1209 errmsg = string_sprintf("malformed %s_selector setting: "
1210 "+ or - expected but found \"%s\"", which, string);
1211 goto ERROR_RETURN;
1212 }
1213
1214 adding = *string++ == '+';
1215 s = string;
1216 while (isalnum(*string) || *string == '_') string++;
1217 len = string - s;
1218
1219 start = options;
1220 end = options + count;
1221
1222 while (start < end)
1223 {
1224 bit_table *middle = start + (end - start)/2;
1225 int c = Ustrncmp(s, middle->name, len);
1226 if (c == 0)
1227 {
1228 if (middle->name[len] != 0) c = -1; else
1229 {
1230 unsigned int bit = middle->bit;
1231 unsigned int *selector;
1232
1233 /* The value with all bits set means "force all bits in both selectors"
1234 in the case where two are being handled. However, the top bit in the
1235 second selector is never set. When setting, some bits can be excluded.
1236 */
1237
1238 if (bit == 0xffffffff)
1239 {
1240 if (adding)
1241 {
1242 *selector1 = 0xffffffff ^ notall1;
1243 if (selector2 != NULL) *selector2 = 0x7fffffff ^ notall2;
1244 }
1245 else
1246 {
1247 *selector1 = 0;
1248 if (selector2 != NULL) *selector2 = 0;
1249 }
1250 }
1251
1252 /* Otherwise, the 0x80000000 bit means "this value, without the top
1253 bit, belongs in the second selector". */
1254
1255 else
1256 {
1257 if ((bit & 0x80000000) != 0)
1258 {
1259 selector = selector2;
1260 bit &= 0x7fffffff;
1261 }
1262 else selector = selector1;
1263 if (adding) *selector |= bit; else *selector &= ~bit;
1264 }
1265 break; /* Out of loop to match selector name */
1266 }
1267 }
1268 if (c < 0) end = middle; else start = middle + 1;
1269 } /* Loop to match selector name */
1270
1271 if (start >= end)
1272 {
1273 errmsg = string_sprintf("unknown %s_selector setting: %c%.*s", which,
1274 adding? '+' : '-', len, s);
1275 goto ERROR_RETURN;
1276 }
1277 } /* Loop for selector names */
1278
1279/* Handle disasters */
1280
1281ERROR_RETURN:
1282if (Ustrcmp(which, "debug") == 0)
1283 {
1284 if (flags & DEBUG_FROM_CONFIG)
1285 {
1286 log_write(0, LOG_CONFIG|LOG_PANIC, "%s", errmsg);
1287 return;
1288 }
1289 fprintf(stderr, "exim: %s\n", errmsg);
1290 exit(EXIT_FAILURE);
1291 }
1292else log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "%s", errmsg);
1293}
1294
1295
1296
1297/*************************************************
1298* Activate a debug logfile (late) *
1299*************************************************/
1300
1301/* Normally, debugging is activated from the command-line; it may be useful
1302within the configuration to activate debugging later, based on certain
1303conditions. If debugging is already in progress, we return early, no action
1304taken (besides debug-logging that we wanted debug-logging).
1305
1306Failures in options are not fatal but will result in paniclog entries for the
1307misconfiguration.
1308
1309The first use of this is in ACL logic, "control = debug/tag=foo/opts=+expand"
1310which can be combined with conditions, etc, to activate extra logging only
9ee44efb 1311for certain sources. The second use is inetd wait mode debug preservation. */
ed7f7860
PP
1312
1313void
1314debug_logging_activate(uschar *tag_name, uschar *opts)
1315{
1316int fd = -1;
1317
1318if (debug_file)
1319 {
1320 debug_printf("DEBUGGING ACTIVATED FROM WITHIN CONFIG.\n"
9ee44efb 1321 "DEBUG: Tag=\"%s\" Opts=\"%s\"\n", tag_name, opts ? opts : US"");
ed7f7860
PP
1322 return;
1323 }
1324
1325if (tag_name != NULL && (Ustrchr(tag_name, '/') != NULL))
1326 {
1327 log_write(0, LOG_MAIN|LOG_PANIC, "debug tag may not contain a '/' in: %s",
1328 tag_name);
1329 return;
1330 }
1331
1332debug_selector = D_default;
1333if (opts)
1334 {
1335 decode_bits(&debug_selector, NULL, D_memory, 0, opts,
1336 debug_options, debug_options_count, US"debug", DEBUG_FROM_CONFIG);
1337 }
1338
1339open_log(&fd, lt_debug, tag_name);
1340
1341if (fd != -1)
1342 debug_file = fdopen(fd, "w");
1343else
1344 log_write(0, LOG_MAIN|LOG_PANIC, "unable to open debug log");
1345}
1346
1347
059ec3d9 1348/* End of log.c */