2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2003 Hiroyuki Yamamoto and the Sylpheed-Claws Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <sys/types.h>
35 #include "common/sylpheed.h"
36 #include "common/version.h"
38 #include "common/utils.h"
43 #include "prefs_gtk.h"
47 #include "spamassassin.h"
49 #ifdef HAVE_SYSEXITS_H
55 #ifdef HAVE_SYS_ERRNO_H
56 #include <sys/errno.h>
61 #ifdef HAVE_SYS_TIME_H
72 CHILD_RUNNING = 1 << 0,
73 TIMEOUT_RUNNING = 1 << 1,
77 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
78 static gchar *username = NULL;
80 static SpamAssassinConfig config;
82 static PrefParam param[] = {
83 {"transport", "0", &config.transport, P_INT,
85 {"hostname", "localhost", &config.hostname, P_STRING,
87 {"port", "783", &config.port, P_INT,
89 {"socket", "", &config.socket, P_STRING,
91 {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
93 {"save_folder", NULL, &config.save_folder, P_STRING,
95 {"max_size", "250", &config.max_size, P_INT,
97 {"timeout", "30", &config.timeout, P_INT,
100 {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
103 gboolean timeout_func(gpointer data)
105 gint *running = (gint *) data;
107 if (*running & CHILD_RUNNING)
110 *running &= ~TIMEOUT_RUNNING;
114 static gboolean msg_is_spam(FILE *fp)
116 struct transport trans;
118 gboolean is_spam = FALSE;
120 transport_init(&trans);
121 switch (config.transport) {
122 case SPAMASSASSIN_TRANSPORT_LOCALHOST:
123 trans.type = TRANSPORT_LOCALHOST;
124 trans.port = config.port;
126 case SPAMASSASSIN_TRANSPORT_TCP:
127 trans.type = TRANSPORT_TCP;
128 trans.hostname = config.hostname;
129 trans.port = config.port;
131 case SPAMASSASSIN_TRANSPORT_UNIX:
132 trans.type = TRANSPORT_UNIX;
133 trans.socketpath = config.socket;
139 if (transport_setup(&trans, flags) != EX_OK) {
140 debug_print("failed to setup transport\n");
144 m.type = MESSAGE_NONE;
145 m.max_len = config.max_size * 1024;
146 m.timeout = config.timeout;
148 if (message_read(fileno(fp), flags, &m) != EX_OK) {
149 debug_print("failed to read message\n");
154 if (message_filter(&trans, username, flags, &m) != EX_OK) {
155 debug_print("filtering the message failed\n");
160 if (m.is_spam == EX_ISSPAM)
168 static gboolean mail_filtering_hook(gpointer source, gpointer data)
170 MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
171 MsgInfo *msginfo = mail_filtering_data->msginfo;
172 gboolean is_spam = FALSE;
177 if (config.transport == SPAMASSASSIN_DISABLED)
180 debug_print("Filtering message %d\n", msginfo->msgnum);
182 if ((fp = procmsg_open_message(msginfo)) == NULL) {
183 debug_print("failed to open message file\n");
189 _exit(msg_is_spam(fp) ? 1 : 0);
193 running |= CHILD_RUNNING;
195 g_timeout_add(1000, timeout_func, &running);
196 running |= TIMEOUT_RUNNING;
198 while(running & CHILD_RUNNING) {
199 waitpid(pid, &status, WNOHANG);
200 if (WIFEXITED(status)) {
201 running &= ~CHILD_RUNNING;
204 g_main_iteration(TRUE);
207 while (running & TIMEOUT_RUNNING)
208 g_main_iteration(TRUE);
210 is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
215 debug_print("message is spam\n");
217 if (config.receive_spam) {
218 FolderItem *save_folder;
220 if ((!config.save_folder) ||
221 (config.save_folder[0] == '\0') ||
222 ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL))
223 save_folder = folder_get_default_trash();
225 procmsg_msginfo_unset_flags(msginfo, ~0, 0);
226 folder_item_move_msg(save_folder, msginfo);
228 folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
237 SpamAssassinConfig *spamassassin_get_config(void)
242 void spamassassin_save_config(void)
247 debug_print("Saving SpamAssassin Page\n");
249 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
250 pfile = prefs_write_open(rcpath);
252 if (!pfile || (prefs_set_block_label(pfile, "SpamAssassin") < 0))
255 if (prefs_write_param(param, pfile->fp) < 0) {
256 g_warning("failed to write SpamAssassin configuration to file\n");
257 prefs_file_close_revert(pfile);
260 fprintf(pfile->fp, "\n");
262 prefs_file_close(pfile);
265 gint plugin_init(gchar **error)
267 if ((sylpheed_get_version() > VERSION_NUMERIC)) {
268 *error = g_strdup("Your sylpheed version is newer than the version the plugin was built with");
272 if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
273 *error = g_strdup("Your sylpheed version is too old");
277 hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
279 *error = g_strdup("Failed to register mail filtering hook");
283 username = g_get_user_name();
284 if (username == NULL) {
285 *error = g_strdup("Failed to get username");
289 prefs_set_default(param);
290 prefs_read_config(param, "SpamAssassin", COMMON_RC);
292 debug_print("Spamassassin plugin loaded\n");
298 void plugin_done(void)
300 hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
301 g_free(config.hostname);
302 g_free(config.save_folder);
304 debug_print("Spamassassin plugin unloaded\n");
307 const gchar *plugin_name(void)
309 return _("SpamAssassin");
312 const gchar *plugin_desc(void)
314 return _("This plugin checks all messages that are received from an "
315 "IMAP, LOCAL or POP account for spam using a SpamAssassin "
316 "server. You will need a SpamAssassin Server (spamd) running "
319 "When a message is identified as spam it can be deleted or "
320 "saved into a special folder.\n"
322 "This plugin only contains the actual function for filtering "
323 "and deleting or moving the message. You probably want to load "
324 "a User Interface plugin too, otherwise you will have to "
325 "manually write the plugin configuration.\n");
328 const gchar *plugin_type(void)