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;
350 #ifdef MEASURE_TIMING
351 report_time_since(×tamp_startup, US"queue_run start");
354 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
355 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
356 gets set. Save the queue_runner's pid and the flag that indicates any
357 deliveries run directly from this process. Deliveries that are run by handing
358 on TCP/IP channels have queue_run_pid set, but not queue_running. */
360 queue_domains = NULL;
361 queue_smtp_domains = NULL;
362 f.queue_smtp = f.queue_2stage;
364 queue_run_pid = getpid();
365 f.queue_running = TRUE;
367 /* Log the true start of a queue run, and fancy options */
374 if (f.queue_2stage) *p++ = 'q';
375 if (f.queue_run_first_delivery) *p++ = 'i';
376 if (f.queue_run_force) *p++ = 'f';
377 if (f.deliver_force_thaw) *p++ = 'f';
378 if (f.queue_run_local) *p++ = 'l';
382 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
385 p += sprintf(CS p, " -q%s", extras);
387 if (deliver_selectstring)
388 p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "",
389 deliver_selectstring);
391 if (deliver_selectstring_sender)
392 p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "",
393 deliver_selectstring_sender);
395 log_detail = string_copy(big_buffer);
397 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
398 queue_name, log_detail);
400 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
403 /* If deliver_selectstring is a regex, compile it. */
405 if (deliver_selectstring && f.deliver_selectstring_regex)
406 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
408 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
409 selectstring_regex_sender =
410 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
412 /* If the spool is split into subdirectories, we want to process it one
413 directory at a time, so as to spread out the directory scanning and the
414 delivering when there are lots of messages involved, except when
415 queue_run_in_order is set.
417 In the random order case, this loop runs once for the main directory (handling
418 any messages therein), and then repeats for any subdirectories that were found.
419 When the first argument of queue_get_spool_list() is 0, it scans the top
420 directory, fills in subdirs, and sets subcount. The order of the directories is
421 then randomized after the first time through, before they are scanned in
422 subsequent iterations.
424 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
425 order), it scans all directories and makes a single message list. */
427 for (int i = queue_run_in_order ? -1 : 0;
428 i <= (queue_run_in_order ? -1 : subcount);
431 rmark reset_point1 = store_mark();
436 debug_printf("queue running main directory\n");
438 debug_printf("queue running combined directories\n");
440 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
443 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
444 !queue_run_in_order);
453 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
454 check that the load average is low enough to permit deliveries. */
456 if (!f.queue_run_force && deliver_queue_load_max >= 0)
457 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
459 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
461 (double)load_average/1000.0,
462 (double)deliver_queue_load_max/1000.0);
463 i = subcount; /* Don't process other directories */
467 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
468 (double)load_average/1000.0,
469 (double)deliver_queue_load_max/1000.0);
471 /* Skip this message unless it's within the ID limits */
473 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
475 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
478 /* Check that the message still exists */
480 message_subdir[0] = fq->dir_uschar;
481 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
484 /* There are some tests that require the reading of the header file. Ensure
485 the store used is scavenged afterwards so that this process doesn't keep
486 growing its store. We have to read the header file again when actually
487 delivering, but it's cheaper than forking a delivery process for each
488 message when many are not going to be delivered. */
490 if (deliver_selectstring || deliver_selectstring_sender ||
491 f.queue_run_first_delivery)
494 BOOL orig_dont_deliver = f.dont_deliver;
495 rmark reset_point2 = store_mark();
497 /* Restore the original setting of dont_deliver after reading the header,
498 so that a setting for a particular message doesn't force it for any that
499 follow. If the message is chosen for delivery, the header is read again
500 in the deliver_message() function, in a subprocess. */
502 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) continue;
503 f.dont_deliver = orig_dont_deliver;
505 /* Now decide if we want to deliver this message. As we have read the
506 header file, we might as well do the freeze test now, and save forking
509 if (f.deliver_freeze && !f.deliver_force_thaw)
511 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
515 /* Check first_delivery in the case when there are no message logs. */
517 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
519 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
523 /* Check for a matching address if deliver_selectstring[_sender] is set.
524 If so, we do a fully delivery - don't want to omit other addresses since
525 their routing might trigger re-writing etc. */
527 /* Sender matching */
529 else if ( deliver_selectstring_sender
530 && !(f.deliver_selectstring_sender_regex
531 ? (pcre_exec(selectstring_regex_sender, NULL,
532 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
534 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
538 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
539 fq->text, deliver_selectstring_sender);
543 /* Recipient matching */
545 else if (deliver_selectstring)
548 for (i = 0; i < recipients_count; i++)
550 uschar *address = recipients_list[i].address;
551 if ( (f.deliver_selectstring_regex
552 ? (pcre_exec(selectstring_regex, NULL, CS address,
553 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
554 : (strstric(address, deliver_selectstring, FALSE) != NULL)
556 && tree_search(tree_nonrecipients, address) == NULL
561 if (i >= recipients_count)
564 debug_printf("%s: no recipient address matched %s\n",
565 fq->text, deliver_selectstring);
570 /* Recover store used when reading the header */
572 spool_clear_header_globals();
573 store_reset(reset_point2);
574 if (!wanted) continue; /* With next message */
577 /* OK, got a message we want to deliver. Create a pipe which will
578 serve as a means of detecting when all the processes created by the
579 delivery process are finished. This is relevant when the delivery
580 process passes one or more SMTP channels on to its own children. The
581 pipe gets passed down; by reading on it here we detect when the last
582 descendent dies by the unblocking of the read. It's a pity that for
583 most of the time the pipe isn't used, but creating a pipe should be
587 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
588 "runner process %d: %s", queue_run_pid, strerror(errno));
589 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
591 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
594 if (queue_run_pipe == 0)
596 queue_run_pipe = dup(queue_run_pipe);
600 /* Before forking to deliver the message, ensure any open and cached
601 lookup files or databases are closed. Otherwise, closing in the subprocess
602 can make the next subprocess have problems. There won't often be anything
603 open here, but it is possible (e.g. if spool_directory is an expanded
604 string). A single call before this loop would probably suffice, but just in
605 case expansions get inserted at some point, I've taken the heavy-handed
606 approach. When nothing is open, the call should be cheap. */
610 /* Now deliver the message; get the id by cutting the -H off the file
611 name. The return of the process is zero if a delivery was attempted. */
613 set_process_info("running queue: %s", fq->text);
614 fq->text[SPOOL_NAME_LENGTH-2] = 0;
615 #ifdef MEASURE_TIMING
616 report_time_since(×tamp_startup, US"queue msg selected");
619 if ((pid = fork()) == 0)
622 testharness_pause_ms(100);
623 (void)close(pfd[pipe_read]);
624 rc = deliver_message(fq->text, force_delivery, FALSE);
625 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED);
628 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
629 "queue runner %d failed\n", queue_run_pid);
631 /* Close the writing end of the synchronizing pipe in this process,
632 then wait for the first level process to terminate. */
634 (void)close(pfd[pipe_write]);
635 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
636 while (wait(&status) != pid);
638 /* A zero return means a delivery was attempted; turn off the force flag
639 for any subsequent calls unless queue_force is set. */
641 if (!(status & 0xffff)) force_delivery = f.queue_run_force;
643 /* If the process crashed, tell somebody */
645 else if (status & 0x00ff)
646 log_write(0, LOG_MAIN|LOG_PANIC,
647 "queue run: process %d crashed with signal %d while delivering %s",
648 (int)pid, status & 0x00ff, fq->text);
650 /* Before continuing, wait till the pipe gets closed at the far end. This
651 tells us that any children created by the delivery to re-use any SMTP
652 channels have all finished. Since no process actually writes to the pipe,
653 the mere fact that read() unblocks is enough. */
655 set_process_info("running queue: waiting for children of %d", pid);
656 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
657 log_write(0, LOG_MAIN|LOG_PANIC, status > 0 ?
658 "queue run: unexpected data on pipe" : "queue run: error on pipe: %s",
660 (void)close(pfd[pipe_read]);
661 set_process_info("running queue");
663 /* If we are in the test harness, and this is not the first of a 2-stage
664 queue run, update fudged queue times. */
666 if (f.running_in_test_harness && !f.queue_2stage)
668 uschar * fqtnext = Ustrchr(fudged_queue_times, '/');
669 if (fqtnext) fudged_queue_times = fqtnext + 1;
671 } /* End loop for list of messages */
673 tree_nonrecipients = NULL;
674 store_reset(reset_point1); /* Scavenge list of messages */
676 /* If this was the first time through for random order processing, and
677 sub-directories have been found, randomize their order if necessary. */
679 if (i == 0 && subcount > 1 && !queue_run_in_order)
680 for (int j = 1; j <= subcount; j++)
683 if ((r = random_number(100)) >= 50)
685 int k = (r % subcount) + 1;
687 subdirs[j] = subdirs[k];
691 } /* End loop for multiple directories */
693 /* If queue_2stage is true, we do it all again, with the 2stage flag
698 f.queue_2stage = FALSE;
699 queue_run(start_id, stop_id, TRUE);
702 /* At top level, log the end of the run. */
706 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
707 queue_name, log_detail);
709 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
715 /************************************************
716 * Count messages on the queue *
717 ************************************************/
719 /* Called as a result of -bpc
732 for (queue_filename *f = queue_get_spool_list(
733 -1, /* entire queue */
734 subdirs, /* for holding sub list */
735 &subcount, /* for subcount */
736 FALSE); /* not random */
737 f; f = f->next) count++;
738 fprintf(stdout, "%d\n", count);
743 /************************************************
744 * List extra deliveries *
745 ************************************************/
747 /* This is called from queue_list below to print out all addresses that
748 have received a message but which were not primary addresses. That is, all
749 the addresses in the tree of non-recipients that are not primary addresses.
750 The tree has been scanned and the data field filled in for those that are
753 Argument: points to the tree node
758 queue_list_extras(tree_node *p)
760 if (p->left) queue_list_extras(p->left);
761 if (!p->data.val) printf(" +D %s\n", p->name);
762 if (p->right) queue_list_extras(p->right);
767 /************************************************
768 * List messages on the queue *
769 ************************************************/
771 /* Or a given list of messages. In the "all" case, we get a list of file names
772 as quickly as possible, then scan each one for information to output. If any
773 disappear while we are processing, just leave them out, but give an error if an
774 explicit list was given. This function is a top-level function that is obeyed
775 as a result of the -bp argument. As there may be a lot of messages on the
776 queue, we must tidy up the store after reading the headers for each one.
779 option 0 => list top-level recipients, with "D" for those delivered
780 1 => list only undelivered top-level recipients
781 2 => as 0, plus any generated delivered recipients
782 If 8 is added to any of these values, the queue is listed in
784 list => first of any message ids to list
785 count count of message ids; 0 => all
791 queue_list(int option, uschar **list, int count)
794 int now = (int)time(NULL);
796 queue_filename * qf = NULL;
799 /* If given a list of messages, build a chain containing their ids. */
803 queue_filename *last = NULL;
804 for (int i = 0; i < count; i++)
806 queue_filename *next =
807 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
808 sprintf(CS next->text, "%s-H", list[i]);
809 next->dir_uschar = '*';
811 if (i == 0) qf = next; else last->next = next;
816 /* Otherwise get a list of the entire queue, in order if necessary. */
819 qf = queue_get_spool_list(
820 -1, /* entire queue */
821 subdirs, /* for holding sub list */
822 &subcount, /* for subcount */
823 option >= 8); /* randomize if required */
825 if (option >= 8) option -= 8;
827 /* Now scan the chain and print information, resetting store used
831 qf && (reset_point = store_mark());
832 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
840 message_subdir[0] = qf->dir_uschar;
841 rc = spool_read_header(qf->text, FALSE, count <= 0);
842 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
846 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
853 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
855 ptr = Ustrlen(fname)-1;
858 /* Add the data size to the header size; don't count the file name
859 at the start of the data file, but add one for the notional blank line
860 that precedes the data. */
862 if (Ustat(fname, &statbuf) == 0)
863 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
864 i = (now - received_time.tv_sec)/60; /* minutes on queue */
868 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
870 else printf("%2dm ", i);
872 /* Collect delivered addresses from any J file */
875 if ((jread = Ufopen(fname, "rb")))
877 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
879 int n = Ustrlen(big_buffer);
881 tree_add_nonrecipient(big_buffer);
887 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
888 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
890 if (env_read && sender_address)
892 printf(" <%s>", sender_address);
893 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
896 if (rc != spool_read_OK)
899 if (save_errno == ERRNO_SPOOLFORMAT)
902 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
904 if (Ustat(fname, &statbuf) == 0)
905 printf("*** spool format error: size=" OFF_T_FMT " ***",
907 else printf("*** spool format error ***");
909 else printf("*** spool read error: %s ***", strerror(save_errno));
910 if (rc != spool_read_hdrerror)
917 if (f.deliver_freeze) printf(" *** frozen ***");
923 for (int i = 0; i < recipients_count; i++)
925 tree_node *delivered =
926 tree_search(tree_nonrecipients, recipients_list[i].address);
927 if (!delivered || option != 1)
929 delivered ? "D" : " ", recipients_list[i].address);
930 if (delivered) delivered->data.val = TRUE;
932 if (option == 2 && tree_nonrecipients)
933 queue_list_extras(tree_nonrecipients);
941 /*************************************************
942 * Act on a specific message *
943 *************************************************/
945 /* Actions that require a list of addresses make use of argv/argc/
946 recipients_arg. Other actions do not. This function does its own
950 id id of the message to work on
951 action which action is required (MSG_xxx)
952 argv the original argv for Exim
953 argc the original argc for Exim
954 recipients_arg offset to the list of recipients in argv
956 Returns: FALSE if there was any problem
960 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
963 BOOL removed = FALSE;
965 uschar *doing = NULL;
968 uschar spoolname[32];
970 /* Set the global message_id variable, used when re-writing spool files. This
971 also causes message ids to be added to log messages. */
973 Ustrcpy(message_id, id);
975 /* The "actions" that just list the files do not require any locking to be
976 done. Only admin users may read the spool files. */
978 if (action >= MSG_SHOW_BODY)
981 uschar *subdirectory, *suffix;
985 printf("Permission denied\n");
989 if (recipients_arg < argc)
991 printf("*** Only one message can be listed at once\n");
995 if (action == MSG_SHOW_BODY)
997 subdirectory = US"input";
1000 else if (action == MSG_SHOW_HEADER)
1002 subdirectory = US"input";
1007 subdirectory = US"msglog";
1011 for (int i = 0; i < 2; i++)
1013 set_subdir_str(message_subdir, id, i);
1014 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1020 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1022 if (action == MSG_SHOW_LOG && !message_logs)
1023 printf("(No message logs are being created because the message_logs "
1024 "option is false.)\n");
1028 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1029 rc = write(fileno(stdout), big_buffer, rc);
1035 /* For actions that actually act, open and lock the data file to ensure that no
1036 other process is working on this message. If the file does not exist, continue
1037 only if the action is remove and the user is an admin user, to allow for
1038 tidying up broken states. */
1040 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1041 if (errno == ENOENT)
1044 printf("Spool data file for %s does not exist\n", id);
1045 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1046 printf("Continuing, to ensure all files removed\n");
1050 if (errno == 0) printf("Message %s is locked\n", id);
1051 else printf("Couldn't open spool file for %s: %s\n", id,
1056 /* Read the spool header file for the message. Again, continue after an
1057 error only in the case of deleting by an administrator. Setting the third
1058 argument false causes it to look both in the main spool directory and in
1059 the appropriate subdirectory, and set message_subdir according to where it
1060 found the message. */
1062 sprintf(CS spoolname, "%s-H", id);
1063 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1066 if (errno != ERRNO_SPOOLFORMAT)
1067 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1069 printf("Spool format error for %s\n", spoolname);
1070 if (action != MSG_REMOVE || !f.admin_user)
1072 (void)close(deliver_datafile);
1073 deliver_datafile = -1;
1076 printf("Continuing to ensure all files removed\n");
1079 /* Check that the user running this process is entitled to operate on this
1080 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1081 mess about, but the original sender is permitted to remove a message. That's
1082 why we leave this check until after the headers are read. */
1084 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1086 printf("Permission denied\n");
1087 (void)close(deliver_datafile);
1088 deliver_datafile = -1;
1092 /* Set up the user name for logging. */
1094 pw = getpwuid(real_uid);
1095 username = (pw != NULL)?
1096 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1098 /* Take the necessary action. */
1100 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1106 transport_ctx tctx = {{0}};
1107 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1108 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1110 (void) transport_write_message(&tctx, 0);
1116 if (f.deliver_freeze)
1119 printf("is already frozen\n");
1123 f.deliver_freeze = TRUE;
1124 f.deliver_manual_thaw = FALSE;
1125 deliver_frozen_at = time(NULL);
1126 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1128 printf("is now frozen\n");
1129 log_write(0, LOG_MAIN, "frozen by %s", username);
1134 printf("could not be frozen: %s\n", errmsg);
1141 if (!f.deliver_freeze)
1144 printf("is not frozen\n");
1148 f.deliver_freeze = FALSE;
1149 f.deliver_manual_thaw = TRUE;
1150 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1152 printf("is no longer frozen\n");
1153 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1158 printf("could not be unfrozen: %s\n", errmsg);
1164 /* We must ensure all files are removed from both the input directory
1165 and the appropriate subdirectory, to clean up cases when there are odd
1166 files left lying around in odd places. In the normal case message_subdir
1167 will have been set correctly by spool_read_header, but as this is a rare
1168 operation, just run everything twice. */
1176 message_subdir[0] = id[5];
1178 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1180 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1182 DEBUG(D_any) debug_printf(" removing %s", fname);
1183 if (Uunlink(fname) < 0)
1185 if (errno != ENOENT)
1188 printf("Error while removing %s: %s\n", fname, strerror(errno));
1190 else DEBUG(D_any) debug_printf(" (no file)\n");
1195 DEBUG(D_any) debug_printf(" (ok)\n");
1198 for (int i = 0; i < 3; i++)
1202 suffix[1] = (US"DHJ")[i];
1203 fname = spool_fname(US"input", message_subdir, id, suffix);
1205 DEBUG(D_any) debug_printf(" removing %s", fname);
1206 if (Uunlink(fname) < 0)
1208 if (errno != ENOENT)
1211 printf("Error while removing %s: %s\n", fname, strerror(errno));
1213 else DEBUG(D_any) debug_printf(" (no file)\n");
1218 DEBUG(D_any) debug_printf(" (done)\n");
1223 /* In the common case, the datafile is open (and locked), so give the
1224 obvious message. Otherwise be more specific. */
1226 if (deliver_datafile >= 0) printf("has been removed\n");
1227 else printf("has been removed or did not exist\n");
1230 #ifndef DISABLE_EVENT
1231 if (event_action) for (int i = 0; i < recipients_count; i++)
1233 tree_node *delivered =
1234 tree_search(tree_nonrecipients, recipients_list[i].address);
1237 uschar * save_local = deliver_localpart;
1238 const uschar * save_domain = deliver_domain;
1239 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1240 int start, end, dom;
1242 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1243 log_write(0, LOG_MAIN|LOG_PANIC,
1244 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1248 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1249 deliver_domain = dom
1250 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1252 event_raise(event_action, US"msg:fail:internal",
1253 string_sprintf("message removed by %s", username));
1255 deliver_localpart = save_local;
1256 deliver_domain = save_domain;
1260 (void) event_raise(event_action, US"msg:complete", NULL);
1262 log_write(0, LOG_MAIN, "removed by %s", username);
1263 log_write(0, LOG_MAIN, "Completed");
1270 /* The global "queue_name_dest" is used as destination, "queue_name"
1273 spool_move_message(id, message_subdir, US"", US"");
1277 case MSG_MARK_ALL_DELIVERED:
1278 for (int i = 0; i < recipients_count; i++)
1279 tree_add_nonrecipient(recipients_list[i].address);
1281 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1283 printf("has been modified\n");
1284 for (int i = 0; i < recipients_count; i++)
1285 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1286 recipients_list[i].address, username);
1291 printf("- could not mark all delivered: %s\n", errmsg);
1296 case MSG_EDIT_SENDER:
1297 if (recipients_arg < argc - 1)
1300 printf("- only one sender address can be specified\n");
1303 doing = US"editing sender";
1306 case MSG_ADD_RECIPIENT:
1307 if (doing == NULL) doing = US"adding recipient";
1310 case MSG_MARK_DELIVERED:
1311 if (doing == NULL) doing = US"marking as delivered";
1313 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1315 if (recipients_arg >= argc)
1318 printf("- error while %s: no address given\n", doing);
1322 for (; recipients_arg < argc; recipients_arg++)
1324 int start, end, domain;
1327 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1328 &domain, (action == MSG_EDIT_SENDER));
1330 if (recipient == NULL)
1333 printf("- error while %s:\n bad address %s: %s\n",
1334 doing, argv[recipients_arg], errmess);
1336 else if (recipient[0] != 0 && domain == 0)
1339 printf("- error while %s:\n bad address %s: "
1340 "domain missing\n", doing, argv[recipients_arg]);
1344 if (action == MSG_ADD_RECIPIENT)
1347 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1349 receive_add_recipient(recipient, -1);
1350 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1351 recipient, username);
1353 else if (action == MSG_MARK_DELIVERED)
1356 for (i = 0; i < recipients_count; i++)
1357 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1358 if (i >= recipients_count)
1360 printf("- error while %s:\n %s is not a recipient:"
1361 " message not updated\n", doing, recipient);
1366 tree_add_nonrecipient(recipients_list[i].address);
1367 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1368 recipient, username);
1371 else /* MSG_EDIT_SENDER */
1374 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1376 sender_address = recipient;
1377 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1378 recipient, username);
1384 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1385 printf("has been modified\n");
1389 printf("- while %s: %s\n", doing, errmsg);
1395 /* Closing the datafile releases the lock and permits other processes
1396 to operate on the message (if it still exists). */
1398 if (deliver_datafile >= 0)
1400 (void)close(deliver_datafile);
1401 deliver_datafile = -1;
1408 /*************************************************
1409 * Check the queue_only_file condition *
1410 *************************************************/
1412 /* The queue_only_file option forces certain kinds of queueing if a given file
1420 queue_check_only(void)
1423 struct stat statbuf;
1426 uschar buffer[1024];
1428 if (queue_only_file == NULL) return;
1430 s = queue_only_file;
1431 while ((ss = string_nextinlist(&s, &sep, buffer, sizeof(buffer))) != NULL)
1433 if (Ustrncmp(ss, "smtp", 4) == 0)
1436 if (Ustat(ss, &statbuf) == 0)
1438 f.queue_smtp = TRUE;
1439 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1444 if (Ustat(ss, &statbuf) == 0)
1447 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1453 #endif /*!COMPILE_UTILITY*/
1455 /* End of queue.c */