src/plugins/clamav/clamav_plugin.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 #include <clamav.h>
  28
  29 #include "common/sylpheed.h"
  30 #include "common/version.h"
  31 #include "intl.h"
  32 #include "plugin.h"
  33 #include "utils.h"
  34 #include "hooks.h"
  35 #include "inc.h"
  36 #include "mimeview.h"
  37 #include "folder.h"
  38 #include "prefs.h"
  39 #include "prefs_gtk.h"
  40
  41 #include "clamav_plugin.h"
  42
  43 static guint hook_id;
  44
  45 static ClamAvConfig config;
  46
  47 static PrefParam param[] = {
  48         {"clamav_enable", "FALSE", &config.clamav_enable, P_BOOL,
  49          NULL, NULL, NULL},
  50         {"clamav_enable_arc", "FALSE", &config.clamav_enable_arc, P_BOOL,
  51          NULL, NULL, NULL},
  52         {"clamav_max_size", "1", &config.clamav_max_size, P_USHORT,
  53          NULL, NULL, NULL},
  54         {"clamav_recv_infected", "TRUE", &config.clamav_recv_infected, P_BOOL,
  55          NULL, NULL, NULL},
  56         {"clamav_save_folder", NULL, &config.clamav_save_folder, P_STRING,
  57          NULL, NULL, NULL},
  58
  59         {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
  60 };
  61
  62 static gboolean mail_filtering_hook(gpointer source, gpointer data)
  63 {
  64         MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
  65         MsgInfo *msginfo = mail_filtering_data->msginfo;
  66         gboolean is_infected = FALSE;
  67         FILE  *fp;
  68         MimeInfo *mimeinfo;
  69         MimeInfo *child;
  70         gchar *infile;
  71         gchar *outfile;
  72         gint scan_archive = 0;
  73
  74         int ret, no;
  75         unsigned long int size;
  76         char *virname;
  77         struct cl_node *root = NULL;
  78         struct cl_limits limits;
  79
  80         if (!config.clamav_enable)
  81                 return FALSE;
  82
  83         fp = procmsg_open_message(msginfo);
  84         if (fp == NULL) {
  85                 debug_print("failed to open message file");
  86         }
  87
  88         mimeinfo = procmime_scan_message(msginfo);
  89         if (!mimeinfo) return FALSE;
  90
  91         child = mimeinfo->children;
  92         if (!child) {
  93                 procmime_mimeinfo_free_all(mimeinfo);
  94                 return FALSE;
  95         }
  96
  97         debug_print("Scanning message %d for viruses\n", msginfo->msgnum);
  98
  99         infile = procmsg_get_message_file_path(msginfo);
 100
 101
 102         if((ret = cl_loaddbdir(cl_retdbdir(), &root, &no))) {
 103                 debug_print("cl_loaddbdir: %s\n", cl_perror(ret));
 104                 exit(2);
 105         }
 106
 107         debug_print("Database loaded (containing in total %d signatures)\n", no);
 108
 109         cl_buildtrie(root);
 110
 111         limits.maxfiles = 1000; /* max files */
 112         limits.maxfilesize = config.clamav_max_size * 1048576; /* maximum archived file size */
 113         limits.maxreclevel = 8; /* maximum recursion level */
 114
 115         if (config.clamav_enable_arc)
 116                 scan_archive = TRUE;
 117
 118         while (child != NULL) {
 119                 if (child->children || child->mime_type == MIME_MULTIPART) {
 120                         child = procmime_mimeinfo_next(child);
 121                         continue;
 122                 }
 123                 if(child->parent && child->parent->parent
 124                 && !strcasecmp(child->parent->parent->content_type, "multipart/signed")
 125                 && child->mime_type == MIME_TEXT) {
 126                         /* this is the main text part of a signed message */
 127                         child = procmime_mimeinfo_next(child);
 128                         continue;
 129                 }
 130                 outfile = procmime_get_tmp_file_name(child);
 131                 if (procmime_get_part(outfile, infile, child) < 0)
 132                         g_warning("Can't get the part of multipart message.");
 133                 else {
 134                         debug_print("Scanning %s\n", outfile);
 135                         if ((ret = cl_scanfile(outfile, &virname, &size, root,
 136                                               &limits, scan_archive)) == CL_VIRUS) {
 137                                 is_infected = TRUE;
 138                                 debug_print("Detected %s virus.\n", virname);
 139                         } else {
 140                                 debug_print("No virus detected.\n");
 141                                 if (ret != CL_CLEAN)
 142                                         debug_print("Error: %s\n", cl_perror(ret));
 143                         }
 144
 145                         unlink(outfile);
 146
 147                         if (is_infected) break;
 148                         child = child->next;
 149                 }
 150         }
 151
 152         if (is_infected) {
 153                 if (config.clamav_recv_infected) {
 154                         FolderItem *clamav_save_folder;
 155
 156                         if ((!config.clamav_save_folder) ||
 157                             (config.clamav_save_folder[0] == '\0') ||
 158                             ((clamav_save_folder = folder_find_item_from_identifier(config.clamav_save_folder)) == NULL))
 159                                     clamav_save_folder = folder_get_default_trash();
 160
 161                         procmsg_msginfo_unset_flags(msginfo, ~0, 0);
 162                         folder_item_move_msg(clamav_save_folder, msginfo);
 163                 } else {
 164                         folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
 165                 }
 166         }
 167
 168         cl_freetrie(root);
 169         g_free(infile);
 170         procmime_mimeinfo_free_all(mimeinfo);
 171
 172         return is_infected;
 173 }
 174
 175 ClamAvConfig *clamav_get_config(void)
 176 {
 177         return &config;
 178 }
 179
 180 void clamav_save_config(void)
 181 {
 182         PrefFile *pfile;
 183         gchar *rcpath;
 184
 185         debug_print("Saving ClamAV Page\n");
 186
 187         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 188         pfile = prefs_write_open(rcpath);
 189         g_free(rcpath);
 190         if (!pfile || (prefs_set_block_label(pfile, "ClamAV") < 0))
 191                 return;
 192
 193         if (prefs_write_param(param, pfile->fp) < 0) {
 194                 g_warning("failed to write ClamAV configuration to file\n");
 195                 prefs_file_close_revert(pfile);
 196                 return;
 197         }
 198         fprintf(pfile->fp, "\n");
 199
 200         prefs_file_close(pfile);
 201 }
 202
 203 gint plugin_init(gchar **error)
 204 {
 205         if ((sylpheed_get_version() > VERSION_NUMERIC)) {
 206                 *error = g_strdup("Your sylpheed version is newer than the version the plugin was built with");
 207                 return -1;
 208         }
 209
 210         if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
 211                 *error = g_strdup("Your sylpheed version is too old");
 212                 return -1;
 213         }
 214
 215         hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);
 216         if (hook_id == -1) {
 217                 *error = g_strdup("Failed to register mail filtering hook");
 218                 return -1;
 219         }
 220
 221         prefs_set_default(param);
 222         prefs_read_config(param, "ClamAV", COMMON_RC);
 223
 224         debug_print("ClamAV plugin loaded\n");
 225
 226         return 0;
 227
 228 }
 229
 230 void plugin_done(void)
 231 {
 232         hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, hook_id);
 233         g_free(config.clamav_save_folder);
 234
 235         debug_print("ClamAV plugin unloaded\n");
 236 }
 237
 238 const gchar *plugin_name(void)
 239 {
 240         return _("Clam AntiVirus");
 241 }
 242
 243 const gchar *plugin_desc(void)
 244 {
 245         return _("This plugin uses Clam AntiVirus to scan all message attachments "
 246                "that are received from a POP account.\n"
 247                "\n"
 248                "When a message attachment is found to contain a virus it can be "
 249                "deleted or saved in a specially designated folder.\n"
 250                "\n"
 251                "This plugin only contains the actual function for scanning "
 252                "and deleting or moving the message. You probably want to load "
 253                "the Gtk+ User Interface plugin too, otherwise you will have to "
 254                "manually write the plugin configuration.\n");
 255 }
 256
 257 const gchar *plugin_type(void)
 258 {
 259         return "Common";
 260 }