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 */
357 #ifdef MEASURE_TIMING
358 report_time_since(×tamp_startup, US"queue_run start");
361 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
362 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
363 gets set. Save the queue_runner's pid and the flag that indicates any
364 deliveries run directly from this process. Deliveries that are run by handing
365 on TCP/IP channels have queue_run_pid set, but not queue_running. */
367 queue_domains = NULL;
368 queue_smtp_domains = NULL;
369 f.queue_smtp = f.queue_2stage;
371 queue_run_pid = getpid();
372 f.queue_running = TRUE;
374 /* Log the true start of a queue run, and fancy options */
381 if (f.queue_2stage) *p++ = 'q';
382 if (f.queue_run_first_delivery) *p++ = 'i';
383 if (f.queue_run_force) *p++ = 'f';
384 if (f.deliver_force_thaw) *p++ = 'f';
385 if (f.queue_run_local) *p++ = 'l';
389 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
392 p += sprintf(CS p, " -q%s", extras);
394 if (deliver_selectstring)
395 p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "",
396 deliver_selectstring);
398 if (deliver_selectstring_sender)
399 p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "",
400 deliver_selectstring_sender);
402 log_detail = string_copy(big_buffer);
404 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
405 queue_name, log_detail);
407 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
410 /* If deliver_selectstring is a regex, compile it. */
412 if (deliver_selectstring && f.deliver_selectstring_regex)
413 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
415 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
416 selectstring_regex_sender =
417 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
419 /* If the spool is split into subdirectories, we want to process it one
420 directory at a time, so as to spread out the directory scanning and the
421 delivering when there are lots of messages involved, except when
422 queue_run_in_order is set.
424 In the random order case, this loop runs once for the main directory (handling
425 any messages therein), and then repeats for any subdirectories that were found.
426 When the first argument of queue_get_spool_list() is 0, it scans the top
427 directory, fills in subdirs, and sets subcount. The order of the directories is
428 then randomized after the first time through, before they are scanned in
429 subsequent iterations.
431 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
432 order), it scans all directories and makes a single message list. */
434 for (int i = queue_run_in_order ? -1 : 0;
435 i <= (queue_run_in_order ? -1 : subcount);
438 rmark reset_point1 = store_mark();
443 debug_printf("queue running main directory\n");
445 debug_printf("queue running combined directories\n");
447 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
450 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
451 !queue_run_in_order, NULL);
460 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
461 check that the load average is low enough to permit deliveries. */
463 if (!f.queue_run_force && deliver_queue_load_max >= 0)
464 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
466 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
468 (double)load_average/1000.0,
469 (double)deliver_queue_load_max/1000.0);
470 i = subcount; /* Don't process other directories */
474 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
475 (double)load_average/1000.0,
476 (double)deliver_queue_load_max/1000.0);
478 /* If initial of a 2-phase run, maintain a set of child procs
479 to get disk parallelism */
481 if (f.queue_2stage && !queue_run_in_order)
484 if (qpid[f.running_in_test_harness ? 0 : nelem(qpid) - 1])
486 DEBUG(D_queue_run) debug_printf("q2stage waiting for child\n");
487 waitpid(qpid[0], NULL, 0);
488 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[0]);
489 for (i = 0; i < nelem(qpid) - 1; i++) qpid[i] = qpid[i+1];
493 for (i = 0; qpid[i]; ) i++;
494 DEBUG(D_queue_run) debug_printf("q2stage forking\n");
495 if ((qpid[i] = fork()))
496 continue; /* parent loops around */
497 DEBUG(D_queue_run) debug_printf("q2stage child\n");
500 /* Skip this message unless it's within the ID limits */
502 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
504 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
507 /* Check that the message still exists */
509 message_subdir[0] = fq->dir_uschar;
510 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
513 /* There are some tests that require the reading of the header file. Ensure
514 the store used is scavenged afterwards so that this process doesn't keep
515 growing its store. We have to read the header file again when actually
516 delivering, but it's cheaper than forking a delivery process for each
517 message when many are not going to be delivered. */
519 if (deliver_selectstring || deliver_selectstring_sender ||
520 f.queue_run_first_delivery)
523 BOOL orig_dont_deliver = f.dont_deliver;
524 rmark reset_point2 = store_mark();
526 /* Restore the original setting of dont_deliver after reading the header,
527 so that a setting for a particular message doesn't force it for any that
528 follow. If the message is chosen for delivery, the header is read again
529 in the deliver_message() function, in a subprocess. */
531 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) goto go_around;
532 f.dont_deliver = orig_dont_deliver;
534 /* Now decide if we want to deliver this message. As we have read the
535 header file, we might as well do the freeze test now, and save forking
538 if (f.deliver_freeze && !f.deliver_force_thaw)
540 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
544 /* Check first_delivery in the case when there are no message logs. */
546 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
548 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
552 /* Check for a matching address if deliver_selectstring[_sender] is set.
553 If so, we do a fully delivery - don't want to omit other addresses since
554 their routing might trigger re-writing etc. */
556 /* Sender matching */
558 else if ( deliver_selectstring_sender
559 && !(f.deliver_selectstring_sender_regex
560 ? (pcre_exec(selectstring_regex_sender, NULL,
561 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
563 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
567 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
568 fq->text, deliver_selectstring_sender);
572 /* Recipient matching */
574 else if (deliver_selectstring)
577 for (i = 0; i < recipients_count; i++)
579 uschar *address = recipients_list[i].address;
580 if ( (f.deliver_selectstring_regex
581 ? (pcre_exec(selectstring_regex, NULL, CS address,
582 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
583 : (strstric(address, deliver_selectstring, FALSE) != NULL)
585 && tree_search(tree_nonrecipients, address) == NULL
590 if (i >= recipients_count)
593 debug_printf("%s: no recipient address matched %s\n",
594 fq->text, deliver_selectstring);
599 /* Recover store used when reading the header */
601 spool_clear_header_globals();
602 store_reset(reset_point2);
603 if (!wanted) goto go_around; /* With next message */
606 /* OK, got a message we want to deliver. Create a pipe which will
607 serve as a means of detecting when all the processes created by the
608 delivery process are finished. This is relevant when the delivery
609 process passes one or more SMTP channels on to its own children. The
610 pipe gets passed down; by reading on it here we detect when the last
611 descendent dies by the unblocking of the read. It's a pity that for
612 most of the time the pipe isn't used, but creating a pipe should be
616 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
617 "runner process %d: %s", queue_run_pid, strerror(errno));
618 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
620 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
623 if (queue_run_pipe == 0)
625 queue_run_pipe = dup(queue_run_pipe);
629 /* Before forking to deliver the message, ensure any open and cached
630 lookup files or databases are closed. Otherwise, closing in the subprocess
631 can make the next subprocess have problems. There won't often be anything
632 open here, but it is possible (e.g. if spool_directory is an expanded
633 string). A single call before this loop would probably suffice, but just in
634 case expansions get inserted at some point, I've taken the heavy-handed
635 approach. When nothing is open, the call should be cheap. */
639 /* Now deliver the message; get the id by cutting the -H off the file
640 name. The return of the process is zero if a delivery was attempted. */
642 set_process_info("running queue: %s", fq->text);
643 fq->text[SPOOL_NAME_LENGTH-2] = 0;
644 #ifdef MEASURE_TIMING
645 report_time_since(×tamp_startup, US"queue msg selected");
648 if ((pid = fork()) == 0)
651 testharness_pause_ms(100);
652 (void)close(pfd[pipe_read]);
653 rc = deliver_message(fq->text, force_delivery, FALSE);
654 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED);
657 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
658 "queue runner %d failed\n", queue_run_pid);
660 /* Close the writing end of the synchronizing pipe in this process,
661 then wait for the first level process to terminate. */
663 (void)close(pfd[pipe_write]);
664 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
665 while (wait(&status) != pid);
667 /* A zero return means a delivery was attempted; turn off the force flag
668 for any subsequent calls unless queue_force is set. */
670 if (!(status & 0xffff)) force_delivery = f.queue_run_force;
672 /* If the process crashed, tell somebody */
674 else if (status & 0x00ff)
675 log_write(0, LOG_MAIN|LOG_PANIC,
676 "queue run: process %d crashed with signal %d while delivering %s",
677 (int)pid, status & 0x00ff, fq->text);
679 /* Before continuing, wait till the pipe gets closed at the far end. This
680 tells us that any children created by the delivery to re-use any SMTP
681 channels have all finished. Since no process actually writes to the pipe,
682 the mere fact that read() unblocks is enough. */
684 set_process_info("running queue: waiting for children of %d", pid);
685 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
686 log_write(0, LOG_MAIN|LOG_PANIC, status > 0 ?
687 "queue run: unexpected data on pipe" : "queue run: error on pipe: %s",
689 (void)close(pfd[pipe_read]);
690 set_process_info("running queue");
692 /* If initial of a 2-phase run, we are a child - so just exit */
693 if (f.queue_2stage && !queue_run_in_order)
694 exim_exit(EXIT_SUCCESS, US"2-phase child");
696 /* If we are in the test harness, and this is not the first of a 2-stage
697 queue run, update fudged queue times. */
699 if (f.running_in_test_harness && !f.queue_2stage)
701 uschar * fqtnext = Ustrchr(fudged_queue_times, '/');
702 if (fqtnext) fudged_queue_times = fqtnext + 1;
709 /* If initial of a 2-phase run, we are a child - so just exit */
710 if (f.queue_2stage && !queue_run_in_order)
711 exim_exit(EXIT_SUCCESS, US"2-phase child");
712 } /* End loop for list of messages */
714 tree_nonrecipients = NULL;
715 store_reset(reset_point1); /* Scavenge list of messages */
717 /* If this was the first time through for random order processing, and
718 sub-directories have been found, randomize their order if necessary. */
720 if (i == 0 && subcount > 1 && !queue_run_in_order)
721 for (int j = 1; j <= subcount; j++)
724 if ((r = random_number(100)) >= 50)
726 int k = (r % subcount) + 1;
728 subdirs[j] = subdirs[k];
732 } /* End loop for multiple directories */
734 /* If queue_2stage is true, we do it all again, with the 2stage flag
740 /* wait for last children */
741 for (int i = 0; i < nelem(qpid); i++)
744 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[i]);
745 waitpid(qpid[i], NULL, 0);
749 #ifdef MEASURE_TIMING
750 report_time_since(×tamp_startup, US"queue_run 1st phase done");
752 f.queue_2stage = FALSE;
753 queue_run(start_id, stop_id, TRUE);
756 /* At top level, log the end of the run. */
760 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
761 queue_name, log_detail);
763 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
769 /************************************************
770 * Count messages on the queue *
771 ************************************************/
773 /* Called as a result of -bpc
786 (void) queue_get_spool_list(-1, /* entire queue */
787 subdirs, /* for holding sub list */
788 &subcount, /* for subcount */
789 FALSE, /* not random */
790 &count); /* just get the count */
795 #define QUEUE_SIZE_AGE 60 /* update rate for queue_size */
798 queue_count_cached(void)
801 if ((now = time(NULL)) >= queue_size_next)
803 queue_size = queue_count();
804 queue_size_next = now + (f.running_in_test_harness ? 3 : QUEUE_SIZE_AGE);
809 /************************************************
810 * List extra deliveries *
811 ************************************************/
813 /* This is called from queue_list below to print out all addresses that
814 have received a message but which were not primary addresses. That is, all
815 the addresses in the tree of non-recipients that are not primary addresses.
816 The tree has been scanned and the data field filled in for those that are
819 Argument: points to the tree node
824 queue_list_extras(tree_node *p)
826 if (p->left) queue_list_extras(p->left);
827 if (!p->data.val) printf(" +D %s\n", p->name);
828 if (p->right) queue_list_extras(p->right);
833 /************************************************
834 * List messages on the queue *
835 ************************************************/
837 /* Or a given list of messages. In the "all" case, we get a list of file names
838 as quickly as possible, then scan each one for information to output. If any
839 disappear while we are processing, just leave them out, but give an error if an
840 explicit list was given. This function is a top-level function that is obeyed
841 as a result of the -bp argument. As there may be a lot of messages on the
842 queue, we must tidy up the store after reading the headers for each one.
845 option 0 => list top-level recipients, with "D" for those delivered
846 1 => list only undelivered top-level recipients
847 2 => as 0, plus any generated delivered recipients
848 If 8 is added to any of these values, the queue is listed in
850 list => first of any message ids to list
851 count count of message ids; 0 => all
857 queue_list(int option, uschar **list, int count)
860 int now = (int)time(NULL);
862 queue_filename * qf = NULL;
865 /* If given a list of messages, build a chain containing their ids. */
869 queue_filename *last = NULL;
870 for (int i = 0; i < count; i++)
872 queue_filename *next =
873 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
874 sprintf(CS next->text, "%s-H", list[i]);
875 next->dir_uschar = '*';
877 if (i == 0) qf = next; else last->next = next;
882 /* Otherwise get a list of the entire queue, in order if necessary. */
885 qf = queue_get_spool_list(
886 -1, /* entire queue */
887 subdirs, /* for holding sub list */
888 &subcount, /* for subcount */
889 option >= 8, /* randomize if required */
890 NULL); /* don't just count */
892 if (option >= 8) option -= 8;
894 /* Now scan the chain and print information, resetting store used
898 qf && (reset_point = store_mark());
899 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
907 message_subdir[0] = qf->dir_uschar;
908 rc = spool_read_header(qf->text, FALSE, count <= 0);
909 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
913 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
920 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
922 ptr = Ustrlen(fname)-1;
925 /* Add the data size to the header size; don't count the file name
926 at the start of the data file, but add one for the notional blank line
927 that precedes the data. */
929 if (Ustat(fname, &statbuf) == 0)
930 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
931 i = (now - received_time.tv_sec)/60; /* minutes on queue */
935 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
937 else printf("%2dm ", i);
939 /* Collect delivered addresses from any J file */
942 if ((jread = Ufopen(fname, "rb")))
944 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
946 int n = Ustrlen(big_buffer);
948 tree_add_nonrecipient(big_buffer);
954 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
955 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
957 if (env_read && sender_address)
959 printf(" <%s>", sender_address);
960 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
963 if (rc != spool_read_OK)
966 if (save_errno == ERRNO_SPOOLFORMAT)
969 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
971 if (Ustat(fname, &statbuf) == 0)
972 printf("*** spool format error: size=" OFF_T_FMT " ***",
974 else printf("*** spool format error ***");
976 else printf("*** spool read error: %s ***", strerror(save_errno));
977 if (rc != spool_read_hdrerror)
984 if (f.deliver_freeze) printf(" *** frozen ***");
990 for (int i = 0; i < recipients_count; i++)
992 tree_node *delivered =
993 tree_search(tree_nonrecipients, recipients_list[i].address);
994 if (!delivered || option != 1)
996 delivered ? "D" : " ", recipients_list[i].address);
997 if (delivered) delivered->data.val = TRUE;
999 if (option == 2 && tree_nonrecipients)
1000 queue_list_extras(tree_nonrecipients);
1008 /*************************************************
1009 * Act on a specific message *
1010 *************************************************/
1012 /* Actions that require a list of addresses make use of argv/argc/
1013 recipients_arg. Other actions do not. This function does its own
1017 id id of the message to work on
1018 action which action is required (MSG_xxx)
1019 argv the original argv for Exim
1020 argc the original argc for Exim
1021 recipients_arg offset to the list of recipients in argv
1023 Returns: FALSE if there was any problem
1027 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
1030 BOOL removed = FALSE;
1032 uschar *doing = NULL;
1035 uschar spoolname[32];
1037 /* Set the global message_id variable, used when re-writing spool files. This
1038 also causes message ids to be added to log messages. */
1040 Ustrcpy(message_id, id);
1042 /* The "actions" that just list the files do not require any locking to be
1043 done. Only admin users may read the spool files. */
1045 if (action >= MSG_SHOW_BODY)
1048 uschar *subdirectory, *suffix;
1052 printf("Permission denied\n");
1056 if (recipients_arg < argc)
1058 printf("*** Only one message can be listed at once\n");
1062 if (action == MSG_SHOW_BODY)
1064 subdirectory = US"input";
1067 else if (action == MSG_SHOW_HEADER)
1069 subdirectory = US"input";
1074 subdirectory = US"msglog";
1078 for (int i = 0; i < 2; i++)
1080 set_subdir_str(message_subdir, id, i);
1081 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1087 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1089 if (action == MSG_SHOW_LOG && !message_logs)
1090 printf("(No message logs are being created because the message_logs "
1091 "option is false.)\n");
1095 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1096 rc = write(fileno(stdout), big_buffer, rc);
1102 /* For actions that actually act, open and lock the data file to ensure that no
1103 other process is working on this message. If the file does not exist, continue
1104 only if the action is remove and the user is an admin user, to allow for
1105 tidying up broken states. */
1107 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1108 if (errno == ENOENT)
1111 printf("Spool data file for %s does not exist\n", id);
1112 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1113 printf("Continuing, to ensure all files removed\n");
1117 if (errno == 0) printf("Message %s is locked\n", id);
1118 else printf("Couldn't open spool file for %s: %s\n", id,
1123 /* Read the spool header file for the message. Again, continue after an
1124 error only in the case of deleting by an administrator. Setting the third
1125 argument false causes it to look both in the main spool directory and in
1126 the appropriate subdirectory, and set message_subdir according to where it
1127 found the message. */
1129 sprintf(CS spoolname, "%s-H", id);
1130 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1133 if (errno != ERRNO_SPOOLFORMAT)
1134 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1136 printf("Spool format error for %s\n", spoolname);
1137 if (action != MSG_REMOVE || !f.admin_user)
1139 (void)close(deliver_datafile);
1140 deliver_datafile = -1;
1143 printf("Continuing to ensure all files removed\n");
1146 /* Check that the user running this process is entitled to operate on this
1147 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1148 mess about, but the original sender is permitted to remove a message. That's
1149 why we leave this check until after the headers are read. */
1151 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1153 printf("Permission denied\n");
1154 (void)close(deliver_datafile);
1155 deliver_datafile = -1;
1159 /* Set up the user name for logging. */
1161 pw = getpwuid(real_uid);
1162 username = (pw != NULL)?
1163 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1165 /* Take the necessary action. */
1167 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1173 transport_ctx tctx = {{0}};
1174 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1175 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1177 (void) transport_write_message(&tctx, 0);
1183 if (f.deliver_freeze)
1186 printf("is already frozen\n");
1190 f.deliver_freeze = TRUE;
1191 f.deliver_manual_thaw = FALSE;
1192 deliver_frozen_at = time(NULL);
1193 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1195 printf("is now frozen\n");
1196 log_write(0, LOG_MAIN, "frozen by %s", username);
1201 printf("could not be frozen: %s\n", errmsg);
1208 if (!f.deliver_freeze)
1211 printf("is not frozen\n");
1215 f.deliver_freeze = FALSE;
1216 f.deliver_manual_thaw = TRUE;
1217 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1219 printf("is no longer frozen\n");
1220 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1225 printf("could not be unfrozen: %s\n", errmsg);
1231 /* We must ensure all files are removed from both the input directory
1232 and the appropriate subdirectory, to clean up cases when there are odd
1233 files left lying around in odd places. In the normal case message_subdir
1234 will have been set correctly by spool_read_header, but as this is a rare
1235 operation, just run everything twice. */
1243 message_subdir[0] = id[5];
1245 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1247 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1249 DEBUG(D_any) debug_printf(" removing %s", fname);
1250 if (Uunlink(fname) < 0)
1252 if (errno != ENOENT)
1255 printf("Error while removing %s: %s\n", fname, strerror(errno));
1257 else DEBUG(D_any) debug_printf(" (no file)\n");
1262 DEBUG(D_any) debug_printf(" (ok)\n");
1265 for (int i = 0; i < 3; i++)
1269 suffix[1] = (US"DHJ")[i];
1270 fname = spool_fname(US"input", message_subdir, id, suffix);
1272 DEBUG(D_any) debug_printf(" removing %s", fname);
1273 if (Uunlink(fname) < 0)
1275 if (errno != ENOENT)
1278 printf("Error while removing %s: %s\n", fname, strerror(errno));
1280 else DEBUG(D_any) debug_printf(" (no file)\n");
1285 DEBUG(D_any) debug_printf(" (done)\n");
1290 /* In the common case, the datafile is open (and locked), so give the
1291 obvious message. Otherwise be more specific. */
1293 if (deliver_datafile >= 0) printf("has been removed\n");
1294 else printf("has been removed or did not exist\n");
1297 #ifndef DISABLE_EVENT
1298 if (event_action) for (int i = 0; i < recipients_count; i++)
1300 tree_node *delivered =
1301 tree_search(tree_nonrecipients, recipients_list[i].address);
1304 uschar * save_local = deliver_localpart;
1305 const uschar * save_domain = deliver_domain;
1306 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1307 int start, end, dom;
1309 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1310 log_write(0, LOG_MAIN|LOG_PANIC,
1311 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1315 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1316 deliver_domain = dom
1317 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1319 event_raise(event_action, US"msg:fail:internal",
1320 string_sprintf("message removed by %s", username));
1322 deliver_localpart = save_local;
1323 deliver_domain = save_domain;
1327 (void) event_raise(event_action, US"msg:complete", NULL);
1329 log_write(0, LOG_MAIN, "removed by %s", username);
1330 log_write(0, LOG_MAIN, "Completed");
1337 /* The global "queue_name_dest" is used as destination, "queue_name"
1340 spool_move_message(id, message_subdir, US"", US"");
1344 case MSG_MARK_ALL_DELIVERED:
1345 for (int i = 0; i < recipients_count; i++)
1346 tree_add_nonrecipient(recipients_list[i].address);
1348 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1350 printf("has been modified\n");
1351 for (int i = 0; i < recipients_count; i++)
1352 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1353 recipients_list[i].address, username);
1358 printf("- could not mark all delivered: %s\n", errmsg);
1363 case MSG_EDIT_SENDER:
1364 if (recipients_arg < argc - 1)
1367 printf("- only one sender address can be specified\n");
1370 doing = US"editing sender";
1373 case MSG_ADD_RECIPIENT:
1374 if (doing == NULL) doing = US"adding recipient";
1377 case MSG_MARK_DELIVERED:
1378 if (doing == NULL) doing = US"marking as delivered";
1380 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1382 if (recipients_arg >= argc)
1385 printf("- error while %s: no address given\n", doing);
1389 for (; recipients_arg < argc; recipients_arg++)
1391 int start, end, domain;
1394 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1395 &domain, (action == MSG_EDIT_SENDER));
1397 if (recipient == NULL)
1400 printf("- error while %s:\n bad address %s: %s\n",
1401 doing, argv[recipients_arg], errmess);
1403 else if (recipient[0] != 0 && domain == 0)
1406 printf("- error while %s:\n bad address %s: "
1407 "domain missing\n", doing, argv[recipients_arg]);
1411 if (action == MSG_ADD_RECIPIENT)
1414 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1416 receive_add_recipient(recipient, -1);
1417 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1418 recipient, username);
1420 else if (action == MSG_MARK_DELIVERED)
1423 for (i = 0; i < recipients_count; i++)
1424 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1425 if (i >= recipients_count)
1427 printf("- error while %s:\n %s is not a recipient:"
1428 " message not updated\n", doing, recipient);
1433 tree_add_nonrecipient(recipients_list[i].address);
1434 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1435 recipient, username);
1438 else /* MSG_EDIT_SENDER */
1441 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1443 sender_address = recipient;
1444 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1445 recipient, username);
1451 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1452 printf("has been modified\n");
1456 printf("- while %s: %s\n", doing, errmsg);
1462 /* Closing the datafile releases the lock and permits other processes
1463 to operate on the message (if it still exists). */
1465 if (deliver_datafile >= 0)
1467 (void)close(deliver_datafile);
1468 deliver_datafile = -1;
1475 /*************************************************
1476 * Check the queue_only_file condition *
1477 *************************************************/
1479 /* The queue_only_file option forces certain kinds of queueing if a given file
1487 queue_check_only(void)
1490 struct stat statbuf;
1491 const uschar * s = queue_only_file;
1495 while ((ss = string_nextinlist(&s, &sep, NULL, 0)))
1496 if (Ustrncmp(ss, "smtp", 4) == 0)
1499 if (Ustat(ss, &statbuf) == 0)
1501 f.queue_smtp = TRUE;
1502 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1506 if (Ustat(ss, &statbuf) == 0)
1509 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1515 /******************************************************************************/
1516 /******************************************************************************/
1518 #ifdef EXPERIMENTAL_QUEUE_RAMP
1520 queue_notify_daemon(const uschar * msgid)
1522 uschar buf[MESSAGE_ID_LENGTH + 2];
1525 DEBUG(D_queue_run) debug_printf("%s: %s\n", __FUNCTION__, msgid);
1527 buf[0] = NOTIFY_MSG_QRUN;
1528 memcpy(buf+1, msgid, MESSAGE_ID_LENGTH+1);
1530 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) >= 0)
1532 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1535 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1536 int len = offsetof(struct sockaddr_un, sun_path) + 1
1537 + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1538 NOTIFIER_SOCKET_NAME);
1539 sa_un.sun_path[0] = 0;
1541 int len = offsetof(struct sockaddr_un, sun_path)
1542 + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s/%s",
1543 spool_directory, NOTIFIER_SOCKET_NAME);
1546 if (sendto(fd, buf, sizeof(buf), 0, (struct sockaddr *)&sa_un, len) < 0)
1548 debug_printf("%s: sendto %s\n", __FUNCTION__, strerror(errno));
1551 else DEBUG(D_queue_run) debug_printf(" socket: %s\n", strerror(errno));
1555 #endif /*!COMPILE_UTILITY*/
1557 /* End of queue.c */