1 /*************************************************
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
14 /* This module contains functions to do with scanning exim's
15 queue and displaying the data therefrom. */
18 /* If we are anonymizing for screen shots, define a function to anonymize
19 addresses. Otherwise, define a macro that does nothing. */
22 static uschar *anon(uschar *s)
24 static uschar anon_result[256];
25 uschar *ss = anon_result;
26 for (; *s != 0; s++) *ss++ = (*s == '@' || *s == '.')? *s : 'x';
35 /*************************************************
37 *************************************************/
39 static int queue_total = 0; /* number of items in queue */
41 /* Table for turning base-62 numbers into binary */
43 static uschar tab62[] =
44 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
45 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
46 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
47 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
48 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
49 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
52 /* Index for quickly finding things in the ordered queue. */
54 static queue_item *queue_index[queue_index_size];
58 /*************************************************
59 * Find/Create/Delete a destination *
60 *************************************************/
62 /* If the action is dest_noop, then just return item or NULL;
63 if it is dest_add, then add if not present, and return item;
64 if it is dest_remove, remove if present and return NULL. The
65 address is lowercased to start with, unless it begins with
66 "*", which it does for error messages. */
69 find_dest(queue_item * q, const uschar * name, int action, BOOL caseless)
72 dest_item ** d = &q->destinations;
76 if ((caseless? strcmpic(name,(*d)->address) : Ustrcmp(name,(*d)->address))
79 if (action != dest_remove) return *d;
84 /* Unset any parent pointers that were to this address */
86 for (dest_item * ddd = q->destinations; ddd; ddd = ddd->next)
87 if (ddd->parent == dd) ddd->parent = NULL;
94 if (action != dest_add) return NULL;
96 dd = (dest_item *)store_malloc(sizeof(dest_item) + Ustrlen(name));
97 Ustrcpy(dd->address, name);
106 /*************************************************
107 * Clean up a dead queue item *
108 *************************************************/
111 clean_up(queue_item *p)
113 dest_item *dd = p->destinations;
116 dest_item *next = dd->next;
120 if (p->sender != NULL) store_free(p->sender);
125 /*************************************************
126 * Set up an ACL variable *
127 *************************************************/
129 /* The spool_read_header() function calls acl_var_create() when it reads in an
130 ACL variable. We know that in this case, the variable will be new, not re-used,
131 so this is a cut-down version, to save including the whole acl.c module (which
132 would need conditional compilation to cut most of it out). */
135 acl_var_create(uschar *name)
137 tree_node *node, **root;
138 root = name[0] == 'c' ? &acl_var_c : &acl_var_m;
139 node = store_get(sizeof(tree_node) + Ustrlen(name), GET_UNTAINTED);
140 Ustrcpy(node->name, name);
141 node->data.ptr = NULL;
142 (void)tree_insertnode(root, node);
148 /*************************************************
149 * Set up new queue item *
150 *************************************************/
153 set_up(uschar * name, int dir_char)
155 int i, rc, save_errno;
156 struct stat statdata;
159 queue_item *q = (queue_item *)store_malloc(sizeof(queue_item));
162 /* Initialize the block */
164 q->next = q->prev = NULL;
165 q->destinations = NULL;
166 Ustrncpy(q->name, name, sizeof(q->name));
169 q->dir_char = dir_char;
173 /* Read the header file from the spool; if there is a failure it might mean
174 inaccessibility as a result of protections. A successful read will have caused
175 sender_address to get set and the recipients fields to be initialized. If
176 there's a format error in the headers, we can still display info from the
179 Before reading the header remember the position in the dynamic store so that
180 we can recover the store into which the header is read. All data read by
181 spool_read_header that is to be preserved is copied into malloc store. */
183 reset_point = store_mark();
185 message_subdir[0] = dir_char;
186 sprintf(CS buffer, "%s-H", name);
187 rc = spool_read_header(buffer, FALSE, TRUE);
190 /* If we failed to read the envelope, compute the input time by
191 interpreting the id as a base-62 number. */
193 if (rc != spool_read_OK && rc != spool_read_hdrerror)
196 for (i = 0; i < 6; i++) t = t * 62 + tab62[name[i] - '0'];
197 q->update_time = q->input_time = t;
200 /* Envelope read; get input time and remove qualify_domain from sender address,
205 q->update_time = q->input_time = received_time.tv_sec;
206 /* deconst ok; strstric is actually safe */
207 if ((p = strstric(US sender_address+1, qualify_domain, FALSE)) != NULL &&
211 /* If we didn't read the whole header successfully, generate an error
212 message. If the envelope was read, this appears as a first recipient;
213 otherwise it sets set up in the sender field. */
215 if (rc != spool_read_OK)
219 if (save_errno == ERRNO_SPOOLFORMAT)
222 sprintf(CS big_buffer, "%s/input/%s", spool_directory, buffer);
223 if (Ustat(big_buffer, &statbuf) == 0)
224 msg = string_sprintf("*** Format error in spool file: size = " OFF_T_FMT " ***",
226 else msg = US"*** Format error in spool file ***";
228 else msg = US"*** Cannot read spool file ***";
230 if (rc == spool_read_hdrerror)
232 (void)find_dest(q, msg, dest_add, FALSE);
236 f.deliver_freeze = FALSE;
237 sender_address = msg;
238 recipients_count = 0;
242 /* Now set up the remaining data. */
244 q->frozen = f.deliver_freeze;
246 if (f.sender_set_untrusted)
248 if (sender_address[0] == 0)
250 q->sender = store_malloc(Ustrlen(originator_login) + 6);
251 sprintf(CS q->sender, "<> (%s)", originator_login);
255 q->sender = store_malloc(Ustrlen(sender_address) +
256 Ustrlen(originator_login) + 4);
257 sprintf(CS q->sender, "%s (%s)", sender_address, originator_login);
262 q->sender = store_malloc(Ustrlen(sender_address) + 1);
263 Ustrcpy(q->sender, sender_address);
266 sender_address = NULL;
268 snprintf(CS buffer, sizeof(buffer), "%s/input/%s/%s/%s-D",
269 spool_directory, queue_name, message_subdir, name);
270 if (Ustat(buffer, &statdata) == 0)
271 q->size = message_size + statdata.st_size - spool_data_start_offset(name) + 1;
273 /* Scan and process the recipients list, skipping any that have already
274 been delivered, and removing visible names. */
277 for (i = 0; i < recipients_count; i++)
279 const uschar * r = recipients_list[i].address;
280 if (tree_search(tree_nonrecipients, r) == NULL)
282 /* deconst ok; strstric is actually safe */
283 if ((p = strstric(US r+1, qualify_domain, FALSE)) != NULL &&
284 *(--p) == '@') *p = 0;
285 (void)find_dest(q, r, dest_add, FALSE);
289 /* Recover the dynamic store used by spool_read_header(). */
291 store_reset(reset_point);
297 /*************************************************
298 * Find/Create a queue item *
299 *************************************************/
301 /* The queue is kept as a doubly-linked list, sorted by name. However,
302 to speed up searches, an index into the list is used. This is maintained
303 by the scan_spool_input function when it goes down the list throwing
304 out entries that are no longer needed. When the action is "add" and
305 we don't need to add, mark the found item as seen. */
309 static void debug_queue(void)
314 printf("\nqueue_total=%d\n", queue_total);
316 for (i = 0; i < queue_index_size; i++)
317 printf("index %d = %d %s\n", i, (int)(queue_index[i]),
318 (queue_index[i])->name);
320 printf("Queue is:\n");
325 for (i = 0; i < queue_index_size; i++)
327 if (queue_index[i] == p) printf("count=%d index=%d\n", count, (int)p);
329 printf("%d %d %d %s\n", (int)p, (int)p->next, (int)p->prev, p->name);
338 find_queue(uschar *name, int action, int dir_char)
341 int last = queue_index_size - 1;
342 int middle = (first + last)/2;
343 queue_item *p, *q, *qq;
345 /* Handle the empty queue as a special case. */
347 if (queue_total == 0)
349 if (action != queue_add) return NULL;
350 if ((qq = set_up(name, dir_char)) != NULL)
353 for (i = 0; i < queue_index_size; i++) queue_index[i] = qq;
360 /* Also handle insertion at the start or end of the queue
363 if (Ustrcmp(name, (queue_index[0])->name) < 0)
365 if (action != queue_add) return NULL;
366 if ((qq = set_up(name, dir_char)) != NULL)
368 qq->next = queue_index[0];
369 (queue_index[0])->prev = qq;
377 if (Ustrcmp(name, (queue_index[queue_index_size-1])->name) > 0)
379 if (action != queue_add) return NULL;
380 if ((qq = set_up(name, dir_char)) != NULL)
382 qq->prev = queue_index[queue_index_size-1];
383 (queue_index[queue_index_size-1])->next = qq;
384 queue_index[queue_index_size-1] = qq;
391 /* Use binary chopping on the index to get a range of the queue to search
392 when the name is somewhere in the middle, if present. */
394 while (middle > first)
396 if (Ustrcmp(name, (queue_index[middle])->name) >= 0) first = middle;
398 middle = (first + last)/2;
401 /* Now search down the part of the queue in which the item must
402 lie if it exists. Both end points are inclusive - though in fact
403 the bottom one can only be = if it is the original bottom. */
405 p = queue_index[first];
406 q = queue_index[last];
410 int c = Ustrcmp(name, p->name);
412 /* Already on queue; mark seen if required. */
416 if (action == queue_add) p->seen = TRUE;
420 /* Not on the queue; add an entry if required. Note that set-up might
421 fail (the file might vanish under our feet). Note also that we know
422 there is always a previous item to p because the end points are
427 if (action == queue_add)
429 if ((qq = set_up(name, dir_char)) != NULL)
442 /* Control should not reach here if p == q, because the name
443 is supposed to be <= the name of the bottom item. */
445 if (p == q) return NULL;
447 /* Else might be further down the queue; continue */
452 /* Control should never reach here. */
457 /*************************************************
458 * Scan the exim spool directory *
459 *************************************************/
461 /* If we discover that there are subdirectories, set a flag so that the menu
462 code knows to look for them. We count the entries to set the value for the
463 queue stripchart, and set up data for the queue display window if the "full"
467 scan_spool_input(int full)
475 uschar input_dir[256];
479 stripchart_total[0] = 0;
481 sprintf(CS input_dir, "%s/input", spool_directory);
482 subptr = Ustrlen(input_dir);
483 input_dir[subptr+2] = 0; /* terminator for lengthened name */
485 /* Loop for each spool file on the queue - searching any subdirectories that
486 may exist. When initializing eximon, every file will have to be read. To show
487 there is progress, output a dot for each one to the standard output. */
489 for (i = 0; i < subdir_max; i++)
491 int subdirchar = subdirs[i]; /* 0 for main directory */
497 input_dir[subptr] = '/';
498 input_dir[subptr+1] = subdirchar;
501 if (!(dd = exim_opendir(input_dir))) continue;
503 while ((ent = readdir(dd)))
505 uschar *name = US ent->d_name;
506 int len = Ustrlen(name);
508 /* If we find a single alphameric sub-directory on the first
509 pass, add it to the list for subsequent scans, and remember that
510 we are dealing with a split directory. */
512 if (i == 0 && len == 1 && isalnum(*name))
514 subdirs[subdir_max++] = *name;
515 spool_is_split = TRUE;
519 /* Otherwise, if it is a header spool file, add it to the list */
521 if (len == SPOOL_NAME_LENGTH &&
522 name[SPOOL_NAME_LENGTH - 2] == '-' &&
523 name[SPOOL_NAME_LENGTH - 1] == 'H')
525 uschar basename[SPOOL_NAME_LENGTH + 1];
526 stripchart_total[0]++;
527 if (!eximon_initialized) { printf("."); fflush(stdout); }
528 Ustrcpy(basename, name);
529 basename[SPOOL_NAME_LENGTH - 2] = 0;
530 if (full) find_queue(basename, queue_add, subdirchar);
536 /* If simply counting the number, we are done; same if there are no
537 items in the in-store queue. */
539 if (!full || queue_total == 0) return;
541 /* Now scan the queue and remove any items that were not in the directory. At
542 the same time, set up the index pointers into the queue. Because we are
543 removing items, the total that we are comparing against isn't actually correct,
544 but in a long queue it won't make much difference, and in a short queue it
545 doesn't matter anyway!*/
547 for (p = queue_index[0]; p; )
550 queue_item * next = p->next;
552 p->prev->next = next;
554 queue_index[0] = next;
556 next->prev = p->prev;
560 queue_item * q = queue_index[queue_index_size-1];
561 for (i = queue_index_size - 1; i >= 0; i--)
562 if (queue_index[i] == q) queue_index[i] = p->prev;
570 if (++count > (queue_total * indexptr)/(queue_index_size-1))
571 queue_index[indexptr++] = p;
572 p->seen = FALSE; /* for next time */
576 /* If a lot of messages have been removed at the bottom, we may not
577 have got the index all filled in yet. Make sure all the pointers
580 while (indexptr < queue_index_size - 1)
581 queue_index[indexptr++] = queue_index[queue_index_size-1];
587 /*************************************************
588 * Update the recipients list for a message *
589 *************************************************/
591 /* We read the spool file only if its update time differs from last time,
592 or if there is a journal file in existence. */
594 /* First, a local subroutine to scan the non-recipients tree and
595 remove any of them from the address list */
598 scan_tree(queue_item *p, tree_node *tn)
602 if (tn->left != NULL) scan_tree(p, tn->left);
603 if (tn->right != NULL) scan_tree(p, tn->right);
604 (void)find_dest(p, tn->name, dest_remove, FALSE);
608 /* The main function */
610 static void update_recipients(queue_item *p)
615 struct stat statdata;
618 message_subdir[0] = p->dir_char;
620 snprintf(CS buffer, sizeof(buffer), "%s/input/%s/%s/%s-J",
621 spool_directory, queue_name, message_subdir, p->name);
623 if (!(jread = fopen(CS buffer, "r")))
625 snprintf(CS buffer, sizeof(buffer), "%s/input/%s/%s/%s-H",
626 spool_directory, queue_name, message_subdir, p->name);
627 if (Ustat(buffer, &statdata) < 0 || p->update_time == statdata.st_mtime)
631 /* Get the contents of the header file; if any problem, just give up.
632 Arrange to recover the dynamic store afterwards. */
634 reset_point = store_mark();
635 sprintf(CS buffer, "%s-H", p->name);
636 if (spool_read_header(buffer, FALSE, TRUE) != spool_read_OK)
638 store_reset(reset_point);
639 if (jread != NULL) fclose(jread);
643 /* If there's a journal file, add its contents to the non-recipients tree */
647 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
649 int n = Ustrlen(big_buffer);
651 tree_add_nonrecipient(big_buffer);
656 /* Scan and process the recipients list, removing any that have already
657 been delivered, and removing visible names. In the nonrecipients tree,
658 domains are lower cased. */
661 for (i = 0; i < recipients_count; i++)
664 const uschar * r = recipients_list[i].address;
667 if (!(node = tree_search(tree_nonrecipients, r)))
668 node = tree_search(tree_nonrecipients, string_copylc(r));
670 /* deconst ok; strstric is actually safe */
671 if ((pp = strstric(US r+1, qualify_domain, FALSE)) && *(--pp) == '@')
674 (void)find_dest(p, r, dest_add, FALSE);
676 (void)find_dest(p, r, dest_remove, FALSE);
679 /* We also need to scan the tree of non-recipients, which might
680 contain child addresses that are not in the recipients list, but
681 which may have got onto the address list as a result of eximon
682 noticing an == line in the log. Then remember the update time,
683 recover the dynamic store, and we are done. */
685 scan_tree(p, tree_nonrecipients);
686 p->update_time = statdata.st_mtime;
687 store_reset(reset_point);
692 /*************************************************
693 * Display queue data *
694 *************************************************/
696 /* The present implementation simple re-writes the entire information each
697 time. Take some care to keep the scrolled position as it previously was, but,
698 if it was at the bottom, keep it at the bottom. Take note of any hide list, and
699 time out the entries as appropriate. */
704 int now = (int)time(NULL);
705 queue_item *p = queue_index[0];
707 if (menu_is_up) return; /* Avoid nasty interactions */
709 text_empty(queue_widget);
716 int t = (now - p->input_time)/60; /* minutes on queue */
726 if (t > 99) /* someone had > 99 days */
730 if (t > 99) /* so, just in case */
739 update_recipients(p); /* update destinations */
741 /* Can't set this earlier, as header data may change things. */
743 dd = p->destinations;
745 /* Check to see if this message is on the hide list; if any hide
746 item has timed out, remove it from the list. Hide if all destinations
747 are on the hide list. */
749 for (ddd = dd; ddd != NULL; ddd = ddd->next)
755 if (ddd->address[0] == '*') break;
756 len_address = Ustrlen(ddd->address);
758 for (skp = &queue_skip; ; skp = &(sk->next))
763 while (sk != NULL && now >= sk->reveal)
768 if (queue_skip == NULL)
770 XtDestroyWidget(unhide_widget);
771 unhide_widget = NULL;
774 if (sk == NULL) break;
776 /* If this address matches the skip item, break (sk != NULL) */
778 len_skip = Ustrlen(sk->text);
779 if (len_skip <= len_address &&
780 Ustrcmp(ddd->address + len_address - len_skip, sk->text) == 0)
784 if (sk == NULL) break;
787 /* Don't use more than one call of anon() in one statement - it uses
788 a fixed static buffer. */
790 if (ddd != NULL || dd == NULL)
792 text_showf(queue_widget, "%c%2d%c %s %s %-8s ",
793 (p->frozen)? '*' : ' ',
795 string_format_size(p->size, big_buffer),
797 (p->sender == NULL)? US" " :
798 (p->sender[0] == 0)? US"<> " : anon(p->sender));
800 text_showf(queue_widget, "%s%s%s",
801 (dd == NULL || dd->address[0] == '*')? "" : "<",
802 (dd == NULL)? US"" : anon(dd->address),
803 (dd == NULL || dd->address[0] == '*')? "" : ">");
805 if (dd != NULL && dd->parent != NULL && dd->parent->address[0] != '*')
806 text_showf(queue_widget, " parent <%s>", anon(dd->parent->address));
808 text_show(queue_widget, US"\n");
810 if (dd != NULL) dd = dd->next;
811 while (dd != NULL && count++ < queue_max_addresses)
813 text_showf(queue_widget, " <%s>",
815 if (dd->parent != NULL && dd->parent->address[0] != '*')
816 text_showf(queue_widget, " parent <%s>", anon(dd->parent->address));
817 text_show(queue_widget, US"\n");
821 text_showf(queue_widget, " ...\n");
828 /* End of em_queue.c */