2008-05-12 [wwp] 3.4.0cvs30
[claws.git] / src / plugins / spamassassin / spamassassin.c
index 1da9d8f367359c9a1aec07c4d9f4d26738fcd695..2bde5a93583676e84ba440e9878e34065bda0a12 100644 (file)
@@ -1,10 +1,10 @@
 /*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2003 Hiroyuki Yamamoto and the Sylpheed-Claws Team
+ * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 1999-2007 the Claws Mail 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
@@ -13,8 +13,8 @@
  * GNU General Public License for more details.
  *
  * 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.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifdef HAVE_CONFIG_H
 
 #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/claws.h"
+#include "common/version.h"
 #include "plugin.h"
 #include "common/utils.h"
 #include "hooks.h"
 #include "folder.h"
 #include "prefs.h"
 #include "prefs_gtk.h"
-#include "intl.h"
 
 #include "libspamc.h"
 #include "spamassassin.h"
+#include "inc.h"
+#include "log.h"
+#include "prefs_common.h"
+#include "alertpanel.h"
+#include "addr_compl.h"
 
 #ifdef HAVE_SYSEXITS_H
 #include <sysexits.h>
 #include <pwd.h>
 #endif
 
-static guint hook_id;
+#define PLUGIN_NAME (_("SpamAssassin"))
+
+enum {
+    CHILD_RUNNING = 1 << 0,
+    TIMEOUT_RUNNING = 1 << 1,
+};
+
+static guint hook_id = -1;
 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
-static gchar *username = NULL;
+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,
         NULL, NULL, NULL},
        {"port", "783", &config.port, P_INT,
         NULL, NULL, NULL},
-       {"max_size", "250", &config.max_size, P_INT,
+       {"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,
         NULL, NULL, NULL},
+       {"max_size", "250", &config.max_size, P_INT,
+        NULL, NULL, NULL},
+       {"timeout", "30", &config.timeout, P_INT,
+        NULL, NULL, NULL},
+       {"username", "", &config.username, P_STRING,
+        NULL, NULL, NULL},
+       {"mark_as_read", "TRUE", &config.mark_as_read, P_BOOL,
+        NULL, NULL, NULL},
+       {"whitelist_ab", "FALSE", &config.whitelist_ab, P_BOOL,
+        NULL, NULL, NULL},
+       {"whitelist_ab_folder", N_("Any"), &config.whitelist_ab_folder, P_STRING,
+        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;
-       gchar *oldlocale = NULL;
-       struct sockaddr addr;
-       int ret;
+       gint *running = (gint *) data;
 
-       if (!config.enable)
-               return FALSE;
+       if (*running & CHILD_RUNNING)
+               return TRUE;
 
-       debug_print("Filtering message %d\n", msginfo->msgnum);
+       *running &= ~TIMEOUT_RUNNING;
+       return FALSE;
+}
 
-       /* remember old locale and set it to C */
-       Xstrdup_a(oldlocale, setlocale(LC_ALL, NULL), return FALSE);
-       setlocale(LC_ALL, "C");
+typedef enum {
+       MSG_IS_HAM = 0,
+       MSG_IS_SPAM = 1,
+       MSG_FILTERING_ERROR = 2
+} MsgStatus;
 
