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 */
18 spool_pname_buf(uschar * buf, int len)
20 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
24 spool_dname(const uschar * purpose, uschar * subdir)
26 return string_sprintf("%s/%s/%s/%s",
27 spool_directory, queue_name, purpose, subdir);
31 spool_sname(const uschar * purpose, uschar * subdir)
33 return string_sprintf("%s%s%s%s%s",
34 queue_name, *queue_name ? "/" : "",
36 *subdir ? "/" : "", subdir);
40 spool_fname(const uschar * purpose, uschar * subdir, uschar * fname, uschar * suffix)
42 return string_sprintf("%s/%s/%s/%s/%s%s",
43 spool_directory, queue_name, purpose, subdir, fname, suffix);
49 #ifndef COMPILE_UTILITY
51 /* The number of nodes to use for the bottom-up merge sort when a list of queue
52 items is to be ordered. The code for this sort was contributed as a patch by
55 #define LOG2_MAXNODES 32
59 /*************************************************
60 * Helper sort function for queue_get_spool_list *
61 *************************************************/
63 /* This function is used when sorting the queue list in the function
64 queue_get_spool_list() below.
67 a points to an ordered list of queue_filename items
68 b points to another ordered list
70 Returns: a pointer to a merged ordered list
73 static queue_filename *
74 merge_queue_lists(queue_filename *a, queue_filename *b)
76 queue_filename *first = NULL;
77 queue_filename **append = &first;
79 while (a != NULL && b != NULL)
81 if (Ustrcmp(a->text, b->text) < 0)
95 *append=((a != NULL)? a : b);
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. */
164 if (randomize) resetflags = time(NULL) & 0xFFFF;
165 else for (i = 0; i < LOG2_MAXNODES; i++) root[i] = NULL;
167 /* If processing the full queue, or just the top-level, start at the base
168 directory, and initialize the first subdirectory name (as none). Otherwise,
169 start at the sub-directory offset. */
171 if (subdiroffset <= 0)
177 else i = subdiroffset;
179 /* Set up prototype for the directory name. */
181 spool_pname_buf(buffer, sizeof(buffer));
182 buffer[sizeof(buffer) - 3] = 0;
183 subptr = Ustrlen(buffer);
184 buffer[subptr+2] = 0; /* terminator for lengthened name */
186 /* This loop runs at least once, for the main or given directory, and then as
187 many times as necessary to scan any subdirectories encountered in the main
188 directory, if they are to be scanned at this time. */
190 for (; i <= *subcount; i++)
193 int subdirchar = subdirs[i]; /* 0 for main directory */
197 buffer[subptr] = '/';
198 buffer[subptr+1] = subdirchar;
201 DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer);
202 if (!(dd = opendir(CS buffer)))
205 /* Now scan the directory. */
207 while ((ent = readdir(dd)) != NULL)
209 uschar *name = US ent->d_name;
210 int len = Ustrlen(name);
216 /* If we find a single alphameric sub-directory in the base directory,
217 add it to the list for subsequent scans. */
219 if (i == 0 && len == 1 && isalnum(*name))
221 *subcount = *subcount + 1;
222 subdirs[*subcount] = *name;
226 /* Otherwise, if it is a header spool file, add it to the list */
228 if (len == SPOOL_NAME_LENGTH &&
229 Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0)
231 queue_filename *next =
232 store_get(sizeof(queue_filename) + Ustrlen(name));
233 Ustrcpy(next->text, name);
234 next->dir_uschar = subdirchar;
236 /* Handle the creation of a randomized list. The first item becomes both
237 the top and bottom of the list. Subsequent items are inserted either at
238 the top or the bottom, randomly. This is, I argue, faster than doing a
239 sort by allocating a random number to each item, and it also saves having
240 to store the number with each item. */
251 if (flags == 0) flags = resetflags;
252 if ((flags & 1) == 0)
267 /* Otherwise do a bottom-up merge sort based on the name. */
273 for (j = 0; j < LOG2_MAXNODES; j++)
277 next = merge_queue_lists(next, root[j]);
278 root[j] = (j == LOG2_MAXNODES - 1)? next : NULL;
290 /* Finished with this directory */
294 /* If we have just scanned a sub-directory, and it was empty (count == 2
295 implies just "." and ".." entries), and Exim is no longer configured to
296 use sub-directories, attempt to get rid of it. At the same time, try to
297 get rid of any corresponding msglog subdirectory. These are just cosmetic
298 tidying actions, so just ignore failures. If we are scanning just a single
299 sub-directory, break the loop. */
303 if (!split_spool_directory && count <= 2)
308 subdir[0] = subdirchar; subdir[1] = 0;
309 rmdir(CS spool_dname(US"msglog", subdir));
311 if (subdiroffset > 0) break; /* Single sub-directory */
314 /* If we have just scanned the base directory, and subdiroffset is 0,
315 we do not want to continue scanning the sub-directories. */
319 if (subdiroffset == 0) break;
321 } /* Loop for multiple subdirectories */
323 /* When using a bottom-up merge sort, do the final merging of the sublists.
324 Then pass back the final list of file items. */
327 for (i = 0; i < LOG2_MAXNODES; ++i)
328 yield = merge_queue_lists(yield, root[i]);
336 /*************************************************
337 * Perform a queue run *
338 *************************************************/
340 /* The arguments give the messages to start and stop at; NULL means start at
341 the beginning or stop at the end. If the given start message doesn't exist, we
342 start at the next lexically greater one, and likewise we stop at the after the
343 previous lexically lesser one if the given stop message doesn't exist. Because
344 a queue run can take some time, stat each file before forking, in case it has
345 been delivered in the meantime by some other means.
347 The global variables queue_run_force and queue_run_local may be set to cause
348 forced deliveries or local-only deliveries, respectively.
350 If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do
351 not contain the string. As this option is typically used when a machine comes
352 back online, we want to ensure that at least one delivery attempt takes place,
353 so force the first one. The selecting string can optionally be a regex, or
354 refer to the sender instead of recipients.
356 If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp
357 is set so that routing is done for all messages. Thus in the second run those
358 that are routed to the same host should go down the same SMTP connection.
361 start_id message id to start at, or NULL for all
362 stop_id message id to end at, or NULL for all
363 recurse TRUE if recursing for 2-stage run
369 queue_run(uschar *start_id, uschar *stop_id, BOOL recurse)
371 BOOL force_delivery = queue_run_force || deliver_selectstring != NULL ||
372 deliver_selectstring_sender != NULL;
373 const pcre *selectstring_regex = NULL;
374 const pcre *selectstring_regex_sender = NULL;
375 uschar *log_detail = NULL;
380 /* Cancel any specific queue domains. Turn off the flag that causes SMTP
381 deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag
382 gets set. Save the queue_runner's pid and the flag that indicates any
383 deliveries run directly from this process. Deliveries that are run by handing
384 on TCP/IP channels have queue_run_pid set, but not queue_running. */
386 queue_domains = NULL;
387 queue_smtp_domains = NULL;
388 queue_smtp = queue_2stage;
390 queue_run_pid = getpid();
391 queue_running = TRUE;
393 /* Log the true start of a queue run, and fancy options */
400 if (queue_2stage) *p++ = 'q';
401 if (queue_run_first_delivery) *p++ = 'i';
402 if (queue_run_force) *p++ = 'f';
403 if (deliver_force_thaw) *p++ = 'f';
404 if (queue_run_local) *p++ = 'l';
408 sprintf(CS p, "pid=%d", (int)queue_run_pid);
413 sprintf(CS p, " -q%s", extras);
417 if (deliver_selectstring != NULL)
419 sprintf(CS p, " -R%s %s", deliver_selectstring_regex? "r" : "",
420 deliver_selectstring);
424 if (deliver_selectstring_sender != NULL)
426 sprintf(CS p, " -S%s %s", deliver_selectstring_sender_regex? "r" : "",
427 deliver_selectstring_sender);
431 log_detail = string_copy(big_buffer);
433 log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s",
434 queue_name, log_detail);
436 log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail);
439 /* If deliver_selectstring is a regex, compile it. */
441 if (deliver_selectstring != NULL && deliver_selectstring_regex)
442 selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE);
444 if (deliver_selectstring_sender != NULL && deliver_selectstring_sender_regex)
445 selectstring_regex_sender =
446 regex_must_compile(deliver_selectstring_sender, TRUE, FALSE);
448 /* If the spool is split into subdirectories, we want to process it one
449 directory at a time, so as to spread out the directory scanning and the
450 delivering when there are lots of messages involved, except when
451 queue_run_in_order is set.
453 In the random order case, this loop runs once for the main directory (handling
454 any messages therein), and then repeats for any subdirectories that were found.
455 When the first argument of queue_get_spool_list() is 0, it scans the top
456 directory, fills in subdirs, and sets subcount. The order of the directories is
457 then randomized after the first time through, before they are scanned in
458 subsqeuent iterations.
460 When the first argument of queue_get_spool_list() is -1 (for queue_run_in_
461 order), it scans all directories and makes a single message list. */
463 for (i = (queue_run_in_order? -1 : 0);
464 i <= (queue_run_in_order? -1 : subcount);
468 void *reset_point1 = store_get(0);
473 debug_printf("queue running main directory\n");
475 debug_printf("queue running combined directories\n");
477 debug_printf("queue running subdirectory '%c'\n", subdirs[i]);
480 for (f = queue_get_spool_list(i, subdirs, &subcount, !queue_run_in_order);
490 /* Unless deliveries are forced, if deliver_queue_load_max is non-negative,
491 check that the load average is low enough to permit deliveries. */
493 if (!queue_run_force && deliver_queue_load_max >= 0)
495 load_average = os_getloadavg();
496 if (load_average > deliver_queue_load_max)
498 log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)",
500 (double)load_average/1000.0,
501 (double)deliver_queue_load_max/1000.0);
502 i = subcount; /* Don't process other directories */
507 DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n",
508 (double)load_average/1000.0,
509 (double)deliver_queue_load_max/1000.0);
513 /* Skip this message unless it's within the ID limits */
515 if (stop_id != NULL && Ustrncmp(f->text, stop_id, MESSAGE_ID_LENGTH) > 0)
517 if (start_id != NULL && Ustrncmp(f->text, start_id, MESSAGE_ID_LENGTH) < 0)
520 /* Check that the message still exists */
522 message_subdir[0] = f->dir_uschar;
523 if (Ustat(spool_fname(US"input", message_subdir, f->text, US""), &statbuf) < 0)
526 /* There are some tests that require the reading of the header file. Ensure
527 the store used is scavenged afterwards so that this process doesn't keep
528 growing its store. We have to read the header file again when actually
529 delivering, but it's cheaper than forking a delivery process for each
530 message when many are not going to be delivered. */
532 if (deliver_selectstring != NULL || deliver_selectstring_sender != NULL ||
533 queue_run_first_delivery)
536 BOOL orig_dont_deliver = dont_deliver;
537 void *reset_point2 = store_get(0);
539 /* Restore the original setting of dont_deliver after reading the header,
540 so that a setting for a particular message doesn't force it for any that
541 follow. If the message is chosen for delivery, the header is read again
542 in the deliver_message() function, in a subprocess. */
544 if (spool_read_header(f->text, FALSE, TRUE) != spool_read_OK) continue;
545 dont_deliver = orig_dont_deliver;
547 /* Now decide if we want to deliver this message. As we have read the
548 header file, we might as well do the freeze test now, and save forking
551 if (deliver_freeze && !deliver_force_thaw)
553 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
557 /* Check first_delivery in the case when there are no message logs. */
559 else if (queue_run_first_delivery && !deliver_firsttime)
561 DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", f->text);
565 /* Check for a matching address if deliver_selectstring[_sender} is set.
566 If so, we do a fully delivery - don't want to omit other addresses since
567 their routing might trigger re-writing etc. */
569 /* Sender matching */
571 else if (deliver_selectstring_sender != NULL &&
572 !(deliver_selectstring_sender_regex?
573 (pcre_exec(selectstring_regex_sender, NULL, CS sender_address,
574 Ustrlen(sender_address), 0, PCRE_EOPT, NULL, 0) >= 0)
576 (strstric(sender_address, deliver_selectstring_sender, FALSE)
579 DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n",
580 f->text, deliver_selectstring_sender);
584 /* Recipient matching */
586 else if (deliver_selectstring != NULL)
589 for (i = 0; i < recipients_count; i++)
591 uschar *address = recipients_list[i].address;
592 if ((deliver_selectstring_regex?
593 (pcre_exec(selectstring_regex, NULL, CS address,
594 Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0)
596 (strstric(address, deliver_selectstring, FALSE) != NULL))
598 tree_search(tree_nonrecipients, address) == NULL)
602 if (i >= recipients_count)
605 debug_printf("%s: no recipient address matched %s\n",
606 f->text, deliver_selectstring);
611 /* Recover store used when reading the header */
613 store_reset(reset_point2);
614 if (!wanted) continue; /* With next message */
617 /* OK, got a message we want to deliver. Create a pipe which will
618 serve as a means of detecting when all the processes created by the
619 delivery process are finished. This is relevant when the delivery
620 process passes one or more SMTP channels on to its own children. The
621 pipe gets passed down; by reading on it here we detect when the last
622 descendent dies by the unblocking of the read. It's a pity that for
623 most of the time the pipe isn't used, but creating a pipe should be
628 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue "
629 "runner process %d: %s", queue_run_pid, strerror(errno));
631 queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */
633 /* Make sure it isn't stdin. This seems unlikely, but just to be on the
636 if (queue_run_pipe == 0)
638 queue_run_pipe = dup(queue_run_pipe);
642 /* Before forking to deliver the message, ensure any open and cached
643 lookup files or databases are closed. Otherwise, closing in the subprocess
644 can make the next subprocess have problems. There won't often be anything
645 open here, but it is possible (e.g. if spool_directory is an expanded
646 string). A single call before this loop would probably suffice, but just in
647 case expansions get inserted at some point, I've taken the heavy-handed
648 approach. When nothing is open, the call should be cheap. */
652 /* Now deliver the message; get the id by cutting the -H off the file
653 name. The return of the process is zero if a delivery was attempted. */
655 set_process_info("running queue: %s", f->text);
656 f->text[SPOOL_NAME_LENGTH-2] = 0;
657 if ((pid = fork()) == 0)
660 if (running_in_test_harness) millisleep(100);
661 (void)close(pfd[pipe_read]);
662 rc = deliver_message(f->text, force_delivery, FALSE);
663 _exit(rc == DELIVER_NOT_ATTEMPTED);
666 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from "
667 "queue runner %d failed\n", queue_run_pid);
669 /* Close the writing end of the synchronizing pipe in this process,
670 then wait for the first level process to terminate. */
672 (void)close(pfd[pipe_write]);
673 set_process_info("running queue: waiting for %s (%d)", f->text, pid);
674 while (wait(&status) != pid);
676 /* A zero return means a delivery was attempted; turn off the force flag
677 for any subsequent calls unless queue_force is set. */
679 if ((status & 0xffff) == 0) force_delivery = queue_run_force;
681 /* If the process crashed, tell somebody */
683 else if ((status & 0x00ff) != 0)
685 log_write(0, LOG_MAIN|LOG_PANIC,
686 "queue run: process %d crashed with signal %d while delivering %s",
687 (int)pid, status & 0x00ff, f->text);
690 /* Before continuing, wait till the pipe gets closed at the far end. This
691 tells us that any children created by the delivery to re-use any SMTP
692 channels have all finished. Since no process actually writes to the pipe,
693 the mere fact that read() unblocks is enough. */
695 set_process_info("running queue: waiting for children of %d", pid);
696 if (read(pfd[pipe_read], buffer, sizeof(buffer)) > 0)
697 log_write(0, LOG_MAIN|LOG_PANIC, "queue run: unexpected data on pipe");
698 (void)close(pfd[pipe_read]);
699 set_process_info("running queue");
701 /* If we are in the test harness, and this is not the first of a 2-stage
702 queue run, update fudged queue times. */
704 if (running_in_test_harness && !queue_2stage)
706 uschar *fqtnext = Ustrchr(fudged_queue_times, '/');
707 if (fqtnext != NULL) fudged_queue_times = fqtnext + 1;
709 } /* End loop for list of messages */
711 store_reset(reset_point1); /* Scavenge list of messages */
713 /* If this was the first time through for random order processing, and
714 sub-directories have been found, randomize their order if necessary. */
716 if (i == 0 && subcount > 1 && !queue_run_in_order)
719 for (j = 1; j <= subcount; j++)
721 int r = random_number(100);
724 int k = (r % subcount) + 1;
726 subdirs[j] = subdirs[k];
731 } /* End loop for multiple directories */
733 /* If queue_2stage is true, we do it all again, with the 2stage flag
738 queue_2stage = FALSE;
739 queue_run(start_id, stop_id, TRUE);
742 /* At top level, log the end of the run. */
746 log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s",
747 queue_name, log_detail);
749 log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail);
755 /************************************************
756 * Count messages on the queue *
757 ************************************************/
759 /* Called as a result of -bpc
770 queue_filename *f = NULL;
772 f = queue_get_spool_list(
773 -1, /* entire queue */
774 subdirs, /* for holding sub list */
775 &subcount, /* for subcount */
776 FALSE); /* not random */
777 for (; f != NULL; f = f->next) count++;
778 fprintf(stdout, "%d\n", count);
783 /************************************************
784 * List extra deliveries *
785 ************************************************/
787 /* This is called from queue_list below to print out all addresses that
788 have received a message but which were not primary addresses. That is, all
789 the addresses in the tree of non-recipients that are not primary addresses.
790 The tree has been scanned and the data field filled in for those that are
793 Argument: points to the tree node
797 static void queue_list_extras(tree_node *p)
799 if (p->left != NULL) queue_list_extras(p->left);
800 if (!p->data.val) printf(" +D %s\n", p->name);
801 if (p->right != NULL) queue_list_extras(p->right);
806 /************************************************
807 * List messages on the queue *
808 ************************************************/
810 /* Or a given list of messages. In the "all" case, we get a list of file names
811 as quickly as possible, then scan each one for information to output. If any
812 disappear while we are processing, just leave them out, but give an error if an
813 explicit list was given. This function is a top-level function that is obeyed
814 as a result of the -bp argument. As there may be a lot of messages on the
815 queue, we must tidy up the store after reading the headers for each one.
818 option 0 => list top-level recipients, with "D" for those delivered
819 1 => list only undelivered top-level recipients
820 2 => as 0, plus any generated delivered recipients
821 If 8 is added to any of these values, the queue is listed in
823 list => first of any message ids to list
824 count count of message ids; 0 => all
830 queue_list(int option, uschar **list, int count)
834 int now = (int)time(NULL);
836 queue_filename *f = NULL;
839 /* If given a list of messages, build a chain containing their ids. */
843 queue_filename *last = NULL;
844 for (i = 0; i < count; i++)
846 queue_filename *next =
847 store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2);
848 sprintf(CS next->text, "%s-H", list[i]);
849 next->dir_uschar = '*';
851 if (i == 0) f = next; else last->next = next;
856 /* Otherwise get a list of the entire queue, in order if necessary. */
859 f = queue_get_spool_list(
860 -1, /* entire queue */
861 subdirs, /* for holding sub list */
862 &subcount, /* for subcount */
863 option >= 8); /* randomize if required */
865 if (option >= 8) option -= 8;
867 /* Now scan the chain and print information, resetting store used
870 reset_point = store_get(0);
872 for (; f != NULL; f = f->next)
878 store_reset(reset_point);
880 message_subdir[0] = f->dir_uschar;
881 rc = spool_read_header(f->text, FALSE, count <= 0);
882 if (rc == spool_read_notopen && errno == ENOENT && count <= 0) continue;
885 env_read = (rc == spool_read_OK || rc == spool_read_hdrerror);
892 uschar * fname = spool_fname(US"input", message_subdir, f->text, US"");
894 ptr = Ustrlen(fname)-1;
897 /* Add the data size to the header size; don't count the file name
898 at the start of the data file, but add one for the notional blank line
899 that precedes the data. */
901 if (Ustat(fname, &statbuf) == 0)
902 size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1;
903 i = (now - received_time)/60; /* minutes on queue */
907 if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i);
909 else printf("%2dm ", i);
911 /* Collect delivered addresses from any J file */
914 jread = Ufopen(fname, "rb");
917 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
919 int n = Ustrlen(big_buffer);
921 tree_add_nonrecipient(big_buffer);
927 fprintf(stdout, "%s ", string_format_size(size, big_buffer));
928 for (i = 0; i < 16; i++) fputc(f->text[i], stdout);
930 if (env_read && sender_address != NULL)
932 printf(" <%s>", sender_address);
933 if (sender_set_untrusted) printf(" (%s)", originator_login);
936 if (rc != spool_read_OK)
939 if (save_errno == ERRNO_SPOOLFORMAT)
942 uschar * fname = spool_fname(US"input", message_subdir, f->text, US"");
944 if (Ustat(fname, &statbuf) == 0)
945 printf("*** spool format error: size=" OFF_T_FMT " ***",
947 else printf("*** spool format error ***");
949 else printf("*** spool read error: %s ***", strerror(save_errno));
950 if (rc != spool_read_hdrerror)
957 if (deliver_freeze) printf(" *** frozen ***");
961 if (recipients_list != NULL)
963 for (i = 0; i < recipients_count; i++)
965 tree_node *delivered =
966 tree_search(tree_nonrecipients, recipients_list[i].address);
967 if (!delivered || option != 1)
968 printf(" %s %s\n", (delivered != NULL)? "D":" ",
969 recipients_list[i].address);
970 if (delivered != NULL) delivered->data.val = TRUE;
972 if (option == 2 && tree_nonrecipients != NULL)
973 queue_list_extras(tree_nonrecipients);
981 /*************************************************
982 * Act on a specific message *
983 *************************************************/
985 /* Actions that require a list of addresses make use of argv/argc/
986 recipients_arg. Other actions do not. This function does its own
990 id id of the message to work on
991 action which action is required (MSG_xxx)
992 argv the original argv for Exim
993 argc the original argc for Exim
994 recipients_arg offset to the list of recipients in argv
996 Returns: FALSE if there was any problem
1000 queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg)
1004 BOOL removed = FALSE;
1006 uschar *doing = NULL;
1009 uschar spoolname[32];
1011 /* Set the global message_id variable, used when re-writing spool files. This
1012 also causes message ids to be added to log messages. */
1014 Ustrcpy(message_id, id);
1016 /* The "actions" that just list the files do not require any locking to be
1017 done. Only admin users may read the spool files. */
1019 if (action >= MSG_SHOW_BODY)
1022 uschar *subdirectory, *suffix;
1026 printf("Permission denied\n");
1030 if (recipients_arg < argc)
1032 printf("*** Only one message can be listed at once\n");
1036 if (action == MSG_SHOW_BODY)
1038 subdirectory = US"input";
1041 else if (action == MSG_SHOW_HEADER)
1043 subdirectory = US"input";
1048 subdirectory = US"msglog";
1052 for (i = 0; i < 2; i++)
1054 message_subdir[0] = split_spool_directory == (i == 0) ? id[5] : 0;
1055 if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix),
1061 printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix,
1063 if (action == MSG_SHOW_LOG && !message_logs)
1064 printf("(No message logs are being created because the message_logs "
1065 "option is false.)\n");
1069 while((rc = read(fd, big_buffer, big_buffer_size)) > 0)
1070 rc = write(fileno(stdout), big_buffer, rc);
1076 /* For actions that actually act, open and lock the data file to ensure that no
1077 other process is working on this message. If the file does not exist, continue
1078 only if the action is remove and the user is an admin user, to allow for
1079 tidying up broken states. */
1081 if ((deliver_datafile = spool_open_datafile(id)) < 0)
1082 if (errno == ENOENT)
1085 printf("Spool data file for %s does not exist\n", id);
1086 if (action != MSG_REMOVE || !admin_user) return FALSE;
1087 printf("Continuing, to ensure all files removed\n");
1091 if (errno == 0) printf("Message %s is locked\n", id);
1092 else printf("Couldn't open spool file for %s: %s\n", id,
1097 /* Read the spool header file for the message. Again, continue after an
1098 error only in the case of deleting by an administrator. Setting the third
1099 argument false causes it to look both in the main spool directory and in
1100 the appropriate subdirectory, and set message_subdir according to where it
1101 found the message. */
1103 sprintf(CS spoolname, "%s-H", id);
1104 if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK)
1107 if (errno != ERRNO_SPOOLFORMAT)
1108 printf("Spool read error for %s: %s\n", spoolname, strerror(errno));
1110 printf("Spool format error for %s\n", spoolname);
1111 if (action != MSG_REMOVE || !admin_user)
1113 (void)close(deliver_datafile);
1114 deliver_datafile = -1;
1117 printf("Continuing to ensure all files removed\n");
1120 /* Check that the user running this process is entitled to operate on this
1121 message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise
1122 mess about, but the original sender is permitted to remove a message. That's
1123 why we leave this check until after the headers are read. */
1125 if (!admin_user && (action != MSG_REMOVE || real_uid != originator_uid))
1127 printf("Permission denied\n");
1128 (void)close(deliver_datafile);
1129 deliver_datafile = -1;
1133 /* Set up the user name for logging. */
1135 pw = getpwuid(real_uid);
1136 username = (pw != NULL)?
1137 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid);
1139 /* Take the necessary action. */
1141 if (action != MSG_SHOW_COPY) printf("Message %s ", id);
1146 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
1147 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
1148 transport_write_message(NULL, 1, 0, 0, NULL, NULL, NULL, NULL, NULL, 0);
1156 printf("is already frozen\n");
1160 deliver_freeze = TRUE;
1161 deliver_manual_thaw = FALSE;
1162 deliver_frozen_at = time(NULL);
1163 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1165 printf("is now frozen\n");
1166 log_write(0, LOG_MAIN, "frozen by %s", username);
1171 printf("could not be frozen: %s\n", errmsg);
1178 if (!deliver_freeze)
1181 printf("is not frozen\n");
1185 deliver_freeze = FALSE;
1186 deliver_manual_thaw = TRUE;
1187 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1189 printf("is no longer frozen\n");
1190 log_write(0, LOG_MAIN, "unfrozen by %s", username);
1195 printf("could not be unfrozen: %s\n", errmsg);
1201 /* We must ensure all files are removed from both the input directory
1202 and the appropriate subdirectory, to clean up cases when there are odd
1203 files left lying around in odd places. In the normal case message_subdir
1204 will have been set correctly by spool_read_header, but as this is a rare
1205 operation, just run everything twice. */
1213 message_subdir[0] = id[5];
1215 for (j = 0; j < 2; message_subdir[0] = 0, j++)
1217 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
1219 DEBUG(D_any) debug_printf(" removing %s", fname);
1220 if (Uunlink(fname) < 0)
1222 if (errno != ENOENT)
1225 printf("Error while removing %s: %s\n", fname, strerror(errno));
1227 else DEBUG(D_any) debug_printf(" (no file)\n");
1232 DEBUG(D_any) debug_printf(" (ok)\n");
1235 for (i = 0; i < 3; i++)
1239 suffix[1] = (US"DHJ")[i];
1240 fname = spool_fname(US"input", message_subdir, id, suffix);
1242 DEBUG(D_any) debug_printf(" removing %s", fname);
1243 if (Uunlink(fname) < 0)
1245 if (errno != ENOENT)
1248 printf("Error while removing %s: %s\n", fname, strerror(errno));
1250 else DEBUG(D_any) debug_printf(" (no file)\n");
1255 DEBUG(D_any) debug_printf(" (done)\n");
1260 /* In the common case, the datafile is open (and locked), so give the
1261 obvious message. Otherwise be more specific. */
1263 if (deliver_datafile >= 0) printf("has been removed\n");
1264 else printf("has been removed or did not exist\n");
1267 log_write(0, LOG_MAIN, "removed by %s", username);
1268 log_write(0, LOG_MAIN, "Completed");
1274 case MSG_MARK_ALL_DELIVERED:
1275 for (i = 0; i < recipients_count; i++)
1277 tree_add_nonrecipient(recipients_list[i].address);
1279 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1281 printf("has been modified\n");
1282 for (i = 0; i < recipients_count; i++)
1283 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1284 recipients_list[i].address, username);
1289 printf("- could not mark all delivered: %s\n", errmsg);
1294 case MSG_EDIT_SENDER:
1295 if (recipients_arg < argc - 1)
1298 printf("- only one sender address can be specified\n");
1301 doing = US"editing sender";
1304 case MSG_ADD_RECIPIENT:
1305 if (doing == NULL) doing = US"adding recipient";
1308 case MSG_MARK_DELIVERED:
1309 if (doing == NULL) doing = US"marking as delivered";
1311 /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */
1313 if (recipients_arg >= argc)
1316 printf("- error while %s: no address given\n", doing);
1320 for (; recipients_arg < argc; recipients_arg++)
1322 int start, end, domain;
1325 parse_extract_address(argv[recipients_arg], &errmess, &start, &end,
1326 &domain, (action == MSG_EDIT_SENDER));
1328 if (recipient == NULL)
1331 printf("- error while %s:\n bad address %s: %s\n",
1332 doing, argv[recipients_arg], errmess);
1334 else if (recipient[0] != 0 && domain == 0)
1337 printf("- error while %s:\n bad address %s: "
1338 "domain missing\n", doing, argv[recipients_arg]);
1342 if (action == MSG_ADD_RECIPIENT)
1345 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1347 receive_add_recipient(recipient, -1);
1348 log_write(0, LOG_MAIN, "recipient <%s> added by %s",
1349 recipient, username);
1351 else if (action == MSG_MARK_DELIVERED)
1353 for (i = 0; i < recipients_count; i++)
1354 if (Ustrcmp(recipients_list[i].address, recipient) == 0) break;
1355 if (i >= recipients_count)
1357 printf("- error while %s:\n %s is not a recipient:"
1358 " message not updated\n", doing, recipient);
1363 tree_add_nonrecipient(recipients_list[i].address);
1364 log_write(0, LOG_MAIN, "address <%s> marked delivered by %s",
1365 recipient, username);
1368 else /* MSG_EDIT_SENDER */
1371 if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE;
1373 sender_address = recipient;
1374 log_write(0, LOG_MAIN, "sender address changed to <%s> by %s",
1375 recipient, username);
1381 if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0)
1382 printf("has been modified\n");
1386 printf("- while %s: %s\n", doing, errmsg);
1392 /* Closing the datafile releases the lock and permits other processes
1393 to operate on the message (if it still exists). */
1395 if (deliver_datafile >= 0)
1397 (void)close(deliver_datafile);
1398 deliver_datafile = -1;
1405 /*************************************************
1406 * Check the queue_only_file condition *
1407 *************************************************/
1409 /* The queue_only_file option forces certain kinds of queueing if a given file
1417 queue_check_only(void)
1421 struct stat statbuf;
1424 uschar buffer[1024];
1426 if (queue_only_file == NULL) return;
1428 s = queue_only_file;
1429 while ((ss = string_nextinlist(&s, &sep, buffer, sizeof(buffer))) != NULL)
1431 if (Ustrncmp(ss, "smtp", 4) == 0)
1433 name = US"queue_smtp";
1439 name = US"queue_only";
1443 if (Ustat(ss, &statbuf) == 0)
1446 DEBUG(D_receive) debug_printf("%s set because %s exists\n", name, ss);
1451 #endif /*!COMPILE_UTILITY*/
1453 /* End of queue.c */