path: root/src/bookmarks/ephy-bookmarks.c

/*
 *  Copyright (C) 2002 Marco Pesenti Gritti
 *
 *  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, 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-bookmarks.h"
#include "ephy-file-helpers.h"
#include "ephy-shell.h"
#include "ephy-history.h"
#include "ephy-debug.h"
#include "ephy-tree-model-node.h"
#include "ephy-node-common.h"
#include "ephy-toolbars-model.h"
#include "ephy-bookmarks-export.h"
#include "ephy-bookmarks-import.h"
#include "ephy-autocompletion.h"
#include "session.h"

#include <string.h>
#include <bonobo/bonobo-i18n.h>
#include <libgnomevfs/gnome-vfs-utils.h>

#define EPHY_BOOKMARKS_XML_VERSION "1.0"
#define BOOKMARKS_SAVE_DELAY (3 * 1000)
#define MAX_FAVORITES_NUM 10

struct EphyBookmarksPrivate
{
    EphyToolbarsModel *toolbars_model;
    gboolean init_defaults;
    gboolean dirty;
    guint save_timeout_id;
    char *xml_file;
    char *rdf_file;
    EphyNodeDb *db;
    EphyNode *bookmarks;
    EphyNode *keywords;
    EphyNode *favorites;
    EphyNode *notcategorized;
    EphyNode *lower_fav;
    double lower_score;
};

typedef struct
{
    const char *title;
    const char *location;
    const char *smart_url;
} EphyBookmarksBookmarkInfo;

static const EphyBookmarksBookmarkInfo default_bookmarks [] =
{
    /* Translators you should change these links to respect your locale.
     * For instance in .nl these should be
     * "http://www.google.nl" and "http://www.google.nl/search?q=%s"
     */

    { N_("Search the web"), N_("http://www.google.com/search?q=%s&ie=UTF-8&oe=UTF-8") }
};
static int n_default_bookmarks = G_N_ELEMENTS (default_bookmarks);

static const char *default_topics [] =
{
    N_("Entertainment"),
    N_("News"),
    N_("Shopping"),
    N_("Sports"),
    N_("Travel"),
    N_("Work")
};
static int n_default_topics = G_N_ELEMENTS (default_topics);

enum
{
    PROP_0,
    PROP_TOOLBARS_MODEL
};

/* Signals */
enum
{
    TREE_CHANGED,
    LAST_SIGNAL
};

static guint ephy_bookmarks_signals[LAST_SIGNAL] = { 0 };

static void
ephy_bookmarks_class_init (EphyBookmarksClass *klass);
static void
ephy_bookmarks_init (EphyBookmarks *tab);
static void
ephy_bookmarks_finalize (GObject *object);
static void
ephy_bookmarks_autocompletion_source_init (EphyAutocompletionSourceIface *iface);

static GObjectClass *parent_class = NULL;

GType
ephy_bookmarks_get_type (void)
{
        static GType ephy_bookmarks_type = 0;

        if (ephy_bookmarks_type == 0)
        {
                static const GTypeInfo our_info =
                {
                        sizeof (EphyBookmarksClass),
                        NULL, /* base_init */
                        NULL, /* base_finalize */
                        (GClassInitFunc) ephy_bookmarks_class_init,
                        NULL,
                        NULL, /* class_data */
                        sizeof (EphyBookmarks),
                        0, /* n_preallocs */
                        (GInstanceInitFunc) ephy_bookmarks_init
                };

        static const GInterfaceInfo autocompletion_source_info =
        {
            (GInterfaceInitFunc) ephy_bookmarks_autocompletion_source_init,
            NULL,
            NULL
        };

                ephy_bookmarks_type = g_type_register_static (G_TYPE_OBJECT,
                                  "EphyBookmarks",
                                  &our_info, 0);

        g_type_add_interface_static (ephy_bookmarks_type,
                         EPHY_TYPE_AUTOCOMPLETION_SOURCE,
                         &autocompletion_source_info);
        }

        return ephy_bookmarks_type;
}

static void
ephy_bookmarks_autocompletion_source_set_basic_key (EphyAutocompletionSource *source,
                            const gchar *basic_key)
{
    /* nothing to do here */
}

