Libravatar: remove hooks on failed init
[claws.git] / src / plugins / libravatar / libravatar.c
index 843ffb4a74e03fb61af6342ec3e2b7fe666b0bef..e36829e61c8387939cecbcdb776f1e89956bef53 100644 (file)
@@ -1,7 +1,6 @@
 /*
  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2014 Hiroyuki Yamamoto and the Claws Mail Team
- * Copyright (C) 2014 Ricardo Mones
+ * Copyright (C) 2014-2015 Ricardo Mones and the Claws Mail Team
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,7 +29,9 @@
 #include "version.h"
 #include "libravatar.h"
 #include "libravatar_prefs.h"
+#include "libravatar_cache.h"
 #include "libravatar_missing.h"
+#include "libravatar_federation.h"
 #include "prefs_common.h"
 #include "procheader.h"
 #include "procmsg.h"
@@ -58,10 +59,18 @@ static gboolean libravatar_header_update_hook(gpointer source, gpointer data)
        debug_print("libravatar avatar_header_update invoked\n");
 
        if (!strcmp(acd->header, "From:")) {
-               gchar *a = g_strdup(acd->content);
+               gchar *a, *lower;
+
+               a = g_strdup(acd->content);
                extract_address(a);
+
+               /* string to lower */
+               for (lower = a; *lower; lower++)
+                       *lower = g_ascii_tolower(*lower);
+
                debug_print("libravatar added '%s'\n", a);
                procmsg_msginfo_add_avatar(acd->msginfo, AVATAR_LIBRAVATAR, a);
+               g_free(a);
        }
 
        return FALSE; /* keep getting */
@@ -69,10 +78,21 @@ static gboolean libravatar_header_update_hook(gpointer source, gpointer data)
 
 static gchar *federated_base_url_from_address(const gchar *address)
 {
-       /*
-          TODO: no federation supported right now
-          Details on http://wiki.libravatar.org/running_your_own/
-        */
+#if (defined USE_GNUTLS && GLIB_CHECK_VERSION(2,22,0))
+       gchar *base_url = NULL;
+
+       if (!libravatarprefs.allow_federated) {
+               debug_print("federated domains disabled by configuration\n");
+               goto default_url;
+       }
+
+       base_url = federated_url_for_address(address);
+       if (base_url != NULL) {
+               return base_url;
+       }
+
+default_url:
+#endif
        return g_strdup(libravatarprefs.base_url);
 }
 
@@ -93,14 +113,14 @@ static GtkWidget *image_widget_from_filename(const gchar *filename)
                picture = gdk_pixbuf_new_from_file(filename, &error);
 
        if (error != NULL) {
-               g_warning("Failed to load image '%s': %s\n", filename, error->message);
+               g_warning("failed to load image '%s': %s", filename, error->message);
                g_error_free(error);
        } else {
                if (picture) {
                        image = gtk_image_new_from_pixbuf(picture);
                        g_object_unref(picture);
                } else
-                       g_warning("Failed to load image '%s': no error returned!\n", filename);
+                       g_warning("failed to load image '%s': no error returned!", filename);
        }
 
        return image;
@@ -135,11 +155,19 @@ static GtkWidget *image_widget_from_url(const gchar *url, const gchar *md5)
 
        curl = curl_easy_init();
        if (curl == NULL) {
-               g_warning("could not initialize curl to get image from url\n");
+               g_warning("could not initialize curl to get image from URL");
                return NULL;
        }
        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_image_data_cb);
+       /* make sure timeout is less than general IO timeout */
+       curl_easy_setopt(curl, CURLOPT_TIMEOUT,
+                       (libravatarprefs.timeout == 0
+                               || libravatarprefs.timeout
+                                       > prefs_common_get_prefs()->io_timeout_secs)
+                       ? prefs_common_get_prefs()->io_timeout_secs
+                       : libravatarprefs.timeout);
+       curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
 
        filename = cache_name_for_md5(md5);
        file = fopen(filename, "wb");
@@ -147,7 +175,8 @@ static GtkWidget *image_widget_from_url(const gchar *url, const gchar *md5)
                long filesize;
 
                if (libravatarprefs.allow_redirects) {
-                       long maxredirs = (libravatarprefs.default_mode == DEF_MODE_MM)? 2L: 1L;
+                       long maxredirs = (libravatarprefs.default_mode == DEF_MODE_URL)? 3L
+                               : ((libravatarprefs.default_mode == DEF_MODE_MM)? 2L: 1L);
 
                        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
                        curl_easy_setopt(curl, CURLOPT_MAXREDIRS, maxredirs);
@@ -163,15 +192,15 @@ static GtkWidget *image_widget_from_url(const gchar *url, const gchar *md5)
                else
                        image = image_widget_from_filename(filename);
 
-               if (!libravatarprefs.cache_icons) {
+               if (!libravatarprefs.cache_icons || filesize == 0) {
                        if (g_unlink(filename) < 0)
-                               g_warning("failed to delete cache file %s\n", filename);
+                               g_warning("failed to delete cache file '%s'", filename);
                }
 
                if (filesize == 0)
                        missing_add_md5(libravatarmisses, md5);
        } else {
-               g_warning("could not open '%s' for writting\n", filename);
+               g_warning("could not open '%s' for writing", filename);
        }
        curl_easy_cleanup(curl);
        g_free(filename);
@@ -181,7 +210,7 @@ static GtkWidget *image_widget_from_url(const gchar *url, const gchar *md5)
 
 static gboolean is_recent_enough(const gchar *filename)
 {
-       struct stat s;
+       GStatBuf s;
        time_t t;
 
        if (libravatarprefs.cache_icons) {
@@ -225,7 +254,7 @@ static gchar *libravatar_url_for_md5(const gchar *base, const gchar *md5)
                                base, md5, AVATAR_SIZE);
        }
 
-       g_warning("invalid libravatar default mode: %d\n", libravatarprefs.default_mode);
+       g_warning("invalid libravatar default mode: %d", libravatarprefs.default_mode);
        return NULL;
 }
 
