tidying
[exim.git] / src / src / filter.c
CommitLineData
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
9/* Code for mail filtering functions. */
10
11#include "exim.h"
12
13
14/* Command arguments and left/right points in conditions can contain different
15types of data, depending on the particular command or condition. Originally,
16(void *) was used as "any old type", with casts, but this gives trouble and
17warnings in some environments. So now it is done "properly", with a union. We
18need to declare the structures first because some of them are recursive. */
19
20struct filter_cmd;
21struct condition_block;
22
23union argtypes {
24 struct string_item *a;
25 BOOL b;
26 struct condition_block *c;
27 struct filter_cmd *f;
28 int i;
29 uschar *u;
30};
31
32/* Local structures used in this module */
33
34typedef struct filter_cmd {
35 struct filter_cmd *next;
36 int command;
37 BOOL seen;
38 BOOL noerror;
39 union argtypes args[1];
40} filter_cmd;
41
42typedef struct condition_block {
43 struct condition_block *parent;
44 int type;
45 BOOL testfor;
46 union argtypes left;
47 union argtypes right;
48} condition_block;
49
50/* Miscellaneous other declarations */
51
52static uschar **error_pointer;
53static uschar *log_filename;
54static int filter_options;
55static int line_number;
56static int expect_endif;
57static int had_else_endif;
58static int log_fd;
59static int log_mode;
60static int output_indent;
61static BOOL filter_delivered;
62static BOOL finish_obeyed;
63static BOOL seen_force;
64static BOOL seen_value;
65static BOOL noerror_force;
66
67enum { had_neither, had_else, had_elif, had_endif };
68
69static BOOL read_command_list(uschar **, filter_cmd ***, BOOL);
70
71
72/* The string arguments for the mail command. The header line ones (that are
73permitted to include \n followed by white space) first, and then the body text
74one (it can have \n anywhere). Then the file names and once_repeat, which may
75not contain \n. */
76
1ba28e2b
PP
77static const char *mailargs[] = { /* "to" must be first, and */
78 "to", /* "cc" and "bcc" must follow */
059ec3d9
PH
79 "cc",
80 "bcc",
81 "from",
82 "reply_to",
83 "subject",
84 "extra_headers", /* miscellaneous added header lines */
85 "text",
86 "file",
87 "log",
88 "once",
89 "once_repeat"
90};
91
92/* The count of string arguments */
93
5903c6ff 94#define MAILARGS_STRING_COUNT (nelem(mailargs))
059ec3d9
PH
95
96/* The count of string arguments that are actually passed over as strings
97(once_repeat is converted to an int). */
98
99#define mailargs_string_passed (MAILARGS_STRING_COUNT - 1)
100
101/* This defines the offsets for the arguments; first the string ones, and
102then the non-string ones. The order must be as above. */
103
104enum { mailarg_index_to,
105 mailarg_index_cc,
106 mailarg_index_bcc,
107 mailarg_index_from,
108 mailarg_index_reply_to,
109 mailarg_index_subject,
110 mailarg_index_headers, /* misc headers must be last */
111 mailarg_index_text, /* text is first after headers */
112 mailarg_index_file, /* between text and expand are filenames */
113 mailarg_index_log,
114 mailarg_index_once,
115 mailarg_index_once_repeat, /* a time string */
116 mailarg_index_expand, /* first non-string argument */
117 mailarg_index_return,
118 mailargs_total /* total number of arguments */
119 };
120
121/* Offsets in the data structure for the string arguments (note that
122once_repeat isn't a string argument at this point.) */
123
124static int reply_offsets[] = { /* must be in same order as above */
125 offsetof(reply_item, to),
126 offsetof(reply_item, cc),
127 offsetof(reply_item, bcc),
128 offsetof(reply_item, from),
129 offsetof(reply_item, reply_to),
130 offsetof(reply_item, subject),
131 offsetof(reply_item, headers),
132 offsetof(reply_item, text),
133 offsetof(reply_item, file),
134 offsetof(reply_item, logfile),
135 offsetof(reply_item, oncelog),
136};
137
138/* Condition identities and names, with negated versions for some
139of them. */
140
141enum { cond_and, cond_or, cond_personal, cond_begins, cond_BEGINS,
142 cond_ends, cond_ENDS, cond_is, cond_IS, cond_matches,
143 cond_MATCHES, cond_contains, cond_CONTAINS, cond_delivered,
144 cond_above, cond_below, cond_errormsg, cond_firsttime,
145 cond_manualthaw, cond_foranyaddress };
146
1ba28e2b 147static const char *cond_names[] = {
059ec3d9
PH
148 "and", "or", "personal",
149 "begins", "BEGINS", "ends", "ENDS",
150 "is", "IS", "matches", "MATCHES", "contains",
151 "CONTAINS", "delivered", "above", "below", "error_message",
152 "first_delivery", "manually_thawed", "foranyaddress" };
153
1ba28e2b 154static const char *cond_not_names[] = {
059ec3d9
PH
155 "", "", "not personal",
156 "does not begin", "does not BEGIN",
157 "does not end", "does not END",
158 "is not", "IS not", "does not match",
159 "does not MATCH", "does not contain", "does not CONTAIN",
160 "not delivered", "not above", "not below", "not error_message",
161 "not first_delivery", "not manually_thawed", "not foranyaddress" };
162
163/* Tables of binary condition words and their corresponding types. Not easy
164to amalgamate with the above because of the different variants. */
165
1ba28e2b 166static const char *cond_words[] = {
059ec3d9
PH
167 "BEGIN",
168 "BEGINS",
169 "CONTAIN",
170 "CONTAINS",
171 "END",
172 "ENDS",
173 "IS",
174 "MATCH",
175 "MATCHES",
176 "above",
177 "begin",
178 "begins",
179 "below",
180 "contain",
181 "contains",
182 "end",
183 "ends",
184 "is",
185 "match",
186 "matches"};
187
5903c6ff 188static int cond_word_count = nelem(cond_words);
059ec3d9
PH
189
190static int cond_types[] = { cond_BEGINS, cond_BEGINS, cond_CONTAINS,
191 cond_CONTAINS, cond_ENDS, cond_ENDS, cond_IS, cond_MATCHES, cond_MATCHES,
192 cond_above, cond_begins, cond_begins, cond_below, cond_contains,
193 cond_contains, cond_ends, cond_ends, cond_is, cond_matches, cond_matches };
194
195/* Command identities: must be kept in step with the list of command words
196and the list of expanded argument counts which follow. */
197
198enum { add_command, defer_command, deliver_command, elif_command, else_command,
199 endif_command, finish_command, fail_command, freeze_command,
200 headers_command, if_command, logfile_command, logwrite_command,
201 mail_command, noerror_command, pipe_command, save_command, seen_command,
202 testprint_command, unseen_command, vacation_command };
203
1ba28e2b 204static const char *command_list[] = {
059ec3d9
PH
205 "add", "defer", "deliver", "elif", "else", "endif", "finish",
206 "fail", "freeze", "headers", "if", "logfile", "logwrite", "mail",
207 "noerror", "pipe", "save", "seen", "testprint", "unseen", "vacation"
208};
209
5903c6ff 210static int command_list_count = nelem(command_list);
059ec3d9
PH
211
212/* This table contains the number of expanded arguments in the bottom 4 bits.
213If the top bit is set, it means that the default for the command is "seen". */
214
215static uschar command_exparg_count[] = {
216 2, /* add */
217 1, /* defer */
218 128+2, /* deliver */
219 0, /* elif */
220 0, /* else */
221 0, /* endif */
222 0, /* finish */
223 1, /* fail */
224 1, /* freeze */
225 1, /* headers */
226 0, /* if */
227 1, /* logfile */
228 1, /* logwrite */
229 MAILARGS_STRING_COUNT, /* mail */
230 0, /* noerror */
231 128+0, /* pipe */
232 128+1, /* save */
233 0, /* seen */
234 1, /* testprint */
235 0, /* unseen */
236 MAILARGS_STRING_COUNT /* vacation */
237};
238
239
240
241/*************************************************
242* Find next significant uschar *
243*************************************************/
244
245/* Function to skip over white space and, optionally, comments.
246
247Arguments:
248 ptr pointer to next character
249 comment_allowed if TRUE, comments (# to \n) are skipped
250
251Returns: pointer to next non-whitespace character
252*/
253
254static uschar *
255nextsigchar(uschar *ptr, BOOL comment_allowed)
256{
257for (;;)
258 {
259 while (isspace(*ptr))
260 {
261 if (*ptr == '\n') line_number++;
262 ptr++;
263 }
264 if (comment_allowed && *ptr == '#')
265 {
266 while (*(++ptr) != '\n' && *ptr != 0);
267 continue;
268 }
269 else break;
270 }
271return ptr;
272}
273
274
275
276/*************************************************
277* Read one word *
278*************************************************/
279
280/* The terminator is white space unless bracket is TRUE, in which
281case ( and ) terminate.
282
283Arguments
284 ptr pointer to next character
285 buffer where to put the word
286 size size of buffer
287 bracket if TRUE, terminate on ( and ) as well as space
288
289Returns: pointer to the next significant character after the word
290*/
291
292static uschar *
293nextword(uschar *ptr, uschar *buffer, int size, BOOL bracket)
294{
295uschar *bp = buffer;
296while (*ptr != 0 && !isspace(*ptr) &&
297 (!bracket || (*ptr != '(' && *ptr != ')')))
298 {
299 if (bp - buffer < size - 1) *bp++ = *ptr++; else
300 {
301 *error_pointer = string_sprintf("word is too long in line %d of "
302 "filter file (max = %d chars)", line_number, size);
303 break;
304 }
305 }
306*bp = 0;
307return nextsigchar(ptr, TRUE);
308}
309
310
311
312/*************************************************
313* Read one item *
314*************************************************/
315
316/* Might be a word, or might be a quoted string; in the latter case
317do the escape stuff.
318
319Arguments:
320 ptr pointer to next character
321 buffer where to put the item
322 size size of buffer
323 bracket if TRUE, terminate non-quoted on ( and ) as well as space
324
325Returns: the next significant character after the item
326*/
327
328static uschar *
329nextitem(uschar *ptr, uschar *buffer, int size, BOOL bracket)
330{
331uschar *bp = buffer;
332if (*ptr != '\"') return nextword(ptr, buffer, size, bracket);
333
334while (*(++ptr) != 0 && *ptr != '\"' && *ptr != '\n')
335 {
336 if (bp - buffer >= size - 1)
337 {
338 *error_pointer = string_sprintf("string is too long in line %d of "
339 "filter file (max = %d chars)", line_number, size);
340 break;
341 }
342
343 if (*ptr != '\\') *bp++ = *ptr; else
344 {
345 if (isspace(ptr[1])) /* \<whitespace>NL<whitespace> ignored */
346 {
347 uschar *p = ptr + 1;
348 while (*p != '\n' && isspace(*p)) p++;
349 if (*p == '\n')
350 {
351 line_number++;
352 ptr = p;
353 while (ptr[1] != '\n' && isspace(ptr[1])) ptr++;
354 continue;
355 }
356 }
357
55414b25 358 *bp++ = string_interpret_escape(CUSS &ptr);
059ec3d9
PH
359 }
360 }
361
362if (*ptr == '\"') ptr++;
363 else if (*error_pointer == NULL)
364 *error_pointer = string_sprintf("quote missing at end of string "
365 "in line %d", line_number);
366
367*bp = 0;
368return nextsigchar(ptr, TRUE);
369}
370
371
372
373
374/*************************************************
375* Convert a string + K|M to a number *
376*************************************************/
377
378/*
379Arguments:
380 s points to text string
381 OK set TRUE if a valid number was read
382
383Returns: the number, or 0 on error (with *OK FALSE)
384*/
385
386static int
387get_number(uschar *s, BOOL *ok)
388{
389int value, count;
390*ok = FALSE;
391if (sscanf(CS s, "%i%n", &value, &count) != 1) return 0;
392if (tolower(s[count]) == 'k') { value *= 1024; count++; }
393if (tolower(s[count]) == 'm') { value *= 1024*1024; count++; }
394while (isspace((s[count]))) count++;
395if (s[count] != 0) return 0;
396*ok = TRUE;
397return value;
398}
399
400
401
402/*************************************************
403* Read one condition *
404*************************************************/
405
406/* A complete condition must be terminated by "then"; bracketed internal
407conditions must be terminated by a closing bracket. They are read by calling
408this function recursively.
409
410Arguments:
411 ptr points to start of condition
412 condition_block where to hang the created condition block
413 toplevel TRUE when called at the top level
414
415Returns: points to next character after "then"
416*/
417
418static uschar *
419read_condition(uschar *ptr, condition_block **cond, BOOL toplevel)
420{
421uschar buffer[1024];
422BOOL testfor = TRUE;
423condition_block *current_parent = NULL;
424condition_block **current = cond;
425
426*current = NULL;
427
428/* Loop to read next condition */
429
430for (;;)
431 {
432 condition_block *c;
433
434 /* reaching the end of the input is an error. */
435
436 if (*ptr == 0)
437 {
f3ebb786 438 *error_pointer = US"\"then\" missing at end of filter file";
059ec3d9
PH
439 break;
440 }
441
442 /* Opening bracket at the start of a condition introduces a nested
443 condition, which must be terminated by a closing bracket. */
444
445 if (*ptr == '(')
446 {
447 ptr = read_condition(nextsigchar(ptr+1, TRUE), &c, FALSE);
448 if (*error_pointer != NULL) break;
449 if (*ptr != ')')
450 {
451 *error_pointer = string_sprintf("expected \")\" in line %d of "
452 "filter file", line_number);
453 break;
454 }
455 if (!testfor)
456 {
457 c->testfor = !c->testfor;
458 testfor = TRUE;
459 }
460 ptr = nextsigchar(ptr+1, TRUE);
461 }
462
463
464 /* Closing bracket at the start of a condition is an error. Give an
465 explicit message, as otherwise "unknown condition" would be confusing. */
466
467 else if (*ptr == ')')
468 {
469 *error_pointer = string_sprintf("unexpected \")\" in line %d of "
470 "filter file", line_number);
471 break;
472 }
473
474 /* Otherwise we expect a word or a string. */
475
476 else
477 {
478 ptr = nextitem(ptr, buffer, sizeof(buffer), TRUE);
479 if (*error_pointer != NULL) break;
480
481 /* "Then" at the start of a condition is an error */
482
483 if (Ustrcmp(buffer, "then") == 0)
484 {
485 *error_pointer = string_sprintf("unexpected \"then\" near line %d of "
486 "filter file", line_number);
487 break;
488 }
489
490 /* "Not" at the start of a condition negates the testing condition. */
491
492 if (Ustrcmp(buffer, "not") == 0)
493 {
494 testfor = !testfor;
495 continue;
496 }
497
498 /* Build a condition block from the specific word. */
499
f3ebb786 500 c = store_get(sizeof(condition_block), FALSE);
059ec3d9
PH
501 c->left.u = c->right.u = NULL;
502 c->testfor = testfor;
503 testfor = TRUE;
504
505 /* Check for conditions that start with a keyword */
506
507 if (Ustrcmp(buffer, "delivered") == 0) c->type = cond_delivered;
508 else if (Ustrcmp(buffer, "error_message") == 0) c->type = cond_errormsg;
509 else if (Ustrcmp(buffer, "first_delivery") == 0) c->type = cond_firsttime;
510 else if (Ustrcmp(buffer, "manually_thawed") == 0) c->type = cond_manualthaw;
511
512 /* Personal can be followed by any number of aliases */
513
514 else if (Ustrcmp(buffer, "personal") == 0)
515 {
516 c->type = cond_personal;
517 for (;;)
518 {
519 string_item *aa;
520 uschar *saveptr = ptr;
521 ptr = nextword(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 522 if (*error_pointer) break;
059ec3d9
PH
523 if (Ustrcmp(buffer, "alias") != 0)
524 {
525 ptr = saveptr;
526 break;
527 }
528 ptr = nextitem(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 529 if (*error_pointer) break;
f3ebb786 530 aa = store_get(sizeof(string_item), FALSE);
059ec3d9
PH
531 aa->text = string_copy(buffer);
532 aa->next = c->left.a;
533 c->left.a = aa;
534 }
535 }
536
537 /* Foranyaddress must be followed by a string and a condition enclosed
538 in parentheses, which is handled as a subcondition. */
539
540 else if (Ustrcmp(buffer, "foranyaddress") == 0)
541 {
542 ptr = nextitem(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 543 if (*error_pointer) break;
059ec3d9
PH
544 if (*ptr != '(')
545 {
546 *error_pointer = string_sprintf("\"(\" expected after \"foranyaddress\" "
547 "near line %d of filter file", line_number);
548 break;
549 }
550
551 c->type = cond_foranyaddress;
552 c->left.u = string_copy(buffer);
553
554 ptr = read_condition(nextsigchar(ptr+1, TRUE), &(c->right.c), FALSE);
4dc2379a 555 if (*error_pointer) break;
059ec3d9
PH
556 if (*ptr != ')')
557 {
558 *error_pointer = string_sprintf("expected \")\" in line %d of "
559 "filter file", line_number);
560 break;
561 }
059ec3d9
PH
562 ptr = nextsigchar(ptr+1, TRUE);
563 }
564
565 /* If it's not a word we recognize, then it must be the lefthand
566 operand of one of the comparison words. */
567
568 else
569 {
570 int i;
571 uschar *isptr = NULL;
572
573 c->left.u = string_copy(buffer);
574 ptr = nextword(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 575 if (*error_pointer) break;
059ec3d9
PH
576
577 /* Handle "does|is [not]", preserving the pointer after "is" in
578 case it isn't that, but the form "is <string>". */
579
580 if (strcmpic(buffer, US"does") == 0 || strcmpic(buffer, US"is") == 0)
581 {
582 if (buffer[0] == 'i') { c->type = cond_is; isptr = ptr; }
583 if (buffer[0] == 'I') { c->type = cond_IS; isptr = ptr; }
584
585 ptr = nextword(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 586 if (*error_pointer) break;
059ec3d9
PH
587 if (strcmpic(buffer, US"not") == 0)
588 {
589 c->testfor = !c->testfor;
4dc2379a 590 if (isptr) isptr = ptr;
059ec3d9 591 ptr = nextword(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 592 if (*error_pointer) break;
059ec3d9
PH
593 }
594 }
595
596 for (i = 0; i < cond_word_count; i++)
597 {
598 if (Ustrcmp(buffer, cond_words[i]) == 0)
599 {
600 c->type = cond_types[i];
601 break;
602 }
603 }
604
605 /* If an unknown word follows "is" or "is not"
606 it's actually the argument. Reset to read it. */
607
608 if (i >= cond_word_count)
609 {
4dc2379a 610 if (!isptr)
059ec3d9
PH
611 {
612 *error_pointer = string_sprintf("unrecognized condition word \"%s\" "
613 "near line %d of filter file", buffer, line_number);
614 break;
615 }
4dc2379a 616 ptr = isptr;
059ec3d9
PH
617 }
618
619 /* Get the RH argument. */
620
621 ptr = nextitem(ptr, buffer, sizeof(buffer), TRUE);
4dc2379a 622 if (*error_pointer) break;
059ec3d9
PH
623 c->right.u = string_copy(buffer);
624 }
625 }
626
627 /* We have read some new condition and set it up in the condition block
628 c; point the current pointer at it, and then deal with what follows. */
629
630 *current = c;
631
632 /* Closing bracket terminates if this is a lower-level condition. Otherwise
633 it is unexpected. */
634
635 if (*ptr == ')')
636 {
637 if (toplevel)
638 *error_pointer = string_sprintf("unexpected \")\" in line %d of "
639 "filter file", line_number);
640 break;
641 }
642
643 /* Opening bracket following a condition is an error; give an explicit
644 message to make it clearer what is wrong. */
645
646 else if (*ptr == '(')
647 {
648 *error_pointer = string_sprintf("unexpected \"(\" in line %d of "
649 "filter file", line_number);
650 break;
651 }
652
653 /* Otherwise the next thing must be one of the words "and", "or" or "then" */
654
655 else
656 {
657 uschar *saveptr = ptr;
658 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
4dc2379a 659 if (*error_pointer) break;
059ec3d9
PH
660
661 /* "Then" terminates a toplevel condition; otherwise a closing bracket
662 has been omitted. Put a string terminator at the start of "then" so
663 that reflecting the condition can be done when testing. */
664
665 if (Ustrcmp(buffer, "then") == 0)
666 {
667 if (toplevel) *saveptr = 0;
4dc2379a 668 else *error_pointer = string_sprintf("missing \")\" at end of "
059ec3d9
PH
669 "condition near line %d of filter file", line_number);
670 break;
671 }
672
673 /* "And" causes a new condition block to replace the one we have
674 just read, which becomes the left sub-condition. The current pointer
675 is reset to the pointer for the right sub-condition. We have to keep
676 track of the tree of sequential "ands", so as to traverse back up it
677 if an "or" is met. */
678
679 else if (Ustrcmp(buffer, "and") == 0)
680 {
f3ebb786 681 condition_block *andc = store_get(sizeof(condition_block), FALSE);
059ec3d9
PH
682 andc->parent = current_parent;
683 andc->type = cond_and;
684 andc->testfor = TRUE;
685 andc->left.c = c;
686 andc->right.u = NULL; /* insurance */
687 *current = andc;
688 current = &(andc->right.c);
689 current_parent = andc;
690 }
691
692 /* "Or" is similar, but has to be done a bit more carefully to
693 ensure that "and" is more binding. If there's a parent set, we
694 are following a sequence of "and"s and must track back to their
695 start. */
696
697 else if (Ustrcmp(buffer, "or") == 0)
698 {
f3ebb786 699 condition_block *orc = store_get(sizeof(condition_block), FALSE);
059ec3d9
PH
700 condition_block *or_parent = NULL;
701
4dc2379a 702 if (current_parent)
059ec3d9 703 {
4dc2379a 704 while (current_parent->parent &&
059ec3d9
PH
705 current_parent->parent->type == cond_and)
706 current_parent = current_parent->parent;
707
708 /* If the parent has a parent, it must be an "or" parent. */
709
4dc2379a 710 if (current_parent->parent)
059ec3d9
PH
711 or_parent = current_parent->parent;
712 }
713
714 orc->parent = or_parent;
4dc2379a
JH
715 if (!or_parent) *cond = orc;
716 else or_parent->right.c = orc;
059ec3d9
PH
717 orc->type = cond_or;
718 orc->testfor = TRUE;
719 orc->left.c = (current_parent == NULL)? c : current_parent;
720 orc->right.c = NULL; /* insurance */
721 current = &(orc->right.c);
722 current_parent = orc;
723 }
724
725 /* Otherwise there is a disaster */
726
727 else
728 {
729 *error_pointer = string_sprintf("\"and\" or \"or\" or \"%s\" "
730 "expected near line %d of filter file, but found \"%s\"",
731 toplevel? "then" : ")", line_number, buffer);
732 break;
733 }
734 }
735 }
736
737return nextsigchar(ptr, TRUE);
738}
739
740
741
742/*************************************************
4c04137d 743* Output the current indent *
059ec3d9
PH
744*************************************************/
745
746static void
747indent(void)
748{
749int i;
750for (i = 0; i < output_indent; i++) debug_printf(" ");
751}
752
753
754
755/*************************************************
756* Condition printer: for debugging *
757*************************************************/
758
759/*
760Arguments:
761 c the block at the top of the tree
762 toplevel TRUE at toplevel - stops overall brackets
763
764Returns: nothing
765*/
766
767static void
768print_condition(condition_block *c, BOOL toplevel)
769{
1ba28e2b 770const char *name = (c->testfor)? cond_names[c->type] : cond_not_names[c->type];
059ec3d9
PH
771switch(c->type)
772 {
773 case cond_personal:
774 case cond_delivered:
775 case cond_errormsg:
776 case cond_firsttime:
777 case cond_manualthaw:
778 debug_printf("%s", name);
779 break;
780
781 case cond_is:
782 case cond_IS:
783 case cond_matches:
784 case cond_MATCHES:
785 case cond_contains:
786 case cond_CONTAINS:
787 case cond_begins:
788 case cond_BEGINS:
789 case cond_ends:
790 case cond_ENDS:
791 case cond_above:
792 case cond_below:
1ba28e2b 793 debug_printf("%s %s %s", c->left.u, name, c->right.u);
059ec3d9
PH
794 break;
795
796 case cond_and:
797 if (!c->testfor) debug_printf("not (");
798 print_condition(c->left.c, FALSE);
799 debug_printf(" %s ", cond_names[c->type]);
800 print_condition(c->right.c, FALSE);
801 if (!c->testfor) debug_printf(")");
802 break;
803
804 case cond_or:
805 if (!c->testfor) debug_printf("not (");
806 else if (!toplevel) debug_printf("(");
807 print_condition(c->left.c, FALSE);
808 debug_printf(" %s ", cond_names[c->type]);
809 print_condition(c->right.c, FALSE);
810 if (!toplevel || !c->testfor) debug_printf(")");
811 break;
812
813 case cond_foranyaddress:
814 debug_printf("%s %s (", name, c->left.u);
815 print_condition(c->right.c, FALSE);
816 debug_printf(")");
817 break;
818 }
819}
820
821
822
823
824/*************************************************
825* Read one filtering command *
826*************************************************/
827
828/*
829Arguments:
830 pptr points to pointer to first character of command; the pointer
831 is updated to point after the last character read
832 lastcmdptr points to pointer to pointer to last command; used for hanging
833 on the newly read command
834
835Returns: TRUE if command successfully read, else FALSE
836*/
837
838static BOOL
839read_command(uschar **pptr, filter_cmd ***lastcmdptr)
840{
841int command, i, cmd_bit;
842filter_cmd *new, **newlastcmdptr;
843BOOL yield = TRUE;
844BOOL was_seen_or_unseen = FALSE;
845BOOL was_noerror = FALSE;
846uschar buffer[1024];
847uschar *ptr = *pptr;
848uschar *saveptr;
849uschar *fmsg = NULL;
850
851/* Read the next word and find which command it is. Command words are normally
852terminated by white space, but there are two exceptions, which are the "if" and
853"elif" commands. We must allow for them to be terminated by an opening bracket,
854as brackets are allowed in conditions and users will expect not to require
855white space here. */
856
857if (Ustrncmp(ptr, "if(", 3) == 0)
858 {
f3ebb786 859 Ustrcpy(buffer, US"if");
059ec3d9
PH
860 ptr += 2;
861 }
862else if (Ustrncmp(ptr, "elif(", 5) == 0)
863 {
f3ebb786 864 Ustrcpy(buffer, US"elif");
059ec3d9
PH
865 ptr += 4;
866 }
867else
868 {
869 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
870 if (*error_pointer != NULL) return FALSE;
871 }
872
873for (command = 0; command < command_list_count; command++)
874 if (Ustrcmp(buffer, command_list[command]) == 0) break;
875
876/* Handle the individual commands */
877
878switch (command)
879 {
880 /* Add takes two arguments, separated by the word "to". Headers has two
881 arguments, but the first must be "add", "remove", or "charset", and it gets
882 stored in the second argument slot. Neither may be preceded by seen, unseen
883 or noerror. */
884
885 case add_command:
886 case headers_command:
887 if (seen_force || noerror_force)
888 {
889 *error_pointer = string_sprintf("\"seen\", \"unseen\", or \"noerror\" "
890 "found before an \"%s\" command near line %d",
891 command_list[command], line_number);
892 yield = FALSE;
893 }
894 /* Fall through */
895
896 /* Logwrite, logfile, pipe, and testprint all take a single argument, save
897 and logfile can have an option second argument for the mode, and deliver can
898 have "errors_to <address>" in a system filter, or in a user filter if the
899 address is the current one. */
900
901 case deliver_command:
902 case logfile_command:
903 case logwrite_command:
904 case pipe_command:
905 case save_command:
906 case testprint_command:
907
908 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
909 if (*buffer == 0)
910 *error_pointer = string_sprintf("\"%s\" requires an argument "
911 "near line %d of filter file", command_list[command], line_number);
912
913 if (*error_pointer != NULL) yield = FALSE; else
914 {
915 union argtypes argument, second_argument;
916
917 argument.u = second_argument.u = NULL;
918
919 if (command == add_command)
920 {
921 argument.u = string_copy(buffer);
922 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
923 if (*buffer == 0 || Ustrcmp(buffer, "to") != 0)
924 *error_pointer = string_sprintf("\"to\" expected in \"add\" command "
925 "near line %d of filter file", line_number);
926 else
927 {
928 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
929 if (*buffer == 0)
930 *error_pointer = string_sprintf("value missing after \"to\" "
931 "near line %d of filter file", line_number);
932 else second_argument.u = string_copy(buffer);
933 }
934 }
935
936 else if (command == headers_command)
937 {
938 if (Ustrcmp(buffer, "add") == 0)
939 second_argument.b = TRUE;
940 else
941 if (Ustrcmp(buffer, "remove") == 0) second_argument.b = FALSE;
942 else
943 if (Ustrcmp(buffer, "charset") == 0)
944 second_argument.b = TRUE_UNSET;
945 else
946 {
947 *error_pointer = string_sprintf("\"add\", \"remove\", or \"charset\" "
948 "expected after \"headers\" near line %d of filter file",
949 line_number);
950 yield = FALSE;
951 }
952
8768d548 953 if (!f.system_filtering && second_argument.b != TRUE_UNSET)
059ec3d9
PH
954 {
955 *error_pointer = string_sprintf("header addition and removal is "
956 "available only in system filters: near line %d of filter file",
957 line_number);
958 yield = FALSE;
959 break;
960 }
961
962 if (yield)
963 {
964 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
965 if (*buffer == 0)
966 *error_pointer = string_sprintf("value missing after \"add\", "
967 "\"remove\", or \"charset\" near line %d of filter file",
968 line_number);
969 else argument.u = string_copy(buffer);
970 }
971 }
972
973 /* The argument for the logwrite command must end in a newline, and the save
974 and logfile commands can have an optional mode argument. The deliver
975 command can have an optional "errors_to <address>" for a system filter,
976 or for a user filter if the address is the user's address. Accept the
977 syntax here - the check is later. */
978
979 else
980 {
981 if (command == logwrite_command)
982 {
983 int len = Ustrlen(buffer);
f3ebb786 984 if (len == 0 || buffer[len-1] != '\n') Ustrcat(buffer, US"\n");
059ec3d9
PH
985 }
986
987 argument.u = string_copy(buffer);
988
989 if (command == save_command || command == logfile_command)
990 {
991 if (isdigit(*ptr))
992 {
993 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
994 second_argument.i = (int)Ustrtol(buffer, NULL, 8);
995 }
996 else second_argument.i = -1;
997 }
998
999 else if (command == deliver_command)
1000 {
1001 uschar *save_ptr = ptr;
1002 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
1003 if (Ustrcmp(buffer, "errors_to") == 0)
1004 {
1005 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
1006 second_argument.u = string_copy(buffer);
1007 }
1008 else ptr = save_ptr;
1009 }
1010 }
1011
1012 /* Set up the command block. Seen defaults TRUE for delivery commands,
1013 FALSE for logging commands, and it doesn't matter for testprint, as
1014 that doesn't change the "delivered" status. */
1015
1016 if (*error_pointer != NULL) yield = FALSE; else
1017 {
f3ebb786 1018 new = store_get(sizeof(filter_cmd) + sizeof(union argtypes), FALSE);
059ec3d9
PH
1019 new->next = NULL;
1020 **lastcmdptr = new;
1021 *lastcmdptr = &(new->next);
1022 new->command = command;
1023 new->seen = seen_force? seen_value : command_exparg_count[command] >= 128;
1024 new->noerror = noerror_force;
1025 new->args[0] = argument;
1026 new->args[1] = second_argument;
1027 }
1028 }
1029 break;
1030
1031
1032 /* Elif, else and endif just set a flag if expected. */
1033
1034 case elif_command:
1035 case else_command:
1036 case endif_command:
41609df5
PH
1037 if (seen_force || noerror_force)
1038 {
1039 *error_pointer = string_sprintf("\"seen\", \"unseen\", or \"noerror\" "
1040 "near line %d is not followed by a command", line_number);
1041 yield = FALSE;
1042 }
1043
059ec3d9
PH
1044 if (expect_endif > 0)
1045 had_else_endif = (command == elif_command)? had_elif :
1046 (command == else_command)? had_else : had_endif;
1047 else
1048 {
1049 *error_pointer = string_sprintf("unexpected \"%s\" command near "
1050 "line %d of filter file", buffer, line_number);
1051 yield = FALSE;
1052 }
1053 break;
1054
1055
1056 /* Defer, freeze, and fail are available only if permitted. */
1057
1058 case defer_command:
1059 cmd_bit = RDO_DEFER;
1060 goto DEFER_FREEZE_FAIL;
1061
1062 case fail_command:
1063 cmd_bit = RDO_FAIL;
1064 goto DEFER_FREEZE_FAIL;
1065
1066 case freeze_command:
1067 cmd_bit = RDO_FREEZE;
1068
1069 DEFER_FREEZE_FAIL:
1070 if ((filter_options & cmd_bit) == 0)
1071 {
1072 *error_pointer = string_sprintf("filtering command \"%s\" is disabled: "
1073 "near line %d of filter file", buffer, line_number);
1074 yield = FALSE;
1075 break;
1076 }
1077
1078 /* A text message can be provided after the "text" keyword, or
1079 as a string in quotes. */
1080
1081 saveptr = ptr;
1082 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
1083 if (*saveptr != '\"' && (*buffer == 0 || Ustrcmp(buffer, "text") != 0))
1084 {
1085 ptr = saveptr;
1086 fmsg = US"";
1087 }
1088 else
1089 {
1090 if (*saveptr != '\"')
1091 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
1092 fmsg = string_copy(buffer);
1093 }
1094
1095 /* Drop through and treat as "finish", but never set "seen". */
1096
1097 seen_value = FALSE;
1098
1099 /* Finish has no arguments; fmsg defaults to NULL */
1100
1101 case finish_command:
f3ebb786 1102 new = store_get(sizeof(filter_cmd), FALSE);
059ec3d9
PH
1103 new->next = NULL;
1104 **lastcmdptr = new;
1105 *lastcmdptr = &(new->next);
1106 new->command = command;
1107 new->seen = seen_force? seen_value : FALSE;
1108 new->args[0].u = fmsg;
1109 break;
1110
1111
1112 /* Seen, unseen, and noerror are not allowed before if, which takes a
1113 condition argument and then and else sub-commands. */
1114
1115 case if_command:
1116 if (seen_force || noerror_force)
1117 {
1118 *error_pointer = string_sprintf("\"seen\", \"unseen\", or \"noerror\" "
1119 "found before an \"if\" command near line %d",
1120 line_number);
1121 yield = FALSE;
1122 }
1123
1124 /* Set up the command block for if */
1125
f3ebb786 1126 new = store_get(sizeof(filter_cmd) + 4 * sizeof(union argtypes), FALSE);
059ec3d9
PH
1127 new->next = NULL;
1128 **lastcmdptr = new;
1129 *lastcmdptr = &(new->next);
1130 new->command = command;
1131 new->seen = FALSE;
1132 new->args[0].u = NULL;
1133 new->args[1].u = new->args[2].u = NULL;
1134 new->args[3].u = ptr;
1135
1136 /* Read the condition */
1137
1138 ptr = read_condition(ptr, &(new->args[0].c), TRUE);
1139 if (*error_pointer != NULL) { yield = FALSE; break; }
1140
1141 /* Read the commands to be obeyed if the condition is true */
1142
1143 newlastcmdptr = &(new->args[1].f);
1144 if (!read_command_list(&ptr, &newlastcmdptr, TRUE)) yield = FALSE;
1145
1146 /* If commands were successfully read, handle the various possible
1147 terminators. There may be a number of successive "elif" sections. */
1148
1149 else
1150 {
1151 while (had_else_endif == had_elif)
1152 {
1153 filter_cmd *newnew =
f3ebb786 1154 store_get(sizeof(filter_cmd) + 4 * sizeof(union argtypes), FALSE);
059ec3d9
PH
1155 new->args[2].f = newnew;
1156 new = newnew;
1157 new->next = NULL;
1158 new->command = command;
1159 new->seen = FALSE;
1160 new->args[0].u = NULL;
1161 new->args[1].u = new->args[2].u = NULL;
1162 new->args[3].u = ptr;
1163
1164 ptr = read_condition(ptr, &(new->args[0].c), TRUE);
1165 if (*error_pointer != NULL) { yield = FALSE; break; }
1166 newlastcmdptr = &(new->args[1].f);
1167 if (!read_command_list(&ptr, &newlastcmdptr, TRUE))
1168 yield = FALSE;
1169 }
1170
1171 if (yield == FALSE) break;
1172
1173 /* Handle termination by "else", possibly following one or more
1174 "elsif" sections. */
1175
1176 if (had_else_endif == had_else)
1177 {
1178 newlastcmdptr = &(new->args[2].f);
1179 if (!read_command_list(&ptr, &newlastcmdptr, TRUE))
1180 yield = FALSE;
1181 else if (had_else_endif != had_endif)
1182 {
1183 *error_pointer = string_sprintf("\"endif\" missing near line %d of "
1184 "filter file", line_number);
1185 yield = FALSE;
1186 }
1187 }
1188
1189 /* Otherwise the terminator was "endif" - this is checked by
1190 read_command_list(). The pointer is already set to NULL. */
1191 }
1192
1193 /* Reset the terminator flag. */
1194
1195 had_else_endif = had_neither;
1196 break;
1197
1198
1199 /* The mail & vacation commands have a whole slew of keyworded arguments.
1200 The final argument values are the file expand and return message booleans,
1201 whose offsets are defined in mailarg_index_{expand,return}. Although they
1202 are logically booleans, because they are stored in a uschar * value, we use
1203 NULL and not FALSE, to keep 64-bit compilers happy. */
1204
1205 case mail_command:
1206 case vacation_command:
f3ebb786 1207 new = store_get(sizeof(filter_cmd) + mailargs_total * sizeof(union argtypes), FALSE);
059ec3d9
PH
1208 new->next = NULL;
1209 new->command = command;
1210 new->seen = seen_force? seen_value : FALSE;
1211 new->noerror = noerror_force;
1212 for (i = 0; i < mailargs_total; i++) new->args[i].u = NULL;
1213
1214 /* Read keyword/value pairs until we hit one that isn't. The data
1215 must contain only printing chars plus tab, though the "text" value
1216 can also contain newlines. The "file" keyword can be preceded by the
1217 word "expand", and "return message" has no data. */
1218
1219 for (;;)
1220 {
1221 uschar *saveptr = ptr;
1222 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
1223 if (*error_pointer != NULL)
1224 {
1225 yield = FALSE;
1226 break;
1227 }
1228
1229 /* Ensure "return" is followed by "message"; that's a complete option */
1230
1231 if (Ustrcmp(buffer, "return") == 0)
1232 {
1233 new->args[mailarg_index_return].u = US""; /* not NULL => TRUE */
1234 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
1235 if (Ustrcmp(buffer, "message") != 0)
1236 {
1237 *error_pointer = string_sprintf("\"return\" not followed by \"message\" "
1238 " near line %d of filter file", line_number);
1239 yield = FALSE;
1240 break;
1241 }
1242 continue;
1243 }
1244
1245 /* Ensure "expand" is followed by "file", then fall through to process the
1246 file keyword. */
1247
1248 if (Ustrcmp(buffer, "expand") == 0)
1249 {
1250 new->args[mailarg_index_expand].u = US""; /* not NULL => TRUE */
1251 ptr = nextword(ptr, buffer, sizeof(buffer), FALSE);
1252 if (Ustrcmp(buffer, "file") != 0)
1253 {
1254 *error_pointer = string_sprintf("\"expand\" not followed by \"file\" "
1255 " near line %d of filter file", line_number);
1256 yield = FALSE;
1257 break;
1258 }
1259 }
1260
1261 /* Scan for the keyword */
1262
1263 for (i = 0; i < MAILARGS_STRING_COUNT; i++)
1264 if (Ustrcmp(buffer, mailargs[i]) == 0) break;
1265
1266 /* Not found keyword; assume end of this command */
1267
1268 if (i >= MAILARGS_STRING_COUNT)
1269 {
1270 ptr = saveptr;
1271 break;
1272 }
1273
1274 /* Found keyword, read the data item */
1275
1276 ptr = nextitem(ptr, buffer, sizeof(buffer), FALSE);
1277 if (*error_pointer != NULL)
1278 {
1279 yield = FALSE;
1280 break;
1281 }
1282 else new->args[i].u = string_copy(buffer);
1283 }
1284
1285 /* If this is the vacation command, apply some default settings to
1286 some of the arguments. */
1287
1288 if (command == vacation_command)
1289 {
1290 if (new->args[mailarg_index_file].u == NULL)
1291 {
1292 new->args[mailarg_index_file].u = string_copy(US".vacation.msg");
1293 new->args[mailarg_index_expand].u = US""; /* not NULL => TRUE */
1294 }
1295 if (new->args[mailarg_index_log].u == NULL)
1296 new->args[mailarg_index_log].u = string_copy(US".vacation.log");
1297 if (new->args[mailarg_index_once].u == NULL)
1298 new->args[mailarg_index_once].u = string_copy(US".vacation");
1299 if (new->args[mailarg_index_once_repeat].u == NULL)
1300 new->args[mailarg_index_once_repeat].u = string_copy(US"7d");
1301 if (new->args[mailarg_index_subject].u == NULL)
1302 new->args[mailarg_index_subject].u = string_copy(US"On vacation");
1303 }
1304
1305 /* Join the address on to the chain of generated addresses */
1306
1307 **lastcmdptr = new;
1308 *lastcmdptr = &(new->next);
1309 break;
1310
1311
1312 /* Seen and unseen just set flags */
1313
1314 case seen_command:
1315 case unseen_command:
41609df5
PH
1316 if (*ptr == 0)
1317 {
1318 *error_pointer = string_sprintf("\"seen\" or \"unseen\" "
1319 "near line %d is not followed by a command", line_number);
1320 yield = FALSE;
1321 }
059ec3d9
PH
1322 if (seen_force)
1323 {
1324 *error_pointer = string_sprintf("\"seen\" or \"unseen\" repeated "
1325 "near line %d", line_number);
1326 yield = FALSE;
1327 }
1328 seen_value = (command == seen_command);
1329 seen_force = TRUE;
1330 was_seen_or_unseen = TRUE;
1331 break;
1332
1333
1334 /* So does noerror */
1335
1336 case noerror_command:
41609df5
PH
1337 if (*ptr == 0)
1338 {
1339 *error_pointer = string_sprintf("\"noerror\" "
1340 "near line %d is not followed by a command", line_number);
1341 yield = FALSE;
1342 }
059ec3d9
PH
1343 noerror_force = TRUE;
1344 was_noerror = TRUE;
1345 break;
1346
1347
1348 /* Oops */
1349
1350 default:
1351 *error_pointer = string_sprintf("unknown filtering command \"%s\" "
1352 "near line %d of filter file", buffer, line_number);
1353 yield = FALSE;
1354 break;
1355 }
1356
1357if (!was_seen_or_unseen && !was_noerror)
1358 {
1359 seen_force = FALSE;
1360 noerror_force = FALSE;
1361 }
1362
1363*pptr = ptr;
1364return yield;
1365}
1366
1367
1368
1369/*************************************************
1370* Read a list of commands *
1371*************************************************/
1372
4c04137d 1373/* If conditional is TRUE, the list must be terminated
059ec3d9
PH
1374by the words "else" or "endif".
1375
1376Arguments:
1377 pptr points to pointer to next character; the pointer is updated
1378 lastcmdptr points to pointer to pointer to previously-read command; used
1379 for hanging on the new command
1380 conditional TRUE if this command is the subject of a condition
1381
1382Returns: TRUE on success
1383*/
1384
1385static BOOL
1386read_command_list(uschar **pptr, filter_cmd ***lastcmdptr, BOOL conditional)
1387{
1388if (conditional) expect_endif++;
1389had_else_endif = had_neither;
1390while (**pptr != 0 && had_else_endif == had_neither)
1391 {
1392 if (!read_command(pptr, lastcmdptr)) return FALSE;
1393 *pptr = nextsigchar(*pptr, TRUE);
1394 }
1395if (conditional)
1396 {
1397 expect_endif--;
1398 if (had_else_endif == had_neither)
1399 {
1400 *error_pointer = US"\"endif\" missing at end of filter file";
1401 return FALSE;
1402 }
1403 }
1404return TRUE;
1405}
1406
1407
1408
1409
1410/*************************************************
1411* Test a condition *
1412*************************************************/
1413
1414/*
1415Arguments:
1416 c points to the condition block; c->testfor indicated whether
1417 it's a positive or negative condition
1418 toplevel TRUE if called from "if" directly; FALSE otherwise
1419
1420Returns: TRUE if the condition is met
1421*/
1422
1423static BOOL
1424test_condition(condition_block *c, BOOL toplevel)
1425{
91ecef39 1426BOOL yield = FALSE;
059ec3d9
PH
1427const pcre *re;
1428uschar *exp[2], *p, *pp;
1429const uschar *regcomp_error = NULL;
1430int regcomp_error_offset;
1431int val[2];
1432int i;
1433
1434if (c == NULL) return TRUE; /* does this ever occur? */
1435
1436switch (c->type)
1437 {
1438 case cond_and:
1439 yield = test_condition(c->left.c, FALSE) &&
1440 *error_pointer == NULL &&
1441 test_condition(c->right.c, FALSE);
1442 break;
1443
1444 case cond_or:
1445 yield = test_condition(c->left.c, FALSE) ||
1446 (*error_pointer == NULL &&
1447 test_condition(c->right.c, FALSE));
1448 break;
1449
1450 /* The personal test is meaningless in a system filter. The tests are now in
1451 a separate function (so Sieve can use them). However, an Exim filter does not
1452 scan Cc: (hence the FALSE argument). */
1453
1454 case cond_personal:
8768d548 1455 yield = f.system_filtering? FALSE : filter_personal(c->left.a, FALSE);
059ec3d9
PH
1456 break;
1457
1458 case cond_delivered:
1459 yield = filter_delivered;
1460 break;
1461
1462 /* Only TRUE if a message is actually being processed; FALSE for address
1463 testing and verification. */
1464
1465 case cond_errormsg:
1466 yield = message_id[0] != 0 &&
1467 (sender_address == NULL || sender_address[0] == 0);
1468 break;
1469
1470 /* Only FALSE if a message is actually being processed; TRUE for address
1471 and filter testing and verification. */
1472
1473 case cond_firsttime:
8768d548 1474 yield = filter_test != FTEST_NONE || message_id[0] == 0 || f.deliver_firsttime;
059ec3d9
PH
1475 break;
1476
1477 /* Only TRUE if a message is actually being processed; FALSE for address
1478 testing and verification. */
1479
1480 case cond_manualthaw:
8768d548 1481 yield = message_id[0] != 0 && f.deliver_manual_thaw;
059ec3d9
PH
1482 break;
1483
1484 /* The foranyaddress condition loops through a list of addresses */
1485
1486 case cond_foranyaddress:
1487 p = c->left.u;
1488 pp = expand_string(p);
1489 if (pp == NULL)
1490 {
1491 *error_pointer = string_sprintf("failed to expand \"%s\" in "
1492 "filter file: %s", p, expand_string_message);
1493 return FALSE;
1494 }
1495
1496 yield = FALSE;
8768d548 1497 f.parse_allow_group = TRUE; /* Allow group syntax */
059ec3d9
PH
1498
1499 while (*pp != 0)
1500 {
1501 uschar *error;
1502 int start, end, domain;
1503 int saveend;
1504
1505 p = parse_find_address_end(pp, FALSE);
1506 saveend = *p;
1507
1508 *p = 0;
1509 filter_thisaddress =
1510 parse_extract_address(pp, &error, &start, &end, &domain, FALSE);
1511 *p = saveend;
1512
1513 if (filter_thisaddress != NULL)
1514 {
f05da2e8 1515 if ((filter_test != FTEST_NONE && debug_selector != 0) ||
059ec3d9
PH
1516 (debug_selector & D_filter) != 0)
1517 {
1518 indent();
f3ebb786 1519 debug_printf_indent("Extracted address %s\n", filter_thisaddress);
059ec3d9
PH
1520 }
1521 yield = test_condition(c->right.c, FALSE);
1522 }
1523
1524 if (yield) break;
1525 if (saveend == 0) break;
1526 pp = p + 1;
1527 }
1528
8768d548
JH
1529 f.parse_allow_group = FALSE; /* Reset group syntax flags */
1530 f.parse_found_group = FALSE;
059ec3d9
PH
1531 break;
1532
1533 /* All other conditions have left and right values that need expanding;
1534 on error, it doesn't matter what value is returned. */
1535
1536 default:
1537 p = c->left.u;
1538 for (i = 0; i < 2; i++)
1539 {
1540 exp[i] = expand_string(p);
1541 if (exp[i] == NULL)
1542 {
1543 *error_pointer = string_sprintf("failed to expand \"%s\" in "
1544 "filter file: %s", p, expand_string_message);
1545 return FALSE;
1546 }
1547 p = c->right.u;
1548 }
1549
1550 /* Inner switch for the different cases */
1551
1552 switch(c->type)
1553 {
1554 case cond_is:
1555 yield = strcmpic(exp[0], exp[1]) == 0;
1556 break;
1557
1558 case cond_IS:
1559 yield = Ustrcmp(exp[0], exp[1]) == 0;
1560 break;
1561
1562 case cond_contains:
1563 yield = strstric(exp[0], exp[1], FALSE) != NULL;
1564 break;
1565
1566 case cond_CONTAINS:
1567 yield = Ustrstr(exp[0], exp[1]) != NULL;
1568 break;
1569
1570 case cond_begins:
1571 yield = strncmpic(exp[0], exp[1], Ustrlen(exp[1])) == 0;
1572 break;
1573
1574 case cond_BEGINS:
1575 yield = Ustrncmp(exp[0], exp[1], Ustrlen(exp[1])) == 0;
1576 break;
1577
1578 case cond_ends:
1579 case cond_ENDS:
1580 {
1581 int len = Ustrlen(exp[1]);
1582 uschar *s = exp[0] + Ustrlen(exp[0]) - len;
1583 yield = (s < exp[0])? FALSE :
1584 ((c->type == cond_ends)? strcmpic(s, exp[1]) : Ustrcmp(s, exp[1])) == 0;
1585 }
1586 break;
1587
1588 case cond_matches:
1589 case cond_MATCHES:
f05da2e8 1590 if ((filter_test != FTEST_NONE && debug_selector != 0) ||
059ec3d9
PH
1591 (debug_selector & D_filter) != 0)
1592 {
f3ebb786
JH
1593 debug_printf_indent("Match expanded arguments:\n");
1594 debug_printf_indent(" Subject = %s\n", exp[0]);
1595 debug_printf_indent(" Pattern = %s\n", exp[1]);
059ec3d9
PH
1596 }
1597
1598 re = pcre_compile(CS exp[1],
1599 PCRE_COPT | ((c->type == cond_matches)? PCRE_CASELESS : 0),
1600 (const char **)&regcomp_error, &regcomp_error_offset, NULL);
1601
1602 if (re == NULL)
1603 {
1604 *error_pointer = string_sprintf("error while compiling "
1605 "regular expression \"%s\": %s at offset %d",
1606 exp[1], regcomp_error, regcomp_error_offset);
1607 return FALSE;
1608 }
1609
1610 yield = regex_match_and_setup(re, exp[0], PCRE_EOPT, -1);
1611 break;
1612
1613 /* For above and below, convert the strings to numbers */
1614
1615 case cond_above:
1616 case cond_below:
1617 for (i = 0; i < 2; i++)
1618 {
1619 val[i] = get_number(exp[i], &yield);
1620 if (!yield)
1621 {
1622 *error_pointer = string_sprintf("malformed numerical string \"%s\"",
1623 exp[i]);
1624 return FALSE;
1625 }
1626 }
1627 yield = (c->type == cond_above)? (val[0] > val[1]) : (val[0] < val[1]);
1628 break;
1629 }
1630 break;
1631 }
1632
f05da2e8 1633if ((filter_test != FTEST_NONE && debug_selector != 0) ||
059ec3d9
PH
1634 (debug_selector & D_filter) != 0)
1635 {
1636 indent();
f3ebb786 1637 debug_printf_indent("%sondition is %s: ",
059ec3d9
PH
1638 toplevel? "C" : "Sub-c",
1639 (yield == c->testfor)? "true" : "false");
1640 print_condition(c, TRUE);
f3ebb786 1641 debug_printf_indent("\n");
059ec3d9
PH
1642 }
1643
1644return yield == c->testfor;
1645}
1646
1647
1648
1649/*************************************************
1650* Interpret chain of commands *
1651*************************************************/
1652
1653/* In testing state, just say what would be done rather than doing it. The
1654testprint command just expands and outputs its argument in testing state, and
1655does nothing otherwise.
1656
1657Arguments:
1658 commands points to chain of commands to interpret
1659 generated where to hang newly-generated addresses
1660
1661Returns: FF_DELIVERED success, a significant action was taken
1662 FF_NOTDELIVERED success, no significant action
1663 FF_DEFER defer requested
1664 FF_FAIL fail requested
1665 FF_FREEZE freeze requested
1666 FF_ERROR there was a problem
1667*/
1668
1669static int
1670interpret_commands(filter_cmd *commands, address_item **generated)
1671{
1672uschar *s;
1673int mode;
1674address_item *addr;
1675BOOL condition_value;
1676
f3ebb786 1677while (commands)
059ec3d9
PH
1678 {
1679 int ff_ret;
1680 uschar *fmsg, *ff_name;
1681 uschar *expargs[MAILARGS_STRING_COUNT];
1682
1683 int i, n[2];
1684
1685 /* Expand the relevant number of arguments for the command that are
1686 not NULL. */
1687
1688 for (i = 0; i < (command_exparg_count[commands->command] & 15); i++)
1689 {
1690 uschar *ss = commands->args[i].u;
f3ebb786 1691 if (!ss)
059ec3d9 1692 expargs[i] = NULL;
059ec3d9 1693 else
f3ebb786 1694 if (!(expargs[i] = expand_string(ss)))
059ec3d9
PH
1695 {
1696 *error_pointer = string_sprintf("failed to expand \"%s\" in "
1697 "%s command: %s", ss, command_list[commands->command],
1698 expand_string_message);
1699 return FF_ERROR;
1700 }
059ec3d9
PH
1701 }
1702
1703 /* Now switch for each command, setting the "delivered" flag if any of them
1704 have "seen" set. */
1705
1706 if (commands->seen) filter_delivered = TRUE;
1707
1708 switch(commands->command)
1709 {
1710 case add_command:
f3ebb786
JH
1711 for (i = 0; i < 2; i++)
1712 {
1713 uschar *ss = expargs[i];
1714 uschar *end;
059ec3d9 1715
f3ebb786
JH
1716 if (i == 1 && (*ss++ != 'n' || ss[1] != 0))
1717 {
1718 *error_pointer = string_sprintf("unknown variable \"%s\" in \"add\" "
1719 "command", expargs[i]);
1720 return FF_ERROR;
1721 }
059ec3d9 1722
f3ebb786
JH
1723 /* Allow for "--" at the start of the value (from -$n0) for example */
1724 if (i == 0) while (ss[0] == '-' && ss[1] == '-') ss += 2;
059ec3d9 1725
f3ebb786
JH
1726 n[i] = (int)Ustrtol(ss, &end, 0);
1727 if (*end != 0)
1728 {
1729 *error_pointer = string_sprintf("malformed number \"%s\" in \"add\" "
1730 "command", ss);
1731 return FF_ERROR;
1732 }
1733 }
059ec3d9 1734
f3ebb786
JH
1735 filter_n[n[1]] += n[0];
1736 if (filter_test != FTEST_NONE) printf("Add %d to n%d\n", n[0], n[1]);
1737 break;
059ec3d9 1738
f3ebb786
JH
1739 /* A deliver command's argument must be a valid address. Its optional
1740 second argument (system filter only) must also be a valid address. */
059ec3d9
PH
1741
1742 case deliver_command:
f3ebb786
JH
1743 for (i = 0; i < 2; i++)
1744 {
1745 s = expargs[i];
1746 if (s != NULL)
1747 {
1748 int start, end, domain;
1749 uschar *error;
1750 uschar *ss = parse_extract_address(s, &error, &start, &end, &domain,
1751 FALSE);
1752 if (ss != NULL)
1753 expargs[i] = ((filter_options & RDO_REWRITE) != 0)?
1754 rewrite_address(ss, TRUE, FALSE, global_rewrite_rules,
1755 rewrite_existflags) :
1756 rewrite_address_qualify(ss, TRUE);
1757 else
1758 {
1759 *error_pointer = string_sprintf("malformed address \"%s\" in "
1760 "filter file: %s", s, error);
1761 return FF_ERROR;
1762 }
1763 }
1764 }
059ec3d9 1765
f3ebb786
JH
1766 /* Stick the errors address into a simple variable, as it will
1767 be referenced a few times. Check that the caller is permitted to
1768 specify it. */
059ec3d9 1769
f3ebb786 1770 s = expargs[1];
059ec3d9 1771
f3ebb786
JH
1772 if (s != NULL && !f.system_filtering)
1773 {
1774 uschar *ownaddress = expand_string(US"$local_part@$domain");
1775 if (strcmpic(ownaddress, s) != 0)
1776 {
1777 *error_pointer = US"errors_to must point to the caller's address";
1778 return FF_ERROR;
1779 }
1780 }
059ec3d9 1781
f3ebb786 1782 /* Test case: report what would happen */
059ec3d9 1783
f3ebb786
JH
1784 if (filter_test != FTEST_NONE)
1785 {
1786 indent();
1787 printf("%seliver message to: %s%s%s%s\n",
1788 (commands->seen)? "D" : "Unseen d",
1789 expargs[0],
1790 commands->noerror? " (noerror)" : "",
1791 (s != NULL)? " errors_to " : "",
1792 (s != NULL)? s : US"");
1793 }
059ec3d9 1794
f3ebb786 1795 /* Real case. */
059ec3d9 1796
f3ebb786
JH
1797 else
1798 {
1799 DEBUG(D_filter) debug_printf_indent("Filter: %sdeliver message to: %s%s%s%s\n",
1800 (commands->seen)? "" : "unseen ",
1801 expargs[0],
1802 commands->noerror? " (noerror)" : "",
1803 (s != NULL)? " errors_to " : "",
1804 (s != NULL)? s : US"");
1805
1806 /* Create the new address and add it to the chain, setting the
1807 af_ignore_error flag if necessary, and the errors address, which can be
1808 set in a system filter and to the local address in user filters. */
1809
1810 addr = deliver_make_addr(expargs[0], TRUE); /* TRUE => copy s */
1811 addr->prop.errors_address = (s == NULL)?
1812 s : string_copy(s); /* Default is NULL */
1813 if (commands->noerror) addr->prop.ignore_error = TRUE;
1814 addr->next = *generated;
1815 *generated = addr;
1816 }
1817 break;
059ec3d9
PH
1818
1819 case save_command:
f3ebb786
JH
1820 s = expargs[0];
1821 mode = commands->args[1].i;
059ec3d9 1822
f3ebb786 1823 /* Test case: report what would happen */
059ec3d9 1824
f3ebb786
JH
1825 if (filter_test != FTEST_NONE)
1826 {
1827 indent();
1828 if (mode < 0)
1829 printf("%save message to: %s%s\n", (commands->seen)?
1830 "S" : "Unseen s", s, commands->noerror? " (noerror)" : "");
1831 else
1832 printf("%save message to: %s %04o%s\n", (commands->seen)?
1833 "S" : "Unseen s", s, mode, commands->noerror? " (noerror)" : "");
1834 }
059ec3d9 1835
f3ebb786
JH
1836 /* Real case: Ensure save argument starts with / if there is a home
1837 directory to prepend. */
059ec3d9 1838
f3ebb786
JH
1839 else
1840 {
1841 if (s[0] != '/' && (filter_options & RDO_PREPEND_HOME) != 0 &&
1842 deliver_home != NULL && deliver_home[0] != 0)
1843 s = string_sprintf("%s/%s", deliver_home, s);
1844 DEBUG(D_filter) debug_printf_indent("Filter: %ssave message to: %s%s\n",
1845 (commands->seen)? "" : "unseen ", s,
1846 commands->noerror? " (noerror)" : "");
1847
1848 /* Create the new address and add it to the chain, setting the
1849 af_pfr and af_file flags, the af_ignore_error flag if necessary, and the
1850 mode value. */
1851
1852 addr = deliver_make_addr(s, TRUE); /* TRUE => copy s */
1853 setflag(addr, af_pfr);
1854 setflag(addr, af_file);
1855 if (commands->noerror) addr->prop.ignore_error = TRUE;
1856 addr->mode = mode;
1857 addr->next = *generated;
1858 *generated = addr;
1859 }
1860 break;
059ec3d9
PH
1861
1862 case pipe_command:
f3ebb786
JH
1863 s = string_copy(commands->args[0].u);
1864 if (filter_test != FTEST_NONE)
1865 {
1866 indent();
1867 printf("%sipe message to: %s%s\n", (commands->seen)?
1868 "P" : "Unseen p", s, commands->noerror? " (noerror)" : "");
1869 }
1870 else /* Ensure pipe command starts with | */
1871 {
1872 DEBUG(D_filter) debug_printf_indent("Filter: %spipe message to: %s%s\n",
1873 commands->seen ? "" : "unseen ", s,
1874 commands->noerror ? " (noerror)" : "");
1875 if (s[0] != '|') s = string_sprintf("|%s", s);
059ec3d9 1876
f3ebb786
JH
1877 /* Create the new address and add it to the chain, setting the
1878 af_ignore_error flag if necessary. Set the af_expand_pipe flag so that
1879 each command argument is expanded in the transport after the command
1880 has been split up into separate arguments. */
1881
1882 addr = deliver_make_addr(s, TRUE); /* TRUE => copy s */
1883 setflag(addr, af_pfr);
1884 setflag(addr, af_expand_pipe);
1885 if (commands->noerror) addr->prop.ignore_error = TRUE;
1886 addr->next = *generated;
1887 *generated = addr;
1888
1889 /* If there are any numeric variables in existence (e.g. after a regex
1890 condition), or if $thisaddress is set, take a copy for use in the
1891 expansion. Note that we can't pass NULL for filter_thisaddress, because
1892 NULL terminates the list. */
1893
1894 if (expand_nmax >= 0 || filter_thisaddress != NULL)
1895 {
1896 int ecount = expand_nmax >= 0 ? expand_nmax : -1;
1897 uschar **ss = store_get(sizeof(uschar *) * (ecount + 3), FALSE);
1898
1899 addr->pipe_expandn = ss;
1900 if (!filter_thisaddress) filter_thisaddress = US"";
1901 *ss++ = string_copy(filter_thisaddress);
1902 for (int i = 0; i <= expand_nmax; i++)
1903 *ss++ = string_copyn(expand_nstring[i], expand_nlength[i]);
1904 *ss = NULL;
1905 }
1906 }
1907 break;
1908
1909 /* Set up the file name and mode, and close any previously open
1910 file. */
059ec3d9
PH
1911
1912 case logfile_command:
f3ebb786
JH
1913 log_mode = commands->args[1].i;
1914 if (log_mode == -1) log_mode = 0600;
1915 if (log_fd >= 0)
1916 {
1917 (void)close(log_fd);
1918 log_fd = -1;
1919 }
1920 log_filename = expargs[0];
1921 if (filter_test != FTEST_NONE)
1922 {
1923 indent();
1924 printf("%sogfile %s\n", (commands->seen)? "Seen l" : "L", log_filename);
1925 }
1926 break;
059ec3d9
PH
1927
1928 case logwrite_command:
f3ebb786 1929 s = expargs[0];
059ec3d9 1930
f3ebb786
JH
1931 if (filter_test != FTEST_NONE)
1932 {
1933 indent();
1934 printf("%sogwrite \"%s\"\n", (commands->seen)? "Seen l" : "L",
1935 string_printing(s));
1936 }
059ec3d9 1937
f3ebb786
JH
1938 /* Attempt to write to a log file only if configured as permissible.
1939 Logging may be forcibly skipped for verifying or testing. */
059ec3d9 1940
f3ebb786
JH
1941 else if ((filter_options & RDO_LOG) != 0) /* Locked out */
1942 {
1943 DEBUG(D_filter)
1944 debug_printf_indent("filter log command aborted: euid=%ld\n",
1945 (long int)geteuid());
1946 *error_pointer = US"logwrite command forbidden";
1947 return FF_ERROR;
1948 }
1949 else if ((filter_options & RDO_REALLOG) != 0)
1950 {
1951 int len;
1952 DEBUG(D_filter) debug_printf_indent("writing filter log as euid %ld\n",
1953 (long int)geteuid());
1954 if (log_fd < 0)
1955 {
1956 if (log_filename == NULL)
1957 {
1958 *error_pointer = US"attempt to obey \"logwrite\" command "
1959 "without a previous \"logfile\"";
1960 return FF_ERROR;
1961 }
1962 log_fd = Uopen(log_filename, O_CREAT|O_APPEND|O_WRONLY, log_mode);
1963 if (log_fd < 0)
1964 {
1965 *error_pointer = string_open_failed(errno, "filter log file \"%s\"",
1966 log_filename);
1967 return FF_ERROR;
1968 }
1969 }
1970 len = Ustrlen(s);
1971 if (write(log_fd, s, len) != len)
1972 {
1973 *error_pointer = string_sprintf("write error on file \"%s\": %s",
1974 log_filename, strerror(errno));
1975 return FF_ERROR;
1976 }
1977 }
1978 else
1979 {
1980 DEBUG(D_filter) debug_printf_indent("skipping logwrite (verifying or testing)\n");
1981 }
1982 break;
059ec3d9 1983
f3ebb786
JH
1984 /* Header addition and removal is available only in the system filter. The
1985 command is rejected at parse time otherwise. However "headers charset" is
1986 always permitted. */
059ec3d9
PH
1987
1988 case headers_command:
f3ebb786
JH
1989 {
1990 int subtype = commands->args[1].i;
1991 s = expargs[0];
059ec3d9 1992
f3ebb786
JH
1993 if (filter_test != FTEST_NONE)
1994 printf("Headers %s \"%s\"\n", (subtype == TRUE)? "add" :
1995 (subtype == FALSE)? "remove" : "charset", string_printing(s));
059ec3d9 1996
f3ebb786
JH
1997 if (subtype == TRUE)
1998 {
1999 while (isspace(*s)) s++;
2000 if (s[0] != 0)
2001 {
2002 header_add(htype_other, "%s%s", s, (s[Ustrlen(s)-1] == '\n')?
2003 "" : "\n");
2004 header_last->type = header_checkname(header_last, FALSE);
2005 if (header_last->type >= 'a') header_last->type = htype_other;
2006 }
2007 }
059ec3d9 2008
f3ebb786
JH
2009 else if (subtype == FALSE)
2010 {
2011 int sep = 0;
2012 uschar *ss;
2013 const uschar *list = s;
2014 uschar buffer[128];
2015 while ((ss = string_nextinlist(&list, &sep, buffer, sizeof(buffer)))
2016 != NULL)
2017 header_remove(0, ss);
2018 }
059ec3d9 2019
f3ebb786
JH
2020 /* This setting lasts only while the filter is running; on exit, the
2021 variable is reset to the previous value. */
059ec3d9 2022
f3ebb786
JH
2023 else headers_charset = s;
2024 }
2025 break;
059ec3d9 2026
f3ebb786
JH
2027 /* Defer, freeze, and fail are available only when explicitly permitted.
2028 These commands are rejected at parse time otherwise. The message can get
2029 very long by the inclusion of message headers; truncate if it is, and also
2030 ensure printing characters so as not to mess up log files. */
059ec3d9
PH
2031
2032 case defer_command:
f3ebb786
JH
2033 ff_name = US"defer";
2034 ff_ret = FF_DEFER;
2035 goto DEFERFREEZEFAIL;
059ec3d9
PH
2036
2037 case fail_command:
f3ebb786
JH
2038 ff_name = US"fail";
2039 ff_ret = FF_FAIL;
2040 goto DEFERFREEZEFAIL;
059ec3d9
PH
2041
2042 case freeze_command:
f3ebb786
JH
2043 ff_name = US"freeze";
2044 ff_ret = FF_FREEZE;
059ec3d9 2045
f3ebb786
JH
2046 DEFERFREEZEFAIL:
2047 fmsg = expargs[0];
2048 if (Ustrlen(fmsg) > 1024) Ustrcpy(fmsg + 1000, US" ... (truncated)");
2049 fmsg = US string_printing(fmsg);
2050 *error_pointer = fmsg;
059ec3d9 2051
f3ebb786
JH
2052 if (filter_test != FTEST_NONE)
2053 {
2054 indent();
2055 printf("%c%s text \"%s\"\n", toupper(ff_name[0]), ff_name+1, fmsg);
2056 }
2057 else DEBUG(D_filter) debug_printf_indent("Filter: %s \"%s\"\n", ff_name, fmsg);
2058 return ff_ret;
059ec3d9
PH
2059
2060 case finish_command:
f3ebb786
JH
2061 if (filter_test != FTEST_NONE)
2062 {
2063 indent();
2064 printf("%sinish\n", (commands->seen)? "Seen f" : "F");
2065 }
2066 else
2067 {
2068 DEBUG(D_filter) debug_printf_indent("Filter: %sfinish\n",
2069 (commands->seen)? " Seen " : "");
2070 }
2071 finish_obeyed = TRUE;
2072 return filter_delivered? FF_DELIVERED : FF_NOTDELIVERED;
059ec3d9
PH
2073
2074 case if_command:
f3ebb786
JH
2075 {
2076 uschar *save_address = filter_thisaddress;
2077 int ok = FF_DELIVERED;
2078 condition_value = test_condition(commands->args[0].c, TRUE);
2079 if (*error_pointer != NULL) ok = FF_ERROR; else
2080 {
2081 output_indent += 2;
2082 ok = interpret_commands(commands->args[condition_value? 1:2].f,
2083 generated);
2084 output_indent -= 2;
2085 }
2086 filter_thisaddress = save_address;
2087 if (finish_obeyed || (ok != FF_DELIVERED && ok != FF_NOTDELIVERED))
2088 return ok;
2089 }
2090 break;
059ec3d9
PH
2091
2092
f3ebb786
JH
2093 /* To try to catch runaway loops, do not generate mail if the
2094 return path is unset or if a non-trusted user supplied -f <>
2095 as the return path. */
059ec3d9
PH
2096
2097 case mail_command:
2098 case vacation_command:
f3ebb786
JH
2099 if (return_path == NULL || return_path[0] == 0)
2100 {
2101 if (filter_test != FTEST_NONE)
2102 printf("%s command ignored because return_path is empty\n",
2103 command_list[commands->command]);
2104 else DEBUG(D_filter) debug_printf_indent("%s command ignored because return_path "
2105 "is empty\n", command_list[commands->command]);
2106 break;
2107 }
acec9514 2108
f3ebb786
JH
2109 /* Check the contents of the strings. The type of string can be deduced
2110 from the value of i.
acec9514 2111
f3ebb786
JH
2112 . If i is equal to mailarg_index_text it's a text string for the body,
2113 where anything goes.
acec9514 2114
f3ebb786
JH
2115 . If i is > mailarg_index_text, we are dealing with a file name, which
2116 cannot contain non-printing characters.
acec9514 2117
f3ebb786
JH
2118 . If i is less than mailarg_index_headers we are dealing with something
2119 that will go in a single message header line, where newlines must be
2120 followed by white space.
acec9514 2121
f3ebb786
JH
2122 . If i is equal to mailarg_index_headers, we have a string that contains
2123 one or more headers. Newlines that are not followed by white space must
2124 be followed by a header name.
2125 */
acec9514 2126
f3ebb786
JH
2127 for (i = 0; i < MAILARGS_STRING_COUNT; i++)
2128 {
2129 uschar *p;
2130 uschar *s = expargs[i];
acec9514 2131
f3ebb786 2132 if (s == NULL) continue;
acec9514 2133
f3ebb786 2134 if (i != mailarg_index_text) for (p = s; *p != 0; p++)
acec9514 2135 {
f3ebb786
JH
2136 int c = *p;
2137 if (i > mailarg_index_text)
acec9514 2138 {
f3ebb786
JH
2139 if (!mac_isprint(c))
2140 {
2141 *error_pointer = string_sprintf("non-printing character in \"%s\" "
2142 "in %s command", string_printing(s),
2143 command_list[commands->command]);
2144 return FF_ERROR;
2145 }
acec9514 2146 }
acec9514 2147
f3ebb786 2148 /* i < mailarg_index_text */
acec9514 2149
f3ebb786 2150 else if (c == '\n' && !isspace(p[1]))
acec9514 2151 {
f3ebb786
JH
2152 if (i < mailarg_index_headers)
2153 {
2154 *error_pointer = string_sprintf("\\n not followed by space in "
2155 "\"%.1024s\" in %s command", string_printing(s),
2156 command_list[commands->command]);
2157 return FF_ERROR;
2158 }
acec9514 2159
f3ebb786 2160 /* Check for the start of a new header line within the string */
acec9514 2161
f3ebb786 2162 else
acec9514 2163 {
f3ebb786
JH
2164 uschar *pp;
2165 for (pp = p + 1;; pp++)
acec9514 2166 {
f3ebb786
JH
2167 c = *pp;
2168 if (c == ':' && pp != p + 1) break;
2169 if (c == 0 || c == ':' || isspace(*pp))
2170 {
2171 *error_pointer = string_sprintf("\\n not followed by space or "
2172 "valid header name in \"%.1024s\" in %s command",
2173 string_printing(s), command_list[commands->command]);
2174 return FF_ERROR;
2175 }
acec9514 2176 }
f3ebb786 2177 p = pp;
acec9514 2178 }
acec9514 2179 }
f3ebb786 2180 } /* Loop to scan the string */
acec9514 2181
f3ebb786 2182 /* The string is OK */
acec9514 2183
f3ebb786 2184 commands->args[i].u = s;
acec9514 2185 }
acec9514 2186
f3ebb786 2187 /* Proceed with mail or vacation command */
acec9514 2188
f3ebb786 2189 if (filter_test != FTEST_NONE)
acec9514 2190 {
f3ebb786
JH
2191 uschar *to = commands->args[mailarg_index_to].u;
2192 indent();
2193 printf("%sail to: %s%s%s\n", (commands->seen)? "Seen m" : "M",
2194 to ? to : US"<default>",
acec9514
JH
2195 commands->command == vacation_command ? " (vacation)" : "",
2196 commands->noerror ? " (noerror)" : "");
2197 for (i = 1; i < MAILARGS_STRING_COUNT; i++)
2198 {
2199 uschar *arg = commands->args[i].u;
f3ebb786 2200 if (arg)
acec9514
JH
2201 {
2202 int len = Ustrlen(mailargs[i]);
f3ebb786
JH
2203 int indent = (debug_selector != 0)? output_indent : 0;
2204 while (len++ < 7 + indent) printf(" ");
2205 printf("%s: %s%s\n", mailargs[i], string_printing(arg),
acec9514
JH
2206 (commands->args[mailarg_index_expand].u != NULL &&
2207 Ustrcmp(mailargs[i], "file") == 0)? " (expanded)" : "");
2208 }
2209 }
f3ebb786
JH
2210 if (commands->args[mailarg_index_return].u)
2211 printf("Return original message\n");
acec9514 2212 }
f3ebb786 2213 else
acec9514 2214 {
f3ebb786
JH
2215 uschar *tt;
2216 uschar *to = commands->args[mailarg_index_to].u;
2217 gstring * log_addr = NULL;
acec9514 2218
f3ebb786
JH
2219 if (!to) to = expand_string(US"$reply_address");
2220 while (isspace(*to)) to++;
acec9514 2221
f3ebb786
JH
2222 for (tt = to; *tt != 0; tt++) /* Get rid of newlines */
2223 if (*tt == '\n') *tt = ' ';
acec9514 2224
f3ebb786 2225 DEBUG(D_filter)
acec9514 2226 {
f3ebb786
JH
2227 debug_printf_indent("Filter: %smail to: %s%s%s\n",
2228 commands->seen ? "seen " : "",
2229 to,
2230 commands->command == vacation_command ? " (vacation)" : "",
2231 commands->noerror ? " (noerror)" : "");
2232 for (i = 1; i < MAILARGS_STRING_COUNT; i++)
2233 {
2234 uschar *arg = commands->args[i].u;
2235 if (arg != NULL)
2236 {
2237 int len = Ustrlen(mailargs[i]);
2238 while (len++ < 15) debug_printf_indent(" ");
2239 debug_printf_indent("%s: %s%s\n", mailargs[i], string_printing(arg),
2240 (commands->args[mailarg_index_expand].u != NULL &&
2241 Ustrcmp(mailargs[i], "file") == 0)? " (expanded)" : "");
2242 }
2243 }
acec9514
JH
2244 }
2245
f3ebb786
JH
2246 /* Create the "address" for the autoreply. This is used only for logging,
2247 as the actual recipients are extracted from the To: line by -t. We use the
2248 same logic here to extract the working addresses (there may be more than
2249 one). Just in case there are a vast number of addresses, stop when the
2250 string gets too long. */
acec9514 2251
f3ebb786
JH
2252 tt = to;
2253 while (*tt != 0)
acec9514 2254 {
f3ebb786
JH
2255 uschar *ss = parse_find_address_end(tt, FALSE);
2256 uschar *recipient, *errmess;
2257 int start, end, domain;
2258 int temp = *ss;
acec9514 2259
f3ebb786
JH
2260 *ss = 0;
2261 recipient = parse_extract_address(tt, &errmess, &start, &end, &domain,
2262 FALSE);
2263 *ss = temp;
acec9514 2264
f3ebb786
JH
2265 /* Ignore empty addresses and errors; an error will occur later if
2266 there's something really bad. */
acec9514 2267
f3ebb786
JH
2268 if (recipient)
2269 {
2270 log_addr = string_catn(log_addr, log_addr ? US"," : US">", 1);
2271 log_addr = string_cat (log_addr, recipient);
2272 }
acec9514 2273
f3ebb786 2274 /* Check size */
acec9514 2275
f3ebb786
JH
2276 if (log_addr && log_addr->ptr > 256)
2277 {
2278 log_addr = string_catn(log_addr, US", ...", 5);
2279 break;
2280 }
2281
2282 /* Move on past this address */
2283
2284 tt = ss + (*ss ? 1 : 0);
2285 while (isspace(*tt)) tt++;
2286 }
2287
2288 if (log_addr)
2289 addr = deliver_make_addr(string_from_gstring(log_addr), FALSE);
2290 else
acec9514 2291 {
f3ebb786
JH
2292 addr = deliver_make_addr(US ">**bad-reply**", FALSE);
2293 setflag(addr, af_bad_reply);
acec9514 2294 }
acec9514 2295
f3ebb786
JH
2296 setflag(addr, af_pfr);
2297 if (commands->noerror) addr->prop.ignore_error = TRUE;
2298 addr->next = *generated;
2299 *generated = addr;
2300
2301 addr->reply = store_get(sizeof(reply_item), FALSE);
2302 addr->reply->from = NULL;
2303 addr->reply->to = string_copy(to);
2304 addr->reply->file_expand =
2305 commands->args[mailarg_index_expand].u != NULL;
2306 addr->reply->expand_forbid = expand_forbid;
2307 addr->reply->return_message =
2308 commands->args[mailarg_index_return].u != NULL;
2309 addr->reply->once_repeat = 0;
2310
2311 if (commands->args[mailarg_index_once_repeat].u != NULL)
2312 {
2313 addr->reply->once_repeat =
2314 readconf_readtime(commands->args[mailarg_index_once_repeat].u, 0,
2315 FALSE);
2316 if (addr->reply->once_repeat < 0)
2317 {
2318 *error_pointer = string_sprintf("Bad time value for \"once_repeat\" "
2319 "in mail or vacation command: %s",
2320 commands->args[mailarg_index_once_repeat].u);
2321 return FF_ERROR;
2322 }
2323 }
acec9514 2324
f3ebb786
JH
2325 /* Set up all the remaining string arguments (those other than "to") */
2326
2327 for (i = 1; i < mailargs_string_passed; i++)
2328 {
2329 uschar *ss = commands->args[i].u;
2330 *(USS((US addr->reply) + reply_offsets[i])) =
2331 ss ? string_copy(ss) : NULL;
2332 }
acec9514 2333 }
f3ebb786 2334 break;
059ec3d9
PH
2335
2336 case testprint_command:
f3ebb786
JH
2337 if (filter_test != FTEST_NONE || (debug_selector & D_filter) != 0)
2338 {
2339 const uschar *s = string_printing(expargs[0]);
2340 if (filter_test == FTEST_NONE)
2341 debug_printf_indent("Filter: testprint: %s\n", s);
2342 else
2343 printf("Testprint: %s\n", s);
2344 }
059ec3d9
PH
2345 }
2346
2347 commands = commands->next;
2348 }
2349
2350return filter_delivered? FF_DELIVERED : FF_NOTDELIVERED;
2351}
2352
2353
2354
2355/*************************************************
2356* Test for a personal message *
2357*************************************************/
2358
2359/* This function is global so that it can also be called from the code that
2360implements Sieve filters.
2361
2362Arguments:
2363 aliases a chain of aliases
2364 scan_cc TRUE if Cc: and Bcc: are to be scanned (Exim filters do not)
2365
2366Returns: TRUE if the message is deemed to be personal
2367*/
2368
2369BOOL
2370filter_personal(string_item *aliases, BOOL scan_cc)
2371{
2372uschar *self, *self_from, *self_to;
2373uschar *psself = NULL, *psself_from = NULL, *psself_to = NULL;
f3ebb786 2374rmark reset_point = store_mark();
059ec3d9
PH
2375BOOL yield;
2376header_line *h;
2377int to_count = 2;
2378int from_count = 9;
2379
4b233853
PH
2380/* If any header line in the message is a defined "List-" header field, it is
2381not a personal message. We used to check for any header line that started with
2382"List-", but this was tightened up for release 4.54. The check is now for
2383"List-Id", defined in RFC 2929, or "List-Help", "List-Subscribe", "List-
2384Unsubscribe", "List-Post", "List-Owner" or "List-Archive", all of which are
2385defined in RFC 2369. We also scan for "Auto-Submitted"; if it is found to
2386contain any value other than "no", the message is not personal (RFC 3834).
2387Previously the test was for "auto-". */
059ec3d9 2388
f3ebb786 2389for (h = header_list; h; h = h->next)
059ec3d9 2390 {
4b233853
PH
2391 uschar *s;
2392 if (h->type == htype_old) continue;
2393
2394 if (strncmpic(h->text, US"List-", 5) == 0)
2395 {
2396 s = h->text + 5;
2397 if (strncmpic(s, US"Id:", 3) == 0 ||
2398 strncmpic(s, US"Help:", 5) == 0 ||
2399 strncmpic(s, US"Subscribe:", 10) == 0 ||
2400 strncmpic(s, US"Unsubscribe:", 12) == 0 ||
2401 strncmpic(s, US"Post:", 5) == 0 ||
2402 strncmpic(s, US"Owner:", 6) == 0 ||
2403 strncmpic(s, US"Archive:", 8) == 0)
2404 return FALSE;
2405 }
2406
2407 else if (strncmpic(h->text, US"Auto-submitted:", 15) == 0)
2408 {
2409 s = h->text + 15;
2410 while (isspace(*s)) s++;
2411 if (strncmpic(s, US"no", 2) != 0) return FALSE;
2412 s += 2;
2413 while (isspace(*s)) s++;
2414 if (*s != 0) return FALSE;
2415 }
059ec3d9
PH
2416 }
2417
2418/* Set up "my" address */
2419
2420self = string_sprintf("%s@%s", deliver_localpart, deliver_domain);
2421self_from = rewrite_one(self, rewrite_from, NULL, FALSE, US"",
2422 global_rewrite_rules);
2423self_to = rewrite_one(self, rewrite_to, NULL, FALSE, US"",
2424 global_rewrite_rules);
2425
2426
2427if (self_from == NULL) self_from = self;
2428if (self_to == NULL) self_to = self;
2429
2430/* If there's a prefix or suffix set, we must include the prefixed/
2431suffixed version of the local part in the tests. */
2432
2433if (deliver_localpart_prefix != NULL || deliver_localpart_suffix != NULL)
2434 {
2435 psself = string_sprintf("%s%s%s@%s",
2436 (deliver_localpart_prefix == NULL)? US"" : deliver_localpart_prefix,
2437 deliver_localpart,
2438 (deliver_localpart_suffix == NULL)? US"" : deliver_localpart_suffix,
2439 deliver_domain);
2440 psself_from = rewrite_one(psself, rewrite_from, NULL, FALSE, US"",
2441 global_rewrite_rules);
2442 psself_to = rewrite_one(psself, rewrite_to, NULL, FALSE, US"",
2443 global_rewrite_rules);
2444 if (psself_from == NULL) psself_from = psself;
2445 if (psself_to == NULL) psself_to = psself;
2446 to_count += 2;
2447 from_count += 2;
2448 }
2449
2450/* Do all the necessary tests; the counts are adjusted for {pre,suf}fix */
2451
2452yield =
2453 (
2454 header_match(US"to:", TRUE, TRUE, aliases, to_count, self, self_to, psself,
2455 psself_to) ||
2456 (scan_cc &&
2457 (
2458 header_match(US"cc:", TRUE, TRUE, aliases, to_count, self, self_to,
2459 psself, psself_to)
2460 ||
2461 header_match(US"bcc:", TRUE, TRUE, aliases, to_count, self, self_to,
2462 psself, psself_to)
2463 )
2464 )
2465 ) &&
2466
2467 header_match(US"from:", TRUE, FALSE, aliases, from_count, "^server@",
2468 "^daemon@", "^root@", "^listserv@", "^majordomo@", "^.*?-request@",
2469 "^owner-[^@]+@", self, self_from, psself, psself_from) &&
2470
059ec3d9
PH
2471 header_match(US"precedence:", FALSE, FALSE, NULL, 3, "bulk","list","junk") &&
2472
2473 (sender_address == NULL || sender_address[0] != 0);
2474
2475store_reset(reset_point);
2476return yield;
2477}
2478
2479
2480
2481/*************************************************
2482* Interpret a mail filter file *
2483*************************************************/
2484
2485/*
2486Arguments:
2487 filter points to the entire file, read into store as a single string
2488 options controls whether various special things are allowed, and requests
2489 special actions
2490 generated where to hang newly-generated addresses
2491 error where to pass back an error text
2492
2493Returns: FF_DELIVERED success, a significant action was taken
2494 FF_NOTDELIVERED success, no significant action
2495 FF_DEFER defer requested
2496 FF_FAIL fail requested
2497 FF_FREEZE freeze requested
2498 FF_ERROR there was a problem
2499*/
2500
2501int
2502filter_interpret(uschar *filter, int options, address_item **generated,
2503 uschar **error)
2504{
2505int i;
2506int yield = FF_ERROR;
2507uschar *ptr = filter;
2508uschar *save_headers_charset = headers_charset;
2509filter_cmd *commands = NULL;
2510filter_cmd **lastcmdptr = &commands;
2511
2512DEBUG(D_route) debug_printf("Filter: start of processing\n");
f3ebb786 2513acl_level++;
059ec3d9
PH
2514
2515/* Initialize "not in an if command", set the global flag that is always TRUE
2516while filtering, and zero the variables. */
2517
2518expect_endif = 0;
2519output_indent = 0;
8768d548 2520f.filter_running = TRUE;
059ec3d9
PH
2521for (i = 0; i < FILTER_VARIABLE_COUNT; i++) filter_n[i] = 0;
2522
2523/* To save having to pass certain values about all the time, make them static.
2524Also initialize the line number, for error messages, and the log file
2525variables. */
2526
2527filter_options = options;
2528filter_delivered = FALSE;
2529finish_obeyed = FALSE;
2530error_pointer = error;
2531*error_pointer = NULL;
2532line_number = 1;
2533log_fd = -1;
2534log_mode = 0600;
2535log_filename = NULL;
2536
2537/* Scan filter file for syntax and build up an interpretation thereof, and
2538interpret the compiled commands, and if testing, say whether we ended up
2539delivered or not, unless something went wrong. */
2540
2541seen_force = FALSE;
2542ptr = nextsigchar(ptr, TRUE);
2543
2544if (read_command_list(&ptr, &lastcmdptr, FALSE))
2545 yield = interpret_commands(commands, generated);
2546
f05da2e8 2547if (filter_test != FTEST_NONE || (debug_selector & D_filter) != 0)
059ec3d9
PH
2548 {
2549 uschar *s = US"";
2550 switch(yield)
2551 {
2552 case FF_DEFER:
f3ebb786
JH
2553 s = US"Filtering ended by \"defer\".";
2554 break;
059ec3d9
PH
2555
2556 case FF_FREEZE:
f3ebb786
JH
2557 s = US"Filtering ended by \"freeze\".";
2558 break;
059ec3d9
PH
2559
2560 case FF_FAIL:
f3ebb786
JH
2561 s = US"Filtering ended by \"fail\".";
2562 break;
059ec3d9
PH
2563
2564 case FF_DELIVERED:
f3ebb786
JH
2565 s = US"Filtering set up at least one significant delivery "
2566 "or other action.\n"
2567 "No other deliveries will occur.";
2568 break;
059ec3d9
PH
2569
2570 case FF_NOTDELIVERED:
f3ebb786
JH
2571 s = US"Filtering did not set up a significant delivery.\n"
2572 "Normal delivery will occur.";
2573 break;
059ec3d9
PH
2574
2575 case FF_ERROR:
f3ebb786
JH
2576 s = string_sprintf("Filter error: %s", *error);
2577 break;
059ec3d9
PH
2578 }
2579
f05da2e8 2580 if (filter_test != FTEST_NONE) printf("%s\n", CS s);
f3ebb786 2581 else debug_printf_indent("%s\n", s);
059ec3d9
PH
2582 }
2583
2584/* Close the log file if it was opened, and kill off any numerical variables
2585before returning. Reset the header decoding charset. */
2586
f1e894f3 2587if (log_fd >= 0) (void)close(log_fd);
059ec3d9 2588expand_nmax = -1;
8768d548 2589f.filter_running = FALSE;
059ec3d9
PH
2590headers_charset = save_headers_charset;
2591
f3ebb786 2592acl_level--;
059ec3d9
PH
2593DEBUG(D_route) debug_printf("Filter: end of processing\n");
2594return yield;
2595}
2596
2597
2598/* End of filter.c */