1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions that operate on the input queue. */
19 #ifndef COMPILE_UTILITY
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
25 #define LOG2_MAXNODES 32
29 /*************************************************
30 * Helper sort function for queue_get_spool_list *
31 *************************************************/
33 /* This function is used when sorting the queue list in the function
34 queue_get_spool_list() below.
37 a points to an ordered list of queue_filename items
38 b points to another ordered list
40 Returns: a pointer to a merged ordered list
43 static queue_filename *
44 merge_queue_lists(queue_filename *a, queue_filename *b)
46 queue_filename *first = NULL;
47 queue_filename **append = &first;
52 if ((d = Ustrncmp(a->text, b->text, 6)) == 0)
53 d = Ustrcmp(a->text + 14, b->text + 14);
76 /*************************************************
77 * Get list of spool files *
78 *************************************************/
80 /* Scan the spool directory and return a list of the relevant file names
81 therein. Single-character sub-directories are handled as follows:
83 If the first argument is > 0, a sub-directory is scanned; the letter is
84 taken from the nth entry in subdirs.
86 If the first argument is 0, sub-directories are not scanned. However, a
87 list of them is returned.
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.
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.
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
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 pcount If not NULL, fill in with count of files and do not return list
115 Returns: pointer to a chain of queue name items
118 static queue_filename *
119 queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount,
120 BOOL randomize, unsigned * pcount)
126 queue_filename *yield = NULL;
127 queue_filename *last = NULL;
131 queue_filename *root[LOG2_MAXNODES];
133 /* When randomizing, the file names are added to the start or end of the list
134 according to the bits of the flags variable. Get a collection of bits from the
135 current time. Use the bottom 16 and just keep re-using them if necessary. When
136 not randomizing, initialize the sublists for the bottom-up merge sort. */
141 resetflags = time(NULL) & 0xFFFF;
143 for (i = 0; i < LOG2_MAXNODES; i++)
146 /* If processing the full queue, or just the top-level, start at the base
147 directory, and initialize the first subdirectory name (as none). Otherwise,
148 start at the sub-directory offset. */
150 if (subdiroffset <= 0)
159 /* Set up prototype for the directory name. */
161 spool_pname_buf(buffer, sizeof(buffer));
162 buffer[sizeof(buffer) - 3] = 0;
163 subptr = Ustrlen(buffer);
164 buffer[subptr+2] = 0; /* terminator for lengthened name */
166 /* This loop runs at least once, for the main or given directory, and then as
167 many times as necessary to scan any subdirectories encountered in the main
168 directory, if they are to be scanned at this time. */
170 for (; i <= *subcount; i++)
173 int subdirchar = subdirs[i]; /* 0 for main directory */
177 buffer[subptr] = '/';
178 buffer[subptr+1] = subdirchar;
181 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
182 if (!(dd = opendir(CS buffer)))
185 /* Now scan the directory. */
187 while ((ent = readdir(dd)))
189 uschar *name = US ent->d_name;
190 int len = Ustrlen(name);
196 /* If we find a single alphameric sub-directory in the base directory,
197 add it to the list for subsequent scans. */
199 if (i == 0 && len == 1 && isalnum(*name))
201 *subcount = *subcount + 1;
202 subdirs[*subcount] = *name;
206 /* Otherwise, if it is a header spool file, add it to the list */
208 if (len == SPOOL_NAME_LENGTH &&
209 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
214 queue_filename *next =
215 store_get(sizeof(queue_filename) + Ustrlen(name), is_tainted(name));
216 Ustrcpy(next->text, name);
217 next->dir_uschar = subdirchar;
219 /* Handle the creation of a randomized list. The first item becomes both
220 the top and bottom of the list. Subsequent items are inserted either at
221 the top or the bottom, randomly. This is, I argue, faster than doing a
222 sort by allocating a random number to each item, and it also saves having
223 to store the number with each item. */
235 if ((flags & 1) == 0)
249 /* Otherwise do a bottom-up merge sort based on the name. */
254 for (int j = 0; j < LOG2_MAXNODES; j++)
257 next = merge_queue_lists(next, root[j]);
258 root[j] = j == LOG2_MAXNODES - 1 ? next : NULL;
269 /* Finished with this directory */
273 /* If we have just scanned a sub-directory, and it was empty (count == 2
274 implies just "." and ".." entries), and Exim is no longer configured to
275 use sub-directories, attempt to get rid of it. At the same time, try to
276 get rid of any corresponding msglog subdirectory. These are just cosmetic
277 tidying actions, so just ignore failures. If we are scanning just a single
278 sub-directory, break the loop. */
282 if (!split_spool_directory && count <= 2)
287 subdir[0] = subdirchar; subdir[1] = 0;
288 rmdir(CS spool_dname(US"msglog", subdir));
290 if (subdiroffset > 0) break; /* Single sub-directory */
293 /* If we have just scanned the base directory, and subdiroffset is 0,
294 we do not want to continue scanning the sub-directories. */
296 else if (subdiroffset == 0)
298 } /* Loop for multiple subdirectories */
300 /* When using a bottom-up merge sort, do the final merging of the sublists.
301 Then pass back the final list of file items. */
303 if (!pcount && !randomize)
304 for (i = 0; i < LOG2_MAXNODES; ++i)
305 yield = merge_queue_lists(yield, root[i]);
313 /*************************************************
314 * Perform a queue run *
315 *************************************************/
317 /* The arguments give the messages to start and stop at; NULL means start at
318 the beginning or stop at the end. If the given start message doesn't exist, we
319 start at the next lexically greater one, and likewise we stop at the after the
320 previous lexically lesser one if the given stop message doesn't exist. Because
321 a queue run can take some time, stat each file before forking, in case it has
322 been delivered in the meantime by some other means.
324 The global variables queue_run_force and queue_run_local may be set to cause
325 forced deliveries or local-only deliveries, respectively.
327 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
328 not contain the string. As this option is typically used when a machine comes
329 back online, we want to ensure that at least one delivery attempt takes place,
330 so force the first one. The selecting string can optionally be a regex, or
331 refer to the sender instead of recipients.
333 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
334 is set so that routing is done for all messages. Thus in the second run those
335 that are routed to the same host should go down the same SMTP connection.
338 start_id message id to start at, or NULL for all
339 stop_id message id to end at, or NULL for all
340 recurse TRUE if recursing for 2-stage run
346 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
348 BOOL force_delivery = f.queue_run_force || deliver_selectstring != NULL ||
349 deliver_selectstring_sender != NULL;
350 const pcre *selectstring_regex = NULL;
351 const pcre *selectstring_regex_sender = NULL;
352 uschar *log_detail = NULL;
355 pid_t qpid[4] = {0}; /* Parallelism factor for q2stage 1st phase */
356 BOOL single_id = FALSE;
358 #ifdef MEASURE_TIMING
359 report_time_since(×tamp_startup, US"queue_run start");
362 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
363 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
364 gets set. Save the queue_runner's pid and the flag that indicates any
365 deliveries run directly from this process. Deliveries that are run by handing
366 on TCP/IP channels have queue_run_pid set, but not queue_running. */
368 queue_domains = NULL;
369 queue_smtp_domains = NULL;
370 f.queue_smtp = f.queue_2stage;
372 queue_run_pid = getpid();
373 f.queue_running = TRUE;
375 /* Log the true start of a queue run, and fancy options */
382 if (f.queue_2stage) *p++ = 'q';
383 if (f.queue_run_first_delivery) *p++ = 'i';
384 if (f.queue_run_force) *p++ = 'f';
385 if (f.deliver_force_thaw) *p++ = 'f';
386 if (f.queue_run_local) *p++ = 'l';
390 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
393 p += sprintf(CS p, " -q%s", extras);
395 if (deliver_selectstring)
396 p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "",
397 deliver_selectstring);
399 if (deliver_selectstring_sender)
400 p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "",
401 deliver_selectstring_sender);
403 log_detail = string_copy(big_buffer);
405 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
406 queue_name, log_detail);
408 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
410 single_id = start_id && stop_id && !f.queue_2stage
411 && Ustrcmp(start_id, stop_id) == 0;
414 /* If deliver_selectstring is a regex, compile it. */
416 if (deliver_selectstring && f.deliver_selectstring_regex)
417 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
419 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
420 selectstring_regex_sender =
421 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
423 /* If the spool is split into subdirectories, we want to process it one
424 directory at a time, so as to spread out the directory scanning and the
425 delivering when there are lots of messages involved, except when
426 queue_run_in_order is set.
428 In the random order case, this loop runs once for the main directory (handling
429 any messages therein), and then repeats for any subdirectories that were found.
430 When the first argument of queue_get_spool_list() is 0, it scans the top
431 directory, fills in subdirs, and sets subcount. The order of the directories is
432 then randomized after the first time through, before they are scanned in
433 subsequent iterations.
435 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
436 order), it scans all directories and makes a single message list. */
438 for (int i = queue_run_in_order ? -1 : 0;
439 i <= (queue_run_in_order ? -1 : subcount);
442 rmark reset_point1 = store_mark();
447 debug_printf("queue running main directory\n");
449 debug_printf("queue running combined directories\n");
451 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
454 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
455 !queue_run_in_order, NULL);
464 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
465 check that the load average is low enough to permit deliveries. */
467 if (!f.queue_run_force && deliver_queue_load_max >= 0)
468 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
470 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
472 (double)load_average/1000.0,
473 (double)deliver_queue_load_max/1000.0);
474 i = subcount; /* Don't process other directories */
478 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
479 (double)load_average/1000.0,
480 (double)deliver_queue_load_max/1000.0);
482 /* If initial of a 2-phase run, maintain a set of child procs
483 to get disk parallelism */
485 if (f.queue_2stage && !queue_run_in_order)
488 if (qpid[f.running_in_test_harness ? 0 : nelem(qpid) - 1])
490 DEBUG(D_queue_run) debug_printf("q2stage waiting for child %d\n", (int)qpid[0]);
491 waitpid(qpid[0], NULL, 0);
492 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[0]);
493 if (f.running_in_test_harness) i = 0;
494 else for (i = 0; i < nelem(qpid) - 1; i++) qpid[i] = qpid[i+1];
498 for (i = 0; qpid[i]; ) i++;
499 if ((qpid[i] = exim_fork(US"qrun-phase-one")))
500 continue; /* parent loops around */
503 /* Skip this message unless it's within the ID limits */
505 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
507 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
510 /* Check that the message still exists */
512 message_subdir[0] = fq->dir_uschar;
513 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
516 /* There are some tests that require the reading of the header file. Ensure
517 the store used is scavenged afterwards so that this process doesn't keep
518 growing its store. We have to read the header file again when actually
519 delivering, but it's cheaper than forking a delivery process for each
520 message when many are not going to be delivered. */
522 if (deliver_selectstring || deliver_selectstring_sender ||
523 f.queue_run_first_delivery)
526 BOOL orig_dont_deliver = f.dont_deliver;
527 rmark reset_point2 = store_mark();
529 /* Restore the original setting of dont_deliver after reading the header,
530 so that a setting for a particular message doesn't force it for any that
531 follow. If the message is chosen for delivery, the header is read again
532 in the deliver_message() function, in a subprocess. */
534 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) goto go_around;
535 f.dont_deliver = orig_dont_deliver;
537 /* Now decide if we want to deliver this message. As we have read the
538 header file, we might as well do the freeze test now, and save forking
541 if (f.deliver_freeze && !f.deliver_force_thaw)
543 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
547 /* Check first_delivery in the case when there are no message logs. */
549 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
551 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
555 /* Check for a matching address if deliver_selectstring[_sender] is set.
556 If so, we do a fully delivery - don't want to omit other addresses since
557 their routing might trigger re-writing etc. */
559 /* Sender matching */
561 else if ( deliver_selectstring_sender
562 && !(f.deliver_selectstring_sender_regex
563 ? (pcre_exec(selectstring_regex_sender, NULL,
564 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
566 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
570 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
571 fq->text, deliver_selectstring_sender);
575 /* Recipient matching */
577 else if (deliver_selectstring)
580 for (i = 0; i < recipients_count; i++)
582 uschar *address = recipients_list[i].address;
583 if ( (f.deliver_selectstring_regex
584 ? (pcre_exec(selectstring_regex, NULL, CS address,
585 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
586 : (strstric(address, deliver_selectstring, FALSE) != NULL)
588 && tree_search(tree_nonrecipients, address) == NULL
593 if (i >= recipients_count)
596 debug_printf("%s: no recipient address matched %s\n",
597 fq->text, deliver_selectstring);
602 /* Recover store used when reading the header */
604 spool_clear_header_globals();
605 store_reset(reset_point2);
606 if (!wanted) goto go_around; /* With next message */
609 /* OK, got a message we want to deliver. Create a pipe which will
610 serve as a means of detecting when all the processes created by the
611 delivery process are finished. This is relevant when the delivery
612 process passes one or more SMTP channels on to its own children. The
613 pipe gets passed down; by reading on it here we detect when the last
614 descendent dies by the unblocking of the read. It's a pity that for
615 most of the time the pipe isn't used, but creating a pipe should be
619 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
620 "runner process %d: %s", queue_run_pid, strerror(errno));
621 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
623 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
626 if (queue_run_pipe == 0)
628 queue_run_pipe = dup(queue_run_pipe);
632 /* Before forking to deliver the message, ensure any open and cached
633 lookup files or databases are closed. Otherwise, closing in the subprocess
634 can make the next subprocess have problems. There won't often be anything
635 open here, but it is possible (e.g. if spool_directory is an expanded
636 string). A single call before this loop would probably suffice, but just in
637 case expansions get inserted at some point, I've taken the heavy-handed
638 approach. When nothing is open, the call should be cheap. */
642 /* Now deliver the message; get the id by cutting the -H off the file
643 name. The return of the process is zero if a delivery was attempted. */
645 set_process_info("running queue: %s", fq->text);
646 fq->text[SPOOL_NAME_LENGTH-2] = 0;
647 #ifdef MEASURE_TIMING
648 report_time_since(×tamp_startup, US"queue msg selected");
652 if ((pid = exim_fork(US"qrun delivery")) == 0)
655 (void)close(pfd[pipe_read]);
656 rc = deliver_message(fq->text, force_delivery, FALSE);
657 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED, US"qrun-delivery");
660 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
661 "queue runner %d failed\n", queue_run_pid);
663 /* Close the writing end of the synchronizing pipe in this process,
664 then wait for the first level process to terminate. */
666 (void)close(pfd[pipe_write]);
667 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
668 while (wait(&status) != pid);
670 /* A zero return means a delivery was attempted; turn off the force flag
671 for any subsequent calls unless queue_force is set. */
673 if (!(status & 0xffff)) force_delivery = f.queue_run_force;
675 /* If the process crashed, tell somebody */
677 else if (status & 0x00ff)
678 log_write(0, LOG_MAIN|LOG_PANIC,
679 "queue run: process %d crashed with signal %d while delivering %s",
680 (int)pid, status & 0x00ff, fq->text);
682 /* If single-item delivery was untried (likely due to locking)
683 retry once after a delay */
685 if (status & 0xff00 && single_id)
688 DEBUG(D_queue_run) debug_printf("qrun single-item pause before retry\n");
690 DEBUG(D_queue_run) debug_printf("qrun single-item retry after pause\n");
691 goto single_item_retry;
694 /* Before continuing, wait till the pipe gets closed at the far end. This
695 tells us that any children created by the delivery to re-use any SMTP
696 channels have all finished. Since no process actually writes to the pipe,
697 the mere fact that read() unblocks is enough. */
699 set_process_info("running queue: waiting for children of %d", pid);
700 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
701 log_write(0, LOG_MAIN|LOG_PANIC, status > 0 ?
702 "queue run: unexpected data on pipe" : "queue run: error on pipe: %s",
704 (void)close(pfd[pipe_read]);
705 set_process_info("running queue");
707 /* If initial of a 2-phase run, we are a child - so just exit */
708 if (f.queue_2stage && !queue_run_in_order)
709 exim_exit(EXIT_SUCCESS, US"2-phase child");
711 /* If we are in the test harness, and this is not the first of a 2-stage
712 queue run, update fudged queue times. */
714 if (f.running_in_test_harness && !f.queue_2stage)
716 uschar * fqtnext = Ustrchr(fudged_queue_times, '/');
717 if (fqtnext) fudged_queue_times = fqtnext + 1;
724 /* If initial of a 2-phase run, we are a child - so just exit */
725 if (f.queue_2stage && !queue_run_in_order)
726 exim_exit(EXIT_SUCCESS, US"2-phase child");
727 } /* End loop for list of messages */
729 tree_nonrecipients = NULL;
730 store_reset(reset_point1); /* Scavenge list of messages */
732 /* If this was the first time through for random order processing, and
733 sub-directories have been found, randomize their order if necessary. */
735 if (i == 0 && subcount > 1 && !queue_run_in_order)
736 for (int j = 1; j <= subcount; j++)
739 if ((r = random_number(100)) >= 50)
741 int k = (r % subcount) + 1;
743 subdirs[j] = subdirs[k];
747 } /* End loop for multiple directories */
749 /* If queue_2stage is true, we do it all again, with the 2stage flag
755 /* wait for last children */
756 for (int i = 0; i < nelem(qpid); i++)
759 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[i]);
760 waitpid(qpid[i], NULL, 0);
764 #ifdef MEASURE_TIMING
765 report_time_since(×tamp_startup, US"queue_run 1st phase done");
767 f.queue_2stage = FALSE;
768 queue_run(start_id, stop_id, TRUE);
771 /* At top level, log the end of the run. */
775 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
776 queue_name, log_detail);
778 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
784 /************************************************
785 * Count messages on the queue *
786 ************************************************/
788 /* Called as a result of -bpc
801 (void) queue_get_spool_list(-1, /* entire queue */
802 subdirs, /* for holding sub list */
803 &subcount, /* for subcount */
804 FALSE, /* not random */
805 &count); /* just get the count */
810 #define QUEUE_SIZE_AGE 60 /* update rate for queue_size */
813 queue_count_cached(void)
816 if ((now = time(NULL)) >= queue_size_next)
818 queue_size = queue_count();
819 queue_size_next = now + (f.running_in_test_harness ? 3 : QUEUE_SIZE_AGE);
824 /************************************************
825 * List extra deliveries *
826 ************************************************/
828 /* This is called from queue_list below to print out all addresses that
829 have received a message but which were not primary addresses. That is, all
830 the addresses in the tree of non-recipients that are not primary addresses.
831 The tree has been scanned and the data field filled in for those that are
834 Argument: points to the tree node
839 queue_list_extras(tree_node *p)
841 if (p->left) queue_list_extras(p->left);
842 if (!p->data.val) printf(" +D %s\n", p->name);
843 if (p->right) queue_list_extras(p->right);
848 /************************************************
849 * List messages on the queue *
850 ************************************************/
852 /* Or a given list of messages. In the "all" case, we get a list of file names
853 as quickly as possible, then scan each one for information to output. If any
854 disappear while we are processing, just leave them out, but give an error if an
855 explicit list was given. This function is a top-level function that is obeyed
856 as a result of the -bp argument. As there may be a lot of messages on the
857 queue, we must tidy up the store after reading the headers for each one.
860 option 0 => list top-level recipients, with "D" for those delivered
861 1 => list only undelivered top-level recipients
862 2 => as 0, plus any generated delivered recipients
863 If 8 is added to any of these values, the queue is listed in
865 list => first of any message ids to list
866 count count of message ids; 0 => all
872 queue_list(int option, uschar **list, int count)
875 int now = (int)time(NULL);
877 queue_filename * qf = NULL;
880 /* If given a list of messages, build a chain containing their ids. */
884 queue_filename *last = NULL;
885 for (int i = 0; i < count; i++)
887 queue_filename *next =
888 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
889 sprintf(CS next->text, "%s-H", list[i]);
890 next->dir_uschar = '*';
892 if (i == 0) qf = next; else last->next = next;
897 /* Otherwise get a list of the entire queue, in order if necessary. */
900 qf = queue_get_spool_list(
901 -1, /* entire queue */
902 subdirs, /* for holding sub list */
903 &subcount, /* for subcount */
904 option >= 8, /* randomize if required */
905 NULL); /* don't just count */
907 if (option >= 8) option -= 8;
909 /* Now scan the chain and print information, resetting store used
913 qf && (reset_point = store_mark());
914 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
922 message_subdir[0] = qf->dir_uschar;
923 rc = spool_read_header(qf->text, FALSE, count <= 0);
924 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
928 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
935 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
937 ptr = Ustrlen(fname)-1;
940 /* Add the data size to the header size; don't count the file name
941 at the start of the data file, but add one for the notional blank line
942 that precedes the data. */
944 if (Ustat(fname, &statbuf) == 0)
945 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
946 i = (now - received_time.tv_sec)/60; /* minutes on queue */
950 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
952 else printf("%2dm ", i);
954 /* Collect delivered addresses from any J file */
957 if ((jread = Ufopen(fname, "rb")))
959 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
961 int n = Ustrlen(big_buffer);
963 tree_add_nonrecipient(big_buffer);
969 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
970 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
972 if (env_read && sender_address)
974 printf(" <%s>", sender_address);
975 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
978 if (rc != spool_read_OK)
981 if (save_errno == ERRNO_SPOOLFORMAT)
984 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
986 if (Ustat(fname, &statbuf) == 0)
987 printf("*** spool format error: size=" OFF_T_FMT " ***",
989 else printf("*** spool format error ***");
991 else printf("*** spool read error: %s ***", strerror(save_errno));
992 if (rc != spool_read_hdrerror)
999 if (f.deliver_freeze) printf(" *** frozen ***");
1003 if (recipients_list)
1005 for (int i = 0; i < recipients_count; i++)
1007 tree_node *delivered =
1008 tree_search(tree_nonrecipients, recipients_list[i].address);
1009 if (!delivered || option != 1)
1011 delivered ? "D" : " ", recipients_list[i].address);
1012 if (delivered) delivered->data.val = TRUE;
1014 if (option == 2 && tree_nonrecipients)
1015 queue_list_extras(tree_nonrecipients);
1023 /*************************************************
1024 * Act on a specific message *
1025 *************************************************/
1027 /* Actions that require a list of addresses make use of argv/argc/
1028 recipients_arg. Other actions do not. This function does its own
1032 id id of the message to work on
1033 action which action is required (MSG_xxx)
1034 argv the original argv for Exim
1035 argc the original argc for Exim
1036 recipients_arg offset to the list of recipients in argv
1038 Returns: FALSE if there was any problem
1042 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
1045 BOOL removed = FALSE;
1047 uschar *doing = NULL;
1050 uschar spoolname[32];
1052 /* Set the global message_id variable, used when re-writing spool files. This
1053 also causes message ids to be added to log messages. */
1055 Ustrcpy(message_id, id);
1057 /* The "actions" that just list the files do not require any locking to be
1058 done. Only admin users may read the spool files. */
1060 if (action >= MSG_SHOW_BODY)
1063 uschar *subdirectory, *suffix;
1067 printf("Permission denied\n");
1071 if (recipients_arg < argc)
1073 printf("*** Only one message can be listed at once\n");
1077 if (action == MSG_SHOW_BODY)
1079 subdirectory = US"input";
1082 else if (action == MSG_SHOW_HEADER)
1084 subdirectory = US"input";
1089 subdirectory = US"msglog";
1093 for (int i = 0; i < 2; i++)
1095 set_subdir_str(message_subdir, id, i);
1096 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1102 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1104 if (action == MSG_SHOW_LOG && !message_logs)
1105 printf("(No message logs are being created because the message_logs "
1106 "option is false.)\n");
1110 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1111 rc = write(fileno(stdout), big_buffer, rc);
1117 /* For actions that actually act, open and lock the data file to ensure that no
1118 other process is working on this message. If the file does not exist, continue
1119 only if the action is remove and the user is an admin user, to allow for
1120 tidying up broken states. */
1122 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1123 if (errno == ENOENT)
1126 printf("Spool data file for %s does not exist\n", id);
1127 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1128 printf("Continuing, to ensure all files removed\n");
1132 if (errno == 0) printf("Message %s is locked\n", id);
1133 else printf("Couldn't open spool file for %s: %s\n", id,
1138 /* Read the spool header file for the message. Again, continue after an
1139 error only in the case of deleting by an administrator. Setting the third
1140 argument false causes it to look both in the main spool directory and in
1141 the appropriate subdirectory, and set message_subdir according to where it
1142 found the message. */
1144 sprintf(CS spoolname, "%s-H", id);
1145 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1148 if (errno != ERRNO_SPOOLFORMAT)
1149 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1151 printf("Spool format error for %s\n", spoolname);
1152 if (action != MSG_REMOVE || !f.admin_user)
1154 (void)close(deliver_datafile);
1155 deliver_datafile = -1;
1158 printf("Continuing to ensure all files removed\n");
1161 /* Check that the user running this process is entitled to operate on this
1162 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1163 mess about, but the original sender is permitted to remove a message. That's
1164 why we leave this check until after the headers are read. */
1166 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1168 printf("Permission denied\n");
1169 (void)close(deliver_datafile);
1170 deliver_datafile = -1;
1174 /* Set up the user name for logging. */
1176 pw = getpwuid(real_uid);
1177 username = (pw != NULL)?
1178 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1180 /* Take the necessary action. */
1182 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1188 transport_ctx tctx = {{0}};
1189 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1190 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1192 (void) transport_write_message(&tctx, 0);
1198 if (f.deliver_freeze)
1201 printf("is already frozen\n");
1205 f.deliver_freeze = TRUE;
1206 f.deliver_manual_thaw = FALSE;
1207 deliver_frozen_at = time(NULL);
1208 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1210 printf("is now frozen\n");
1211 log_write(0, LOG_MAIN, "frozen by %s", username);
1216 printf("could not be frozen: %s\n", errmsg);
1223 if (!f.deliver_freeze)
1226 printf("is not frozen\n");
1230 f.deliver_freeze = FALSE;
1231 f.deliver_manual_thaw = TRUE;
1232 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1234 printf("is no longer frozen\n");
1235 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1240 printf("could not be unfrozen: %s\n", errmsg);
1246 /* We must ensure all files are removed from both the input directory
1247 and the appropriate subdirectory, to clean up cases when there are odd
1248 files left lying around in odd places. In the normal case message_subdir
1249 will have been set correctly by spool_read_header, but as this is a rare
1250 operation, just run everything twice. */
1258 message_subdir[0] = id[5];
1260 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1262 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1264 DEBUG(D_any) debug_printf(" removing %s", fname);
1265 if (Uunlink(fname) < 0)
1267 if (errno != ENOENT)
1270 printf("Error while removing %s: %s\n", fname, strerror(errno));
1272 else DEBUG(D_any) debug_printf(" (no file)\n");
1277 DEBUG(D_any) debug_printf(" (ok)\n");
1280 for (int i = 0; i < 3; i++)
1284 suffix[1] = (US"DHJ")[i];
1285 fname = spool_fname(US"input", message_subdir, id, suffix);
1287 DEBUG(D_any) debug_printf(" removing %s", fname);
1288 if (Uunlink(fname) < 0)
1290 if (errno != ENOENT)
1293 printf("Error while removing %s: %s\n", fname, strerror(errno));
1295 else DEBUG(D_any) debug_printf(" (no file)\n");
1300 DEBUG(D_any) debug_printf(" (done)\n");
1305 /* In the common case, the datafile is open (and locked), so give the
1306 obvious message. Otherwise be more specific. */
1308 if (deliver_datafile >= 0) printf("has been removed\n");
1309 else printf("has been removed or did not exist\n");
1312 #ifndef DISABLE_EVENT
1313 if (event_action) for (int i = 0; i < recipients_count; i++)
1315 tree_node *delivered =
1316 tree_search(tree_nonrecipients, recipients_list[i].address);
1319 uschar * save_local = deliver_localpart;
1320 const uschar * save_domain = deliver_domain;
1321 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1322 int start, end, dom;
1324 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1325 log_write(0, LOG_MAIN|LOG_PANIC,
1326 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1330 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1331 deliver_domain = dom
1332 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1334 event_raise(event_action, US"msg:fail:internal",
1335 string_sprintf("message removed by %s", username));
1337 deliver_localpart = save_local;
1338 deliver_domain = save_domain;
1342 (void) event_raise(event_action, US"msg:complete", NULL);
1344 log_write(0, LOG_MAIN, "removed by %s", username);
1345 log_write(0, LOG_MAIN, "Completed");
1352 /* The global "queue_name_dest" is used as destination, "queue_name"
1355 spool_move_message(id, message_subdir, US"", US"");
1359 case MSG_MARK_ALL_DELIVERED:
1360 for (int i = 0; i < recipients_count; i++)
1361 tree_add_nonrecipient(recipients_list[i].address);
1363 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1365 printf("has been modified\n");
1366 for (int i = 0; i < recipients_count; i++)
1367 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1368 recipients_list[i].address, username);
1373 printf("- could not mark all delivered: %s\n", errmsg);
1378 case MSG_EDIT_SENDER:
1379 if (recipients_arg < argc - 1)
1382 printf("- only one sender address can be specified\n");
1385 doing = US"editing sender";
1388 case MSG_ADD_RECIPIENT:
1389 if (doing == NULL) doing = US"adding recipient";
1392 case MSG_MARK_DELIVERED:
1393 if (doing == NULL) doing = US"marking as delivered";
1395 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1397 if (recipients_arg >= argc)
1400 printf("- error while %s: no address given\n", doing);
1404 for (; recipients_arg < argc; recipients_arg++)
1406 int start, end, domain;
1409 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1410 &domain, (action == MSG_EDIT_SENDER));
1412 if (recipient == NULL)
1415 printf("- error while %s:\n bad address %s: %s\n",
1416 doing, argv[recipients_arg], errmess);
1418 else if (recipient[0] != 0 && domain == 0)
1421 printf("- error while %s:\n bad address %s: "
1422 "domain missing\n", doing, argv[recipients_arg]);
1426 if (action == MSG_ADD_RECIPIENT)
1429 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1431 receive_add_recipient(recipient, -1);
1432 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1433 recipient, username);
1435 else if (action == MSG_MARK_DELIVERED)
1438 for (i = 0; i < recipients_count; i++)
1439 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1440 if (i >= recipients_count)
1442 printf("- error while %s:\n %s is not a recipient:"
1443 " message not updated\n", doing, recipient);
1448 tree_add_nonrecipient(recipients_list[i].address);
1449 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1450 recipient, username);
1453 else /* MSG_EDIT_SENDER */
1456 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1458 sender_address = recipient;
1459 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1460 recipient, username);
1466 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1467 printf("has been modified\n");
1471 printf("- while %s: %s\n", doing, errmsg);
1477 /* Closing the datafile releases the lock and permits other processes
1478 to operate on the message (if it still exists). */
1480 if (deliver_datafile >= 0)
1482 (void)close(deliver_datafile);
1483 deliver_datafile = -1;
1490 /*************************************************
1491 * Check the queue_only_file condition *
1492 *************************************************/
1494 /* The queue_only_file option forces certain kinds of queueing if a given file
1502 queue_check_only(void)
1505 struct stat statbuf;
1506 const uschar * s = queue_only_file;
1510 while ((ss = string_nextinlist(&s, &sep, NULL, 0)))
1511 if (Ustrncmp(ss, "smtp", 4) == 0)
1514 if (Ustat(ss, &statbuf) == 0)
1516 f.queue_smtp = TRUE;
1517 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1521 if (Ustat(ss, &statbuf) == 0)
1524 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1530 /******************************************************************************/
1531 /******************************************************************************/
1533 #ifdef EXPERIMENTAL_QUEUE_RAMP
1535 queue_notify_daemon(const uschar * msgid)
1537 uschar buf[MESSAGE_ID_LENGTH + 2];
1540 DEBUG(D_queue_run) debug_printf("%s: %s\n", __FUNCTION__, msgid);
1542 buf[0] = NOTIFY_MSG_QRUN;
1543 memcpy(buf+1, msgid, MESSAGE_ID_LENGTH+1);
1545 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) >= 0)
1547 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1550 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1551 int len = offsetof(struct sockaddr_un, sun_path) + 1
1552 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1553 expand_string(notifier_socket));
1554 sa_un.sun_path[0] = 0;
1556 int len = offsetof(struct sockaddr_un, sun_path)
1557 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1558 expand_string(notifier_socket));
1561 if (sendto(fd, buf, sizeof(buf), 0, (struct sockaddr *)&sa_un, len) < 0)
1563 debug_printf("%s: sendto %s\n", __FUNCTION__, strerror(errno));
1566 else DEBUG(D_queue_run) debug_printf(" socket: %s\n", strerror(errno));
1570 #endif /*!COMPILE_UTILITY*/
1572 /* End of queue.c */