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
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, see <http://www.gnu.org/licenses/>.
22 #include "claws-features.h"
26 #include <glib/gi18n.h>
28 #include <curl/curl.h>
31 #include "libravatar.h"
32 #include "libravatar_prefs.h"
33 #include "libravatar_missing.h"
34 #include "prefs_common.h"
35 #include "procheader.h"
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 */
50 static guint update_hook_id;
51 static guint render_hook_id;
52 static gchar *cache_dir = NULL; /* dir-separator terminated */
54 static gboolean libravatar_header_update_hook(gpointer source, gpointer data)
56 AvatarCaptureData *acd = (AvatarCaptureData *)source;
58 debug_print("libravatar avatar_header_update invoked\n");
60 if (!strcmp(acd->header, "From:")) {
63 a = g_strdup(acd->content);
67 for (lower = a; *lower; lower++)
68 *lower = g_ascii_tolower(*lower);
70 debug_print("libravatar added '%s'\n", a);
71 procmsg_msginfo_add_avatar(acd->msginfo, AVATAR_LIBRAVATAR, a);
74 return FALSE; /* keep getting */
77 static gchar *federated_base_url_from_address(const gchar *address)
80 TODO: no federation supported right now
81 Details on http://wiki.libravatar.org/running_your_own/
83 return g_strdup(libravatarprefs.base_url);
86 static GtkWidget *image_widget_from_filename(const gchar *filename)
88 GtkWidget *image = NULL;
89 GdkPixbuf *picture = NULL;
93 gdk_pixbuf_get_file_info(filename, &w, &h);
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);
100 picture = gdk_pixbuf_new_from_file(filename, &error);
103 g_warning("Failed to load image '%s': %s\n", filename, error->message);
107 image = gtk_image_new_from_pixbuf(picture);
108 g_object_unref(picture);
110 g_warning("Failed to load image '%s': no error returned!\n", filename);
116 static gchar *cache_name_for_md5(const gchar *md5)
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);
124 /* default cache dir */
125 return g_strconcat(cache_dir, md5, NULL);
128 static size_t write_image_data_cb(void *ptr, size_t size, size_t nmemb, void *stream)
130 size_t written = fwrite(ptr, size, nmemb, (FILE *)stream);
131 debug_print("received %zu bytes from avatar server\n", written);
136 static GtkWidget *image_widget_from_url(const gchar *url, const gchar *md5)
138 GtkWidget *image = NULL;
143 curl = curl_easy_init();
145 g_warning("could not initialize curl to get image from url\n");
148 curl_easy_setopt(curl, CURLOPT_URL, url);
149 curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_image_data_cb);
150 curl_easy_setopt(curl, CURLOPT_TIMEOUT, prefs_common_get_prefs()->io_timeout_secs);
151 curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
153 filename = cache_name_for_md5(md5);
154 file = fopen(filename, "wb");
158 if (libravatarprefs.allow_redirects) {
159 long maxredirs = (libravatarprefs.default_mode == DEF_MODE_URL)? 3L
160 : ((libravatarprefs.default_mode == DEF_MODE_MM)? 2L: 1L);
162 curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
163 curl_easy_setopt(curl, CURLOPT_MAXREDIRS, maxredirs);
165 curl_easy_setopt(curl, CURLOPT_FILE, file);
166 debug_print("retrieving URL to file: %s -> %s\n", url, filename);
167 curl_easy_perform(curl);
168 filesize = ftell(file);
171 if (filesize < MIN_PNG_SIZE)
172 debug_print("not enough data for an avatar image: %ld bytes\n", filesize);
174 image = image_widget_from_filename(filename);
176 if (!libravatarprefs.cache_icons || filesize == 0) {
177 if (g_unlink(filename) < 0)
178 g_warning("failed to delete cache file %s\n", filename);
182 missing_add_md5(libravatarmisses, md5);
184 g_warning("could not open '%s' for writting\n", filename);
186 curl_easy_cleanup(curl);
192 static gboolean is_recent_enough(const gchar *filename)
197 if (libravatarprefs.cache_icons) {
199 if (t != (time_t)-1 && !g_stat(filename, &s)) {
200 if (t - s.st_ctime <= libravatarprefs.cache_interval * 3600)
205 return FALSE; /* re-download */
208 static GtkWidget *image_widget_from_cached_md5(const gchar *md5)
210 GtkWidget *image = NULL;
213 filename = cache_name_for_md5(md5);
214 if (is_file_exist(filename) && is_recent_enough(filename)) {
215 debug_print("found cached image for %s\n", md5);
216 image = image_widget_from_filename(filename);
223 static gchar *libravatar_url_for_md5(const gchar *base, const gchar *md5)
225 if (libravatarprefs.default_mode >= DEF_MODE_404) {
226 return g_strdup_printf("%s/%s?s=%u&d=%s",
227 base, md5, AVATAR_SIZE,
228 def_mode[libravatarprefs.default_mode - 10]);
229 } else if (libravatarprefs.default_mode == DEF_MODE_URL) {
230 return g_strdup_printf("%s/%s?s=%u&d=%s",
231 base, md5, AVATAR_SIZE,
232 libravatarprefs.default_mode_url);
233 } else if (libravatarprefs.default_mode == DEF_MODE_NONE) {
234 return g_strdup_printf("%s/%s?s=%u",
235 base, md5, AVATAR_SIZE);
238 g_warning("invalid libravatar default mode: %d\n", libravatarprefs.default_mode);
242 static gboolean libravatar_image_render_hook(gpointer source, gpointer data)
244 AvatarRender *ar = (AvatarRender *)source;
245 GtkWidget *image = NULL;
246 gchar *a = NULL, *url = NULL;
249 debug_print("libravatar avatar_image_render invoked\n");
251 a = procmsg_msginfo_get_avatar(ar->full_msginfo, AVATAR_LIBRAVATAR);
255 md5_hex_digest(md5sum, a);
256 /* try missing cache */
257 if (is_missing_md5(libravatarmisses, md5sum)) {
261 image = image_widget_from_cached_md5(md5sum);
263 if (ar->image) /* previous plugin set one */
264 gtk_widget_destroy(ar->image);
268 /* not cached copy: try network */
269 if (prefs_common.work_offline) {
270 debug_print("working off-line: libravatar network retrieval skipped\n");
273 base = federated_base_url_from_address(a);
274 url = libravatar_url_for_md5(base, md5sum);
276 image = image_widget_from_url(url, md5sum);
279 if (ar->image) /* previous plugin set one */
280 gtk_widget_destroy(ar->image);
289 return FALSE; /* keep rendering */
292 static gint cache_dir_init()
297 cache_dir = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
298 LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
300 if (!is_dir_exist(cache_dir)) {
301 if (make_dir(cache_dir) < 0) {
306 for (i = DEF_MODE_MM; i <= DEF_MODE_RETRO; ++i) {
307 subdir = g_strconcat(cache_dir, def_mode[i - 10], NULL);
308 if (!is_dir_exist(subdir)) {
309 if (make_dir(subdir) < 0) {
310 g_warning("cannot create directory %s\n", subdir);
321 static gint missing_cache_init()
323 gchar *cache_file = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
324 LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
325 LIBRAVATAR_MISSING_FILE, NULL);
327 libravatarmisses = missing_load_from_file(cache_file);
330 if (libravatarmisses == NULL)
336 static void missing_cache_done()
340 if (libravatarmisses != NULL) {
341 cache_file = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
342 LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
343 LIBRAVATAR_MISSING_FILE, NULL);
344 missing_save_to_file(libravatarmisses, cache_file);
346 g_hash_table_destroy(libravatarmisses);
353 * @param error For storing the returned error message.
355 * @return 0 if initialization succeeds, -1 on failure.
357 gint plugin_init(gchar **error)
359 if (!check_plugin_version(MAKE_NUMERIC_VERSION(3,9,3,29),
360 VERSION_NUMERIC, _("Libravatar"), error))
362 /* get info from headers */
363 update_hook_id = hooks_register_hook(AVATAR_HEADER_UPDATE_HOOKLIST,
364 libravatar_header_update_hook,
366 if (update_hook_id == -1) {
367 *error = g_strdup(_("Failed to register avatar header update hook"));
370 /* get image for displaying */
371 render_hook_id = hooks_register_hook(AVATAR_IMAGE_RENDER_HOOKLIST,
372 libravatar_image_render_hook,
374 if (render_hook_id == -1) {
375 *error = g_strdup(_("Failed to register avatar image render hook"));
379 if (cache_dir_init() == -1) {
380 *error = g_strdup(_("Failed to create avatar image cache directory"));
383 /* preferences page */
384 libravatar_prefs_init();
386 curl_global_init(CURL_GLOBAL_DEFAULT);
388 if (missing_cache_init() == -1) {
389 *error = g_strdup(_("Failed to load missing items cache"));
392 debug_print("Libravatar plugin loaded\n");
398 * Destructor for the plugin.
399 * Unregister the callback function and frees matcher.
401 * @return Always TRUE.
403 gboolean plugin_done(void)
405 if (render_hook_id != -1) {
406 hooks_unregister_hook(AVATAR_IMAGE_RENDER_HOOKLIST,
410 if (update_hook_id != -1) {
411 hooks_unregister_hook(AVATAR_HEADER_UPDATE_HOOKLIST,
415 libravatar_prefs_done();
416 missing_cache_done();
417 if (cache_dir != NULL)
419 debug_print("Libravatar plugin unloaded\n");
425 * Get the name of the plugin.
427 * @return The plugin's name, maybe translated.
429 const gchar *plugin_name(void)
431 return _("Libravatar");
435 * Get the description of the plugin.
437 * @return The plugin's description, maybe translated.
439 const gchar *plugin_desc(void)
441 return _("Display libravatar profiles' images for mail messages. More\n"
442 "info about libravatar at http://www.libravatar.org/. If you have\n"
443 "a gravatar.com profile but not a libravatar one, those will also\n"
444 "be retrieved (when redirections are allowed in plugin config).\n"
445 "Plugin config page it's available from main window at:\n"
446 "/Configuration/Preferences/Plugins/Libravatar.\n\n"
447 "This plugin uses libcurl to retrieve images, so if you're behind a\n"
448 "proxy please refer to curl(1) manpage for details on 'http_proxy'\n"
449 "configuration. More details about this and others on README file.\n\n"
450 "Feedback to <ricardo@mones.org> is welcome.\n");
454 * Get the kind of plugin.
456 * @return The "GTK2" constant.
458 const gchar *plugin_type(void)
464 * Get the license acronym the plugin is released under.
466 * @return The "GPL3+" constant.
468 const gchar *plugin_licence(void)
474 * Get the version of the plugin.
476 * @return The current version string.
478 const gchar *plugin_version(void)
484 * Get the features implemented by the plugin.
486 * @return A constant PluginFeature structure with the features.
488 struct PluginFeature *plugin_provides(void)
490 static struct PluginFeature features[] =
491 { {PLUGIN_OTHER, N_("Libravatar")},
492 {PLUGIN_NOTHING, NULL}};