static void
ephy_bookmarks_autocompletion_source_foreach (EphyAutocompletionSource *source,
                          const gchar *current_text,
                          EphyAutocompletionSourceForeachFunc func,
                          gpointer data)
{
    GPtrArray *children;
    int i;
    EphyBookmarks *eb = EPHY_BOOKMARKS (source);

    children = ephy_node_get_children (eb->priv->bookmarks);
    for (i = 0; i < children->len; i++)
    {
        EphyNode *kid;
        const char *url, *title, *keywords;
        gboolean smart_url;

        kid = g_ptr_array_index (children, i);
        url = ephy_node_get_property_string
            (kid, EPHY_NODE_BMK_PROP_LOCATION);
        smart_url = ephy_node_get_property_boolean
            (kid, EPHY_NODE_BMK_PROP_HAS_SMART_ADDRESS);
        title = ephy_node_get_property_string
            (kid, EPHY_NODE_BMK_PROP_TITLE);
        keywords = ephy_node_get_property_string
            (kid, EPHY_NODE_BMK_PROP_KEYWORDS);

        func (source, keywords, title, url, smart_url,
              !smart_url, 0, data);
    }
    ephy_node_thaw (eb->priv->bookmarks);
}

static void
ephy_bookmarks_emit_data_changed (EphyBookmarks *eb)
{
    g_signal_emit_by_name (eb, "data-changed");
}

static void
ephy_bookmarks_autocompletion_source_init (EphyAutocompletionSourceIface *iface)
{
    iface->foreach = ephy_bookmarks_autocompletion_source_foreach;
    iface->set_basic_key = ephy_bookmarks_autocompletion_source_set_basic_key;
}

static void
ephy_bookmarks_init_defaults (EphyBookmarks *eb)
{
    int i;

    for (i = 0; i < n_default_topics; i++)
    {
        ephy_bookmarks_add_keyword (eb, default_topics[i]);
    }

    for (i = 0; i < n_default_bookmarks; i++)
    {
        EphyNode *bmk;

        bmk = ephy_bookmarks_add (eb, default_bookmarks[i].title,
                          default_bookmarks[i].location);
        ephy_toolbars_model_add_bookmark (eb->priv->toolbars_model, FALSE,
                          ephy_node_get_id (bmk));
    }
}

static void
ephy_bookmarks_set_toolbars_model (EphyBookmarks *eb, EphyToolbarsModel *model)
{
    eb->priv->toolbars_model = model;
    g_object_add_weak_pointer (G_OBJECT(eb->priv->toolbars_model),
                   (gpointer *)&eb->priv->toolbars_model);

    if (eb->priv->init_defaults)
    {
        ephy_bookmarks_init_defaults (eb);
    }
}

static void
ephy_bookmarks_set_property (GObject *object,
                             guint prop_id,
                             const GValue *value,
                             GParamSpec *pspec)
{
    EphyBookmarks *eb;

    eb = EPHY_BOOKMARKS (object);

    switch (prop_id)
    {
        case PROP_TOOLBARS_MODEL:
            ephy_bookmarks_set_toolbars_model (eb, g_value_get_object (value));
            break;
    }
}

static void
ephy_bookmarks_get_property (GObject *object,
                             guint prop_id,
                             GValue *value,
                             GParamSpec *pspec)
{
    EphyBookmarks *eb;

    eb = EPHY_BOOKMARKS (object);

    switch (prop_id)
    {
        case PROP_TOOLBARS_MODEL:
            g_value_set_object (value, eb->priv->toolbars_model);
            break;
    }
}


static void
ephy_bookmarks_class_init (EphyBookmarksClass *klass)
{
        GObjectClass *object_class = G_OBJECT_CLASS (klass);

        parent_class = g_type_class_peek_parent (klass);

        object_class->finalize = ephy_bookmarks_finalize;
    object_class->set_property = ephy_bookmarks_set_property;
    object_class->get_property = ephy_bookmarks_get_property;

    ephy_bookmarks_signals[TREE_CHANGED] =
        g_signal_new ("tree_changed",
                  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (EphyBookmarksClass, tree_changed),
                  NULL, NULL,
                  g_cclosure_marshal_VOID__VOID,
                  G_TYPE_NONE,
                  0);

    g_object_class_install_property (object_class,
                                         PROP_TOOLBARS_MODEL,
                                         g_param_spec_object ("toolbars_model",
                                                              "Toolbars model",
                                                              "Toolbars model",
                                                              EPHY_TOOLBARS_MODEL_TYPE,
                                                              G_PARAM_READWRITE));

}

static gboolean
ephy_bookmarks_load (EphyBookmarks *eb)
{
    xmlDocPtr doc;
    xmlNodePtr root, child;
    char *tmp;
    gboolean result = TRUE;

    if (g_file_test (eb->priv->xml_file, G_FILE_TEST_EXISTS) == FALSE)
        return FALSE;

    doc = xmlParseFile (eb->priv->xml_file);
    g_return_val_if_fail (doc != NULL, FALSE);

    root = xmlDocGetRootElement (doc);

    tmp = xmlGetProp (root, "version");
    if (tmp != NULL && strcmp (tmp, EPHY_BOOKMARKS_XML_VERSION) != 0)
    {
        g_warning ("Old bookmarks database format detected");
        child = NULL;
        result = FALSE;
    }
    g_free (tmp);

    for (child = root->children; child != NULL; child = child->next)
    {
        EphyNode *node;

        node = ephy_node_new_from_xml (eb->priv->db, child);
    }

    xmlFreeDoc (doc);

    return result;
}

