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. */
15 /* Routines with knowledge 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, const uschar * subdir, const uschar * fname,
43 const uschar * suffix)
45 return string_sprintf("%s/%s/%s/%s/%s%s",
46 spool_directory, queue_name, purpose, subdir, fname, suffix);
52 #ifndef COMPILE_UTILITY
54 /* The number of nodes to use for the bottom-up merge sort when a list of queue
55 items is to be ordered. The code for this sort was contributed as a patch by
58 #define LOG2_MAXNODES 32
62 /*************************************************
63 * Helper sort function for queue_get_spool_list *
64 *************************************************/
66 /* This function is used when sorting the queue list in the function
67 queue_get_spool_list() below.
70 a points to an ordered list of queue_filename items
71 b points to another ordered list
73 Returns: a pointer to a merged ordered list
76 static queue_filename *
77 merge_queue_lists(queue_filename *a, queue_filename *b)
79 queue_filename *first = NULL;
80 queue_filename **append = &first;
85 if ((d = Ustrncmp(a->text, b->text, 6)) == 0)
86 d = Ustrcmp(a->text + 14, b->text + 14);
109 /*************************************************
110 * Get list of spool files *
111 *************************************************/
113 /* Scan the spool directory and return a list of the relevant file names
114 therein. Single-character sub-directories are handled as follows:
116 If the first argument is > 0, a sub-directory is scanned; the letter is
117 taken from the nth entry in subdirs.
119 If the first argument is 0, sub-directories are not scanned. However, a
120 list of them is returned.
122 If the first argument is < 0, sub-directories are scanned for messages,
123 and a single, unified list is created. The returned data blocks contain the
124 identifying character of the subdirectory, if any. The subdirs vector is
125 still required as an argument.
127 If the randomize argument is TRUE, messages are returned in "randomized" order.
128 Actually, the order is anything but random, but the algorithm is cheap, and the
129 point is simply to ensure that the same order doesn't occur every time, in case
130 a particular message is causing a remote MTA to barf - we would like to try
131 other messages to that MTA first.
133 If the randomize argument is FALSE, sort the list according to the file name.
134 This should give the order in which the messages arrived. It is normally used
135 only for presentation to humans, in which case the (possibly expensive) sort
136 that it does is not part of the normal operational code. However, if
137 queue_run_in_order is set, sorting has to take place for queue runs as well.
138 When randomize is FALSE, the first argument is normally -1, so all messages are
142 subdiroffset sub-directory character offset, or 0 or -1 (see above)
143 subdirs vector to store list of subdirchars
144 subcount pointer to int in which to store count of subdirs
145 randomize TRUE if the order of the list is to be unpredictable
147 Returns: pointer to a chain of queue name items
150 static queue_filename *
151 queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount,
158 queue_filename *yield = NULL;
159 queue_filename *last = NULL;
163 queue_filename *root[LOG2_MAXNODES];
165 /* When randomizing, the file names are added to the start or end of the list
166 according to the bits of the flags variable. Get a collection of bits from the
167 current time. Use the bottom 16 and just keep re-using them if necessary. When
168 not randomizing, initialize the sublists for the bottom-up merge sort. */
171 resetflags = time(NULL) & 0xFFFF;
173 for (i = 0; i < LOG2_MAXNODES; i++)
176 /* If processing the full queue, or just the top-level, start at the base
177 directory, and initialize the first subdirectory name (as none). Otherwise,
178 start at the sub-directory offset. */
180 if (subdiroffset <= 0)
189 /* Set up prototype for the directory name. */
191 spool_pname_buf(buffer, sizeof(buffer));
192 buffer[sizeof(buffer) - 3] = 0;
193 subptr = Ustrlen(buffer);
194 buffer[subptr+2] = 0; /* terminator for lengthened name */
196 /* This loop runs at least once, for the main or given directory, and then as
197 many times as necessary to scan any subdirectories encountered in the main
198 directory, if they are to be scanned at this time. */
200 for (; i <= *subcount; i++)
203 int subdirchar = subdirs[i]; /* 0 for main directory */
207 buffer[subptr] = '/';
208 buffer[subptr+1] = subdirchar;
211 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
212 if (!(dd = opendir(CS buffer)))
215 /* Now scan the directory. */
217 while ((ent = readdir(dd)))
219 uschar *name = US ent->d_name;
220 int len = Ustrlen(name);
226 /* If we find a single alphameric sub-directory in the base directory,
227 add it to the list for subsequent scans. */
229 if (i == 0 && len == 1 && isalnum(*name))
231 *subcount = *subcount + 1;
232 subdirs[*subcount] = *name;
236 /* Otherwise, if it is a header spool file, add it to the list */
238 if (len == SPOOL_NAME_LENGTH &&
239 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
241 queue_filename *next =
242 store_get(sizeof(queue_filename) + Ustrlen(name));
243 Ustrcpy(next->text, name);
244 next->dir_uschar = subdirchar;
246 /* Handle the creation of a randomized list. The first item becomes both
247 the top and bottom of the list. Subsequent items are inserted either at
248 the top or the bottom, randomly. This is, I argue, faster than doing a
249 sort by allocating a random number to each item, and it also saves having
250 to store the number with each item. */
262 if ((flags & 1) == 0)
276 /* Otherwise do a bottom-up merge sort based on the name. */
282 for (j = 0; j < LOG2_MAXNODES; j++)
285 next = merge_queue_lists(next, root[j]);
286 root[j] = j == LOG2_MAXNODES - 1 ? next : NULL;
297 /* Finished with this directory */
301 /* If we have just scanned a sub-directory, and it was empty (count == 2
302 implies just "." and ".." entries), and Exim is no longer configured to
303 use sub-directories, attempt to get rid of it. At the same time, try to
304 get rid of any corresponding msglog subdirectory. These are just cosmetic
305 tidying actions, so just ignore failures. If we are scanning just a single
306 sub-directory, break the loop. */
310 if (!split_spool_directory && count <= 2)
315 subdir[0] = subdirchar; subdir[1] = 0;
316 rmdir(CS spool_dname(US"msglog", subdir));
318 if (subdiroffset > 0) break; /* Single sub-directory */
321 /* If we have just scanned the base directory, and subdiroffset is 0,
322 we do not want to continue scanning the sub-directories. */
324 else if (subdiroffset == 0)
326 } /* Loop for multiple subdirectories */
328 /* When using a bottom-up merge sort, do the final merging of the sublists.
329 Then pass back the final list of file items. */
332 for (i = 0; i < LOG2_MAXNODES; ++i)
333 yield = merge_queue_lists(yield, root[i]);
341 /*************************************************
342 * Perform a queue run *
343 *************************************************/
345 /* The arguments give the messages to start and stop at; NULL means start at
346 the beginning or stop at the end. If the given start message doesn't exist, we
347 start at the next lexically greater one, and likewise we stop at the after the
348 previous lexically lesser one if the given stop message doesn't exist. Because
349 a queue run can take some time, stat each file before forking, in case it has
350 been delivered in the meantime by some other means.
352 The global variables queue_run_force and queue_run_local may be set to cause
353 forced deliveries or local-only deliveries, respectively.
355 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
356 not contain the string. As this option is typically used when a machine comes
357 back online, we want to ensure that at least one delivery attempt takes place,
358 so force the first one. The selecting string can optionally be a regex, or
359 refer to the sender instead of recipients.
361 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
362 is set so that routing is done for all messages. Thus in the second run those
363 that are routed to the same host should go down the same SMTP connection.
366 start_id message id to start at, or NULL for all
367 stop_id message id to end at, or NULL for all
368 recurse TRUE if recursing for 2-stage run
374 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
376 BOOL force_delivery = queue_run_force || deliver_selectstring != NULL ||
377 deliver_selectstring_sender != NULL;
378 const pcre *selectstring_regex = NULL;
379 const pcre *selectstring_regex_sender = NULL;
380 uschar *log_detail = NULL;
385 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
386 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
387 gets set. Save the queue_runner's pid and the flag that indicates any
388 deliveries run directly from this process. Deliveries that are run by handing
389 on TCP/IP channels have queue_run_pid set, but not queue_running. */
391 queue_domains = NULL;
392 queue_smtp_domains = NULL;
393 queue_smtp = queue_2stage;
395 queue_run_pid = getpid();
396 queue_running = TRUE;
398 /* Log the true start of a queue run, and fancy options */
405 if (queue_2stage) *p++ = 'q';
406 if (queue_run_first_delivery) *p++ = 'i';
407 if (queue_run_force) *p++ = 'f';
408 if (deliver_force_thaw) *p++ = 'f';
409 if (queue_run_local) *p++ = 'l';
413 p += sprintf(CS p, "pid=%d", (int)queue_run_pid);
416 p += sprintf(CS p, " -q%s", extras);
418 if (deliver_selectstring)
419 p += sprintf(CS p, " -R%s %s", deliver_selectstring_regex? "r" : "",
420 deliver_selectstring);
422 if (deliver_selectstring_sender)
423 p += sprintf(CS p, " -S%s %s", deliver_selectstring_sender_regex? "r" : "",
424 deliver_selectstring_sender);
426 log_detail = string_copy(big_buffer);
428 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
429 queue_name, log_detail);
431 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
434 /* If deliver_selectstring is a regex, compile it. */
436 if (deliver_selectstring && deliver_selectstring_regex)
437 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
439 if (deliver_selectstring_sender && deliver_selectstring_sender_regex)
440 selectstring_regex_sender =
441 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
443 /* If the spool is split into subdirectories, we want to process it one
444 directory at a time, so as to spread out the directory scanning and the
445 delivering when there are lots of messages involved, except when
446 queue_run_in_order is set.
448 In the random order case, this loop runs once for the main directory (handling
449 any messages therein), and then repeats for any subdirectories that were found.
450 When the first argument of queue_get_spool_list() is 0, it scans the top
451 directory, fills in subdirs, and sets subcount. The order of the directories is
452 then randomized after the first time through, before they are scanned in
453 subsequent iterations.
455 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
456 order), it scans all directories and makes a single message list. */
458 for (i = queue_run_in_order ? -1 : 0;
459 i <= (queue_run_in_order ? -1 : subcount);
463 void *reset_point1 = store_get(0);
468 debug_printf("queue running main directory\n");
470 debug_printf("queue running combined directories\n");
472 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
475 for (f = queue_get_spool_list(i, subdirs, &subcount, !queue_run_in_order);
485 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
486 check that the load average is low enough to permit deliveries. */
488 if (!queue_run_force && deliver_queue_load_max >= 0)
489 if ((load_average = os_getloadavg()) > deliver_queue_load_max)
491 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
493 (double)load_average/1000.0,
494 (double)deliver_queue_load_max/1000.0);
495 i = subcount; /* Don't process other directories */
499 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
500 (double)load_average/1000.0,
501 (double)deliver_queue_load_max/1000.0);
503 /* Skip this message unless it's within the ID limits */
505 if (stop_id && Ustrncmp(f->text, stop_id, MESSAGE_ID_LENGTH) > 0)
507 if (start_id && Ustrncmp(f->text, start_id, MESSAGE_ID_LENGTH) < 0)
510 /* Check that the message still exists */
512 message_subdir[0] = f->dir_uschar;
513 if (Ustat(spool_fname(US"input", message_subdir, f->text, US""), &statbuf) < 0)
516 /* There are some tests that require the reading of the header file. Ensure
517 the store used is scavenged afterwards so that this process doesn't keep
518 growing its store. We have to read the header file again when actually
519 delivering, but it's cheaper than forking a delivery process for each
520 message when many are not going to be delivered. */
522 if (deliver_selectstring || deliver_selectstring_sender ||
523 queue_run_first_delivery)
526 BOOL orig_dont_deliver = dont_deliver;
527 void *reset_point2 = store_get(0);
529 /* Restore the original setting of dont_deliver after reading the header,
530 so that a setting for a particular message doesn't force it for any that
531 follow. If the message is chosen for delivery, the header is read again
532 in the deliver_message() function, in a subprocess. */
534 if (spool_read_header(f->text, FALSE, TRUE) != spool_read_OK) continue;
535 dont_deliver = orig_dont_deliver;
537 /* Now decide if we want to deliver this message. As we have read the
538 header file, we might as well do the freeze test now, and save forking
541 if (deliver_freeze && !deliver_force_thaw)
543 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
547 /* Check first_delivery in the case when there are no message logs. */
549 else if (queue_run_first_delivery && !deliver_firsttime)
551 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", f->text);
555 /* Check for a matching address if deliver_selectstring[_sender] is set.
556 If so, we do a fully delivery - don't want to omit other addresses since
557 their routing might trigger re-writing etc. */
559 /* Sender matching */
561 else if ( deliver_selectstring_sender
562 && !(deliver_selectstring_sender_regex
563 ? (pcre_exec(selectstring_regex_sender, NULL,
564 CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT,
566 : (strstric(sender_address, deliver_selectstring_sender, FALSE)
570 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
571 f->text, deliver_selectstring_sender);
575 /* Recipient matching */
577 else if (deliver_selectstring)
580 for (i = 0; i < recipients_count; i++)
582 uschar *address = recipients_list[i].address;
583 if ( (deliver_selectstring_regex
584 ? (pcre_exec(selectstring_regex, NULL, CS address,
585 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
586 : (strstric(address, deliver_selectstring, FALSE) != NULL)
588 && tree_search(tree_nonrecipients, address) == NULL
593 if (i >= recipients_count)
596 debug_printf("%s: no recipient address matched %s\n",
597 f->text, deliver_selectstring);
602 /* Recover store used when reading the header */
604 spool_clear_header_globals();
605 store_reset(reset_point2);
606 if (!wanted) continue; /* With next message */
609 /* OK, got a message we want to deliver. Create a pipe which will
610 serve as a means of detecting when all the processes created by the
611 delivery process are finished. This is relevant when the delivery
612 process passes one or more SMTP channels on to its own children. The
613 pipe gets passed down; by reading on it here we detect when the last
614 descendent dies by the unblocking of the read. It's a pity that for
615 most of the time the pipe isn't used, but creating a pipe should be
619 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
620 "runner process %d: %s", queue_run_pid, strerror(errno));
621 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
623 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
626 if (queue_run_pipe == 0)
628 queue_run_pipe = dup(queue_run_pipe);
632 /* Before forking to deliver the message, ensure any open and cached
633 lookup files or databases are closed. Otherwise, closing in the subprocess
634 can make the next subprocess have problems. There won't often be anything
635 open here, but it is possible (e.g. if spool_directory is an expanded
636 string). A single call before this loop would probably suffice, but just in
637 case expansions get inserted at some point, I've taken the heavy-handed
638 approach. When nothing is open, the call should be cheap. */
642 /* Now deliver the message; get the id by cutting the -H off the file
643 name. The return of the process is zero if a delivery was attempted. */
645 set_process_info("running queue: %s", f->text);
646 f->text[SPOOL_NAME_LENGTH-2] = 0;
647 if ((pid = fork()) == 0)
650 if (running_in_test_harness) millisleep(100);
651 (void)close(pfd[pipe_read]);
652 rc = deliver_message(f->text, force_delivery, FALSE);
653 _exit(rc == DELIVER_NOT_ATTEMPTED);
656 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
657 "queue runner %d failed\n", queue_run_pid);
659 /* Close the writing end of the synchronizing pipe in this process,
660 then wait for the first level process to terminate. */
662 (void)close(pfd[pipe_write]);
663 set_process_info("running queue: waiting for %s (%d)", f->text, pid);
664 while (wait(&status) != pid);
666 /* A zero return means a delivery was attempted; turn off the force flag
667 for any subsequent calls unless queue_force is set. */
669 if ((status & 0xffff) == 0) force_delivery = queue_run_force;
671 /* If the process crashed, tell somebody */
673 else if ((status & 0x00ff) != 0)
674 log_write(0, LOG_MAIN|LOG_PANIC,
675 "queue run: process %d crashed with signal %d while delivering %s",
676 (int)pid, status & 0x00ff, f->text);
678 /* Before continuing, wait till the pipe gets closed at the far end. This
679 tells us that any children created by the delivery to re-use any SMTP
680 channels have all finished. Since no process actually writes to the pipe,
681 the mere fact that read() unblocks is enough. */
683 set_process_info("running queue: waiting for children of %d", pid);
684 if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0)
685 log_write(0, LOG_MAIN|LOG_PANIC, "queue run: %s on pipe",
686 status > 0 ? "unexpected data" : "error");
687 (void)close(pfd[pipe_read]);
688 set_process_info("running queue");
690 /* If we are in the test harness, and this is not the first of a 2-stage
691 queue run, update fudged queue times. */
693 if (running_in_test_harness && !queue_2stage)
695 uschar *fqtnext = Ustrchr(fudged_queue_times, '/');
696 if (fqtnext != NULL) fudged_queue_times = fqtnext + 1;
698 } /* End loop for list of messages */
700 tree_nonrecipients = NULL;
701 store_reset(reset_point1); /* Scavenge list of messages */
703 /* If this was the first time through for random order processing, and
704 sub-directories have been found, randomize their order if necessary. */
706 if (i == 0 && subcount > 1 && !queue_run_in_order)
709 for (j = 1; j <= subcount; j++)
710 if ((r = random_number(100)) >= 50)
712 int k = (r % subcount) + 1;
714 subdirs[j] = subdirs[k];
718 } /* End loop for multiple directories */
720 /* If queue_2stage is true, we do it all again, with the 2stage flag
725 queue_2stage = FALSE;
726 queue_run(start_id, stop_id, TRUE);
729 /* At top level, log the end of the run. */
733 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
734 queue_name, log_detail);
736 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
742 /************************************************
743 * Count messages on the queue *
744 ************************************************/
746 /* Called as a result of -bpc
757 queue_filename *f = NULL;
759 f = queue_get_spool_list(
760 -1, /* entire queue */
761 subdirs, /* for holding sub list */
762 &subcount, /* for subcount */
763 FALSE); /* not random */
764 for (; f != NULL; f = f->next) count++;
765 fprintf(stdout, "%d\n", count);
770 /************************************************
771 * List extra deliveries *
772 ************************************************/
774 /* This is called from queue_list below to print out all addresses that
775 have received a message but which were not primary addresses. That is, all
776 the addresses in the tree of non-recipients that are not primary addresses.
777 The tree has been scanned and the data field filled in for those that are
780 Argument: points to the tree node
784 static void queue_list_extras(tree_node *p)
786 if (p->left != NULL) queue_list_extras(p->left);
787 if (!p->data.val) printf(" +D %s\n", p->name);
788 if (p->right != NULL) queue_list_extras(p->right);
793 /************************************************
794 * List messages on the queue *
795 ************************************************/
797 /* Or a given list of messages. In the "all" case, we get a list of file names
798 as quickly as possible, then scan each one for information to output. If any
799 disappear while we are processing, just leave them out, but give an error if an
800 explicit list was given. This function is a top-level function that is obeyed
801 as a result of the -bp argument. As there may be a lot of messages on the
802 queue, we must tidy up the store after reading the headers for each one.
805 option 0 => list top-level recipients, with "D" for those delivered
806 1 => list only undelivered top-level recipients
807 2 => as 0, plus any generated delivered recipients
808 If 8 is added to any of these values, the queue is listed in
810 list => first of any message ids to list
811 count count of message ids; 0 => all
817 queue_list(int option, uschar **list, int count)
821 int now = (int)time(NULL);
823 queue_filename *f = NULL;
826 /* If given a list of messages, build a chain containing their ids. */
830 queue_filename *last = NULL;
831 for (i = 0; i < count; i++)
833 queue_filename *next =
834 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2);
835 sprintf(CS next->text, "%s-H", list[i]);
836 next->dir_uschar = '*';
838 if (i == 0) f = next; else last->next = next;
843 /* Otherwise get a list of the entire queue, in order if necessary. */
846 f = queue_get_spool_list(
847 -1, /* entire queue */
848 subdirs, /* for holding sub list */
849 &subcount, /* for subcount */
850 option >= 8); /* randomize if required */
852 if (option >= 8) option -= 8;
854 /* Now scan the chain and print information, resetting store used
857 for (reset_point = store_get(0); f; f = f->next)
864 message_subdir[0] = f->dir_uschar;
865 rc = spool_read_header(f->text, FALSE, count <= 0);
866 if (rc == spool_read_notopen && errno == ENOENT && count <= 0) goto next;
869 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
876 uschar * fname = spool_fname(US"input", message_subdir, f->text, US"");
878 ptr = Ustrlen(fname)-1;
881 /* Add the data size to the header size; don't count the file name
882 at the start of the data file, but add one for the notional blank line
883 that precedes the data. */
885 if (Ustat(fname, &statbuf) == 0)
886 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
887 i = (now - received_time.tv_sec)/60; /* minutes on queue */
891 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
893 else printf("%2dm ", i);
895 /* Collect delivered addresses from any J file */
898 if ((jread = Ufopen(fname, "rb")))
900 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
902 int n = Ustrlen(big_buffer);
904 tree_add_nonrecipient(big_buffer);
910 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
911 for (i = 0; i < 16; i++) fputc(f->text[i], stdout);
913 if (env_read && sender_address)
915 printf(" <%s>", sender_address);
916 if (sender_set_untrusted) printf(" (%s)", originator_login);
919 if (rc != spool_read_OK)
922 if (save_errno == ERRNO_SPOOLFORMAT)
925 uschar * fname = spool_fname(US"input", message_subdir, f->text, US"");
927 if (Ustat(fname, &statbuf) == 0)
928 printf("*** spool format error: size=" OFF_T_FMT " ***",
930 else printf("*** spool format error ***");
932 else printf("*** spool read error: %s ***", strerror(save_errno));
933 if (rc != spool_read_hdrerror)
940 if (deliver_freeze) printf(" *** frozen ***");
946 for (i = 0; i < recipients_count; i++)
948 tree_node *delivered =
949 tree_search(tree_nonrecipients, recipients_list[i].address);
950 if (!delivered || option != 1)
951 printf(" %s %s\n", (delivered != NULL)? "D":" ",
952 recipients_list[i].address);
953 if (delivered) delivered->data.val = TRUE;
955 if (option == 2 && tree_nonrecipients)
956 queue_list_extras(tree_nonrecipients);
961 received_protocol = NULL;
962 sender_fullhost = sender_helo_name =
963 sender_rcvhost = sender_host_address = sender_address = sender_ident = NULL;
964 sender_host_authenticated = authenticated_sender = authenticated_id = NULL;
965 interface_address = NULL;
968 store_reset(reset_point);
974 /*************************************************
975 * Act on a specific message *
976 *************************************************/
978 /* Actions that require a list of addresses make use of argv/argc/
979 recipients_arg. Other actions do not. This function does its own
983 id id of the message to work on
984 action which action is required (MSG_xxx)
985 argv the original argv for Exim
986 argc the original argc for Exim
987 recipients_arg offset to the list of recipients in argv
989 Returns: FALSE if there was any problem
993 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
997 BOOL removed = FALSE;
999 uschar *doing = NULL;
1002 uschar spoolname[32];
1004 /* Set the global message_id variable, used when re-writing spool files. This
1005 also causes message ids to be added to log messages. */
1007 Ustrcpy(message_id, id);
1009 /* The "actions" that just list the files do not require any locking to be
1010 done. Only admin users may read the spool files. */
1012 if (action >= MSG_SHOW_BODY)
1015 uschar *subdirectory, *suffix;
1019 printf("Permission denied\n");
1023 if (recipients_arg < argc)
1025 printf("*** Only one message can be listed at once\n");
1029 if (action == MSG_SHOW_BODY)
1031 subdirectory = US"input";
1034 else if (action == MSG_SHOW_HEADER)
1036 subdirectory = US"input";
1041 subdirectory = US"msglog";
1045 for (i = 0; i < 2; i++)
1047 message_subdir[0] = split_spool_directory == (i == 0) ? id[5] : 0;
1048 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1054 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1056 if (action == MSG_SHOW_LOG && !message_logs)
1057 printf("(No message logs are being created because the message_logs "
1058 "option is false.)\n");
1062 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1063 rc = write(fileno(stdout), big_buffer, rc);
1069 /* For actions that actually act, open and lock the data file to ensure that no
1070 other process is working on this message. If the file does not exist, continue
1071 only if the action is remove and the user is an admin user, to allow for
1072 tidying up broken states. */
1074 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1075 if (errno == ENOENT)
1078 printf("Spool data file for %s does not exist\n", id);
1079 if (action != MSG_REMOVE || !admin_user) return FALSE;
1080 printf("Continuing, to ensure all files removed\n");
1084 if (errno == 0) printf("Message %s is locked\n", id);
1085 else printf("Couldn't open spool file for %s: %s\n", id,
1090 /* Read the spool header file for the message. Again, continue after an
1091 error only in the case of deleting by an administrator. Setting the third
1092 argument false causes it to look both in the main spool directory and in
1093 the appropriate subdirectory, and set message_subdir according to where it
1094 found the message. */
1096 sprintf(CS spoolname, "%s-H", id);
1097 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1100 if (errno != ERRNO_SPOOLFORMAT)
1101 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1103 printf("Spool format error for %s\n", spoolname);
1104 if (action != MSG_REMOVE || !admin_user)
1106 (void)close(deliver_datafile);
1107 deliver_datafile = -1;
1110 printf("Continuing to ensure all files removed\n");
1113 /* Check that the user running this process is entitled to operate on this
1114 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1115 mess about, but the original sender is permitted to remove a message. That's
1116 why we leave this check until after the headers are read. */
1118 if (!admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1120 printf("Permission denied\n");
1121 (void)close(deliver_datafile);
1122 deliver_datafile = -1;
1126 /* Set up the user name for logging. */
1128 pw = getpwuid(real_uid);
1129 username = (pw != NULL)?
1130 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1132 /* Take the necessary action. */
1134 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1140 transport_ctx tctx = {{0}};
1141 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1142 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1144 transport_write_message(&tctx, 0);
1153 printf("is already frozen\n");
1157 deliver_freeze = TRUE;
1158 deliver_manual_thaw = FALSE;
1159 deliver_frozen_at = time(NULL);
1160 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1162 printf("is now frozen\n");
1163 log_write(0, LOG_MAIN, "frozen by %s", username);
1168 printf("could not be frozen: %s\n", errmsg);
1175 if (!deliver_freeze)
1178 printf("is not frozen\n");
1182 deliver_freeze = FALSE;
1183 deliver_manual_thaw = TRUE;
1184 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1186 printf("is no longer frozen\n");
1187 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1192 printf("could not be unfrozen: %s\n", errmsg);
1198 /* We must ensure all files are removed from both the input directory
1199 and the appropriate subdirectory, to clean up cases when there are odd
1200 files left lying around in odd places. In the normal case message_subdir
1201 will have been set correctly by spool_read_header, but as this is a rare
1202 operation, just run everything twice. */
1210 message_subdir[0] = id[5];
1212 for (j = 0; j < 2; message_subdir[0] = 0, j++)
1214 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1216 DEBUG(D_any) debug_printf(" removing %s", fname);
1217 if (Uunlink(fname) < 0)
1219 if (errno != ENOENT)
1222 printf("Error while removing %s: %s\n", fname, strerror(errno));
1224 else DEBUG(D_any) debug_printf(" (no file)\n");
1229 DEBUG(D_any) debug_printf(" (ok)\n");
1232 for (i = 0; i < 3; i++)
1236 suffix[1] = (US"DHJ")[i];
1237 fname = spool_fname(US"input", message_subdir, id, suffix);
1239 DEBUG(D_any) debug_printf(" removing %s", fname);
1240 if (Uunlink(fname) < 0)
1242 if (errno != ENOENT)
1245 printf("Error while removing %s: %s\n", fname, strerror(errno));
1247 else DEBUG(D_any) debug_printf(" (no file)\n");
1252 DEBUG(D_any) debug_printf(" (done)\n");
1257 /* In the common case, the datafile is open (and locked), so give the
1258 obvious message. Otherwise be more specific. */
1260 if (deliver_datafile >= 0) printf("has been removed\n");
1261 else printf("has been removed or did not exist\n");
1264 log_write(0, LOG_MAIN, "removed by %s", username);
1265 log_write(0, LOG_MAIN, "Completed");
1271 case MSG_MARK_ALL_DELIVERED:
1272 for (i = 0; i < recipients_count; i++)
1274 tree_add_nonrecipient(recipients_list[i].address);
1276 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1278 printf("has been modified\n");
1279 for (i = 0; i < recipients_count; i++)
1280 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1281 recipients_list[i].address, username);
1286 printf("- could not mark all delivered: %s\n", errmsg);
1291 case MSG_EDIT_SENDER:
1292 if (recipients_arg < argc - 1)
1295 printf("- only one sender address can be specified\n");
1298 doing = US"editing sender";
1301 case MSG_ADD_RECIPIENT:
1302 if (doing == NULL) doing = US"adding recipient";
1305 case MSG_MARK_DELIVERED:
1306 if (doing == NULL) doing = US"marking as delivered";
1308 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1310 if (recipients_arg >= argc)
1313 printf("- error while %s: no address given\n", doing);
1317 for (; recipients_arg < argc; recipients_arg++)
1319 int start, end, domain;
1322 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1323 &domain, (action == MSG_EDIT_SENDER));
1325 if (recipient == NULL)
1328 printf("- error while %s:\n bad address %s: %s\n",
1329 doing, argv[recipients_arg], errmess);
1331 else if (recipient[0] != 0 && domain == 0)
1334 printf("- error while %s:\n bad address %s: "
1335 "domain missing\n", doing, argv[recipients_arg]);
1339 if (action == MSG_ADD_RECIPIENT)
1342 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1344 receive_add_recipient(recipient, -1);
1345 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1346 recipient, username);
1348 else if (action == MSG_MARK_DELIVERED)
1350 for (i = 0; i < recipients_count; i++)
1351 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1352 if (i >= recipients_count)
1354 printf("- error while %s:\n %s is not a recipient:"
1355 " message not updated\n", doing, recipient);
1360 tree_add_nonrecipient(recipients_list[i].address);
1361 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1362 recipient, username);
1365 else /* MSG_EDIT_SENDER */
1368 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1370 sender_address = recipient;
1371 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1372 recipient, username);
1378 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1379 printf("has been modified\n");
1383 printf("- while %s: %s\n", doing, errmsg);
1389 /* Closing the datafile releases the lock and permits other processes
1390 to operate on the message (if it still exists). */
1392 if (deliver_datafile >= 0)
1394 (void)close(deliver_datafile);
1395 deliver_datafile = -1;
1402 /*************************************************
1403 * Check the queue_only_file condition *
1404 *************************************************/
1406 /* The queue_only_file option forces certain kinds of queueing if a given file
1414 queue_check_only(void)
1418 struct stat statbuf;
1421 uschar buffer[1024];
1423 if (queue_only_file == NULL) return;
1425 s = queue_only_file;
1426 while ((ss = string_nextinlist(&s, &sep, buffer, sizeof(buffer))) != NULL)
1428 if (Ustrncmp(ss, "smtp", 4) == 0)
1430 name = US"queue_smtp";
1436 name = US"queue_only";
1440 if (Ustat(ss, &statbuf) == 0)
1443 DEBUG(D_receive) debug_printf("%s set because %s exists\n", name, ss);
1448 #endif /*!COMPILE_UTILITY*/
1450 /* End of queue.c */