1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions that operate on the input queue. */
20 #ifndef COMPILE_UTILITY
22 /* The number of nodes to use for the bottom-up merge sort when a list of queue
23 items is to be ordered. The code for this sort was contributed as a patch by
26 #define LOG2_MAXNODES 32
30 static BOOL queue_tls_init = FALSE;
33 /*************************************************
34 * Helper sort function for queue_get_spool_list *
35 *************************************************/
37 /* This function is used when sorting the queue list in the function
38 queue_get_spool_list() below.
41 a points to an ordered list of queue_filename items
42 b points to another ordered list
44 Returns: a pointer to a merged ordered list
47 static queue_filename *
48 merge_queue_lists(queue_filename *a, queue_filename *b)
50 queue_filename *first = NULL;
51 queue_filename **append = &first;
56 if ((d = Ustrncmp(a->text, b->text, 6)) == 0)
57 d = Ustrcmp(a->text + 14, b->text + 14);
80 /*************************************************
81 * Get list of spool files *
82 *************************************************/
84 /* Scan the spool directory and return a list of the relevant file names
85 therein. Single-character sub-directories are handled as follows:
87 If the first argument is > 0, a sub-directory is scanned; the letter is
88 taken from the nth entry in subdirs.
90 If the first argument is 0, sub-directories are not scanned. However, a
91 list of them is returned.
93 If the first argument is < 0, sub-directories are scanned for messages,
94 and a single, unified list is created. The returned data blocks contain the
95 identifying character of the subdirectory, if any. The subdirs vector is
96 still required as an argument.
98 If the randomize argument is TRUE, messages are returned in "randomized" order.
99 Actually, the order is anything but random, but the algorithm is cheap, and the
100 point is simply to ensure that the same order doesn't occur every time, in case
101 a particular message is causing a remote MTA to barf - we would like to try
102 other messages to that MTA first.
104 If the randomize argument is FALSE, sort the list according to the file name.
105 This should give the order in which the messages arrived. It is normally used
106 only for presentation to humans, in which case the (possibly expensive) sort
107 that it does is not part of the normal operational code. However, if
108 queue_run_in_order is set, sorting has to take place for queue runs as well.
109 When randomize is FALSE, the first argument is normally -1, so all messages are
113 subdiroffset sub-directory character offset, or 0 or -1 (see above)
114 subdirs vector to store list of subdirchars
115 subcount pointer to int in which to store count of subdirs
116 randomize TRUE if the order of the list is to be unpredictable
117 pcount If not NULL, fill in with count of files and do not return list
119 Returns: pointer to a chain of queue name items
122 static queue_filename *
123 queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount,
124 BOOL randomize, unsigned * pcount)
130 queue_filename *yield = NULL;
131 queue_filename *last = NULL;
133 queue_filename *root[LOG2_MAXNODES];
135 /* When randomizing, the file names are added to the start or end of the list
136 according to the bits of the flags variable. Get a collection of bits from the
137 current time. Use the bottom 16 and just keep re-using them if necessary. When
138 not randomizing, initialize the sublists for the bottom-up merge sort. */
143 resetflags = time(NULL) & 0xFFFF;
145 for (i = 0; i < LOG2_MAXNODES; i++)
148 /* If processing the full queue, or just the top-level, start at the base
149 directory, and initialize the first subdirectory name (as none). Otherwise,
150 start at the sub-directory offset. */
152 if (subdiroffset <= 0)
161 /* Set up prototype for the directory name. */
163 spool_pname_buf(buffer, sizeof(buffer));
164 buffer[sizeof(buffer) - 3] = 0;
165 subptr = Ustrlen(buffer);
166 buffer[subptr+2] = 0; /* terminator for lengthened name */
168 /* This loop runs at least once, for the main or given directory, and then as
169 many times as necessary to scan any subdirectories encountered in the main
170 directory, if they are to be scanned at this time. */
172 for (; i <= *subcount; i++)
175 int subdirchar = subdirs[i]; /* 0 for main directory */
180 buffer[subptr] = '/';
181 buffer[subptr+1] = subdirchar;
184 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
185 if (!(dd = exim_opendir(buffer)))
188 /* Now scan the directory. */
190 for (struct dirent *ent; ent = readdir(dd); )
192 uschar *name = US ent->d_name;
193 int len = Ustrlen(name);
199 /* If we find a single alphameric sub-directory in the base directory,
200 add it to the list for subsequent scans. */
202 if (i == 0 && len == 1 && isalnum(*name))
204 *subcount = *subcount + 1;
205 subdirs[*subcount] = *name;
209 /* Otherwise, if it is a header spool file, add it to the list */
211 if (len == SPOOL_NAME_LENGTH &&
212 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
217 queue_filename *next =
218 store_get(sizeof(queue_filename) + Ustrlen(name), is_tainted(name));
219 Ustrcpy(next->text, name);
220 next->dir_uschar = subdirchar;
222 /* Handle the creation of a randomized list. The first item becomes both
223 the top and bottom of the list. Subsequent items are inserted either at
224 the top or the bottom, randomly. This is, I argue, faster than doing a
225 sort by allocating a random number to each item, and it also saves having
226 to store the number with each item. */
238 if ((flags & 1) == 0)
252 /* Otherwise do a bottom-up merge sort based on the name. */
257 for (int j = 0; j < LOG2_MAXNODES; j++)
260 next = merge_queue_lists(next, root[j]);
261 root[j] = j == LOG2_MAXNODES - 1 ? next : NULL;
272 /* Finished with this directory */
276 /* If we have just scanned a sub-directory, and it was empty (count == 2
277 implies just "." and ".." entries), and Exim is no longer configured to
278 use sub-directories, attempt to get rid of it. At the same time, try to
279 get rid of any corresponding msglog subdirectory. These are just cosmetic
280 tidying actions, so just ignore failures. If we are scanning just a single
281 sub-directory, break the loop. */
285 if (!split_spool_directory && count <= 2)
290 subdir[0] = subdirchar; subdir[1] = 0;
291 rmdir(CS spool_dname(US"msglog", subdir));
293 if (subdiroffset > 0) break; /* Single sub-directory */
296 /* If we have just scanned the base directory, and subdiroffset is 0,
297 we do not want to continue scanning the sub-directories. */
299 else if (subdiroffset == 0)
301 } /* Loop for multiple subdirectories */
303 /* When using a bottom-up merge sort, do the final merging of the sublists.
304 Then pass back the final list of file items. */
306 if (!pcount && !randomize)
307 for (i = 0; i < LOG2_MAXNODES; ++i)
308 yield = merge_queue_lists(yield, root[i]);
316 /*************************************************
317 * Perform a queue run *
318 *************************************************/
320 /* The arguments give the messages to start and stop at; NULL means start at
321 the beginning or stop at the end. If the given start message doesn't exist, we
322 start at the next lexically greater one, and likewise we stop at the after the
323 previous lexically lesser one if the given stop message doesn't exist. Because
324 a queue run can take some time, stat each file before forking, in case it has
325 been delivered in the meantime by some other means.
327 The global variables queue_run_force and queue_run_local may be set to cause
328 forced deliveries or local-only deliveries, respectively.
330 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
331 not contain the string. As this option is typically used when a machine comes
332 back online, we want to ensure that at least one delivery attempt takes place,
333 so force the first one. The selecting string can optionally be a regex, or
334 refer to the sender instead of recipients.
336 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
337 is set so that routing is done for all messages. Thus in the second run those
338 that are routed to the same host should go down the same SMTP connection.
341 start_id message id to start at, or NULL for all
342 stop_id message id to end at, or NULL for all
343 recurse TRUE if recursing for 2-stage run
349 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
351 BOOL force_delivery = f.queue_run_force || deliver_selectstring != NULL ||
352 deliver_selectstring_sender != NULL;
353 const pcre *selectstring_regex = NULL;
354 const pcre *selectstring_regex_sender = NULL;
355 uschar *log_detail = NULL;
358 pid_t qpid[4] = {0}; /* Parallelism factor for q2stage 1st phase */
359 BOOL single_id = FALSE;
361 #ifdef MEASURE_TIMING
362 report_time_since(×tamp_startup, US"queue_run start");
365 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
366 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
367 gets set. Save the queue_runner's pid and the flag that indicates any
368 deliveries run directly from this process. Deliveries that are run by handing
369 on TCP/IP channels have queue_run_pid set, but not queue_running. */
371 queue_domains = NULL;
372 queue_smtp_domains = NULL;
373 f.queue_smtp = f.queue_2stage;
375 queue_run_pid = getpid();
376 f.queue_running = TRUE;
378 /* Log the true start of a queue run, and fancy options */
385 if (f.queue_2stage) *p++ = 'q';
386 if (f.queue_run_first_delivery) *p++ = 'i';
387 if (f.queue_run_force) *p++ = 'f';
388 if (f.deliver_force_thaw) *p++ = 'f';
389 if (f.queue_run_local) *p++ = 'l';
393 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
396 p += sprintf(CS p, " -q%s", extras);
398 if (deliver_selectstring)
400 snprintf(CS p, big_buffer_size - (p - big_buffer), " -R%s %s",
401 f.deliver_selectstring_regex? "r" : "", deliver_selectstring);
405 if (deliver_selectstring_sender)
407 snprintf(CS p, big_buffer_size - (p - big_buffer), " -S%s %s",
408 f.deliver_selectstring_sender_regex? "r" : "", deliver_selectstring_sender);
412 log_detail = string_copy(big_buffer);
414 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
415 queue_name, log_detail);
417 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
419 single_id = start_id && stop_id && !f.queue_2stage
420 && Ustrcmp(start_id, stop_id) == 0;
423 /* If deliver_selectstring is a regex, compile it. */
425 if (deliver_selectstring && f.deliver_selectstring_regex)
426 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
428 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
429 selectstring_regex_sender =
430 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
432 /* If the spool is split into subdirectories, we want to process it one
433 directory at a time, so as to spread out the directory scanning and the
434 delivering when there are lots of messages involved, except when
435 queue_run_in_order is set.
437 In the random order case, this loop runs once for the main directory (handling
438 any messages therein), and then repeats for any subdirectories that were found.
439 When the first argument of queue_get_spool_list() is 0, it scans the top
440 directory, fills in subdirs, and sets subcount. The order of the directories is
441 then randomized after the first time through, before they are scanned in
442 subsequent iterations.
444 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
445 order), it scans all directories and makes a single message list. */
447 for (int i = queue_run_in_order ? -1 : 0;
448 i <= (queue_run_in_order ? -1 : subcount);
451 rmark reset_point1 = store_mark();
456 debug_printf("queue running main directory\n");
458 debug_printf("queue running combined directories\n");
460 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
463 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
464 !queue_run_in_order, NULL);
473 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
474 check that the load average is low enough to permit deliveries. */
476 if (!f.queue_run_force && deliver_queue_load_max >= 0)
477 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
479 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
481 (double)load_average/1000.0,
482 (double)deliver_queue_load_max/1000.0);
483 i = subcount; /* Don't process other directories */
487 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
488 (double)load_average/1000.0,
489 (double)deliver_queue_load_max/1000.0);
491 /* If initial of a 2-phase run, maintain a set of child procs
492 to get disk parallelism */
494 if (f.queue_2stage && !queue_run_in_order)
497 if (qpid[f.running_in_test_harness ? 0 : nelem(qpid) - 1])
499 DEBUG(D_queue_run) debug_printf("q2stage waiting for child %d\n", (int)qpid[0]);
500 waitpid(qpid[0], NULL, 0);
501 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[0]);
502 if (f.running_in_test_harness) i = 0;
503 else for (i = 0; i < nelem(qpid) - 1; i++) qpid[i] = qpid[i+1];
507 for (i = 0; qpid[i]; ) i++;
508 if ((qpid[i] = exim_fork(US"qrun-phase-one")))
509 continue; /* parent loops around */
512 /* Skip this message unless it's within the ID limits */
514 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
516 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
519 /* Check that the message still exists */
521 message_subdir[0] = fq->dir_uschar;
522 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
525 /* There are some tests that require the reading of the header file. Ensure
526 the store used is scavenged afterwards so that this process doesn't keep
527 growing its store. We have to read the header file again when actually
528 delivering, but it's cheaper than forking a delivery process for each
529 message when many are not going to be delivered. */
531 if (deliver_selectstring || deliver_selectstring_sender ||
532 f.queue_run_first_delivery)
535 BOOL orig_dont_deliver = f.dont_deliver;
536 rmark reset_point2 = store_mark();
538 /* Restore the original setting of dont_deliver after reading the header,
539 so that a setting for a particular message doesn't force it for any that
540 follow. If the message is chosen for delivery, the header is read again
541 in the deliver_message() function, in a subprocess. */
543 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) goto go_around;
544 f.dont_deliver = orig_dont_deliver;
546 /* Now decide if we want to deliver this message. As we have read the
547 header file, we might as well do the freeze test now, and save forking
550 if (f.deliver_freeze && !f.deliver_force_thaw)
552 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
556 /* Check first_delivery in the case when there are no message logs. */
558 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
560 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
564 /* Check for a matching address if deliver_selectstring[_sender] is set.
565 If so, we do a fully delivery - don't want to omit other addresses since
566 their routing might trigger re-writing etc. */
568 /* Sender matching */
570 else if ( deliver_selectstring_sender
571 && !(f.deliver_selectstring_sender_regex
572 ? (pcre_exec(selectstring_regex_sender, NULL,
573 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
575 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
579 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
580 fq->text, deliver_selectstring_sender);
584 /* Recipient matching */
586 else if (deliver_selectstring)
589 for (i = 0; i < recipients_count; i++)
591 uschar *address = recipients_list[i].address;
592 if ( (f.deliver_selectstring_regex
593 ? (pcre_exec(selectstring_regex, NULL, CS address,
594 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
595 : (strstric(address, deliver_selectstring, FALSE) != NULL)
597 && tree_search(tree_nonrecipients, address) == NULL
602 if (i >= recipients_count)
605 debug_printf("%s: no recipient address matched %s\n",
606 fq->text, deliver_selectstring);
611 /* Recover store used when reading the header */
613 spool_clear_header_globals();
614 store_reset(reset_point2);
615 if (!wanted) goto go_around; /* With next message */
618 /* OK, got a message we want to deliver. Create a pipe which will
619 serve as a means of detecting when all the processes created by the
620 delivery process are finished. This is relevant when the delivery
621 process passes one or more SMTP channels on to its own children. The
622 pipe gets passed down; by reading on it here we detect when the last
623 descendent dies by the unblocking of the read. It's a pity that for
624 most of the time the pipe isn't used, but creating a pipe should be
628 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
629 "runner process %d: %s", queue_run_pid, strerror(errno));
630 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
632 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
635 if (queue_run_pipe == 0)
637 queue_run_pipe = dup(queue_run_pipe);
641 /* Before forking to deliver the message, ensure any open and cached
642 lookup files or databases are closed. Otherwise, closing in the subprocess
643 can make the next subprocess have problems. There won't often be anything
644 open here, but it is possible (e.g. if spool_directory is an expanded
645 string). A single call before this loop would probably suffice, but just in
646 case expansions get inserted at some point, I've taken the heavy-handed
647 approach. When nothing is open, the call should be cheap. */
651 /* Now deliver the message; get the id by cutting the -H off the file
652 name. The return of the process is zero if a delivery was attempted. */
654 set_process_info("running queue: %s", fq->text);
655 fq->text[SPOOL_NAME_LENGTH-2] = 0;
656 #ifdef MEASURE_TIMING
657 report_time_since(×tamp_startup, US"queue msg selected");
663 queue_tls_init = TRUE;
664 /* Preload TLS library info for smtp transports. Once, and only if we
665 have a delivery to do. */
666 tls_client_creds_reload(FALSE);
671 if ((pid = exim_fork(US"qrun-delivery")) == 0)
674 (void)close(pfd[pipe_read]);
675 rc = deliver_message(fq->text, force_delivery, FALSE);
676 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED
677 ? EXIT_FAILURE : EXIT_SUCCESS);
680 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
681 "queue runner %d failed\n", queue_run_pid);
683 /* Close the writing end of the synchronizing pipe in this process,
684 then wait for the first level process to terminate. */
686 (void)close(pfd[pipe_write]);
687 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
688 while (wait(&status) != pid);
690 /* A zero return means a delivery was attempted; turn off the force flag
691 for any subsequent calls unless queue_force is set. */
693 if (!(status & 0xffff)) force_delivery = f.queue_run_force;
695 /* If the process crashed, tell somebody */
697 else if (status & 0x00ff)
698 log_write(0, LOG_MAIN|LOG_PANIC,
699 "queue run: process %d crashed with signal %d while delivering %s",
700 (int)pid, status & 0x00ff, fq->text);
702 /* If single-item delivery was untried (likely due to locking)
703 retry once after a delay */
705 if (status & 0xff00 && single_id)
708 DEBUG(D_queue_run) debug_printf("qrun single-item pause before retry\n");
710 DEBUG(D_queue_run) debug_printf("qrun single-item retry after pause\n");
711 goto single_item_retry;
714 /* Before continuing, wait till the pipe gets closed at the far end. This
715 tells us that any children created by the delivery to re-use any SMTP
716 channels have all finished. Since no process actually writes to the pipe,
717 the mere fact that read() unblocks is enough. */
719 set_process_info("running queue: waiting for children of %d", pid);
720 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
721 log_write(0, LOG_MAIN|LOG_PANIC, status > 0 ?
722 "queue run: unexpected data on pipe" : "queue run: error on pipe: %s",
724 (void)close(pfd[pipe_read]);
725 set_process_info("running queue");
727 /* If initial of a 2-phase run, we are a child - so just exit */
728 if (f.queue_2stage && !queue_run_in_order)
729 exim_exit(EXIT_SUCCESS);
731 /* If we are in the test harness, and this is not the first of a 2-stage
732 queue run, update fudged queue times. */
734 if (f.running_in_test_harness && !f.queue_2stage)
736 uschar * fqtnext = Ustrchr(fudged_queue_times, '/');
737 if (fqtnext) fudged_queue_times = fqtnext + 1;
744 /* If initial of a 2-phase run, we are a child - so just exit */
745 if (f.queue_2stage && !queue_run_in_order)
746 exim_exit(EXIT_SUCCESS);
747 } /* End loop for list of messages */
749 tree_nonrecipients = NULL;
750 store_reset(reset_point1); /* Scavenge list of messages */
752 /* If this was the first time through for random order processing, and
753 sub-directories have been found, randomize their order if necessary. */
755 if (i == 0 && subcount > 1 && !queue_run_in_order)
756 for (int j = 1; j <= subcount; j++)
759 if ((r = random_number(100)) >= 50)
761 int k = (r % subcount) + 1;
763 subdirs[j] = subdirs[k];
767 } /* End loop for multiple directories */
769 /* If queue_2stage is true, we do it all again, with the 2stage flag
775 /* wait for last children */
776 for (int i = 0; i < nelem(qpid); i++)
779 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[i]);
780 waitpid(qpid[i], NULL, 0);
784 #ifdef MEASURE_TIMING
785 report_time_since(×tamp_startup, US"queue_run 1st phase done");
787 f.queue_2stage = FALSE;
788 queue_run(start_id, stop_id, TRUE);
791 /* At top level, log the end of the run. */
795 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
796 queue_name, log_detail);
798 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
804 /************************************************
805 * Count messages on the queue *
806 ************************************************/
808 /* Called as a result of -bpc
821 (void) queue_get_spool_list(-1, /* entire queue */
822 subdirs, /* for holding sub list */
823 &subcount, /* for subcount */
824 FALSE, /* not random */
825 &count); /* just get the count */
830 #define QUEUE_SIZE_AGE 60 /* update rate for queue_size */
833 queue_count_cached(void)
836 if ((now = time(NULL)) >= queue_size_next)
838 queue_size = queue_count();
839 queue_size_next = now + (f.running_in_test_harness ? 3 : QUEUE_SIZE_AGE);
844 /************************************************
845 * List extra deliveries *
846 ************************************************/
848 /* This is called from queue_list below to print out all addresses that
849 have received a message but which were not primary addresses. That is, all
850 the addresses in the tree of non-recipients that are not primary addresses.
851 The tree has been scanned and the data field filled in for those that are
854 Argument: points to the tree node
859 queue_list_extras(tree_node *p)
861 if (p->left) queue_list_extras(p->left);
862 if (!p->data.val) printf(" +D %s\n", p->name);
863 if (p->right) queue_list_extras(p->right);
868 /************************************************
869 * List messages on the queue *
870 ************************************************/
872 /* Or a given list of messages. In the "all" case, we get a list of file names
873 as quickly as possible, then scan each one for information to output. If any
874 disappear while we are processing, just leave them out, but give an error if an
875 explicit list was given. This function is a top-level function that is obeyed
876 as a result of the -bp argument. As there may be a lot of messages on the
877 queue, we must tidy up the store after reading the headers for each one.
880 option 0 => list top-level recipients, with "D" for those delivered
881 1 => list only undelivered top-level recipients
882 2 => as 0, plus any generated delivered recipients
883 If 8 is added to any of these values, the queue is listed in
885 list => first of any message ids to list
886 count count of message ids; 0 => all
892 queue_list(int option, uschar **list, int count)
895 int now = (int)time(NULL);
897 queue_filename * qf = NULL;
900 /* If given a list of messages, build a chain containing their ids. */
904 queue_filename *last = NULL;
905 for (int i = 0; i < count; i++)
907 queue_filename *next =
908 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
909 sprintf(CS next->text, "%s-H", list[i]);
910 next->dir_uschar = '*';
912 if (i == 0) qf = next; else last->next = next;
917 /* Otherwise get a list of the entire queue, in order if necessary. */
920 qf = queue_get_spool_list(
921 -1, /* entire queue */
922 subdirs, /* for holding sub list */
923 &subcount, /* for subcount */
924 option >= 8, /* randomize if required */
925 NULL); /* don't just count */
927 if (option >= 8) option -= 8;
929 /* Now scan the chain and print information, resetting store used
933 qf && (reset_point = store_mark());
934 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
942 message_subdir[0] = qf->dir_uschar;
943 rc = spool_read_header(qf->text, FALSE, count <= 0);
944 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
948 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
955 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
957 ptr = Ustrlen(fname)-1;
960 /* Add the data size to the header size; don't count the file name
961 at the start of the data file, but add one for the notional blank line
962 that precedes the data. */
964 if (Ustat(fname, &statbuf) == 0)
965 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
966 i = (now - received_time.tv_sec)/60; /* minutes on queue */
970 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
972 else printf("%2dm ", i);
974 /* Collect delivered addresses from any J file */
977 if ((jread = Ufopen(fname, "rb")))
979 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
981 int n = Ustrlen(big_buffer);
983 tree_add_nonrecipient(big_buffer);
989 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
990 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
992 if (env_read && sender_address)
994 printf(" <%s>", sender_address);
995 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
998 if (rc != spool_read_OK)
1001 if (save_errno == ERRNO_SPOOLFORMAT)
1003 struct stat statbuf;
1004 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
1006 if (Ustat(fname, &statbuf) == 0)
1007 printf("*** spool format error: size=" OFF_T_FMT " ***",
1009 else printf("*** spool format error ***");
1011 else printf("*** spool read error: %s ***", strerror(save_errno));
1012 if (rc != spool_read_hdrerror)
1019 if (f.deliver_freeze) printf(" *** frozen ***");
1023 if (recipients_list)
1025 for (int i = 0; i < recipients_count; i++)
1027 tree_node *delivered =
1028 tree_search(tree_nonrecipients, recipients_list[i].address);
1029 if (!delivered || option != 1)
1031 delivered ? "D" : " ", recipients_list[i].address);
1032 if (delivered) delivered->data.val = TRUE;
1034 if (option == 2 && tree_nonrecipients)
1035 queue_list_extras(tree_nonrecipients);
1043 /*************************************************
1044 * Act on a specific message *
1045 *************************************************/
1047 /* Actions that require a list of addresses make use of argv/argc/
1048 recipients_arg. Other actions do not. This function does its own
1052 id id of the message to work on
1053 action which action is required (MSG_xxx)
1054 argv the original argv for Exim
1055 argc the original argc for Exim
1056 recipients_arg offset to the list of recipients in argv
1058 Returns: FALSE if there was any problem
1062 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
1065 BOOL removed = FALSE;
1067 uschar *doing = NULL;
1070 uschar spoolname[32];
1072 /* Set the global message_id variable, used when re-writing spool files. This
1073 also causes message ids to be added to log messages. */
1075 Ustrcpy(message_id, id);
1077 /* The "actions" that just list the files do not require any locking to be
1078 done. Only admin users may read the spool files. */
1080 if (action >= MSG_SHOW_BODY)
1083 uschar *subdirectory, *suffix;
1087 printf("Permission denied\n");
1091 if (recipients_arg < argc)
1093 printf("*** Only one message can be listed at once\n");
1097 if (action == MSG_SHOW_BODY)
1099 subdirectory = US"input";
1102 else if (action == MSG_SHOW_HEADER)
1104 subdirectory = US"input";
1109 subdirectory = US"msglog";
1113 for (int i = 0; i < 2; i++)
1115 set_subdir_str(message_subdir, id, i);
1116 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1122 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1124 if (action == MSG_SHOW_LOG && !message_logs)
1125 printf("(No message logs are being created because the message_logs "
1126 "option is false.)\n");
1130 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1131 rc = write(fileno(stdout), big_buffer, rc);
1137 /* For actions that actually act, open and lock the data file to ensure that no
1138 other process is working on this message. If the file does not exist, continue
1139 only if the action is remove and the user is an admin user, to allow for
1140 tidying up broken states. */
1142 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1143 if (errno == ENOENT)
1146 printf("Spool data file for %s does not exist\n", id);
1147 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1148 printf("Continuing, to ensure all files removed\n");
1152 if (errno == 0) printf("Message %s is locked\n", id);
1153 else printf("Couldn't open spool file for %s: %s\n", id,
1158 /* Read the spool header file for the message. Again, continue after an
1159 error only in the case of deleting by an administrator. Setting the third
1160 argument false causes it to look both in the main spool directory and in
1161 the appropriate subdirectory, and set message_subdir according to where it
1162 found the message. */
1164 sprintf(CS spoolname, "%s-H", id);
1165 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1168 if (errno != ERRNO_SPOOLFORMAT)
1169 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1171 printf("Spool format error for %s\n", spoolname);
1172 if (action != MSG_REMOVE || !f.admin_user)
1174 (void)close(deliver_datafile);
1175 deliver_datafile = -1;
1178 printf("Continuing to ensure all files removed\n");
1181 /* Check that the user running this process is entitled to operate on this
1182 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1183 mess about, but the original sender is permitted to remove a message. That's
1184 why we leave this check until after the headers are read. */
1186 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1188 printf("Permission denied\n");
1189 (void)close(deliver_datafile);
1190 deliver_datafile = -1;
1194 /* Set up the user name for logging. */
1196 pw = getpwuid(real_uid);
1197 username = (pw != NULL)?
1198 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1200 /* Take the necessary action. */
1202 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1208 transport_ctx tctx = {{0}};
1209 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1210 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1212 (void) transport_write_message(&tctx, 0);
1218 if (f.deliver_freeze)
1221 printf("is already frozen\n");
1225 f.deliver_freeze = TRUE;
1226 f.deliver_manual_thaw = FALSE;
1227 deliver_frozen_at = time(NULL);
1228 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1230 printf("is now frozen\n");
1231 log_write(0, LOG_MAIN, "frozen by %s", username);
1236 printf("could not be frozen: %s\n", errmsg);
1243 if (!f.deliver_freeze)
1246 printf("is not frozen\n");
1250 f.deliver_freeze = FALSE;
1251 f.deliver_manual_thaw = TRUE;
1252 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1254 printf("is no longer frozen\n");
1255 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1260 printf("could not be unfrozen: %s\n", errmsg);
1266 /* We must ensure all files are removed from both the input directory
1267 and the appropriate subdirectory, to clean up cases when there are odd
1268 files left lying around in odd places. In the normal case message_subdir
1269 will have been set correctly by spool_read_header, but as this is a rare
1270 operation, just run everything twice. */
1278 message_subdir[0] = id[5];
1280 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1282 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1284 DEBUG(D_any) debug_printf(" removing %s", fname);
1285 if (Uunlink(fname) < 0)
1287 if (errno != ENOENT)
1290 printf("Error while removing %s: %s\n", fname, strerror(errno));
1292 else DEBUG(D_any) debug_printf(" (no file)\n");
1297 DEBUG(D_any) debug_printf(" (ok)\n");
1300 for (int i = 0; i < 3; i++)
1304 suffix[1] = (US"DHJ")[i];
1305 fname = spool_fname(US"input", message_subdir, id, suffix);
1307 DEBUG(D_any) debug_printf(" removing %s", fname);
1308 if (Uunlink(fname) < 0)
1310 if (errno != ENOENT)
1313 printf("Error while removing %s: %s\n", fname, strerror(errno));
1315 else DEBUG(D_any) debug_printf(" (no file)\n");
1320 DEBUG(D_any) debug_printf(" (done)\n");
1325 /* In the common case, the datafile is open (and locked), so give the
1326 obvious message. Otherwise be more specific. */
1328 if (deliver_datafile >= 0) printf("has been removed\n");
1329 else printf("has been removed or did not exist\n");
1332 #ifndef DISABLE_EVENT
1333 if (event_action) for (int i = 0; i < recipients_count; i++)
1335 tree_node *delivered =
1336 tree_search(tree_nonrecipients, recipients_list[i].address);
1339 uschar * save_local = deliver_localpart;
1340 const uschar * save_domain = deliver_domain;
1341 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1342 int start, end, dom;
1344 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1345 log_write(0, LOG_MAIN|LOG_PANIC,
1346 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1350 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1351 deliver_domain = dom
1352 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1354 event_raise(event_action, US"msg:fail:internal",
1355 string_sprintf("message removed by %s", username));
1357 deliver_localpart = save_local;
1358 deliver_domain = save_domain;
1362 (void) event_raise(event_action, US"msg:complete", NULL);
1364 log_write(0, LOG_MAIN, "removed by %s", username);
1365 log_write(0, LOG_MAIN, "Completed");
1372 /* The global "queue_name_dest" is used as destination, "queue_name"
1375 spool_move_message(id, message_subdir, US"", US"");
1379 case MSG_MARK_ALL_DELIVERED:
1380 for (int i = 0; i < recipients_count; i++)
1381 tree_add_nonrecipient(recipients_list[i].address);
1383 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1385 printf("has been modified\n");
1386 for (int i = 0; i < recipients_count; i++)
1387 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1388 recipients_list[i].address, username);
1393 printf("- could not mark all delivered: %s\n", errmsg);
1398 case MSG_EDIT_SENDER:
1399 if (recipients_arg < argc - 1)
1402 printf("- only one sender address can be specified\n");
1405 doing = US"editing sender";
1408 case MSG_ADD_RECIPIENT:
1409 if (doing == NULL) doing = US"adding recipient";
1412 case MSG_MARK_DELIVERED:
1413 if (doing == NULL) doing = US"marking as delivered";
1415 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1417 if (recipients_arg >= argc)
1420 printf("- error while %s: no address given\n", doing);
1424 for (; recipients_arg < argc; recipients_arg++)
1426 int start, end, domain;
1429 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1430 &domain, (action == MSG_EDIT_SENDER));
1435 printf("- error while %s:\n bad address %s: %s\n",
1436 doing, argv[recipients_arg], errmess);
1438 else if (*recipient && domain == 0)
1441 printf("- error while %s:\n bad address %s: "
1442 "domain missing\n", doing, argv[recipients_arg]);
1446 if (action == MSG_ADD_RECIPIENT)
1449 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1451 receive_add_recipient(recipient, -1);
1452 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1453 recipient, username);
1455 else if (action == MSG_MARK_DELIVERED)
1458 for (i = 0; i < recipients_count; i++)
1459 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1460 if (i >= recipients_count)
1462 printf("- error while %s:\n %s is not a recipient:"
1463 " message not updated\n", doing, recipient);
1468 tree_add_nonrecipient(recipients_list[i].address);
1469 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1470 recipient, username);
1473 else /* MSG_EDIT_SENDER */
1476 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1478 sender_address = recipient;
1479 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1480 recipient, username);
1486 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1487 printf("has been modified\n");
1491 printf("- while %s: %s\n", doing, errmsg);
1497 /* Closing the datafile releases the lock and permits other processes
1498 to operate on the message (if it still exists). */
1500 if (deliver_datafile >= 0)
1502 (void)close(deliver_datafile);
1503 deliver_datafile = -1;
1510 /*************************************************
1511 * Check the queue_only_file condition *
1512 *************************************************/
1514 /* The queue_only_file option forces certain kinds of queueing if a given file
1522 queue_check_only(void)
1525 struct stat statbuf;
1526 const uschar * s = queue_only_file;
1530 while ((ss = string_nextinlist(&s, &sep, NULL, 0)))
1531 if (Ustrncmp(ss, "smtp", 4) == 0)
1534 if (Ustat(ss, &statbuf) == 0)
1536 f.queue_smtp = TRUE;
1537 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1541 if (Ustat(ss, &statbuf) == 0)
1544 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1550 /******************************************************************************/
1551 /******************************************************************************/
1553 #ifndef DISABLE_QUEUE_RAMP
1555 queue_notify_daemon(const uschar * msgid)
1557 uschar buf[MESSAGE_ID_LENGTH + 2];
1560 DEBUG(D_queue_run) debug_printf("%s: %s\n", __FUNCTION__, msgid);
1562 buf[0] = NOTIFY_MSG_QRUN;
1563 memcpy(buf+1, msgid, MESSAGE_ID_LENGTH+1);
1565 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) >= 0)
1567 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1569 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1570 int len = offsetof(struct sockaddr_un, sun_path) + 1
1571 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1572 expand_string(notifier_socket));
1573 sa_un.sun_path[0] = 0;
1575 int len = offsetof(struct sockaddr_un, sun_path)
1576 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1577 expand_string(notifier_socket));
1580 if (sendto(fd, buf, sizeof(buf), 0, (struct sockaddr *)&sa_un, len) < 0)
1582 debug_printf("%s: sendto %s\n", __FUNCTION__, strerror(errno));
1585 else DEBUG(D_queue_run) debug_printf(" socket: %s\n", strerror(errno));
1589 #endif /*!COMPILE_UTILITY*/
1591 /* End of queue.c */