static void
ephy_bookmarks_save (EphyBookmarks *eb)
{
    xmlDocPtr doc;
    xmlNodePtr root;
    xmlNodePtr comment;
    GPtrArray *children;
    int i;

    LOG ("Saving bookmarks")

    /* save nodes to xml */
    xmlIndentTreeOutput = TRUE;
    doc = xmlNewDoc ("1.0");

    root = xmlNewDocNode (doc, NULL, "ephy_bookmarks", NULL);
    xmlSetProp (root, "version", EPHY_BOOKMARKS_XML_VERSION);
    xmlDocSetRootElement (doc, root);

    comment = xmlNewDocComment (doc, "Do not rely on this file, it's only for internal use. Use bookmarks.rdf instead.");
    xmlAddChild (root, comment);

    children = ephy_node_get_children (eb->priv->keywords);
    for (i = 0; i < children->len; i++)
    {
        EphyNode *kid;

        kid = g_ptr_array_index (children, i);

        if (kid != eb->priv->bookmarks &&
            kid != eb->priv->favorites &&
            kid != eb->priv->notcategorized)
        {
            ephy_node_save_to_xml (kid, root);
        }
    }
    ephy_node_thaw (eb->priv->keywords);

    children = ephy_node_get_children (eb->priv->bookmarks);
    for (i = 0; i < children->len; i++)
    {
        EphyNode *kid;

        kid = g_ptr_array_index (children, i);

        ephy_node_save_to_xml (kid, root);
    }
    ephy_node_thaw (eb->priv->bookmarks);

    ephy_file_save_xml (eb->priv->xml_file, doc);
    xmlFreeDoc(doc);

    /* Export bookmarks in rdf */
    ephy_bookmarks_export_rdf (eb, eb->priv->rdf_file);
}

static gboolean
save_bookmarks_delayed (EphyBookmarks *bookmarks)
{
    ephy_bookmarks_save (bookmarks);
    bookmarks->priv->dirty = FALSE;
    bookmarks->priv->save_timeout_id = 0;

    return FALSE;
}

static void
ephy_bookmarks_save_delayed (EphyBookmarks *bookmarks, int delay)
{
    if (!bookmarks->priv->dirty)
    {
        bookmarks->priv->dirty = TRUE;

        if (delay > 0)
        {
            bookmarks->priv->save_timeout_id =
                g_timeout_add (BOOKMARKS_SAVE_DELAY,
                               (GSourceFunc) save_bookmarks_delayed,
                           bookmarks);
        }
        else
        {
            bookmarks->priv->save_timeout_id =
                g_idle_add ((GSourceFunc) save_bookmarks_delayed,
                        bookmarks);
        }
    }
}

static double
get_history_item_score (EphyHistory *eh, const char *page)
{
    return ephy_history_get_page_visits (eh, page);
}

static EphyNode *
compute_lower_fav (EphyNode *favorites, double *score)
{
    GPtrArray *children;
    int i;
    EphyEmbedShell *embed_shell;
    EphyHistory *history;
    EphyNode *result = NULL;

    embed_shell = EPHY_EMBED_SHELL (ephy_shell);
    history = ephy_embed_shell_get_global_history (embed_shell);

    *score = DBL_MAX;
    children = ephy_node_get_children (favorites);
    for (i = 0; i < children->len; i++)
    {
        const char *url;
        EphyNode *child;
        double item_score;

        child = g_ptr_array_index (children, i);
        url = ephy_node_get_property_string
            (child, EPHY_NODE_BMK_PROP_LOCATION);
        item_score = get_history_item_score (history, url);
        if (*score > item_score)
        {
            *score = item_score;
            result = child;
        }
    }
    ephy_node_thaw (favorites);

    if (result == NULL) *score = 0;

    return result;
}

static void
ephy_bookmarks_update_favorites (EphyBookmarks *eb)
{
    eb->priv->lower_fav = compute_lower_fav (eb->priv->favorites,
                         &eb->priv->lower_score);
}

