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 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
351 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
352 gets set. Save the queue_runner's pid and the flag that indicates any
353 deliveries run directly from this process. Deliveries that are run by handing
354 on TCP/IP channels have queue_run_pid set, but not queue_running. */
356 queue_domains = NULL;
357 queue_smtp_domains = NULL;
358 f.queue_smtp = f.queue_2stage;
360 queue_run_pid = getpid();
361 f.queue_running = TRUE;
363 /* Log the true start of a queue run, and fancy options */
370 if (f.queue_2stage) *p++ = 'q';
371 if (f.queue_run_first_delivery) *p++ = 'i';
372 if (f.queue_run_force) *p++ = 'f';
373 if (f.deliver_force_thaw) *p++ = 'f';
374 if (f.queue_run_local) *p++ = 'l';
378 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
381 p += sprintf(CS p, " -q%s", extras);
383 if (deliver_selectstring)
384 p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "",
385 deliver_selectstring);
387 if (deliver_selectstring_sender)
388 p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "",
389 deliver_selectstring_sender);
391 log_detail = string_copy(big_buffer);
393 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
394 queue_name, log_detail);
396 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
399 /* If deliver_selectstring is a regex, compile it. */
401 if (deliver_selectstring && f.deliver_selectstring_regex)
402 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
404 if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex)
405 selectstring_regex_sender =
406 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
408 /* If the spool is split into subdirectories, we want to process it one
409 directory at a time, so as to spread out the directory scanning and the
410 delivering when there are lots of messages involved, except when
411 queue_run_in_order is set.
413 In the random order case, this loop runs once for the main directory (handling
414 any messages therein), and then repeats for any subdirectories that were found.
415 When the first argument of queue_get_spool_list() is 0, it scans the top
416 directory, fills in subdirs, and sets subcount. The order of the directories is
417 then randomized after the first time through, before they are scanned in
418 subsequent iterations.
420 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
421 order), it scans all directories and makes a single message list. */
423 for (int i = queue_run_in_order ? -1 : 0;
424 i <= (queue_run_in_order ? -1 : subcount);
427 rmark reset_point1 = store_mark();
432 debug_printf("queue running main directory\n");
434 debug_printf("queue running combined directories\n");
436 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
439 for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount,
440 !queue_run_in_order);
449 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
450 check that the load average is low enough to permit deliveries. */
452 if (!f.queue_run_force && deliver_queue_load_max >= 0)
453 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
455 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
457 (double)load_average/1000.0,
458 (double)deliver_queue_load_max/1000.0);
459 i = subcount; /* Don't process other directories */
463 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
464 (double)load_average/1000.0,
465 (double)deliver_queue_load_max/1000.0);
467 /* Skip this message unless it's within the ID limits */
469 if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0)
471 if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0)
474 /* Check that the message still exists */
476 message_subdir[0] = fq->dir_uschar;
477 if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0)
480 /* There are some tests that require the reading of the header file. Ensure
481 the store used is scavenged afterwards so that this process doesn't keep
482 growing its store. We have to read the header file again when actually
483 delivering, but it's cheaper than forking a delivery process for each
484 message when many are not going to be delivered. */
486 if (deliver_selectstring || deliver_selectstring_sender ||
487 f.queue_run_first_delivery)
490 BOOL orig_dont_deliver = f.dont_deliver;
491 rmark reset_point2 = store_mark();
493 /* Restore the original setting of dont_deliver after reading the header,
494 so that a setting for a particular message doesn't force it for any that
495 follow. If the message is chosen for delivery, the header is read again
496 in the deliver_message() function, in a subprocess. */
498 if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) continue;
499 f.dont_deliver = orig_dont_deliver;
501 /* Now decide if we want to deliver this message. As we have read the
502 header file, we might as well do the freeze test now, and save forking
505 if (f.deliver_freeze && !f.deliver_force_thaw)
507 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
511 /* Check first_delivery in the case when there are no message logs. */
513 else if (f.queue_run_first_delivery && !f.deliver_firsttime)
515 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text);
519 /* Check for a matching address if deliver_selectstring[_sender] is set.
520 If so, we do a fully delivery - don't want to omit other addresses since
521 their routing might trigger re-writing etc. */
523 /* Sender matching */
525 else if ( deliver_selectstring_sender
526 && !(f.deliver_selectstring_sender_regex
527 ? (pcre_exec(selectstring_regex_sender, NULL,
528 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
530 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
534 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
535 fq->text, deliver_selectstring_sender);
539 /* Recipient matching */
541 else if (deliver_selectstring)
544 for (i = 0; i < recipients_count; i++)
546 uschar *address = recipients_list[i].address;
547 if ( (f.deliver_selectstring_regex
548 ? (pcre_exec(selectstring_regex, NULL, CS address,
549 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
550 : (strstric(address, deliver_selectstring, FALSE) != NULL)
552 && tree_search(tree_nonrecipients, address) == NULL
557 if (i >= recipients_count)
560 debug_printf("%s: no recipient address matched %s\n",
561 fq->text, deliver_selectstring);
566 /* Recover store used when reading the header */
568 spool_clear_header_globals();
569 store_reset(reset_point2);
570 if (!wanted) continue; /* With next message */
573 /* OK, got a message we want to deliver. Create a pipe which will
574 serve as a means of detecting when all the processes created by the
575 delivery process are finished. This is relevant when the delivery
576 process passes one or more SMTP channels on to its own children. The
577 pipe gets passed down; by reading on it here we detect when the last
578 descendent dies by the unblocking of the read. It's a pity that for
579 most of the time the pipe isn't used, but creating a pipe should be
583 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
584 "runner process %d: %s", queue_run_pid, strerror(errno));
585 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
587 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
590 if (queue_run_pipe == 0)
592 queue_run_pipe = dup(queue_run_pipe);
596 /* Before forking to deliver the message, ensure any open and cached
597 lookup files or databases are closed. Otherwise, closing in the subprocess
598 can make the next subprocess have problems. There won't often be anything
599 open here, but it is possible (e.g. if spool_directory is an expanded
600 string). A single call before this loop would probably suffice, but just in
601 case expansions get inserted at some point, I've taken the heavy-handed
602 approach. When nothing is open, the call should be cheap. */
606 /* Now deliver the message; get the id by cutting the -H off the file
607 name. The return of the process is zero if a delivery was attempted. */
609 set_process_info("running queue: %s", fq->text);
610 fq->text[SPOOL_NAME_LENGTH-2] = 0;
611 if ((pid = fork()) == 0)
614 if (f.running_in_test_harness) millisleep(100);
615 (void)close(pfd[pipe_read]);
616 rc = deliver_message(fq->text, force_delivery, FALSE);
617 exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED);
620 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
621 "queue runner %d failed\n", queue_run_pid);
623 /* Close the writing end of the synchronizing pipe in this process,
624 then wait for the first level process to terminate. */
626 (void)close(pfd[pipe_write]);
627 set_process_info("running queue: waiting for %s (%d)", fq->text, pid);
628 while (wait(&status) != pid);
630 /* A zero return means a delivery was attempted; turn off the force flag
631 for any subsequent calls unless queue_force is set. */
633 if ((status & 0xffff) == 0) force_delivery = f.queue_run_force;
635 /* If the process crashed, tell somebody */
637 else if ((status & 0x00ff) != 0)
638 log_write(0, LOG_MAIN|LOG_PANIC,
639 "queue run: process %d crashed with signal %d while delivering %s",
640 (int)pid, status & 0x00ff, fq->text);
642 /* Before continuing, wait till the pipe gets closed at the far end. This
643 tells us that any children created by the delivery to re-use any SMTP
644 channels have all finished. Since no process actually writes to the pipe,
645 the mere fact that read() unblocks is enough. */
647 set_process_info("running queue: waiting for children of %d", pid);
648 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
649 log_write(0, LOG_MAIN|LOG_PANIC, "queue run: %s on pipe",
650 status > 0 ? "unexpected data" : "error");
651 (void)close(pfd[pipe_read]);
652 set_process_info("running queue");
654 /* If we are in the test harness, and this is not the first of a 2-stage
655 queue run, update fudged queue times. */
657 if (f.running_in_test_harness && !f.queue_2stage)
659 uschar *fqtnext = Ustrchr(fudged_queue_times, '/');
660 if (fqtnext != NULL) fudged_queue_times = fqtnext + 1;
662 } /* End loop for list of messages */
664 tree_nonrecipients = NULL;
665 store_reset(reset_point1); /* Scavenge list of messages */
667 /* If this was the first time through for random order processing, and
668 sub-directories have been found, randomize their order if necessary. */
670 if (i == 0 && subcount > 1 && !queue_run_in_order)
671 for (int j = 1; j <= subcount; j++)
674 if ((r = random_number(100)) >= 50)
676 int k = (r % subcount) + 1;
678 subdirs[j] = subdirs[k];
682 } /* End loop for multiple directories */
684 /* If queue_2stage is true, we do it all again, with the 2stage flag
689 f.queue_2stage = FALSE;
690 queue_run(start_id, stop_id, TRUE);
693 /* At top level, log the end of the run. */
697 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
698 queue_name, log_detail);
700 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
706 /************************************************
707 * Count messages on the queue *
708 ************************************************/
710 /* Called as a result of -bpc
723 for (queue_filename *f = queue_get_spool_list(
724 -1, /* entire queue */
725 subdirs, /* for holding sub list */
726 &subcount, /* for subcount */
727 FALSE); /* not random */
728 f; f = f->next) count++;
729 fprintf(stdout, "%d\n", count);
734 /************************************************
735 * List extra deliveries *
736 ************************************************/
738 /* This is called from queue_list below to print out all addresses that
739 have received a message but which were not primary addresses. That is, all
740 the addresses in the tree of non-recipients that are not primary addresses.
741 The tree has been scanned and the data field filled in for those that are
744 Argument: points to the tree node
749 queue_list_extras(tree_node *p)
751 if (p->left) queue_list_extras(p->left);
752 if (!p->data.val) printf(" +D %s\n", p->name);
753 if (p->right) queue_list_extras(p->right);
758 /************************************************
759 * List messages on the queue *
760 ************************************************/
762 /* Or a given list of messages. In the "all" case, we get a list of file names
763 as quickly as possible, then scan each one for information to output. If any
764 disappear while we are processing, just leave them out, but give an error if an
765 explicit list was given. This function is a top-level function that is obeyed
766 as a result of the -bp argument. As there may be a lot of messages on the
767 queue, we must tidy up the store after reading the headers for each one.
770 option 0 => list top-level recipients, with "D" for those delivered
771 1 => list only undelivered top-level recipients
772 2 => as 0, plus any generated delivered recipients
773 If 8 is added to any of these values, the queue is listed in
775 list => first of any message ids to list
776 count count of message ids; 0 => all
782 queue_list(int option, uschar **list, int count)
785 int now = (int)time(NULL);
787 queue_filename * qf = NULL;
790 /* If given a list of messages, build a chain containing their ids. */
794 queue_filename *last = NULL;
795 for (int i = 0; i < count; i++)
797 queue_filename *next =
798 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i]));
799 sprintf(CS next->text, "%s-H", list[i]);
800 next->dir_uschar = '*';
802 if (i == 0) qf = next; else last->next = next;
807 /* Otherwise get a list of the entire queue, in order if necessary. */
810 qf = queue_get_spool_list(
811 -1, /* entire queue */
812 subdirs, /* for holding sub list */
813 &subcount, /* for subcount */
814 option >= 8); /* randomize if required */
816 if (option >= 8) option -= 8;
818 /* Now scan the chain and print information, resetting store used
822 qf && (reset_point = store_mark());
823 spool_clear_header_globals(), store_reset(reset_point), qf = qf->next
831 message_subdir[0] = qf->dir_uschar;
832 rc = spool_read_header(qf->text, FALSE, count <= 0);
833 if (rc == spool_read_notopen && errno == ENOENT && count <= 0)
837 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
844 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
846 ptr = Ustrlen(fname)-1;
849 /* Add the data size to the header size; don't count the file name
850 at the start of the data file, but add one for the notional blank line
851 that precedes the data. */
853 if (Ustat(fname, &statbuf) == 0)
854 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
855 i = (now - received_time.tv_sec)/60; /* minutes on queue */
859 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
861 else printf("%2dm ", i);
863 /* Collect delivered addresses from any J file */
866 if ((jread = Ufopen(fname, "rb")))
868 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
870 int n = Ustrlen(big_buffer);
872 tree_add_nonrecipient(big_buffer);
878 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
879 for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout);
881 if (env_read && sender_address)
883 printf(" <%s>", sender_address);
884 if (f.sender_set_untrusted) printf(" (%s)", originator_login);
887 if (rc != spool_read_OK)
890 if (save_errno == ERRNO_SPOOLFORMAT)
893 uschar * fname = spool_fname(US"input", message_subdir, qf->text, US"");
895 if (Ustat(fname, &statbuf) == 0)
896 printf("*** spool format error: size=" OFF_T_FMT " ***",
898 else printf("*** spool format error ***");
900 else printf("*** spool read error: %s ***", strerror(save_errno));
901 if (rc != spool_read_hdrerror)
908 if (f.deliver_freeze) printf(" *** frozen ***");
914 for (int i = 0; i < recipients_count; i++)
916 tree_node *delivered =
917 tree_search(tree_nonrecipients, recipients_list[i].address);
918 if (!delivered || option != 1)
920 delivered ? "D" : " ", recipients_list[i].address);
921 if (delivered) delivered->data.val = TRUE;
923 if (option == 2 && tree_nonrecipients)
924 queue_list_extras(tree_nonrecipients);
932 /*************************************************
933 * Act on a specific message *
934 *************************************************/
936 /* Actions that require a list of addresses make use of argv/argc/
937 recipients_arg. Other actions do not. This function does its own
941 id id of the message to work on
942 action which action is required (MSG_xxx)
943 argv the original argv for Exim
944 argc the original argc for Exim
945 recipients_arg offset to the list of recipients in argv
947 Returns: FALSE if there was any problem
951 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
954 BOOL removed = FALSE;
956 uschar *doing = NULL;
959 uschar spoolname[32];
961 /* Set the global message_id variable, used when re-writing spool files. This
962 also causes message ids to be added to log messages. */
964 Ustrcpy(message_id, id);
966 /* The "actions" that just list the files do not require any locking to be
967 done. Only admin users may read the spool files. */
969 if (action >= MSG_SHOW_BODY)
972 uschar *subdirectory, *suffix;
976 printf("Permission denied\n");
980 if (recipients_arg < argc)
982 printf("*** Only one message can be listed at once\n");
986 if (action == MSG_SHOW_BODY)
988 subdirectory = US"input";
991 else if (action == MSG_SHOW_HEADER)
993 subdirectory = US"input";
998 subdirectory = US"msglog";
1002 for (int i = 0; i < 2; i++)
1004 set_subdir_str(message_subdir, id, i);
1005 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1011 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1013 if (action == MSG_SHOW_LOG && !message_logs)
1014 printf("(No message logs are being created because the message_logs "
1015 "option is false.)\n");
1019 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1020 rc = write(fileno(stdout), big_buffer, rc);
1026 /* For actions that actually act, open and lock the data file to ensure that no
1027 other process is working on this message. If the file does not exist, continue
1028 only if the action is remove and the user is an admin user, to allow for
1029 tidying up broken states. */
1031 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1032 if (errno == ENOENT)
1035 printf("Spool data file for %s does not exist\n", id);
1036 if (action != MSG_REMOVE || !f.admin_user) return FALSE;
1037 printf("Continuing, to ensure all files removed\n");
1041 if (errno == 0) printf("Message %s is locked\n", id);
1042 else printf("Couldn't open spool file for %s: %s\n", id,
1047 /* Read the spool header file for the message. Again, continue after an
1048 error only in the case of deleting by an administrator. Setting the third
1049 argument false causes it to look both in the main spool directory and in
1050 the appropriate subdirectory, and set message_subdir according to where it
1051 found the message. */
1053 sprintf(CS spoolname, "%s-H", id);
1054 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1057 if (errno != ERRNO_SPOOLFORMAT)
1058 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1060 printf("Spool format error for %s\n", spoolname);
1061 if (action != MSG_REMOVE || !f.admin_user)
1063 (void)close(deliver_datafile);
1064 deliver_datafile = -1;
1067 printf("Continuing to ensure all files removed\n");
1070 /* Check that the user running this process is entitled to operate on this
1071 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1072 mess about, but the original sender is permitted to remove a message. That's
1073 why we leave this check until after the headers are read. */
1075 if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1077 printf("Permission denied\n");
1078 (void)close(deliver_datafile);
1079 deliver_datafile = -1;
1083 /* Set up the user name for logging. */
1085 pw = getpwuid(real_uid);
1086 username = (pw != NULL)?
1087 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1089 /* Take the necessary action. */
1091 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1097 transport_ctx tctx = {{0}};
1098 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1099 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1101 (void) transport_write_message(&tctx, 0);
1107 if (f.deliver_freeze)
1110 printf("is already frozen\n");
1114 f.deliver_freeze = TRUE;
1115 f.deliver_manual_thaw = FALSE;
1116 deliver_frozen_at = time(NULL);
1117 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1119 printf("is now frozen\n");
1120 log_write(0, LOG_MAIN, "frozen by %s", username);
1125 printf("could not be frozen: %s\n", errmsg);
1132 if (!f.deliver_freeze)
1135 printf("is not frozen\n");
1139 f.deliver_freeze = FALSE;
1140 f.deliver_manual_thaw = TRUE;
1141 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1143 printf("is no longer frozen\n");
1144 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1149 printf("could not be unfrozen: %s\n", errmsg);
1155 /* We must ensure all files are removed from both the input directory
1156 and the appropriate subdirectory, to clean up cases when there are odd
1157 files left lying around in odd places. In the normal case message_subdir
1158 will have been set correctly by spool_read_header, but as this is a rare
1159 operation, just run everything twice. */
1167 message_subdir[0] = id[5];
1169 for (int j = 0; j < 2; message_subdir[0] = 0, j++)
1171 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1173 DEBUG(D_any) debug_printf(" removing %s", fname);
1174 if (Uunlink(fname) < 0)
1176 if (errno != ENOENT)
1179 printf("Error while removing %s: %s\n", fname, strerror(errno));
1181 else DEBUG(D_any) debug_printf(" (no file)\n");
1186 DEBUG(D_any) debug_printf(" (ok)\n");
1189 for (int i = 0; i < 3; i++)
1193 suffix[1] = (US"DHJ")[i];
1194 fname = spool_fname(US"input", message_subdir, id, suffix);
1196 DEBUG(D_any) debug_printf(" removing %s", fname);
1197 if (Uunlink(fname) < 0)
1199 if (errno != ENOENT)
1202 printf("Error while removing %s: %s\n", fname, strerror(errno));
1204 else DEBUG(D_any) debug_printf(" (no file)\n");
1209 DEBUG(D_any) debug_printf(" (done)\n");
1214 /* In the common case, the datafile is open (and locked), so give the
1215 obvious message. Otherwise be more specific. */
1217 if (deliver_datafile >= 0) printf("has been removed\n");
1218 else printf("has been removed or did not exist\n");
1221 #ifndef DISABLE_EVENT
1222 if (event_action) for (int i = 0; i < recipients_count; i++)
1224 tree_node *delivered =
1225 tree_search(tree_nonrecipients, recipients_list[i].address);
1228 uschar * save_local = deliver_localpart;
1229 const uschar * save_domain = deliver_domain;
1230 uschar * addr = recipients_list[i].address, * errmsg = NULL;
1231 int start, end, dom;
1233 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
1234 log_write(0, LOG_MAIN|LOG_PANIC,
1235 "failed to parse address '%.100s'\n: %s", addr, errmsg);
1239 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
1240 deliver_domain = dom
1241 ? CUS string_copyn(addr+dom, end - dom) : CUS"";
1243 event_raise(event_action, US"msg:fail:internal",
1244 string_sprintf("message removed by %s", username));
1246 deliver_localpart = save_local;
1247 deliver_domain = save_domain;
1251 (void) event_raise(event_action, US"msg:complete", NULL);
1253 log_write(0, LOG_MAIN, "removed by %s", username);
1254 log_write(0, LOG_MAIN, "Completed");
1260 case MSG_MARK_ALL_DELIVERED:
1261 for (int i = 0; i < recipients_count; i++)
1262 tree_add_nonrecipient(recipients_list[i].address);
1264 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1266 printf("has been modified\n");
1267 for (int i = 0; i < recipients_count; i++)
1268 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1269 recipients_list[i].address, username);
1274 printf("- could not mark all delivered: %s\n", errmsg);
1279 case MSG_EDIT_SENDER:
1280 if (recipients_arg < argc - 1)
1283 printf("- only one sender address can be specified\n");
1286 doing = US"editing sender";
1289 case MSG_ADD_RECIPIENT:
1290 if (doing == NULL) doing = US"adding recipient";
1293 case MSG_MARK_DELIVERED:
1294 if (doing == NULL) doing = US"marking as delivered";
1296 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1298 if (recipients_arg >= argc)
1301 printf("- error while %s: no address given\n", doing);
1305 for (; recipients_arg < argc; recipients_arg++)
1307 int start, end, domain;
1310 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1311 &domain, (action == MSG_EDIT_SENDER));
1313 if (recipient == NULL)
1316 printf("- error while %s:\n bad address %s: %s\n",
1317 doing, argv[recipients_arg], errmess);
1319 else if (recipient[0] != 0 && domain == 0)
1322 printf("- error while %s:\n bad address %s: "
1323 "domain missing\n", doing, argv[recipients_arg]);
1327 if (action == MSG_ADD_RECIPIENT)
1330 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1332 receive_add_recipient(recipient, -1);
1333 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1334 recipient, username);
1336 else if (action == MSG_MARK_DELIVERED)
1339 for (i = 0; i < recipients_count; i++)
1340 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1341 if (i >= recipients_count)
1343 printf("- error while %s:\n %s is not a recipient:"
1344 " message not updated\n", doing, recipient);
1349 tree_add_nonrecipient(recipients_list[i].address);
1350 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1351 recipient, username);
1354 else /* MSG_EDIT_SENDER */
1357 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1359 sender_address = recipient;
1360 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1361 recipient, username);
1367 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1368 printf("has been modified\n");
1372 printf("- while %s: %s\n", doing, errmsg);
1378 /* Closing the datafile releases the lock and permits other processes
1379 to operate on the message (if it still exists). */
1381 if (deliver_datafile >= 0)
1383 (void)close(deliver_datafile);
1384 deliver_datafile = -1;
1391 /*************************************************
1392 * Check the queue_only_file condition *
1393 *************************************************/
1395 /* The queue_only_file option forces certain kinds of queueing if a given file
1403 queue_check_only(void)
1406 struct stat statbuf;
1409 uschar buffer[1024];
1411 if (queue_only_file == NULL) return;
1413 s = queue_only_file;
1414 while ((ss = string_nextinlist(&s, &sep, buffer, sizeof(buffer))) != NULL)
1416 if (Ustrncmp(ss, "smtp", 4) == 0)
1419 if (Ustat(ss, &statbuf) == 0)
1421 f.queue_smtp = TRUE;
1422 DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss);
1427 if (Ustat(ss, &statbuf) == 0)
1430 DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss);
1436 #endif /*!COMPILE_UTILITY*/
1438 /* End of queue.c */