-       if (lookup_host(config.hostname, config.port, &addr) != EX_OK) {
-               debug_print("failed to look up spamd host\n");
-               return FALSE;
+static MsgStatus msg_is_spam(FILE *fp)
+{
+       struct transport trans;
+       struct message m;
+       gboolean is_spam = FALSE;
+
+       if (!config.enable)
+               return MSG_IS_HAM;
+
+       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 MSG_IS_HAM;
+       }
+
+       if (transport_setup(&trans, flags) != EX_OK) {
+               log_error(LOG_PROTOCOL, _("SpamAssassin plugin couldn't connect to spamd.\n"));
+               debug_print("failed to setup transport\n");
+               return MSG_FILTERING_ERROR;
        }
 
        m.type = MESSAGE_NONE;
        m.max_len = config.max_size * 1024;
-       m.timeout = 30;
-
-       if ((fp = procmsg_open_message(msginfo)) == NULL) {
-               debug_print("failed to open message file\n");
-               return FALSE;
-       }
+       m.timeout = config.timeout;
 
        if (message_read(fileno(fp), flags, &m) != EX_OK) {
                debug_print("failed to read message\n");
-               fclose(fp);
                message_cleanup(&m);
-               return FALSE;
+               return MSG_FILTERING_ERROR;
        }
 
-       if ((ret = message_filter(&addr, username, flags, &m)) != EX_OK) {
+       if (message_filter(&trans, config.username, flags, &m) != EX_OK) {
+               log_error(LOG_PROTOCOL, _("SpamAssassin plugin filtering failed.\n"));
                debug_print("filtering the message failed\n");
-               fclose(fp);
                message_cleanup(&m);
-               return FALSE;
+               return MSG_FILTERING_ERROR;
        }
 
        if (m.is_spam == EX_ISSPAM)
                is_spam = TRUE;
 
        message_cleanup(&m);
+
+       return is_spam ? MSG_IS_SPAM:MSG_IS_HAM;
+}
+
+static gboolean sa_found_in_addressbook(const gchar *address)
+{
+       gchar *addr = NULL;
+       gboolean found = FALSE;
+       gint num_addr = 0;
+       
+       if (!address)
+               return FALSE;
+       
+       addr = g_strdup(address);
+       extract_address(addr);
+       num_addr = complete_address(addr);
+       if (num_addr > 1) {
+               /* skip first item (this is the search string itself) */
+               int i = 1;
+               for (; i < num_addr && !found; i++) {
+                       gchar *caddr = get_complete_address(i);
+                       extract_address(caddr);
+                       if (strcasecmp(caddr, addr) == 0)
+                               found = TRUE;
+                       g_free(caddr);
+               }
+       }
+       g_free(addr);
+       return found;
+}
+
+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, error = FALSE;
+       static gboolean warned_error = FALSE;
+       FILE *fp = NULL;
+       int pid = 0;
+       int status;
+
+       /* SPAMASSASSIN_DISABLED : keep test for compatibility purpose */
+       if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
+               log_warning(LOG_PROTOCOL, _("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..."));
+
+       if ((fp = procmsg_open_message(msginfo)) == NULL) {
+               debug_print("failed to open message file\n");
+               return FALSE;
+       }
+
+       if (config.whitelist_ab) {
+               gchar *ab_folderpath;
+               gboolean whitelisted = FALSE;
+
+               if (*config.whitelist_ab_folder == '\0' ||
+                       strcasecmp(config.whitelist_ab_folder, "Any") == 0) {
+                       /* match the whole addressbook */
+                       ab_folderpath = NULL;
+               } else {
+                       /* match the specific book/folder of the addressbook */
+                       ab_folderpath = config.whitelist_ab_folder;
+               }
+
+               start_address_completion(ab_folderpath);
+               if (msginfo->from && 
+                   sa_found_in_addressbook(msginfo->from))
+                               whitelisted = TRUE;
+               end_address_completion();
+               
+               if (whitelisted) {
+                       debug_print("message is ham (whitelisted)\n");
+                       return FALSE;
+               }
+       }
+       pid = fork();
+       if (pid == 0) {
+               _exit(msg_is_spam(fp));
+       } 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)) {
+                                       MsgStatus result = MSG_IS_HAM;
+                                       running &= ~CHILD_RUNNING;
+                                       result = WEXITSTATUS(status);
+                                       is_spam = (result == MSG_IS_SPAM) ? TRUE : FALSE;
+                                       error = (result == MSG_FILTERING_ERROR);
+                               }
+                       } if (ret < 0) {
+                               running &= ~CHILD_RUNNING;
+                       } /* ret == 0 continue */
+           
+                       g_main_iteration(TRUE);
+               }
+
+               while (running & TIMEOUT_RUNNING)
+                       g_main_iteration(TRUE);
+       }
+
        fclose(fp);