static gboolean
add_to_favorites (EphyBookmarks *eb, EphyNode *node, EphyHistory *eh)
{
    const char *url;
    gboolean full_menu;
    double score;

    if (ephy_node_has_child (eb->priv->favorites, node)) return FALSE;

    url = ephy_node_get_property_string (node, EPHY_NODE_BMK_PROP_LOCATION);
    score = get_history_item_score (eh, url);
    full_menu = ephy_node_get_n_children (eb->priv->favorites)
            > MAX_FAVORITES_NUM;
    if (full_menu && score < eb->priv->lower_score) return FALSE;

    if (eb->priv->lower_fav && full_menu)
    {
        ephy_node_remove_child (eb->priv->favorites,
                        eb->priv->lower_fav);
    }

    ephy_node_add_child (eb->priv->favorites, node);
    ephy_bookmarks_update_favorites (eb);

    return TRUE;
}

static void
update_favorites_menus ()
{
    Session *session;
    const GList *l;

    session = SESSION (ephy_shell_get_session (ephy_shell));
    l = session_get_windows (session);

    for (; l != NULL; l = l->next)
    {
        EphyWindow *window = EPHY_WINDOW (l->data);

        ephy_window_update_control (window, FavoritesControl);
    }
}

static void
history_site_visited_cb (EphyHistory *gh, const char *url, EphyBookmarks *eb)
{
    EphyNode *node;

    node = ephy_bookmarks_find_bookmark (eb, url);
    if (node == NULL) return;

    if (add_to_favorites (eb, node, gh))
    {
        update_favorites_menus ();
    }
}

static void
ephy_setup_history_notifiers (EphyBookmarks *eb)
{
    EphyEmbedShell *embed_shell;
    EphyHistory *history;

    embed_shell = EPHY_EMBED_SHELL (ephy_shell);
    history = ephy_embed_shell_get_global_history (embed_shell);

    g_signal_connect (history, "visited",
              G_CALLBACK (history_site_visited_cb), eb);
}

static void
bookmarks_changed_cb (EphyNode *node,
              EphyNode *child,
              EphyBookmarks *eb)
{
    ephy_bookmarks_emit_data_changed (eb);
    ephy_bookmarks_save_delayed (eb, BOOKMARKS_SAVE_DELAY);
}

static void
bookmarks_removed_cb (EphyNode *node,
              EphyNode *child,
              guint old_index,
              EphyBookmarks *eb)
{
    ephy_bookmarks_emit_data_changed (eb);
    g_signal_emit (G_OBJECT (eb), ephy_bookmarks_signals[TREE_CHANGED], 0);
    ephy_bookmarks_save_delayed (eb, BOOKMARKS_SAVE_DELAY);
}

static char *
get_topics_list (EphyBookmarks *eb,
         EphyNode *bookmark,
         gboolean *no_topics)
{
    GPtrArray *children;
    int i;
    GString *list;

    list = g_string_new (NULL);
    *no_topics = TRUE;

    children = ephy_node_get_children (eb->priv->keywords);
    for (i = 0; i < children->len; i++)
    {
        EphyNode *kid;

        kid = g_ptr_array_index (children, i);

        if (kid != eb->priv->notcategorized && 
            kid != eb->priv->favorites &&
            kid != eb->priv->bookmarks &&
            ephy_node_has_child (kid, bookmark))
        {
            const char *topic;
            topic = ephy_node_get_property_string
                (kid, EPHY_NODE_KEYWORD_PROP_NAME);
            g_string_append (list, topic);
            *no_topics = FALSE;
        }
    }
    ephy_node_thaw (eb->priv->keywords);

    return g_string_free (list, FALSE);
}

static void
update_topics_list (EphyNode *bookmark, const char *list)
{
    GValue value = { 0, };

    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, list);
    ephy_node_set_property (bookmark, EPHY_NODE_BMK_PROP_KEYWORDS,
                    &value);
    g_value_unset (&value);
}


static void
topics_removed_cb (EphyNode *node,
           EphyNode *child,
           guint old_index,
           EphyBookmarks *eb)
{
    GPtrArray *children;
    int i;

    children = ephy_node_get_children (child);
    for (i = 0; i < children->len; i++)
    {
        EphyNode *kid;
        gboolean no_topics;
        char *list;

        kid = g_ptr_array_index (children, i);
        list = get_topics_list (eb, kid, &no_topics);

        if (no_topics &&
            !ephy_node_has_child (eb->priv->notcategorized, kid))
        {
            ephy_node_add_child
                (eb->priv->notcategorized, kid);
        }

        update_topics_list (kid, list);

        g_free (list);
    }
    ephy_node_thaw (child);

    g_signal_emit (G_OBJECT (eb), ephy_bookmarks_signals[TREE_CHANGED], 0);
}