@@ -253,10 +282,11 @@ static gboolean libravatar_image_render_hook(gpointer source, gpointer data)
                        if (ar->image) /* previous plugin set one */
                                gtk_widget_destroy(ar->image);
                        ar->image = image;
+                       ar->type  = AVATAR_LIBRAVATAR;
                        return FALSE;
                }
                /* not cached copy: try network */
-               if (prefs_common.work_offline) {
+               if (prefs_common_get_prefs()->work_offline) {
                        debug_print("working off-line: libravatar network retrieval skipped\n");
                        return FALSE;
                }
@@ -269,6 +299,7 @@ static gboolean libravatar_image_render_hook(gpointer source, gpointer data)
                                if (ar->image) /* previous plugin set one */
                                        gtk_widget_destroy(ar->image);
                                ar->image = image;
+                               ar->type  = AVATAR_LIBRAVATAR;
                        }
                }
                g_free(base);
@@ -281,29 +312,8 @@ static gboolean libravatar_image_render_hook(gpointer source, gpointer data)
 
 static gint cache_dir_init()
 {
-       gchar *subdir;
-       int i;
-
-       cache_dir = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
-                               LIBRAVATAR_CACHE_DIR, G_DIR_SEPARATOR_S,
-                               NULL);
-       if (!is_dir_exist(cache_dir)) {
-               if (make_dir(cache_dir) < 0) {
-                       g_free(cache_dir);
-                       return -1;
-               }
-       }
-       for (i = DEF_MODE_MM; i <= DEF_MODE_RETRO; ++i) {
-               subdir = g_strconcat(cache_dir, def_mode[i - 10], NULL);
-               if (!is_dir_exist(subdir)) {
-                       if (make_dir(subdir) < 0) {
-                               g_warning("cannot create directory %s\n", subdir);
-                               g_free(subdir);
-                               return -1;
-                       }
-               }
-               g_free(subdir);
-       }
+       cache_dir = libravatar_cache_init(def_mode, DEF_MODE_MM - 10, DEF_MODE_RETRO - 10);
+       cm_return_val_if_fail (cache_dir != NULL, -1);
 
        return 0;
 }
@@ -337,6 +347,20 @@ static void missing_cache_done()
        }
 }
 
+static void unregister_hooks()
+{
+       if (render_hook_id != -1) {
+               hooks_unregister_hook(AVATAR_IMAGE_RENDER_HOOKLIST,
+                                     render_hook_id);
+               render_hook_id = -1;
+       }
+       if (update_hook_id != -1) {
+               hooks_unregister_hook(AVATAR_HEADER_UPDATE_HOOKLIST,
+                                     update_hook_id);
+               update_hook_id = -1;
+       }
+}
+
 /**
  * Initialize plugin.
  *
@@ -362,11 +386,13 @@ gint plugin_init(gchar **error)
                                             libravatar_image_render_hook,
                                             NULL);
        if (render_hook_id == -1) {
+               unregister_hooks();
                *error = g_strdup(_("Failed to register avatar image render hook"));
                return -1;
        }
        /* cache dir */
        if (cache_dir_init() == -1) {
+               unregister_hooks();
                *error = g_strdup(_("Failed to create avatar image cache directory"));
                return -1;
        }
@@ -376,6 +402,7 @@ gint plugin_init(gchar **error)
        curl_global_init(CURL_GLOBAL_DEFAULT);
        /* missing cache */
        if (missing_cache_init() == -1) {
+               unregister_hooks();
                *error = g_strdup(_("Failed to load missing items cache"));
                return -1;
        }
@@ -392,16 +419,7 @@ gint plugin_init(gchar **error)
  */
 gboolean plugin_done(void)
 {
-       if (render_hook_id != -1) {
-               hooks_unregister_hook(AVATAR_IMAGE_RENDER_HOOKLIST,
-                                     render_hook_id);
-               render_hook_id = -1;
-       }
-       if (update_hook_id != -1) {
-               hooks_unregister_hook(AVATAR_HEADER_UPDATE_HOOKLIST,
-                                     update_hook_id);
-               update_hook_id = -1;
-       }
+       unregister_hooks();
        libravatar_prefs_done();
        missing_cache_done();
        if (cache_dir != NULL)
@@ -428,8 +446,15 @@ const gchar *plugin_name(void)
  */
 const gchar *plugin_desc(void)
 {
-       return _("Get and display libravatar images for mail messages.\n\n"
-                "Info about libravatar at http://www.libravatar.org/\n\n"
+       return _("Display libravatar profiles' images for mail messages. More\n"
+                "info about libravatar at http://www.libravatar.org/. If you have\n"
+                "a gravatar.com profile but not a libravatar one, those will also\n"
+                "be retrieved (when redirections are allowed in plugin config).\n"
+                "Plugin config page is available from main window at:\n"
+                "/Configuration/Preferences/Plugins/Libravatar.\n\n"
+                "This plugin uses libcurl to retrieve images, so if you're behind a\n"
+                "proxy please refer to curl(1) manpage for details on 'http_proxy'\n"
+                "configuration. More details about this and others on README file.\n\n"
                 "Feedback to <ricardo@mones.org> is welcome.\n");
 }