f65c65262481555eb14f413bc1f11ad1d5fbce46
[exim.git] / src / src / queue.c
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8 /* Functions that operate on the input queue. */
9
10
11 #include "exim.h"
12
13
14
15
16
17
18
19 #ifndef COMPILE_UTILITY
20
21 /* The number of nodes to use for the bottom-up merge sort when a list of queue
22 items is to be ordered. The code for this sort was contributed as a patch by
23 Michael Haardt. */
24
25 #define LOG2_MAXNODES 32
26
27
28
29 /*************************************************
30 * Helper sort function for queue_get_spool_list *
31 *************************************************/
32
33 /* This function is used when sorting the queue list in the function
34 queue_get_spool_list() below.
35
36 Arguments:
37 a points to an ordered list of queue_filename items
38 b points to another ordered list
39
40 Returns: a pointer to a merged ordered list
41 */
42
43 static queue_filename *
44 merge_queue_lists(queue_filename *a, queue_filename *b)
45 {
46 queue_filename *first = NULL;
47 queue_filename **append = &first;
48
49 while (a && b)
50 {
51 int d;
52 if ((d = Ustrncmp(a->text, b->text, 6)) == 0)
53 d = Ustrcmp(a->text + 14, b->text + 14);
54 if (d < 0)
55 {
56 *append = a;
57 append= &a->next;
58 a = a->next;
59 }
60 else
61 {
62 *append = b;
63 append= &b->next;
64 b = b->next;
65 }
66 }
67
68 *append = a ? a : b;
69 return first;
70 }
71
72
73
74
75
76 /*************************************************
77 * Get list of spool files *
78 *************************************************/
79
80 /* Scan the spool directory and return a list of the relevant file names
81 therein. Single-character sub-directories are handled as follows:
82
83 If the first argument is > 0, a sub-directory is scanned; the letter is
84 taken from the nth entry in subdirs.
85
86 If the first argument is 0, sub-directories are not scanned. However, a
87 list of them is returned.
88
89 If the first argument is < 0, sub-directories are scanned for messages,
90 and a single, unified list is created. The returned data blocks contain the
91 identifying character of the subdirectory, if any. The subdirs vector is
92 still required as an argument.
93
94 If the randomize argument is TRUE, messages are returned in "randomized" order.
95 Actually, the order is anything but random, but the algorithm is cheap, and the
96 point is simply to ensure that the same order doesn't occur every time, in case
97 a particular message is causing a remote MTA to barf - we would like to try
98 other messages to that MTA first.
99
100 If the randomize argument is FALSE, sort the list according to the file name.
101 This should give the order in which the messages arrived. It is normally used
102 only for presentation to humans, in which case the (possibly expensive) sort
103 that it does is not part of the normal operational code. However, if
104 queue_run_in_order is set, sorting has to take place for queue runs as well.
105 When randomize is FALSE, the first argument is normally -1, so all messages are
106 included.
107
108 Arguments:
109 subdiroffset sub-directory character offset, or 0 or -1 (see above)
110 subdirs vector to store list of subdirchars
111 subcount pointer to int in which to store count of subdirs
112 randomize TRUE if the order of the list is to be unpredictable
113
114 Returns: pointer to a chain of queue name items
115 */
116
117 static queue_filename *
118 queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount,
119 BOOL randomize)
120 {
121 int i;
122 int flags = 0;
123 int resetflags = -1;
124 int subptr;
125 queue_filename *yield = NULL;
126 queue_filename *last = NULL;
127 struct dirent *ent;
128 DIR *dd;
129 uschar buffer[256];
130 queue_filename *root[LOG2_MAXNODES];
131
132 /* When randomizing, the file names are added to the start or end of the list
133 according to the bits of the flags variable. Get a collection of bits from the
134 current time. Use the bottom 16 and just keep re-using them if necessary. When
135 not randomizing, initialize the sublists for the bottom-up merge sort. */
136
137 if (randomize)
138 resetflags = time(NULL) & 0xFFFF;
139 else
140 for (i = 0; i < LOG2_MAXNODES; i++)
141 root[i] = NULL;
142
143 /* If processing the full queue, or just the top-level, start at the base
144 directory, and initialize the first subdirectory name (as none). Otherwise,
145 start at the sub-directory offset. */
146
147 if (subdiroffset <= 0)
148 {
149 i = 0;
150 subdirs[0] = 0;
151 *subcount = 0;
152 }
153 else
154 i = subdiroffset;
155
156 /* Set up prototype for the directory name. */
157
158 spool_pname_buf(buffer, sizeof(buffer));
159 buffer[sizeof(buffer) - 3] = 0;
160 subptr = Ustrlen(buffer);
161 buffer[subptr+2] = 0; /* terminator for lengthened name */
162
163 /* This loop runs at least once, for the main or given directory, and then as
164 many times as necessary to scan any subdirectories encountered in the main
165 directory, if they are to be scanned at this time. */
166
167 for (; i <= *subcount; i++)
168 {
169 int count = 0;
170 int subdirchar = subdirs[i]; /* 0 for main directory */
171
172 if (subdirchar != 0)
173 {
174 buffer[subptr] = '/';
175 buffer[subptr+1] = subdirchar;
176 }
177
178 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
179 if (!(dd = opendir(CS buffer)))
180 continue;
181
182 /* Now scan the directory. */
183
184 while ((ent = readdir(dd)))
185 {
186 uschar *name = US ent->d_name;
187 int len = Ustrlen(name);
188
189 /* Count entries */
190
191 count++;
192
193 /* If we find a single alphameric sub-directory in the base directory,
194 add it to the list for subsequent scans. */
195
196 if (i == 0 && len == 1 && isalnum(*name))
197 {
198 *subcount = *subcount + 1;
199 subdirs[*subcount] = *name;
200 continue;
201 }
202
203 /* Otherwise, if it is a header spool file, add it to the list */
204
205 if (len == SPOOL_NAME_LENGTH &&
206 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
207 {
208 queue_filename *next =
209 store_get(sizeof(queue_filename) + Ustrlen(name), is_tainted(name));
210 Ustrcpy(next->text, name);
211 next->dir_uschar = subdirchar;
212
213 /* Handle the creation of a randomized list. The first item becomes both
214 the top and bottom of the list. Subsequent items are inserted either at
215 the top or the bottom, randomly. This is, I argue, faster than doing a
216 sort by allocating a random number to each item, and it also saves having
217 to store the number with each item. */
218
219 if (randomize)
220 if (!yield)
221 {
222 next->next = NULL;
223 yield = last = next;
224 }
225 else
226 {
227 if (flags == 0)
228 flags = resetflags;
229 if ((flags & 1) == 0)
230 {
231 next->next = yield;
232 yield = next;
233 }
234 else
235 {
236 next->next = NULL;
237 last->next = next;
238 last = next;
239 }
240 flags = flags >> 1;
241 }
242
243 /* Otherwise do a bottom-up merge sort based on the name. */
244
245 else
246 {
247 next->next = NULL;
248 for (int j = 0; j < LOG2_MAXNODES; j++)
249 if (root[j])
250 {
251 next = merge_queue_lists(next, root[j]);
252 root[j] = j == LOG2_MAXNODES - 1 ? next : NULL;
253 }
254 else
255 {
256 root[j] = next;
257 break;
258 }
259 }
260 }
261 }
262
263 /* Finished with this directory */
264
265 closedir(dd);
266
267 /* If we have just scanned a sub-directory, and it was empty (count == 2
268 implies just "." and ".." entries), and Exim is no longer configured to
269 use sub-directories, attempt to get rid of it. At the same time, try to
270 get rid of any corresponding msglog subdirectory. These are just cosmetic
271 tidying actions, so just ignore failures. If we are scanning just a single
272 sub-directory, break the loop. */
273
274 if (i != 0)
275 {
276 if (!split_spool_directory && count <= 2)
277 {
278 uschar subdir[2];
279
280 rmdir(CS buffer);
281 subdir[0] = subdirchar; subdir[1] = 0;
282 rmdir(CS spool_dname(US"msglog", subdir));
283 }
284 if (subdiroffset > 0) break; /* Single sub-directory */
285 }
286
287 /* If we have just scanned the base directory, and subdiroffset is 0,
288 we do not want to continue scanning the sub-directories. */
289
290 else if (subdiroffset == 0)
291 break;
292 } /* Loop for multiple subdirectories */
293
294 /* When using a bottom-up merge sort, do the final merging of the sublists.
295 Then pass back the final list of file items. */
296
297 if (!randomize)
298 for (i = 0; i < LOG2_MAXNODES; ++i)
299 yield = merge_queue_lists(yield, root[i]);
300
301 return yield;
302 }
303
304
305
306
307 /*************************************************
308 * Perform a queue run *
309 *************************************************/
310
311 /* The arguments give the messages to start and stop at; NULL means start at
312 the beginning or stop at the end. If the given start message doesn't exist, we
313 start at the next lexically greater one, and likewise we stop at the after the
314 previous lexically lesser one if the given stop message doesn't exist. Because
315 a queue run can take some time, stat each file before forking, in case it has
316 been delivered in the meantime by some other means.
317
318 The global variables queue_run_force and queue_run_local may be set to cause
319 forced deliveries or local-only deliveries, respectively.
320
321 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
322 not contain the string. As this option is typically used when a machine comes
323 back online, we want to ensure that at least one delivery attempt takes place,
324 so force the first one. The selecting string can optionally be a regex, or
325 refer to the sender instead of recipients.
326
327 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
328 is set so that routing is done for all messages. Thus in the second run those
329 that are routed to the same host should go down the same SMTP connection.
330
331 Arguments:
332 start_id message id to start at, or NULL for all
333 stop_id message id to end at, or NULL for all
334 recurse TRUE if recursing for 2-stage run
335
336 Returns: nothing
337 */
338
339 void
340 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
341 {
342 BOOL force_delivery = f.queue_run_force || deliver_selectstring != NULL ||
343 deliver_selectstring_sender != NULL;
344 const pcre *selectstring_regex = NULL;
345 const pcre *selectstring_regex_sender = NULL;
346 uschar *log_detail = NULL;
347 int subcount = 0;
348 uschar subdirs[64];
349
350 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
351 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
352 gets set. Save the queue_runner's pid and the flag that indicates any
353 deliveries run directly from this process. Deliveries that are run by handing
354 on TCP/IP channels have queue_run_pid set, but not queue_running. */
355
356 queue_domains = NULL;
357 queue_smtp_domains = NULL;
358 f.queue_smtp = f.queue_2stage;
359
360 queue_run_pid = getpid();
361 f.queue_running = TRUE;
362
363 /* Log the true start of a queue run, and fancy options */
364
365 if (!recurse)
366 {
367 uschar extras[8];
368 uschar *p = extras;
369
370 if (f.queue_2stage) *p++ = 'q';
371 if (f.queue_run_first_delivery) *p++ = 'i';
372 if (f.queue_run_force) *p++ = 'f';
373 if (f.deliver_force_thaw) *p++ = 'f';
374 if (f.queue_run_local) *p++ = 'l';
375 *p = 0;
376
377 p = big_buffer;
378 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
379
380 if (extras[0] != 0)
381 p += sprintf(CS p, " -q%s", extras);
382
383 if (deliver_selectstring)
384 p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "",
385 deliver_selectstring);
386
387 if (deliver_selectstring_sender)
388 p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "",
389 deliver_selectstring_sender);
390
391 log_detail = string_copy(big_buffer);
392 if (*queue_name)
393 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
394 queue_name, log_detail);
395 else
396 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
397 }
398
399 /* If deliver_selectstring is a regex, compile it. */
400
401 if (deliver_selectstring && f.deliver_selectstring_regex)
402 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
403
404 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
405 selectstring_regex_sender =
406 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
407
408 /* If the spool is split into subdirectories, we want to process it one
409 directory at a time, so as to spread out the directory scanning and the
410 delivering when there are lots of messages involved, except when
411 queue_run_in_order is set.
412
413 In the random order case, this loop runs once for the main directory (handling
414 any messages therein), and then repeats for any subdirectories that were found.
415 When the first argument of queue_get_spool_list() is 0, it scans the top
416 directory, fills in subdirs, and sets subcount. The order of the directories is
417 then randomized after the first time through, before they are scanned in
418 subsequent iterations.
419
420 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
421 order), it scans all directories and makes a single message list. */
422
423 for (int i = queue_run_in_order ? -1 : 0;
424 i <= (queue_run_in_order ? -1 : subcount);
425 i++)
426 {
427 rmark reset_point1 = store_mark();
428
429 DEBUG(D_queue_run)
430 {
431 if (i == 0)
432 debug_printf("queue running main directory\n");
433 else if (i == -1)
434 debug_printf("queue running combined directories\n");
435 else
436 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
437 }
438
439 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
440 !queue_run_in_order);
441 fq; fq = fq->next)
442 {
443 pid_t pid;
444 int status;
445 int pfd[2];
446 struct stat statbuf;
447 uschar buffer[256];
448
449 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
450 check that the load average is low enough to permit deliveries. */
451
452 if (!f.queue_run_force && deliver_queue_load_max >= 0)
453 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
454 {
455 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
456 log_detail,
457 (double)load_average/1000.0,
458 (double)deliver_queue_load_max/1000.0);
459 i = subcount; /* Don't process other directories */
460 break;
461 }
462 else
463 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
464 (double)load_average/1000.0,
465 (double)deliver_queue_load_max/1000.0);
466
467 /* Skip this message unless it's within the ID limits */
468
469 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
470 continue;
471 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
472 continue;
473
474 /* Check that the message still exists */
475
476 message_subdir[0] = fq->dir_uschar;
477 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
478 continue;
479
480 /* There are some tests that require the reading of the header file. Ensure
481 the store used is scavenged afterwards so that this process doesn't keep
482 growing its store. We have to read the header file again when actually
483 delivering, but it's cheaper than forking a delivery process for each
484 message when many are not going to be delivered. */
485
486 if (deliver_selectstring || deliver_selectstring_sender ||
487 f.queue_run_first_delivery)
488 {
489 BOOL wanted = TRUE;
490 BOOL orig_dont_deliver = f.dont_deliver;
491 rmark reset_point2 = store_mark();
492
493 /* Restore the original setting of dont_deliver after reading the header,
494 so that a setting for a particular message doesn't force it for any that
495 follow. If the message is chosen for delivery, the header is read again
496 in the deliver_message() function, in a subprocess. */
497
498 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) continue;
499 f.dont_deliver = orig_dont_deliver;
500
501 /* Now decide if we want to deliver this message. As we have read the
502 header file, we might as well do the freeze test now, and save forking
503 another process. */
504
505 if (f.deliver_freeze && !f.deliver_force_thaw)
506 {
507 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
508 wanted = FALSE;
509 }
510
511 /* Check first_delivery in the case when there are no message logs. */
512
513 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
514 {
515 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
516 wanted = FALSE;
517 }
518
519 /* Check for a matching address if deliver_selectstring[_sender] is set.
520 If so, we do a fully delivery - don't want to omit other addresses since
521 their routing might trigger re-writing etc. */
522
523 /* Sender matching */
524
525 else if ( deliver_selectstring_sender
526 && !(f.deliver_selectstring_sender_regex
527 ? (pcre_exec(selectstring_regex_sender, NULL,
528 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
529 NULL, 0) >= 0)
530 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
531 != NULL)
532 ) )
533 {
534 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
535 fq->text, deliver_selectstring_sender);
536 wanted = FALSE;
537 }
538
539 /* Recipient matching */
540
541 else if (deliver_selectstring)
542 {
543 int i;
544 for (i = 0; i < recipients_count; i++)
545 {
546 uschar *address = recipients_list[i].address;
547 if ( (f.deliver_selectstring_regex
548 ? (pcre_exec(selectstring_regex, NULL, CS address,
549 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
550 : (strstric(address, deliver_selectstring, FALSE) != NULL)
551 )
552 && tree_search(tree_nonrecipients, address) == NULL
553 )
554 break;
555 }
556
557 if (i >= recipients_count)
558 {
559 DEBUG(D_queue_run)
560 debug_printf("%s: no recipient address matched %s\n",
561 fq->text, deliver_selectstring);
562 wanted = FALSE;
563 }
564 }
565
566 /* Recover store used when reading the header */
567
568 spool_clear_header_globals();
569 store_reset(reset_point2);
570 if (!wanted) continue; /* With next message */
571 }
572
573 /* OK, got a message we want to deliver. Create a pipe which will
574 serve as a means of detecting when all the processes created by the
575 delivery process are finished. This is relevant when the delivery
576 process passes one or more SMTP channels on to its own children. The
577 pipe gets passed down; by reading on it here we detect when the last
578 descendent dies by the unblocking of the read. It's a pity that for
579 most of the time the pipe isn't used, but creating a pipe should be
580 pretty cheap. */
581
582 if (pipe(pfd) < 0)
583 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
584 "runner process %d: %s", queue_run_pid, strerror(errno));
585 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
586
587 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
588 safe side... */
589
590 if (queue_run_pipe == 0)
591 {
592 queue_run_pipe = dup(queue_run_pipe);
593 (void)close(0);
594 }
595
596 /* Before forking to deliver the message, ensure any open and cached
597 lookup files or databases are closed. Otherwise, closing in the subprocess
598 can make the next subprocess have problems. There won't often be anything
599 open here, but it is possible (e.g. if spool_directory is an expanded
600 string). A single call before this loop would probably suffice, but just in
601 case expansions get inserted at some point, I've taken the heavy-handed
602 approach. When nothing is open, the call should be cheap. */
603
604 search_tidyup();
605
606 /* Now deliver the message; get the id by cutting the -H off the file
607 name. The return of the process is zero if a delivery was attempted. */
608
609 set_process_info("running queue: %s", fq->text);
610 fq->text[SPOOL_NAME_LENGTH-2] = 0;
611 if ((pid = fork()) == 0)
612 {
613 int rc;
614 if (f.running_in_test_harness) millisleep(100);
615 (void)close(pfd[pipe_read]);
616 rc = deliver_message(fq->text, force_delivery, FALSE);
617 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED);
618 }
619 if (pid < 0)
620 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
621 "queue runner %d failed\n", queue_run_pid);
622
623 /* Close the writing end of the synchronizing pipe in this process,
624 then wait for the first level process to terminate. */
625
626 (void)close(pfd[pipe_write]);
627 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
628 while (wait(&status) != pid);
629
630 /* A zero return means a delivery was attempted; turn off the force flag
631 for any subsequent calls unless queue_force is set. */
632
633 if ((status & 0xffff) == 0) force_delivery = f.queue_run_force;
634
635 /* If the process crashed, tell somebody */
636
637 else if ((status & 0x00ff) != 0)
638 log_write(0, LOG_MAIN|LOG_PANIC,
639 "queue run: process %d crashed with signal %d while delivering %s",
640 (int)pid, status & 0x00ff, fq->text);
641
642 /* Before continuing, wait till the pipe gets closed at the far end. This
643 tells us that any children created by the delivery to re-use any SMTP
644 channels have all finished. Since no process actually writes to the pipe,
645 the mere fact that read() unblocks is enough. */
646
647 set_process_info("running queue: waiting for children of %d", pid);
648 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
649 log_write(0, LOG_MAIN|LOG_PANIC, "queue run: %s on pipe",
650 status > 0 ? "unexpected data" : "error");
651 (void)close(pfd[pipe_read]);
652 set_process_info("running queue");
653
654 /* If we are in the test harness, and this is not the first of a 2-stage
655 queue run, update fudged queue times. */
656
657 if (f.running_in_test_harness && !f.queue_2stage)
658 {
659 uschar *fqtnext = Ustrchr(fudged_queue_times, '/');
660 if (fqtnext != NULL) fudged_queue_times = fqtnext + 1;
661 }
662 } /* End loop for list of messages */
663
664 tree_nonrecipients = NULL;
665 store_reset(reset_point1); /* Scavenge list of messages */
666
667 /* If this was the first time through for random order processing, and
668 sub-directories have been found, randomize their order if necessary. */
669
670 if (i == 0 && subcount > 1 && !queue_run_in_order)
671 for (int j = 1; j <= subcount; j++)
672 {
673 int r;
674 if ((r = random_number(100)) >= 50)
675 {
676 int k = (r % subcount) + 1;
677 int x = subdirs[j];
678 subdirs[j] = subdirs[k];
679 subdirs[k] = x;
680 }
681 }
682 } /* End loop for multiple directories */
683
684 /* If queue_2stage is true, we do it all again, with the 2stage flag
685 turned off. */
686
687 if (f.queue_2stage)
688 {
689 f.queue_2stage = FALSE;
690 queue_run(start_id, stop_id, TRUE);
691 }
692
693 /* At top level, log the end of the run. */
694
695 if (!recurse)
696 if (*queue_name)
697 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
698 queue_name, log_detail);
699 else
700 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
701 }
702
703
704
705
706 /************************************************
707 * Count messages on the queue *
708 ************************************************/
709
710 /* Called as a result of -bpc
711
712 Arguments: none
713 Returns: nothing
714 */
715
716 void
717 queue_count(void)
718 {
719 int subcount;
720 int count = 0;
721 uschar subdirs[64];
722
723 for (queue_filename *f = queue_get_spool_list(
724 -1, /* entire queue */
725 subdirs, /* for holding sub list */
726 &subcount, /* for subcount */
727 FALSE); /* not random */
728 f; f = f->next) count++;
729 fprintf(stdout, "%d\n", count);
730 }
731
732
733
734 /************************************************
735 * List extra deliveries *
736 ************************************************/
737
738 /* This is called from queue_list below to print out all addresses that
739 have received a message but which were not primary addresses. That is, all
740 the addresses in the tree of non-recipients that are not primary addresses.
741 The tree has been scanned and the data field filled in for those that are
742 primary addresses.
743
744 Argument: points to the tree node
745 Returns: nothing
746 */
747
748 static void
749 queue_list_extras(tree_node *p)
750 {
751 if (p->left) queue_list_extras(p->left);
752 if (!p->data.val) printf(" +D %s\n", p->name);
753 if (p->right) queue_list_extras(p->right);
754 }
755
756
757
758 /************************************************
759 * List messages on the queue *
760 ************************************************/
761
762 /* Or a given list of messages. In the "all" case, we get a list of file names
763 as quickly as possible, then scan each one for information to output. If any
764 disappear while we are processing, just leave them out, but give an error if an
765 explicit list was given. This function is a top-level function that is obeyed
766 as a result of the -bp argument. As there may be a lot of messages on the
767 queue, we must tidy up the store after reading the headers for each one.
768
769 Arguments:
770 option 0 => list top-level recipients, with "D" for those delivered
771 1 => list only undelivered top-level recipients
772 2 => as 0, plus any generated delivered recipients
773 If 8 is added to any of these values, the queue is listed in
774 random order.
775 list => first of any message ids to list
776 count count of message ids; 0 => all
777
778 Returns: nothing
779 */
780
781 void
782 queue_list(int option, uschar **list, int count)
783 {
784 int subcount;
785 int now = (int)time(NULL);
786 rmark reset_point;
787 queue_filename * qf = NULL;
788 uschar subdirs[64];
789
790 /* If given a list of messages, build a chain containing their ids. */
791
792 if (count > 0)
793 {
794 queue_filename *last = NULL;
795 for (int i = 0; i < count; i++)
796 {
797 queue_filename *next =
798 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
799 sprintf(CS next->text, "%s-H", list[i]);
800 next->dir_uschar = '*';
801 next->next = NULL;
802 if (i == 0) qf = next; else last->next = next;
803 last = next;
804 }
805 }
806
807 /* Otherwise get a list of the entire queue, in order if necessary. */
808
809 else
810 qf = queue_get_spool_list(
811 -1, /* entire queue */
812 subdirs, /* for holding sub list */
813 &subcount, /* for subcount */
814 option >= 8); /* randomize if required */
815
816 if (option >= 8) option -= 8;
817
818 /* Now scan the chain and print information, resetting store used
819 each time. */
820
821 for (;
822 qf && (reset_point = store_mark());
823 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
824 )
825 {
826 int rc, save_errno;
827 int size = 0;
828 BOOL env_read;
829
830 message_size = 0;
831 message_subdir[0] = qf->dir_uschar;
832 rc = spool_read_header(qf->text, FALSE, count <= 0);
833 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
834 continue;
835 save_errno = errno;
836
837 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
838
839 if (env_read)
840 {
841 int i, ptr;
842 FILE *jread;
843 struct stat statbuf;
844 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
845
846 ptr = Ustrlen(fname)-1;
847 fname[ptr] = 'D';
848
849 /* Add the data size to the header size; don't count the file name
850 at the start of the data file, but add one for the notional blank line
851 that precedes the data. */
852
853 if (Ustat(fname, &statbuf) == 0)
854 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
855 i = (now - received_time.tv_sec)/60; /* minutes on queue */
856 if (i > 90)
857 {
858 i = (i + 30)/60;
859 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
860 }
861 else printf("%2dm ", i);
862
863 /* Collect delivered addresses from any J file */
864
865 fname[ptr] = 'J';
866 if ((jread = Ufopen(fname, "rb")))
867 {
868 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
869 {
870 int n = Ustrlen(big_buffer);
871 big_buffer[n-1] = 0;
872 tree_add_nonrecipient(big_buffer);
873 }
874 (void)fclose(jread);
875 }
876 }
877
878 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
879 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
880
881 if (env_read && sender_address)
882 {
883 printf(" <%s>", sender_address);
884 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
885 }
886
887 if (rc != spool_read_OK)
888 {
889 printf("\n ");
890 if (save_errno == ERRNO_SPOOLFORMAT)
891 {
892 struct stat statbuf;
893 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
894
895 if (Ustat(fname, &statbuf) == 0)
896 printf("*** spool format error: size=" OFF_T_FMT " ***",
897 statbuf.st_size);
898 else printf("*** spool format error ***");
899 }
900 else printf("*** spool read error: %s ***", strerror(save_errno));
901 if (rc != spool_read_hdrerror)
902 {
903 printf("\n\n");
904 continue;
905 }
906 }
907
908 if (f.deliver_freeze) printf(" *** frozen ***");
909
910 printf("\n");
911
912 if (recipients_list)
913 {
914 for (int i = 0; i < recipients_count; i++)
915 {
916 tree_node *delivered =
917 tree_search(tree_nonrecipients, recipients_list[i].address);
918 if (!delivered || option != 1)
919 printf(" %s %s\n",
920 delivered ? "D" : " ", recipients_list[i].address);
921 if (delivered) delivered->data.val = TRUE;
922 }
923 if (option == 2 && tree_nonrecipients)
924 queue_list_extras(tree_nonrecipients);
925 printf("\n");
926 }
927 }
928 }
929
930
931
932 /*************************************************
933 * Act on a specific message *
934 *************************************************/
935
936 /* Actions that require a list of addresses make use of argv/argc/
937 recipients_arg. Other actions do not. This function does its own
938 authority checking.
939
940 Arguments:
941 id id of the message to work on
942 action which action is required (MSG_xxx)
943 argv the original argv for Exim
944 argc the original argc for Exim
945 recipients_arg offset to the list of recipients in argv
946
947 Returns: FALSE if there was any problem
948 */
949
950 BOOL
951 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
952 {
953 BOOL yield = TRUE;
954 BOOL removed = FALSE;
955 struct passwd *pw;
956 uschar *doing = NULL;
957 uschar *username;
958 uschar *errmsg;
959 uschar spoolname[32];
960
961 /* Set the global message_id variable, used when re-writing spool files. This
962 also causes message ids to be added to log messages. */
963
964 Ustrcpy(message_id, id);
965
966 /* The "actions" that just list the files do not require any locking to be
967 done. Only admin users may read the spool files. */
968
969 if (action >= MSG_SHOW_BODY)
970 {
971 int fd, rc;
972 uschar *subdirectory, *suffix;
973
974 if (!f.admin_user)
975 {
976 printf("Permission denied\n");
977 return FALSE;
978 }
979
980 if (recipients_arg < argc)
981 {
982 printf("*** Only one message can be listed at once\n");
983 return FALSE;
984 }
985
986 if (action == MSG_SHOW_BODY)
987 {
988 subdirectory = US"input";
989 suffix = US"-D";
990 }
991 else if (action == MSG_SHOW_HEADER)
992 {
993 subdirectory = US"input";
994 suffix = US"-H";
995 }
996 else
997 {
998 subdirectory = US"msglog";
999 suffix = US"";
1000 }
1001
1002 for (int i = 0; i < 2; i++)
1003 {
1004 set_subdir_str(message_subdir, id, i);
1005 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1006 O_RDONLY, 0)) >= 0)
1007 break;
1008 if (i == 0)
1009 continue;
1010
1011 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1012 strerror(errno));
1013 if (action == MSG_SHOW_LOG && !message_logs)
1014 printf("(No message logs are being created because the message_logs "
1015 "option is false.)\n");
1016 return FALSE;
1017 }
1018
1019 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1020 rc = write(fileno(stdout), big_buffer, rc);
1021
1022 (void)close(fd);
1023 return TRUE;
1024 }
1025
1026 /* For actions that actually act, open and lock the data file to ensure that no
1027 other process is working on this message. If the file does not exist, continue
1028 only if the action is remove and the user is an admin user, to allow for
1029 tidying up broken states. */
1030
1031 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1032 if (errno == ENOENT)
1033 {
1034 yield = FALSE;
1035 printf("Spool data file for %s does not exist\n", id);
1036 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1037 printf("Continuing, to ensure all files removed\n");
1038 }
1039 else
1040 {
1041 if (errno == 0) printf("Message %s is locked\n", id);
1042 else printf("Couldn't open spool file for %s: %s\n", id,
1043 strerror(errno));
1044 return FALSE;
1045 }
1046
1047 /* Read the spool header file for the message. Again, continue after an
1048 error only in the case of deleting by an administrator. Setting the third
1049 argument false causes it to look both in the main spool directory and in
1050 the appropriate subdirectory, and set message_subdir according to where it
1051 found the message. */
1052
1053 sprintf(CS spoolname, "%s-H", id);
1054 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1055 {
1056 yield = FALSE;
1057 if (errno != ERRNO_SPOOLFORMAT)
1058 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1059 else
1060 printf("Spool format error for %s\n", spoolname);
1061 if (action != MSG_REMOVE || !f.admin_user)
1062 {
1063 (void)close(deliver_datafile);
1064 deliver_datafile = -1;
1065 return FALSE;
1066 }
1067 printf("Continuing to ensure all files removed\n");
1068 }
1069
1070 /* Check that the user running this process is entitled to operate on this
1071 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1072 mess about, but the original sender is permitted to remove a message. That's
1073 why we leave this check until after the headers are read. */
1074
1075 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1076 {
1077 printf("Permission denied\n");
1078 (void)close(deliver_datafile);
1079 deliver_datafile = -1;
1080 return FALSE;
1081 }
1082
1083 /* Set up the user name for logging. */
1084
1085 pw = getpwuid(real_uid);
1086 username = (pw != NULL)?
1087 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1088
1089 /* Take the necessary action. */
1090
1091 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1092
1093 switch(action)
1094 {
1095 case MSG_SHOW_COPY:
1096 {
1097 transport_ctx tctx = {{0}};
1098 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1099 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1100 tctx.u.fd = 1;
1101 (void) transport_write_message(&tctx, 0);
1102 break;
1103 }
1104
1105
1106 case MSG_FREEZE:
1107 if (f.deliver_freeze)
1108 {
1109 yield = FALSE;
1110 printf("is already frozen\n");
1111 }
1112 else
1113 {
1114 f.deliver_freeze = TRUE;
1115 f.deliver_manual_thaw = FALSE;
1116 deliver_frozen_at = time(NULL);
1117 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1118 {
1119 printf("is now frozen\n");
1120 log_write(0, LOG_MAIN, "frozen by %s", username);
1121 }
1122 else
1123 {
1124 yield = FALSE;
1125 printf("could not be frozen: %s\n", errmsg);
1126 }
1127 }
1128 break;
1129
1130
1131 case MSG_THAW:
1132 if (!f.deliver_freeze)
1133 {
1134 yield = FALSE;
1135 printf("is not frozen\n");
1136 }
1137 else
1138 {
1139 f.deliver_freeze = FALSE;
1140 f.deliver_manual_thaw = TRUE;
1141 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1142 {
1143 printf("is no longer frozen\n");
1144 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1145 }
1146 else
1147 {
1148 yield = FALSE;
1149 printf("could not be unfrozen: %s\n", errmsg);
1150 }
1151 }
1152 break;
1153
1154
1155 /* We must ensure all files are removed from both the input directory
1156 and the appropriate subdirectory, to clean up cases when there are odd
1157 files left lying around in odd places. In the normal case message_subdir
1158 will have been set correctly by spool_read_header, but as this is a rare
1159 operation, just run everything twice. */
1160
1161 case MSG_REMOVE:
1162 {
1163 uschar suffix[3];
1164
1165 suffix[0] = '-';
1166 suffix[2] = 0;
1167 message_subdir[0] = id[5];
1168
1169 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1170 {
1171 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1172
1173 DEBUG(D_any) debug_printf(" removing %s", fname);
1174 if (Uunlink(fname) < 0)
1175 {
1176 if (errno != ENOENT)
1177 {
1178 yield = FALSE;
1179 printf("Error while removing %s: %s\n", fname, strerror(errno));
1180 }
1181 else DEBUG(D_any) debug_printf(" (no file)\n");
1182 }
1183 else
1184 {
1185 removed = TRUE;
1186 DEBUG(D_any) debug_printf(" (ok)\n");
1187 }
1188
1189 for (int i = 0; i < 3; i++)
1190 {
1191 uschar * fname;
1192
1193 suffix[1] = (US"DHJ")[i];
1194 fname = spool_fname(US"input", message_subdir, id, suffix);
1195
1196 DEBUG(D_any) debug_printf(" removing %s", fname);
1197 if (Uunlink(fname) < 0)
1198 {
1199 if (errno != ENOENT)
1200 {
1201 yield = FALSE;
1202 printf("Error while removing %s: %s\n", fname, strerror(errno));
1203 }
1204 else DEBUG(D_any) debug_printf(" (no file)\n");
1205 }
1206 else
1207 {
1208 removed = TRUE;
1209 DEBUG(D_any) debug_printf(" (done)\n");
1210 }
1211 }
1212 }
1213
1214 /* In the common case, the datafile is open (and locked), so give the
1215 obvious message. Otherwise be more specific. */
1216
1217 if (deliver_datafile >= 0) printf("has been removed\n");
1218 else printf("has been removed or did not exist\n");
1219 if (removed)
1220 {
1221 #ifndef DISABLE_EVENT
1222 if (event_action) for (int i = 0; i < recipients_count; i++)
1223 {
1224 tree_node *delivered =
1225 tree_search(tree_nonrecipients, recipients_list[i].address);
1226 if (!delivered)
1227 {
1228 uschar * save_local = deliver_localpart;
1229 const uschar * save_domain = deliver_domain;
1230 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1231 int start, end, dom;
1232
1233 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1234 log_write(0, LOG_MAIN|LOG_PANIC,
1235 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1236 else
1237 {
1238 deliver_localpart =
1239 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1240 deliver_domain = dom
1241 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1242
1243 event_raise(event_action, US"msg:fail:internal",
1244 string_sprintf("message removed by %s", username));
1245
1246 deliver_localpart = save_local;
1247 deliver_domain = save_domain;
1248 }
1249 }
1250 }
1251 (void) event_raise(event_action, US"msg:complete", NULL);
1252 #endif
1253 log_write(0, LOG_MAIN, "removed by %s", username);
1254 log_write(0, LOG_MAIN, "Completed");
1255 }
1256 break;
1257 }
1258
1259
1260 case MSG_MARK_ALL_DELIVERED:
1261 for (int i = 0; i < recipients_count; i++)
1262 tree_add_nonrecipient(recipients_list[i].address);
1263
1264 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1265 {
1266 printf("has been modified\n");
1267 for (int i = 0; i < recipients_count; i++)
1268 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1269 recipients_list[i].address, username);
1270 }
1271 else
1272 {
1273 yield = FALSE;
1274 printf("- could not mark all delivered: %s\n", errmsg);
1275 }
1276 break;
1277
1278
1279 case MSG_EDIT_SENDER:
1280 if (recipients_arg < argc - 1)
1281 {
1282 yield = FALSE;
1283 printf("- only one sender address can be specified\n");
1284 break;
1285 }
1286 doing = US"editing sender";
1287 /* Fall through */
1288
1289 case MSG_ADD_RECIPIENT:
1290 if (doing == NULL) doing = US"adding recipient";
1291 /* Fall through */
1292
1293 case MSG_MARK_DELIVERED:
1294 if (doing == NULL) doing = US"marking as delivered";
1295
1296 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1297
1298 if (recipients_arg >= argc)
1299 {
1300 yield = FALSE;
1301 printf("- error while %s: no address given\n", doing);
1302 break;
1303 }
1304
1305 for (; recipients_arg < argc; recipients_arg++)
1306 {
1307 int start, end, domain;
1308 uschar *errmess;
1309 uschar *recipient =
1310 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1311 &domain, (action == MSG_EDIT_SENDER));
1312
1313 if (recipient == NULL)
1314 {
1315 yield = FALSE;
1316 printf("- error while %s:\n bad address %s: %s\n",
1317 doing, argv[recipients_arg], errmess);
1318 }
1319 else if (recipient[0] != 0 && domain == 0)
1320 {
1321 yield = FALSE;
1322 printf("- error while %s:\n bad address %s: "
1323 "domain missing\n", doing, argv[recipients_arg]);
1324 }
1325 else
1326 {
1327 if (action == MSG_ADD_RECIPIENT)
1328 {
1329 #ifdef SUPPORT_I18N
1330 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1331 #endif
1332 receive_add_recipient(recipient, -1);
1333 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1334 recipient, username);
1335 }
1336 else if (action == MSG_MARK_DELIVERED)
1337 {
1338 int i;
1339 for (i = 0; i < recipients_count; i++)
1340 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1341 if (i >= recipients_count)
1342 {
1343 printf("- error while %s:\n %s is not a recipient:"
1344 " message not updated\n", doing, recipient);
1345 yield = FALSE;
1346 }
1347 else
1348 {
1349 tree_add_nonrecipient(recipients_list[i].address);
1350 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1351 recipient, username);
1352 }
1353 }
1354 else /* MSG_EDIT_SENDER */
1355 {
1356 #ifdef SUPPORT_I18N
1357 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1358 #endif
1359 sender_address = recipient;
1360 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1361 recipient, username);
1362 }
1363 }
1364 }
1365
1366 if (yield)
1367 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1368 printf("has been modified\n");
1369 else
1370 {
1371 yield = FALSE;
1372 printf("- while %s: %s\n", doing, errmsg);
1373 }
1374
1375 break;
1376 }
1377
1378 /* Closing the datafile releases the lock and permits other processes
1379 to operate on the message (if it still exists). */
1380
1381 if (deliver_datafile >= 0)
1382 {
1383 (void)close(deliver_datafile);
1384 deliver_datafile = -1;
1385 }
1386 return yield;
1387 }
1388
1389
1390
1391 /*************************************************
1392 * Check the queue_only_file condition *
1393 *************************************************/
1394
1395 /* The queue_only_file option forces certain kinds of queueing if a given file
1396 exists.
1397
1398 Arguments: none
1399 Returns: nothing
1400 */
1401
1402 void
1403 queue_check_only(void)
1404 {
1405 int sep = 0;
1406 struct stat statbuf;
1407 const uschar *s;
1408 uschar *ss;
1409 uschar buffer[1024];
1410
1411 if (queue_only_file == NULL) return;
1412
1413 s = queue_only_file;
1414 while ((ss = string_nextinlist(&s, &sep, buffer, sizeof(buffer))) != NULL)
1415 {
1416 if (Ustrncmp(ss, "smtp", 4) == 0)
1417 {
1418 ss += 4;
1419 if (Ustat(ss, &statbuf) == 0)
1420 {
1421 f.queue_smtp = TRUE;
1422 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1423 }
1424 }
1425 else
1426 {
1427 if (Ustat(ss, &statbuf) == 0)
1428 {
1429 queue_only = TRUE;
1430 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1431 }
1432 }
1433 }
1434 }
1435
1436 #endif /*!COMPILE_UTILITY*/
1437
1438 /* End of queue.c */