static void
ephy_bookmarks_init (EphyBookmarks *eb)
{
    GValue value = { 0, };
    EphyNodeDb *db;

    LOG ("Init");

        eb->priv = g_new0 (EphyBookmarksPrivate, 1);
    eb->priv->toolbars_model = NULL;

    db = ephy_node_db_new (EPHY_NODE_DB_BOOKMARKS);
    eb->priv->db = db;
    eb->priv->dirty = FALSE;
    eb->priv->save_timeout_id = 0;
    eb->priv->xml_file = g_build_filename (ephy_dot_dir (),
                           "ephy-bookmarks.xml",
                           NULL);
    eb->priv->rdf_file = g_build_filename (ephy_dot_dir (),
                           "bookmarks.rdf",
                           NULL);

    /* Bookmarks */
    eb->priv->bookmarks = ephy_node_new_with_id (db, BOOKMARKS_NODE_ID);
    ephy_node_ref (eb->priv->bookmarks);
    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, _("All"));
    ephy_node_set_property (eb->priv->bookmarks,
                    EPHY_NODE_KEYWORD_PROP_NAME,
                    &value);
    g_value_unset (&value);
    ephy_node_signal_connect_object (eb->priv->bookmarks,
                         EPHY_NODE_CHILD_REMOVED,
                         (EphyNodeCallback) bookmarks_removed_cb,
                         G_OBJECT (eb));
    ephy_node_signal_connect_object (eb->priv->bookmarks,
                         EPHY_NODE_CHILD_CHANGED,
                         (EphyNodeCallback) bookmarks_changed_cb,
                         G_OBJECT (eb));

    /* Keywords */
    eb->priv->keywords = ephy_node_new_with_id (db, KEYWORDS_NODE_ID);
    ephy_node_ref (eb->priv->keywords);
    g_value_init (&value, G_TYPE_INT);
    g_value_set_int (&value, EPHY_NODE_ALL_PRIORITY);
    ephy_node_set_property (eb->priv->bookmarks,
                    EPHY_NODE_KEYWORD_PROP_PRIORITY,
                    &value);
    g_value_unset (&value);
    ephy_node_signal_connect_object (eb->priv->keywords,
                         EPHY_NODE_CHILD_REMOVED,
                         (EphyNodeCallback) topics_removed_cb,
                         G_OBJECT (eb));

    ephy_node_add_child (eb->priv->keywords,
                 eb->priv->bookmarks);

    /* Favorites */
    eb->priv->favorites = ephy_node_new_with_id (db, FAVORITES_NODE_ID);
    ephy_node_ref (eb->priv->favorites);
    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, _("Most Visited"));
    ephy_node_set_property (eb->priv->favorites,
                    EPHY_NODE_KEYWORD_PROP_NAME,
                    &value);
    g_value_unset (&value);
    g_value_init (&value, G_TYPE_INT);
    g_value_set_int (&value, EPHY_NODE_SPECIAL_PRIORITY);
    ephy_node_set_property (eb->priv->favorites,
                EPHY_NODE_KEYWORD_PROP_PRIORITY,
                &value);
    g_value_unset (&value);
    ephy_node_add_child (eb->priv->keywords, eb->priv->favorites);

    /* Not categorized */
    eb->priv->notcategorized = ephy_node_new_with_id (db, BMKS_NOTCATEGORIZED_NODE_ID);
    ephy_node_ref (eb->priv->notcategorized);
    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, _("Not Categorized"));
    ephy_node_set_property (eb->priv->notcategorized,
                    EPHY_NODE_KEYWORD_PROP_NAME,
                    &value);
    g_value_unset (&value);
    g_value_init (&value, G_TYPE_INT);
    g_value_set_int (&value, EPHY_NODE_SPECIAL_PRIORITY);
    ephy_node_set_property (eb->priv->notcategorized,
                EPHY_NODE_KEYWORD_PROP_PRIORITY,
                &value);
    g_value_unset (&value);
    ephy_node_add_child (eb->priv->keywords, eb->priv->notcategorized);

    if (!ephy_bookmarks_load (eb))
    {
        if (!ephy_bookmarks_import_rdf (eb, eb->priv->rdf_file))
        {
            eb->priv->init_defaults = !ephy_bookmarks_load (eb);
        }
    }

    ephy_bookmarks_emit_data_changed (eb);

    ephy_setup_history_notifiers (eb);
    ephy_bookmarks_update_favorites (eb);
}

