/* * Copyright (C) 2002 Jorn Baayen * Copyright (C) 2003-2004 Marco Pesenti Gritti * Copyright (C) 2004 Christian Persch * * 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 * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * $Id$ */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "ephy-favicon-cache.h" #include #include #include #include #include "ephy-embed-persist.h" #include "ephy-embed-factory.h" #include "ephy-file-helpers.h" #include "ephy-node-common.h" #include "ephy-node.h" #include "ephy-debug.h" #define EPHY_FAVICON_CACHE_XML_ROOT "ephy_favicons_cache" #define EPHY_FAVICON_CACHE_XML_VERSION "1.1" #define EPHY_FAVICON_CACHE_OBSOLETE_DAYS 30 static void ephy_favicon_cache_class_init (EphyFaviconCacheClass *klass); static void ephy_favicon_cache_init (EphyFaviconCache *cache); static void ephy_favicon_cache_finalize (GObject *object); #define EPHY_FAVICON_CACHE_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_FAVICON_CACHE, EphyFaviconCachePrivate)) struct EphyFaviconCachePrivate { char *directory; char *xml_file; EphyNodeDb *db; EphyNode *icons; GHashTable *icons_hash; GHashTable *downloads_hash; }; enum { CHANGED, LAST_SIGNAL }; enum { EPHY_NODE_FAVICON_PROP_URL = 2, EPHY_NODE_FAVICON_PROP_FILENAME = 3, EPHY_NODE_FAVICON_PROP_LAST_USED = 4, EPHY_NODE_FAVICON_PROP_STATE = 5 }; static guint signals[LAST_SIGNAL] = { 0 }; static GObjectClass *parent_class = NULL; GType ephy_favicon_cache_get_type (void) { static GType type = 0; if (type == 0) { static const GTypeInfo our_info = { sizeof (EphyFaviconCacheClass), NULL, NULL, (GClassInitFunc) ephy_favicon_cache_class_init, NULL, NULL, sizeof (EphyFaviconCache), 0, (GInstanceInitFunc) ephy_favicon_cache_init }; type = g_type_register_static (G_TYPE_OBJECT, "EphyFaviconCache", &our_info, 0); } return type; } static void ephy_favicon_cache_class_init (EphyFaviconCacheClass *klass) { GObjectClass *object_class = G_OBJECT_CLASS (klass); parent_class = g_type_class_peek_parent (klass); object_class->finalize = ephy_favicon_cache_finalize; signals[CHANGED] = g_signal_new ("changed", G_OBJECT_CLASS_TYPE (object_class), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (EphyFaviconCacheClass, changed), NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE, 1, G_TYPE_STRING); g_type_class_add_private (object_class, sizeof (EphyFaviconCachePrivate)); } EphyFaviconCache * ephy_favicon_cache_new (void) { return EPHY_FAVICON_CACHE (g_object_new (EPHY_TYPE_FAVICON_CACHE, NULL)); } static gboolean icon_is_obsolete (EphyNode *node, GDate *now) { int last_visit; GDate date; last_visit = ephy_node_get_property_int (node, EPHY_NODE_FAVICON_PROP_LAST_USED); g_date_clear (&date, 1); g_date_set_time (&date, last_visit); return (g_date_days_between (&date, now) >= EPHY_FAVICON_CACHE_OBSOLETE_DAYS); } static void icons_added_cb (EphyNode *node, EphyNode *child, EphyFaviconCache *eb) { g_hash_table_insert (eb->priv->icons_hash, (char *) ephy_node_get_property_string (child, EPHY_NODE_FAVICON_PROP_URL), child); } static void icons_removed_cb (EphyNode *node, EphyNode *child, EphyFaviconCache *eb) { g_hash_table_remove (eb->priv->icons_hash, ephy_node_get_property_string (child, EPHY_NODE_FAVICON_PROP_URL)); } static void remove_obsolete_icons (EphyFaviconCache *eb) { GPtrArray *children; int i; GTime now; GDate current_date; now = time (NULL); g_date_clear (¤t_date, 1); g_date_set_time (¤t_date, time (NULL)); children = ephy_node_get_children (eb->priv->icons); for (i = 0; i < children->len; i++) { EphyNode *kid; kid = g_ptr_array_index (children, i); if (icon_is_obsolete (kid, ¤t_date)) { const char *filename; char *path; filename = ephy_node_get_property_string (kid, EPHY_NODE_FAVICON_PROP_FILENAME); path = g_build_filename (eb->priv->directory, filename, NULL); gnome_vfs_unlink (path); g_free (path); ephy_node_unref (kid); } } } static void ephy_favicon_cache_init (EphyFaviconCache *cache) { EphyNodeDb *db; cache->priv = EPHY_FAVICON_CACHE_GET_PRIVATE (cache); db = ephy_node_db_new (EPHY_NODE_DB_SITEICONS); cache->priv->db = db; cache->priv->xml_file = g_build_filename (ephy_dot_dir (), "ephy-favicon-cache.xml", NULL); cache->priv->directory = g_build_filename (ephy_dot_dir (), "favicon_cache", NULL); if (g_file_test (cache->priv->directory, G_FILE_TEST_IS_DIR) == FALSE) { if (mkdir (cache->priv->directory, 488) != 0) { g_error ("Couldn't mkdir %s.", cache->priv->directory); } } cache->priv->icons_hash = g_hash_table_new (g_str_hash, g_str_equal); cache->priv->downloads_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL); /* Icons */ cache->priv->icons = ephy_node_new_with_id (db, ICONS_NODE_ID); ephy_node_ref (cache->priv->icons); ephy_node_signal_connect_object (cache->priv->icons, EPHY_NODE_CHILD_ADDED, (EphyNodeCallback) icons_added_cb, G_OBJECT (cache)); ephy_node_signal_connect_object (cache->priv->icons, EPHY_NODE_CHILD_REMOVED, (EphyNodeCallback) icons_removed_cb, G_OBJECT (cache)); ephy_node_db_load_from_file (cache->priv->db, cache->priv->xml_file, EPHY_FAVICON_CACHE_XML_ROOT, EPHY_FAVICON_CACHE_XML_VERSION); } static gboolean kill_download (char *key, EphyEmbedPersist *persist, EphyFaviconCache *cache) { EphyNode *icon; /* disconnect "completed" and "cancelled" callbacks */ g_signal_handlers_disconnect_matched (persist,G_SIGNAL_MATCH_DATA , 0, 0, NULL, NULL, cache); /* now cancel the download */ ephy_embed_persist_cancel (persist); icon = g_hash_table_lookup (cache->priv->icons_hash, key); g_return_val_if_fail (EPHY_IS_NODE (icon), TRUE); ephy_node_unref (icon); return TRUE; } static void ephy_favicon_cache_finalize (GObject *object) { EphyFaviconCache *cache = EPHY_FAVICON_CACHE (object); LOG ("EphyFaviconCache finalising") g_hash_table_foreach_remove (cache->priv->downloads_hash, (GHRFunc) kill_download, cache); remove_obsolete_icons (cache); ephy_node_db_write_to_xml_safe (cache->priv->db, cache->priv->xml_file, EPHY_FAVICON_CACHE_XML_ROOT, EPHY_FAVICON_CACHE_XML_VERSION, NULL, cache->priv->icons, 0, NULL); g_free (cache->priv->xml_file); g_free (cache->priv->directory); g_hash_table_destroy (cache->priv->icons_hash); g_hash_table_destroy (cache->priv->downloads_hash); g_object_unref (cache->priv->db); G_OBJECT_CLASS (parent_class)->finalize (object); } static char * favicon_name_build (const char *url) { char *result; result = g_filename_from_utf8 (url, -1, NULL, NULL, NULL); if (result == NULL) { return NULL; } return g_strdelimit (result, "/", '_'); } static void favicon_download_completed_cb (EphyEmbedPersist *persist, EphyFaviconCache *cache) { const char *url; url = ephy_embed_persist_get_source (persist); g_return_if_fail (url != NULL); LOG ("Favicon cache download completed for %s", url) g_hash_table_remove (cache->priv->downloads_hash, url); g_signal_emit (G_OBJECT (cache), signals[CHANGED], 0, url); g_object_unref (persist); } static void favicon_download_cancelled_cb (EphyEmbedPersist *persist, EphyFaviconCache *cache) { const char *url, *dest; url = ephy_embed_persist_get_source (persist); g_return_if_fail (url != NULL); LOG ("Favicon cache download cancelled %s", url) g_hash_table_remove (cache->priv->downloads_hash, url); /* remove a partially downloaded file */ dest = ephy_embed_persist_get_dest (persist); gnome_vfs_unlink (dest); /* FIXME: re-schedule to try again after n days? */ g_object_unref (persist); } static void ephy_favicon_cache_download (EphyFaviconCache *cache, const char *favicon_url, const char *filename) { EphyEmbedPersist *persist; char *dest; LOG ("Download favicon: %s", favicon_url) g_return_if_fail (EPHY_IS_FAVICON_CACHE (cache)); g_return_if_fail (favicon_url != NULL); g_return_if_fail (filename != NULL); dest = g_build_filename (cache->priv->directory, filename, NULL); persist = EPHY_EMBED_PERSIST (ephy_embed_factory_new_object ("EphyEmbedPersist")); ephy_embed_persist_set_dest (persist, dest); ephy_embed_persist_set_flags (persist, EMBED_PERSIST_NO_VIEW); ephy_embed_persist_set_max_size (persist, 100 * 1024); ephy_embed_persist_set_source (persist, favicon_url); g_free (dest); g_signal_connect (G_OBJECT (persist), "completed", G_CALLBACK (favicon_download_completed_cb), cache); g_signal_connect (G_OBJECT (persist), "cancelled", G_CALLBACK (favicon_download_cancelled_cb), cache); g_hash_table_insert (cache->priv->downloads_hash, g_strdup (favicon_url), persist); ephy_embed_persist_save (persist); } GdkPixbuf * ephy_favicon_cache_get (EphyFaviconCache *cache, const char *url) { GTime now; EphyNode *icon; GValue value = { 0, }; char *pix_file; GdkPixbuf *pixbuf; if (url == NULL) return NULL; now = time (NULL); icon = g_hash_table_lookup (cache->priv->icons_hash, url); if (!icon) { char *filename; filename = favicon_name_build (url); if (filename == NULL) { return NULL; } icon = ephy_node_new (cache->priv->db); g_value_init (&value, G_TYPE_STRING); g_value_set_string (&value, url); ephy_node_set_property (icon, EPHY_NODE_FAVICON_PROP_URL, &value); g_value_unset (&value); g_value_init (&value, G_TYPE_STRING); g_value_set_string (&value, filename); ephy_node_set_property (icon, EPHY_NODE_FAVICON_PROP_FILENAME, &value); g_value_unset (&value); ephy_node_add_child (cache->priv->icons, icon); ephy_favicon_cache_download (cache, url, filename); g_free (filename); } g_value_init (&value, G_TYPE_INT); g_value_set_int (&value, now); ephy_node_set_property (icon, EPHY_NODE_FAVICON_PROP_LAST_USED, &value); g_value_unset (&value); if (g_hash_table_lookup (cache->priv->downloads_hash, url) != NULL) { /* still downloading, return NULL */ return NULL; } pix_file = g_build_filename (cache->priv->directory, ephy_node_get_property_string (icon, EPHY_NODE_FAVICON_PROP_FILENAME), NULL); LOG ("Create pixbuf for %s", pix_file) pixbuf = gdk_pixbuf_new_from_file (pix_file, NULL); g_free (pix_file); if (pixbuf == NULL) { return NULL; } if (gdk_pixbuf_get_width (pixbuf) > 16 || gdk_pixbuf_get_height (pixbuf) > 16) { GdkPixbuf *scaled = gdk_pixbuf_scale_simple (pixbuf, 16, 16, GDK_INTERP_NEAREST); g_object_unref (G_OBJECT (pixbuf)); pixbuf = scaled; } return pixbuf; }