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
114 Returns: pointer to a chain of queue name items
117 static queue_filename *
118 queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount,
125 queue_filename *yield = NULL;
126 queue_filename *last = NULL;
130 queue_filename *root[LOG2_MAXNODES];
132 /* When randomizing, the file names are added to the start or end of the list
133 according to the bits of the flags variable. Get a collection of bits from the
134 current time. Use the bottom 16 and just keep re-using them if necessary. When
135 not randomizing, initialize the sublists for the bottom-up merge sort. */
138 resetflags = time(NULL) & 0xFFFF;
140 for (i = 0; i < LOG2_MAXNODES; i++)
143 /* If processing the full queue, or just the top-level, start at the base
144 directory, and initialize the first subdirectory name (as none). Otherwise,
145 start at the sub-directory offset. */
147 if (subdiroffset <= 0)
156 /* Set up prototype for the directory name. */
158 spool_pname_buf(buffer, sizeof(buffer));
159 buffer[sizeof(buffer) - 3] = 0;
160 subptr = Ustrlen(buffer);
161 buffer[subptr+2] = 0; /* terminator for lengthened name */
163 /* This loop runs at least once, for the main or given directory, and then as
164 many times as necessary to scan any subdirectories encountered in the main
165 directory, if they are to be scanned at this time. */
167 for (; i <= *subcount; i++)
170 int subdirchar = subdirs[i]; /* 0 for main directory */
174 buffer[subptr] = '/';
175 buffer[subptr+1] = subdirchar;
178 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
179 if (!(dd = opendir(CS buffer)))
182 /* Now scan the directory. */
184 while ((ent = readdir(dd)))
186 uschar *name = US ent->d_name;
187 int len = Ustrlen(name);
193 /* If we find a single alphameric sub-directory in the base directory,
194 add it to the list for subsequent scans. */
196 if (i == 0 && len == 1 && isalnum(*name))
198 *subcount = *subcount + 1;
199 subdirs[*subcount] = *name;
203 /* Otherwise, if it is a header spool file, add it to the list */
205 if (len == SPOOL_NAME_LENGTH &&
206 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
208 queue_filename *next =
209 store_get(sizeof(queue_filename) + Ustrlen(name), is_tainted(name));
210 Ustrcpy(next->text, name);
211 next->dir_uschar = subdirchar;
213 /* Handle the creation of a randomized list. The first item becomes both
214 the top and bottom of the list. Subsequent items are inserted either at
215 the top or the bottom, randomly. This is, I argue, faster than doing a
216 sort by allocating a random number to each item, and it also saves having
217 to store the number with each item. */
229 if ((flags & 1) == 0)
243 /* Otherwise do a bottom-up merge sort based on the name. */
248 for (int j = 0; j < LOG2_MAXNODES; j++)
251 next = merge_queue_lists(next, root[j]);
252 root[j] = j == LOG2_MAXNODES - 1 ? next : NULL;
263 /* Finished with this directory */
267 /* If we have just scanned a sub-directory, and it was empty (count == 2
268 implies just "." and ".." entries), and Exim is no longer configured to
269 use sub-directories, attempt to get rid of it. At the same time, try to
270 get rid of any corresponding msglog subdirectory. These are just cosmetic
271 tidying actions, so just ignore failures. If we are scanning just a single
272 sub-directory, break the loop. */
276 if (!split_spool_directory && count <= 2)
281 subdir[0] = subdirchar; subdir[1] = 0;
282 rmdir(CS spool_dname(US"msglog", subdir));
284 if (subdiroffset > 0) break; /* Single sub-directory */
287 /* If we have just scanned the base directory, and subdiroffset is 0,
288 we do not want to continue scanning the sub-directories. */
290 else if (subdiroffset == 0)
292 } /* Loop for multiple subdirectories */
294 /* When using a bottom-up merge sort, do the final merging of the sublists.
295 Then pass back the final list of file items. */
298 for (i = 0; i < LOG2_MAXNODES; ++i)
299 yield = merge_queue_lists(yield, root[i]);
307 /*************************************************
308 * Perform a queue run *
309 *************************************************/
311 /* The arguments give the messages to start and stop at; NULL means start at
312 the beginning or stop at the end. If the given start message doesn't exist, we
313 start at the next lexically greater one, and likewise we stop at the after the
314 previous lexically lesser one if the given stop message doesn't exist. Because
315 a queue run can take some time, stat each file before forking, in case it has
316 been delivered in the meantime by some other means.
318 The global variables queue_run_force and queue_run_local may be set to cause
319 forced deliveries or local-only deliveries, respectively.
321 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
322 not contain the string. As this option is typically used when a machine comes
323 back online, we want to ensure that at least one delivery attempt takes place,
324 so force the first one. The selecting string can optionally be a regex, or
325 refer to the sender instead of recipients.
327 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
328 is set so that routing is done for all messages. Thus in the second run those
329 that are routed to the same host should go down the same SMTP connection.
332 start_id message id to start at, or NULL for all
333 stop_id message id to end at, or NULL for all
334 recurse TRUE if recursing for 2-stage run
340 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
342 BOOL force_delivery = f.queue_run_force || deliver_selectstring != NULL ||
343 deliver_selectstring_sender != NULL;
344 const pcre *selectstring_regex = NULL;
345 const pcre *selectstring_regex_sender = NULL;
346 uschar *log_detail = NULL;
349 pid_t qpid[4] = {0}; /* Parallelism factor for q2stage 1st phase */
351 #ifdef MEASURE_TIMING
352 report_time_since(×tamp_startup, US"queue_run start");
355 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
356 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
357 gets set. Save the queue_runner's pid and the flag that indicates any
358 deliveries run directly from this process. Deliveries that are run by handing
359 on TCP/IP channels have queue_run_pid set, but not queue_running. */
361 queue_domains = NULL;
362 queue_smtp_domains = NULL;
363 f.queue_smtp = f.queue_2stage;
365 queue_run_pid = getpid();
366 f.queue_running = TRUE;
368 /* Log the true start of a queue run, and fancy options */
375 if (f.queue_2stage) *p++ = 'q';
376 if (f.queue_run_first_delivery) *p++ = 'i';
377 if (f.queue_run_force) *p++ = 'f';
378 if (f.deliver_force_thaw) *p++ = 'f';
379 if (f.queue_run_local) *p++ = 'l';
383 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
386 p += sprintf(CS p, " -q%s", extras);
388 if (deliver_selectstring)
389 p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "",
390 deliver_selectstring);
392 if (deliver_selectstring_sender)
393 p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "",
394 deliver_selectstring_sender);
396 log_detail = string_copy(big_buffer);
398 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
399 queue_name, log_detail);
401 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
404 /* If deliver_selectstring is a regex, compile it. */
406 if (deliver_selectstring && f.deliver_selectstring_regex)
407 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
409 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
410 selectstring_regex_sender =
411 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
413 /* If the spool is split into subdirectories, we want to process it one
414 directory at a time, so as to spread out the directory scanning and the
415 delivering when there are lots of messages involved, except when
416 queue_run_in_order is set.
418 In the random order case, this loop runs once for the main directory (handling
419 any messages therein), and then repeats for any subdirectories that were found.
420 When the first argument of queue_get_spool_list() is 0, it scans the top
421 directory, fills in subdirs, and sets subcount. The order of the directories is
422 then randomized after the first time through, before they are scanned in
423 subsequent iterations.
425 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
426 order), it scans all directories and makes a single message list. */
428 for (int i = queue_run_in_order ? -1 : 0;
429 i <= (queue_run_in_order ? -1 : subcount);
432 rmark reset_point1 = store_mark();
437 debug_printf("queue running main directory\n");
439 debug_printf("queue running combined directories\n");
441 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
444 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
445 !queue_run_in_order);
454 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
455 check that the load average is low enough to permit deliveries. */
457 if (!f.queue_run_force && deliver_queue_load_max >= 0)
458 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
460 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
462 (double)load_average/1000.0,
463 (double)deliver_queue_load_max/1000.0);
464 i = subcount; /* Don't process other directories */
468 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
469 (double)load_average/1000.0,
470 (double)deliver_queue_load_max/1000.0);
472 /* If initial of a 2-phase run, maintain a set of child procs
473 to get disk parallelism */
475 if (f.queue_2stage && !queue_run_in_order)
478 if (qpid[nelem(qpid) - 1])
480 DEBUG(D_queue_run) debug_printf("q2stage waiting for child\n");
481 waitpid(qpid[0], NULL, 0);
482 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[0]);
483 for (i = 0; i < nelem(qpid) - 1; i++) qpid[i] = qpid[i+1];
487 for (i = 0; qpid[i]; ) i++;
488 DEBUG(D_queue_run) debug_printf("q2stage forking\n");
489 if ((qpid[i] = fork()))
490 continue; /* parent loops around */
491 DEBUG(D_queue_run) debug_printf("q2stage child\n");
494 /* Skip this message unless it's within the ID limits */
496 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
498 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
501 /* Check that the message still exists */
503 message_subdir[0] = fq->dir_uschar;
504 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
507 /* There are some tests that require the reading of the header file. Ensure
508 the store used is scavenged afterwards so that this process doesn't keep
509 growing its store. We have to read the header file again when actually
510 delivering, but it's cheaper than forking a delivery process for each
511 message when many are not going to be delivered. */
513 if (deliver_selectstring || deliver_selectstring_sender ||
514 f.queue_run_first_delivery)
517 BOOL orig_dont_deliver = f.dont_deliver;
518 rmark reset_point2 = store_mark();
520 /* Restore the original setting of dont_deliver after reading the header,
521 so that a setting for a particular message doesn't force it for any that
522 follow. If the message is chosen for delivery, the header is read again
523 in the deliver_message() function, in a subprocess. */
525 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) goto go_around;
526 f.dont_deliver = orig_dont_deliver;
528 /* Now decide if we want to deliver this message. As we have read the
529 header file, we might as well do the freeze test now, and save forking
532 if (f.deliver_freeze && !f.deliver_force_thaw)
534 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
538 /* Check first_delivery in the case when there are no message logs. */
540 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
542 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
546 /* Check for a matching address if deliver_selectstring[_sender] is set.
547 If so, we do a fully delivery - don't want to omit other addresses since
548 their routing might trigger re-writing etc. */
550 /* Sender matching */
552 else if ( deliver_selectstring_sender
553 && !(f.deliver_selectstring_sender_regex
554 ? (pcre_exec(selectstring_regex_sender, NULL,
555 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
557 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
561 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
562 fq->text, deliver_selectstring_sender);
566 /* Recipient matching */
568 else if (deliver_selectstring)
571 for (i = 0; i < recipients_count; i++)
573 uschar *address = recipients_list[i].address;
574 if ( (f.deliver_selectstring_regex
575 ? (pcre_exec(selectstring_regex, NULL, CS address,
576 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
577 : (strstric(address, deliver_selectstring, FALSE) != NULL)
579 && tree_search(tree_nonrecipients, address) == NULL
584 if (i >= recipients_count)
587 debug_printf("%s: no recipient address matched %s\n",
588 fq->text, deliver_selectstring);
593 /* Recover store used when reading the header */
595 spool_clear_header_globals();
596 store_reset(reset_point2);
597 if (!wanted) goto go_around; /* With next message */
600 /* OK, got a message we want to deliver. Create a pipe which will
601 serve as a means of detecting when all the processes created by the
602 delivery process are finished. This is relevant when the delivery
603 process passes one or more SMTP channels on to its own children. The
604 pipe gets passed down; by reading on it here we detect when the last
605 descendent dies by the unblocking of the read. It's a pity that for
606 most of the time the pipe isn't used, but creating a pipe should be
610 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
611 "runner process %d: %s", queue_run_pid, strerror(errno));
612 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
614 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
617 if (queue_run_pipe == 0)
619 queue_run_pipe = dup(queue_run_pipe);
623 /* Before forking to deliver the message, ensure any open and cached
624 lookup files or databases are closed. Otherwise, closing in the subprocess
625 can make the next subprocess have problems. There won't often be anything
626 open here, but it is possible (e.g. if spool_directory is an expanded
627 string). A single call before this loop would probably suffice, but just in
628 case expansions get inserted at some point, I've taken the heavy-handed
629 approach. When nothing is open, the call should be cheap. */
633 /* Now deliver the message; get the id by cutting the -H off the file
634 name. The return of the process is zero if a delivery was attempted. */
636 set_process_info("running queue: %s", fq->text);
637 fq->text[SPOOL_NAME_LENGTH-2] = 0;
638 #ifdef MEASURE_TIMING
639 report_time_since(×tamp_startup, US"queue msg selected");
642 if ((pid = fork()) == 0)
645 testharness_pause_ms(100);
646 (void)close(pfd[pipe_read]);
647 rc = deliver_message(fq->text, force_delivery, FALSE);
648 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED);
651 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
652 "queue runner %d failed\n", queue_run_pid);
654 /* Close the writing end of the synchronizing pipe in this process,
655 then wait for the first level process to terminate. */
657 (void)close(pfd[pipe_write]);
658 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
659 while (wait(&status) != pid);
661 /* A zero return means a delivery was attempted; turn off the force flag
662 for any subsequent calls unless queue_force is set. */
664 if (!(status & 0xffff)) force_delivery = f.queue_run_force;
666 /* If the process crashed, tell somebody */
668 else if (status & 0x00ff)
669 log_write(0, LOG_MAIN|LOG_PANIC,
670 "queue run: process %d crashed with signal %d while delivering %s",
671 (int)pid, status & 0x00ff, fq->text);
673 /* Before continuing, wait till the pipe gets closed at the far end. This
674 tells us that any children created by the delivery to re-use any SMTP
675 channels have all finished. Since no process actually writes to the pipe,
676 the mere fact that read() unblocks is enough. */
678 set_process_info("running queue: waiting for children of %d", pid);
679 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
680 log_write(0, LOG_MAIN|LOG_PANIC, status > 0 ?
681 "queue run: unexpected data on pipe" : "queue run: error on pipe: %s",
683 (void)close(pfd[pipe_read]);
684 set_process_info("running queue");
686 /* If initial of a 2-phase run, we are a child - so just exit */
687 if (f.queue_2stage && !queue_run_in_order)
688 exim_exit(EXIT_SUCCESS, US"2-phase child");
690 /* If we are in the test harness, and this is not the first of a 2-stage
691 queue run, update fudged queue times. */
693 if (f.running_in_test_harness && !f.queue_2stage)
695 uschar * fqtnext = Ustrchr(fudged_queue_times, '/');
696 if (fqtnext) fudged_queue_times = fqtnext + 1;
703 /* If initial of a 2-phase run, we are a child - so just exit */
704 if (f.queue_2stage && !queue_run_in_order)
705 exim_exit(EXIT_SUCCESS, US"2-phase child");
706 } /* End loop for list of messages */
708 tree_nonrecipients = NULL;
709 store_reset(reset_point1); /* Scavenge list of messages */
711 /* If this was the first time through for random order processing, and
712 sub-directories have been found, randomize their order if necessary. */
714 if (i == 0 && subcount > 1 && !queue_run_in_order)
715 for (int j = 1; j <= subcount; j++)
718 if ((r = random_number(100)) >= 50)
720 int k = (r % subcount) + 1;
722 subdirs[j] = subdirs[k];
726 } /* End loop for multiple directories */
728 /* If queue_2stage is true, we do it all again, with the 2stage flag
734 /* wait for last children */
735 for (int i = 0; i < nelem(qpid); i++)
738 DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[i]);
739 waitpid(qpid[i], NULL, 0);
743 #ifdef MEASURE_TIMING
744 report_time_since(×tamp_startup, US"queue_run 1st phase done");
746 f.queue_2stage = FALSE;
747 queue_run(start_id, stop_id, TRUE);
750 /* At top level, log the end of the run. */
754 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
755 queue_name, log_detail);
757 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
763 /************************************************
764 * Count messages on the queue *
765 ************************************************/
767 /* Called as a result of -bpc
780 for (queue_filename *f = queue_get_spool_list(
781 -1, /* entire queue */
782 subdirs, /* for holding sub list */
783 &subcount, /* for subcount */
784 FALSE); /* not random */
785 f; f = f->next) count++;
786 fprintf(stdout, "%d\n", count);
791 /************************************************
792 * List extra deliveries *
793 ************************************************/
795 /* This is called from queue_list below to print out all addresses that
796 have received a message but which were not primary addresses. That is, all
797 the addresses in the tree of non-recipients that are not primary addresses.
798 The tree has been scanned and the data field filled in for those that are
801 Argument: points to the tree node
806 queue_list_extras(tree_node *p)
808 if (p->left) queue_list_extras(p->left);
809 if (!p->data.val) printf(" +D %s\n", p->name);
810 if (p->right) queue_list_extras(p->right);
815 /************************************************
816 * List messages on the queue *
817 ************************************************/
819 /* Or a given list of messages. In the "all" case, we get a list of file names
820 as quickly as possible, then scan each one for information to output. If any
821 disappear while we are processing, just leave them out, but give an error if an
822 explicit list was given. This function is a top-level function that is obeyed
823 as a result of the -bp argument. As there may be a lot of messages on the
824 queue, we must tidy up the store after reading the headers for each one.
827 option 0 => list top-level recipients, with "D" for those delivered
828 1 => list only undelivered top-level recipients
829 2 => as 0, plus any generated delivered recipients
830 If 8 is added to any of these values, the queue is listed in
832 list => first of any message ids to list
833 count count of message ids; 0 => all
839 queue_list(int option, uschar **list, int count)
842 int now = (int)time(NULL);
844 queue_filename * qf = NULL;
847 /* If given a list of messages, build a chain containing their ids. */
851 queue_filename *last = NULL;
852 for (int i = 0; i < count; i++)
854 queue_filename *next =
855 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
856 sprintf(CS next->text, "%s-H", list[i]);
857 next->dir_uschar = '*';
859 if (i == 0) qf = next; else last->next = next;
864 /* Otherwise get a list of the entire queue, in order if necessary. */
867 qf = queue_get_spool_list(
868 -1, /* entire queue */
869 subdirs, /* for holding sub list */
870 &subcount, /* for subcount */
871 option >= 8); /* randomize if required */
873 if (option >= 8) option -= 8;
875 /* Now scan the chain and print information, resetting store used
879 qf && (reset_point = store_mark());
880 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
888 message_subdir[0] = qf->dir_uschar;
889 rc = spool_read_header(qf->text, FALSE, count <= 0);
890 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
894 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
901 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
903 ptr = Ustrlen(fname)-1;
906 /* Add the data size to the header size; don't count the file name
907 at the start of the data file, but add one for the notional blank line
908 that precedes the data. */
910 if (Ustat(fname, &statbuf) == 0)
911 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
912 i = (now - received_time.tv_sec)/60; /* minutes on queue */
916 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
918 else printf("%2dm ", i);
920 /* Collect delivered addresses from any J file */
923 if ((jread = Ufopen(fname, "rb")))
925 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
927 int n = Ustrlen(big_buffer);
929 tree_add_nonrecipient(big_buffer);
935 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
936 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
938 if (env_read && sender_address)
940 printf(" <%s>", sender_address);
941 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
944 if (rc != spool_read_OK)
947 if (save_errno == ERRNO_SPOOLFORMAT)
950 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
952 if (Ustat(fname, &statbuf) == 0)
953 printf("*** spool format error: size=" OFF_T_FMT " ***",
955 else printf("*** spool format error ***");
957 else printf("*** spool read error: %s ***", strerror(save_errno));
958 if (rc != spool_read_hdrerror)
965 if (f.deliver_freeze) printf(" *** frozen ***");
971 for (int i = 0; i < recipients_count; i++)
973 tree_node *delivered =
974 tree_search(tree_nonrecipients, recipients_list[i].address);
975 if (!delivered || option != 1)
977 delivered ? "D" : " ", recipients_list[i].address);
978 if (delivered) delivered->data.val = TRUE;
980 if (option == 2 && tree_nonrecipients)
981 queue_list_extras(tree_nonrecipients);
989 /*************************************************
990 * Act on a specific message *
991 *************************************************/
993 /* Actions that require a list of addresses make use of argv/argc/
994 recipients_arg. Other actions do not. This function does its own
998 id id of the message to work on
999 action which action is required (MSG_xxx)
1000 argv the original argv for Exim
1001 argc the original argc for Exim
1002 recipients_arg offset to the list of recipients in argv
1004 Returns: FALSE if there was any problem
1008 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
1011 BOOL removed = FALSE;
1013 uschar *doing = NULL;
1016 uschar spoolname[32];
1018 /* Set the global message_id variable, used when re-writing spool files. This
1019 also causes message ids to be added to log messages. */
1021 Ustrcpy(message_id, id);
1023 /* The "actions" that just list the files do not require any locking to be
1024 done. Only admin users may read the spool files. */
1026 if (action >= MSG_SHOW_BODY)
1029 uschar *subdirectory, *suffix;
1033 printf("Permission denied\n");
1037 if (recipients_arg < argc)
1039 printf("*** Only one message can be listed at once\n");
1043 if (action == MSG_SHOW_BODY)
1045 subdirectory = US"input";
1048 else if (action == MSG_SHOW_HEADER)
1050 subdirectory = US"input";
1055 subdirectory = US"msglog";
1059 for (int i = 0; i < 2; i++)
1061 set_subdir_str(message_subdir, id, i);
1062 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1068 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1070 if (action == MSG_SHOW_LOG && !message_logs)
1071 printf("(No message logs are being created because the message_logs "
1072 "option is false.)\n");
1076 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1077 rc = write(fileno(stdout), big_buffer, rc);
1083 /* For actions that actually act, open and lock the data file to ensure that no
1084 other process is working on this message. If the file does not exist, continue
1085 only if the action is remove and the user is an admin user, to allow for
1086 tidying up broken states. */
1088 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1089 if (errno == ENOENT)
1092 printf("Spool data file for %s does not exist\n", id);
1093 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1094 printf("Continuing, to ensure all files removed\n");
1098 if (errno == 0) printf("Message %s is locked\n", id);
1099 else printf("Couldn't open spool file for %s: %s\n", id,
1104 /* Read the spool header file for the message. Again, continue after an
1105 error only in the case of deleting by an administrator. Setting the third
1106 argument false causes it to look both in the main spool directory and in
1107 the appropriate subdirectory, and set message_subdir according to where it
1108 found the message. */
1110 sprintf(CS spoolname, "%s-H", id);
1111 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1114 if (errno != ERRNO_SPOOLFORMAT)
1115 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1117 printf("Spool format error for %s\n", spoolname);
1118 if (action != MSG_REMOVE || !f.admin_user)
1120 (void)close(deliver_datafile);
1121 deliver_datafile = -1;
1124 printf("Continuing to ensure all files removed\n");
1127 /* Check that the user running this process is entitled to operate on this
1128 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1129 mess about, but the original sender is permitted to remove a message. That's
1130 why we leave this check until after the headers are read. */
1132 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1134 printf("Permission denied\n");
1135 (void)close(deliver_datafile);
1136 deliver_datafile = -1;
1140 /* Set up the user name for logging. */
1142 pw = getpwuid(real_uid);
1143 username = (pw != NULL)?
1144 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1146 /* Take the necessary action. */
1148 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1154 transport_ctx tctx = {{0}};
1155 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1156 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1158 (void) transport_write_message(&tctx, 0);
1164 if (f.deliver_freeze)
1167 printf("is already frozen\n");
1171 f.deliver_freeze = TRUE;
1172 f.deliver_manual_thaw = FALSE;
1173 deliver_frozen_at = time(NULL);
1174 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1176 printf("is now frozen\n");
1177 log_write(0, LOG_MAIN, "frozen by %s", username);
1182 printf("could not be frozen: %s\n", errmsg);
1189 if (!f.deliver_freeze)
1192 printf("is not frozen\n");
1196 f.deliver_freeze = FALSE;
1197 f.deliver_manual_thaw = TRUE;
1198 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1200 printf("is no longer frozen\n");
1201 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1206 printf("could not be unfrozen: %s\n", errmsg);
1212 /* We must ensure all files are removed from both the input directory
1213 and the appropriate subdirectory, to clean up cases when there are odd
1214 files left lying around in odd places. In the normal case message_subdir
1215 will have been set correctly by spool_read_header, but as this is a rare
1216 operation, just run everything twice. */
1224 message_subdir[0] = id[5];
1226 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1228 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1230 DEBUG(D_any) debug_printf(" removing %s", fname);
1231 if (Uunlink(fname) < 0)
1233 if (errno != ENOENT)
1236 printf("Error while removing %s: %s\n", fname, strerror(errno));
1238 else DEBUG(D_any) debug_printf(" (no file)\n");
1243 DEBUG(D_any) debug_printf(" (ok)\n");
1246 for (int i = 0; i < 3; i++)
1250 suffix[1] = (US"DHJ")[i];
1251 fname = spool_fname(US"input", message_subdir, id, suffix);
1253 DEBUG(D_any) debug_printf(" removing %s", fname);
1254 if (Uunlink(fname) < 0)
1256 if (errno != ENOENT)
1259 printf("Error while removing %s: %s\n", fname, strerror(errno));
1261 else DEBUG(D_any) debug_printf(" (no file)\n");
1266 DEBUG(D_any) debug_printf(" (done)\n");
1271 /* In the common case, the datafile is open (and locked), so give the
1272 obvious message. Otherwise be more specific. */
1274 if (deliver_datafile >= 0) printf("has been removed\n");
1275 else printf("has been removed or did not exist\n");
1278 #ifndef DISABLE_EVENT
1279 if (event_action) for (int i = 0; i < recipients_count; i++)
1281 tree_node *delivered =
1282 tree_search(tree_nonrecipients, recipients_list[i].address);
1285 uschar * save_local = deliver_localpart;
1286 const uschar * save_domain = deliver_domain;
1287 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1288 int start, end, dom;
1290 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1291 log_write(0, LOG_MAIN|LOG_PANIC,
1292 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1296 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1297 deliver_domain = dom
1298 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1300 event_raise(event_action, US"msg:fail:internal",
1301 string_sprintf("message removed by %s", username));
1303 deliver_localpart = save_local;
1304 deliver_domain = save_domain;
1308 (void) event_raise(event_action, US"msg:complete", NULL);
1310 log_write(0, LOG_MAIN, "removed by %s", username);
1311 log_write(0, LOG_MAIN, "Completed");
1318 /* The global "queue_name_dest" is used as destination, "queue_name"
1321 spool_move_message(id, message_subdir, US"", US"");
1325 case MSG_MARK_ALL_DELIVERED:
1326 for (int i = 0; i < recipients_count; i++)
1327 tree_add_nonrecipient(recipients_list[i].address);
1329 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1331 printf("has been modified\n");
1332 for (int i = 0; i < recipients_count; i++)
1333 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1334 recipients_list[i].address, username);
1339 printf("- could not mark all delivered: %s\n", errmsg);
1344 case MSG_EDIT_SENDER:
1345 if (recipients_arg < argc - 1)
1348 printf("- only one sender address can be specified\n");
1351 doing = US"editing sender";
1354 case MSG_ADD_RECIPIENT:
1355 if (doing == NULL) doing = US"adding recipient";
1358 case MSG_MARK_DELIVERED:
1359 if (doing == NULL) doing = US"marking as delivered";
1361 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1363 if (recipients_arg >= argc)
1366 printf("- error while %s: no address given\n", doing);
1370 for (; recipients_arg < argc; recipients_arg++)
1372 int start, end, domain;
1375 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1376 &domain, (action == MSG_EDIT_SENDER));
1378 if (recipient == NULL)
1381 printf("- error while %s:\n bad address %s: %s\n",
1382 doing, argv[recipients_arg], errmess);
1384 else if (recipient[0] != 0 && domain == 0)
1387 printf("- error while %s:\n bad address %s: "
1388 "domain missing\n", doing, argv[recipients_arg]);
1392 if (action == MSG_ADD_RECIPIENT)
1395 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1397 receive_add_recipient(recipient, -1);
1398 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1399 recipient, username);
1401 else if (action == MSG_MARK_DELIVERED)
1404 for (i = 0; i < recipients_count; i++)
1405 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1406 if (i >= recipients_count)
1408 printf("- error while %s:\n %s is not a recipient:"
1409 " message not updated\n", doing, recipient);
1414 tree_add_nonrecipient(recipients_list[i].address);
1415 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1416 recipient, username);
1419 else /* MSG_EDIT_SENDER */
1422 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1424 sender_address = recipient;
1425 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1426 recipient, username);
1432 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1433 printf("has been modified\n");
1437 printf("- while %s: %s\n", doing, errmsg);
1443 /* Closing the datafile releases the lock and permits other processes
1444 to operate on the message (if it still exists). */
1446 if (deliver_datafile >= 0)
1448 (void)close(deliver_datafile);
1449 deliver_datafile = -1;
1456 /*************************************************
1457 * Check the queue_only_file condition *
1458 *************************************************/
1460 /* The queue_only_file option forces certain kinds of queueing if a given file
1468 queue_check_only(void)
1471 struct stat statbuf;
1472 const uschar * s = queue_only_file;
1476 while ((ss = string_nextinlist(&s, &sep, NULL, 0)))
1477 if (Ustrncmp(ss, "smtp", 4) == 0)
1480 if (Ustat(ss, &statbuf) == 0)
1482 f.queue_smtp = TRUE;
1483 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1487 if (Ustat(ss, &statbuf) == 0)
1490 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1496 /******************************************************************************/
1497 /******************************************************************************/
1499 #ifdef EXPERIMENTAL_QUEUE_RAMP
1501 queue_notify_daemon(const uschar * msgid)
1503 uschar buf[MESSAGE_ID_LENGTH + 2];
1506 DEBUG(D_queue_run) debug_printf("%s: %s\n", __FUNCTION__, msgid);
1508 buf[0] = NOTIFY_MSG_QRUN;
1509 memcpy(buf+1, msgid, MESSAGE_ID_LENGTH+1);
1511 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) >= 0)
1513 struct sockaddr_un sun = {.sun_family = AF_UNIX};
1515 snprintf(sun.sun_path, sizeof(sun.sun_path), "%s/%s",
1516 spool_directory, NOTIFIER_SOCKET_NAME);
1518 if (sendto(fd, buf, sizeof(buf), 0, &sun, sizeof(sun)) < 0)
1520 debug_printf("%s: sendto %s\n", __FUNCTION__, strerror(errno));
1523 else DEBUG(D_queue_run) debug_printf(" socket: %s\n", strerror(errno));
1527 #endif /*!COMPILE_UTILITY*/
1529 /* End of queue.c */