static void
ephy_bookmarks_finalize (GObject *object)
{
        EphyBookmarks *eb;

    g_return_if_fail (IS_EPHY_BOOKMARKS (object));

    eb = EPHY_BOOKMARKS (object);

        g_return_if_fail (eb->priv != NULL);

    if (eb->priv->save_timeout_id != 0)
    {
        g_source_remove (eb->priv->save_timeout_id);
    }

    ephy_bookmarks_save (eb);

    ephy_node_unref (eb->priv->bookmarks);
    ephy_node_unref (eb->priv->keywords);
    ephy_node_unref (eb->priv->favorites);
    ephy_node_unref (eb->priv->notcategorized);

    g_object_unref (eb->priv->db);

    if (eb->priv->toolbars_model)
    {
        g_object_remove_weak_pointer (G_OBJECT(eb->priv->toolbars_model),
                          (gpointer *)&eb->priv->toolbars_model);
    }

    g_free (eb->priv->xml_file);
    g_free (eb->priv->rdf_file);

        g_free (eb->priv);

    LOG ("Bookmarks finalized")

    G_OBJECT_CLASS (parent_class)->finalize (object);
}

EphyBookmarks *
ephy_bookmarks_new ()
{
    EphyBookmarks *tab;

    tab = EPHY_BOOKMARKS (g_object_new (EPHY_BOOKMARKS_TYPE, NULL));

    return tab;
}

static void
update_has_smart_address (EphyNode *bmk, const char *address)
{
    gboolean smart = FALSE;
    GValue value = { 0, };

    if (address)
    {
        smart = strstr (address, "%s") != NULL;
    }

    g_value_init (&value, G_TYPE_BOOLEAN);
    g_value_set_boolean (&value, smart);
    ephy_node_set_property (bmk, EPHY_NODE_BMK_PROP_HAS_SMART_ADDRESS,
                    &value);
    g_value_unset (&value);
}

EphyNode *
ephy_bookmarks_add (EphyBookmarks *eb,
            const char *title,
            const char *url)
{
    EphyNode *bm;
    GValue value = { 0, };

    bm = ephy_node_new (eb->priv->db);

    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, title);
    ephy_node_set_property (bm, EPHY_NODE_BMK_PROP_TITLE,
                    &value);
    g_value_unset (&value);

    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, url);
    ephy_node_set_property (bm, EPHY_NODE_BMK_PROP_LOCATION,
                    &value);
    g_value_unset (&value);

    update_has_smart_address (bm, url);

    ephy_node_add_child (eb->priv->bookmarks, bm);
    ephy_node_add_child (eb->priv->notcategorized, bm);

    ephy_bookmarks_emit_data_changed (eb);
    g_signal_emit (G_OBJECT (eb), ephy_bookmarks_signals[TREE_CHANGED], 0);
    ephy_bookmarks_save_delayed (eb, 0);

    return bm;
}

void
ephy_bookmarks_set_address (EphyBookmarks *eb,
                EphyNode *bookmark,
                const char *address)
{
    GValue value = { 0, };

    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, address);
    ephy_node_set_property (bookmark, EPHY_NODE_BMK_PROP_LOCATION,
                    &value);
    g_value_unset (&value);

    update_has_smart_address (bookmark, address);
}

EphyNode *
ephy_bookmarks_find_bookmark (EphyBookmarks *eb,
                  const char *url)
{
    GPtrArray *children;
    int i;

    g_return_val_if_fail (IS_EPHY_BOOKMARKS (eb), NULL);
    g_return_val_if_fail (eb->priv->bookmarks != NULL, NULL);
    g_return_val_if_fail (url != NULL, NULL);

    children = ephy_node_get_children (eb->priv->bookmarks);
    for (i = 0; i < children->len; i++)
    {
        EphyNode *kid;
        const char *location;

        kid = g_ptr_array_index (children, i);
        location = ephy_node_get_property_string
            (kid, EPHY_NODE_BMK_PROP_LOCATION);

        if (location != NULL && strcmp (url, location) == 0)
        {
            ephy_node_thaw (eb->priv->bookmarks);
            return kid;
        }
    }
    ephy_node_thaw (eb->priv->bookmarks);

    return NULL;
}

void
ephy_bookmarks_set_icon (EphyBookmarks *eb,
             const char *url,
             const char *icon)
{
    EphyNode *node;
    GValue value = { 0, };

    g_return_if_fail (icon != NULL);

    node = ephy_bookmarks_find_bookmark (eb, url);
    if (node == NULL) return;

    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, icon);
    ephy_node_set_property (node, EPHY_NODE_BMK_PROP_ICON,
                    &value);
    g_value_unset (&value);
}

static gchar *
options_skip_spaces (const gchar *str)
{
    const gchar *ret = str;
    while (*ret && g_ascii_isspace (*ret))
    {
        ++ret;
    }
    return (gchar *) ret;
}

static char *
options_find_value_end (const gchar *value_start)
{
    const gchar *value_end;
    if (*value_start == '"')
    {
        for (value_end = value_start + 1;
             *value_end && (*value_end != '"' || *(value_end - 1) == '\\');
             ++value_end) ;
    }
    else
    {
        for (value_end = value_start;
             *value_end && ! (g_ascii_isspace (*value_end)
                      || *value_end == ','
                      || *value_end == ';');
             ++value_end) ;
    }
    return (gchar *) value_end;
}

