0.9.4claws18
[claws.git] / src / plugins / spamassassin / spamassassin.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2003 Hiroyuki Yamamoto and the Sylpheed-Claws Team
4  *
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.
9  *
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.
14  *
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.
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #  include "config.h"
22 #endif
23
24 #include "defs.h"
25
26 #include <sys/types.h>
27 #include <sys/wait.h>
28
29 #include <glib.h>
30
31 #if HAVE_LOCALE_H
32 #  include <locale.h>
33 #endif
34
35 #include "common/sylpheed.h"
36 #include "common/version.h"
37 #include "plugin.h"
38 #include "common/utils.h"
39 #include "hooks.h"
40 #include "procmsg.h"
41 #include "folder.h"
42 #include "prefs.h"
43 #include "prefs_gtk.h"
44 #include "intl.h"
45
46 #include "libspamc.h"
47 #include "spamassassin.h"
48
49 #ifdef HAVE_SYSEXITS_H
50 #include <sysexits.h>
51 #endif
52 #ifdef HAVE_ERRNO_H
53 #include <errno.h>
54 #endif
55 #ifdef HAVE_SYS_ERRNO_H
56 #include <sys/errno.h>
57 #endif
58 #ifdef HAVE_TIME_H
59 #include <time.h>
60 #endif
61 #ifdef HAVE_SYS_TIME_H
62 #include <sys/time.h>
63 #endif
64 #ifdef HAVE_SIGNAL_H
65 #include <signal.h>
66 #endif
67 #ifdef HAVE_PWD_H
68 #include <pwd.h>
69 #endif
70
71 enum {
72     CHILD_RUNNING = 1 << 0,
73     TIMEOUT_RUNNING = 1 << 1,
74 };
75
76 static guint hook_id;
77 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
78 static gchar *username = NULL;
79
80 static SpamAssassinConfig config;
81
82 static PrefParam param[] = {
83         {"enable", "FALSE", &config.enable, P_BOOL,
84          NULL, NULL, NULL},
85         {"hostname", "localhost", &config.hostname, P_STRING,
86          NULL, NULL, NULL},
87         {"port", "783", &config.port, P_INT,
88          NULL, NULL, NULL},
89         {"max_size", "250", &config.max_size, P_INT,
90          NULL, NULL, NULL},
91         {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
92          NULL, NULL, NULL},
93         {"save_folder", NULL, &config.save_folder, P_STRING,
94          NULL, NULL, NULL},
95
96         {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
97 };
98
99 gboolean timeout_func(gpointer data)
100 {
101         gint *running = (gint *) data;
102
103         if (*running & CHILD_RUNNING)
104                 return TRUE;
105
106         *running &= ~TIMEOUT_RUNNING;
107         return FALSE;
108 }
109
110 static gboolean msg_is_spam(FILE *fp)
111 {
112         struct sockaddr addr;
113         struct message m;
114         gboolean is_spam = FALSE;
115
116         if (lookup_host(config.hostname, config.port, &addr) != EX_OK) {
117                 debug_print("failed to look up spamd host\n");
118                 return FALSE;
119         }
120
121         m.type = MESSAGE_NONE;
122         m.max_len = config.max_size * 1024;
123         m.timeout = 30;
124
125         if (message_read(fileno(fp), flags, &m) != EX_OK) {
126                 debug_print("failed to read message\n");
127                 message_cleanup(&m);
128                 return FALSE;
129         }
130
131         if (message_filter(&addr, username, flags, &m) != EX_OK) {
132                 debug_print("filtering the message failed\n");
133                 message_cleanup(&m);
134                 return FALSE;
135         }
136
137         if (m.is_spam == EX_ISSPAM)
138                 is_spam = TRUE;
139
140         message_cleanup(&m);
141
142         return is_spam;
143 }
144
145 static gboolean mail_filtering_hook(gpointer source, gpointer data)
146 {
147         MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
148         MsgInfo *msginfo = mail_filtering_data->msginfo;
149         gboolean is_spam = FALSE;
150         FILE *fp = NULL;
151         int pid = 0;
152         int status;
153
154         if (!config.enable)
155                 return FALSE;
156
157         debug_print("Filtering message %d\n", msginfo->msgnum);
158
159         if ((fp = procmsg_open_message(msginfo)) == NULL) {
160                 debug_print("failed to open message file\n");
161                 return FALSE;
162         }
163
164         pid = fork();
165         if (pid == 0) {
166                 _exit(msg_is_spam(fp) ? 1 : 0);
167         } else {
168                 gint running = 0;
169
170                 running |= CHILD_RUNNING;
171
172                 g_timeout_add(1000, timeout_func, &running);
173                 running |= TIMEOUT_RUNNING;
174
175                 while(running & CHILD_RUNNING) {
176                         waitpid(pid, &status, WNOHANG);
177                         if (WIFEXITED(status)) {
178                                 running &= ~CHILD_RUNNING;
179                         }
180             
181                         g_main_iteration(TRUE);
182                 }
183
184                 while (running & TIMEOUT_RUNNING)
185                         g_main_iteration(TRUE);
186         }
187         is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
188
189         fclose(fp);
190
191         if (is_spam) {
192                 debug_print("message is spam\n");
193                             
194                 if (config.receive_spam) {
195                         FolderItem *save_folder;
196
197                         if ((!config.save_folder) ||
198                             (config.save_folder[0] == '\0') ||
199                             ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL))
200                                 save_folder = folder_get_default_trash();
201
202                         procmsg_msginfo_unset_flags(msginfo, ~0, 0);
203                         folder_item_move_msg(save_folder, msginfo);
204                 } else {
205                         folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
206                 }
207
208                 return TRUE;
209         }
210         
211         return FALSE;
212 }
213
214 SpamAssassinConfig *spamassassin_get_config(void)
215 {
216         return &config;
217 }
218
219 void spamassassin_save_config(void)
220 {
221         PrefFile *pfile;
222         gchar *rcpath;
223
224         debug_print("Saving SpamAssassin Page\n");
225
226         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
227         pfile = prefs_write_open(rcpath);
228         g_free(rcpath);
229         if (!pfile || (prefs_set_block_label(pfile, "SpamAssassin") < 0))
230                 return;
231
232         if (prefs_write_param(param, pfile->fp) < 0) {
233                 g_warning("failed to write SpamAssassin configuration to file\n");
234                 prefs_file_close_revert(pfile);
235                 return;
236         }
237         fprintf(pfile->fp, "\n");
238
239         prefs_file_close(pfile);
240 }
241
242 gint plugin_init(gchar **error)
243 {
244         if ((sylpheed_get_version() > VERSION_NUMERIC)) {
245                 *error = g_strdup("Your sylpheed version is newer than the version the plugin was built with");
246                 return -1;
247         }
248
249         if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
250                 *error = g_strdup("Your sylpheed version is too old");
251                 return -1;
252         }
253
254         hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
255         if (hook_id == -1) {
256                 *error = g_strdup("Failed to register mail filtering hook");
257                 return -1;
258         }
259
260         username = g_get_user_name();
261         if (username == NULL) {
262                 *error = g_strdup("Failed to get username");
263                 return -1;
264         }
265
266         prefs_set_default(param);
267         prefs_read_config(param, "SpamAssassin", COMMON_RC);
268
269         debug_print("Spamassassin plugin loaded\n");
270
271         return 0;
272         
273 }
274
275 void plugin_done(void)
276 {
277         hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
278         g_free(config.hostname);
279         g_free(config.save_folder);
280
281         debug_print("Spamassassin plugin unloaded\n");
282 }
283
284 const gchar *plugin_name(void)
285 {
286         return _("SpamAssassin");
287 }
288
289 const gchar *plugin_desc(void)
290 {
291         return _("This plugin checks all messages that are received from a POP "
292                  "account for spam using a SpamAssassin server. You will need "
293                  "a SpamAssassin Server (spamd) running somewhere.\n"
294                  "\n"
295                  "When a message is identified as spam it can be deleted or "
296                  "saved into a special folder.\n"
297                  "\n"
298                  "This plugin only contains the actual function for filtering "
299                  "and deleting or moving the message. You probably want to load "
300                  "a User Interface plugin too, otherwise you will have to "
301                  "manually write the plugin configuration.\n");
302 }
303
304 const gchar *plugin_type(void)
305 {
306         return "Common";
307 }