0.8.10claws100
[claws.git] / src / plugins / spamassassin / spamassassin.c
index e642f45d00a1950cd552070a34a361a8b2e051bb..99ed7cff21ee230d0bf8c35f0d410228dc9420ca 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2002 Hiroyuki Yamamoto and the Sylpheed-Claws Team
+ * Copyright (C) 1999-2003 Hiroyuki Yamamoto and the Sylpheed-Claws Team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -21,6 +21,8 @@
 #  include "config.h"
 #endif
 
+#include "defs.h"
+
 #include <glib.h>
 
 #if HAVE_LOCALE_H
 #include "inc.h"
 #include "procmsg.h"
 #include "folder.h"
+#include "prefs.h"
+#include "prefs_gtk.h"
 
 #include "libspamc.h"
+#include "spamassassin.h"
 
 #ifdef HAVE_SYSEXITS_H
 #include <sysexits.h>
 #endif
 
 static gint hook_id;
-static int max_size;
 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
-static gchar *hostname = NULL;
-static int port;
+static gchar *username = NULL;
+
+static SpamAssassinConfig config;
+
+static PrefParam param[] = {
+       {"enable", "FALSE", &config.enable, P_BOOL,
+        NULL, NULL, NULL},
+       {"hostname", "localhost", &config.hostname, P_STRING,
+        NULL, NULL, NULL},
+       {"port", "783", &config.port, P_USHORT,
+        NULL, NULL, NULL},
+       {"max_size", "250", &config.max_size, P_USHORT,
+        NULL, NULL, NULL},
+       {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
+        NULL, NULL, NULL},
+       {"save_folder", NULL, &config.save_folder, P_STRING,
+        NULL, NULL, NULL},
+
+       {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
+};
 
 static gboolean mail_filtering_hook(gpointer source, gpointer data)
 {
@@ -71,65 +93,94 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
        gboolean is_spam = FALSE;
        FILE *fp = NULL;
        struct message m;
-       int ret;
-       gchar *username = NULL, *oldlocale = NULL;
+       gchar *oldlocale = NULL;
        struct sockaddr addr;
-       
-       debug_print("Filtering message %d\n", msginfo->msgnum);
 
-       oldlocale = g_strdup(setlocale(LC_ALL, NULL));
-       if (oldlocale == NULL)
-               goto CATCH;
+       if (!config.enable)
+               return FALSE;
 
+       debug_print("Filtering message %d\n", msginfo->msgnum);
+
+       /* remember old locale and set it to C */
+       Xstrdup_a(oldlocale, setlocale(LC_ALL, NULL), return FALSE);
        setlocale(LC_ALL, "C");
 
-       ret = lookup_host(hostname, port, &addr);
-       if (ret != EX_OK)
-               goto CATCH;
+       if (lookup_host(config.hostname, config.port, &addr) != EX_OK) {
+               debug_print("failed to look up spamd host");
+               return FALSE;
+       }
 
        m.type = MESSAGE_NONE;
-       m.max_len = max_size;
+       m.max_len = config.max_size * 1024;
 
-       username = g_get_user_name();
-       if (username == NULL)
-               goto CATCH;
-
-       fp = procmsg_open_message(msginfo);
-       if (fp == NULL)
-               goto CATCH;
+       if ((fp = procmsg_open_message(msginfo)) == NULL) {
+               debug_print("failed to open message file");
+               return FALSE;
+       }
 
-       ret = message_read(fileno(fp), flags, &m);
-       if (ret != EX_OK)
-               goto CATCH;
+       if (message_read(fileno(fp), flags, &m) != EX_OK) {
+               debug_print("failed to read message");
+               fclose(fp);
+               message_cleanup(&m);
+               return FALSE;
+       }
 
-       ret = message_filter(&addr, username, flags, &m);
-       if ((ret == EX_OK) && (m.is_spam == EX_ISSPAM))
+       if ((message_filter(&addr, username, flags, &m) == EX_OK) && (m.is_spam == EX_ISSPAM))
                is_spam = TRUE;
 
-CATCH:
-       if (fp != NULL)
-               fclose(fp);
        message_cleanup(&m);
-       if (oldlocale != NULL) {
-               setlocale(LC_ALL, oldlocale);
-               g_free(oldlocale);
-       }
+       fclose(fp);
+       setlocale(LC_ALL, oldlocale);
 
        if (is_spam) {
-               debug_print("Message is spam\n");
+               if (config.receive_spam) {
+                       FolderItem *save_folder;
+
+                       debug_print("message is spam\n");
+                           
+                       if ((!config.save_folder) ||
+                           (config.save_folder[0] == '\0') ||
+                           ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL))
+                               save_folder = folder_get_default_trash();
+
+                       procmsg_msginfo_unset_flags(msginfo, ~0, 0);
+                       folder_item_move_msg(save_folder, msginfo);
+               } else {
+                       folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
+               }
 
-               folder_item_move_msg(folder_get_default_trash(), msginfo);
                return TRUE;
        }
        
        return FALSE;
 }
 
-static void spamassassin_read_config()
+SpamAssassinConfig *spamassassin_get_config()
 {
-       max_size = 250*1024;
-       hostname = "127.0.0.1";
-       port = 783;
+       return &config;
+}
+
+void spamassassin_save_config()
+{
+       PrefFile *pfile;
+       gchar *rcpath;
+
+       debug_print("Saving SpamAssassin Page\n");
+
+       rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
+       pfile = prefs_write_open(rcpath);
+       g_free(rcpath);
+       if (!pfile || (prefs_set_block_label(pfile, "SpamAssassin") < 0))
+               return;
+
+       if (prefs_write_param(param, pfile->fp) < 0) {
+               g_warning("failed to write SpamAssassin configuration to file\n");
+               prefs_file_close_revert(pfile);
+               return;
+       }
+       fprintf(pfile->fp, "\n");
+
+       prefs_file_close(pfile);
 }
 
 gint plugin_init(gchar **error)
@@ -140,7 +191,14 @@ gint plugin_init(gchar **error)
                return -1;
        }
 
-       spamassassin_read_config();
+       username = g_get_user_name();
+       if (username == NULL) {
+               *error = g_strdup("Failed to get username");
+               return -1;
+       }
+
+       prefs_set_default(param);
+       prefs_read_config(param, "SpamAssassin", COMMON_RC);
 
        debug_print("Spamassassin plugin loaded\n");
 
@@ -151,17 +209,28 @@ gint plugin_init(gchar **error)
 void plugin_done()
 {
        hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
+       g_free(config.hostname);
+       g_free(config.save_folder);
 
        debug_print("Spamassassin plugin unloaded\n");
 }
 
 const gchar *plugin_name()
 {
-       return "Spamassassin Plugin";
+       return "SpamAssassin";
 }
 
 const gchar *plugin_desc()
 {
-       return "Check incoming mails for spam with spamassassin";
+       return "This plugin checks all messages that are received from a POP "
+              "account for spam using a SpamAssassin server. You will need "
+              "a SpamAssassin Server (spamd) running somewhere.\n"
+              "\n"
+              "When a message is identified as spam it can be deleted or "
+              "saved into a special folder.\n"
+              "\n"
+              "This plugin only contains the actual function for filtering "
+              "and deleting or moving the message. You probably want to load "
+              "a User Interface plugin too, otherwise you will have to "
+              "manually write the plugin configuration.\n";
 }
-