1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions that operate on the input queue. */
15 /* Routines with knowlege of spool layout */
17 #ifndef COMPILE_UTILITY
19 spool_pname_buf(uschar * buf, int len)
21 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
25 spool_dname(const uschar * purpose, uschar * subdir)
27 return string_sprintf("%s/%s/%s/%s",
28 spool_directory, queue_name, purpose, subdir);
33 spool_sname(const uschar * purpose, uschar * subdir)
35 return string_sprintf("%s%s%s%s%s",
36 queue_name, *queue_name ? "/" : "",
38 *subdir ? "/" : "", subdir);
42 spool_fname(const uschar * purpose, uschar * subdir, uschar * fname, uschar * suffix)
44 return string_sprintf("%s/%s/%s/%s/%s%s",
45 spool_directory, queue_name, purpose, subdir, fname, suffix);
51 #ifndef COMPILE_UTILITY
53 /* The number of nodes to use for the bottom-up merge sort when a list of queue
54 items is to be ordered. The code for this sort was contributed as a patch by
57 #define LOG2_MAXNODES 32
61 /*************************************************
62 * Helper sort function for queue_get_spool_list *
63 *************************************************/
65 /* This function is used when sorting the queue list in the function
66 queue_get_spool_list() below.
69 a points to an ordered list of queue_filename items
70 b points to another ordered list
72 Returns: a pointer to a merged ordered list
75 static queue_filename *
76 merge_queue_lists(queue_filename *a, queue_filename *b)
78 queue_filename *first = NULL;
79 queue_filename **append = &first;
82 if (Ustrcmp(a->text, b->text) < 0)
103 /*************************************************
104 * Get list of spool files *
105 *************************************************/
107 /* Scan the spool directory and return a list of the relevant file names
108 therein. Single-character sub-directories are handled as follows:
110 If the first argument is > 0, a sub-directory is scanned; the letter is
111 taken from the nth entry in subdirs.
113 If the first argument is 0, sub-directories are not scanned. However, a
114 list of them is returned.
116 If the first argument is < 0, sub-directories are scanned for messages,
117 and a single, unified list is created. The returned data blocks contain the
118 identifying character of the subdirectory, if any. The subdirs vector is
119 still required as an argument.
121 If the randomize argument is TRUE, messages are returned in "randomized" order.
122 Actually, the order is anything but random, but the algorithm is cheap, and the
123 point is simply to ensure that the same order doesn't occur every time, in case
124 a particular message is causing a remote MTA to barf - we would like to try
125 other messages to that MTA first.
127 If the randomize argument is FALSE, sort the list according to the file name.
128 This should give the order in which the messages arrived. It is normally used
129 only for presentation to humans, in which case the (possibly expensive) sort
130 that it does is not part of the normal operational code. However, if
131 queue_run_in_order is set, sorting has to take place for queue runs as well.
132 When randomize is FALSE, the first argument is normally -1, so all messages are
136 subdiroffset sub-directory character offset, or 0 or -1 (see above)
137 subdirs vector to store list of subdirchars
138 subcount pointer to int in which to store count of subdirs
139 randomize TRUE if the order of the list is to be unpredictable
141 Returns: pointer to a chain of queue name items
144 static queue_filename *
145 queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount,
152 queue_filename *yield = NULL;
153 queue_filename *last = NULL;
157 queue_filename *root[LOG2_MAXNODES];
159 /* When randomizing, the file names are added to the start or end of the list
160 according to the bits of the flags variable. Get a collection of bits from the
161 current time. Use the bottom 16 and just keep re-using them if necessary. When
162 not randomizing, initialize the sublists for the bottom-up merge sort. */
165 resetflags = time(NULL) & 0xFFFF;
167 for (i = 0; i < LOG2_MAXNODES; i++)
170 /* If processing the full queue, or just the top-level, start at the base
171 directory, and initialize the first subdirectory name (as none). Otherwise,
172 start at the sub-directory offset. */
174 if (subdiroffset <= 0)
183 /* Set up prototype for the directory name. */
185 spool_pname_buf(buffer, sizeof(buffer));
186 buffer[sizeof(buffer) - 3] = 0;
187 subptr = Ustrlen(buffer);
188 buffer[subptr+2] = 0; /* terminator for lengthened name */
190 /* This loop runs at least once, for the main or given directory, and then as
191 many times as necessary to scan any subdirectories encountered in the main
192 directory, if they are to be scanned at this time. */
194 for (; i <= *subcount; i++)
197 int subdirchar = subdirs[i]; /* 0 for main directory */
201 buffer[subptr] = '/';
202 buffer[subptr+1] = subdirchar;
205 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
206 if (!(dd = opendir(CS buffer)))
209 /* Now scan the directory. */
211 while ((ent = readdir(dd)))
213 uschar *name = US ent->d_name;
214 int len = Ustrlen(name);
220 /* If we find a single alphameric sub-directory in the base directory,
221 add it to the list for subsequent scans. */
223 if (i == 0 && len == 1 && isalnum(*name))
225 *subcount = *subcount + 1;
226 subdirs[*subcount] = *name;
230 /* Otherwise, if it is a header spool file, add it to the list */
232 if (len == SPOOL_NAME_LENGTH &&
233 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
235 queue_filename *next =
236 store_get(sizeof(queue_filename) + Ustrlen(name));
237 Ustrcpy(next->text, name);
238 next->dir_uschar = subdirchar;
240 /* Handle the creation of a randomized list. The first item becomes both
241 the top and bottom of the list. Subsequent items are inserted either at
242 the top or the bottom, randomly. This is, I argue, faster than doing a
243 sort by allocating a random number to each item, and it also saves having
244 to store the number with each item. */
256 if ((flags & 1) == 0)
270 /* Otherwise do a bottom-up merge sort based on the name. */
276 for (j = 0; j < LOG2_MAXNODES; j++)
279 next = merge_queue_lists(next, root[j]);
280 root[j] = (j == LOG2_MAXNODES - 1)? next : NULL;
291 /* Finished with this directory */
295 /* If we have just scanned a sub-directory, and it was empty (count == 2
296 implies just "." and ".." entries), and Exim is no longer configured to
297 use sub-directories, attempt to get rid of it. At the same time, try to
298 get rid of any corresponding msglog subdirectory. These are just cosmetic
299 tidying actions, so just ignore failures. If we are scanning just a single
300 sub-directory, break the loop. */
304 if (!split_spool_directory && count <= 2)
309 subdir[0] = subdirchar; subdir[1] = 0;
310 rmdir(CS spool_dname(US"msglog", subdir));
312 if (subdiroffset > 0) break; /* Single sub-directory */
315 /* If we have just scanned the base directory, and subdiroffset is 0,
316 we do not want to continue scanning the sub-directories. */
318 else if (subdiroffset == 0)
320 } /* Loop for multiple subdirectories */
322 /* When using a bottom-up merge sort, do the final merging of the sublists.
323 Then pass back the final list of file items. */
326 for (i = 0; i < LOG2_MAXNODES; ++i)
327 yield = merge_queue_lists(yield, root[i]);
335 /*************************************************
336 * Perform a queue run *
337 *************************************************/
339 /* The arguments give the messages to start and stop at; NULL means start at
340 the beginning or stop at the end. If the given start message doesn't exist, we
341 start at the next lexically greater one, and likewise we stop at the after the
342 previous lexically lesser one if the given stop message doesn't exist. Because
343 a queue run can take some time, stat each file before forking, in case it has
344 been delivered in the meantime by some other means.
346 The global variables queue_run_force and queue_run_local may be set to cause
347 forced deliveries or local-only deliveries, respectively.
349 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
350 not contain the string. As this option is typically used when a machine comes
351 back online, we want to ensure that at least one delivery attempt takes place,
352 so force the first one. The selecting string can optionally be a regex, or
353 refer to the sender instead of recipients.
355 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
356 is set so that routing is done for all messages. Thus in the second run those
357 that are routed to the same host should go down the same SMTP connection.
360 start_id message id to start at, or NULL for all
361 stop_id message id to end at, or NULL for all
362 recurse TRUE if recursing for 2-stage run
368 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
370 BOOL force_delivery = queue_run_force || deliver_selectstring != NULL ||
371 deliver_selectstring_sender != NULL;
372 const pcre *selectstring_regex = NULL;
373 const pcre *selectstring_regex_sender = NULL;
374 uschar *log_detail = NULL;
379 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
380 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
381 gets set. Save the queue_runner's pid and the flag that indicates any
382 deliveries run directly from this process. Deliveries that are run by handing
383 on TCP/IP channels have queue_run_pid set, but not queue_running. */
385 queue_domains = NULL;
386 queue_smtp_domains = NULL;
387 queue_smtp = queue_2stage;
389 queue_run_pid = getpid();
390 queue_running = TRUE;
392 /* Log the true start of a queue run, and fancy options */
399 if (queue_2stage) *p++ = 'q';
400 if (queue_run_first_delivery) *p++ = 'i';
401 if (queue_run_force) *p++ = 'f';
402 if (deliver_force_thaw) *p++ = 'f';
403 if (queue_run_local) *p++ = 'l';
407 sprintf(CS p, "pid=%d", (int)queue_run_pid);
412 sprintf(CS p, " -q%s", extras);
416 if (deliver_selectstring != NULL)
418 sprintf(CS p, " -R%s %s", deliver_selectstring_regex? "r" : "",
419 deliver_selectstring);
423 if (deliver_selectstring_sender != NULL)
425 sprintf(CS p, " -S%s %s", deliver_selectstring_sender_regex? "r" : "",
426 deliver_selectstring_sender);
430 log_detail = string_copy(big_buffer);
432 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
433 queue_name, log_detail);
435 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
438 /* If deliver_selectstring is a regex, compile it. */
440 if (deliver_selectstring != NULL && deliver_selectstring_regex)
441 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
443 if (deliver_selectstring_sender != NULL && deliver_selectstring_sender_regex)
444 selectstring_regex_sender =
445 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
447 /* If the spool is split into subdirectories, we want to process it one
448 directory at a time, so as to spread out the directory scanning and the
449 delivering when there are lots of messages involved, except when
450 queue_run_in_order is set.
452 In the random order case, this loop runs once for the main directory (handling
453 any messages therein), and then repeats for any subdirectories that were found.
454 When the first argument of queue_get_spool_list() is 0, it scans the top
455 directory, fills in subdirs, and sets subcount. The order of the directories is
456 then randomized after the first time through, before they are scanned in
457 subsqeuent iterations.
459 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
460 order), it scans all directories and makes a single message list. */
462 for (i = (queue_run_in_order? -1 : 0);
463 i <= (queue_run_in_order? -1 : subcount);
467 void *reset_point1 = store_get(0);
472 debug_printf("queue running main directory\n");
474 debug_printf("queue running combined directories\n");
476 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
479 for (f = queue_get_spool_list(i, subdirs, &subcount, !queue_run_in_order);
489 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
490 check that the load average is low enough to permit deliveries. */
492 if (!queue_run_force && deliver_queue_load_max >= 0)
493 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
495 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
497 (double)load_average/1000.0,
498 (double)deliver_queue_load_max/1000.0);
499 i = subcount; /* Don't process other directories */
503 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
504 (double)load_average/1000.0,
505 (double)deliver_queue_load_max/1000.0);
507 /* Skip this message unless it's within the ID limits */
509 if (stop_id && Ustrncmp(f->text, stop_id, MESSAGE_ID_LENGTH) > 0)
511 if (start_id && Ustrncmp(f->text, start_id, MESSAGE_ID_LENGTH) < 0)
514 /* Check that the message still exists */
516 message_subdir[0] = f->dir_uschar;
517 if (Ustat(spool_fname(US"input", message_subdir, f->text, US""), &statbuf) < 0)
520 /* There are some tests that require the reading of the header file. Ensure
521 the store used is scavenged afterwards so that this process doesn't keep
522 growing its store. We have to read the header file again when actually
523 delivering, but it's cheaper than forking a delivery process for each
524 message when many are not going to be delivered. */
526 if (deliver_selectstring || deliver_selectstring_sender ||
527 queue_run_first_delivery)
530 BOOL orig_dont_deliver = dont_deliver;
531 void *reset_point2 = store_get(0);
533 /* Restore the original setting of dont_deliver after reading the header,
534 so that a setting for a particular message doesn't force it for any that
535 follow. If the message is chosen for delivery, the header is read again
536 in the deliver_message() function, in a subprocess. */
538 if (spool_read_header(f->text, FALSE, TRUE) != spool_read_OK) continue;
539 dont_deliver = orig_dont_deliver;
541 /* Now decide if we want to deliver this message. As we have read the
542 header file, we might as well do the freeze test now, and save forking
545 if (deliver_freeze && !deliver_force_thaw)
547 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
551 /* Check first_delivery in the case when there are no message logs. */
553 else if (queue_run_first_delivery && !deliver_firsttime)
555 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", f->text);
559 /* Check for a matching address if deliver_selectstring[_sender] is set.
560 If so, we do a fully delivery - don't want to omit other addresses since
561 their routing might trigger re-writing etc. */
563 /* Sender matching */
565 else if ( deliver_selectstring_sender
566 && !(deliver_selectstring_sender_regex
567 ? (pcre_exec(selectstring_regex_sender, NULL,
568 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
570 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
574 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
575 f->text, deliver_selectstring_sender);
579 /* Recipient matching */
581 else if (deliver_selectstring)
584 for (i = 0; i < recipients_count; i++)
586 uschar *address = recipients_list[i].address;
587 if ( (deliver_selectstring_regex
588 ? (pcre_exec(selectstring_regex, NULL, CS address,
589 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
590 : (strstric(address, deliver_selectstring, FALSE) != NULL)
592 && tree_search(tree_nonrecipients, address) == NULL
597 if (i >= recipients_count)
600 debug_printf("%s: no recipient address matched %s\n",
601 f->text, deliver_selectstring);
606 /* Recover store used when reading the header */
608 store_reset(reset_point2);
609 if (!wanted) continue; /* With next message */
612 /* OK, got a message we want to deliver. Create a pipe which will
613 serve as a means of detecting when all the processes created by the
614 delivery process are finished. This is relevant when the delivery
615 process passes one or more SMTP channels on to its own children. The
616 pipe gets passed down; by reading on it here we detect when the last
617 descendent dies by the unblocking of the read. It's a pity that for
618 most of the time the pipe isn't used, but creating a pipe should be
622 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
623 "runner process %d: %s", queue_run_pid, strerror(errno));
624 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
626 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
629 if (queue_run_pipe == 0)
631 queue_run_pipe = dup(queue_run_pipe);
635 /* Before forking to deliver the message, ensure any open and cached
636 lookup files or databases are closed. Otherwise, closing in the subprocess
637 can make the next subprocess have problems. There won't often be anything
638 open here, but it is possible (e.g. if spool_directory is an expanded
639 string). A single call before this loop would probably suffice, but just in
640 case expansions get inserted at some point, I've taken the heavy-handed
641 approach. When nothing is open, the call should be cheap. */
645 /* Now deliver the message; get the id by cutting the -H off the file
646 name. The return of the process is zero if a delivery was attempted. */
648 set_process_info("running queue: %s", f->text);
649 f->text[SPOOL_NAME_LENGTH-2] = 0;
650 if ((pid = fork()) == 0)
653 if (running_in_test_harness) millisleep(100);
654 (void)close(pfd[pipe_read]);
655 rc = deliver_message(f->text, force_delivery, FALSE);
656 _exit(rc == DELIVER_NOT_ATTEMPTED);
659 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
660 "queue runner %d failed\n", queue_run_pid);
662 /* Close the writing end of the synchronizing pipe in this process,
663 then wait for the first level process to terminate. */
665 (void)close(pfd[pipe_write]);
666 set_process_info("running queue: waiting for %s (%d)", f->text, pid);
667 while (wait(&status) != pid);
669 /* A zero return means a delivery was attempted; turn off the force flag
670 for any subsequent calls unless queue_force is set. */
672 if ((status & 0xffff) == 0) force_delivery = queue_run_force;
674 /* If the process crashed, tell somebody */
676 else if ((status & 0x00ff) != 0)
677 log_write(0, LOG_MAIN|LOG_PANIC,
678 "queue run: process %d crashed with signal %d while delivering %s",
679 (int)pid, status & 0x00ff, f->text);
681 /* Before continuing, wait till the pipe gets closed at the far end. This
682 tells us that any children created by the delivery to re-use any SMTP
683 channels have all finished. Since no process actually writes to the pipe,
684 the mere fact that read() unblocks is enough. */
686 set_process_info("running queue: waiting for children of %d", pid);
687 if (read(pfd[pipe_read], buffer, sizeof(buffer)) > 0)
688 log_write(0, LOG_MAIN|LOG_PANIC, "queue run: unexpected data on pipe");
689 (void)close(pfd[pipe_read]);
690 set_process_info("running queue");
692 /* If we are in the test harness, and this is not the first of a 2-stage
693 queue run, update fudged queue times. */
695 if (running_in_test_harness && !queue_2stage)
697 uschar *fqtnext = Ustrchr(fudged_queue_times, '/');
698 if (fqtnext != NULL) fudged_queue_times = fqtnext + 1;
700 } /* End loop for list of messages */
702 store_reset(reset_point1); /* Scavenge list of messages */
704 /* If this was the first time through for random order processing, and
705 sub-directories have been found, randomize their order if necessary. */
707 if (i == 0 && subcount > 1 && !queue_run_in_order)
710 for (j = 1; j <= subcount; j++)
712 int r = random_number(100);
715 int k = (r % subcount) + 1;
717 subdirs[j] = subdirs[k];
722 } /* End loop for multiple directories */
724 /* If queue_2stage is true, we do it all again, with the 2stage flag
729 queue_2stage = FALSE;
730 queue_run(start_id, stop_id, TRUE);
733 /* At top level, log the end of the run. */
737 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
738 queue_name, log_detail);
740 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
746 /************************************************
747 * Count messages on the queue *
748 ************************************************/
750 /* Called as a result of -bpc
761 queue_filename *f = NULL;
763 f = queue_get_spool_list(
764 -1, /* entire queue */
765 subdirs, /* for holding sub list */
766 &subcount, /* for subcount */
767 FALSE); /* not random */
768 for (; f != NULL; f = f->next) count++;
769 fprintf(stdout, "%d\n", count);
774 /************************************************
775 * List extra deliveries *
776 ************************************************/
778 /* This is called from queue_list below to print out all addresses that
779 have received a message but which were not primary addresses. That is, all
780 the addresses in the tree of non-recipients that are not primary addresses.
781 The tree has been scanned and the data field filled in for those that are
784 Argument: points to the tree node
788 static void queue_list_extras(tree_node *p)
790 if (p->left != NULL) queue_list_extras(p->left);
791 if (!p->data.val) printf(" +D %s\n", p->name);
792 if (p->right != NULL) queue_list_extras(p->right);
797 /************************************************
798 * List messages on the queue *
799 ************************************************/
801 /* Or a given list of messages. In the "all" case, we get a list of file names
802 as quickly as possible, then scan each one for information to output. If any
803 disappear while we are processing, just leave them out, but give an error if an
804 explicit list was given. This function is a top-level function that is obeyed
805 as a result of the -bp argument. As there may be a lot of messages on the
806 queue, we must tidy up the store after reading the headers for each one.
809 option 0 => list top-level recipients, with "D" for those delivered
810 1 => list only undelivered top-level recipients
811 2 => as 0, plus any generated delivered recipients
812 If 8 is added to any of these values, the queue is listed in
814 list => first of any message ids to list
815 count count of message ids; 0 => all
821 queue_list(int option, uschar **list, int count)
825 int now = (int)time(NULL);
827 queue_filename *f = NULL;
830 /* If given a list of messages, build a chain containing their ids. */
834 queue_filename *last = NULL;
835 for (i = 0; i < count; i++)
837 queue_filename *next =
838 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2);
839 sprintf(CS next->text, "%s-H", list[i]);
840 next->dir_uschar = '*';
842 if (i == 0) f = next; else last->next = next;
847 /* Otherwise get a list of the entire queue, in order if necessary. */
850 f = queue_get_spool_list(
851 -1, /* entire queue */
852 subdirs, /* for holding sub list */
853 &subcount, /* for subcount */
854 option >= 8); /* randomize if required */
856 if (option >= 8) option -= 8;
858 /* Now scan the chain and print information, resetting store used
861 reset_point = store_get(0);
863 for (; f != NULL; f = f->next)
869 store_reset(reset_point);
871 message_subdir[0] = f->dir_uschar;
872 rc = spool_read_header(f->text, FALSE, count <= 0);
873 if (rc == spool_read_notopen && errno == ENOENT && count <= 0) continue;
876 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
883 uschar * fname = spool_fname(US"input", message_subdir, f->text, US"");
885 ptr = Ustrlen(fname)-1;
888 /* Add the data size to the header size; don't count the file name
889 at the start of the data file, but add one for the notional blank line
890 that precedes the data. */
892 if (Ustat(fname, &statbuf) == 0)
893 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
894 i = (now - received_time)/60; /* minutes on queue */
898 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
900 else printf("%2dm ", i);
902 /* Collect delivered addresses from any J file */
905 jread = Ufopen(fname, "rb");
908 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
910 int n = Ustrlen(big_buffer);
912 tree_add_nonrecipient(big_buffer);
918 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
919 for (i = 0; i < 16; i++) fputc(f->text[i], stdout);
921 if (env_read && sender_address != NULL)
923 printf(" <%s>", sender_address);
924 if (sender_set_untrusted) printf(" (%s)", originator_login);
927 if (rc != spool_read_OK)
930 if (save_errno == ERRNO_SPOOLFORMAT)
933 uschar * fname = spool_fname(US"input", message_subdir, f->text, US"");
935 if (Ustat(fname, &statbuf) == 0)
936 printf("*** spool format error: size=" OFF_T_FMT " ***",
938 else printf("*** spool format error ***");
940 else printf("*** spool read error: %s ***", strerror(save_errno));
941 if (rc != spool_read_hdrerror)
948 if (deliver_freeze) printf(" *** frozen ***");
952 if (recipients_list != NULL)
954 for (i = 0; i < recipients_count; i++)
956 tree_node *delivered =
957 tree_search(tree_nonrecipients, recipients_list[i].address);
958 if (!delivered || option != 1)
959 printf(" %s %s\n", (delivered != NULL)? "D":" ",
960 recipients_list[i].address);
961 if (delivered != NULL) delivered->data.val = TRUE;
963 if (option == 2 && tree_nonrecipients != NULL)
964 queue_list_extras(tree_nonrecipients);
972 /*************************************************
973 * Act on a specific message *
974 *************************************************/
976 /* Actions that require a list of addresses make use of argv/argc/
977 recipients_arg. Other actions do not. This function does its own
981 id id of the message to work on
982 action which action is required (MSG_xxx)
983 argv the original argv for Exim
984 argc the original argc for Exim
985 recipients_arg offset to the list of recipients in argv
987 Returns: FALSE if there was any problem
991 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
995 BOOL removed = FALSE;
997 uschar *doing = NULL;
1000 uschar spoolname[32];
1002 /* Set the global message_id variable, used when re-writing spool files. This
1003 also causes message ids to be added to log messages. */
1005 Ustrcpy(message_id, id);
1007 /* The "actions" that just list the files do not require any locking to be
1008 done. Only admin users may read the spool files. */
1010 if (action >= MSG_SHOW_BODY)
1013 uschar *subdirectory, *suffix;
1017 printf("Permission denied\n");
1021 if (recipients_arg < argc)
1023 printf("*** Only one message can be listed at once\n");
1027 if (action == MSG_SHOW_BODY)
1029 subdirectory = US"input";
1032 else if (action == MSG_SHOW_HEADER)
1034 subdirectory = US"input";
1039 subdirectory = US"msglog";
1043 for (i = 0; i < 2; i++)
1045 message_subdir[0] = split_spool_directory == (i == 0) ? id[5] : 0;
1046 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1052 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1054 if (action == MSG_SHOW_LOG && !message_logs)
1055 printf("(No message logs are being created because the message_logs "
1056 "option is false.)\n");
1060 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1061 rc = write(fileno(stdout), big_buffer, rc);
1067 /* For actions that actually act, open and lock the data file to ensure that no
1068 other process is working on this message. If the file does not exist, continue
1069 only if the action is remove and the user is an admin user, to allow for
1070 tidying up broken states. */
1072 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1073 if (errno == ENOENT)
1076 printf("Spool data file for %s does not exist\n", id);
1077 if (action != MSG_REMOVE || !admin_user) return FALSE;
1078 printf("Continuing, to ensure all files removed\n");
1082 if (errno == 0) printf("Message %s is locked\n", id);
1083 else printf("Couldn't open spool file for %s: %s\n", id,
1088 /* Read the spool header file for the message. Again, continue after an
1089 error only in the case of deleting by an administrator. Setting the third
1090 argument false causes it to look both in the main spool directory and in
1091 the appropriate subdirectory, and set message_subdir according to where it
1092 found the message. */
1094 sprintf(CS spoolname, "%s-H", id);
1095 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1098 if (errno != ERRNO_SPOOLFORMAT)
1099 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1101 printf("Spool format error for %s\n", spoolname);
1102 if (action != MSG_REMOVE || !admin_user)
1104 (void)close(deliver_datafile);
1105 deliver_datafile = -1;
1108 printf("Continuing to ensure all files removed\n");
1111 /* Check that the user running this process is entitled to operate on this
1112 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1113 mess about, but the original sender is permitted to remove a message. That's
1114 why we leave this check until after the headers are read. */
1116 if (!admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1118 printf("Permission denied\n");
1119 (void)close(deliver_datafile);
1120 deliver_datafile = -1;
1124 /* Set up the user name for logging. */
1126 pw = getpwuid(real_uid);
1127 username = (pw != NULL)?
1128 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1130 /* Take the necessary action. */
1132 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1137 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1138 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1139 transport_write_message(1, NULL, 0);
1147 printf("is already frozen\n");
1151 deliver_freeze = TRUE;
1152 deliver_manual_thaw = FALSE;
1153 deliver_frozen_at = time(NULL);
1154 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1156 printf("is now frozen\n");
1157 log_write(0, LOG_MAIN, "frozen by %s", username);
1162 printf("could not be frozen: %s\n", errmsg);
1169 if (!deliver_freeze)
1172 printf("is not frozen\n");
1176 deliver_freeze = FALSE;
1177 deliver_manual_thaw = TRUE;
1178 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1180 printf("is no longer frozen\n");
1181 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1186 printf("could not be unfrozen: %s\n", errmsg);
1192 /* We must ensure all files are removed from both the input directory
1193 and the appropriate subdirectory, to clean up cases when there are odd
1194 files left lying around in odd places. In the normal case message_subdir
1195 will have been set correctly by spool_read_header, but as this is a rare
1196 operation, just run everything twice. */
1204 message_subdir[0] = id[5];
1206 for (j = 0; j < 2; message_subdir[0] = 0, j++)
1208 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1210 DEBUG(D_any) debug_printf(" removing %s", fname);
1211 if (Uunlink(fname) < 0)
1213 if (errno != ENOENT)
1216 printf("Error while removing %s: %s\n", fname, strerror(errno));
1218 else DEBUG(D_any) debug_printf(" (no file)\n");
1223 DEBUG(D_any) debug_printf(" (ok)\n");
1226 for (i = 0; i < 3; i++)
1230 suffix[1] = (US"DHJ")[i];
1231 fname = spool_fname(US"input", message_subdir, id, suffix);
1233 DEBUG(D_any) debug_printf(" removing %s", fname);
1234 if (Uunlink(fname) < 0)
1236 if (errno != ENOENT)
1239 printf("Error while removing %s: %s\n", fname, strerror(errno));
1241 else DEBUG(D_any) debug_printf(" (no file)\n");
1246 DEBUG(D_any) debug_printf(" (done)\n");
1251 /* In the common case, the datafile is open (and locked), so give the
1252 obvious message. Otherwise be more specific. */
1254 if (deliver_datafile >= 0) printf("has been removed\n");
1255 else printf("has been removed or did not exist\n");
1258 log_write(0, LOG_MAIN, "removed by %s", username);
1259 log_write(0, LOG_MAIN, "Completed");
1265 case MSG_MARK_ALL_DELIVERED:
1266 for (i = 0; i < recipients_count; i++)
1268 tree_add_nonrecipient(recipients_list[i].address);
1270 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1272 printf("has been modified\n");
1273 for (i = 0; i < recipients_count; i++)
1274 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1275 recipients_list[i].address, username);
1280 printf("- could not mark all delivered: %s\n", errmsg);
1285 case MSG_EDIT_SENDER:
1286 if (recipients_arg < argc - 1)
1289 printf("- only one sender address can be specified\n");
1292 doing = US"editing sender";
1295 case MSG_ADD_RECIPIENT:
1296 if (doing == NULL) doing = US"adding recipient";
1299 case MSG_MARK_DELIVERED:
1300 if (doing == NULL) doing = US"marking as delivered";
1302 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1304 if (recipients_arg >= argc)
1307 printf("- error while %s: no address given\n", doing);
1311 for (; recipients_arg < argc; recipients_arg++)
1313 int start, end, domain;
1316 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1317 &domain, (action == MSG_EDIT_SENDER));
1319 if (recipient == NULL)
1322 printf("- error while %s:\n bad address %s: %s\n",
1323 doing, argv[recipients_arg], errmess);
1325 else if (recipient[0] != 0 && domain == 0)
1328 printf("- error while %s:\n bad address %s: "
1329 "domain missing\n", doing, argv[recipients_arg]);
1333 if (action == MSG_ADD_RECIPIENT)
1336 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1338 receive_add_recipient(recipient, -1);
1339 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1340 recipient, username);
1342 else if (action == MSG_MARK_DELIVERED)
1344 for (i = 0; i < recipients_count; i++)
1345 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1346 if (i >= recipients_count)
1348 printf("- error while %s:\n %s is not a recipient:"
1349 " message not updated\n", doing, recipient);
1354 tree_add_nonrecipient(recipients_list[i].address);
1355 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1356 recipient, username);
1359 else /* MSG_EDIT_SENDER */
1362 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1364 sender_address = recipient;
1365 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1366 recipient, username);
1372 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1373 printf("has been modified\n");
1377 printf("- while %s: %s\n", doing, errmsg);
1383 /* Closing the datafile releases the lock and permits other processes
1384 to operate on the message (if it still exists). */
1386 if (deliver_datafile >= 0)
1388 (void)close(deliver_datafile);
1389 deliver_datafile = -1;
1396 /*************************************************
1397 * Check the queue_only_file condition *
1398 *************************************************/
1400 /* The queue_only_file option forces certain kinds of queueing if a given file
1408 queue_check_only(void)
1412 struct stat statbuf;
1415 uschar buffer[1024];
1417 if (queue_only_file == NULL) return;
1419 s = queue_only_file;
1420 while ((ss = string_nextinlist(&s, &sep, buffer, sizeof(buffer))) != NULL)
1422 if (Ustrncmp(ss, "smtp", 4) == 0)
1424 name = US"queue_smtp";
1430 name = US"queue_only";
1434 if (Ustat(ss, &statbuf) == 0)
1437 DEBUG(D_receive) debug_printf("%s set because %s exists\n", name, ss);
1442 #endif /*!COMPILE_UTILITY*/
1444 /* End of queue.c */