-       setlocale(LC_ALL, oldlocale);
 
        if (is_spam) {
                debug_print("message is spam\n");
-                           
+               procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
                if (config.receive_spam) {
-                       FolderItem *save_folder;
+                       FolderItem *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);
-                       folder_item_move_msg(save_folder, msginfo);
+                           ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL)) {
+                               if (mail_filtering_data->account && mail_filtering_data->account->set_trash_folder) {
+                                       save_folder = folder_find_item_from_identifier(
+                                               mail_filtering_data->account->trash_folder);
+                                       if (save_folder)
+                                               debug_print("found trash folder from account's advanced settings\n");
+                               }
+                               if (save_folder == NULL && mail_filtering_data->account &&
+                                   mail_filtering_data->account->folder) {
+                                       save_folder = mail_filtering_data->account->folder->trash;
+                                       if (save_folder)
+                                               debug_print("found trash folder from account's trash\n");
+                               }
+                               if (save_folder == NULL && mail_filtering_data->account &&
+                                   !mail_filtering_data->account->folder)  {
+                                       if (mail_filtering_data->account->inbox) {
+                                               FolderItem *item = folder_find_item_from_identifier(
+                                                       mail_filtering_data->account->inbox);
+                                               if (item && item->folder->trash) {
+                                                       save_folder = item->folder->trash;
+                                                       debug_print("found trash folder from account's inbox\n");
+                                               }
+                                       } 
+                                       if (!save_folder && mail_filtering_data->account->local_inbox) {
+                                               FolderItem *item = folder_find_item_from_identifier(
+                                                       mail_filtering_data->account->local_inbox);
+                                               if (item && item->folder->trash) {
+                                                       save_folder = item->folder->trash;
+                                                       debug_print("found trash folder from account's local_inbox\n");
+                                               }
+                                       }
+                               }
+                               if (save_folder == NULL) {
+                                       debug_print("using default trash folder\n");
+                                       save_folder = folder_get_default_trash();
+                               }
+                       }
+                       if (config.mark_as_read)
+                               procmsg_msginfo_unset_flags(msginfo, ~0, 0);
+                       procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
+                       msginfo->filter_op = IS_MOVE;
+                       msginfo->to_filter_folder = save_folder;
                } 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);
+       }
+       
+       if (error) {
+               gchar *msg = _("The SpamAssassin plugin couldn't filter "
+                                          "a message. The probable cause of the error "
+                                          "is an unreachable spamd daemon. Please make "
+                                          "sure spamd is running and accessible.");
+               if (!prefs_common.no_recv_err_panel) {
+                       if (!warned_error) {
+                               alertpanel_error("%s", msg);
+                       }
+                       warned_error = TRUE;
+               } else {
+                       log_error(LOG_PROTOCOL, "%s\n", msg);
+               }
        }
        
        return FALSE;
@@ -169,6 +389,125 @@ SpamAssassinConfig *spamassassin_get_config(void)
        return &config;
 }
 
+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;
+       const gchar *shell = g_getenv("SHELL");
+       gchar *spamc_wrapper = NULL;
+
+       if (msginfo == NULL && msglist == NULL) {
+               return -1;
+       }
+
+       if (config.transport == SPAMASSASSIN_TRANSPORT_TCP
+       &&  prefs_common.work_offline
+       &&  !inc_offline_should_override(TRUE,
+               _("Claws Mail 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 -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);
+               }
+       }
+       if (msglist) {
+               GSList *cur = msglist;
+               MsgInfo *info;
+
+               if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
+                       /* execute n-times the spamc command */
+                       for (; cur; cur = cur->next) {
+                               info = (MsgInfo *)cur->data;
+                               gchar *tmpcmd = NULL;
+                               gchar *tmpfile = get_tmp_file();
+
+                               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);
+                               }
+                               g_free(tmpfile);
+                       }
+                       g_free(spamc_wrapper);
+                       return 0;
+               } else {
+                       cmd = g_strdup_printf("sa-learn -u %s %s %s",
+                                       config.username,
+                                       prefs_common.work_offline?"-L":"",
+                                       spam?"--spam":"--ham");
+
+                       /* concatenate all message tmpfiles to the sa-learn command-line */
+                       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);
+                                       g_free(cmd);
+                                       cmd = tmpcmd;
+                               }
+                               g_free(tmpfile);
+                       }
+               }
+       }
+       if (cmd == NULL) {
+               return -1;
+       }
+       debug_print("%s\n", cmd);
+       /* only run sync calls to sa-learn/spamc to prevent system lockdown */
+       execute_command_line(cmd, FALSE);
+       g_free(cmd);
+       g_free(spamc_wrapper);
+
+       return 0;
+}
+
 void spamassassin_save_config(void)
 {
        PrefFile *pfile;
@@ -183,68 +522,177 @@ 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;
        }
-       fprintf(pfile->fp, "\n");
+        if (fprintf(pfile->fp, "\n") < 0) {
+               FILE_OP_ERROR(rcpath, "fprintf");
+               prefs_file_close_revert(pfile);
+       } else
+               prefs_file_close(pfile);
+}
 
