2006-03-10 [colin] 2.0.0cvs130
[claws.git] / src / plugins / spamassassin / spamassassin.c
index 38ad000110b24eeb38ac8c6bff11b51e2f64e0c0..c27b16f66a4bc8a720424f5e40c6d8d0661e62b9 100644 (file)
@@ -45,6 +45,7 @@
 
 #include "libspamc.h"
 #include "spamassassin.h"
+#include "inc.h"
 #include "log.h"
 #include "prefs_common.h"
 
@@ -75,13 +76,15 @@ enum {
     TIMEOUT_RUNNING = 1 << 1,
 };
 
-static guint hook_id;
+static guint hook_id = -1;
 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
 static MessageCallback message_callback;
 
 static SpamAssassinConfig config;
 
 static PrefParam param[] = {
+       {"enable", "FALSE", &config.enable, P_BOOL,
+       NULL, NULL, NULL},
        {"transport", "0", &config.transport, P_INT,
         NULL, NULL, NULL},
        {"hostname", "localhost", &config.hostname, P_STRING,
@@ -90,6 +93,8 @@ static PrefParam param[] = {
         NULL, NULL, NULL},
        {"socket", "", &config.socket, P_STRING,
         NULL, NULL, NULL},
+       {"process_emails", "TRUE", &config.process_emails, P_BOOL,
+        NULL, NULL, NULL},
        {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
         NULL, NULL, NULL},
        {"save_folder", NULL, &config.save_folder, P_STRING,
@@ -121,6 +126,9 @@ static gboolean msg_is_spam(FILE *fp)
        struct message m;
        gboolean is_spam = FALSE;
 
+       if (!config.enable)
+               return FALSE;
+
        transport_init(&trans);
        switch (config.transport) {
        case SPAMASSASSIN_TRANSPORT_LOCALHOST:
@@ -179,7 +187,8 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
        int pid = 0;
        int status;
 
-       if (config.transport == SPAMASSASSIN_DISABLED) {
+       /* SPAMASSASSIN_DISABLED : keep test for compatibility purpose */
+       if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
                log_error("Spamassassin plugin is disabled by its preferences.\n");
                return FALSE;
        }
@@ -256,29 +265,62 @@ SpamAssassinConfig *spamassassin_get_config(void)
        return &config;
 }
 
-void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
+gchar* spamassassin_create_tmp_spamc_wrapper(gboolean spam)
+{
+       gchar *contents;
+       gchar *fname = get_tmp_file();
+
+       if (fname != NULL) {
+               contents = g_strdup_printf(
+                                               "spamc -d %s -p %u -u %s -t %u -s %u -L %s<\"$*\";exit $?",
+                                               config.hostname, config.port, 
+                                               config.username, config.timeout,
+                                               config.max_size * 1024, spam?"spam":"ham");
+               if (str_write_to_file(contents, fname) < 0) {
+                       g_free(fname);
+                       fname = NULL;
+               }
+               g_free(contents);
+       }
+       /* returned pointer must be free'ed by caller */
+       return fname;
+}
+
+int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
 {
        gchar *cmd = NULL;
        gchar *file = NULL;
-       gboolean async = FALSE;
+       const gchar *shell = g_getenv("SHELL");
+       gchar *spamc_wrapper = NULL;
 
-       if (msginfo == NULL && msglist == NULL)
-               return;
+       if (msginfo == NULL && msglist == NULL) {
+               return -1;
+       }
+
+       if (config.transport == SPAMASSASSIN_TRANSPORT_TCP
+       &&  prefs_common.work_offline
+       &&  !inc_offline_should_override(
+               _("Sylpheed-Claws needs network access in order "
+                 "to feed this mail(s) to the remote learner."))) {
+               return -1;
+       }
 
        if (msginfo) {
                file = procmsg_get_message_file(msginfo);
-               if (file == NULL)
-                       return;
+               if (file == NULL) {
+                       return -1;
+               }
                if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
+                       spamc_wrapper = spamassassin_create_tmp_spamc_wrapper(spam);
+                       if (spamc_wrapper != NULL) {
+                               cmd = g_strconcat(shell?shell:"sh", " ",
+                                                               spamc_wrapper, " ", file, NULL);
+                       }
+               } else {
                        cmd = g_strdup_printf("sa-learn -u %s %s %s %s",
                                                        config.username,
                                                        prefs_common.work_offline?"-L":"",
                                                        spam?"--spam":"--ham", file);
-               } else {
-                       cmd = g_strdup_printf("spamc -d %s -p %u -u %s -t %u -s %u -L %s < %s",
-                                                       config.hostname, config.port, 
-                                                       config.username, config.timeout,
-                                                       config.max_size * 1024, spam?"spam":"ham", file);
                }
        }
        if (msglist) {
@@ -286,31 +328,32 @@ void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
                MsgInfo *info;
 
                if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
-                       cmd = g_strdup_printf("spamc -d %s -p %u -u %s -t %u -s %u -L %s",
-                                                       config.hostname, config.port,
-                                                       config.username, config.timeout,
-                                                       config.max_size * 1024, spam?"spam":"ham");
-
                        /* execute n-times the spamc command */
                        for (; 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);
+                               if (spamc_wrapper == NULL) {
+                                       spamc_wrapper = spamassassin_create_tmp_spamc_wrapper(spam);
+                               }
+
+                               if (spamc_wrapper && tmpfile &&
+                               copy_file(procmsg_get_message_file(info), tmpfile, TRUE) == 0) {
+                                       tmpcmd = g_strconcat(shell?shell:"sh", " ", spamc_wrapper, " ",
+                                                                               tmpfile, NULL);
                                        debug_print("%s\n", tmpcmd);
                                        execute_command_line(tmpcmd, FALSE);
                                        g_free(tmpcmd);
                                }
-                               if (tmpfile)
+                               if (tmpfile != NULL) {
                                        g_free(tmpfile);
+                               }
                        }
-                       async = TRUE;
-
-                       g_free(cmd);
-                       return;
+                       if (spamc_wrapper != NULL) {
+                               g_free(spamc_wrapper);
+                       }
+                       return 0;
                } else {
                        cmd = g_strdup_printf("sa-learn -u %s %s %s",
                                        config.username,
@@ -329,20 +372,23 @@ void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
                                        g_free(cmd);
                                        cmd = tmpcmd;
                                }
-                               if (tmpfile)
+                               if (tmpfile != NULL) {
                                        g_free(tmpfile);
+                               }
                        }
-                       async = TRUE;
                }
        }
