f7762b47ae9944286e5536a5c6b4e01210564b20
[claws.git] / src / plugins / spamassassin / spamassassin.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 #include <glib/gi18n.h>
31
32 #if HAVE_LOCALE_H
33 #  include <locale.h>
34 #endif
35
36 #include "common/sylpheed.h"
37 #include "common/version.h"
38 #include "plugin.h"
39 #include "common/utils.h"
40 #include "hooks.h"
41 #include "procmsg.h"
42 #include "folder.h"
43 #include "prefs.h"
44 #include "prefs_gtk.h"
45
46 #include "libspamc.h"
47 #include "spamassassin.h"
48 #include "inc.h"
49 #include "log.h"
50 #include "prefs_common.h"
51
52 #ifdef HAVE_SYSEXITS_H
53 #include <sysexits.h>
54 #endif
55 #ifdef HAVE_ERRNO_H
56 #include <errno.h>
57 #endif
58 #ifdef HAVE_SYS_ERRNO_H
59 #include <sys/errno.h>
60 #endif
61 #ifdef HAVE_TIME_H
62 #include <time.h>
63 #endif
64 #ifdef HAVE_SYS_TIME_H
65 #include <sys/time.h>
66 #endif
67 #ifdef HAVE_SIGNAL_H
68 #include <signal.h>
69 #endif
70 #ifdef HAVE_PWD_H
71 #include <pwd.h>
72 #endif
73
74 enum {
75     CHILD_RUNNING = 1 << 0,
76     TIMEOUT_RUNNING = 1 << 1,
77 };
78
79 static guint hook_id = -1;
80 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
81 static MessageCallback message_callback;
82
83 static SpamAssassinConfig config;
84
85 static PrefParam param[] = {
86         {"transport", "0", &config.transport, P_INT,
87          NULL, NULL, NULL},
88         {"hostname", "localhost", &config.hostname, P_STRING,
89          NULL, NULL, NULL},
90         {"port", "783", &config.port, P_INT,
91          NULL, NULL, NULL},
92         {"socket", "", &config.socket, P_STRING,
93          NULL, NULL, NULL},
94         {"process_emails", "TRUE", &config.process_emails, P_BOOL,
95          NULL, NULL, NULL},
96         {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
97          NULL, NULL, NULL},
98         {"save_folder", NULL, &config.save_folder, P_STRING,
99          NULL, NULL, NULL},
100         {"max_size", "250", &config.max_size, P_INT,
101          NULL, NULL, NULL},
102         {"timeout", "30", &config.timeout, P_INT,
103          NULL, NULL, NULL},
104         {"username", "", &config.username, P_STRING,
105          NULL, NULL, NULL},
106
107         {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
108 };
109
110 gboolean timeout_func(gpointer data)
111 {
112         gint *running = (gint *) data;
113
114         if (*running & CHILD_RUNNING)
115                 return TRUE;
116
117         *running &= ~TIMEOUT_RUNNING;
118         return FALSE;
119 }
120
121 static gboolean msg_is_spam(FILE *fp)
122 {
123         struct transport trans;
124         struct message m;
125         gboolean is_spam = FALSE;
126
127         transport_init(&trans);
128         switch (config.transport) {
129         case SPAMASSASSIN_TRANSPORT_LOCALHOST:
130                 trans.type = TRANSPORT_LOCALHOST;
131                 trans.port = config.port;
132                 break;
133         case SPAMASSASSIN_TRANSPORT_TCP:
134                 trans.type = TRANSPORT_TCP;
135                 trans.hostname = config.hostname;
136                 trans.port = config.port;
137                 break;
138         case SPAMASSASSIN_TRANSPORT_UNIX:
139                 trans.type = TRANSPORT_UNIX;
140                 trans.socketpath = config.socket;
141                 break;
142         default:
143                 return FALSE;
144         }
145
146         if (transport_setup(&trans, flags) != EX_OK) {
147                 log_error("Spamassassin plugin couldn't connect to spamd.\n");
148                 debug_print("failed to setup transport\n");
149                 return FALSE;
150         }
151
152         m.type = MESSAGE_NONE;
153         m.max_len = config.max_size * 1024;
154         m.timeout = config.timeout;
155
156         if (message_read(fileno(fp), flags, &m) != EX_OK) {
157                 debug_print("failed to read message\n");
158                 message_cleanup(&m);
159                 return FALSE;
160         }
161
162         if (message_filter(&trans, config.username, flags, &m) != EX_OK) {
163                 debug_print("filtering the message failed\n");
164                 message_cleanup(&m);
165                 return FALSE;
166         }
167
168         if (m.is_spam == EX_ISSPAM)
169                 is_spam = TRUE;
170
171         message_cleanup(&m);
172
173         return is_spam;
174 }
175
176 static gboolean mail_filtering_hook(gpointer source, gpointer data)
177 {
178         MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
179         MsgInfo *msginfo = mail_filtering_data->msginfo;
180         gboolean is_spam = FALSE;
181         FILE *fp = NULL;
182         int pid = 0;
183         int status;
184
185         if (config.transport == SPAMASSASSIN_DISABLED) {
186                 log_error("Spamassassin plugin is disabled by its preferences.\n");
187                 return FALSE;
188         }
189         debug_print("Filtering message %d\n", msginfo->msgnum);
190         if (message_callback != NULL)
191                 message_callback(_("SpamAssassin: filtering message..."));
192
193         if ((fp = procmsg_open_message(msginfo)) == NULL) {
194                 debug_print("failed to open message file\n");
195                 return FALSE;
196         }
197
198         pid = fork();
199         if (pid == 0) {
200                 _exit(msg_is_spam(fp) ? 1 : 0);
201         } else {
202                 gint running = 0;
203
204                 running |= CHILD_RUNNING;
205
206                 g_timeout_add(50, timeout_func, &running);
207                 running |= TIMEOUT_RUNNING;
208
209                 while(running & CHILD_RUNNING) {
210                         int ret;
211
212                         ret = waitpid(pid, &status, WNOHANG);
213                         if (ret == pid) {
214                                 if (WIFEXITED(status)) {
215                                         running &= ~CHILD_RUNNING;
216                                         is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
217                                 }
218                         } if (ret < 0) {
219                                 running &= ~CHILD_RUNNING;
220                         } /* ret == 0 continue */
221             
222                         g_main_iteration(TRUE);
223                 }
224
225                 while (running & TIMEOUT_RUNNING)
226                         g_main_iteration(TRUE);
227         }
228
229         fclose(fp);
230
231         if (is_spam) {
232                 debug_print("message is spam\n");
233                 procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
234                 if (config.receive_spam) {
235                         FolderItem *save_folder;
236
237                         if ((!config.save_folder) ||
238                             (config.save_folder[0] == '\0') ||
239                             ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL))
240                                 save_folder = folder_get_default_trash();
241
242                         procmsg_msginfo_unset_flags(msginfo, ~0, 0);
243                         procmsg_msginfo_set_flags(msginfo, MSG_SPAM, 0);
244                         folder_item_move_msg(save_folder, msginfo);
245                 } else {
246                         folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
247                 }
248
249                 return TRUE;
250         } else {
251                 debug_print("message is ham\n");
252                 procmsg_msginfo_unset_flags(msginfo, MSG_SPAM, 0);
253         }
254         return FALSE;
255 }
256
257 SpamAssassinConfig *spamassassin_get_config(void)
258 {
259         return &config;
260 }
261
262 gchar* spamassassin_create_tmp_spamc_wrapper(gboolean spam)
263 {
264         gchar *contents;
265         gchar *fname = get_tmp_file();
266
267         if (fname != NULL) {
268                 contents = g_strdup_printf(
269                                                 "spamc -d %s -p %u -u %s -t %u -s %u -L %s<\"$*\";exit $?",
270                                                 config.hostname, config.port, 
271                                                 config.username, config.timeout,
272                                                 config.max_size * 1024, spam?"spam":"ham");
273                 if (str_write_to_file(contents, fname) < 0) {
274                         g_free(fname);
275                         fname = NULL;
276                 }
277                 g_free(contents);
278         }
279         /* returned pointer must be free'ed by caller */
280         return fname;
281 }
282
283 int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
284 {
285         gchar *cmd = NULL;
286         gchar *file = NULL;
287         const gchar *shell = g_getenv("SHELL");
288         gchar *spamc_wrapper = NULL;
289
290         if (msginfo == NULL && msglist == NULL) {
291                 return -1;
292         }
293
294         if (config.transport == SPAMASSASSIN_TRANSPORT_TCP
295         &&  prefs_common.work_offline
296         &&  !inc_offline_should_override(
297                 _("Sylpheed-Claws needs network access in order "
298                   "to feed this mail(s) to the remote learner."))) {
299                 return -1;
300         }
301
302         if (msginfo) {
303                 file = procmsg_get_message_file(msginfo);
304                 if (file == NULL) {
305                         return -1;
306                 }
307                 if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
308                         spamc_wrapper = spamassassin_create_tmp_spamc_wrapper(spam);
309                         if (spamc_wrapper != NULL) {
310                                 cmd = g_strconcat(shell?shell:"sh", " ",
311                                                                 spamc_wrapper, " ", file, NULL);
312                         }
313                 } else {
314                         cmd = g_strdup_printf("sa-learn -u %s %s %s %s",
315                                                         config.username,
316                                                         prefs_common.work_offline?"-L":"",
317                                                         spam?"--spam":"--ham", file);
318                 }
319         }
320         if (msglist) {
321                 GSList *cur = msglist;
322                 MsgInfo *info;
323
324                 if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
325                         /* execute n-times the spamc command */
326                         for (; cur; cur = cur->next) {
327                                 info = (MsgInfo *)cur->data;
328                                 gchar *tmpcmd = NULL;
329                                 gchar *tmpfile = get_tmp_file();
330
331                                 if (spamc_wrapper == NULL) {
332                                         spamc_wrapper = spamassassin_create_tmp_spamc_wrapper(spam);
333                                 }
334
335                                 if (spamc_wrapper && tmpfile &&
336                                 copy_file(procmsg_get_message_file(info), tmpfile, TRUE) == 0) {
337                                         tmpcmd = g_strconcat(shell?shell:"sh", " ", spamc_wrapper, " ",
338                                                                                 tmpfile, NULL);
339                                         debug_print("%s\n", tmpcmd);
340                                         execute_command_line(tmpcmd, FALSE);
341                                         g_free(tmpcmd);
342                                 }
343                                 if (tmpfile != NULL) {
344                                         g_free(tmpfile);
345                                 }
346                         }
347                         if (spamc_wrapper != NULL) {
348                                 g_free(spamc_wrapper);
349                         }
350                         return 0;
351                 } else {
352                         cmd = g_strdup_printf("sa-learn -u %s %s %s",
353                                         config.username,
354                                         prefs_common.work_offline?"-L":"",
355                                         spam?"--spam":"--ham");
356
357                         /* concatenate all message tmpfiles to the sa-learn command-line */
358                         for (; cur; cur = cur->next) {
359                                 info = (MsgInfo *)cur->data;
360                                 gchar *tmpcmd = NULL;
361                                 gchar *tmpfile = get_tmp_file();
362
363                                 if (tmpfile &&
364                                 copy_file(procmsg_get_message_file(info), tmpfile, TRUE) == 0) {                        
365                                         tmpcmd = g_strconcat(cmd, " ", tmpfile, NULL);
366                                         g_free(cmd);
367                                         cmd = tmpcmd;
368                                 }
369                                 if (tmpfile != NULL) {
370                                         g_free(tmpfile);
371                                 }
372                         }
373                 }
374         }
375         if (cmd == NULL) {
376                 return -1;
377         }
378         debug_print("%s\n", cmd);
379         /* only run sync calls to sa-learn/spamc to prevent system lockdown */
380         execute_command_line(cmd, FALSE);
381         g_free(cmd);
382         if (spamc_wrapper != NULL) {
383                 g_free(spamc_wrapper);
384         }
385         return 0;
386 }
387
388 void spamassassin_save_config(void)
389 {
390         PrefFile *pfile;
391         gchar *rcpath;
392
393         debug_print("Saving SpamAssassin Page\n");
394
395         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
396         pfile = prefs_write_open(rcpath);
397         g_free(rcpath);
398         if (!pfile || (prefs_set_block_label(pfile, "SpamAssassin") < 0))
399                 return;
400
401         if (prefs_write_param(param, pfile->fp) < 0) {
402                 g_warning("Failed to write SpamAssassin configuration to file\n");
403                 prefs_file_close_revert(pfile);
404                 return;
405         }
406         fprintf(pfile->fp, "\n");
407
408         prefs_file_close(pfile);
409 }
410
411 gboolean spamassassin_check_username(void)
412 {
413         if (config.username == NULL || config.username[0] == '\0') {
414                 config.username = (gchar*)g_get_user_name();
415                 if (config.username == NULL) {
416                         if (hook_id != -1) {
417                                 spamassassin_unregister_hook();
418                         }
419                         procmsg_unregister_spam_learner(spamassassin_learn);
420                         procmsg_spam_set_folder(NULL);
421                         return FALSE;
422                 }
423         }
424         return TRUE;
425 }
426
427 void spamassassin_set_message_callback(MessageCallback callback)
428 {
429         message_callback = callback;
430 }
431
432 gint plugin_init(gchar **error)
433 {
434         gchar *rcpath;
435
436         hook_id = -1;
437
438         if ((sylpheed_get_version() > VERSION_NUMERIC)) {
439                 *error = g_strdup("Your version of Sylpheed-Claws is newer than the version the SpamAssassin plugin was built with");
440                 return -1;
441         }
442
443         if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
444                 *error = g_strdup("Your version of Sylpheed-Claws is too old for the SpamAssassin plugin");
445                 return -1;
446         }
447
448         prefs_set_default(param);
449         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
450         prefs_read_config(param, "SpamAssassin", rcpath, NULL);
451         g_free(rcpath);
452         if (!spamassassin_check_username()) {
453                 *error = g_strdup("Failed to get username");
454                 return -1;
455         }
456         spamassassin_gtk_init();
457                 
458         debug_print("Spamassassin plugin loaded\n");
459
460         if (config.process_emails) {
461                 spamassassin_register_hook();
462         }
463
464         if (config.transport == SPAMASSASSIN_DISABLED) {
465                 log_error("Spamassassin plugin is loaded but disabled by its preferences.\n");
466         }
467
468         if (config.transport != SPAMASSASSIN_DISABLED) {
469                 if (config.transport == SPAMASSASSIN_TRANSPORT_TCP)
470                         debug_print("Enabling learner with a remote spamassassin server requires spamc/spamd 3.1.x\n");
471                 procmsg_register_spam_learner(spamassassin_learn);
472                 procmsg_spam_set_folder(config.save_folder);
473         }
474
475         return 0;
476         
477 }
478
479 void plugin_done(void)
480 {
481         if (hook_id != -1) {
482                 spamassassin_unregister_hook();
483         }
484         g_free(config.hostname);
485         g_free(config.save_folder);
486         spamassassin_gtk_done();
487         procmsg_unregister_spam_learner(spamassassin_learn);
488         procmsg_spam_set_folder(NULL);
489         debug_print("Spamassassin plugin unloaded\n");
490 }
491
492 const gchar *plugin_name(void)
493 {
494         return _("SpamAssassin");
495 }
496
497 const gchar *plugin_desc(void)
498 {
499         return _("This plugin checks all messages that are received from an "
500                  "IMAP, LOCAL or POP account for spam using a SpamAssassin "
501                  "server. You will need a SpamAssassin Server (spamd) running "
502                  "somewhere.\n"
503                  "\n"
504                  "When a message is identified as spam it can be deleted or "
505                  "saved into a special folder.\n"
506                  "\n");
507 }
508
509 const gchar *plugin_type(void)
510 {
511         return "GTK2";
512 }
513
514 const gchar *plugin_licence(void)
515 {
516         return "GPL";
517 }
518
519 const gchar *plugin_version(void)
520 {
521         return VERSION;
522 }
523
524 void spamassassin_register_hook(void)
525 {
526         hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
527         if (hook_id == -1) {
528                 g_warning("Failed to register mail filtering hook");
529                 config.process_emails = FALSE;
530         }
531 }
532
533 void spamassassin_unregister_hook(void)
534 {
535         if (hook_id != -1) {
536                 hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
537         }
538 }