2008-05-12 [wwp] 3.4.0cvs30
[claws.git] / src / plugins / spamassassin / spamassassin.c
index d698045601c30d62267b82b03582a51290608d7a..2bde5a93583676e84ba440e9878e34065bda0a12 100644 (file)
@@ -1,10 +1,10 @@
 /*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifdef HAVE_CONFIG_H
@@ -33,7 +33,7 @@
 #  include <locale.h>
 #endif
 
-#include "common/sylpheed.h"
+#include "common/claws.h"
 #include "common/version.h"
 #include "plugin.h"
 #include "common/utils.h"
@@ -49,6 +49,7 @@
 #include "log.h"
 #include "prefs_common.h"
 #include "alertpanel.h"
+#include "addr_compl.h"
 
 #ifdef HAVE_SYSEXITS_H
 #include <sysexits.h>
@@ -72,6 +73,8 @@
 #include <pwd.h>
 #endif
 
+#define PLUGIN_NAME (_("SpamAssassin"))
+
 enum {
     CHILD_RUNNING = 1 << 0,
     TIMEOUT_RUNNING = 1 << 1,
@@ -106,6 +109,12 @@ static PrefParam param[] = {
         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}
 };
@@ -156,7 +165,7 @@ static MsgStatus msg_is_spam(FILE *fp)
        }
 
        if (transport_setup(&trans, flags) != EX_OK) {
-               log_error(_("SpamAssassin plugin couldn't connect to spamd.\n"));
+               log_error(LOG_PROTOCOL, _("SpamAssassin plugin couldn't connect to spamd.\n"));
                debug_print("failed to setup transport\n");
                return MSG_FILTERING_ERROR;
        }
@@ -172,7 +181,7 @@ static MsgStatus msg_is_spam(FILE *fp)
        }
 
        if (message_filter(&trans, config.username, flags, &m) != EX_OK) {
-               log_error(_("SpamAssassin plugin filtering failed.\n"));
+               log_error(LOG_PROTOCOL, _("SpamAssassin plugin filtering failed.\n"));
                debug_print("filtering the message failed\n");
                message_cleanup(&m);
                return MSG_FILTERING_ERROR;
@@ -186,6 +195,33 @@ static MsgStatus msg_is_spam(FILE *fp)
        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;
@@ -198,7 +234,7 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
 
        /* SPAMASSASSIN_DISABLED : keep test for compatibility purpose */
        if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
-               log_warning(_("SpamAssassin plugin is disabled by its preferences.\n"));
+               log_warning(LOG_PROTOCOL, _("SpamAssassin plugin is disabled by its preferences.\n"));
                return FALSE;
        }
        debug_print("Filtering message %d\n", msginfo->msgnum);
@@ -210,6 +246,30 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
                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));
@@ -250,16 +310,51 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
                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);
+                           ((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->is_move = TRUE;
+                       msginfo->filter_op = IS_MOVE;
                        msginfo->to_filter_folder = save_folder;
                } else {
                        folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
@@ -278,13 +373,11 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
                                           "sure spamd is running and accessible.");
                if (!prefs_common.no_recv_err_panel) {
                        if (!warned_error) {
-                               alertpanel_error(msg);
+                               alertpanel_error("%s", msg);
                        }
                        warned_error = TRUE;
                } else {
-                       gchar *tmp = g_strdup_printf("%s\n", msg);
-                       log_error(tmp);
-                       g_free(tmp);
+                       log_error(LOG_PROTOCOL, "%s\n", msg);
                }
        }
        
@@ -330,8 +423,8 @@ int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
 
        if (config.transport == SPAMASSASSIN_TRANSPORT_TCP
        &&  prefs_common.work_offline
-       &&  !inc_offline_should_override(
-               _("Sylpheed-Claws needs network access in order "
+       &&  !inc_offline_should_override(TRUE,
+               _("Claws Mail needs network access in order "
                  "to feed this mail(s) to the remote learner."))) {
                return -1;
        }
@@ -433,9 +526,11 @@ void spamassassin_save_config(void)
                prefs_file_close_revert(pfile);
                return;
        }
-       fprintf(pfile->fp, "\n");
-
-       prefs_file_close(pfile);
+        if (fprintf(pfile->fp, "\n") < 0) {
+               FILE_OP_ERROR(rcpath, "fprintf");
+               prefs_file_close_revert(pfile);
+       } else
+               prefs_file_close(pfile);
 }
 
 gboolean spamassassin_check_username(void)
@@ -447,7 +542,7 @@ gboolean spamassassin_check_username(void)
                                spamassassin_unregister_hook();
                        }
                        procmsg_unregister_spam_learner(spamassassin_learn);
-                       procmsg_spam_set_folder(NULL);
+                       procmsg_spam_set_folder(NULL, NULL);
                        return FALSE;
                }
        }
@@ -465,15 +560,9 @@ gint plugin_init(gchar **error)
 
        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"));
+       if (!check_plugin_version(MAKE_NUMERIC_VERSION(2,9,2,72),
+                               VERSION_NUMERIC, PLUGIN_NAME, error))
                return -1;
-       }
-
-       if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
-               *error = g_strdup(_("Your version of Sylpheed-Claws is too old for the SpamAssassin plugin"));
-               return -1;
-       }
 
        prefs_set_default(param);
        rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
@@ -492,20 +581,20 @@ gint plugin_init(gchar **error)
        }
 
        if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
-               log_warning(_("SpamAssassin plugin is loaded but disabled by its preferences.\n"));
+               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);
+               procmsg_spam_set_folder(config.save_folder, spamassassin_get_spam_folder);
        }
 
        return 0;
        
 }
 
-void plugin_done(void)
+gboolean plugin_done(void)
 {
        if (hook_id != -1) {
                spamassassin_unregister_hook();
@@ -514,13 +603,14 @@ void plugin_done(void)
        g_free(config.save_folder);
        spamassassin_gtk_done();
        procmsg_unregister_spam_learner(spamassassin_learn);
-       procmsg_spam_set_folder(NULL);
+       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)
@@ -545,7 +635,7 @@ const gchar *plugin_type(void)
 
 const gchar *plugin_licence(void)
 {
-       return "GPL";
+       return "GPL3+";
 }
 
 const gchar *plugin_version(void)
@@ -579,3 +669,30 @@ void spamassassin_unregister_hook(void)
        }
        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;
+}
+