static char *
options_find_next_option (const char *current)
{
    const gchar *value_start;
    const gchar *value_end;
    const gchar *ret;
    value_start = strchr (current, '=');
    if (!value_start) return NULL;
    value_start = options_skip_spaces (value_start + 1);
    value_end = options_find_value_end (value_start);
    if (! (*value_end)) return NULL;
    for (ret = value_end + 1;
         *ret && (g_ascii_isspace (*ret)
              || *ret == ','
              || *ret == ';');
         ++ret);
    return (char *) ret;
}

/**
 * Very simple parser for option strings in the
 * form a=b,c=d,e="f g",...
 */
static gchar *
smart_url_options_get (const gchar *options, const gchar *option)
{
    gchar *ret = NULL;
    gsize optionlen = strlen (option);
    const gchar *current = options_skip_spaces (options);

    while (current)
    {
        if (!strncmp (option, current, optionlen))
        {
            if (g_ascii_isspace (*(current + optionlen)) || *(current + optionlen) == '=')
            {
                const gchar *value_start;
                const gchar *value_end;
                value_start = strchr (current + optionlen, '=');
                if (!value_start) continue;
                value_start = options_skip_spaces (value_start + 1);
                value_end = options_find_value_end (value_start);
                if (*value_start == '"') value_start++;
                if (value_end >= value_start)
                {
                    ret = g_strndup (value_start, value_end - value_start);
                    break;
                }
            }
        }
        current = options_find_next_option (current);
    }

    return ret;
}

static char *
get_smarturl_only (const char *smarturl)
{
    const gchar *openbrace;
    const gchar *closebrace;
    const gchar *c;

    openbrace = strchr (smarturl, '{');
    if (!openbrace) return g_strdup (smarturl);
    for (c = smarturl; c < openbrace; ++c)
    {
        if (!strchr (" \t\n", *c)) return g_strdup (smarturl);
    }

    closebrace = strchr (openbrace + 1, '}');
    if (!closebrace) return g_strdup (smarturl);

    return g_strdup (closebrace + 1);
}

char *
ephy_bookmarks_solve_smart_url (EphyBookmarks *eb,
                const char *smart_url,
                const char *content)
{
    gchar *ret;
    GString *s;
    gchar *t1;
    gchar *t2;
    gchar *encoding;
    gchar *smarturl_only;
    gchar *arg;
    gchar *escaped_arg;

    g_return_val_if_fail (content != NULL, NULL);

    smarturl_only = get_smarturl_only (smart_url);

    s = g_string_new ("");

    encoding = smart_url_options_get (smart_url, "encoding");
    if (!encoding)
    {
        encoding = g_strdup ("UTF-8");
    }

    arg = g_convert (content, strlen (content),
             encoding, "UTF-8", NULL, NULL, NULL);
    escaped_arg = gnome_vfs_escape_string (arg);

    t1 = smarturl_only;
    t2 = strstr (t1, "%s");
    g_return_val_if_fail (t2 != NULL, NULL);
    g_string_append_len (s, t1, t2 - t1);
    g_string_append (s, escaped_arg);
    t1 = t2 + 2;
    g_string_append (s, t1);
    ret = g_string_free (s, FALSE);

    g_free (arg);
    g_free (escaped_arg);
    g_free (encoding);
    g_free (smarturl_only);

    return ret;
}

EphyNode *
ephy_bookmarks_add_keyword (EphyBookmarks *eb,
                const char *name)
{
    EphyNode *key;
    GValue value = { 0, };

    key = ephy_node_new (eb->priv->db);

    g_value_init (&value, G_TYPE_STRING);
    g_value_set_string (&value, name);
    ephy_node_set_property (key, EPHY_NODE_KEYWORD_PROP_NAME,
                    &value);
    g_value_unset (&value);

    g_value_init (&value, G_TYPE_INT);
    g_value_set_int (&value, EPHY_NODE_NORMAL_PRIORITY);
    ephy_node_set_property (key, EPHY_NODE_KEYWORD_PROP_PRIORITY,
                    &value);
    g_value_unset (&value);

    ephy_node_add_child (eb->priv->keywords, key);

    return key;
}

void
ephy_bookmarks_remove_keyword (EphyBookmarks *eb,
                   EphyNode *keyword)
{
    ephy_node_remove_child (eb->priv->keywords, keyword);
}

