2005-07-20 [colin] 1.9.12cvs87
[claws.git] / src / plugins / spamassassin / spamassassin.c
index 99a4743bc185fd4d81208c8e14f84ea57fcd4989..13e484fd96e9ad07df6cbe99ed3ebd713d58ade0 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
 
 #include "defs.h"
 
+#include <sys/types.h>
+#include <sys/wait.h>
+
 #include <glib.h>
+#include <glib/gi18n.h>
 
 #if HAVE_LOCALE_H
 #  include <locale.h>
 #endif
 
+#include "common/sylpheed.h"
+#include "common/version.h"
 #include "plugin.h"
 #include "common/utils.h"
 #include "hooks.h"
-#include "inc.h"
 #include "procmsg.h"
 #include "folder.h"
 #include "prefs.h"
 #include <pwd.h>
 #endif
 
-static gint hook_id;
+enum {
+    CHILD_RUNNING = 1 << 0,
+    TIMEOUT_RUNNING = 1 << 1,
+};
+
+static guint hook_id;
 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
+static gchar *username = NULL;
+static MessageCallback message_callback;
 
-gboolean spamassassin_enable;
-gchar *spamassassin_hostname;
-int spamassassin_port;
-int spamassassin_max_size;
-gboolean spamassassin_receive_spam;
-gchar *spamassassin_save_folder;
+static SpamAssassinConfig config;
 
 static PrefParam param[] = {
-       {"enable", "FALSE", &spamassassin_enable, P_BOOL,
+       {"transport", "0", &config.transport, P_INT,
+        NULL, NULL, NULL},
+       {"hostname", "localhost", &config.hostname, P_STRING,
+        NULL, NULL, NULL},
+       {"port", "783", &config.port, P_INT,
         NULL, NULL, NULL},
-       {"hostname", "localhost", &spamassassin_hostname, P_STRING,
+       {"socket", "", &config.socket, P_STRING,
         NULL, NULL, NULL},
-       {"port", "783", &spamassassin_port, P_USHORT,
+       {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
         NULL, NULL, NULL},
-       {"max_size", "250", &spamassassin_max_size, P_USHORT,
+       {"save_folder", NULL, &config.save_folder, P_STRING,
         NULL, NULL, NULL},
-       {"receive_spam", "250", &spamassassin_receive_spam, P_BOOL,
+       {"max_size", "250", &config.max_size, P_INT,
         NULL, NULL, NULL},
-       {"save_folder", NULL, &spamassassin_save_folder, P_STRING,
+       {"timeout", "30", &config.timeout, P_INT,
         NULL, NULL, NULL},
 
        {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
 };
 
-static gboolean mail_filtering_hook(gpointer source, gpointer data)
+gboolean timeout_func(gpointer data)
 {
-       MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
-       MsgInfo *msginfo = mail_filtering_data->msginfo;
-       gboolean is_spam = FALSE;
-       FILE *fp = NULL;
-       struct message m;
-       int ret;
-       gchar *username = NULL, *oldlocale = NULL;
-       struct sockaddr addr;
+       gint *running = (gint *) data;
 
-       if (!spamassassin_enable)
-               return FALSE;
+       if (*running & CHILD_RUNNING)
+               return TRUE;
 
-       debug_print("Filtering message %d\n", msginfo->msgnum);
+       *running &= ~TIMEOUT_RUNNING;
+       return FALSE;
+}
 
-       oldlocale = g_strdup(setlocale(LC_ALL, NULL));
-       if (oldlocale == NULL) {
-               debug_print("failed to get locale");
-               goto CATCH;
-       }
+static gboolean msg_is_spam(FILE *fp)
+{
+       struct transport trans;
+       struct message m;
+       gboolean is_spam = FALSE;
 
-       setlocale(LC_ALL, "C");
+       transport_init(&trans);
+       switch (config.transport) {
+       case SPAMASSASSIN_TRANSPORT_LOCALHOST:
+               trans.type = TRANSPORT_LOCALHOST;
+               trans.port = config.port;
+               break;
+       case SPAMASSASSIN_TRANSPORT_TCP:
+               trans.type = TRANSPORT_TCP;
+               trans.hostname = config.hostname;
+               trans.port = config.port;
+               break;
+       case SPAMASSASSIN_TRANSPORT_UNIX:
+               trans.type = TRANSPORT_UNIX;
+               trans.socketpath = config.socket;
+               break;
+       default:
+               return FALSE;
+       }
 
-       ret = lookup_host(spamassassin_hostname, spamassassin_port, &addr);
-       if (ret != EX_OK) {
-               debug_print("failed to look up spamd host");
-               goto CATCH;
+       if (transport_setup(&trans, flags) != EX_OK) {
+               debug_print("failed to setup transport\n");
+               return FALSE;
        }
 
        m.type = MESSAGE_NONE;
-       m.max_len = spamassassin_max_size * 1024;
+       m.max_len = config.max_size * 1024;
+       m.timeout = config.timeout;
 
-       username = g_get_user_name();
-       if (username == NULL) {
-               debug_print("failed to get username");
-               goto CATCH;
-       }
-
-       fp = procmsg_open_message(msginfo);
-       if (fp == NULL) {
-               debug_print("failed to open message file");
-               goto CATCH;
+       if (message_read(fileno(fp), flags, &m) != EX_OK) {
+               debug_print("failed to read message\n");
+               message_cleanup(&m);
+               return FALSE;
        }
 
-       ret = message_read(fileno(fp), flags, &m);
-       if (ret != EX_OK) {
-               debug_print("failed to read message");
-               goto CATCH;
+       if (message_filter(&trans, username, flags, &m) != EX_OK) {
+               debug_print("filtering the message failed\n");
+               message_cleanup(&m);
+               return FALSE;
        }
 
-       ret = message_filter(&addr, username, flags, &m);
-       if ((ret == EX_OK) && (m.is_spam == EX_ISSPAM))
+       if (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);
+
+       return is_spam;
+}
+
+static gboolean mail_filtering_hook(gpointer source, gpointer data)
+{
+       MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
+       MsgInfo *msginfo = mail_filtering_data->msginfo;
+       gboolean is_spam = FALSE;
+       FILE *fp = NULL;
+       int pid = 0;
+       int status;
+
+       if (config.transport == SPAMASSASSIN_DISABLED)
+               return FALSE;
+
+       debug_print("Filtering message %d\n", msginfo->msgnum);
+       if (message_callback != NULL)
+               message_callback(_("SpamAssassin: filtering message..."));
+
+       if ((fp = procmsg_open_message(msginfo)) == NULL) {
+               debug_print("failed to open message file\n");
+               return FALSE;
+       }
+
+       pid = fork();
+       if (pid == 0) {
+               _exit(msg_is_spam(fp) ? 1 : 0);
+       } else {
+               gint running = 0;
+
+               running |= CHILD_RUNNING;
+
+               g_timeout_add(50, timeout_func, &running);
+               running |= TIMEOUT_RUNNING;
+
+               while(running & CHILD_RUNNING) {
+                       int ret;
+
+                       ret = waitpid(pid, &status, WNOHANG);
+                       if (ret == pid) {
+                               if (WIFEXITED(status)) {
+                                       running &= ~CHILD_RUNNING;
+                                       is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
+                               }
+                       } if (ret < 0) {
+                               running &= ~CHILD_RUNNING;
+                       } /* ret == 0 continue */
+           
+                       g_main_iteration(TRUE);
+               }
+
+               while (running & TIMEOUT_RUNNING)
+                       g_main_iteration(TRUE);
        }
 
+       fclose(fp);
+
        if (is_spam) {
-               if (spamassassin_receive_spam) {
+               debug_print("message is spam\n");
+                           
+               if (config.receive_spam) {
                        FolderItem *save_folder;
 
-                       debug_print("message is spam\n");
-                           
-                       if ((!spamassassin_save_folder) ||
-                           (spamassassin_save_folder[0] == '\0') ||
-                           ((save_folder = folder_find_item_from_identifier(spamassassin_save_folder)) == NULL))
+                       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);
@@ -177,7 +243,12 @@ CATCH:
        return FALSE;
 }
 
-void spamassassin_save_config()
+SpamAssassinConfig *spamassassin_get_config(void)
+{
+       return &config;
+}
+
+void spamassassin_save_config(void)
 {
        PrefFile *pfile;
        gchar *rcpath;
@@ -200,16 +271,42 @@ void spamassassin_save_config()
        prefs_file_close(pfile);
 }
 
+void spamassassin_set_message_callback(MessageCallback callback)
+{
+       message_callback = callback;
+}
+
 gint plugin_init(gchar **error)
 {
+       gchar *rcpath;
+
+       if ((sylpheed_get_version() > VERSION_NUMERIC)) {
+               *error = g_strdup("Your sylpheed version is newer than the version the plugin was built with");
+               return -1;
+       }
+
+       if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
+               *error = g_strdup("Your sylpheed version is too old");
+               return -1;
+       }
+
        hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
        if (hook_id == -1) {
                *error = g_strdup("Failed to register mail filtering hook");
                return -1;
        }
 
+       username = g_get_user_name();
+       if (username == NULL) {
+               hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
+               *error = g_strdup("Failed to get username");
+               return -1;
+       }
+
        prefs_set_default(param);
-       prefs_read_config(param, "SpamAssassin", COMMON_RC);
+       rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
+       prefs_read_config(param, "SpamAssassin", rcpath, NULL);
+       g_free(rcpath);
 
        debug_print("Spamassassin plugin loaded\n");
 
@@ -217,30 +314,37 @@ gint plugin_init(gchar **error)
        
 }
 
-void plugin_done()
+void plugin_done(void)
 {
        hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
-       g_free(spamassassin_hostname);
+       g_free(config.hostname);
+       g_free(config.save_folder);
 
        debug_print("Spamassassin plugin unloaded\n");
 }
 
-const gchar *plugin_name()
+const gchar *plugin_name(void)
+{
+       return _("SpamAssassin");
+}
+
+const gchar *plugin_desc(void)
 {
-       return "SpamAssassin";
+       return _("This plugin checks all messages that are received from an "
+                "IMAP, LOCAL or 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");
 }
 
-const gchar *plugin_desc()
+const gchar *plugin_type(void)
 {
-       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 would have to "
-              "manually write the plugin configuration.\n";
+       return "Common";
 }