-       prefs_file_close(pfile);
+gboolean spamassassin_check_username(void)
+{
+       if (config.username == NULL || config.username[0] == '\0') {
+               config.username = (gchar*)g_get_user_name();
+               if (config.username == NULL) {
+                       if (hook_id != -1) {
+                               spamassassin_unregister_hook();
+                       }
+                       procmsg_unregister_spam_learner(spamassassin_learn);
+                       procmsg_spam_set_folder(NULL, NULL);
+                       return FALSE;
+               }
+       }
+       return TRUE;
+}
+
+void spamassassin_set_message_callback(MessageCallback callback)
+{
+       message_callback = callback;
 }
 
 gint plugin_init(gchar **error)
 {
-       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");
+       gchar *rcpath;
+
+       hook_id = -1;
+
+       if (!check_plugin_version(MAKE_NUMERIC_VERSION(2,9,2,72),
+                               VERSION_NUMERIC, PLUGIN_NAME, error))
                return -1;
-       }
 
-       username = g_get_user_name();
-       if (username == NULL) {
-               *error = g_strdup("Failed to get username");
+       prefs_set_default(param);
+       rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
+       prefs_read_config(param, "SpamAssassin", rcpath, NULL);
+       g_free(rcpath);
+       if (!spamassassin_check_username()) {
+               *error = g_strdup(_("Failed to get username"));
                return -1;
        }
+       spamassassin_gtk_init();
+               
+       debug_print("SpamAssassin plugin loaded\n");
 
-       prefs_set_default(param);
-       prefs_read_config(param, "SpamAssassin", COMMON_RC);
+       if (config.process_emails) {
+               spamassassin_register_hook();
+       }
 
-       debug_print("Spamassassin plugin loaded\n");
+       if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
+               log_warning(LOG_PROTOCOL, _("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");
+               procmsg_register_spam_learner(spamassassin_learn);
+               procmsg_spam_set_folder(config.save_folder, spamassassin_get_spam_folder);
+       }
 
        return 0;
        
 }
 
-void plugin_done(void)
+gboolean 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);
-
-       debug_print("Spamassassin plugin unloaded\n");
+       spamassassin_gtk_done();
+       procmsg_unregister_spam_learner(spamassassin_learn);
+       procmsg_spam_set_folder(NULL, NULL);
+       debug_print("SpamAssassin plugin unloaded\n");
+       return TRUE;
 }
 
 const gchar *plugin_name(void)
 {
-       return _("SpamAssassin");
+       return PLUGIN_NAME;
 }
 
 const gchar *plugin_desc(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"
+       return _("This plugin can check 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"
+                "It can also be used for marking messages as Ham or Spam.\n"
                 "\n"
                 "When a message is identified as spam it can be deleted or "
-                "saved into a special folder.\n"
+                "saved in a specially designated 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");
+                "Options can be found in /Configuration/Preferences/Plugins/SpamAssassin");
 }
 
 const gchar *plugin_type(void)
 {
-       return "Common";
+       return "GTK2";
+}
+
+const gchar *plugin_licence(void)
+{
+       return "GPL3+";
+}
+
+const gchar *plugin_version(void)
+{
+       return VERSION;
+}
+
+struct PluginFeature *plugin_provides(void)
+{
+       static struct PluginFeature features[] = 
+               { {PLUGIN_FILTERING, N_("Spam detection")},
+                 {PLUGIN_FILTERING, N_("Spam learning")},
+                 {PLUGIN_NOTHING, NULL}};
+       return features;
+}
+
+void spamassassin_register_hook(void)
+{
+       if (hook_id == -1)
+               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);
+       }
+       hook_id = -1;
+}
+
+FolderItem *spamassassin_get_spam_folder(MsgInfo *msginfo)
+{
+       FolderItem *item = folder_find_item_from_identifier(config.save_folder);
+
+       if (item || msginfo == NULL || msginfo->folder == NULL)
+               return item;
+
+       if (msginfo->folder->folder &&
+           msginfo->folder->folder->account && 
+           msginfo->folder->folder->account->set_trash_folder) {
+               item = folder_find_item_from_identifier(
+                       msginfo->folder->folder->account->trash_folder);
+       }
+
+       if (item == NULL && 
+           msginfo->folder->folder &&
+           msginfo->folder->folder->trash)
+               item = msginfo->folder->folder->trash;
+               
+       if (item == NULL)
+               item = folder_get_default_trash();
+               
+       debug_print("SA spam dir: %s\n", folder_item_get_path(item));
+       return item;
+}
+