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