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         {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
  90          NULL, NULL, NULL},
  91         {"save_folder", NULL, &config.save_folder, P_STRING,
  92          NULL, NULL, NULL},
  93         {"max_size", "250", &config.max_size, P_INT,
  94          NULL, NULL, NULL},
  95         {"timeout", "30", &config.timeout, P_INT,
  96          NULL, NULL, NULL},
  97
  98         {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
  99 };
 100
 101 gboolean timeout_func(gpointer data)
 102 {
 103         gint *running = (gint *) data;
 104
 105         if (*running & CHILD_RUNNING)
 106                 return TRUE;
 107
 108         *running &= ~TIMEOUT_RUNNING;
 109         return FALSE;
 110 }
 111
 112 static gboolean msg_is_spam(FILE *fp)
 113 {
 114         struct transport trans;
 115         struct message m;
 116         gboolean is_spam = FALSE;
 117
 118         transport_init(&trans);
 119         trans.type = TRANSPORT_TCP;
 120         trans.hostname = config.hostname;
 121         trans.port = config.port;
 122
 123         if (transport_setup(&trans, flags) != EX_OK) {
 124                 debug_print("failed to setup transport\n");
 125                 return FALSE;
 126         }
 127
 128         m.type = MESSAGE_NONE;
 129         m.max_len = config.max_size * 1024;
 130         m.timeout = config.timeout;
 131
 132         if (message_read(fileno(fp), flags, &m) != EX_OK) {
 133                 debug_print("failed to read message\n");
 134                 message_cleanup(&m);
 135                 return FALSE;
 136         }
 137
 138         if (message_filter(&trans, username, flags, &m) != EX_OK) {
 139                 debug_print("filtering the message failed\n");
 140                 message_cleanup(&m);
 141                 return FALSE;
 142         }
 143
 144         if (m.is_spam == EX_ISSPAM)
 145                 is_spam = TRUE;
 146
 147         message_cleanup(&m);
 148
 149         return is_spam;
 150 }
 151
 152 static gboolean mail_filtering_hook(gpointer source, gpointer data)
 153 {
 154         MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
 155         MsgInfo *msginfo = mail_filtering_data->msginfo;
 156         gboolean is_spam = FALSE;
 157         FILE *fp = NULL;
 158         int pid = 0;
 159         int status;
 160
 161         if (!config.enable)
 162                 return FALSE;
 163
 164         debug_print("Filtering message %d\n", msginfo->msgnum);
 165
 166         if ((fp = procmsg_open_message(msginfo)) == NULL) {
 167                 debug_print("failed to open message file\n");
 168                 return FALSE;
 169         }
 170
 171         pid = fork();
 172         if (pid == 0) {
 173                 _exit(msg_is_spam(fp) ? 1 : 0);
 174         } else {
 175                 gint running = 0;
 176
 177                 running |= CHILD_RUNNING;
 178
 179                 g_timeout_add(1000, timeout_func, &running);
 180                 running |= TIMEOUT_RUNNING;
 181
 182                 while(running & CHILD_RUNNING) {
 183                         waitpid(pid, &status, WNOHANG);
 184                         if (WIFEXITED(status)) {
 185                                 running &= ~CHILD_RUNNING;
 186                         }
 187
 188                         g_main_iteration(TRUE);
 189                 }
 190
 191                 while (running & TIMEOUT_RUNNING)
 192                         g_main_iteration(TRUE);
 193         }
 194         is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
 195
 196         fclose(fp);
 197
 198         if (is_spam) {
 199                 debug_print("message is spam\n");
 200
 201                 if (config.receive_spam) {
 202                         FolderItem *save_folder;
 203
 204                         if ((!config.save_folder) ||
 205                             (config.save_folder[0] == '\0') ||
 206                             ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL))
 207                                 save_folder = folder_get_default_trash();
 208
 209                         procmsg_msginfo_unset_flags(msginfo, ~0, 0);
 210                         folder_item_move_msg(save_folder, msginfo);
 211                 } else {
 212                         folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
 213                 }
 214
 215                 return TRUE;
 216         }
 217
 218         return FALSE;
 219 }
 220
 221 SpamAssassinConfig *spamassassin_get_config(void)
 222 {
 223         return &config;
 224 }
 225
 226 void spamassassin_save_config(void)
 227 {
 228         PrefFile *pfile;
 229         gchar *rcpath;
 230
 231         debug_print("Saving SpamAssassin Page\n");
 232
 233         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 234         pfile = prefs_write_open(rcpath);
 235         g_free(rcpath);
 236         if (!pfile || (prefs_set_block_label(pfile, "SpamAssassin") < 0))
 237                 return;
 238
 239         if (prefs_write_param(param, pfile->fp) < 0) {
 240                 g_warning("failed to write SpamAssassin configuration to file\n");
 241                 prefs_file_close_revert(pfile);
 242                 return;
 243         }
 244         fprintf(pfile->fp, "\n");
 245
 246         prefs_file_close(pfile);
 247 }
 248
 249 gint plugin_init(gchar **error)
 250 {
 251         if ((sylpheed_get_version() > VERSION_NUMERIC)) {
 252                 *error = g_strdup("Your sylpheed version is newer than the version the plugin was built with");
 253                 return -1;
 254         }
 255
 256         if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
 257                 *error = g_strdup("Your sylpheed version is too old");
 258                 return -1;
 259         }
 260
 261         hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
 262         if (hook_id == -1) {
 263                 *error = g_strdup("Failed to register mail filtering hook");
 264                 return -1;
 265         }
 266
 267         username = g_get_user_name();
 268         if (username == NULL) {
 269                 *error = g_strdup("Failed to get username");
 270                 return -1;
 271         }
 272
 273         prefs_set_default(param);
 274         prefs_read_config(param, "SpamAssassin", COMMON_RC);
 275
 276         debug_print("Spamassassin plugin loaded\n");
 277
 278         return 0;
 279
 280 }
 281
 282 void plugin_done(void)
 283 {
 284         hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
 285         g_free(config.hostname);
 286         g_free(config.save_folder);
 287
 288         debug_print("Spamassassin plugin unloaded\n");
 289 }
 290
 291 const gchar *plugin_name(void)
 292 {
 293         return _("SpamAssassin");
 294 }
 295
 296 const gchar *plugin_desc(void)
 297 {
 298         return _("This plugin checks all messages that are received from a POP "
 299                  "account for spam using a SpamAssassin server. You will need "
 300                  "a SpamAssassin Server (spamd) running somewhere.\n"
 301                  "\n"
 302                  "When a message is identified as spam it can be deleted or "
 303                  "saved into a special folder.\n"
 304                  "\n"
 305                  "This plugin only contains the actual function for filtering "
 306                  "and deleting or moving the message. You probably want to load "
 307                  "a User Interface plugin too, otherwise you will have to "
 308                  "manually write the plugin configuration.\n");
 309 }
 310
 311 const gchar *plugin_type(void)
 312 {
 313         return "Common";
 314 }