char *
ephy_bookmarks_get_topic_uri (EphyBookmarks *eb,
                  EphyNode *node)
{
    char *uri;

    if (ephy_bookmarks_get_bookmarks (eb) == node)
    {
        uri = g_strdup ("topic://Special/All");
    }
    else if (ephy_bookmarks_get_not_categorized (eb) == node)
    {
        uri = g_strdup ("topic://Special/NotCategorized");
    }
    else if (ephy_bookmarks_get_favorites (eb) == node)
    {
        uri = g_strdup ("topic://Special/Favorites");
    }
    else
    {
        const char *name;

        name = ephy_node_get_property_string
            (node, EPHY_NODE_KEYWORD_PROP_NAME);

        uri = g_strdup_printf ("topic://%s", name);
    }

    return uri;
}

EphyNode *
ephy_bookmarks_find_keyword (EphyBookmarks *eb,
                 const char *name,
                 gboolean partial_match)
{
    EphyNode *node;
    GPtrArray *children;
    int i;
    const char *topic_name;

    g_return_val_if_fail (name != NULL, NULL);

    topic_name = name;

    if (g_utf8_strlen (name, -1) == 0)
    {
        LOG ("Empty name, no keyword matches.")
        return NULL;
    }

    if (strcmp (name, "topic://Special/All") == 0)
    {
        return ephy_bookmarks_get_bookmarks (eb);
    }
    else if (strcmp (name, "topic://Special/NotCategorized") == 0)
    {
        return ephy_bookmarks_get_not_categorized (eb);
    }
    else if (strcmp (name, "topic://Special/Favorites") == 0)
    {
        return ephy_bookmarks_get_favorites (eb);
    }
    else if (g_str_has_prefix (name, "topic://"))
    {
        topic_name += strlen ("topic://");
    }

    children = ephy_node_get_children (eb->priv->keywords);
    node = NULL;
    for (i = 0; i < children->len; i++)
    {
         EphyNode *kid;
         const char *key;

         kid = g_ptr_array_index (children, i);
         key = ephy_node_get_property_string (kid, EPHY_NODE_KEYWORD_PROP_NAME);

         if ((partial_match && g_str_has_prefix (key, topic_name) > 0) ||
             (!partial_match && strcmp (key, topic_name) == 0))
         {
             node = kid;
         }
    }
    ephy_node_thaw (eb->priv->keywords);

    return node;
}

gboolean
ephy_bookmarks_has_keyword (EphyBookmarks *eb,
                EphyNode *keyword,
                EphyNode *bookmark)
{
    return ephy_node_has_child (keyword, bookmark);
}

void
ephy_bookmarks_set_keyword (EphyBookmarks *eb,
                EphyNode *keyword,
                EphyNode *bookmark)
{
    gboolean no_topics;
    char *list;

    if (ephy_node_has_child (keyword, bookmark)) return;

    ephy_node_add_child (keyword, bookmark);

    list = get_topics_list (eb, bookmark, &no_topics);

    if (ephy_node_has_child (eb->priv->notcategorized, bookmark))
    {
        LOG ("Remove from categorized bookmarks")
        ephy_node_remove_child
            (eb->priv->notcategorized, bookmark);
    }

    update_topics_list (bookmark, list);
    g_free (list);

    g_signal_emit (G_OBJECT (eb), ephy_bookmarks_signals[TREE_CHANGED], 0);
}

void
ephy_bookmarks_unset_keyword (EphyBookmarks *eb,
                  EphyNode *keyword,
                  EphyNode *bookmark)
{
    gboolean no_topics;
    char *list;

    if (!ephy_node_has_child (keyword, bookmark)) return;

    ephy_node_remove_child (keyword, bookmark);

    list = get_topics_list (eb, bookmark, &no_topics);

    if (no_topics &&
        !ephy_node_has_child (eb->priv->notcategorized, bookmark))
    {
        LOG ("Add to not categorized bookmarks")
        ephy_node_add_child
            (eb->priv->notcategorized, bookmark);
    }

    update_topics_list (bookmark, list);
    g_free (list);

    g_signal_emit (G_OBJECT (eb), ephy_bookmarks_signals[TREE_CHANGED], 0);
}

EphyNode *
ephy_bookmarks_get_keywords (EphyBookmarks *eb)
{
    return eb->priv->keywords;
}

EphyNode *
ephy_bookmarks_get_bookmarks (EphyBookmarks *eb)
{
    return eb->priv->bookmarks;
}

EphyNode *
ephy_bookmarks_get_favorites (EphyBookmarks *eb)
{
    return eb->priv->favorites;
}

EphyNode *
ephy_bookmarks_get_not_categorized (EphyBookmarks *eb)
{
    return eb->priv->notcategorized;
}

EphyNode *
ephy_bookmarks_get_from_id (EphyBookmarks *eb, long id)
{
    return ephy_node_db_get_node_from_id (eb->priv->db, id);
}