Remove references to PCRE documentation no longer supplied with Exim.
[exim.git] / src / src / sieve.c
index 656b972477626fa95c8690684abb8fa774179002..f96db358651561a7f9c0eff6d115bddb71869ebf 100644 (file)
@@ -1,10 +1,10 @@
-/* $Cambridge: exim/src/src/sieve.c,v 1.31 2007/09/28 12:21:57 tom Exp $ */
+/* $Cambridge: exim/src/src/sieve.c,v 1.34 2008/01/29 12:08:43 michael Exp $ */
 
 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
-/* Copyright (c) Michael Haardt 2003-2007 */
+/* Copyright (c) Michael Haardt 2003-2008 */
 /* See the file NOTICE for conditions of use and distribution. */
 
 /* This code was contributed by Michael Haardt. */
@@ -147,6 +147,8 @@ static uschar str_online_c[]="online";
 static const struct String str_online={ str_online_c, 6 };
 static uschar str_maybe_c[]="maybe";
 static const struct String str_maybe={ str_maybe_c, 5 };
+static uschar str_auto_submitted_c[]="Auto-Submitted";
+static const struct String str_auto_submitted={ str_auto_submitted_c, 14 };
 #endif
 #ifdef SUBADDRESS
 static uschar str_subaddress_c[]="subaddress";
@@ -487,7 +489,8 @@ if (*uri=='?')
         {US"date",4},
         {US"from",4},
         {US"message-id",10},
-        {US"received",8}
+        {US"received",8},
+        {US"auto-submitted",14}
         };
       static struct String *end=ignore+sizeof(ignore)/sizeof(ignore[0]);
       struct String *i;