-       if (cmd == NULL)
-               return;
+       if (cmd == NULL) {
+               return -1;
+       }
        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);
+       /* only run sync calls to sa-learn/spamc to prevent system lockdown */
+       execute_command_line(cmd, FALSE);
        g_free(cmd);
+       if (spamc_wrapper != NULL) {
+               g_free(spamc_wrapper);
+       }
+       return 0;
 }
 
 void spamassassin_save_config(void)
@@ -359,7 +405,7 @@ void spamassassin_save_config(void)
                return;
 
        if (prefs_write_param(param, pfile->fp) < 0) {
-               g_warning("failed to write SpamAssassin configuration to file\n");
+               g_warning("Failed to write SpamAssassin configuration to file\n");
                prefs_file_close_revert(pfile);
                return;
        }
@@ -373,7 +419,9 @@ gboolean spamassassin_check_username(void)
        if (config.username == NULL || config.username[0] == '\0') {
                config.username = (gchar*)g_get_user_name();
                if (config.username == NULL) {
-                       hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
+                       if (hook_id != -1) {
+                               spamassassin_unregister_hook();
+                       }
                        procmsg_unregister_spam_learner(spamassassin_learn);
                        procmsg_spam_set_folder(NULL);
                        return FALSE;
@@ -391,6 +439,8 @@ gint plugin_init(gchar **error)
 {
        gchar *rcpath;
 
+       hook_id = -1;
+
        if ((sylpheed_get_version() > VERSION_NUMERIC)) {
                *error = g_strdup("Your version of Sylpheed-Claws is newer than the version the SpamAssassin plugin was built with");
                return -1;
@@ -401,12 +451,6 @@ gint plugin_init(gchar **error)
                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;
-       }
-
        prefs_set_default(param);
        rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
        prefs_read_config(param, "SpamAssassin", rcpath, NULL);
@@ -419,13 +463,16 @@ gint plugin_init(gchar **error)
                
        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.process_emails) {
+               spamassassin_register_hook();
        }
 
-       if (config.transport != SPAMASSASSIN_DISABLED) {
+       if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
+               log_error("Spamassassin plugin is loaded but disabled by its preferences.\n");
+       }
+       else {
                if (config.transport == SPAMASSASSIN_TRANSPORT_TCP)
-                       debug_print("enabling learner with a remote spamassassin server requires spamc/spamd 3.1.x\n");
+                       debug_print("Enabling learner with a remote spamassassin server requires spamc/spamd 3.1.x\n");
                procmsg_register_spam_learner(spamassassin_learn);
                procmsg_spam_set_folder(config.save_folder);
        }
@@ -436,7 +483,9 @@ gint plugin_init(gchar **error)
 
 void plugin_done(void)
 {
-       hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
+       if (hook_id != -1) {
+               spamassassin_unregister_hook();
+       }
        g_free(config.hostname);
        g_free(config.save_folder);
        spamassassin_gtk_done();
@@ -476,3 +525,19 @@ const gchar *plugin_version(void)
 {
        return VERSION;
 }
+
+void spamassassin_register_hook(void)
+{
+       hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
+       if (hook_id == -1) {
+               g_warning("Failed to register mail filtering hook");
+               config.process_emails = FALSE;
+       }
+}
+
+void spamassassin_unregister_hook(void)
+{
+       if (hook_id != -1) {
+               hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
+       }
+}