2006-02-27 [colin] 2.0.0cvs85
[claws.git] / src / plugins / spamassassin / spamassassin.c
index 13e484fd96e9ad07df6cbe99ed3ebd713d58ade0..191c7130fa0245fcd8e2fe4c0a36155f98cacc01 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2003 Hiroyuki Yamamoto and the Sylpheed-Claws Team
+ * Copyright (C) 1999-2006 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
@@ -14,7 +14,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -45,6 +45,8 @@
 
 #include "libspamc.h"
 #include "spamassassin.h"
+#include "log.h"
+#include "prefs_common.h"
 
 #ifdef HAVE_SYSEXITS_H
 #include <sysexits.h>
@@ -138,6 +140,7 @@ static gboolean msg_is_spam(FILE *fp)
        }
 
        if (transport_setup(&trans, flags) != EX_OK) {
+               log_error("Spamassassin plugin couldn't connect to spamd.\n");
                debug_print("failed to setup transport\n");
                return FALSE;
        }
@@ -175,9 +178,10 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
        int pid = 0;
        int status;
 
-       if (config.transport == SPAMASSASSIN_DISABLED)
+       if (config.transport == SPAMASSASSIN_DISABLED) {
+               log_error("Spamassassin plugin is disabled by its preferences.\n");
                return FALSE;
-
+       }
        debug_print("Filtering message %d\n", msginfo->msgnum);
        if (message_callback != NULL)
                message_callback(_("SpamAssassin: filtering message..."));
@@ -222,7 +226,7 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
 
        if (is_spam) {
                debug_print("message is spam\n");
-                           
+               procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
                if (config.receive_spam) {
                        FolderItem *save_folder;
 
@@ -232,14 +236,17 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
                                save_folder = folder_get_default_trash();
 
                        procmsg_msginfo_unset_flags(msginfo, ~0, 0);
+                       procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
                        folder_item_move_msg(save_folder, msginfo);
                } else {
                        folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
                }
 
                return TRUE;
+       } else {
+               debug_print("message is ham\n");
+               procmsg_msginfo_unset_flags(msginfo, MSG_SPAM, 0);
        }
-       
        return FALSE;
 }
 
@@ -248,6 +255,56 @@ SpamAssassinConfig *spamassassin_get_config(void)
        return &config;
 }
 
+void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
+{
+       gchar *cmd = NULL;
+       gchar *file = NULL;
+       gboolean async = FALSE;
+
+       if (msginfo == NULL && msglist == NULL)
+               return;
+
+       if (msginfo) {
+               file = procmsg_get_message_file(msginfo);
+               if (file == NULL)
+                       return;
+               cmd = g_strdup_printf("sa-learn %s %s %s", 
+                       prefs_common.work_offline?"-L":"",
+                       spam?"--spam":"--ham", file);
+       }
+       if (msglist) {
+               GSList *cur;
+               MsgInfo *info;
+               cmd = g_strdup_printf("sa-learn %s %s", 
+                               prefs_common.work_offline?"-L":"",
+                               spam?"--spam":"--ham");
+               for (cur = msglist; cur; cur = cur->next) {
+                       info = (MsgInfo *)cur->data;
+                       gchar *tmpcmd = NULL;
+                       gchar *tmpfile = get_tmp_file();
+                       
+                       if (tmpfile &&
+                           copy_file(procmsg_get_message_file(info), tmpfile, TRUE) == 0) {                    
+                               tmpcmd = g_strconcat
+                                       (cmd, " ", tmpfile, NULL);
+                               g_free(cmd);
+                               cmd = tmpcmd;
+                       }
+                       if (tmpfile)
+                               g_free(tmpfile);
+               }
+               async = TRUE;
+       }
+       if (cmd == NULL)
+               return;
+       debug_print("%s\n",cmd);
+       /* only run async if we have a list, or we could end up
+        * forking lots of perl processes and bury the machine */
+       execute_command_line(cmd, async);
+       g_free(cmd);
+       
+}
+
 void spamassassin_save_config(void)
 {
        PrefFile *pfile;
@@ -281,12 +338,12 @@ 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");
+               *error = g_strdup("Your version of Sylpheed-Claws is newer than the version the SpamAssassin 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");
+               *error = g_strdup("Your version of Sylpheed-Claws is too old for the SpamAssassin plugin");
                return -1;
        }
 
@@ -296,7 +353,7 @@ gint plugin_init(gchar **error)
                return -1;
        }
 
-       username = g_get_user_name();
+       username = (gchar*)g_get_user_name();
        if (username == NULL) {
                hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
                *error = g_strdup("Failed to get username");
@@ -307,9 +364,21 @@ gint plugin_init(gchar **error)
        rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
        prefs_read_config(param, "SpamAssassin", rcpath, NULL);
        g_free(rcpath);
-
+       spamassassin_gtk_init();
+               
        debug_print("Spamassassin plugin loaded\n");
 
+       if (config.transport == SPAMASSASSIN_DISABLED) {
+               log_error("Spamassassin plugin is loaded but disabled by its preferences.\n");
+       }
+       
+       if (config.transport != SPAMASSASSIN_DISABLED &&
+           config.transport != SPAMASSASSIN_TRANSPORT_TCP) {
+               procmsg_register_spam_learner(spamassassin_learn);
+               procmsg_spam_set_folder(config.save_folder);
+       } else if (config.transport == SPAMASSASSIN_TRANSPORT_TCP)
+               debug_print("disabling learner as it only works locally\n");
+
        return 0;
        
 }
@@ -319,7 +388,9 @@ void plugin_done(void)
        hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
        g_free(config.hostname);
        g_free(config.save_folder);
-
+       spamassassin_gtk_done();
+       procmsg_unregister_spam_learner(spamassassin_learn);
+       procmsg_spam_set_folder(NULL);
        debug_print("Spamassassin plugin unloaded\n");
 }
 
@@ -337,14 +408,21 @@ const gchar *plugin_desc(void)
                 "\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");
+                "\n");
 }
 
 const gchar *plugin_type(void)
 {
-       return "Common";
+       return "GTK2";
 }
+
+const gchar *plugin_licence(void)
+{
+       return "GPL";
+}
+
+const gchar *plugin_version(void)
+{
+       return VERSION;
+}
+