@@ -608,8 +611,10 @@ return (match_prefix ? nl==0 : nl==0 && hl==0);
 
 /*
 Arguments:
-  needle      pattern to search ...
-  haystack    ... inside the haystack
+  needle          pattern to search ...
+  haystack        ... inside the haystack
+  ascii_caseless  ignore ASCII case
+  match_octet     match octets, not UTF-8 multi-octet characters
 
 Returns:      0               needle not found in haystack
               1               needle found
@@ -999,7 +1004,7 @@ return quoted;
 *************************************************/
 
 /*
-According to RFC 3028, duplicate delivery to the same address must
+According to RFC 5228, duplicate delivery to the same address must
 not happen, so the list is first searched for the address.
 
 Arguments:
@@ -1934,7 +1939,7 @@ Grammar:
 Arguments:
   filter      points to the Sieve filter including its state
   n           total number of tests
-  true        number of passed tests
+  num_true    number of passed tests
   exec        Execute parsed statements
 
 Returns:      1                success
@@ -2942,7 +2947,9 @@ while (*filter->pc)
     struct String header;
     struct String subject;
     struct String body;
-    uschar *envelope_from,*envelope_to;
+    uschar *envelope_from;
+    struct String auto_submitted_value;
+    uschar *auto_submitted_def;
 
     if (!filter->require_enotify)
       {
@@ -2963,8 +2970,7 @@ while (*filter->pc)
     subject.character=(uschar*)0;
     body.length=-1;
     body.character=(uschar*)0;
-    envelope_from=expand_string("$sender_address");
-    envelope_to=expand_string("$local_part_prefix$local_part$local_part_suffix@$domain");
+    envelope_from=(sender_address && sender_address[0]) ? expand_string("$local_part_prefix$local_part$local_part_suffix@$domain") : US "";
     for (;;)
       {
       if (parse_white(filter)==-1) return -1;
@@ -3015,75 +3021,95 @@ while (*filter->pc)
     if (parse_semicolon(filter)==-1) return -1;
     if (parse_mailto_uri(filter,method.character,&recipient,&header,&subject,&body)!=1)
       return -1;
-    if (message.length==-1) message=subject;
-    if (message.length==-1) expand_header(&message,&str_subject);
-
-    for (already=filter->notified; already; already=already->next)
-      {
-      if (already->method.length==method.length
-          && (method.length==-1 || strcmp(already->method.character,method.character)==0)
-          && already->importance.length==importance.length
-          && (importance.length==-1 || strcmp(already->importance.character,importance.character)==0)
-          && already->message.length==message.length
-          && (message.length==-1 || strcmp(already->message.character,message.character)==0))
-        break;
-      }
-    if (already==(struct Notification*)0)
-      /* New notification, process it */
+    if (exec)
       {
-      struct Notification *sent;
-      sent=store_get(sizeof(struct Notification));
-      sent->method=method;
-      sent->importance=importance;
-      sent->message=message;
-      sent->next=filter->notified;
-      filter->notified=sent;
-      if ((filter_test != FTEST_NONE && debug_selector != 0) || (debug_selector & D_filter) != 0)
+      if (message.length==-1) message=subject;
+      if (message.length==-1) expand_header(&message,&str_subject);
+      expand_header(&auto_submitted_value,&str_auto_submitted);
+      auto_submitted_def=expand_string(string_sprintf("${if def:header_auto-submitted {true}{false}}"));
+      if (auto_submitted_value.character == NULL || auto_submitted_def == NULL)
         {
-        debug_printf("Notification to `%s': '%s'.\n",method.character,message.length!=-1 ? message.character : CUS "");
+        filter->errmsg=CUS "header string expansion failed";
+        return -1;
         }
-#ifndef COMPILE_SYNTAX_CHECKER
-      if (exec && filter_test == FTEST_NONE)
+        if (Ustrcmp(auto_submitted_def,"true")!=0 || Ustrcmp(auto_submitted_value.character,"no")==0)
         {
-        string_item *p;
-        header_line *h;
-        int pid,fd;
+        for (already=filter->notified; already; already=already->next)
+          {
+          if (already->method.length==method.length
+              && (method.length==-1 || strcmp(already->method.character,method.character)==0)
+              && already->importance.length==importance.length
+              && (importance.length==-1 || strcmp(already->importance.character,importance.character)==0)
+              && already->message.length==message.length
+              && (message.length==-1 || strcmp(already->message.character,message.character)==0))
+            break;
+          }
+        if (already==(struct Notification*)0)
+          /* New notification, process it */
+          {
+          struct Notification *sent;
+          sent=store_get(sizeof(struct Notification));
+          sent->method=method;
+          sent->importance=importance;
+          sent->message=message;
+          sent->next=filter->notified;
+          filter->notified=sent;
+  #ifndef COMPILE_SYNTAX_CHECKER
+          if (filter_test == FTEST_NONE)
+            {
+            string_item *p;
+            header_line *h;
+            int pid,fd;
 
-        if ((pid = child_open_exim2(&fd,envelope_to,envelope_to))>=1)
+            if ((pid = child_open_exim2(&fd,envelope_from,envelope_from))>=1)
+              {
+              FILE *f;
+              uschar *buffer;
+              int buffer_capacity;
+
+              f = fdopen(fd, "wb");
+              for (h = header_list; h != NULL; h = h->next)
+                if (h->type == htype_received) fprintf(f,"%s",h->text);
+              fprintf(f,"From: %s\n",from.length==-1 ? expand_string("$local_part_prefix$local_part$local_part_suffix@$domain") : from.character);
+              for (p=recipient; p; p=p->next) fprintf(f,"To: %s\n",p->text);
+              fprintf(f,"Auto-submitted: sieve-notify\n");
+              if (header.length>0) fprintf(f,"%s",header.character);
+              if (message.length==-1)
+                {
+                message.character=US"Notification";
+                message.length=Ustrlen(message.character);
+                }
+              /* Allocation is larger than neccessary, but enough even for split MIME words */
+              buffer_capacity=32+4*message.length;
+              buffer=store_get(buffer_capacity);
+              if (message.length!=-1) fprintf(f,"Subject: %s\n",parse_quote_2047(message.character, message.length, US"utf-8", buffer, buffer_capacity, TRUE));
+              fprintf(f,"\n");
+              if (body.length>0) fprintf(f,"%s\n",body.character);
+              fflush(f);
+              (void)fclose(f);
+              (void)child_close(pid, 0);
+              }
+            }
+          if ((filter_test != FTEST_NONE && debug_selector != 0) || (debug_selector & D_filter) != 0)
+            {
+            debug_printf("Notification to `%s': '%s'.\n",method.character,message.length!=-1 ? message.character : CUS "");
+            }
+#endif
+          }
+        else
           {
-          FILE *f;
-          uschar *buffer;
-          int buffer_capacity;
-
-          f = fdopen(fd, "wb");
-          for (h = header_list; h != NULL; h = h->next)
-            if (h->type == htype_received) fprintf(f,"%s",h->text);
-          fprintf(f,"From: %s\n",from.length==-1 ? envelope_to : from.character);
-          for (p=recipient; p; p=p->next) fprintf(f,"To: %s\n",p->text);
-          if (header.length>0) fprintf(f,"%s",header.character);
-          if (message.length==-1)
+          if ((filter_test != FTEST_NONE && debug_selector != 0) || (debug_selector & D_filter) != 0)
             {
-            message.character=US"Notification";
-            message.length=Ustrlen(message.character);
+            debug_printf("Repeated notification to `%s' ignored.\n",method.character);
             }
-          /* Allocation is larger than neccessary, but enough even for split MIME words */
-          buffer_capacity=32+4*message.length;
-          buffer=store_get(buffer_capacity);
-          if (message.length!=-1) fprintf(f,"Subject: %s\n",parse_quote_2047(message.character, message.length, US"utf-8", buffer, buffer_capacity, TRUE));
-          fprintf(f,"\n");
-          if (body.length>0) fprintf(f,"%s\n",body.character);
-          fflush(f);
-          (void)fclose(f);
-          (void)child_close(pid, 0);
           }
         }
-#endif
-      }
-    else
-      {
-      if ((filter_test != FTEST_NONE && debug_selector != 0) || (debug_selector & D_filter) != 0)
+      else
         {
-        debug_printf("Repeated notification to `%s' ignored.\n",method.character);
+        if ((filter_test != FTEST_NONE && debug_selector != 0) || (debug_selector & D_filter) != 0)
+          {
+          debug_printf("Ignoring notification, triggering message contains Auto-submitted: field.\n");
+          }
         }
       }
     }