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 <glib.h>
  27
  28 #if HAVE_LOCALE_H
  29 #  include <locale.h>
  30 #endif
  31
  32 #include "plugin.h"
  33 #include "common/utils.h"
  34 #include "hooks.h"
  35 #include "procmsg.h"
  36 #include "folder.h"
  37 #include "prefs.h"
  38 #include "prefs_gtk.h"
  39 #include "intl.h"
  40
  41 #include "libspamc.h"
  42 #include "spamassassin.h"
  43
  44 #ifdef HAVE_SYSEXITS_H
  45 #include <sysexits.h>
  46 #endif
  47 #ifdef HAVE_ERRNO_H
  48 #include <errno.h>
  49 #endif
  50 #ifdef HAVE_SYS_ERRNO_H
  51 #include <sys/errno.h>
  52 #endif
  53 #ifdef HAVE_TIME_H
  54 #include <time.h>
  55 #endif
  56 #ifdef HAVE_SYS_TIME_H
  57 #include <sys/time.h>
  58 #endif
  59 #ifdef HAVE_SIGNAL_H
  60 #include <signal.h>
  61 #endif
  62 #ifdef HAVE_PWD_H
  63 #include <pwd.h>
  64 #endif
  65
  66 static gint hook_id;
  67 static int flags = SPAMC_RAW_MODE | SPAMC_SAFE_FALLBACK | SPAMC_CHECK_ONLY;
  68 static gchar *username = NULL;
  69
  70 static SpamAssassinConfig config;
  71
  72 static PrefParam param[] = {
  73         {"enable", "FALSE", &config.enable, P_BOOL,
  74          NULL, NULL, NULL},
  75         {"hostname", "localhost", &config.hostname, P_STRING,
  76          NULL, NULL, NULL},
  77         {"port", "783", &config.port, P_USHORT,
  78          NULL, NULL, NULL},
  79         {"max_size", "250", &config.max_size, P_USHORT,
  80          NULL, NULL, NULL},
  81         {"receive_spam", "TRUE", &config.receive_spam, P_BOOL,
  82          NULL, NULL, NULL},
  83         {"save_folder", NULL, &config.save_folder, P_STRING,
  84          NULL, NULL, NULL},
  85
  86         {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
  87 };
  88
  89 static gboolean mail_filtering_hook(gpointer source, gpointer data)
  90 {
  91         MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
  92         MsgInfo *msginfo = mail_filtering_data->msginfo;
  93         gboolean is_spam = FALSE;
  94         FILE *fp = NULL;
  95         struct message m;
  96         gchar *oldlocale = NULL;
  97         struct sockaddr addr;
  98
  99         if (!config.enable)
 100                 return FALSE;
 101
 102         debug_print("Filtering message %d\n", msginfo->msgnum);
 103
 104         /* remember old locale and set it to C */
 105         Xstrdup_a(oldlocale, setlocale(LC_ALL, NULL), return FALSE);
 106         setlocale(LC_ALL, "C");
 107
 108         if (lookup_host(config.hostname, config.port, &addr) != EX_OK) {
 109                 debug_print("failed to look up spamd host");
 110                 return FALSE;
 111         }
 112
 113         m.type = MESSAGE_NONE;
 114         m.max_len = config.max_size * 1024;
 115
 116         if ((fp = procmsg_open_message(msginfo)) == NULL) {
 117                 debug_print("failed to open message file");
 118                 return FALSE;
 119         }
 120
 121         if (message_read(fileno(fp), flags, &m) != EX_OK) {
 122                 debug_print("failed to read message");
 123                 fclose(fp);
 124                 message_cleanup(&m);
 125                 return FALSE;
 126         }
 127
 128         if ((message_filter(&addr, username, flags, &m) == EX_OK) && (m.is_spam == EX_ISSPAM))
 129                 is_spam = TRUE;
 130
 131         message_cleanup(&m);
 132         fclose(fp);
 133         setlocale(LC_ALL, oldlocale);
 134
 135         if (is_spam) {
 136                 if (config.receive_spam) {
 137                         FolderItem *save_folder;
 138
 139                         debug_print("message is spam\n");
 140
 141                         if ((!config.save_folder) ||
 142                             (config.save_folder[0] == '\0') ||
 143                             ((save_folder = folder_find_item_from_identifier(config.save_folder)) == NULL))
 144                                 save_folder = folder_get_default_trash();
 145
 146                         procmsg_msginfo_unset_flags(msginfo, ~0, 0);
 147                         folder_item_move_msg(save_folder, msginfo);
 148                 } else {
 149                         folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
 150                 }
 151
 152                 return TRUE;
 153         }
 154
 155         return FALSE;
 156 }
 157
 158 SpamAssassinConfig *spamassassin_get_config(void)
 159 {
 160         return &config;
 161 }
 162
 163 void spamassassin_save_config(void)
 164 {
 165         PrefFile *pfile;
 166         gchar *rcpath;
 167
 168         debug_print("Saving SpamAssassin Page\n");
 169
 170         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 171         pfile = prefs_write_open(rcpath);
 172         g_free(rcpath);
 173         if (!pfile || (prefs_set_block_label(pfile, "SpamAssassin") < 0))
 174                 return;
 175
 176         if (prefs_write_param(param, pfile->fp) < 0) {
 177                 g_warning("failed to write SpamAssassin configuration to file\n");
 178                 prefs_file_close_revert(pfile);
 179                 return;
 180         }
 181         fprintf(pfile->fp, "\n");
 182
 183         prefs_file_close(pfile);
 184 }
 185
 186 gint plugin_init(gchar **error)
 187 {
 188         hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
 189         if (hook_id == -1) {
 190                 *error = g_strdup("Failed to register mail filtering hook");
 191                 return -1;
 192         }
 193
 194         username = g_get_user_name();
 195         if (username == NULL) {
 196                 *error = g_strdup("Failed to get username");
 197                 return -1;
 198         }
 199
 200         prefs_set_default(param);
 201         prefs_read_config(param, "SpamAssassin", COMMON_RC);
 202
 203         debug_print("Spamassassin plugin loaded\n");
 204
 205         return 0;
 206
 207 }
 208
 209 void plugin_done(void)
 210 {
 211         hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
 212         g_free(config.hostname);
 213         g_free(config.save_folder);
 214
 215         debug_print("Spamassassin plugin unloaded\n");
 216 }
 217
 218 const gchar *plugin_name(void)
 219 {
 220         return _("SpamAssassin");
 221 }
 222
 223 const gchar *plugin_desc(void)
 224 {
 225         return _("This plugin checks all messages that are received from a POP "
 226                  "account for spam using a SpamAssassin server. You will need "
 227                  "a SpamAssassin Server (spamd) running somewhere.\n"
 228                  "\n"
 229                  "When a message is identified as spam it can be deleted or "
 230                  "saved into a special folder.\n"
 231                  "\n"
 232                  "This plugin only contains the actual function for filtering "
 233                  "and deleting or moving the message. You probably want to load "
 234                  "a User Interface plugin too, otherwise you will have to "
 235                  "manually write the plugin configuration.\n");
 236 }
 237
 238 const gchar *plugin_type(void)
 239 {
 240         return "Common";
 241 }