2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2014 Colin Leroy <colin@colino.net>
4 * and the Claws Mail Team
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.
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.
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.
23 #include "claws-features.h"
30 #include <glib/gi18n.h>
32 #include "common/claws.h"
33 #include "common/version.h"
36 #include "prefs_common.h"
38 #include "spam_report_prefs.h"
39 #include "statusbar.h"
47 #include "procheader.h"
53 #include <curl/curl.h>
54 #include <curl/curlver.h>
56 struct CurlReadWrite {
61 static gboolean check_debian_listid(MsgInfo *msginfo);
63 /* this interface struct is probably not enough for the various available
64 * reporting places/methods. It'll be extended as necessary. */
66 #define SSFR_URL "https://www.signal-spam.fr/api/signaler"
67 #define SSFR_BODY "message=%claws_mail_body_b64%"
69 #define DEBL_URL "https://lists.debian.org/cgi-bin/nominate-for-review.pl?Quiet=on&msgid=%claws_mail_msgid%"
71 ReportInterface spam_interfaces[] = {
72 { "Signal-Spam.fr", INTF_HTTP_AUTH, SSFR_URL, SSFR_BODY, NULL},
73 { "Spamcop.net", INTF_MAIL, NULL, NULL, NULL},
74 { "Debian Lists", INTF_HTTP_GET, DEBL_URL, NULL, check_debian_listid},
75 { NULL, INTF_NULL, NULL, NULL, NULL}
78 /* From RSSyl. This should be factorized to the core... */
79 static gchar *spamreport_strreplace(gchar *source, gchar *pattern,
82 gchar *new, *w_new, *c;
83 guint count = 0, final_length;
84 size_t len_pattern, len_replacement;
86 if( source == NULL || pattern == NULL ) {
87 debug_print("source or pattern is NULL!!!\n");
91 if( !g_utf8_validate(source, -1, NULL) ) {
92 debug_print("source is not an UTF-8 encoded text\n");
96 if( !g_utf8_validate(pattern, -1, NULL) ) {
97 debug_print("pattern is not an UTF-8 encoded text\n");
101 len_pattern = strlen(pattern);
102 len_replacement = replacement ? strlen(replacement) : 0;
105 while( ( c = g_strstr_len(c, strlen(c), pattern) ) ) {
110 final_length = strlen(source)
111 - ( count * len_pattern )
112 + ( count * len_replacement );
114 new = malloc(final_length + 1);
116 memset(new, '\0', final_length + 1);
120 while( *c != '\0' ) {
121 if( !memcmp(c, pattern, len_pattern) ) {
122 gboolean break_after_rep = FALSE;
124 if (*(c + len_pattern) == '\0')
125 break_after_rep = TRUE;
126 for (i = 0; i < len_replacement; i++) {
127 *w_new = replacement[i];
142 static gboolean check_debian_listid(MsgInfo *msginfo)
145 if (!procheader_get_header_from_msginfo(msginfo, buf, sizeof(buf), "List-Id:")) {
146 if (strstr(buf, "lists.debian.org")) {
153 static void spamreport_http_response_log(gchar *url, long response)
156 case 400: /* Bad Request */
157 log_error(LOG_PROTOCOL, "%s: Bad Request\n", url);
159 case 401: /* Not Authorized */
160 log_error(LOG_PROTOCOL, "%s: Wrong login or password\n", url);
162 case 404: /* Not Authorized */
163 log_error(LOG_PROTOCOL, "%s: Not found\n", url);
168 static void *myrealloc(void *pointer, size_t size) {
170 * There might be a realloc() out there that doesn't like reallocing
171 * NULL pointers, so we take care of it here.
174 return realloc(pointer, size);
180 static size_t curl_writefunction_cb(void *pointer, size_t size, size_t nmemb, void *data) {
181 size_t realsize = size * nmemb;
182 struct CurlReadWrite *mem = (struct CurlReadWrite *)data;
184 mem->data = myrealloc(mem->data, mem->size + realsize + 1);
186 memcpy(&(mem->data[mem->size]), pointer, realsize);
187 mem->size += realsize;
188 mem->data[mem->size] = 0;
193 static void report_spam(gint id, ReportInterface *intf, MsgInfo *msginfo, gchar *contents)
195 gchar *reqbody = NULL, *tmp = NULL, *auth = NULL, *b64 = NULL, *geturl = NULL;
199 struct CurlReadWrite chunk;
204 if (spamreport_prefs.enabled[id] == FALSE) {
205 debug_print("not reporting via %s (disabled)\n", intf->name);
208 if (intf->should_report != NULL && (intf->should_report)(msginfo) == FALSE) {
209 debug_print("not reporting via %s (unsuitable)\n", intf->name);
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);
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]);
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 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);
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);
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 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);
267 log_error(LOG_PROTOCOL, "%s: response was empty\n", geturl);
272 g_warning("Unknown method\n");
278 static void report_spam_cb_ui(GtkAction *action, gpointer data)
280 MainWindow *mainwin = mainwindow_get_mainwindow();
281 SummaryView *summaryview = mainwin->summaryview;
282 GSList *msglist = summary_get_selected_msg_list(summaryview);
284 gint curnum=0, total=0;
285 if (summary_is_locked(summaryview) || !msglist) {
287 g_slist_free(msglist);
290 main_window_cursor_wait(summaryview->mainwin);
291 gtk_cmclist_freeze(GTK_CMCLIST(summaryview->ctree));
292 folder_item_update_freeze();
295 STATUSBAR_PUSH(mainwin, _("Reporting spam..."));
296 total = g_slist_length(msglist);
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;
305 debug_print("reporting message %d (%s)\n", msginfo->msgnum, file);
306 statusbar_progress_all(curnum, total, 1);
310 contents = file_read_to_str(file);
312 for (i = 0; i < INTF_LAST; i++)
313 report_spam(i, &(spam_interfaces[i]), msginfo, contents);
319 statusbar_progress_all(0,0,0);
320 STATUSBAR_POP(mainwin);
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);
328 static GtkActionEntry spamreport_main_menu[] = {{
329 "Message/ReportSpam",
330 NULL, N_("Report spam online..."), NULL, NULL, G_CALLBACK(report_spam_cb_ui)
333 static guint context_menu_id = 0;
334 static guint main_menu_id = 0;
336 gint plugin_init(gchar **error)
338 MainWindow *mainwin = mainwindow_get_mainwindow();
340 if (!check_plugin_version(MAKE_NUMERIC_VERSION(3,7,3,13),
341 VERSION_NUMERIC, _("SpamReport"), error))
344 spamreport_prefs_init();
346 curl_global_init(CURL_GLOBAL_DEFAULT);
348 gtk_action_group_add_actions(mainwin->action_group, spamreport_main_menu,
349 1, (gpointer)mainwin);
350 MENUITEM_ADDUI_ID_MANAGER(mainwin->ui_manager, "/Menu/Message", "ReportSpam",
351 "Message/ReportSpam", GTK_UI_MANAGER_MENUITEM,
353 MENUITEM_ADDUI_ID_MANAGER(mainwin->ui_manager, "/Menus/SummaryViewPopup", "ReportSpam",
354 "Message/ReportSpam", GTK_UI_MANAGER_MENUITEM,
359 gboolean plugin_done(void)
361 MainWindow *mainwin = mainwindow_get_mainwindow();
366 MENUITEM_REMUI_MANAGER(mainwin->ui_manager,mainwin->action_group, "Message/ReportSpam", main_menu_id);
369 MENUITEM_REMUI_MANAGER(mainwin->ui_manager,mainwin->action_group, "Message/ReportSpam", context_menu_id);
372 spamreport_prefs_done();
377 const gchar *plugin_name(void)
379 return _("SpamReport");
382 const gchar *plugin_desc(void)
384 return _("This plugin reports spam to various places.\n"
385 "Currently the following sites or methods are supported:\n\n"
386 " * spam-signal.fr\n"
388 " * lists.debian.org nomination system");
391 const gchar *plugin_type(void)
396 const gchar *plugin_licence(void)
401 const gchar *plugin_version(void)
406 struct PluginFeature *plugin_provides(void)
408 static struct PluginFeature features[] =
409 { {PLUGIN_UTILITY, N_("Spam reporting")},
410 {PLUGIN_NOTHING, NULL}};