ClamAV, SA plugins: inform the user what is happening via the statusbar
[claws.git] / src / plugins / spamassassin / spamassassin.c
index e642f45d00a1950cd552070a34a361a8b2e051bb..571aeee0c82c5be0d22e4d1d68a7ab7e9004cb39 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 "config.h"
 #endif
 
+#include "defs.h"
+
+#include <sys/types.h>
+#include <sys/wait.h>
+
 #include <glib.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 "prefs_gtk.h"
+#include "intl.h"
 
 #include "libspamc.h"
+#include "spamassassin.h"
 
 #ifdef HAVE_SYSEXITS_H
 #include <sysexits.h>
 #include <pwd.h>
 #endif
 
-static gint hook_id;
-static int max_size;
+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 *hostname = NULL;
-static int port;
+static gchar *username = NULL;
+
+static SpamAssassinConfig config;
+
+static PrefParam param[] = {
+       {"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},
+       {"socket", "", &config.socket, P_STRING,
+        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},
+       {"max_size", "250", &config.max_size, P_INT,
+        NULL, NULL, NULL},
+       {"timeout", "30", &config.timeout, P_INT,
+        NULL, NULL, NULL},
+
+       {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
+};
+
+gboolean timeout_func(gpointer data)
+{
+       gint *running = (gint *) data;
+
+       if (*running & CHILD_RUNNING)
+               return TRUE;
+
+       *running &= ~TIMEOUT_RUNNING;
+       return FALSE;
+}
+
+static gboolean msg_is_spam(FILE *fp)
+{
+       struct transport trans;
+       struct message m;
+       gboolean is_spam = FALSE;
+
+       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;
+       }
+
+       if (transport_setup(&trans, flags) != EX_OK) {
+               debug_print("failed to setup transport\n");
+               return FALSE;
+       }
+
+       m.type = MESSAGE_NONE;
+       m.max_len = config.max_size * 1024;
+       m.timeout = config.timeout;
+
+       if (message_read(fileno(fp), flags, &m) != EX_OK) {
+               debug_print("failed to read message\n");
+               message_cleanup(&m);
+               return FALSE;
+       }
+
+       if (message_filter(&trans, username, flags, &m) != EX_OK) {
+               debug_print("filtering the message failed\n");
+               message_cleanup(&m);
+               return FALSE;
+       }
+
+       if (m.is_spam == EX_ISSPAM)
+               is_spam = TRUE;
+
+       message_cleanup(&m);
+
+       return is_spam;
+}
 
 static gboolean mail_filtering_hook(gpointer source, gpointer data)
 {
@@ -70,77 +171,124 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
        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;
-       
-       debug_print("Filtering message %d\n", msginfo->msgnum);
+       int pid = 0;
+       int status;
 
-       oldlocale = g_strdup(setlocale(LC_ALL, NULL));
-       if (oldlocale == NULL)
-               goto CATCH;
+       if (config.transport == SPAMASSASSIN_DISABLED)
+               return FALSE;
 
-       setlocale(LC_ALL, "C");
-
-       ret = lookup_host(hostname, port, &addr);
-       if (ret != EX_OK)
-               goto CATCH;
+       debug_print("Filtering message %d\n", msginfo->msgnum);
+       statusbar_print_all(_("SpamAssassin: filtering message..."));
 
-       m.type = MESSAGE_NONE;
-       m.max_len = max_size;
+       if ((fp = procmsg_open_message(msginfo)) == NULL) {
+               debug_print("failed to open message file\n");
+               return FALSE;
+       }
 
-       username = g_get_user_name();
-       if (username == NULL)
-               goto CATCH;
+       pid = fork();
+       if (pid == 0) {
+               _exit(msg_is_spam(fp) ? 1 : 0);
+       } else {
+               gint running = 0;
 
-       fp = procmsg_open_message(msginfo);
-       if (fp == NULL)
-               goto CATCH;
+               running |= CHILD_RUNNING;
 
-       ret = message_read(fileno(fp), flags, &m);
-       if (ret != EX_OK)
-               goto CATCH;
+               g_timeout_add(1000, timeout_func, &running);
+               running |= TIMEOUT_RUNNING;
 
-       ret = message_filter(&addr, username, flags, &m);
-       if ((ret == EX_OK) && (m.is_spam == EX_ISSPAM))
-               is_spam = TRUE;
+               while(running & CHILD_RUNNING) {
+                       waitpid(pid, &status, WNOHANG);
+                       if (WIFEXITED(status)) {
+                               running &= ~CHILD_RUNNING;
+                       }
+           
+                       g_main_iteration(TRUE);
+               }
 
-CATCH:
-       if (fp != NULL)
-               fclose(fp);
-       message_cleanup(&m);
-       if (oldlocale != NULL) {
-               setlocale(LC_ALL, oldlocale);
-               g_free(oldlocale);
+               while (running & TIMEOUT_RUNNING)
+                       g_main_iteration(TRUE);
        }
+        is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
+
+       fclose(fp);
 
        if (is_spam) {
-               debug_print("Message is spam\n");
+               debug_print("message is spam\n");
+                           
+               if (config.receive_spam) {
+                       FolderItem *save_folder;
+
+                       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(void)
 {
-       max_size = 250*1024;
-       hostname = "127.0.0.1";
-       port = 783;
+       return &config;
+}
+
+void spamassassin_save_config(void)
+{
+       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)
 {
+       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;
        }
 
-       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");
 
@@ -148,20 +296,37 @@ gint plugin_init(gchar **error)
        
 }
 
-void plugin_done()
+void plugin_done(void)
 {
        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()
+const gchar *plugin_name(void)
 {
-       return "Spamassassin Plugin";
+       return _("SpamAssassin");
 }
 
-const gchar *plugin_desc()
+const gchar *plugin_desc(void)
 {
-       return "Check incoming mails for spam with 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_type(void)
+{
+       return "Common";
+}