Logging: support +outgoing_port on defer lines and per-host error lines
[exim.git] / src / src / spam.c
index 8817af0cd1f9fff68ccde48d6e2729c4d42a4154..118fcfa8a76b5dcab17a3823dbc61dd6bb46d933 100644 (file)
@@ -2,7 +2,7 @@
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
-/* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003-???? */
+/* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015 */
 /* License: GPL */
 
 /* Code for calling spamassassin's spamd. Called from acl.c. */
@@ -21,45 +21,42 @@ int spam_ok = 0;
 int spam_rc = 0;
 uschar *prev_spamd_address_work = NULL;
 
-static int timeout_sec;
 static const uschar * loglabel = US"spam acl condition:";
 
 
 static int
 spamd_param_init(spamd_address_container *spamd)
 {
-/* default spamd server weight, time and backup value */
-spamd->weight = SPAMD_WEIGHT;
+/* default spamd server weight, time and priority value */
+spamd->is_rspamd = FALSE;
 spamd->is_failed = FALSE;
-spamd->is_backup = FALSE;
+spamd->weight = SPAMD_WEIGHT;
+spamd->timeout = SPAMD_TIMEOUT;
+spamd->retry = 0;
+spamd->priority = 1;
 return 0;
 }
 
 
 static int
-spamd_param(const uschar *param, spamd_address_container *spamd)
+spamd_param(const uschar * param, spamd_address_container * spamd)
 {
 static int timesinceday = -1;
 const uschar * s;
-
-/* check backup parameter */
-if (Ustrcmp(param, "backup") == 0)
-  {
-  spamd->is_backup = TRUE;
-  return 0; /* OK */
-  }
+const uschar * name;
 
 /*XXX more clever parsing could discard embedded spaces? */
 
-/* check weight parameter */
-if (sscanf(param, "weight=%u", &spamd->weight))
+if (sscanf(CCS param, "pri=%u", &spamd->priority))
+  return 0; /* OK */
+
+if (sscanf(CCS param, "weight=%u", &spamd->weight))
   {
   if (spamd->weight == 0) /* this server disabled: skip it */
     return 1;
   return 0; /* OK */
   }
 
-/* check time parameter */
 if (Ustrncmp(param, "time=", 5) == 0)
   {
   unsigned int start_h = 0, start_m = 0, start_s = 0;
@@ -67,6 +64,7 @@ if (Ustrncmp(param, "time=", 5) == 0)
   unsigned int time_start, time_end;
   const uschar * end_string;
 
+  name = US"time";
   s = param+5;
   if ((end_string = Ustrchr(s, '-')))
     {
@@ -74,18 +72,10 @@ if (Ustrncmp(param, "time=", 5) == 0)
     if (  sscanf(CS end_string, "%u.%u.%u", &end_h,   &end_m,   &end_s)   == 0
        || sscanf(CS s,          "%u.%u.%u", &start_h, &start_m, &start_s) == 0
        )
-      {
-      log_write(0, LOG_MAIN,
-       "%s warning - invalid spamd time value: '%s'", loglabel, s);
-      return -1; /* syntax error */
-      }
+      goto badval;
     }
   else
-    {
-    log_write(0, LOG_MAIN,
-      "%s warning - invalid spamd time value: '%s'", loglabel, s);
-    return -1; /* syntax error */
-    }
+    goto badval;
 
   if (timesinceday < 0)
     {
@@ -112,63 +102,79 @@ if (Ustrcmp(param, "variant=rspamd") == 0)
 if (Ustrncmp(param, "tmo=", 4) == 0)
   {
   int sec = readconf_readtime((s = param+4), '\0', FALSE);
+  name = US"timeout";
   if (sec < 0)
-    {
-    log_write(0, LOG_MAIN,
-      "%s warning - invalid spamd timeout value: '%s'", loglabel, s);
-    return -1; /* syntax error */
-    }
-  timeout_sec = sec;
+    goto badval;
+  spamd->timeout = sec;
+  return 0;
+  }
+
+if (Ustrncmp(param, "retry=", 6) == 0)
+  {
+  int sec = readconf_readtime((s = param+6), '\0', FALSE);
+  name = US"retry";
+  if (sec < 0)
+    goto badval;
+  spamd->retry = sec;
   return 0;
   }
 
 log_write(0, LOG_MAIN, "%s warning - invalid spamd parameter: '%s'",
   loglabel, param);
 return -1; /* syntax error */
+
+badval:
+  log_write(0, LOG_MAIN,
+    "%s warning - invalid spamd %s value: '%s'", loglabel, name, s);
+  return -1; /* syntax error */
 }
 
 
 static int
-spamd_get_server(spamd_address_container **spamds, int num_servers)
+spamd_get_server(spamd_address_container ** spamds, int num_servers)
 {
 unsigned int i;
-long rnd, weights = 0;
-static BOOL srandomed = 0;
-BOOL usebackup = FALSE;
-
-for (;;)
-  {
-  /* seedup, if we have only 1 server */
-  if (num_servers == 1)
-    return (spamds[0]->is_failed ? -1 : 0);
+spamd_address_container * sd;
+long rnd, weights;
+unsigned pri;
+static BOOL srandomed = FALSE;
 
-  /* init ranmod */
-  if (!srandomed)
-    {
-    struct timeval tv;
-    gettimeofday(&tv, NULL);
-    srandom((unsigned int)(tv.tv_usec/1000));
-    srandomed = TRUE;
-    }
+/* seedup, if we have only 1 server */
+if (num_servers == 1)
+  return (spamds[0]->is_failed ? -1 : 0);
 
-  /* get sum of all weights */
-  for (i = 0; i < num_servers; i++)
-    if (!spamds[i]->is_failed && spamds[i]->is_backup == usebackup)
-      weights += spamds[i]->weight;
+/* init ranmod */
+if (!srandomed)
+  {
+  struct timeval tv;
+  gettimeofday(&tv, NULL);
+  srandom((unsigned int)(tv.tv_usec/1000));
+  srandomed = TRUE;
+  }
 
-  if (weights != 0)
-    break;
-  if (usebackup)       /* all servers failed (backups too) */
-    return -1;
-  usebackup = TRUE;
+/* scan for highest pri */
+for (pri = 0, i = 0; i < num_servers; i++)
+  {
+  sd = spamds[i];
+  if (!sd->is_failed && sd->priority > pri) pri = sd->priority;
   }
 
-rnd = random() % weights;
+/* get sum of weights */
+for (weights = 0, i = 0; i < num_servers; i++)
+  {
+  sd = spamds[i];
+  if (!sd->is_failed && sd->priority == pri) weights += sd->weight;
+  }
+if (weights == 0)      /* all servers failed */
+  return -1;
 
-for (i = 0; i < num_servers; i++)
-  if (!spamds[i]->is_failed && spamds[i]->is_backup == usebackup)
-    if ((rnd -= spamds[i]->weight) < 0)
+for (rnd = random() % weights, i = 0; i < num_servers; i++)
+  {
+  sd = spamds[i];
+  if (!sd->is_failed && sd->priority == pri)
+    if ((rnd -= sd->weight) <= 0)
       return i;
+  }
 
 log_write(0, LOG_MAIN|LOG_PANIC,
   "%s unknown error (memory/cpu corruption?)", loglabel);
@@ -177,10 +183,10 @@ return -1;
 
 
 int
-spam(uschar **listptr)
+spam(const uschar **listptr)
 {
 int sep = 0;
-uschar *list = *listptr;
+const uschar *list = *listptr;
 uschar *user_name;
 uschar user_name_buffer[128];
 unsigned long mbox_size;
@@ -188,7 +194,6 @@ FILE *mbox_file;
 int spamd_sock = -1;
 uschar spamd_buffer[32600];
 int i, j, offset, result;
-BOOL is_rspamd;
 uschar spamd_version[8];
 uschar spamd_short_result[8];
 uschar spamd_score_char;
@@ -198,7 +203,6 @@ uschar *p,*q;
 int override = 0;
 time_t start;
 size_t read, wrote;
-struct sockaddr_un server;
 #ifndef NO_POLL_H
 struct pollfd pollfd;
 #else                               /* Patch posted by Erik ? for OS X */
@@ -206,6 +210,7 @@ struct timeval select_tv;         /* and applied by PH */
 fd_set select_fd;
 #endif
 uschar *spamd_address_work;
+spamd_address_container * sd;
 
 /* stop compiler warning */
 result = 0;
@@ -224,8 +229,6 @@ if ( (Ustrcmp(user_name,"0") == 0) ||
      (strcmpic(user_name,US"false") == 0) )
   return FAIL;
 
-timeout_sec = SPAMD_TIMEOUT;
-
 /* if there is an additional option, check if it is "true" */
 if (strcmpic(list,US"true") == 0)
   /* in that case, always return true later */
@@ -246,7 +249,7 @@ if (*spamd_address == '$')
 else
   spamd_address_work = spamd_address;
 
-HDEBUG(D_acl) debug_printf("spamd: addrlist '%s'\n", spamd_address_work);
+DEBUG(D_acl) debug_printf("spamd: addrlist '%s'\n", spamd_address_work);
 
 /* check if previous spamd_address was expanded and has changed. dump cached results if so */
 if (  spam_ok
@@ -275,30 +278,30 @@ start = time(NULL);
   {
   int num_servers = 0;
   int current_server;
-  uschar *address;
-  uschar *spamd_address_list_ptr = spamd_address_work;
+  uschar * address;
+  const uschar * spamd_address_list_ptr = spamd_address_work;
   spamd_address_container * spamd_address_vector[32];
-  spamd_address_container * sd;
 
   /* Check how many spamd servers we have
      and register their addresses */
+  sep = 0;                             /* default colon-sep */
   while ((address = string_nextinlist(&spamd_address_list_ptr, &sep,
                                      NULL, 0)) != NULL)
     {
-    uschar * sublist;
+    const uschar * sublist;
     int sublist_sep = -(int)' ';       /* default space-sep */
     unsigned args;
     uschar * s;
 
-    HDEBUG(D_acl) debug_printf("spamd: addr entry '%s'\n", address);
+    DEBUG(D_acl) debug_printf("spamd: addr entry '%s'\n", address);
     sd = (spamd_address_container *)store_get(sizeof(spamd_address_container));
 
     for (sublist = address, args = 0, spamd_param_init(sd);
-        s = string_nextinlist(&sublist, &sublist_sep, NULL, 0);
+        (s = string_nextinlist(&sublist, &sublist_sep, NULL, 0));
         args++
         )
       {
-       HDEBUG(D_acl) debug_printf("spamd: addr parm '%s'\n", s);
+       DEBUG(D_acl) debug_printf("spamd:  addr parm '%s'\n", s);
        switch (args)
        {
        case 0:   sd->hostspec = s;
@@ -331,17 +334,24 @@ start = time(NULL);
     goto defer;
     }
 
-  while (1)
+  current_server = spamd_get_server(spamd_address_vector, num_servers);
+  sd = spamd_address_vector[current_server];
+  for(;;)
     {
     uschar * errstr;
 
-    current_server = spamd_get_server(spamd_address_vector, num_servers);
-    sd = spamd_address_vector[current_server];
+    DEBUG(D_acl) debug_printf("spamd: trying server %s\n", sd->hostspec);
 
-    debug_printf("trying server %s\n", sd->hostspec);
-
-    /* contact a spamd */
-    if ((spamd_sock = ip_streamsocket(sd->hostspec, &errstr, 5)) >= 0)
+    for (;;)
+      {
+      if (  (spamd_sock = ip_streamsocket(sd->hostspec, &errstr, 5)) >= 0
+         || sd->retry <= 0
+        )
+       break;
+      DEBUG(D_acl) debug_printf("spamd: server %s: retry conn\n", sd->hostspec);
+      while (sd->retry > 0) sd->retry = sleep(sd->retry);
+      }
+    if (spamd_sock >= 0)
       break;
 
     log_write(0, LOG_MAIN, "%s spamd: %s", loglabel, errstr);
@@ -350,12 +360,11 @@ start = time(NULL);
     current_server = spamd_get_server(spamd_address_vector, num_servers);
     if (current_server < 0)
       {
-      log_write(0, LOG_MAIN|LOG_PANIC, "%s all spamd servers failed",
-       loglabel);
+      log_write(0, LOG_MAIN|LOG_PANIC, "%s all spamd servers failed", loglabel);
       goto defer;
       }
+    sd = spamd_address_vector[current_server];
     }
-    is_rspamd = sd->is_rspamd;
   }
 
 if (spamd_sock == -1)
@@ -367,15 +376,16 @@ if (spamd_sock == -1)
 
 (void)fcntl(spamd_sock, F_SETFL, O_NONBLOCK);
 /* now we are connected to spamd on spamd_sock */
-if (is_rspamd)
+if (sd->is_rspamd)
   {                            /* rspamd variant */
   uschar *req_str;
-  const char *helo;
-  const char *fcrdns;
+  const uschar * helo;
+  const uschar * fcrdns;
+  const uschar * authid;
 
   req_str = string_sprintf("CHECK RSPAMC/1.3\r\nContent-length: %lu\r\n"
-    "Queue-Id: %s\r\nFrom: <%s>\r\nRecipient-Number: %d\r\n", mbox_size,
-    message_id, sender_address, recipients_count);
+    "Queue-Id: %s\r\nFrom: <%s>\r\nRecipient-Number: %d\r\n",
+    mbox_size, message_id, sender_address, recipients_count);
   for (i = 0; i < recipients_count; i ++)
     req_str = string_sprintf("%sRcpt: <%s>\r\n", req_str, recipients_list[i].address);
   if ((helo = expand_string(US"$sender_helo_name")) != NULL && *helo != '\0')
@@ -384,10 +394,12 @@ if (is_rspamd)
     req_str = string_sprintf("%sHostname: %s\r\n", req_str, fcrdns);
   if (sender_host_address != NULL)
     req_str = string_sprintf("%sIP: %s\r\n", req_str, sender_host_address);
+  if ((authid = expand_string(US"$authenticated_id")) != NULL && *authid != '\0')
+    req_str = string_sprintf("%sUser: %s\r\n", req_str, authid);
   req_str = string_sprintf("%s\r\n", req_str);
-  wrote = send(spamd_sock, req_str, Ustrlen(req_str), 0); 
+  wrote = send(spamd_sock, req_str, Ustrlen(req_str), 0);
   }
-  else
+else
   {                            /* spamassassin variant */
   (void)string_format(spamd_buffer,
          sizeof(spamd_buffer),
@@ -397,6 +409,7 @@ if (is_rspamd)
   /* send our request */
   wrote = send(spamd_sock, spamd_buffer, Ustrlen(spamd_buffer), 0);
   }
+
 if (wrote == -1)
   {
   (void)close(spamd_sock);
@@ -449,7 +462,7 @@ again:
          "%s %s on spamd socket", loglabel, strerror(errno));
       else
        {
-       if (time(NULL) - start < timeout_sec)
+       if (time(NULL) - start < sd->timeout)
          goto again;
        log_write(0, LOG_MAIN|LOG_PANIC,
          "%s timed out writing spamd socket", loglabel);
@@ -494,7 +507,7 @@ offset = 0;
 while ((i = ip_recv(spamd_sock,
                   spamd_buffer + offset,
                   sizeof(spamd_buffer) - offset - 1,
-                  timeout_sec - time(NULL) + start)) > 0 )
+                  sd->timeout - time(NULL) + start)) > 0 )
   offset += i;
 
 /* error handling */
@@ -509,7 +522,7 @@ if (i <= 0 && errno != 0)
 /* reading done */
 (void)close(spamd_sock);
 
-if (is_rspamd)
+if (sd->is_rspamd)
   {                            /* rspamd variant of reply */
   int r;
   if ((r = sscanf(CS spamd_buffer,
@@ -517,9 +530,9 @@ if (is_rspamd)
          spamd_version, spamd_short_result, &spamd_score, &spamd_threshold,
          &spamd_reject_score, &spamd_report_offset)) != 5)
     {
-      log_write(0, LOG_MAIN|LOG_PANIC,
-               "%s cannot parse spamd output: %d", loglabel, r);
-      return DEFER;
+    log_write(0, LOG_MAIN|LOG_PANIC,
+             "%s cannot parse spamd output: %d", loglabel, r);
+    return DEFER;
     }
   /* now parse action */
   p = &spamd_buffer[spamd_report_offset];