/*
* 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
*
* 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
#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/sylpheed.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 "log.h"
+#include "prefs_common.h"
#ifdef HAVE_SYSEXITS_H
#include <sysexits.h>
#include <pwd.h>
#endif
+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 *username = NULL;
+static MessageCallback message_callback;
static SpamAssassinConfig config;
static PrefParam param[] = {
- {"enable", "FALSE", &config.enable, P_BOOL,
+ {"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},
{"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}
};
-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;
+ 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;
- gchar *oldlocale = NULL;
- struct sockaddr addr;
- int ret;
+ gboolean is_spam = FALSE;
- if (!config.enable)
+ 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;
+ }
- debug_print("Filtering message %d\n", msginfo->msgnum);
-
- if (lookup_host(config.hostname, config.port, &addr) != EX_OK) {
- debug_print("failed to look up spamd host\n");
+ 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;
}
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;
}
- if ((ret = message_filter(&addr, username, flags, &m)) != EX_OK) {
+ if (message_filter(&trans, username, flags, &m) != EX_OK) {
debug_print("filtering the message failed\n");
- fclose(fp);
message_cleanup(&m);
return FALSE;
}
is_spam = TRUE;
message_cleanup(&m);
+
+ return is_spam;
+}
+
+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;
+ FILE *fp = NULL;
+ int pid = 0;
+ int status;
+
+ 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..."));
+
+ if ((fp = procmsg_open_message(msginfo)) == NULL) {
+ debug_print("failed to open message file\n");
+ return FALSE;
+ }
+
+ pid = fork();
+ if (pid == 0) {
+ _exit(msg_is_spam(fp) ? 1 : 0);
+ } 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)) {
+ running &= ~CHILD_RUNNING;
+ is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
+ }
+ } if (ret < 0) {
+ running &= ~CHILD_RUNNING;
+ } /* ret == 0 continue */
+
+ g_main_iteration(TRUE);
+ }
+
+ while (running & TIMEOUT_RUNNING)
+ g_main_iteration(TRUE);
+ }
+
fclose(fp);
if (is_spam) {
debug_print("message is spam\n");
-
+ procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
if (config.receive_spam) {
FolderItem *save_folder;
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;
}
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;
prefs_file_close(pfile);
}
+void spamassassin_set_message_callback(MessageCallback callback)
+{
+ message_callback = callback;
+}
+
gint plugin_init(gchar **error)
{
+ gchar *rcpath;
+
+ 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;
+ }
+
+ 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;
+ }
+
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;
}
- 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");
return -1;
}
prefs_set_default(param);
- prefs_read_config(param, "SpamAssassin", COMMON_RC);
-
+ 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;
}
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");
}
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 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");
+ "\n");
}
const gchar *plugin_type(void)
{
- return "Common";
+ return "GTK2";
+}
+
+const gchar *plugin_licence(void)
+{
+ return "GPL";
}
+
+const gchar *plugin_version(void)
+{
+ return VERSION;
+}
+
projects / claws.git / blobdiff