Fix bug #3109 “libravatar: make mail address lower case before hashing MD5”
[claws.git] / src / plugins / libravatar / libravatar.c
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2014 Hiroyuki Yamamoto and the Claws Mail Team
4  * Copyright (C) 2014 Ricardo Mones
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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #  include "config.h"
22 #include "claws-features.h"
23 #endif
24
25 #include <glib.h>
26 #include <glib/gi18n.h>
27
28 #include <curl/curl.h>
29
30 #include "version.h"
31 #include "libravatar.h"
32 #include "libravatar_prefs.h"
33 #include "libravatar_missing.h"
34 #include "prefs_common.h"
35 #include "procheader.h"
36 #include "procmsg.h"
37 #include "utils.h"
38 #include "md5.h"
39
40 /* indexes of keys are default_mode - 10 if applicable */
41 static const char *def_mode[] = {
42         "404",  /* not used, only useful in web pages */
43         "mm",
44         "identicon",
45         "monsterid",
46         "wavatar",
47         "retro"
48 };
49
50 static guint update_hook_id;
51 static guint render_hook_id;
52 static gchar *cache_dir = NULL; /* dir-separator terminated */
53
54 static gboolean libravatar_header_update_hook(gpointer source, gpointer data)
55 {
56         AvatarCaptureData *acd = (AvatarCaptureData *)source;
57
58         debug_print("libravatar avatar_header_update invoked\n");
59
60         if (!strcmp(acd->header, "From:")) {
61                 gchar *a, *lower;
62
63                 a = g_strdup(acd->content);
64                 extract_address(a);
65
66                 /* string to lower */
67                 for (lower = a; *lower; lower++)
68                         *lower = g_ascii_tolower(*lower);
69
70                 debug_print("libravatar added '%s'\n", a);
71                 procmsg_msginfo_add_avatar(acd->msginfo, AVATAR_LIBRAVATAR, a);
72         }
73
74         return FALSE; /* keep getting */
75 }
76
77 static gchar *federated_base_url_from_address(const gchar *address)
78 {
79         /*
80            TODO: no federation supported right now
81            Details on http://wiki.libravatar.org/running_your_own/
82          */
83         return g_strdup(libravatarprefs.base_url);
84 }
85
86 static GtkWidget *image_widget_from_filename(const gchar *filename)
87 {
88         GtkWidget *image = NULL;
89         GdkPixbuf *picture = NULL;
90         GError *error = NULL;
91         gint w, h;
92
93         gdk_pixbuf_get_file_info(filename, &w, &h);
94
95         if (w != AVATAR_SIZE || h != AVATAR_SIZE)
96                 /* server can provide a different size from the requested in URL */
97                 picture = gdk_pixbuf_new_from_file_at_scale(
98                                 filename, AVATAR_SIZE, AVATAR_SIZE, TRUE, &error);
99         else    /* exact size */
100                 picture = gdk_pixbuf_new_from_file(filename, &error);
101
102         if (error != NULL) {
103                 g_warning("Failed to load image '%s': %s\n", filename, error->message);
104                 g_error_free(error);
105         } else {
106                 if (picture) {
107                         image = gtk_image_new_from_pixbuf(picture);
108                         g_object_unref(picture);
109                 } else
110                         g_warning("Failed to load image '%s': no error returned!\n", filename);
111         }
112
113         return image;
114 }
115
116 static gchar *cache_name_for_md5(const gchar *md5)
117 {
118         if (libravatarprefs.default_mode >= DEF_MODE_MM
119                         && libravatarprefs.default_mode <= DEF_MODE_RETRO) {
120                 /* cache dir for generated avatars */
121                 return g_strconcat(cache_dir, def_mode[libravatarprefs.default_mode - 10],
122                                    G_DIR_SEPARATOR_S, md5, NULL);
123         }
124         /* default cache dir */
125         return g_strconcat(cache_dir, md5, NULL);
126 }
127
128 static size_t write_image_data_cb(void *ptr, size_t size, size_t nmemb, void *stream)
129 {
130         size_t written = fwrite(ptr, size, nmemb, (FILE *)stream);
131         debug_print("received %zu bytes from avatar server\n", written);
132
133         return written;
134 }
135
136 static GtkWidget *image_widget_from_url(const gchar *url, const gchar *md5)
137 {
138         GtkWidget *image = NULL;
139         gchar *filename;
140         FILE *file;
141         CURL *curl;
142
143         curl = curl_easy_init();
144         if (curl == NULL) {
145                 g_warning("could not initialize curl to get image from url\n");
146                 return NULL;
147         }
148         curl_easy_setopt(curl, CURLOPT_URL, url);
149         curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_image_data_cb);
150
151         filename = cache_name_for_md5(md5);
152         file = fopen(filename, "wb");
153         if (file != NULL) {
154                 long filesize;
155
156                 if (libravatarprefs.allow_redirects) {
157                         long maxredirs = (libravatarprefs.default_mode == DEF_MODE_MM)? 2L: 1L;
158
159                         curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
160                         curl_easy_setopt(curl, CURLOPT_MAXREDIRS, maxredirs);
161                 }
162                 curl_easy_setopt(curl, CURLOPT_FILE, file);
163                 debug_print("retrieving URL to file: %s -> %s\n", url, filename);
164                 curl_easy_perform(curl);
165                 filesize = ftell(file);
166                 fclose(file);
167
168                 if (filesize < MIN_PNG_SIZE)
169                         debug_print("not enough data for an avatar image: %ld bytes\n", filesize);
170                 else
171                         image = image_widget_from_filename(filename);
172
173                 if (!libravatarprefs.cache_icons) {
174                         if (g_unlink(filename) < 0)
175                                 g_warning("failed to delete cache file %s\n", filename);
176                 }
177
178                 if (filesize == 0)
179                         missing_add_md5(libravatarmisses, md5);
180         } else {
181                 g_warning("could not open '%s' for writting\n", filename);
182         }
183         curl_easy_cleanup(curl);
184         g_free(filename);
185
186         return image;
187 }
188
189 static gboolean is_recent_enough(const gchar *filename)
190 {
191         struct stat s;
192         time_t t;
193
194         if (libravatarprefs.cache_icons) {
195                 t = time(NULL);
196                 if (t != (time_t)-1 && !g_stat(filename, &s)) {
197                         if (t - s.st_ctime <= libravatarprefs.cache_interval * 3600)
198                                 return TRUE;
199                 }
200         }
201
202         return FALSE; /* re-download */
203 }
204
205 static GtkWidget *image_widget_from_cached_md5(const gchar *md5)
206 {
207         GtkWidget *image = NULL;
208         gchar *filename;
209
210         filename = cache_name_for_md5(md5);
211         if (is_file_exist(filename) && is_recent_enough(filename)) {
212                 debug_print("found cached image for %s\n", md5);
213                 image = image_widget_from_filename(filename);
214         }
215         g_free(filename);
216
217         return image;
218 }
219
220 static gchar *libravatar_url_for_md5(const gchar *base, const gchar *md5)
221 {
222         if (libravatarprefs.default_mode >= DEF_MODE_404) {
223                 return g_strdup_printf("%s/%s?s=%u&d=%s",
224                                 base, md5, AVATAR_SIZE,
225                                 def_mode[libravatarprefs.default_mode - 10]);
226         } else if (libravatarprefs.default_mode == DEF_MODE_URL) {
227                 return g_strdup_printf("%s/%s?s=%u&d=%s",
228                                 base, md5, AVATAR_SIZE,
229                                 libravatarprefs.default_mode_url);
230         } else if (libravatarprefs.default_mode == DEF_MODE_NONE) {
231                 return g_strdup_printf("%s/%s?s=%u",
232                                 base, md5, AVATAR_SIZE);
233         }
234
235         g_warning("invalid libravatar default mode: %d\n", libravatarprefs.default_mode);
236         return NULL;
237 }
238
239 static gboolean libravatar_image_render_hook(gpointer source, gpointer data)
240 {
241         AvatarRender *ar = (AvatarRender *)source;
242         GtkWidget *image = NULL;
243         gchar *a = NULL, *url = NULL;
244         gchar md5sum[33];
245
246         debug_print("libravatar avatar_image_render invoked\n");
247
248         a = procmsg_msginfo_get_avatar(ar->full_msginfo, AVATAR_LIBRAVATAR);
249         if (a != NULL) {
250                 gchar *base;
251
252                 md5_hex_digest(md5sum, a);
253                 /* try missing cache */
254                 if (is_missing_md5(libravatarmisses, md5sum)) {
255                         return FALSE;
256                 }
257                 /* try disk cache */
258                 image = image_widget_from_cached_md5(md5sum);
259                 if (image != NULL) {
260                         if (ar->image) /* previous plugin set one */
261                                 gtk_widget_destroy(ar->image);
262                         ar->image = image;
263                         return FALSE;
264                 }
265                 /* not cached copy: try network */
266                 if (prefs_common.work_offline) {
267                         debug_print("working off-line: libravatar network retrieval skipped\n");
268                         return FALSE;
269                 }
270                 base = federated_base_url_from_address(a);
271                 url = libravatar_url_for_md5(base, md5sum);
272                 if (url != NULL) {
273                         image = image_widget_from_url(url, md5sum);
274                         g_free(url);
275                         if (image != NULL) {
276                                 if (ar->image) /* previous plugin set one */
277                                         gtk_widget_destroy(ar->image);
278                                 ar->image = image;
279                         }
280                 }
281                 g_free(base);
282
283                 return TRUE;
284         }
285
286         return FALSE; /* keep rendering */
287 }
288
289 static gint cache_dir_init()
290 {
291         gchar *subdir;
292         int i;
293
294         cache_dir = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
295                                 LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
296                                 NULL);
297         if (!is_dir_exist(cache_dir)) {
298                 if (make_dir(cache_dir) < 0) {
299                         g_free(cache_dir);
300                         return -1;
301                 }
302         }
303         for (i = DEF_MODE_MM; i <= DEF_MODE_RETRO; ++i) {
304                 subdir = g_strconcat(cache_dir, def_mode[i - 10], NULL);
305                 if (!is_dir_exist(subdir)) {
306                         if (make_dir(subdir) < 0) {
307                                 g_warning("cannot create directory %s\n", subdir);
308                                 g_free(subdir);
309                                 return -1;
310                         }
311                 }
312                 g_free(subdir);
313         }
314
315         return 0;
316 }
317
318 static gint missing_cache_init()
319 {
320         gchar *cache_file = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
321                                         LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
322                                         LIBRAVATAR_MISSING_FILE, NULL);
323
324         libravatarmisses = missing_load_from_file(cache_file);
325         g_free(cache_file);
326
327         if (libravatarmisses == NULL)
328                 return -1;
329
330         return 0;
331 }
332
333 static void missing_cache_done()
334 {
335         gchar *cache_file;
336
337         if (libravatarmisses != NULL) {
338                 cache_file = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
339                                         LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
340                                         LIBRAVATAR_MISSING_FILE, NULL);
341                 missing_save_to_file(libravatarmisses, cache_file);
342                 g_free(cache_file);
343                 g_hash_table_destroy(libravatarmisses);
344         }
345 }
346
347 /**
348  * Initialize plugin.
349  *
350  * @param error  For storing the returned error message.
351  *
352  * @return 0 if initialization succeeds, -1 on failure.
353  */
354 gint plugin_init(gchar **error)
355 {
356         if (!check_plugin_version(MAKE_NUMERIC_VERSION(3,9,3,29),
357                                   VERSION_NUMERIC, _("Libravatar"), error))
358                 return -1;
359         /* get info from headers */
360         update_hook_id = hooks_register_hook(AVATAR_HEADER_UPDATE_HOOKLIST,
361                                              libravatar_header_update_hook,
362                                              NULL);
363         if (update_hook_id == -1) {
364                 *error = g_strdup(_("Failed to register avatar header update hook"));
365                 return -1;
366         }
367         /* get image for displaying */
368         render_hook_id = hooks_register_hook(AVATAR_IMAGE_RENDER_HOOKLIST,
369                                              libravatar_image_render_hook,
370                                              NULL);
371         if (render_hook_id == -1) {
372                 *error = g_strdup(_("Failed to register avatar image render hook"));
373                 return -1;
374         }
375         /* cache dir */
376         if (cache_dir_init() == -1) {
377                 *error = g_strdup(_("Failed to create avatar image cache directory"));
378                 return -1;
379         }
380         /* preferences page */
381         libravatar_prefs_init();
382         /* curl library */
383         curl_global_init(CURL_GLOBAL_DEFAULT);
384         /* missing cache */
385         if (missing_cache_init() == -1) {
386                 *error = g_strdup(_("Failed to load missing items cache"));
387                 return -1;
388         }
389         debug_print("Libravatar plugin loaded\n");
390
391         return 0;
392 }
393
394 /**
395  * Destructor for the plugin.
396  * Unregister the callback function and frees matcher.
397  *
398  * @return Always TRUE.
399  */
400 gboolean plugin_done(void)
401 {
402         if (render_hook_id != -1) {
403                 hooks_unregister_hook(AVATAR_IMAGE_RENDER_HOOKLIST,
404                                       render_hook_id);
405                 render_hook_id = -1;
406         }
407         if (update_hook_id != -1) {
408                 hooks_unregister_hook(AVATAR_HEADER_UPDATE_HOOKLIST,
409                                       update_hook_id);
410                 update_hook_id = -1;
411         }
412         libravatar_prefs_done();
413         missing_cache_done();
414         if (cache_dir != NULL)
415                 g_free(cache_dir);
416         debug_print("Libravatar plugin unloaded\n");
417
418         return TRUE;
419 }
420
421 /**
422  * Get the name of the plugin.
423  *
424  * @return The plugin's name, maybe translated.
425  */
426 const gchar *plugin_name(void)
427 {
428         return _("Libravatar");
429 }
430
431 /**
432  * Get the description of the plugin.
433  *
434  * @return The plugin's description, maybe translated.
435  */
436 const gchar *plugin_desc(void)
437 {
438         return _("Get and display libravatar images for mail messages.\n\n"
439                  "Info about libravatar at http://www.libravatar.org/\n\n"
440                  "Feedback to <ricardo@mones.org> is welcome.\n");
441 }
442
443 /**
444  * Get the kind of plugin.
445  *
446  * @return The "GTK2" constant.
447  */
448 const gchar *plugin_type(void)
449 {
450         return "GTK2";
451 }
452
453 /**
454  * Get the license acronym the plugin is released under.
455  *
456  * @return The "GPL3+" constant.
457  */
458 const gchar *plugin_licence(void)
459 {
460         return "GPL3+";
461 }
462
463 /**
464  * Get the version of the plugin.
465  *
466  * @return The current version string.
467  */
468 const gchar *plugin_version(void)
469 {
470         return VERSION;
471 }
472
473 /**
474  * Get the features implemented by the plugin.
475  *
476  * @return A constant PluginFeature structure with the features.
477  */
478 struct PluginFeature *plugin_provides(void)
479 {
480         static struct PluginFeature features[] =
481                 { {PLUGIN_OTHER, N_("Libravatar")},
482                   {PLUGIN_NOTHING, NULL}};
483
484         return features;
485 }
486