src/plugins/spam_report/spam_report.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2007 Colin Leroy <colin@colino.net>
   4  * and the Claws Mail Team
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include "config.h"
  23 #include "claws-features.h"
  24 #endif
  25
  26 #include <unistd.h>
  27 #include <stdio.h>
  28
  29 #include <glib.h>
  30 #include <glib/gi18n.h>
  31 #include <gtk/gtk.h>
  32 #include <gdk/gdkx.h>
  33 #include "common/claws.h"
  34 #include "common/version.h"
  35 #include "main.h"
  36 #include "plugin.h"
  37 #include "prefs_common.h"
  38 #include "utils.h"
  39 #include "spam_report_prefs.h"
  40 #include "statusbar.h"
  41 #include "procmsg.h"
  42 #include "log.h"
  43 #include "inc.h"
  44 #include "plugin.h"
  45 #include "menu.h"
  46 #include "defs.h"
  47 #include "base64.h"
  48 #include "procheader.h"
  49
  50 #ifdef USE_PTHREAD
  51 #include <pthread.h>
  52 #endif
  53
  54 #include <curl/curl.h>
  55 #include <curl/curlver.h>
  56
  57 struct CurlReadWrite {
  58         char *data;
  59         size_t size;
  60 };
  61
  62 static gboolean check_debian_listid(MsgInfo *msginfo);
  63
  64 /* this interface struct is probably not enough for the various available
  65  * reporting places/methods. It'll be extended as necessary. */
  66
  67 ReportInterface spam_interfaces[] = {
  68         { "Signal-Spam.fr", INTF_HTTP_AUTH, "https://www.signal-spam.fr/api/signaler",
  69                 "message=%claws_mail_body_b64%", NULL},
  70         { "Spamcop.net", INTF_MAIL, NULL, NULL, NULL},
  71         { "Debian Lists", INTF_HTTP_GET,
  72                 "http://lists.debian.org/cgi-bin/nominate-for-review.pl?Quiet=on&msgid=%claws_mail_msgid%",
  73                 NULL, check_debian_listid},
  74         { NULL, INTF_NULL, NULL, NULL, NULL}
  75 };
  76
  77 /* From RSSyl. This should be factorized to the core... */
  78 static gchar *spamreport_strreplace(gchar *source, gchar *pattern,
  79                 gchar *replacement)
  80 {
  81         gchar *new, *w_new, *c;
  82         guint count = 0, final_length;
  83         size_t len_pattern, len_replacement;
  84
  85         if( source == NULL || pattern == NULL ) {
  86                 debug_print("source or pattern is NULL!!!\n");
  87                 return NULL;
  88         }
  89
  90         if( !g_utf8_validate(source, -1, NULL) ) {
  91                 debug_print("source is not an UTF-8 encoded text\n");
  92                 return NULL;
  93         }
  94
  95         if( !g_utf8_validate(pattern, -1, NULL) ) {
  96                 debug_print("pattern is not an UTF-8 encoded text\n");
  97                 return NULL;
  98         }
  99
 100         len_pattern = strlen(pattern);
 101         len_replacement = replacement ? strlen(replacement) : 0;
 102
 103         c = source;
 104         while( ( c = g_strstr_len(c, strlen(c), pattern) ) ) {
 105                 count++;
 106                 c += len_pattern;
 107         }
 108
 109         final_length = strlen(source)
 110                 - ( count * len_pattern )
 111                 + ( count * len_replacement );
 112
 113         new = malloc(final_length + 1);
 114         w_new = new;
 115         memset(new, '\0', final_length + 1);
 116
 117         c = source;
 118
 119         while( *c != '\0' ) {
 120                 if( !memcmp(c, pattern, len_pattern) ) {
 121                         gboolean break_after_rep = FALSE;
 122                         size_t i;
 123                         if (*(c + len_pattern) == '\0')
 124                                 break_after_rep = TRUE;
 125                         for (i = 0; i < len_replacement; i++) {
 126                                 *w_new = replacement[i];
 127                                 w_new++;
 128                         }
 129                         if (break_after_rep)
 130                                 break;
 131                         c = c + len_pattern;
 132                 } else {
 133                         *w_new = *c;
 134                         w_new++;
 135                         c++;
 136                 }
 137         }
 138         return new;
 139 }
 140
 141 static gboolean check_debian_listid(MsgInfo *msginfo)
 142 {
 143         gchar buf[1024];
 144         if (!procheader_get_header_from_msginfo(msginfo, buf, sizeof(buf), "List-Id:")) {
 145                 if (strstr(buf, "lists.debian.org")) {
 146                         return TRUE;
 147                 }
 148         }
 149         return FALSE;
 150 }
 151
 152 static void spamreport_http_response_log(gchar *url, long response)
 153 {
 154         switch (response) {
 155         case 400: /* Bad Request */
 156                 log_error(LOG_PROTOCOL, "%s: Bad Request\n", url);
 157                 break;
 158         case 401: /* Not Authorized */
 159                 log_error(LOG_PROTOCOL, "%s: Wrong login or password\n", url);
 160                 break;
 161         case 404: /* Not Authorized */
 162                 log_error(LOG_PROTOCOL, "%s: Not found\n", url);
 163                 break;
 164         }
 165 }
 166
 167 static void *myrealloc(void *pointer, size_t size) {
 168         /*
 169          * There might be a realloc() out there that doesn't like reallocing
 170          * NULL pointers, so we take care of it here.
 171          */
 172         if (pointer) {
 173                 return realloc(pointer, size);
 174         } else {
 175                 return malloc(size);
 176         }
 177 }
 178
 179 static size_t curl_writefunction_cb(void *pointer, size_t size, size_t nmemb, void *data) {
 180         size_t realsize = size * nmemb;
 181         struct CurlReadWrite *mem = (struct CurlReadWrite *)data;
 182
 183         mem->data = myrealloc(mem->data, mem->size + realsize + 1);
 184         if (mem->data) {
 185                 memcpy(&(mem->data[mem->size]), pointer, realsize);
 186                 mem->size += realsize;
 187                 mem->data[mem->size] = 0;
 188         }
 189         return realsize;
 190 }
 191
 192 static void report_spam(gint id, ReportInterface *intf, MsgInfo *msginfo, gchar *contents)
 193 {
 194         gchar *reqbody = NULL, *tmp = NULL, *auth = NULL, *b64 = NULL, *geturl = NULL;
 195         size_t len_contents;
 196         CURL *curl;
 197         CURLcode res;
 198         long response;
 199         struct CurlReadWrite chunk;
 200
 201         chunk.data = NULL;
 202         chunk.size = 0;
 203
 204         if (spamreport_prefs.enabled[id] == FALSE) {
 205                 debug_print("not reporting via %s (disabled)\n", intf->name);
 206                 return;
 207         }
 208         if (intf->should_report != NULL && (intf->should_report)(msginfo) == FALSE) {
 209                 debug_print("not reporting via %s (unsuitable)\n", intf->name);
 210                 return;
 211         }
 212
 213         debug_print("reporting via %s\n", intf->name);
 214         tmp = spamreport_strreplace(intf->body, "%claws_mail_body%", contents);
 215         len_contents = strlen(contents);
 216         b64 = g_malloc0(B64LEN(len_contents) + 1);
 217         base64_encode(b64, contents, len_contents);
 218         reqbody = spamreport_strreplace(tmp, "%claws_mail_body_b64%", b64);
 219         geturl = spamreport_strreplace(intf->url, "%claws_mail_msgid%", msginfo->msgid);
 220         g_free(b64);
 221         g_free(tmp);
 222
 223         switch(intf->type) {
 224         case INTF_HTTP_AUTH:
 225                 if (spamreport_prefs.user[id] && *(spamreport_prefs.user[id])) {
 226                         auth = g_strdup_printf("%s:%s", spamreport_prefs.user[id], spamreport_prefs.pass[id]);
 227
 228                         curl = curl_easy_init();
 229                         curl_easy_setopt(curl, CURLOPT_URL, intf->url);
 230                         curl_easy_setopt(curl, CURLOPT_POSTFIELDS, reqbody);
 231                         curl_easy_setopt(curl, CURLOPT_USERPWD, auth);
 232                         curl_easy_setopt(curl, CURLOPT_TIMEOUT, prefs_common_get_prefs()->io_timeout_secs);
 233                         curl_easy_setopt(curl, CURLOPT_USERAGENT,
 234                                 SPAM_REPORT_USERAGENT "(" PLUGINS_URI ")");
 235                         res = curl_easy_perform(curl);
 236                         curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response);
 237                         curl_easy_cleanup(curl);
 238                         spamreport_http_response_log(intf->url, response);
 239                         g_free(auth);
 240                 }
 241                 break;
 242         case INTF_MAIL:
 243                 if (spamreport_prefs.user[id] && *(spamreport_prefs.user[id])) {
 244                         Compose *compose = compose_forward(NULL, msginfo, TRUE, NULL, TRUE, TRUE);
 245                         compose->use_signing = FALSE;
 246                         compose_entry_append(compose, spamreport_prefs.user[id], COMPOSE_TO, PREF_NONE);
 247                         compose_send(compose);
 248                 }
 249                 break;
 250         case INTF_HTTP_GET:
 251                 curl = curl_easy_init();
 252                 curl_easy_setopt(curl, CURLOPT_URL, geturl);
 253                 curl_easy_setopt(curl, CURLOPT_USERAGENT,
 254                                 SPAM_REPORT_USERAGENT "(" PLUGINS_URI ")");
 255                 curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curl_writefunction_cb);
 256                 curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)&chunk);
 257                 res = curl_easy_perform(curl);
 258                 curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response);
 259                 curl_easy_cleanup(curl);
 260                 spamreport_http_response_log(geturl, response);
 261                 /* On success the page should return "OK: nominated <msgid>" */
 262                 if (chunk.size < 13 || strstr(chunk.data, "OK: nominated") == NULL) {
 263                         if (chunk.size > 0) {
 264                                 log_error(LOG_PROTOCOL, "%s: response was %s\n", geturl, chunk.data);
 265                         }
 266                         else {
 267                                 log_error(LOG_PROTOCOL, "%s: response was empty\n", geturl);
 268                         }
 269                 }
 270                 break;
 271         default:
 272                 g_warning("Unknown method\n");
 273         }
 274         g_free(reqbody);
 275         g_free(geturl);
 276 }
 277
 278 static void report_spam_cb_ui(GtkAction *action, gpointer data)
 279 {
 280         MainWindow *mainwin = mainwindow_get_mainwindow();
 281         SummaryView *summaryview = mainwin->summaryview;
 282         GSList *msglist = summary_get_selected_msg_list(summaryview);
 283         GSList *cur;
 284         gint curnum=0, total=0;
 285         if (summary_is_locked(summaryview) || !msglist) {
 286                 if (msglist)
 287                         g_slist_free(msglist);
 288                 return;
 289         }
 290         main_window_cursor_wait(summaryview->mainwin);
 291         gtk_cmclist_freeze(GTK_CMCLIST(summaryview->ctree));
 292         folder_item_update_freeze();
 293         inc_lock();
 294
 295         STATUSBAR_PUSH(mainwin, _("Reporting spam..."));
 296         total = g_slist_length(msglist);
 297
 298         for (cur = msglist; cur; cur = cur->next) {
 299                 MsgInfo *msginfo = (MsgInfo *)cur->data;
 300                 gchar *file = procmsg_get_message_file(msginfo);
 301                 gchar *contents = NULL;
 302                 int i = 0;
 303                 if (!file)
 304                         continue;
 305                 debug_print("reporting message %d (%s)\n", msginfo->msgnum, file);
 306                 statusbar_progress_all(curnum, total, 1);
 307                 GTK_EVENTS_FLUSH();
 308                 curnum++;
 309
 310                 contents = file_read_to_str(file);
 311
 312                 for (i = 0; i < INTF_LAST; i++)
 313                         report_spam(i, &(spam_interfaces[i]), msginfo, contents);
 314
 315                 g_free(contents);
 316                 g_free(file);
 317         }
 318
 319         statusbar_progress_all(0,0,0);
 320         STATUSBAR_POP(mainwin);
 321         inc_unlock();
 322         folder_item_update_thaw();
 323         gtk_cmclist_thaw(GTK_CMCLIST(summaryview->ctree));
 324         main_window_cursor_normal(summaryview->mainwin);
 325         g_slist_free(msglist);
 326 }
 327
 328 static GtkActionEntry spamreport_main_menu[] = {{
 329         "Message/ReportSpam",
 330         NULL, N_("Report spam online..."), NULL, NULL, G_CALLBACK(report_spam_cb_ui)
 331 }};
 332
 333 static guint context_menu_id = 0;
 334 static guint main_menu_id = 0;
 335
 336 gint plugin_init(gchar **error)
 337 {
 338         MainWindow *mainwin = mainwindow_get_mainwindow();
 339
 340         if (!check_plugin_version(MAKE_NUMERIC_VERSION(3,7,3,13),
 341                                 VERSION_NUMERIC, _("SpamReport"), error))
 342                 return -1;
 343
 344         spamreport_prefs_init();
 345 #ifdef HAVE_LIBCURL
 346         curl_global_init(CURL_GLOBAL_DEFAULT);
 347 #endif
 348
 349         gtk_action_group_add_actions(mainwin->action_group, spamreport_main_menu,
 350                         1, (gpointer)mainwin);
 351         MENUITEM_ADDUI_ID_MANAGER(mainwin->ui_manager, "/Menu/Message", "ReportSpam",
 352                           "Message/ReportSpam", GTK_UI_MANAGER_MENUITEM,
 353                           main_menu_id)
 354         MENUITEM_ADDUI_ID_MANAGER(mainwin->ui_manager, "/Menus/SummaryViewPopup", "ReportSpam",
 355                           "Message/ReportSpam", GTK_UI_MANAGER_MENUITEM,
 356                           context_menu_id)
 357         return 0;
 358 }
 359
 360 gboolean plugin_done(void)
 361 {
 362         MainWindow *mainwin = mainwindow_get_mainwindow();
 363         SummaryView *summaryview = NULL;
 364
 365         if (mainwin == NULL)
 366                 return TRUE;
 367
 368         summaryview = mainwin->summaryview;
 369         MENUITEM_REMUI_MANAGER(mainwin->ui_manager,mainwin->action_group, "Message/ReportSpam", main_menu_id);
 370         main_menu_id = 0;
 371
 372         MENUITEM_REMUI_MANAGER(mainwin->ui_manager,mainwin->action_group, "Message/ReportSpam", context_menu_id);
 373         context_menu_id = 0;
 374 #ifdef HAVE_LIBCURL
 375         spamreport_prefs_done();
 376 #endif
 377         return TRUE;
 378 }
 379
 380 const gchar *plugin_name(void)
 381 {
 382         return _("SpamReport");
 383 }
 384
 385 const gchar *plugin_desc(void)
 386 {
 387         return _("This plugin reports spam to various places.\n"
 388                  "Currently the following sites or methods are supported:\n\n"
 389                  " * spam-signal.fr\n"
 390                  " * spamcop.net\n"
 391                  " * lists.debian.org nomination system");
 392 }
 393
 394 const gchar *plugin_type(void)
 395 {
 396         return "GTK2";
 397 }
 398
 399 const gchar *plugin_licence(void)
 400 {
 401         return "GPL3+";
 402 }
 403
 404 const gchar *plugin_version(void)
 405 {
 406         return VERSION;
 407 }
 408
 409 struct PluginFeature *plugin_provides(void)
 410 {
 411         static struct PluginFeature features[] =
 412                 { {PLUGIN_UTILITY, N_("Spam reporting")},
 413                   {PLUGIN_NOTHING, NULL}};
 414         return features;
 415 }