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