Commit | Line | Data |
---|---|---|
059ec3d9 PH |
1 | /************************************************* |
2 | * Exim - an Internet mail transport agent * | |
3 | *************************************************/ | |
4 | ||
f9ba5e22 | 5 | /* Copyright (c) University of Cambridge 1995 - 2018 */ |
059ec3d9 PH |
6 | /* See the file NOTICE for conditions of use and distribution. */ |
7 | ||
8 | /* Functions that operate on the input queue. */ | |
9 | ||
10 | ||
11 | #include "exim.h" | |
12 | ||
13 | ||
14 | ||
41313d92 JH |
15 | |
16 | ||
17 | ||
18 | ||
19 | #ifndef COMPILE_UTILITY | |
0971ec06 JH |
20 | |
21 | /* The number of nodes to use for the bottom-up merge sort when a list of queue | |
22 | items is to be ordered. The code for this sort was contributed as a patch by | |
23 | Michael Haardt. */ | |
24 | ||
25 | #define LOG2_MAXNODES 32 | |
26 | ||
27 | ||
28 | ||
059ec3d9 PH |
29 | /************************************************* |
30 | * Helper sort function for queue_get_spool_list * | |
31 | *************************************************/ | |
32 | ||
33 | /* This function is used when sorting the queue list in the function | |
34 | queue_get_spool_list() below. | |
35 | ||
36 | Arguments: | |
37 | a points to an ordered list of queue_filename items | |
38 | b points to another ordered list | |
39 | ||
40 | Returns: a pointer to a merged ordered list | |
41 | */ | |
42 | ||
43 | static queue_filename * | |
44 | merge_queue_lists(queue_filename *a, queue_filename *b) | |
45 | { | |
46 | queue_filename *first = NULL; | |
47 | queue_filename **append = &first; | |
48 | ||
40c90bca | 49 | while (a && b) |
2540f2f8 JH |
50 | { |
51 | int d; | |
52 | if ((d = Ustrncmp(a->text, b->text, 6)) == 0) | |
53 | d = Ustrcmp(a->text + 14, b->text + 14); | |
54 | if (d < 0) | |
059ec3d9 PH |
55 | { |
56 | *append = a; | |
57 | append= &a->next; | |
58 | a = a->next; | |
59 | } | |
60 | else | |
61 | { | |
62 | *append = b; | |
63 | append= &b->next; | |
64 | b = b->next; | |
65 | } | |
2540f2f8 | 66 | } |
059ec3d9 | 67 | |
40c90bca | 68 | *append = a ? a : b; |
059ec3d9 PH |
69 | return first; |
70 | } | |
71 | ||
72 | ||
73 | ||
74 | ||
75 | ||
76 | /************************************************* | |
77 | * Get list of spool files * | |
78 | *************************************************/ | |
79 | ||
80 | /* Scan the spool directory and return a list of the relevant file names | |
81 | therein. Single-character sub-directories are handled as follows: | |
82 | ||
83 | If the first argument is > 0, a sub-directory is scanned; the letter is | |
84 | taken from the nth entry in subdirs. | |
85 | ||
86 | If the first argument is 0, sub-directories are not scanned. However, a | |
87 | list of them is returned. | |
88 | ||
89 | If the first argument is < 0, sub-directories are scanned for messages, | |
90 | and a single, unified list is created. The returned data blocks contain the | |
91 | identifying character of the subdirectory, if any. The subdirs vector is | |
92 | still required as an argument. | |
93 | ||
94 | If the randomize argument is TRUE, messages are returned in "randomized" order. | |
95 | Actually, the order is anything but random, but the algorithm is cheap, and the | |
96 | point is simply to ensure that the same order doesn't occur every time, in case | |
97 | a particular message is causing a remote MTA to barf - we would like to try | |
98 | other messages to that MTA first. | |
99 | ||
100 | If the randomize argument is FALSE, sort the list according to the file name. | |
101 | This should give the order in which the messages arrived. It is normally used | |
102 | only for presentation to humans, in which case the (possibly expensive) sort | |
103 | that it does is not part of the normal operational code. However, if | |
104 | queue_run_in_order is set, sorting has to take place for queue runs as well. | |
105 | When randomize is FALSE, the first argument is normally -1, so all messages are | |
106 | included. | |
107 | ||
108 | Arguments: | |
109 | subdiroffset sub-directory character offset, or 0 or -1 (see above) | |
110 | subdirs vector to store list of subdirchars | |
111 | subcount pointer to int in which to store count of subdirs | |
112 | randomize TRUE if the order of the list is to be unpredictable | |
45907b9d | 113 | pcount If not NULL, fill in with count of files and do not return list |
059ec3d9 PH |
114 | |
115 | Returns: pointer to a chain of queue name items | |
116 | */ | |
117 | ||
118 | static queue_filename * | |
119 | queue_get_spool_list(int subdiroffset, uschar *subdirs, int *subcount, | |
45907b9d | 120 | BOOL randomize, unsigned * pcount) |
059ec3d9 PH |
121 | { |
122 | int i; | |
123 | int flags = 0; | |
124 | int resetflags = -1; | |
125 | int subptr; | |
126 | queue_filename *yield = NULL; | |
127 | queue_filename *last = NULL; | |
059ec3d9 PH |
128 | uschar buffer[256]; |
129 | queue_filename *root[LOG2_MAXNODES]; | |
130 | ||
131 | /* When randomizing, the file names are added to the start or end of the list | |
132 | according to the bits of the flags variable. Get a collection of bits from the | |
133 | current time. Use the bottom 16 and just keep re-using them if necessary. When | |
134 | not randomizing, initialize the sublists for the bottom-up merge sort. */ | |
135 | ||
45907b9d JH |
136 | if (pcount) |
137 | *pcount = 0; | |
138 | else if (randomize) | |
40c90bca JH |
139 | resetflags = time(NULL) & 0xFFFF; |
140 | else | |
141 | for (i = 0; i < LOG2_MAXNODES; i++) | |
142 | root[i] = NULL; | |
059ec3d9 PH |
143 | |
144 | /* If processing the full queue, or just the top-level, start at the base | |
145 | directory, and initialize the first subdirectory name (as none). Otherwise, | |
146 | start at the sub-directory offset. */ | |
147 | ||
148 | if (subdiroffset <= 0) | |
149 | { | |
150 | i = 0; | |
151 | subdirs[0] = 0; | |
152 | *subcount = 0; | |
153 | } | |
40c90bca JH |
154 | else |
155 | i = subdiroffset; | |
059ec3d9 PH |
156 | |
157 | /* Set up prototype for the directory name. */ | |
158 | ||
41313d92 | 159 | spool_pname_buf(buffer, sizeof(buffer)); |
a2da3176 | 160 | buffer[sizeof(buffer) - 3] = 0; |
059ec3d9 PH |
161 | subptr = Ustrlen(buffer); |
162 | buffer[subptr+2] = 0; /* terminator for lengthened name */ | |
163 | ||
164 | /* This loop runs at least once, for the main or given directory, and then as | |
165 | many times as necessary to scan any subdirectories encountered in the main | |
166 | directory, if they are to be scanned at this time. */ | |
167 | ||
168 | for (; i <= *subcount; i++) | |
169 | { | |
170 | int count = 0; | |
171 | int subdirchar = subdirs[i]; /* 0 for main directory */ | |
54a2a2a9 | 172 | DIR *dd; |
059ec3d9 PH |
173 | |
174 | if (subdirchar != 0) | |
175 | { | |
176 | buffer[subptr] = '/'; | |
177 | buffer[subptr+1] = subdirchar; | |
178 | } | |
179 | ||
41313d92 | 180 | DEBUG(D_queue_run) debug_printf("looking in %s\n", buffer); |
54a2a2a9 | 181 | if (!(dd = exim_opendir(buffer))) |
a2da3176 | 182 | continue; |
059ec3d9 PH |
183 | |
184 | /* Now scan the directory. */ | |
185 | ||
54a2a2a9 | 186 | for (struct dirent *ent; ent = readdir(dd); ) |
059ec3d9 PH |
187 | { |
188 | uschar *name = US ent->d_name; | |
189 | int len = Ustrlen(name); | |
190 | ||
191 | /* Count entries */ | |
192 | ||
193 | count++; | |
194 | ||
195 | /* If we find a single alphameric sub-directory in the base directory, | |
196 | add it to the list for subsequent scans. */ | |
197 | ||
198 | if (i == 0 && len == 1 && isalnum(*name)) | |
199 | { | |
200 | *subcount = *subcount + 1; | |
201 | subdirs[*subcount] = *name; | |
202 | continue; | |
203 | } | |
204 | ||
205 | /* Otherwise, if it is a header spool file, add it to the list */ | |
206 | ||
207 | if (len == SPOOL_NAME_LENGTH && | |
208 | Ustrcmp(name + SPOOL_NAME_LENGTH - 2, "-H") == 0) | |
45907b9d JH |
209 | if (pcount) |
210 | (*pcount)++; | |
059ec3d9 | 211 | else |
45907b9d JH |
212 | { |
213 | queue_filename *next = | |
214 | store_get(sizeof(queue_filename) + Ustrlen(name), is_tainted(name)); | |
215 | Ustrcpy(next->text, name); | |
216 | next->dir_uschar = subdirchar; | |
217 | ||
218 | /* Handle the creation of a randomized list. The first item becomes both | |
219 | the top and bottom of the list. Subsequent items are inserted either at | |
220 | the top or the bottom, randomly. This is, I argue, faster than doing a | |
221 | sort by allocating a random number to each item, and it also saves having | |
222 | to store the number with each item. */ | |
223 | ||
224 | if (randomize) | |
225 | if (!yield) | |
226 | { | |
227 | next->next = NULL; | |
228 | yield = last = next; | |
229 | } | |
230 | else | |
231 | { | |
232 | if (flags == 0) | |
233 | flags = resetflags; | |
234 | if ((flags & 1) == 0) | |
235 | { | |
236 | next->next = yield; | |
237 | yield = next; | |
238 | } | |
239 | else | |
240 | { | |
241 | next->next = NULL; | |
242 | last->next = next; | |
243 | last = next; | |
244 | } | |
245 | flags = flags >> 1; | |
246 | } | |
247 | ||
248 | /* Otherwise do a bottom-up merge sort based on the name. */ | |
249 | ||
250 | else | |
251 | { | |
252 | next->next = NULL; | |
253 | for (int j = 0; j < LOG2_MAXNODES; j++) | |
254 | if (root[j]) | |
255 | { | |
256 | next = merge_queue_lists(next, root[j]); | |
257 | root[j] = j == LOG2_MAXNODES - 1 ? next : NULL; | |
258 | } | |
259 | else | |
260 | { | |
261 | root[j] = next; | |
262 | break; | |
263 | } | |
264 | } | |
265 | } | |
059ec3d9 PH |
266 | } |
267 | ||
268 | /* Finished with this directory */ | |
269 | ||
270 | closedir(dd); | |
271 | ||
272 | /* If we have just scanned a sub-directory, and it was empty (count == 2 | |
273 | implies just "." and ".." entries), and Exim is no longer configured to | |
274 | use sub-directories, attempt to get rid of it. At the same time, try to | |
275 | get rid of any corresponding msglog subdirectory. These are just cosmetic | |
276 | tidying actions, so just ignore failures. If we are scanning just a single | |
277 | sub-directory, break the loop. */ | |
278 | ||
279 | if (i != 0) | |
280 | { | |
281 | if (!split_spool_directory && count <= 2) | |
282 | { | |
41313d92 JH |
283 | uschar subdir[2]; |
284 | ||
059ec3d9 | 285 | rmdir(CS buffer); |
41313d92 JH |
286 | subdir[0] = subdirchar; subdir[1] = 0; |
287 | rmdir(CS spool_dname(US"msglog", subdir)); | |
059ec3d9 PH |
288 | } |
289 | if (subdiroffset > 0) break; /* Single sub-directory */ | |
290 | } | |
291 | ||
292 | /* If we have just scanned the base directory, and subdiroffset is 0, | |
293 | we do not want to continue scanning the sub-directories. */ | |
294 | ||
40c90bca JH |
295 | else if (subdiroffset == 0) |
296 | break; | |
059ec3d9 PH |
297 | } /* Loop for multiple subdirectories */ |
298 | ||
299 | /* When using a bottom-up merge sort, do the final merging of the sublists. | |
300 | Then pass back the final list of file items. */ | |
301 | ||
45907b9d | 302 | if (!pcount && !randomize) |
059ec3d9 PH |
303 | for (i = 0; i < LOG2_MAXNODES; ++i) |
304 | yield = merge_queue_lists(yield, root[i]); | |
305 | ||
306 | return yield; | |
307 | } | |
308 | ||
309 | ||
310 | ||
311 | ||
312 | /************************************************* | |
313 | * Perform a queue run * | |
314 | *************************************************/ | |
315 | ||
316 | /* The arguments give the messages to start and stop at; NULL means start at | |
317 | the beginning or stop at the end. If the given start message doesn't exist, we | |
318 | start at the next lexically greater one, and likewise we stop at the after the | |
319 | previous lexically lesser one if the given stop message doesn't exist. Because | |
320 | a queue run can take some time, stat each file before forking, in case it has | |
321 | been delivered in the meantime by some other means. | |
322 | ||
323 | The global variables queue_run_force and queue_run_local may be set to cause | |
324 | forced deliveries or local-only deliveries, respectively. | |
325 | ||
326 | If deliver_selectstring[_sender] is not NULL, skip messages whose recipients do | |
327 | not contain the string. As this option is typically used when a machine comes | |
328 | back online, we want to ensure that at least one delivery attempt takes place, | |
329 | so force the first one. The selecting string can optionally be a regex, or | |
330 | refer to the sender instead of recipients. | |
331 | ||
332 | If queue_2stage is set, the queue is scanned twice. The first time, queue_smtp | |
333 | is set so that routing is done for all messages. Thus in the second run those | |
334 | that are routed to the same host should go down the same SMTP connection. | |
335 | ||
336 | Arguments: | |
337 | start_id message id to start at, or NULL for all | |
338 | stop_id message id to end at, or NULL for all | |
339 | recurse TRUE if recursing for 2-stage run | |
340 | ||
341 | Returns: nothing | |
342 | */ | |
343 | ||
344 | void | |
345 | queue_run(uschar *start_id, uschar *stop_id, BOOL recurse) | |
346 | { | |
8768d548 | 347 | BOOL force_delivery = f.queue_run_force || deliver_selectstring != NULL || |
059ec3d9 PH |
348 | deliver_selectstring_sender != NULL; |
349 | const pcre *selectstring_regex = NULL; | |
350 | const pcre *selectstring_regex_sender = NULL; | |
351 | uschar *log_detail = NULL; | |
352 | int subcount = 0; | |
059ec3d9 | 353 | uschar subdirs[64]; |
4c2efd7a | 354 | pid_t qpid[4] = {0}; /* Parallelism factor for q2stage 1st phase */ |
b5695709 | 355 | BOOL single_id = FALSE; |
059ec3d9 | 356 | |
9f01e50d JH |
357 | #ifdef MEASURE_TIMING |
358 | report_time_since(×tamp_startup, US"queue_run start"); | |
359 | #endif | |
360 | ||
059ec3d9 PH |
361 | /* Cancel any specific queue domains. Turn off the flag that causes SMTP |
362 | deliveries not to happen, unless doing a 2-stage queue run, when the SMTP flag | |
363 | gets set. Save the queue_runner's pid and the flag that indicates any | |
364 | deliveries run directly from this process. Deliveries that are run by handing | |
365 | on TCP/IP channels have queue_run_pid set, but not queue_running. */ | |
366 | ||
367 | queue_domains = NULL; | |
368 | queue_smtp_domains = NULL; | |
8768d548 | 369 | f.queue_smtp = f.queue_2stage; |
059ec3d9 PH |
370 | |
371 | queue_run_pid = getpid(); | |
8768d548 | 372 | f.queue_running = TRUE; |
059ec3d9 PH |
373 | |
374 | /* Log the true start of a queue run, and fancy options */ | |
375 | ||
376 | if (!recurse) | |
377 | { | |
378 | uschar extras[8]; | |
379 | uschar *p = extras; | |
380 | ||
8768d548 JH |
381 | if (f.queue_2stage) *p++ = 'q'; |
382 | if (f.queue_run_first_delivery) *p++ = 'i'; | |
383 | if (f.queue_run_force) *p++ = 'f'; | |
384 | if (f.deliver_force_thaw) *p++ = 'f'; | |
385 | if (f.queue_run_local) *p++ = 'l'; | |
059ec3d9 PH |
386 | *p = 0; |
387 | ||
388 | p = big_buffer; | |
5976eb99 | 389 | p += sprintf(CS p, "pid=%d", (int)queue_run_pid); |
059ec3d9 PH |
390 | |
391 | if (extras[0] != 0) | |
5976eb99 | 392 | p += sprintf(CS p, " -q%s", extras); |
059ec3d9 | 393 | |
5976eb99 | 394 | if (deliver_selectstring) |
8768d548 | 395 | p += sprintf(CS p, " -R%s %s", f.deliver_selectstring_regex? "r" : "", |
059ec3d9 | 396 | deliver_selectstring); |
059ec3d9 | 397 | |
5976eb99 | 398 | if (deliver_selectstring_sender) |
8768d548 | 399 | p += sprintf(CS p, " -S%s %s", f.deliver_selectstring_sender_regex? "r" : "", |
059ec3d9 | 400 | deliver_selectstring_sender); |
059ec3d9 PH |
401 | |
402 | log_detail = string_copy(big_buffer); | |
6073ad45 JH |
403 | if (*queue_name) |
404 | log_write(L_queue_run, LOG_MAIN, "Start '%s' queue run: %s", | |
405 | queue_name, log_detail); | |
406 | else | |
407 | log_write(L_queue_run, LOG_MAIN, "Start queue run: %s", log_detail); | |
b5695709 JH |
408 | |
409 | single_id = start_id && stop_id && !f.queue_2stage | |
410 | && Ustrcmp(start_id, stop_id) == 0; | |
059ec3d9 PH |
411 | } |
412 | ||
413 | /* If deliver_selectstring is a regex, compile it. */ | |
414 | ||
8768d548 | 415 | if (deliver_selectstring && f.deliver_selectstring_regex) |
059ec3d9 PH |
416 | selectstring_regex = regex_must_compile(deliver_selectstring, TRUE, FALSE); |
417 | ||
8768d548 | 418 | if (deliver_selectstring_sender && f.deliver_selectstring_sender_regex) |
059ec3d9 PH |
419 | selectstring_regex_sender = |
420 | regex_must_compile(deliver_selectstring_sender, TRUE, FALSE); | |
421 | ||
422 | /* If the spool is split into subdirectories, we want to process it one | |
423 | directory at a time, so as to spread out the directory scanning and the | |
424 | delivering when there are lots of messages involved, except when | |
425 | queue_run_in_order is set. | |
426 | ||
427 | In the random order case, this loop runs once for the main directory (handling | |
428 | any messages therein), and then repeats for any subdirectories that were found. | |
429 | When the first argument of queue_get_spool_list() is 0, it scans the top | |
430 | directory, fills in subdirs, and sets subcount. The order of the directories is | |
431 | then randomized after the first time through, before they are scanned in | |
4c04137d | 432 | subsequent iterations. |
059ec3d9 PH |
433 | |
434 | When the first argument of queue_get_spool_list() is -1 (for queue_run_in_ | |
435 | order), it scans all directories and makes a single message list. */ | |
436 | ||
d7978c0f | 437 | for (int i = queue_run_in_order ? -1 : 0; |
2540f2f8 | 438 | i <= (queue_run_in_order ? -1 : subcount); |
059ec3d9 PH |
439 | i++) |
440 | { | |
f3ebb786 | 441 | rmark reset_point1 = store_mark(); |
059ec3d9 PH |
442 | |
443 | DEBUG(D_queue_run) | |
444 | { | |
445 | if (i == 0) | |
446 | debug_printf("queue running main directory\n"); | |
447 | else if (i == -1) | |
448 | debug_printf("queue running combined directories\n"); | |
449 | else | |
450 | debug_printf("queue running subdirectory '%c'\n", subdirs[i]); | |
451 | } | |
452 | ||
d7978c0f | 453 | for (queue_filename * fq = queue_get_spool_list(i, subdirs, &subcount, |
45907b9d | 454 | !queue_run_in_order, NULL); |
d7978c0f | 455 | fq; fq = fq->next) |
059ec3d9 PH |
456 | { |
457 | pid_t pid; | |
458 | int status; | |
459 | int pfd[2]; | |
460 | struct stat statbuf; | |
461 | uschar buffer[256]; | |
462 | ||
463 | /* Unless deliveries are forced, if deliver_queue_load_max is non-negative, | |
464 | check that the load average is low enough to permit deliveries. */ | |
465 | ||
8768d548 | 466 | if (!f.queue_run_force && deliver_queue_load_max >= 0) |
40c90bca | 467 | if ((load_average = os_getloadavg()) > deliver_queue_load_max) |
059ec3d9 | 468 | { |
3eef829e PH |
469 | log_write(L_queue_run, LOG_MAIN, "Abandon queue run: %s (load %.2f, max %.2f)", |
470 | log_detail, | |
059ec3d9 PH |
471 | (double)load_average/1000.0, |
472 | (double)deliver_queue_load_max/1000.0); | |
473 | i = subcount; /* Don't process other directories */ | |
474 | break; | |
475 | } | |
476 | else | |
059ec3d9 PH |
477 | DEBUG(D_load) debug_printf("load average = %.2f max = %.2f\n", |
478 | (double)load_average/1000.0, | |
479 | (double)deliver_queue_load_max/1000.0); | |
059ec3d9 | 480 | |
92562f63 JH |
481 | /* If initial of a 2-phase run, maintain a set of child procs |
482 | to get disk parallelism */ | |
483 | ||
484 | if (f.queue_2stage && !queue_run_in_order) | |
485 | { | |
486 | int i; | |
2f2dd3a5 | 487 | if (qpid[f.running_in_test_harness ? 0 : nelem(qpid) - 1]) |
92562f63 | 488 | { |
ecf05143 | 489 | DEBUG(D_queue_run) debug_printf("q2stage waiting for child %d\n", (int)qpid[0]); |
92562f63 JH |
490 | waitpid(qpid[0], NULL, 0); |
491 | DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[0]); | |
ecf05143 JH |
492 | if (f.running_in_test_harness) i = 0; |
493 | else for (i = 0; i < nelem(qpid) - 1; i++) qpid[i] = qpid[i+1]; | |
92562f63 JH |
494 | qpid[i] = 0; |
495 | } | |
496 | else | |
497 | for (i = 0; qpid[i]; ) i++; | |
4b01271f | 498 | if ((qpid[i] = exim_fork(US"qrun-phase-one"))) |
92562f63 | 499 | continue; /* parent loops around */ |
92562f63 JH |
500 | } |
501 | ||
059ec3d9 PH |
502 | /* Skip this message unless it's within the ID limits */ |
503 | ||
8768d548 | 504 | if (stop_id && Ustrncmp(fq->text, stop_id, MESSAGE_ID_LENGTH) > 0) |
92562f63 | 505 | goto go_around; |
8768d548 | 506 | if (start_id && Ustrncmp(fq->text, start_id, MESSAGE_ID_LENGTH) < 0) |
92562f63 | 507 | goto go_around; |
059ec3d9 PH |
508 | |
509 | /* Check that the message still exists */ | |
510 | ||
8768d548 JH |
511 | message_subdir[0] = fq->dir_uschar; |
512 | if (Ustat(spool_fname(US"input", message_subdir, fq->text, US""), &statbuf) < 0) | |
92562f63 | 513 | goto go_around; |
059ec3d9 PH |
514 | |
515 | /* There are some tests that require the reading of the header file. Ensure | |
516 | the store used is scavenged afterwards so that this process doesn't keep | |
517 | growing its store. We have to read the header file again when actually | |
518 | delivering, but it's cheaper than forking a delivery process for each | |
519 | message when many are not going to be delivered. */ | |
520 | ||
40c90bca | 521 | if (deliver_selectstring || deliver_selectstring_sender || |
8768d548 | 522 | f.queue_run_first_delivery) |
059ec3d9 PH |
523 | { |
524 | BOOL wanted = TRUE; | |
8768d548 | 525 | BOOL orig_dont_deliver = f.dont_deliver; |
f3ebb786 | 526 | rmark reset_point2 = store_mark(); |
059ec3d9 PH |
527 | |
528 | /* Restore the original setting of dont_deliver after reading the header, | |
529 | so that a setting for a particular message doesn't force it for any that | |
530 | follow. If the message is chosen for delivery, the header is read again | |
531 | in the deliver_message() function, in a subprocess. */ | |
532 | ||
92562f63 | 533 | if (spool_read_header(fq->text, FALSE, TRUE) != spool_read_OK) goto go_around; |
8768d548 | 534 | f.dont_deliver = orig_dont_deliver; |
059ec3d9 PH |
535 | |
536 | /* Now decide if we want to deliver this message. As we have read the | |
537 | header file, we might as well do the freeze test now, and save forking | |
538 | another process. */ | |
539 | ||
8768d548 | 540 | if (f.deliver_freeze && !f.deliver_force_thaw) |
059ec3d9 PH |
541 | { |
542 | log_write(L_skip_delivery, LOG_MAIN, "Message is frozen"); | |
543 | wanted = FALSE; | |
544 | } | |
545 | ||
546 | /* Check first_delivery in the case when there are no message logs. */ | |
547 | ||
8768d548 | 548 | else if (f.queue_run_first_delivery && !f.deliver_firsttime) |
059ec3d9 | 549 | { |
8768d548 | 550 | DEBUG(D_queue_run) debug_printf("%s: not first delivery\n", fq->text); |
059ec3d9 PH |
551 | wanted = FALSE; |
552 | } | |
553 | ||
40c90bca | 554 | /* Check for a matching address if deliver_selectstring[_sender] is set. |
059ec3d9 PH |
555 | If so, we do a fully delivery - don't want to omit other addresses since |
556 | their routing might trigger re-writing etc. */ | |
557 | ||
558 | /* Sender matching */ | |
559 | ||
40c90bca | 560 | else if ( deliver_selectstring_sender |
8768d548 | 561 | && !(f.deliver_selectstring_sender_regex |
40c90bca JH |
562 | ? (pcre_exec(selectstring_regex_sender, NULL, |
563 | CS sender_address, Ustrlen(sender_address), 0, PCRE_EOPT, | |
564 | NULL, 0) >= 0) | |
565 | : (strstric(sender_address, deliver_selectstring_sender, FALSE) | |
566 | != NULL) | |
567 | ) ) | |
059ec3d9 PH |
568 | { |
569 | DEBUG(D_queue_run) debug_printf("%s: sender address did not match %s\n", | |
8768d548 | 570 | fq->text, deliver_selectstring_sender); |
059ec3d9 PH |
571 | wanted = FALSE; |
572 | } | |
573 | ||
574 | /* Recipient matching */ | |
575 | ||
40c90bca | 576 | else if (deliver_selectstring) |
059ec3d9 PH |
577 | { |
578 | int i; | |
579 | for (i = 0; i < recipients_count; i++) | |
580 | { | |
581 | uschar *address = recipients_list[i].address; | |
8768d548 | 582 | if ( (f.deliver_selectstring_regex |
40c90bca JH |
583 | ? (pcre_exec(selectstring_regex, NULL, CS address, |
584 | Ustrlen(address), 0, PCRE_EOPT, NULL, 0) >= 0) | |
585 | : (strstric(address, deliver_selectstring, FALSE) != NULL) | |
586 | ) | |
587 | && tree_search(tree_nonrecipients, address) == NULL | |
588 | ) | |
059ec3d9 PH |
589 | break; |
590 | } | |
591 | ||
592 | if (i >= recipients_count) | |
593 | { | |
594 | DEBUG(D_queue_run) | |
595 | debug_printf("%s: no recipient address matched %s\n", | |
8768d548 | 596 | fq->text, deliver_selectstring); |
059ec3d9 PH |
597 | wanted = FALSE; |
598 | } | |
599 | } | |
600 | ||
601 | /* Recover store used when reading the header */ | |
602 | ||
4b4856ff | 603 | spool_clear_header_globals(); |
059ec3d9 | 604 | store_reset(reset_point2); |
92562f63 | 605 | if (!wanted) goto go_around; /* With next message */ |
059ec3d9 PH |
606 | } |
607 | ||
608 | /* OK, got a message we want to deliver. Create a pipe which will | |
609 | serve as a means of detecting when all the processes created by the | |
610 | delivery process are finished. This is relevant when the delivery | |
611 | process passes one or more SMTP channels on to its own children. The | |
612 | pipe gets passed down; by reading on it here we detect when the last | |
613 | descendent dies by the unblocking of the read. It's a pity that for | |
614 | most of the time the pipe isn't used, but creating a pipe should be | |
615 | pretty cheap. */ | |
616 | ||
617 | if (pipe(pfd) < 0) | |
059ec3d9 PH |
618 | log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to create pipe in queue " |
619 | "runner process %d: %s", queue_run_pid, strerror(errno)); | |
059ec3d9 PH |
620 | queue_run_pipe = pfd[pipe_write]; /* To ensure it gets passed on. */ |
621 | ||
622 | /* Make sure it isn't stdin. This seems unlikely, but just to be on the | |
623 | safe side... */ | |
624 | ||
625 | if (queue_run_pipe == 0) | |
626 | { | |
627 | queue_run_pipe = dup(queue_run_pipe); | |
f1e894f3 | 628 | (void)close(0); |
059ec3d9 PH |
629 | } |
630 | ||
631 | /* Before forking to deliver the message, ensure any open and cached | |
632 | lookup files or databases are closed. Otherwise, closing in the subprocess | |
633 | can make the next subprocess have problems. There won't often be anything | |
634 | open here, but it is possible (e.g. if spool_directory is an expanded | |
635 | string). A single call before this loop would probably suffice, but just in | |
636 | case expansions get inserted at some point, I've taken the heavy-handed | |
637 | approach. When nothing is open, the call should be cheap. */ | |
638 | ||
639 | search_tidyup(); | |
640 | ||
641 | /* Now deliver the message; get the id by cutting the -H off the file | |
642 | name. The return of the process is zero if a delivery was attempted. */ | |
643 | ||
8768d548 JH |
644 | set_process_info("running queue: %s", fq->text); |
645 | fq->text[SPOOL_NAME_LENGTH-2] = 0; | |
9f01e50d JH |
646 | #ifdef MEASURE_TIMING |
647 | report_time_since(×tamp_startup, US"queue msg selected"); | |
648 | #endif | |
649 | ||
b5695709 | 650 | single_item_retry: |
81022793 | 651 | if ((pid = exim_fork(US"qrun-delivery")) == 0) |
059ec3d9 PH |
652 | { |
653 | int rc; | |
654 | (void)close(pfd[pipe_read]); | |
8768d548 | 655 | rc = deliver_message(fq->text, force_delivery, FALSE); |
81022793 JH |
656 | exim_underbar_exit(rc == DELIVER_NOT_ATTEMPTED |
657 | ? EXIT_FAILURE : EXIT_SUCCESS); | |
059ec3d9 PH |
658 | } |
659 | if (pid < 0) | |
660 | log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork of delivery process from " | |
661 | "queue runner %d failed\n", queue_run_pid); | |
662 | ||
663 | /* Close the writing end of the synchronizing pipe in this process, | |
664 | then wait for the first level process to terminate. */ | |
665 | ||
f1e894f3 | 666 | (void)close(pfd[pipe_write]); |
8768d548 | 667 | set_process_info("running queue: waiting for %s (%d)", fq->text, pid); |
059ec3d9 PH |
668 | while (wait(&status) != pid); |
669 | ||
670 | /* A zero return means a delivery was attempted; turn off the force flag | |
671 | for any subsequent calls unless queue_force is set. */ | |
672 | ||
aa81ee14 | 673 | if (!(status & 0xffff)) force_delivery = f.queue_run_force; |
059ec3d9 PH |
674 | |
675 | /* If the process crashed, tell somebody */ | |
676 | ||
aa81ee14 | 677 | else if (status & 0x00ff) |
059ec3d9 PH |
678 | log_write(0, LOG_MAIN|LOG_PANIC, |
679 | "queue run: process %d crashed with signal %d while delivering %s", | |
8768d548 | 680 | (int)pid, status & 0x00ff, fq->text); |
059ec3d9 | 681 | |
b5695709 JH |
682 | /* If single-item delivery was untried (likely due to locking) |
683 | retry once after a delay */ | |
684 | ||
685 | if (status & 0xff00 && single_id) | |
686 | { | |
687 | single_id = FALSE; | |
688 | DEBUG(D_queue_run) debug_printf("qrun single-item pause before retry\n"); | |
689 | millisleep(500); | |
690 | DEBUG(D_queue_run) debug_printf("qrun single-item retry after pause\n"); | |
691 | goto single_item_retry; | |
692 | } | |
693 | ||
059ec3d9 PH |
694 | /* Before continuing, wait till the pipe gets closed at the far end. This |
695 | tells us that any children created by the delivery to re-use any SMTP | |
696 | channels have all finished. Since no process actually writes to the pipe, | |
697 | the mere fact that read() unblocks is enough. */ | |
698 | ||
699 | set_process_info("running queue: waiting for children of %d", pid); | |
847a015a JH |
700 | if ((status = read(pfd[pipe_read], buffer, sizeof(buffer))) != 0) |
701 | log_write(0, LOG_MAIN|LOG_PANIC, status > 0 ? | |
702 | "queue run: unexpected data on pipe" : "queue run: error on pipe: %s", | |
aa81ee14 | 703 | strerror(errno)); |
059ec3d9 PH |
704 | (void)close(pfd[pipe_read]); |
705 | set_process_info("running queue"); | |
706 | ||
92562f63 JH |
707 | /* If initial of a 2-phase run, we are a child - so just exit */ |
708 | if (f.queue_2stage && !queue_run_in_order) | |
81022793 | 709 | exim_exit(EXIT_SUCCESS); |
92562f63 | 710 | |
059ec3d9 PH |
711 | /* If we are in the test harness, and this is not the first of a 2-stage |
712 | queue run, update fudged queue times. */ | |
713 | ||
8768d548 | 714 | if (f.running_in_test_harness && !f.queue_2stage) |
059ec3d9 | 715 | { |
44416341 JH |
716 | uschar * fqtnext = Ustrchr(fudged_queue_times, '/'); |
717 | if (fqtnext) fudged_queue_times = fqtnext + 1; | |
059ec3d9 | 718 | } |
92562f63 JH |
719 | |
720 | ||
721 | continue; | |
722 | ||
723 | go_around: | |
724 | /* If initial of a 2-phase run, we are a child - so just exit */ | |
725 | if (f.queue_2stage && !queue_run_in_order) | |
81022793 | 726 | exim_exit(EXIT_SUCCESS); |
059ec3d9 PH |
727 | } /* End loop for list of messages */ |
728 | ||
ce93c6d8 | 729 | tree_nonrecipients = NULL; |
059ec3d9 PH |
730 | store_reset(reset_point1); /* Scavenge list of messages */ |
731 | ||
732 | /* If this was the first time through for random order processing, and | |
733 | sub-directories have been found, randomize their order if necessary. */ | |
734 | ||
735 | if (i == 0 && subcount > 1 && !queue_run_in_order) | |
d7978c0f JH |
736 | for (int j = 1; j <= subcount; j++) |
737 | { | |
738 | int r; | |
f267271d | 739 | if ((r = random_number(100)) >= 50) |
059ec3d9 PH |
740 | { |
741 | int k = (r % subcount) + 1; | |
742 | int x = subdirs[j]; | |
743 | subdirs[j] = subdirs[k]; | |
744 | subdirs[k] = x; | |
745 | } | |
d7978c0f | 746 | } |
059ec3d9 PH |
747 | } /* End loop for multiple directories */ |
748 | ||
749 | /* If queue_2stage is true, we do it all again, with the 2stage flag | |
750 | turned off. */ | |
751 | ||
8768d548 | 752 | if (f.queue_2stage) |
059ec3d9 | 753 | { |
92562f63 JH |
754 | |
755 | /* wait for last children */ | |
756 | for (int i = 0; i < nelem(qpid); i++) | |
757 | if (qpid[i]) | |
758 | { | |
759 | DEBUG(D_queue_run) debug_printf("q2stage reaped child %d\n", (int)qpid[i]); | |
760 | waitpid(qpid[i], NULL, 0); | |
761 | } | |
762 | else break; | |
763 | ||
764 | #ifdef MEASURE_TIMING | |
765 | report_time_since(×tamp_startup, US"queue_run 1st phase done"); | |
766 | #endif | |
8768d548 | 767 | f.queue_2stage = FALSE; |
059ec3d9 PH |
768 | queue_run(start_id, stop_id, TRUE); |
769 | } | |
770 | ||
771 | /* At top level, log the end of the run. */ | |
772 | ||
6073ad45 JH |
773 | if (!recurse) |
774 | if (*queue_name) | |
775 | log_write(L_queue_run, LOG_MAIN, "End '%s' queue run: %s", | |
776 | queue_name, log_detail); | |
777 | else | |
778 | log_write(L_queue_run, LOG_MAIN, "End queue run: %s", log_detail); | |
059ec3d9 PH |
779 | } |
780 | ||
781 | ||
782 | ||
783 | ||
784 | /************************************************ | |
785 | * Count messages on the queue * | |
786 | ************************************************/ | |
787 | ||
788 | /* Called as a result of -bpc | |
789 | ||
790 | Arguments: none | |
04403ab0 | 791 | Returns: count |
059ec3d9 PH |
792 | */ |
793 | ||
04403ab0 | 794 | unsigned |
059ec3d9 PH |
795 | queue_count(void) |
796 | { | |
797 | int subcount; | |
04403ab0 | 798 | unsigned count = 0; |
059ec3d9 | 799 | uschar subdirs[64]; |
d7978c0f | 800 | |
45907b9d JH |
801 | (void) queue_get_spool_list(-1, /* entire queue */ |
802 | subdirs, /* for holding sub list */ | |
803 | &subcount, /* for subcount */ | |
804 | FALSE, /* not random */ | |
805 | &count); /* just get the count */ | |
04403ab0 | 806 | return count; |
059ec3d9 PH |
807 | } |
808 | ||
809 | ||
04403ab0 JH |
810 | #define QUEUE_SIZE_AGE 60 /* update rate for queue_size */ |
811 | ||
812 | unsigned | |
813 | queue_count_cached(void) | |
814 | { | |
815 | time_t now; | |
816 | if ((now = time(NULL)) >= queue_size_next) | |
817 | { | |
818 | queue_size = queue_count(); | |
819 | queue_size_next = now + (f.running_in_test_harness ? 3 : QUEUE_SIZE_AGE); | |
820 | } | |
821 | return queue_size; | |
822 | } | |
059ec3d9 PH |
823 | |
824 | /************************************************ | |
825 | * List extra deliveries * | |
826 | ************************************************/ | |
827 | ||
828 | /* This is called from queue_list below to print out all addresses that | |
829 | have received a message but which were not primary addresses. That is, all | |
830 | the addresses in the tree of non-recipients that are not primary addresses. | |
831 | The tree has been scanned and the data field filled in for those that are | |
832 | primary addresses. | |
833 | ||
834 | Argument: points to the tree node | |
835 | Returns: nothing | |
836 | */ | |
837 | ||
e5903596 JH |
838 | static void |
839 | queue_list_extras(tree_node *p) | |
059ec3d9 | 840 | { |
e5903596 | 841 | if (p->left) queue_list_extras(p->left); |
059ec3d9 | 842 | if (!p->data.val) printf(" +D %s\n", p->name); |
e5903596 | 843 | if (p->right) queue_list_extras(p->right); |
059ec3d9 PH |
844 | } |
845 | ||
846 | ||
847 | ||
848 | /************************************************ | |
849 | * List messages on the queue * | |
850 | ************************************************/ | |
851 | ||
852 | /* Or a given list of messages. In the "all" case, we get a list of file names | |
853 | as quickly as possible, then scan each one for information to output. If any | |
854 | disappear while we are processing, just leave them out, but give an error if an | |
855 | explicit list was given. This function is a top-level function that is obeyed | |
856 | as a result of the -bp argument. As there may be a lot of messages on the | |
857 | queue, we must tidy up the store after reading the headers for each one. | |
858 | ||
859 | Arguments: | |
860 | option 0 => list top-level recipients, with "D" for those delivered | |
861 | 1 => list only undelivered top-level recipients | |
862 | 2 => as 0, plus any generated delivered recipients | |
863 | If 8 is added to any of these values, the queue is listed in | |
864 | random order. | |
865 | list => first of any message ids to list | |
866 | count count of message ids; 0 => all | |
867 | ||
868 | Returns: nothing | |
869 | */ | |
870 | ||
871 | void | |
872 | queue_list(int option, uschar **list, int count) | |
873 | { | |
059ec3d9 PH |
874 | int subcount; |
875 | int now = (int)time(NULL); | |
f3ebb786 | 876 | rmark reset_point; |
8768d548 | 877 | queue_filename * qf = NULL; |
059ec3d9 PH |
878 | uschar subdirs[64]; |
879 | ||
880 | /* If given a list of messages, build a chain containing their ids. */ | |
881 | ||
882 | if (count > 0) | |
883 | { | |
884 | queue_filename *last = NULL; | |
d7978c0f | 885 | for (int i = 0; i < count; i++) |
059ec3d9 PH |
886 | { |
887 | queue_filename *next = | |
f3ebb786 | 888 | store_get(sizeof(queue_filename) + Ustrlen(list[i]) + 2, is_tainted(list[i])); |
059ec3d9 PH |
889 | sprintf(CS next->text, "%s-H", list[i]); |
890 | next->dir_uschar = '*'; | |
891 | next->next = NULL; | |
8768d548 | 892 | if (i == 0) qf = next; else last->next = next; |
059ec3d9 PH |
893 | last = next; |
894 | } | |
895 | } | |
896 | ||
897 | /* Otherwise get a list of the entire queue, in order if necessary. */ | |
898 | ||
899 | else | |
8768d548 | 900 | qf = queue_get_spool_list( |
059ec3d9 PH |
901 | -1, /* entire queue */ |
902 | subdirs, /* for holding sub list */ | |
903 | &subcount, /* for subcount */ | |
45907b9d JH |
904 | option >= 8, /* randomize if required */ |
905 | NULL); /* don't just count */ | |
059ec3d9 PH |
906 | |
907 | if (option >= 8) option -= 8; | |
908 | ||
909 | /* Now scan the chain and print information, resetting store used | |
910 | each time. */ | |
911 | ||
f3ebb786 JH |
912 | for (; |
913 | qf && (reset_point = store_mark()); | |
8768d548 | 914 | spool_clear_header_globals(), store_reset(reset_point), qf = qf->next |
c232fc99 | 915 | ) |
059ec3d9 PH |
916 | { |
917 | int rc, save_errno; | |
918 | int size = 0; | |
919 | BOOL env_read; | |
920 | ||
059ec3d9 | 921 | message_size = 0; |
8768d548 JH |
922 | message_subdir[0] = qf->dir_uschar; |
923 | rc = spool_read_header(qf->text, FALSE, count <= 0); | |
c232fc99 JH |
924 | if (rc == spool_read_notopen && errno == ENOENT && count <= 0) |
925 | continue; | |
059ec3d9 PH |
926 | save_errno = errno; |
927 | ||
928 | env_read = (rc == spool_read_OK || rc == spool_read_hdrerror); | |
929 | ||
930 | if (env_read) | |
931 | { | |
d7978c0f | 932 | int i, ptr; |
059ec3d9 PH |
933 | FILE *jread; |
934 | struct stat statbuf; | |
8768d548 | 935 | uschar * fname = spool_fname(US"input", message_subdir, qf->text, US""); |
059ec3d9 | 936 | |
41313d92 JH |
937 | ptr = Ustrlen(fname)-1; |
938 | fname[ptr] = 'D'; | |
059ec3d9 PH |
939 | |
940 | /* Add the data size to the header size; don't count the file name | |
941 | at the start of the data file, but add one for the notional blank line | |
942 | that precedes the data. */ | |
943 | ||
41313d92 | 944 | if (Ustat(fname, &statbuf) == 0) |
059ec3d9 | 945 | size = message_size + statbuf.st_size - SPOOL_DATA_START_OFFSET + 1; |
32dfdf8b | 946 | i = (now - received_time.tv_sec)/60; /* minutes on queue */ |
059ec3d9 PH |
947 | if (i > 90) |
948 | { | |
949 | i = (i + 30)/60; | |
950 | if (i > 72) printf("%2dd ", (i + 12)/24); else printf("%2dh ", i); | |
951 | } | |
952 | else printf("%2dm ", i); | |
953 | ||
954 | /* Collect delivered addresses from any J file */ | |
955 | ||
41313d92 | 956 | fname[ptr] = 'J'; |
90341c71 | 957 | if ((jread = Ufopen(fname, "rb"))) |
059ec3d9 PH |
958 | { |
959 | while (Ufgets(big_buffer, big_buffer_size, jread) != NULL) | |
960 | { | |
961 | int n = Ustrlen(big_buffer); | |
962 | big_buffer[n-1] = 0; | |
963 | tree_add_nonrecipient(big_buffer); | |
964 | } | |
f1e894f3 | 965 | (void)fclose(jread); |
059ec3d9 PH |
966 | } |
967 | } | |
968 | ||
969 | fprintf(stdout, "%s ", string_format_size(size, big_buffer)); | |
d7978c0f | 970 | for (int i = 0; i < 16; i++) fputc(qf->text[i], stdout); |
059ec3d9 | 971 | |
90341c71 | 972 | if (env_read && sender_address) |
059ec3d9 PH |
973 | { |
974 | printf(" <%s>", sender_address); | |
8768d548 | 975 | if (f.sender_set_untrusted) printf(" (%s)", originator_login); |
059ec3d9 PH |
976 | } |
977 | ||
978 | if (rc != spool_read_OK) | |
979 | { | |
980 | printf("\n "); | |
981 | if (save_errno == ERRNO_SPOOLFORMAT) | |
982 | { | |
983 | struct stat statbuf; | |
8768d548 | 984 | uschar * fname = spool_fname(US"input", message_subdir, qf->text, US""); |
41313d92 JH |
985 | |
986 | if (Ustat(fname, &statbuf) == 0) | |
b1c749bb PH |
987 | printf("*** spool format error: size=" OFF_T_FMT " ***", |
988 | statbuf.st_size); | |
059ec3d9 PH |
989 | else printf("*** spool format error ***"); |
990 | } | |
991 | else printf("*** spool read error: %s ***", strerror(save_errno)); | |
992 | if (rc != spool_read_hdrerror) | |
993 | { | |
994 | printf("\n\n"); | |
c232fc99 | 995 | continue; |
059ec3d9 PH |
996 | } |
997 | } | |
998 | ||
8768d548 | 999 | if (f.deliver_freeze) printf(" *** frozen ***"); |
059ec3d9 PH |
1000 | |
1001 | printf("\n"); | |
1002 | ||
90341c71 | 1003 | if (recipients_list) |
059ec3d9 | 1004 | { |
d7978c0f | 1005 | for (int i = 0; i < recipients_count; i++) |
059ec3d9 PH |
1006 | { |
1007 | tree_node *delivered = | |
1008 | tree_search(tree_nonrecipients, recipients_list[i].address); | |
1009 | if (!delivered || option != 1) | |
c232fc99 JH |
1010 | printf(" %s %s\n", |
1011 | delivered ? "D" : " ", recipients_list[i].address); | |
90341c71 | 1012 | if (delivered) delivered->data.val = TRUE; |
059ec3d9 | 1013 | } |
90341c71 | 1014 | if (option == 2 && tree_nonrecipients) |
059ec3d9 PH |
1015 | queue_list_extras(tree_nonrecipients); |
1016 | printf("\n"); | |
1017 | } | |
1018 | } | |
1019 | } | |
1020 | ||
1021 | ||
1022 | ||
1023 | /************************************************* | |
1024 | * Act on a specific message * | |
1025 | *************************************************/ | |
1026 | ||
a96603a0 PH |
1027 | /* Actions that require a list of addresses make use of argv/argc/ |
1028 | recipients_arg. Other actions do not. This function does its own | |
1029 | authority checking. | |
059ec3d9 PH |
1030 | |
1031 | Arguments: | |
1032 | id id of the message to work on | |
1033 | action which action is required (MSG_xxx) | |
1034 | argv the original argv for Exim | |
1035 | argc the original argc for Exim | |
1036 | recipients_arg offset to the list of recipients in argv | |
1037 | ||
1038 | Returns: FALSE if there was any problem | |
1039 | */ | |
1040 | ||
1041 | BOOL | |
1042 | queue_action(uschar *id, int action, uschar **argv, int argc, int recipients_arg) | |
1043 | { | |
059ec3d9 PH |
1044 | BOOL yield = TRUE; |
1045 | BOOL removed = FALSE; | |
1046 | struct passwd *pw; | |
1047 | uschar *doing = NULL; | |
1048 | uschar *username; | |
1049 | uschar *errmsg; | |
41313d92 | 1050 | uschar spoolname[32]; |
059ec3d9 PH |
1051 | |
1052 | /* Set the global message_id variable, used when re-writing spool files. This | |
1053 | also causes message ids to be added to log messages. */ | |
1054 | ||
1055 | Ustrcpy(message_id, id); | |
1056 | ||
1057 | /* The "actions" that just list the files do not require any locking to be | |
1058 | done. Only admin users may read the spool files. */ | |
1059 | ||
1060 | if (action >= MSG_SHOW_BODY) | |
1061 | { | |
d7978c0f | 1062 | int fd, rc; |
059ec3d9 PH |
1063 | uschar *subdirectory, *suffix; |
1064 | ||
8768d548 | 1065 | if (!f.admin_user) |
059ec3d9 PH |
1066 | { |
1067 | printf("Permission denied\n"); | |
1068 | return FALSE; | |
1069 | } | |
1070 | ||
1071 | if (recipients_arg < argc) | |
1072 | { | |
1073 | printf("*** Only one message can be listed at once\n"); | |
1074 | return FALSE; | |
1075 | } | |
1076 | ||
1077 | if (action == MSG_SHOW_BODY) | |
1078 | { | |
1079 | subdirectory = US"input"; | |
1080 | suffix = US"-D"; | |
1081 | } | |
1082 | else if (action == MSG_SHOW_HEADER) | |
1083 | { | |
1084 | subdirectory = US"input"; | |
1085 | suffix = US"-H"; | |
1086 | } | |
1087 | else | |
1088 | { | |
1089 | subdirectory = US"msglog"; | |
1090 | suffix = US""; | |
1091 | } | |
1092 | ||
d7978c0f | 1093 | for (int i = 0; i < 2; i++) |
059ec3d9 | 1094 | { |
59a93276 | 1095 | set_subdir_str(message_subdir, id, i); |
41313d92 JH |
1096 | if ((fd = Uopen(spool_fname(subdirectory, message_subdir, id, suffix), |
1097 | O_RDONLY, 0)) >= 0) | |
a2da3176 JH |
1098 | break; |
1099 | if (i == 0) | |
1100 | continue; | |
1101 | ||
059ec3d9 PH |
1102 | printf("Failed to open %s file for %s%s: %s\n", subdirectory, id, suffix, |
1103 | strerror(errno)); | |
1104 | if (action == MSG_SHOW_LOG && !message_logs) | |
1105 | printf("(No message logs are being created because the message_logs " | |
1106 | "option is false.)\n"); | |
1107 | return FALSE; | |
1108 | } | |
1109 | ||
1110 | while((rc = read(fd, big_buffer, big_buffer_size)) > 0) | |
1ac6b2e7 | 1111 | rc = write(fileno(stdout), big_buffer, rc); |
059ec3d9 | 1112 | |
f1e894f3 | 1113 | (void)close(fd); |
059ec3d9 PH |
1114 | return TRUE; |
1115 | } | |
1116 | ||
1117 | /* For actions that actually act, open and lock the data file to ensure that no | |
1118 | other process is working on this message. If the file does not exist, continue | |
1119 | only if the action is remove and the user is an admin user, to allow for | |
1120 | tidying up broken states. */ | |
1121 | ||
789f8a4f | 1122 | if ((deliver_datafile = spool_open_datafile(id)) < 0) |
059ec3d9 PH |
1123 | if (errno == ENOENT) |
1124 | { | |
1125 | yield = FALSE; | |
1126 | printf("Spool data file for %s does not exist\n", id); | |
8768d548 | 1127 | if (action != MSG_REMOVE || !f.admin_user) return FALSE; |
059ec3d9 PH |
1128 | printf("Continuing, to ensure all files removed\n"); |
1129 | } | |
1130 | else | |
1131 | { | |
1132 | if (errno == 0) printf("Message %s is locked\n", id); | |
1133 | else printf("Couldn't open spool file for %s: %s\n", id, | |
1134 | strerror(errno)); | |
1135 | return FALSE; | |
1136 | } | |
059ec3d9 PH |
1137 | |
1138 | /* Read the spool header file for the message. Again, continue after an | |
1139 | error only in the case of deleting by an administrator. Setting the third | |
1140 | argument false causes it to look both in the main spool directory and in | |
1141 | the appropriate subdirectory, and set message_subdir according to where it | |
1142 | found the message. */ | |
1143 | ||
1144 | sprintf(CS spoolname, "%s-H", id); | |
1145 | if (spool_read_header(spoolname, TRUE, FALSE) != spool_read_OK) | |
1146 | { | |
1147 | yield = FALSE; | |
1148 | if (errno != ERRNO_SPOOLFORMAT) | |
1149 | printf("Spool read error for %s: %s\n", spoolname, strerror(errno)); | |
1150 | else | |
1151 | printf("Spool format error for %s\n", spoolname); | |
8768d548 | 1152 | if (action != MSG_REMOVE || !f.admin_user) |
059ec3d9 | 1153 | { |
f1e894f3 | 1154 | (void)close(deliver_datafile); |
059ec3d9 PH |
1155 | deliver_datafile = -1; |
1156 | return FALSE; | |
1157 | } | |
1158 | printf("Continuing to ensure all files removed\n"); | |
1159 | } | |
1160 | ||
1161 | /* Check that the user running this process is entitled to operate on this | |
1162 | message. Only admin users may freeze/thaw, add/cancel recipients, or otherwise | |
1163 | mess about, but the original sender is permitted to remove a message. That's | |
1164 | why we leave this check until after the headers are read. */ | |
1165 | ||
8768d548 | 1166 | if (!f.admin_user && (action != MSG_REMOVE || real_uid != originator_uid)) |
059ec3d9 PH |
1167 | { |
1168 | printf("Permission denied\n"); | |
f1e894f3 | 1169 | (void)close(deliver_datafile); |
059ec3d9 PH |
1170 | deliver_datafile = -1; |
1171 | return FALSE; | |
1172 | } | |
1173 | ||
1174 | /* Set up the user name for logging. */ | |
1175 | ||
1176 | pw = getpwuid(real_uid); | |
1177 | username = (pw != NULL)? | |
1178 | US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid); | |
1179 | ||
1180 | /* Take the necessary action. */ | |
1181 | ||
a96603a0 | 1182 | if (action != MSG_SHOW_COPY) printf("Message %s ", id); |
059ec3d9 PH |
1183 | |
1184 | switch(action) | |
1185 | { | |
a96603a0 | 1186 | case MSG_SHOW_COPY: |
42055a33 | 1187 | { |
cab0c277 | 1188 | transport_ctx tctx = {{0}}; |
42055a33 JH |
1189 | deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE); |
1190 | deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE); | |
1191 | tctx.u.fd = 1; | |
ee8b8090 | 1192 | (void) transport_write_message(&tctx, 0); |
42055a33 JH |
1193 | break; |
1194 | } | |
a96603a0 PH |
1195 | |
1196 | ||
059ec3d9 | 1197 | case MSG_FREEZE: |
8768d548 | 1198 | if (f.deliver_freeze) |
059ec3d9 PH |
1199 | { |
1200 | yield = FALSE; | |
1201 | printf("is already frozen\n"); | |
1202 | } | |
1203 | else | |
1204 | { | |
8768d548 JH |
1205 | f.deliver_freeze = TRUE; |
1206 | f.deliver_manual_thaw = FALSE; | |
059ec3d9 PH |
1207 | deliver_frozen_at = time(NULL); |
1208 | if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0) | |
1209 | { | |
1210 | printf("is now frozen\n"); | |
1211 | log_write(0, LOG_MAIN, "frozen by %s", username); | |
1212 | } | |
1213 | else | |
1214 | { | |
1215 | yield = FALSE; | |
1216 | printf("could not be frozen: %s\n", errmsg); | |
1217 | } | |
1218 | } | |
1219 | break; | |
1220 | ||
1221 | ||
1222 | case MSG_THAW: | |
8768d548 | 1223 | if (!f.deliver_freeze) |
059ec3d9 PH |
1224 | { |
1225 | yield = FALSE; | |
1226 | printf("is not frozen\n"); | |
1227 | } | |
1228 | else | |
1229 | { | |
8768d548 JH |
1230 | f.deliver_freeze = FALSE; |
1231 | f.deliver_manual_thaw = TRUE; | |
059ec3d9 PH |
1232 | if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0) |
1233 | { | |
1234 | printf("is no longer frozen\n"); | |
1235 | log_write(0, LOG_MAIN, "unfrozen by %s", username); | |
1236 | } | |
1237 | else | |
1238 | { | |
1239 | yield = FALSE; | |
1240 | printf("could not be unfrozen: %s\n", errmsg); | |
1241 | } | |
1242 | } | |
1243 | break; | |
1244 | ||
1245 | ||
1246 | /* We must ensure all files are removed from both the input directory | |
1247 | and the appropriate subdirectory, to clean up cases when there are odd | |
1248 | files left lying around in odd places. In the normal case message_subdir | |
1249 | will have been set correctly by spool_read_header, but as this is a rare | |
1250 | operation, just run everything twice. */ | |
1251 | ||
1252 | case MSG_REMOVE: | |
059ec3d9 | 1253 | { |
41313d92 | 1254 | uschar suffix[3]; |
059ec3d9 | 1255 | |
41313d92 JH |
1256 | suffix[0] = '-'; |
1257 | suffix[2] = 0; | |
1258 | message_subdir[0] = id[5]; | |
1259 | ||
d7978c0f | 1260 | for (int j = 0; j < 2; message_subdir[0] = 0, j++) |
059ec3d9 | 1261 | { |
41313d92 JH |
1262 | uschar * fname = spool_fname(US"msglog", message_subdir, id, US""); |
1263 | ||
1264 | DEBUG(D_any) debug_printf(" removing %s", fname); | |
1265 | if (Uunlink(fname) < 0) | |
1266 | { | |
1267 | if (errno != ENOENT) | |
1268 | { | |
1269 | yield = FALSE; | |
1270 | printf("Error while removing %s: %s\n", fname, strerror(errno)); | |
1271 | } | |
1272 | else DEBUG(D_any) debug_printf(" (no file)\n"); | |
1273 | } | |
1274 | else | |
1275 | { | |
1276 | removed = TRUE; | |
1277 | DEBUG(D_any) debug_printf(" (ok)\n"); | |
1278 | } | |
1279 | ||
d7978c0f | 1280 | for (int i = 0; i < 3; i++) |
41313d92 JH |
1281 | { |
1282 | uschar * fname; | |
1283 | ||
1284 | suffix[1] = (US"DHJ")[i]; | |
1285 | fname = spool_fname(US"input", message_subdir, id, suffix); | |
1286 | ||
1287 | DEBUG(D_any) debug_printf(" removing %s", fname); | |
1288 | if (Uunlink(fname) < 0) | |
1289 | { | |
1290 | if (errno != ENOENT) | |
1291 | { | |
1292 | yield = FALSE; | |
1293 | printf("Error while removing %s: %s\n", fname, strerror(errno)); | |
1294 | } | |
1295 | else DEBUG(D_any) debug_printf(" (no file)\n"); | |
1296 | } | |
1297 | else | |
1298 | { | |
1299 | removed = TRUE; | |
1300 | DEBUG(D_any) debug_printf(" (done)\n"); | |
1301 | } | |
1302 | } | |
059ec3d9 | 1303 | } |
059ec3d9 | 1304 | |
41313d92 JH |
1305 | /* In the common case, the datafile is open (and locked), so give the |
1306 | obvious message. Otherwise be more specific. */ | |
059ec3d9 | 1307 | |
41313d92 JH |
1308 | if (deliver_datafile >= 0) printf("has been removed\n"); |
1309 | else printf("has been removed or did not exist\n"); | |
1310 | if (removed) | |
1311 | { | |
7ea1237c | 1312 | #ifndef DISABLE_EVENT |
7a9e0ae1 | 1313 | if (event_action) for (int i = 0; i < recipients_count; i++) |
7ea1237c MK |
1314 | { |
1315 | tree_node *delivered = | |
1316 | tree_search(tree_nonrecipients, recipients_list[i].address); | |
1317 | if (!delivered) | |
1318 | { | |
1319 | uschar * save_local = deliver_localpart; | |
1320 | const uschar * save_domain = deliver_domain; | |
1321 | uschar * addr = recipients_list[i].address, * errmsg = NULL; | |
1322 | int start, end, dom; | |
1323 | ||
1324 | if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE)) | |
1325 | log_write(0, LOG_MAIN|LOG_PANIC, | |
1326 | "failed to parse address '%.100s'\n: %s", addr, errmsg); | |
1327 | else | |
1328 | { | |
1329 | deliver_localpart = | |
1330 | string_copyn(addr+start, dom ? (dom-1) - start : end - start); | |
1331 | deliver_domain = dom | |
1332 | ? CUS string_copyn(addr+dom, end - dom) : CUS""; | |
1333 | ||
1334 | event_raise(event_action, US"msg:fail:internal", | |
1335 | string_sprintf("message removed by %s", username)); | |
1336 | ||
1337 | deliver_localpart = save_local; | |
1338 | deliver_domain = save_domain; | |
1339 | } | |
1340 | } | |
1341 | } | |
1342 | (void) event_raise(event_action, US"msg:complete", NULL); | |
1343 | #endif | |
41313d92 JH |
1344 | log_write(0, LOG_MAIN, "removed by %s", username); |
1345 | log_write(0, LOG_MAIN, "Completed"); | |
1346 | } | |
1347 | break; | |
8e669ac1 | 1348 | } |
059ec3d9 PH |
1349 | |
1350 | ||
fc7bae7f JH |
1351 | case MSG_SETQUEUE: |
1352 | /* The global "queue_name_dest" is used as destination, "queue_name" | |
1353 | as source */ | |
1354 | ||
1355 | spool_move_message(id, message_subdir, US"", US""); | |
1356 | break; | |
1357 | ||
1358 | ||
059ec3d9 | 1359 | case MSG_MARK_ALL_DELIVERED: |
d7978c0f | 1360 | for (int i = 0; i < recipients_count; i++) |
059ec3d9 | 1361 | tree_add_nonrecipient(recipients_list[i].address); |
7ea1237c | 1362 | |
059ec3d9 PH |
1363 | if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0) |
1364 | { | |
1365 | printf("has been modified\n"); | |
d7978c0f | 1366 | for (int i = 0; i < recipients_count; i++) |
059ec3d9 PH |
1367 | log_write(0, LOG_MAIN, "address <%s> marked delivered by %s", |
1368 | recipients_list[i].address, username); | |
1369 | } | |
1370 | else | |
1371 | { | |
1372 | yield = FALSE; | |
1373 | printf("- could not mark all delivered: %s\n", errmsg); | |
1374 | } | |
1375 | break; | |
1376 | ||
1377 | ||
1378 | case MSG_EDIT_SENDER: | |
1379 | if (recipients_arg < argc - 1) | |
1380 | { | |
1381 | yield = FALSE; | |
1382 | printf("- only one sender address can be specified\n"); | |
1383 | break; | |
1384 | } | |
1385 | doing = US"editing sender"; | |
1386 | /* Fall through */ | |
1387 | ||
1388 | case MSG_ADD_RECIPIENT: | |
1389 | if (doing == NULL) doing = US"adding recipient"; | |
1390 | /* Fall through */ | |
1391 | ||
1392 | case MSG_MARK_DELIVERED: | |
1393 | if (doing == NULL) doing = US"marking as delivered"; | |
1394 | ||
1395 | /* Common code for EDIT_SENDER, ADD_RECIPIENT, & MARK_DELIVERED */ | |
1396 | ||
1397 | if (recipients_arg >= argc) | |
1398 | { | |
1399 | yield = FALSE; | |
1400 | printf("- error while %s: no address given\n", doing); | |
1401 | break; | |
1402 | } | |
1403 | ||
1404 | for (; recipients_arg < argc; recipients_arg++) | |
1405 | { | |
1406 | int start, end, domain; | |
1407 | uschar *errmess; | |
1408 | uschar *recipient = | |
1409 | parse_extract_address(argv[recipients_arg], &errmess, &start, &end, | |
1410 | &domain, (action == MSG_EDIT_SENDER)); | |
1411 | ||
5fcc791a | 1412 | if (!recipient) |
059ec3d9 PH |
1413 | { |
1414 | yield = FALSE; | |
1415 | printf("- error while %s:\n bad address %s: %s\n", | |
1416 | doing, argv[recipients_arg], errmess); | |
1417 | } | |
5fcc791a | 1418 | else if (*recipient && domain == 0) |
059ec3d9 PH |
1419 | { |
1420 | yield = FALSE; | |
1421 | printf("- error while %s:\n bad address %s: " | |
1422 | "domain missing\n", doing, argv[recipients_arg]); | |
1423 | } | |
1424 | else | |
1425 | { | |
1426 | if (action == MSG_ADD_RECIPIENT) | |
1427 | { | |
8c5d388a | 1428 | #ifdef SUPPORT_I18N |
d752cc0e JH |
1429 | if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE; |
1430 | #endif | |
059ec3d9 PH |
1431 | receive_add_recipient(recipient, -1); |
1432 | log_write(0, LOG_MAIN, "recipient <%s> added by %s", | |
1433 | recipient, username); | |
1434 | } | |
1435 | else if (action == MSG_MARK_DELIVERED) | |
1436 | { | |
d7978c0f | 1437 | int i; |
059ec3d9 PH |
1438 | for (i = 0; i < recipients_count; i++) |
1439 | if (Ustrcmp(recipients_list[i].address, recipient) == 0) break; | |
1440 | if (i >= recipients_count) | |
1441 | { | |
1442 | printf("- error while %s:\n %s is not a recipient:" | |
1443 | " message not updated\n", doing, recipient); | |
1444 | yield = FALSE; | |
1445 | } | |
1446 | else | |
1447 | { | |
1448 | tree_add_nonrecipient(recipients_list[i].address); | |
1449 | log_write(0, LOG_MAIN, "address <%s> marked delivered by %s", | |
1450 | recipient, username); | |
1451 | } | |
1452 | } | |
1453 | else /* MSG_EDIT_SENDER */ | |
1454 | { | |
8c5d388a | 1455 | #ifdef SUPPORT_I18N |
d752cc0e JH |
1456 | if (string_is_utf8(recipient)) allow_utf8_domains = message_smtputf8 = TRUE; |
1457 | #endif | |
059ec3d9 PH |
1458 | sender_address = recipient; |
1459 | log_write(0, LOG_MAIN, "sender address changed to <%s> by %s", | |
1460 | recipient, username); | |
1461 | } | |
1462 | } | |
1463 | } | |
1464 | ||
1465 | if (yield) | |
059ec3d9 PH |
1466 | if (spool_write_header(id, SW_MODIFYING, &errmsg) >= 0) |
1467 | printf("has been modified\n"); | |
1468 | else | |
1469 | { | |
1470 | yield = FALSE; | |
1471 | printf("- while %s: %s\n", doing, errmsg); | |
1472 | } | |
059ec3d9 PH |
1473 | |
1474 | break; | |
1475 | } | |
1476 | ||
1477 | /* Closing the datafile releases the lock and permits other processes | |
1478 | to operate on the message (if it still exists). */ | |
1479 | ||
12cf7615 JH |
1480 | if (deliver_datafile >= 0) |
1481 | { | |
1482 | (void)close(deliver_datafile); | |
1483 | deliver_datafile = -1; | |
1484 | } | |
059ec3d9 PH |
1485 | return yield; |
1486 | } | |
1487 | ||
1488 | ||
1489 | ||
1490 | /************************************************* | |
1491 | * Check the queue_only_file condition * | |
1492 | *************************************************/ | |
1493 | ||
1494 | /* The queue_only_file option forces certain kinds of queueing if a given file | |
1495 | exists. | |
1496 | ||
1497 | Arguments: none | |
1498 | Returns: nothing | |
1499 | */ | |
1500 | ||
1501 | void | |
1502 | queue_check_only(void) | |
1503 | { | |
059ec3d9 PH |
1504 | int sep = 0; |
1505 | struct stat statbuf; | |
e851856f JH |
1506 | const uschar * s = queue_only_file; |
1507 | uschar * ss; | |
059ec3d9 | 1508 | |
e851856f JH |
1509 | if (s) |
1510 | while ((ss = string_nextinlist(&s, &sep, NULL, 0))) | |
1511 | if (Ustrncmp(ss, "smtp", 4) == 0) | |
8768d548 | 1512 | { |
e851856f JH |
1513 | ss += 4; |
1514 | if (Ustat(ss, &statbuf) == 0) | |
1515 | { | |
1516 | f.queue_smtp = TRUE; | |
1517 | DEBUG(D_receive) debug_printf("queue_smtp set because %s exists\n", ss); | |
1518 | } | |
8768d548 | 1519 | } |
e851856f JH |
1520 | else |
1521 | if (Ustat(ss, &statbuf) == 0) | |
1522 | { | |
1523 | queue_only = TRUE; | |
1524 | DEBUG(D_receive) debug_printf("queue_only set because %s exists\n", ss); | |
1525 | } | |
059ec3d9 PH |
1526 | } |
1527 | ||
ff966302 JH |
1528 | |
1529 | ||
1530 | /******************************************************************************/ | |
1531 | /******************************************************************************/ | |
1532 | ||
1533 | #ifdef EXPERIMENTAL_QUEUE_RAMP | |
1534 | void | |
1535 | queue_notify_daemon(const uschar * msgid) | |
1536 | { | |
1537 | uschar buf[MESSAGE_ID_LENGTH + 2]; | |
1538 | int fd; | |
1539 | ||
1540 | DEBUG(D_queue_run) debug_printf("%s: %s\n", __FUNCTION__, msgid); | |
1541 | ||
1542 | buf[0] = NOTIFY_MSG_QRUN; | |
1543 | memcpy(buf+1, msgid, MESSAGE_ID_LENGTH+1); | |
1544 | ||
1545 | if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) >= 0) | |
1546 | { | |
3978c243 | 1547 | struct sockaddr_un sa_un = {.sun_family = AF_UNIX}; |
2f2dd3a5 JH |
1548 | |
1549 | #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS | |
04403ab0 | 1550 | int len = offsetof(struct sockaddr_un, sun_path) + 1 |
3978c243 | 1551 | + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s", |
691ca88c | 1552 | expand_string(notifier_socket)); |
3978c243 | 1553 | sa_un.sun_path[0] = 0; |
2f2dd3a5 JH |
1554 | #else |
1555 | int len = offsetof(struct sockaddr_un, sun_path) | |
691ca88c JH |
1556 | + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s", |
1557 | expand_string(notifier_socket)); | |
2f2dd3a5 | 1558 | #endif |
ff966302 | 1559 | |
3978c243 | 1560 | if (sendto(fd, buf, sizeof(buf), 0, (struct sockaddr *)&sa_un, len) < 0) |
ff966302 JH |
1561 | DEBUG(D_queue_run) |
1562 | debug_printf("%s: sendto %s\n", __FUNCTION__, strerror(errno)); | |
1563 | close(fd); | |
1564 | } | |
1565 | else DEBUG(D_queue_run) debug_printf(" socket: %s\n", strerror(errno)); | |
1566 | } | |
1567 | #endif | |
1568 | ||
41313d92 JH |
1569 | #endif /*!COMPILE_UTILITY*/ |
1570 | ||
059ec3d9 | 1571 | /* End of queue.c */ |