1 /* gbookmarkfile.c: parsing and building desktop bookmarks
3 * Copyright (C) 2005-2006 Emmanuele Bassi
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 #include "gbookmarkfile.h"
32 #include <sys/types.h>
41 #include "gfileutils.h"
49 #include "gmessages.h"
54 #include "gstrfuncs.h"
60 * SECTION:bookmarkfile
61 * @title: Bookmark file parser
62 * @short_description: parses files containing bookmarks
64 * GBookmarkFile lets you parse, edit or create files containing bookmarks
65 * to URI, along with some meta-data about the resource pointed by the URI
66 * like its MIME type, the application that is registering the bookmark and
67 * the icon that should be used to represent the bookmark. The data is stored
69 * <ulink url="http://www.gnome.org/~ebassi/bookmark-spec">Desktop Bookmark
70 * Specification</ulink>.
72 * The syntax of the bookmark files is described in detail inside the Desktop
73 * Bookmark Specification, here is a quick summary: bookmark files use a
74 * sub-class of the <ulink url="">XML Bookmark Exchange Language</ulink>
75 * specification, consisting of valid UTF-8 encoded XML, under the
76 * <literal>xbel</literal> root element; each bookmark is stored inside a
77 * <literal>bookmark</literal> element, using its URI: no relative paths can
78 * be used inside a bookmark file. The bookmark may have a user defined title
79 * and description, to be used instead of the URI. Under the
80 * <literal>metadata</literal> element, with its <literal>owner</literal>
81 * attribute set to <literal>http://freedesktop.org</literal>, is stored the
82 * meta-data about a resource pointed by its URI. The meta-data consists of
83 * the resource's MIME type; the applications that have registered a bookmark;
84 * the groups to which a bookmark belongs to; a visibility flag, used to set
85 * the bookmark as "private" to the applications and groups that has it
86 * registered; the URI and MIME type of an icon, to be used when displaying
87 * the bookmark inside a GUI.
88 * |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../glib/tests/bookmarks.xbel"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]|
90 * A bookmark file might contain more than one bookmark; each bookmark
91 * is accessed through its URI.
93 * The important caveat of bookmark files is that when you add a new
94 * bookmark you must also add the application that is registering it, using
95 * g_bookmark_file_add_application() or g_bookmark_file_set_app_info().
96 * If a bookmark has no applications then it won't be dumped when creating
97 * the on disk representation, using g_bookmark_file_to_data() or
98 * g_bookmark_file_to_file().
100 * The #GBookmarkFile parser was added in GLib 2.12.
103 /* XBEL 1.0 standard entities */
104 #define XBEL_VERSION "1.0"
105 #define XBEL_DTD_NICK "xbel"
106 #define XBEL_DTD_SYSTEM "+//IDN python.org//DTD XML Bookmark " \
107 "Exchange Language 1.0//EN//XML"
109 #define XBEL_DTD_URI "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"
111 #define XBEL_ROOT_ELEMENT "xbel"
112 #define XBEL_FOLDER_ELEMENT "folder" /* unused */
113 #define XBEL_BOOKMARK_ELEMENT "bookmark"
114 #define XBEL_ALIAS_ELEMENT "alias" /* unused */
115 #define XBEL_SEPARATOR_ELEMENT "separator" /* unused */
116 #define XBEL_TITLE_ELEMENT "title"
117 #define XBEL_DESC_ELEMENT "desc"
118 #define XBEL_INFO_ELEMENT "info"
119 #define XBEL_METADATA_ELEMENT "metadata"
121 #define XBEL_VERSION_ATTRIBUTE "version"
122 #define XBEL_FOLDED_ATTRIBUTE "folded" /* unused */
123 #define XBEL_OWNER_ATTRIBUTE "owner"
124 #define XBEL_ADDED_ATTRIBUTE "added"
125 #define XBEL_VISITED_ATTRIBUTE "visited"
126 #define XBEL_MODIFIED_ATTRIBUTE "modified"
127 #define XBEL_ID_ATTRIBUTE "id"
128 #define XBEL_HREF_ATTRIBUTE "href"
129 #define XBEL_REF_ATTRIBUTE "ref" /* unused */
131 #define XBEL_YES_VALUE "yes"
132 #define XBEL_NO_VALUE "no"
134 /* Desktop bookmark spec entities */
135 #define BOOKMARK_METADATA_OWNER "http://freedesktop.org"
137 #define BOOKMARK_NAMESPACE_NAME "bookmark"
138 #define BOOKMARK_NAMESPACE_URI "http://www.freedesktop.org/standards/desktop-bookmarks"
140 #define BOOKMARK_GROUPS_ELEMENT "groups"
141 #define BOOKMARK_GROUP_ELEMENT "group"
142 #define BOOKMARK_APPLICATIONS_ELEMENT "applications"
143 #define BOOKMARK_APPLICATION_ELEMENT "application"
144 #define BOOKMARK_ICON_ELEMENT "icon"
145 #define BOOKMARK_PRIVATE_ELEMENT "private"
147 #define BOOKMARK_NAME_ATTRIBUTE "name"
148 #define BOOKMARK_EXEC_ATTRIBUTE "exec"
149 #define BOOKMARK_COUNT_ATTRIBUTE "count"
150 #define BOOKMARK_TIMESTAMP_ATTRIBUTE "timestamp" /* deprecated by "modified" */
151 #define BOOKMARK_MODIFIED_ATTRIBUTE "modified"
152 #define BOOKMARK_HREF_ATTRIBUTE "href"
153 #define BOOKMARK_TYPE_ATTRIBUTE "type"
155 /* Shared MIME Info entities */
156 #define MIME_NAMESPACE_NAME "mime"
157 #define MIME_NAMESPACE_URI "http://www.freedesktop.org/standards/shared-mime-info"
158 #define MIME_TYPE_ELEMENT "mime-type"
159 #define MIME_TYPE_ATTRIBUTE "type"
162 typedef struct _BookmarkAppInfo BookmarkAppInfo;
163 typedef struct _BookmarkMetadata BookmarkMetadata;
164 typedef struct _BookmarkItem BookmarkItem;
165 typedef struct _ParseData ParseData;
167 struct _BookmarkAppInfo
177 struct _BookmarkMetadata
184 GHashTable *apps_by_name;
189 guint is_private : 1;
203 BookmarkMetadata *metadata;
206 struct _GBookmarkFile
211 /* we store our items in a list and keep a copy inside
212 * an hash table for faster lookup performances
215 GHashTable *items_by_uri;
218 /* parser state machine */
239 static void g_bookmark_file_init (GBookmarkFile *bookmark);
240 static void g_bookmark_file_clear (GBookmarkFile *bookmark);
241 static gboolean g_bookmark_file_parse (GBookmarkFile *bookmark,
245 static gchar * g_bookmark_file_dump (GBookmarkFile *bookmark,
248 static BookmarkItem *g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
250 static void g_bookmark_file_add_item (GBookmarkFile *bookmark,
254 static time_t timestamp_from_iso8601 (const gchar *iso_date);
255 static gchar * timestamp_to_iso8601 (time_t timestamp);
257 /********************************
260 * Application metadata storage *
261 ********************************/
262 static BookmarkAppInfo *
263 bookmark_app_info_new (const gchar *name)
265 BookmarkAppInfo *retval;
267 g_warn_if_fail (name != NULL);
269 retval = g_slice_new (BookmarkAppInfo);
271 retval->name = g_strdup (name);
280 bookmark_app_info_free (BookmarkAppInfo *app_info)
285 g_free (app_info->name);
286 g_free (app_info->exec);
288 g_slice_free (BookmarkAppInfo, app_info);
292 bookmark_app_info_dump (BookmarkAppInfo *app_info)
295 gchar *name, *exec, *modified, *count;
297 g_warn_if_fail (app_info != NULL);
299 if (app_info->count == 0)
302 name = g_markup_escape_text (app_info->name, -1);
303 exec = g_markup_escape_text (app_info->exec, -1);
304 modified = timestamp_to_iso8601 (app_info->stamp);
305 count = g_strdup_printf ("%u", app_info->count);
307 retval = g_strconcat (" "
308 "<" BOOKMARK_NAMESPACE_NAME ":" BOOKMARK_APPLICATION_ELEMENT
309 " " BOOKMARK_NAME_ATTRIBUTE "=\"", name, "\""
310 " " BOOKMARK_EXEC_ATTRIBUTE "=\"", exec, "\""
311 " " BOOKMARK_MODIFIED_ATTRIBUTE "=\"", modified, "\""
312 " " BOOKMARK_COUNT_ATTRIBUTE "=\"", count, "\"/>\n",
324 /***********************
328 ***********************/
329 static BookmarkMetadata *
330 bookmark_metadata_new (void)
332 BookmarkMetadata *retval;
334 retval = g_slice_new (BookmarkMetadata);
336 retval->mime_type = NULL;
338 retval->groups = NULL;
340 retval->applications = NULL;
341 retval->apps_by_name = g_hash_table_new_full (g_str_hash,
346 retval->is_private = FALSE;
348 retval->icon_href = NULL;
349 retval->icon_mime = NULL;
355 bookmark_metadata_free (BookmarkMetadata *metadata)
360 g_free (metadata->mime_type);
362 g_list_free_full (metadata->groups, g_free);
363 g_list_free_full (metadata->applications, (GDestroyNotify) bookmark_app_info_free);
365 g_hash_table_destroy (metadata->apps_by_name);
367 g_free (metadata->icon_href);
368 g_free (metadata->icon_mime);
370 g_slice_free (BookmarkMetadata, metadata);
374 bookmark_metadata_dump (BookmarkMetadata *metadata)
379 if (!metadata->applications)
382 retval = g_string_sized_new (1024);
384 /* metadata container */
385 g_string_append (retval,
387 "<" XBEL_METADATA_ELEMENT
388 " " XBEL_OWNER_ATTRIBUTE "=\"" BOOKMARK_METADATA_OWNER
392 if (metadata->mime_type) {
393 buffer = g_strconcat (" "
394 "<" MIME_NAMESPACE_NAME ":" MIME_TYPE_ELEMENT " "
395 MIME_TYPE_ATTRIBUTE "=\"", metadata->mime_type, "\"/>\n",
397 g_string_append (retval, buffer);
401 if (metadata->groups)
405 /* open groups container */
406 g_string_append (retval,
408 "<" BOOKMARK_NAMESPACE_NAME
409 ":" BOOKMARK_GROUPS_ELEMENT ">\n");
411 for (l = g_list_last (metadata->groups); l != NULL; l = l->prev)
415 group_name = g_markup_escape_text ((gchar *) l->data, -1);
416 buffer = g_strconcat (" "
417 "<" BOOKMARK_NAMESPACE_NAME
418 ":" BOOKMARK_GROUP_ELEMENT ">",
420 "</" BOOKMARK_NAMESPACE_NAME
421 ":" BOOKMARK_GROUP_ELEMENT ">\n", NULL);
422 g_string_append (retval, buffer);
428 /* close groups container */
429 g_string_append (retval,
431 "</" BOOKMARK_NAMESPACE_NAME
432 ":" BOOKMARK_GROUPS_ELEMENT ">\n");
435 if (metadata->applications)
439 /* open applications container */
440 g_string_append (retval,
442 "<" BOOKMARK_NAMESPACE_NAME
443 ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");
445 for (l = g_list_last (metadata->applications); l != NULL; l = l->prev)
447 BookmarkAppInfo *app_info = (BookmarkAppInfo *) l->data;
450 g_warn_if_fail (app_info != NULL);
452 app_data = bookmark_app_info_dump (app_info);
456 retval = g_string_append (retval, app_data);
462 /* close applications container */
463 g_string_append (retval,
465 "</" BOOKMARK_NAMESPACE_NAME
466 ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");
470 if (metadata->icon_href)
472 if (!metadata->icon_mime)
473 metadata->icon_mime = g_strdup ("application/octet-stream");
475 buffer = g_strconcat (" "
476 "<" BOOKMARK_NAMESPACE_NAME
477 ":" BOOKMARK_ICON_ELEMENT
478 " " BOOKMARK_HREF_ATTRIBUTE "=\"", metadata->icon_href,
479 "\" " BOOKMARK_TYPE_ATTRIBUTE "=\"", metadata->icon_mime, "\"/>\n", NULL);
480 g_string_append (retval, buffer);
486 if (metadata->is_private)
487 g_string_append (retval,
489 "<" BOOKMARK_NAMESPACE_NAME
490 ":" BOOKMARK_PRIVATE_ELEMENT "/>\n");
492 /* close metadata container */
493 g_string_append (retval,
495 "</" XBEL_METADATA_ELEMENT ">\n");
497 return g_string_free (retval, FALSE);
500 /******************************************************
503 * Storage for a single bookmark item inside the list *
504 ******************************************************/
505 static BookmarkItem *
506 bookmark_item_new (const gchar *uri)
510 g_warn_if_fail (uri != NULL);
512 item = g_slice_new (BookmarkItem);
513 item->uri = g_strdup (uri);
516 item->description = NULL;
518 item->added = (time_t) -1;
519 item->modified = (time_t) -1;
520 item->visited = (time_t) -1;
522 item->metadata = NULL;
528 bookmark_item_free (BookmarkItem *item)
534 g_free (item->title);
535 g_free (item->description);
538 bookmark_metadata_free (item->metadata);
540 g_slice_free (BookmarkItem, item);
544 bookmark_item_dump (BookmarkItem *item)
547 gchar *added, *visited, *modified;
551 /* at this point, we must have at least a registered application; if we don't
552 * we don't screw up the bookmark file, and just skip this item
554 if (!item->metadata || !item->metadata->applications)
556 g_warning ("Item for URI '%s' has no registered applications: skipping.\n", item->uri);
560 retval = g_string_sized_new (4096);
562 added = timestamp_to_iso8601 (item->added);
563 modified = timestamp_to_iso8601 (item->modified);
564 visited = timestamp_to_iso8601 (item->visited);
566 escaped_uri = g_markup_escape_text (item->uri, -1);
568 buffer = g_strconcat (" <"
569 XBEL_BOOKMARK_ELEMENT
571 XBEL_HREF_ATTRIBUTE "=\"", escaped_uri, "\" "
572 XBEL_ADDED_ATTRIBUTE "=\"", added, "\" "
573 XBEL_MODIFIED_ATTRIBUTE "=\"", modified, "\" "
574 XBEL_VISITED_ATTRIBUTE "=\"", visited, "\">\n",
577 g_string_append (retval, buffer);
579 g_free (escaped_uri);
587 gchar *escaped_title;
589 escaped_title = g_markup_escape_text (item->title, -1);
590 buffer = g_strconcat (" "
591 "<" XBEL_TITLE_ELEMENT ">",
593 "</" XBEL_TITLE_ELEMENT ">\n",
595 g_string_append (retval, buffer);
597 g_free (escaped_title);
601 if (item->description)
605 escaped_desc = g_markup_escape_text (item->description, -1);
606 buffer = g_strconcat (" "
607 "<" XBEL_DESC_ELEMENT ">",
609 "</" XBEL_DESC_ELEMENT ">\n",
611 g_string_append (retval, buffer);
613 g_free (escaped_desc);
621 metadata = bookmark_metadata_dump (item->metadata);
624 buffer = g_strconcat (" "
625 "<" XBEL_INFO_ELEMENT ">\n",
628 "</" XBEL_INFO_ELEMENT ">\n",
630 retval = g_string_append (retval, buffer);
637 g_string_append (retval, " </" XBEL_BOOKMARK_ELEMENT ">\n");
639 return g_string_free (retval, FALSE);
642 static BookmarkAppInfo *
643 bookmark_item_lookup_app_info (BookmarkItem *item,
644 const gchar *app_name)
646 g_warn_if_fail (item != NULL && app_name != NULL);
651 return g_hash_table_lookup (item->metadata->apps_by_name, app_name);
654 /*************************
656 *************************/
659 g_bookmark_file_init (GBookmarkFile *bookmark)
661 bookmark->title = NULL;
662 bookmark->description = NULL;
664 bookmark->items = NULL;
665 bookmark->items_by_uri = g_hash_table_new_full (g_str_hash,
672 g_bookmark_file_clear (GBookmarkFile *bookmark)
674 g_free (bookmark->title);
675 g_free (bookmark->description);
677 g_list_free_full (bookmark->items, (GDestroyNotify) bookmark_item_free);
678 bookmark->items = NULL;
680 if (bookmark->items_by_uri)
682 g_hash_table_destroy (bookmark->items_by_uri);
684 bookmark->items_by_uri = NULL;
692 GHashTable *namespaces;
694 GBookmarkFile *bookmark_file;
695 BookmarkItem *current_item;
699 parse_data_new (void)
703 retval = g_new (ParseData, 1);
705 retval->state = STATE_STARTED;
706 retval->namespaces = g_hash_table_new_full (g_str_hash, g_str_equal,
707 (GDestroyNotify) g_free,
708 (GDestroyNotify) g_free);
709 retval->bookmark_file = NULL;
710 retval->current_item = NULL;
716 parse_data_free (ParseData *parse_data)
718 g_hash_table_destroy (parse_data->namespaces);
723 #define IS_ATTRIBUTE(s,a) ((0 == strcmp ((s), (a))))
726 parse_bookmark_element (GMarkupParseContext *context,
727 ParseData *parse_data,
728 const gchar **attribute_names,
729 const gchar **attribute_values,
732 const gchar *uri, *added, *modified, *visited;
738 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_BOOKMARK));
741 uri = added = modified = visited = NULL;
742 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
744 if (IS_ATTRIBUTE (attr, XBEL_HREF_ATTRIBUTE))
745 uri = attribute_values[i];
746 else if (IS_ATTRIBUTE (attr, XBEL_ADDED_ATTRIBUTE))
747 added = attribute_values[i];
748 else if (IS_ATTRIBUTE (attr, XBEL_MODIFIED_ATTRIBUTE))
749 modified = attribute_values[i];
750 else if (IS_ATTRIBUTE (attr, XBEL_VISITED_ATTRIBUTE))
751 visited = attribute_values[i];
754 /* bookmark is defined by the XBEL spec, so we need
755 * to error out if the element has different or
758 g_set_error (error, G_MARKUP_ERROR,
759 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
760 _("Unexpected attribute '%s' for element '%s'"),
762 XBEL_BOOKMARK_ELEMENT);
769 g_set_error (error, G_MARKUP_ERROR,
770 G_MARKUP_ERROR_INVALID_CONTENT,
771 _("Attribute '%s' of element '%s' not found"),
773 XBEL_BOOKMARK_ELEMENT);
777 g_warn_if_fail (parse_data->current_item == NULL);
779 item = bookmark_item_new (uri);
782 item->added = timestamp_from_iso8601 (added);
785 item->modified = timestamp_from_iso8601 (modified);
788 item->visited = timestamp_from_iso8601 (visited);
791 g_bookmark_file_add_item (parse_data->bookmark_file,
796 bookmark_item_free (item);
798 g_propagate_error (error, add_error);
803 parse_data->current_item = item;
807 parse_application_element (GMarkupParseContext *context,
808 ParseData *parse_data,
809 const gchar **attribute_names,
810 const gchar **attribute_values,
813 const gchar *name, *exec, *count, *stamp, *modified;
819 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_APPLICATION));
822 name = exec = count = stamp = modified = NULL;
823 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
825 if (IS_ATTRIBUTE (attr, BOOKMARK_NAME_ATTRIBUTE))
826 name = attribute_values[i];
827 else if (IS_ATTRIBUTE (attr, BOOKMARK_EXEC_ATTRIBUTE))
828 exec = attribute_values[i];
829 else if (IS_ATTRIBUTE (attr, BOOKMARK_COUNT_ATTRIBUTE))
830 count = attribute_values[i];
831 else if (IS_ATTRIBUTE (attr, BOOKMARK_TIMESTAMP_ATTRIBUTE))
832 stamp = attribute_values[i];
833 else if (IS_ATTRIBUTE (attr, BOOKMARK_MODIFIED_ATTRIBUTE))
834 modified = attribute_values[i];
837 /* the "name" and "exec" attributes are mandatory */
840 g_set_error (error, G_MARKUP_ERROR,
841 G_MARKUP_ERROR_INVALID_CONTENT,
842 _("Attribute '%s' of element '%s' not found"),
843 BOOKMARK_NAME_ATTRIBUTE,
844 BOOKMARK_APPLICATION_ELEMENT);
850 g_set_error (error, G_MARKUP_ERROR,
851 G_MARKUP_ERROR_INVALID_CONTENT,
852 _("Attribute '%s' of element '%s' not found"),
853 BOOKMARK_EXEC_ATTRIBUTE,
854 BOOKMARK_APPLICATION_ELEMENT);
858 g_warn_if_fail (parse_data->current_item != NULL);
859 item = parse_data->current_item;
861 ai = bookmark_item_lookup_app_info (item, name);
864 ai = bookmark_app_info_new (name);
867 item->metadata = bookmark_metadata_new ();
869 item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
870 g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
873 ai->exec = g_strdup (exec);
876 ai->count = atoi (count);
881 ai->stamp = timestamp_from_iso8601 (modified);
884 /* the timestamp attribute has been deprecated but we still parse
885 * it for backward compatibility
888 ai->stamp = (time_t) atol (stamp);
890 ai->stamp = time (NULL);
895 parse_mime_type_element (GMarkupParseContext *context,
896 ParseData *parse_data,
897 const gchar **attribute_names,
898 const gchar **attribute_values,
906 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_MIME));
910 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
912 if (IS_ATTRIBUTE (attr, MIME_TYPE_ATTRIBUTE))
913 type = attribute_values[i];
917 type = "application/octet-stream";
919 g_warn_if_fail (parse_data->current_item != NULL);
920 item = parse_data->current_item;
923 item->metadata = bookmark_metadata_new ();
925 item->metadata->mime_type = g_strdup (type);
929 parse_icon_element (GMarkupParseContext *context,
930 ParseData *parse_data,
931 const gchar **attribute_names,
932 const gchar **attribute_values,
941 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_ICON));
946 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
948 if (IS_ATTRIBUTE (attr, BOOKMARK_HREF_ATTRIBUTE))
949 href = attribute_values[i];
950 else if (IS_ATTRIBUTE (attr, BOOKMARK_TYPE_ATTRIBUTE))
951 type = attribute_values[i];
954 /* the "href" attribute is mandatory */
957 g_set_error (error, G_MARKUP_ERROR,
958 G_MARKUP_ERROR_INVALID_CONTENT,
959 _("Attribute '%s' of element '%s' not found"),
960 BOOKMARK_HREF_ATTRIBUTE,
961 BOOKMARK_ICON_ELEMENT);
966 type = "application/octet-stream";
968 g_warn_if_fail (parse_data->current_item != NULL);
969 item = parse_data->current_item;
972 item->metadata = bookmark_metadata_new ();
974 item->metadata->icon_href = g_strdup (href);
975 item->metadata->icon_mime = g_strdup (type);
978 /* scans through the attributes of an element for the "xmlns" pragma, and
979 * adds any resulting namespace declaration to a per-parser hashtable, using
980 * the namespace name as a key for the namespace URI; if no key was found,
981 * the namespace is considered as default, and stored under the "default" key.
983 * FIXME: this works on the assumption that the generator of the XBEL file
984 * is either this code or is smart enough to place the namespace declarations
985 * inside the main root node or inside the metadata node and does not redefine
986 * a namespace inside an inner node; this does *not* conform to the
987 * XML-NS standard, although is a close approximation. In order to make this
988 * conformant to the XML-NS specification we should use a per-element
989 * namespace table inside GMarkup and ask it to resolve the namespaces for us.
992 map_namespace_to_name (ParseData *parse_data,
993 const gchar **attribute_names,
994 const gchar **attribute_values)
999 g_warn_if_fail (parse_data != NULL);
1001 if (!attribute_names || !attribute_names[0])
1005 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1007 if (g_str_has_prefix (attr, "xmlns"))
1009 gchar *namespace_name, *namespace_uri;
1012 p = g_utf8_strchr (attr, -1, ':');
1014 p = g_utf8_next_char (p);
1018 namespace_name = g_strdup (p);
1019 namespace_uri = g_strdup (attribute_values[i]);
1021 g_hash_table_replace (parse_data->namespaces,
1028 /* checks whether @element_full is equal to @element.
1030 * if @namespace is set, it tries to resolve the namespace to a known URI,
1031 * and if found is prepended to the element name, from which is separated
1032 * using the character specified in the @sep parameter.
1035 is_element_full (ParseData *parse_data,
1036 const gchar *element_full,
1037 const gchar *namespace,
1038 const gchar *element,
1041 gchar *ns_uri, *ns_name;
1042 const gchar *p, *element_name;
1045 g_warn_if_fail (parse_data != NULL);
1046 g_warn_if_fail (element_full != NULL);
1051 /* no namespace requested: dumb element compare */
1053 return (0 == strcmp (element_full, element));
1055 /* search for namespace separator; if none found, assume we are under the
1056 * default namespace, and set ns_name to our "default" marker; if no default
1057 * namespace has been set, just do a plain comparison between @full_element
1060 p = g_utf8_strchr (element_full, -1, ':');
1063 ns_name = g_strndup (element_full, p - element_full);
1064 element_name = g_utf8_next_char (p);
1068 ns_name = g_strdup ("default");
1069 element_name = element_full;
1072 ns_uri = g_hash_table_lookup (parse_data->namespaces, ns_name);
1075 /* no default namespace found */
1078 return (0 == strcmp (element_full, element));
1081 retval = (0 == strcmp (ns_uri, namespace) &&
1082 0 == strcmp (element_name, element));
1089 #define IS_ELEMENT(p,s,e) (is_element_full ((p), (s), NULL, (e), '\0'))
1090 #define IS_ELEMENT_NS(p,s,n,e) (is_element_full ((p), (s), (n), (e), '|'))
1093 start_element_raw_cb (GMarkupParseContext *context,
1094 const gchar *element_name,
1095 const gchar **attribute_names,
1096 const gchar **attribute_values,
1100 ParseData *parse_data = (ParseData *) user_data;
1102 /* we must check for namespace declarations first
1104 * XXX - we could speed up things by checking for namespace declarations
1105 * only on the root node, where they usually are; this would probably break
1106 * on streams not produced by us or by "smart" generators
1108 map_namespace_to_name (parse_data, attribute_names, attribute_values);
1110 switch (parse_data->state)
1113 if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1119 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1121 if ((IS_ATTRIBUTE (attr, XBEL_VERSION_ATTRIBUTE)) &&
1122 (0 == strcmp (attribute_values[i], XBEL_VERSION)))
1123 parse_data->state = STATE_ROOT;
1127 g_set_error (error, G_MARKUP_ERROR,
1128 G_MARKUP_ERROR_INVALID_CONTENT,
1129 _("Unexpected tag '%s', tag '%s' expected"),
1130 element_name, XBEL_ROOT_ELEMENT);
1133 if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1134 parse_data->state = STATE_TITLE;
1135 else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1136 parse_data->state = STATE_DESC;
1137 else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1139 GError *inner_error = NULL;
1141 parse_data->state = STATE_BOOKMARK;
1143 parse_bookmark_element (context,
1149 g_propagate_error (error, inner_error);
1152 g_set_error (error, G_MARKUP_ERROR,
1153 G_MARKUP_ERROR_INVALID_CONTENT,
1154 _("Unexpected tag '%s' inside '%s'"),
1158 case STATE_BOOKMARK:
1159 if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1160 parse_data->state = STATE_TITLE;
1161 else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1162 parse_data->state = STATE_DESC;
1163 else if (IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT))
1164 parse_data->state = STATE_INFO;
1166 g_set_error (error, G_MARKUP_ERROR,
1167 G_MARKUP_ERROR_INVALID_CONTENT,
1168 _("Unexpected tag '%s' inside '%s'"),
1170 XBEL_BOOKMARK_ELEMENT);
1173 if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1179 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1181 if ((IS_ATTRIBUTE (attr, XBEL_OWNER_ATTRIBUTE)) &&
1182 (0 == strcmp (attribute_values[i], BOOKMARK_METADATA_OWNER)))
1184 parse_data->state = STATE_METADATA;
1186 if (!parse_data->current_item->metadata)
1187 parse_data->current_item->metadata = bookmark_metadata_new ();
1192 g_set_error (error, G_MARKUP_ERROR,
1193 G_MARKUP_ERROR_INVALID_CONTENT,
1194 _("Unexpected tag '%s', tag '%s' expected"),
1196 XBEL_METADATA_ELEMENT);
1198 case STATE_METADATA:
1199 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT))
1200 parse_data->state = STATE_APPLICATIONS;
1201 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT))
1202 parse_data->state = STATE_GROUPS;
1203 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT))
1204 parse_data->current_item->metadata->is_private = TRUE;
1205 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1207 GError *inner_error = NULL;
1209 parse_data->state = STATE_ICON;
1211 parse_icon_element (context,
1217 g_propagate_error (error, inner_error);
1219 else if (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT))
1221 GError *inner_error = NULL;
1223 parse_data->state = STATE_MIME;
1225 parse_mime_type_element (context,
1231 g_propagate_error (error, inner_error);
1234 g_set_error (error, G_MARKUP_ERROR,
1235 G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1236 _("Unexpected tag '%s' inside '%s'"),
1238 XBEL_METADATA_ELEMENT);
1240 case STATE_APPLICATIONS:
1241 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATION_ELEMENT))
1243 GError *inner_error = NULL;
1245 parse_data->state = STATE_APPLICATION;
1247 parse_application_element (context,
1253 g_propagate_error (error, inner_error);
1256 g_set_error (error, G_MARKUP_ERROR,
1257 G_MARKUP_ERROR_INVALID_CONTENT,
1258 _("Unexpected tag '%s', tag '%s' expected"),
1260 BOOKMARK_APPLICATION_ELEMENT);
1263 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUP_ELEMENT))
1264 parse_data->state = STATE_GROUP;
1266 g_set_error (error, G_MARKUP_ERROR,
1267 G_MARKUP_ERROR_INVALID_CONTENT,
1268 _("Unexpected tag '%s', tag '%s' expected"),
1270 BOOKMARK_GROUP_ELEMENT);
1273 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1275 GError *inner_error = NULL;
1277 parse_icon_element (context,
1283 g_propagate_error (error, inner_error);
1286 g_set_error (error, G_MARKUP_ERROR,
1287 G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1288 _("Unexpected tag '%s' inside '%s'"),
1290 XBEL_METADATA_ELEMENT);
1293 g_warn_if_reached ();
1299 end_element_raw_cb (GMarkupParseContext *context,
1300 const gchar *element_name,
1304 ParseData *parse_data = (ParseData *) user_data;
1306 if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1307 parse_data->state = STATE_FINISHED;
1308 else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1310 parse_data->current_item = NULL;
1312 parse_data->state = STATE_ROOT;
1314 else if ((IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT)) ||
1315 (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) ||
1316 (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT)))
1318 if (parse_data->current_item)
1319 parse_data->state = STATE_BOOKMARK;
1321 parse_data->state = STATE_ROOT;
1323 else if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1324 parse_data->state = STATE_INFO;
1325 else if (IS_ELEMENT_NS (parse_data, element_name,
1326 BOOKMARK_NAMESPACE_URI,
1327 BOOKMARK_APPLICATION_ELEMENT))
1328 parse_data->state = STATE_APPLICATIONS;
1329 else if (IS_ELEMENT_NS (parse_data, element_name,
1330 BOOKMARK_NAMESPACE_URI,
1331 BOOKMARK_GROUP_ELEMENT))
1332 parse_data->state = STATE_GROUPS;
1333 else if ((IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT)) ||
1334 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT)) ||
1335 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT)) ||
1336 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT)) ||
1337 (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT)))
1338 parse_data->state = STATE_METADATA;
1342 text_raw_cb (GMarkupParseContext *context,
1348 ParseData *parse_data = (ParseData *) user_data;
1351 payload = g_strndup (text, length);
1353 switch (parse_data->state)
1356 if (parse_data->current_item)
1358 g_free (parse_data->current_item->title);
1359 parse_data->current_item->title = g_strdup (payload);
1363 g_free (parse_data->bookmark_file->title);
1364 parse_data->bookmark_file->title = g_strdup (payload);
1368 if (parse_data->current_item)
1370 g_free (parse_data->current_item->description);
1371 parse_data->current_item->description = g_strdup (payload);
1375 g_free (parse_data->bookmark_file->description);
1376 parse_data->bookmark_file->description = g_strdup (payload);
1383 g_warn_if_fail (parse_data->current_item != NULL);
1385 if (!parse_data->current_item->metadata)
1386 parse_data->current_item->metadata = bookmark_metadata_new ();
1388 groups = parse_data->current_item->metadata->groups;
1389 parse_data->current_item->metadata->groups = g_list_prepend (groups, g_strdup (payload));
1393 case STATE_BOOKMARK:
1395 case STATE_METADATA:
1396 case STATE_APPLICATIONS:
1397 case STATE_APPLICATION:
1403 g_warn_if_reached ();
1410 static const GMarkupParser markup_parser =
1412 start_element_raw_cb, /* start_element */
1413 end_element_raw_cb, /* end_element */
1414 text_raw_cb, /* text */
1415 NULL, /* passthrough */
1420 g_bookmark_file_parse (GBookmarkFile *bookmark,
1421 const gchar *buffer,
1425 GMarkupParseContext *context;
1426 ParseData *parse_data;
1427 GError *parse_error, *end_error;
1430 g_warn_if_fail (bookmark != NULL);
1438 if (length == (gsize) -1)
1439 length = strlen (buffer);
1441 parse_data = parse_data_new ();
1442 parse_data->bookmark_file = bookmark;
1444 context = g_markup_parse_context_new (&markup_parser,
1447 (GDestroyNotify) parse_data_free);
1449 retval = g_markup_parse_context_parse (context,
1454 g_propagate_error (error, parse_error);
1457 retval = g_markup_parse_context_end_parse (context, &end_error);
1459 g_propagate_error (error, end_error);
1462 g_markup_parse_context_free (context);
1468 g_bookmark_file_dump (GBookmarkFile *bookmark,
1476 retval = g_string_sized_new (4096);
1478 g_string_append (retval,
1479 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1481 /* XXX - do we really need the doctype? */
1482 "<!DOCTYPE " XBEL_DTD_NICK "\n"
1483 " PUBLIC \"" XBEL_DTD_SYSTEM "\"\n"
1484 " \"" XBEL_DTD_URI "\">\n"
1486 "<" XBEL_ROOT_ELEMENT " " XBEL_VERSION_ATTRIBUTE "=\"" XBEL_VERSION "\"\n"
1487 " xmlns:" BOOKMARK_NAMESPACE_NAME "=\"" BOOKMARK_NAMESPACE_URI "\"\n"
1488 " xmlns:" MIME_NAMESPACE_NAME "=\"" MIME_NAMESPACE_URI "\"\n>");
1490 if (bookmark->title)
1492 gchar *escaped_title;
1494 escaped_title = g_markup_escape_text (bookmark->title, -1);
1496 buffer = g_strconcat (" "
1497 "<" XBEL_TITLE_ELEMENT ">",
1499 "</" XBEL_TITLE_ELEMENT ">\n", NULL);
1501 g_string_append (retval, buffer);
1504 g_free (escaped_title);
1507 if (bookmark->description)
1509 gchar *escaped_desc;
1511 escaped_desc = g_markup_escape_text (bookmark->description, -1);
1513 buffer = g_strconcat (" "
1514 "<" XBEL_DESC_ELEMENT ">",
1516 "</" XBEL_DESC_ELEMENT ">\n", NULL);
1517 g_string_append (retval, buffer);
1520 g_free (escaped_desc);
1523 if (!bookmark->items)
1526 retval = g_string_append (retval, "\n");
1528 /* the items are stored in reverse order */
1529 for (l = g_list_last (bookmark->items);
1533 BookmarkItem *item = (BookmarkItem *) l->data;
1536 item_dump = bookmark_item_dump (item);
1540 retval = g_string_append (retval, item_dump);
1546 g_string_append (retval, "</" XBEL_ROOT_ELEMENT ">");
1549 *length = retval->len;
1551 return g_string_free (retval, FALSE);
1558 /* converts a Unix timestamp in a ISO 8601 compliant string; you
1559 * should free the returned string.
1562 timestamp_to_iso8601 (time_t timestamp)
1566 if (timestamp == (time_t) -1)
1567 g_get_current_time (&stamp);
1570 stamp.tv_sec = timestamp;
1574 return g_time_val_to_iso8601 (&stamp);
1578 timestamp_from_iso8601 (const gchar *iso_date)
1582 if (!g_time_val_from_iso8601 (iso_date, &stamp))
1585 return (time_t) stamp.tv_sec;
1588 G_DEFINE_QUARK (g-bookmark-file-error-quark, g_bookmark_file_error)
1590 /********************
1592 ********************/
1595 * g_bookmark_file_new:
1597 * Creates a new empty #GBookmarkFile object.
1599 * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
1600 * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
1603 * Return value: an empty #GBookmarkFile
1608 g_bookmark_file_new (void)
1610 GBookmarkFile *bookmark;
1612 bookmark = g_new (GBookmarkFile, 1);
1614 g_bookmark_file_init (bookmark);
1620 * g_bookmark_file_free:
1621 * @bookmark: a #GBookmarkFile
1623 * Frees a #GBookmarkFile.
1628 g_bookmark_file_free (GBookmarkFile *bookmark)
1633 g_bookmark_file_clear (bookmark);
1639 * g_bookmark_file_load_from_data:
1640 * @bookmark: an empty #GBookmarkFile struct
1641 * @data: desktop bookmarks loaded in memory
1642 * @length: the length of @data in bytes
1643 * @error: return location for a #GError, or %NULL
1645 * Loads a bookmark file from memory into an empty #GBookmarkFile
1646 * structure. If the object cannot be created then @error is set to a
1647 * #GBookmarkFileError.
1649 * Return value: %TRUE if a desktop bookmark could be loaded.
1654 g_bookmark_file_load_from_data (GBookmarkFile *bookmark,
1659 GError *parse_error;
1662 g_return_val_if_fail (bookmark != NULL, FALSE);
1664 if (length == (gsize) -1)
1665 length = strlen (data);
1667 if (bookmark->items)
1669 g_bookmark_file_clear (bookmark);
1670 g_bookmark_file_init (bookmark);
1674 retval = g_bookmark_file_parse (bookmark, data, length, &parse_error);
1677 g_propagate_error (error, parse_error);
1683 * g_bookmark_file_load_from_file:
1684 * @bookmark: an empty #GBookmarkFile struct
1685 * @filename: the path of a filename to load, in the GLib file name encoding
1686 * @error: return location for a #GError, or %NULL
1688 * Loads a desktop bookmark file into an empty #GBookmarkFile structure.
1689 * If the file could not be loaded then @error is set to either a #GFileError
1690 * or #GBookmarkFileError.
1692 * Return value: %TRUE if a desktop bookmark file could be loaded
1697 g_bookmark_file_load_from_file (GBookmarkFile *bookmark,
1698 const gchar *filename,
1706 g_return_val_if_fail (bookmark != NULL, FALSE);
1707 g_return_val_if_fail (filename != NULL, FALSE);
1710 g_file_get_contents (filename, &buffer, &len, &read_error);
1713 g_propagate_error (error, read_error);
1719 retval = g_bookmark_file_load_from_data (bookmark,
1725 g_propagate_error (error, read_error);
1738 /* Iterates through all the directories in *dirs trying to
1739 * find file. When it successfully locates file, returns a
1740 * string its absolute path. It also leaves the unchecked
1741 * directories in *dirs. You should free the returned string
1743 * Adapted from gkeyfile.c
1746 find_file_in_data_dirs (const gchar *file,
1750 gchar **data_dirs, *data_dir, *path;
1759 while (data_dirs && (data_dir = *data_dirs) && !path)
1761 gchar *candidate_file, *sub_dir;
1763 candidate_file = (gchar *) file;
1764 sub_dir = g_strdup ("");
1765 while (candidate_file != NULL && !path)
1769 path = g_build_filename (data_dir, sub_dir,
1770 candidate_file, NULL);
1772 candidate_file = strchr (candidate_file, '-');
1774 if (candidate_file == NULL)
1780 sub_dir = g_strndup (file, candidate_file - file - 1);
1782 for (p = sub_dir; *p != '\0'; p++)
1785 *p = G_DIR_SEPARATOR;
1796 g_set_error_literal (error, G_BOOKMARK_FILE_ERROR,
1797 G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND,
1798 _("No valid bookmark file found in data dirs"));
1808 * g_bookmark_file_load_from_data_dirs:
1809 * @bookmark: a #GBookmarkFile
1810 * @file: a relative path to a filename to open and parse
1811 * @full_path: (allow-none): return location for a string containing the full path
1812 * of the file, or %NULL
1813 * @error: return location for a #GError, or %NULL
1815 * This function looks for a desktop bookmark file named @file in the
1816 * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
1817 * loads the file into @bookmark and returns the file's full path in
1818 * @full_path. If the file could not be loaded then an %error is
1819 * set to either a #GFileError or #GBookmarkFileError.
1821 * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
1826 g_bookmark_file_load_from_data_dirs (GBookmarkFile *bookmark,
1831 GError *file_error = NULL;
1832 gchar **all_data_dirs, **data_dirs;
1833 const gchar *user_data_dir;
1834 const gchar * const * system_data_dirs;
1837 gboolean found_file;
1839 g_return_val_if_fail (bookmark != NULL, FALSE);
1840 g_return_val_if_fail (!g_path_is_absolute (file), FALSE);
1842 user_data_dir = g_get_user_data_dir ();
1843 system_data_dirs = g_get_system_data_dirs ();
1844 all_data_dirs = g_new0 (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2);
1847 all_data_dirs[i++] = g_strdup (user_data_dir);
1850 while (system_data_dirs[j] != NULL)
1851 all_data_dirs[i++] = g_strdup (system_data_dirs[j++]);
1854 data_dirs = all_data_dirs;
1856 while (*data_dirs != NULL && !found_file)
1858 g_free (output_path);
1860 output_path = find_file_in_data_dirs (file, &data_dirs, &file_error);
1864 g_propagate_error (error, file_error);
1868 found_file = g_bookmark_file_load_from_file (bookmark,
1873 g_propagate_error (error, file_error);
1878 if (found_file && full_path)
1879 *full_path = output_path;
1881 g_free (output_path);
1883 g_strfreev (all_data_dirs);
1890 * g_bookmark_file_to_data:
1891 * @bookmark: a #GBookmarkFile
1892 * @length: (allow-none): return location for the length of the returned string, or %NULL
1893 * @error: return location for a #GError, or %NULL
1895 * This function outputs @bookmark as a string.
1897 * Return value: a newly allocated string holding
1898 * the contents of the #GBookmarkFile
1903 g_bookmark_file_to_data (GBookmarkFile *bookmark,
1907 GError *write_error = NULL;
1910 g_return_val_if_fail (bookmark != NULL, NULL);
1912 retval = g_bookmark_file_dump (bookmark, length, &write_error);
1915 g_propagate_error (error, write_error);
1924 * g_bookmark_file_to_file:
1925 * @bookmark: a #GBookmarkFile
1926 * @filename: path of the output file
1927 * @error: return location for a #GError, or %NULL
1929 * This function outputs @bookmark into a file. The write process is
1930 * guaranteed to be atomic by using g_file_set_contents() internally.
1932 * Return value: %TRUE if the file was successfully written.
1937 g_bookmark_file_to_file (GBookmarkFile *bookmark,
1938 const gchar *filename,
1942 GError *data_error, *write_error;
1946 g_return_val_if_fail (bookmark != NULL, FALSE);
1947 g_return_val_if_fail (filename != NULL, FALSE);
1950 data = g_bookmark_file_to_data (bookmark, &len, &data_error);
1953 g_propagate_error (error, data_error);
1959 g_file_set_contents (filename, data, len, &write_error);
1962 g_propagate_error (error, write_error);
1974 static BookmarkItem *
1975 g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
1978 g_warn_if_fail (bookmark != NULL && uri != NULL);
1980 return g_hash_table_lookup (bookmark->items_by_uri, uri);
1983 /* this function adds a new item to the list */
1985 g_bookmark_file_add_item (GBookmarkFile *bookmark,
1989 g_warn_if_fail (bookmark != NULL);
1990 g_warn_if_fail (item != NULL);
1992 /* this should never happen; and if it does, then we are
1993 * screwing up something big time.
1995 if (G_UNLIKELY (g_bookmark_file_has_item (bookmark, item->uri)))
1997 g_set_error (error, G_BOOKMARK_FILE_ERROR,
1998 G_BOOKMARK_FILE_ERROR_INVALID_URI,
1999 _("A bookmark for URI '%s' already exists"),
2004 bookmark->items = g_list_prepend (bookmark->items, item);
2006 g_hash_table_replace (bookmark->items_by_uri,
2010 if (item->added == (time_t) -1)
2011 item->added = time (NULL);
2013 if (item->modified == (time_t) -1)
2014 item->modified = time (NULL);
2018 * g_bookmark_file_remove_item:
2019 * @bookmark: a #GBookmarkFile
2021 * @error: return location for a #GError, or %NULL
2023 * Removes the bookmark for @uri from the bookmark file @bookmark.
2025 * Return value: %TRUE if the bookmark was removed successfully.
2030 g_bookmark_file_remove_item (GBookmarkFile *bookmark,
2036 g_return_val_if_fail (bookmark != NULL, FALSE);
2037 g_return_val_if_fail (uri != NULL, FALSE);
2039 item = g_bookmark_file_lookup_item (bookmark, uri);
2043 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2044 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2045 _("No bookmark found for URI '%s'"),
2050 bookmark->items = g_list_remove (bookmark->items, item);
2051 g_hash_table_remove (bookmark->items_by_uri, item->uri);
2053 bookmark_item_free (item);
2059 * g_bookmark_file_has_item:
2060 * @bookmark: a #GBookmarkFile
2063 * Looks whether the desktop bookmark has an item with its URI set to @uri.
2065 * Return value: %TRUE if @uri is inside @bookmark, %FALSE otherwise
2070 g_bookmark_file_has_item (GBookmarkFile *bookmark,
2073 g_return_val_if_fail (bookmark != NULL, FALSE);
2074 g_return_val_if_fail (uri != NULL, FALSE);
2076 return (NULL != g_hash_table_lookup (bookmark->items_by_uri, uri));
2080 * g_bookmark_file_get_uris:
2081 * @bookmark: a #GBookmarkFile
2082 * @length: (allow-none): return location for the number of returned URIs, or %NULL
2084 * Returns all URIs of the bookmarks in the bookmark file @bookmark.
2085 * The array of returned URIs will be %NULL-terminated, so @length may
2086 * optionally be %NULL.
2088 * Return value: a newly allocated %NULL-terminated array of strings.
2089 * Use g_strfreev() to free it.
2094 g_bookmark_file_get_uris (GBookmarkFile *bookmark,
2101 g_return_val_if_fail (bookmark != NULL, NULL);
2103 n_items = g_list_length (bookmark->items);
2104 uris = g_new0 (gchar *, n_items + 1);
2106 /* the items are stored in reverse order, so we walk the list backward */
2107 for (l = g_list_last (bookmark->items), i = 0; l != NULL; l = l->prev)
2109 BookmarkItem *item = (BookmarkItem *) l->data;
2111 g_warn_if_fail (item != NULL);
2113 uris[i++] = g_strdup (item->uri);
2124 * g_bookmark_file_set_title:
2125 * @bookmark: a #GBookmarkFile
2126 * @uri: (allow-none): a valid URI or %NULL
2127 * @title: a UTF-8 encoded string
2129 * Sets @title as the title of the bookmark for @uri inside the
2130 * bookmark file @bookmark.
2132 * If @uri is %NULL, the title of @bookmark is set.
2134 * If a bookmark for @uri cannot be found then it is created.
2139 g_bookmark_file_set_title (GBookmarkFile *bookmark,
2143 g_return_if_fail (bookmark != NULL);
2147 g_free (bookmark->title);
2148 bookmark->title = g_strdup (title);
2154 item = g_bookmark_file_lookup_item (bookmark, uri);
2157 item = bookmark_item_new (uri);
2158 g_bookmark_file_add_item (bookmark, item, NULL);
2161 g_free (item->title);
2162 item->title = g_strdup (title);
2164 item->modified = time (NULL);
2169 * g_bookmark_file_get_title:
2170 * @bookmark: a #GBookmarkFile
2171 * @uri: (allow-none): a valid URI or %NULL
2172 * @error: return location for a #GError, or %NULL
2174 * Returns the title of the bookmark for @uri.
2176 * If @uri is %NULL, the title of @bookmark is returned.
2178 * In the event the URI cannot be found, %NULL is returned and
2179 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2181 * Return value: a newly allocated string or %NULL if the specified
2182 * URI cannot be found.
2187 g_bookmark_file_get_title (GBookmarkFile *bookmark,
2193 g_return_val_if_fail (bookmark != NULL, NULL);
2196 return g_strdup (bookmark->title);
2198 item = g_bookmark_file_lookup_item (bookmark, uri);
2201 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2202 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2203 _("No bookmark found for URI '%s'"),
2208 return g_strdup (item->title);
2212 * g_bookmark_file_set_description:
2213 * @bookmark: a #GBookmarkFile
2214 * @uri: (allow-none): a valid URI or %NULL
2215 * @description: a string
2217 * Sets @description as the description of the bookmark for @uri.
2219 * If @uri is %NULL, the description of @bookmark is set.
2221 * If a bookmark for @uri cannot be found then it is created.
2226 g_bookmark_file_set_description (GBookmarkFile *bookmark,
2228 const gchar *description)
2230 g_return_if_fail (bookmark != NULL);
2234 g_free (bookmark->description);
2235 bookmark->description = g_strdup (description);
2241 item = g_bookmark_file_lookup_item (bookmark, uri);
2244 item = bookmark_item_new (uri);
2245 g_bookmark_file_add_item (bookmark, item, NULL);
2248 g_free (item->description);
2249 item->description = g_strdup (description);
2251 item->modified = time (NULL);
2256 * g_bookmark_file_get_description:
2257 * @bookmark: a #GBookmarkFile
2259 * @error: return location for a #GError, or %NULL
2261 * Retrieves the description of the bookmark for @uri.
2263 * In the event the URI cannot be found, %NULL is returned and
2264 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2266 * Return value: a newly allocated string or %NULL if the specified
2267 * URI cannot be found.
2272 g_bookmark_file_get_description (GBookmarkFile *bookmark,
2278 g_return_val_if_fail (bookmark != NULL, NULL);
2281 return g_strdup (bookmark->description);
2283 item = g_bookmark_file_lookup_item (bookmark, uri);
2286 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2287 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2288 _("No bookmark found for URI '%s'"),
2293 return g_strdup (item->description);
2297 * g_bookmark_file_set_mime_type:
2298 * @bookmark: a #GBookmarkFile
2300 * @mime_type: a MIME type
2302 * Sets @mime_type as the MIME type of the bookmark for @uri.
2304 * If a bookmark for @uri cannot be found then it is created.
2309 g_bookmark_file_set_mime_type (GBookmarkFile *bookmark,
2311 const gchar *mime_type)
2315 g_return_if_fail (bookmark != NULL);
2316 g_return_if_fail (uri != NULL);
2317 g_return_if_fail (mime_type != NULL);
2319 item = g_bookmark_file_lookup_item (bookmark, uri);
2322 item = bookmark_item_new (uri);
2323 g_bookmark_file_add_item (bookmark, item, NULL);
2326 if (!item->metadata)
2327 item->metadata = bookmark_metadata_new ();
2329 g_free (item->metadata->mime_type);
2331 item->metadata->mime_type = g_strdup (mime_type);
2332 item->modified = time (NULL);
2336 * g_bookmark_file_get_mime_type:
2337 * @bookmark: a #GBookmarkFile
2339 * @error: return location for a #GError, or %NULL
2341 * Retrieves the MIME type of the resource pointed by @uri.
2343 * In the event the URI cannot be found, %NULL is returned and
2344 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
2345 * event that the MIME type cannot be found, %NULL is returned and
2346 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2348 * Return value: a newly allocated string or %NULL if the specified
2349 * URI cannot be found.
2354 g_bookmark_file_get_mime_type (GBookmarkFile *bookmark,
2360 g_return_val_if_fail (bookmark != NULL, NULL);
2361 g_return_val_if_fail (uri != NULL, NULL);
2363 item = g_bookmark_file_lookup_item (bookmark, uri);
2366 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2367 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2368 _("No bookmark found for URI '%s'"),
2373 if (!item->metadata)
2375 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2376 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2377 _("No MIME type defined in the bookmark for URI '%s'"),
2382 return g_strdup (item->metadata->mime_type);
2386 * g_bookmark_file_set_is_private:
2387 * @bookmark: a #GBookmarkFile
2389 * @is_private: %TRUE if the bookmark should be marked as private
2391 * Sets the private flag of the bookmark for @uri.
2393 * If a bookmark for @uri cannot be found then it is created.
2398 g_bookmark_file_set_is_private (GBookmarkFile *bookmark,
2400 gboolean is_private)
2404 g_return_if_fail (bookmark != NULL);
2405 g_return_if_fail (uri != NULL);
2407 item = g_bookmark_file_lookup_item (bookmark, uri);
2410 item = bookmark_item_new (uri);
2411 g_bookmark_file_add_item (bookmark, item, NULL);
2414 if (!item->metadata)
2415 item->metadata = bookmark_metadata_new ();
2417 item->metadata->is_private = (is_private == TRUE);
2418 item->modified = time (NULL);
2422 * g_bookmark_file_get_is_private:
2423 * @bookmark: a #GBookmarkFile
2425 * @error: return location for a #GError, or %NULL
2427 * Gets whether the private flag of the bookmark for @uri is set.
2429 * In the event the URI cannot be found, %FALSE is returned and
2430 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
2431 * event that the private flag cannot be found, %FALSE is returned and
2432 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2434 * Return value: %TRUE if the private flag is set, %FALSE otherwise.
2439 g_bookmark_file_get_is_private (GBookmarkFile *bookmark,
2445 g_return_val_if_fail (bookmark != NULL, FALSE);
2446 g_return_val_if_fail (uri != NULL, FALSE);
2448 item = g_bookmark_file_lookup_item (bookmark, uri);
2451 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2452 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2453 _("No bookmark found for URI '%s'"),
2458 if (!item->metadata)
2460 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2461 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2462 _("No private flag has been defined in bookmark for URI '%s'"),
2467 return item->metadata->is_private;
2471 * g_bookmark_file_set_added:
2472 * @bookmark: a #GBookmarkFile
2474 * @added: a timestamp or -1 to use the current time
2476 * Sets the time the bookmark for @uri was added into @bookmark.
2478 * If no bookmark for @uri is found then it is created.
2483 g_bookmark_file_set_added (GBookmarkFile *bookmark,
2489 g_return_if_fail (bookmark != NULL);
2490 g_return_if_fail (uri != NULL);
2492 item = g_bookmark_file_lookup_item (bookmark, uri);
2495 item = bookmark_item_new (uri);
2496 g_bookmark_file_add_item (bookmark, item, NULL);
2499 if (added == (time_t) -1)
2502 item->added = added;
2503 item->modified = added;
2507 * g_bookmark_file_get_added:
2508 * @bookmark: a #GBookmarkFile
2510 * @error: return location for a #GError, or %NULL
2512 * Gets the time the bookmark for @uri was added to @bookmark
2514 * In the event the URI cannot be found, -1 is returned and
2515 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2517 * Return value: a timestamp
2522 g_bookmark_file_get_added (GBookmarkFile *bookmark,
2528 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2529 g_return_val_if_fail (uri != NULL, (time_t) -1);
2531 item = g_bookmark_file_lookup_item (bookmark, uri);
2534 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2535 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2536 _("No bookmark found for URI '%s'"),
2545 * g_bookmark_file_set_modified:
2546 * @bookmark: a #GBookmarkFile
2548 * @modified: a timestamp or -1 to use the current time
2550 * Sets the last time the bookmark for @uri was last modified.
2552 * If no bookmark for @uri is found then it is created.
2554 * The "modified" time should only be set when the bookmark's meta-data
2555 * was actually changed. Every function of #GBookmarkFile that
2556 * modifies a bookmark also changes the modification time, except for
2557 * g_bookmark_file_set_visited().
2562 g_bookmark_file_set_modified (GBookmarkFile *bookmark,
2568 g_return_if_fail (bookmark != NULL);
2569 g_return_if_fail (uri != NULL);
2571 item = g_bookmark_file_lookup_item (bookmark, uri);
2574 item = bookmark_item_new (uri);
2575 g_bookmark_file_add_item (bookmark, item, NULL);
2578 if (modified == (time_t) -1)
2581 item->modified = modified;
2585 * g_bookmark_file_get_modified:
2586 * @bookmark: a #GBookmarkFile
2588 * @error: return location for a #GError, or %NULL
2590 * Gets the time when the bookmark for @uri was last modified.
2592 * In the event the URI cannot be found, -1 is returned and
2593 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2595 * Return value: a timestamp
2600 g_bookmark_file_get_modified (GBookmarkFile *bookmark,
2606 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2607 g_return_val_if_fail (uri != NULL, (time_t) -1);
2609 item = g_bookmark_file_lookup_item (bookmark, uri);
2612 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2613 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2614 _("No bookmark found for URI '%s'"),
2619 return item->modified;
2623 * g_bookmark_file_set_visited:
2624 * @bookmark: a #GBookmarkFile
2626 * @visited: a timestamp or -1 to use the current time
2628 * Sets the time the bookmark for @uri was last visited.
2630 * If no bookmark for @uri is found then it is created.
2632 * The "visited" time should only be set if the bookmark was launched,
2633 * either using the command line retrieved by g_bookmark_file_get_app_info()
2634 * or by the default application for the bookmark's MIME type, retrieved
2635 * using g_bookmark_file_get_mime_type(). Changing the "visited" time
2636 * does not affect the "modified" time.
2641 g_bookmark_file_set_visited (GBookmarkFile *bookmark,
2647 g_return_if_fail (bookmark != NULL);
2648 g_return_if_fail (uri != NULL);
2650 item = g_bookmark_file_lookup_item (bookmark, uri);
2653 item = bookmark_item_new (uri);
2654 g_bookmark_file_add_item (bookmark, item, NULL);
2657 if (visited == (time_t) -1)
2660 item->visited = visited;
2664 * g_bookmark_file_get_visited:
2665 * @bookmark: a #GBookmarkFile
2667 * @error: return location for a #GError, or %NULL
2669 * Gets the time the bookmark for @uri was last visited.
2671 * In the event the URI cannot be found, -1 is returned and
2672 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2674 * Return value: a timestamp.
2679 g_bookmark_file_get_visited (GBookmarkFile *bookmark,
2685 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2686 g_return_val_if_fail (uri != NULL, (time_t) -1);
2688 item = g_bookmark_file_lookup_item (bookmark, uri);
2691 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2692 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2693 _("No bookmark found for URI '%s'"),
2698 return item->visited;
2702 * g_bookmark_file_has_group:
2703 * @bookmark: a #GBookmarkFile
2705 * @group: the group name to be searched
2706 * @error: return location for a #GError, or %NULL
2708 * Checks whether @group appears in the list of groups to which
2709 * the bookmark for @uri belongs to.
2711 * In the event the URI cannot be found, %FALSE is returned and
2712 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2714 * Return value: %TRUE if @group was found.
2719 g_bookmark_file_has_group (GBookmarkFile *bookmark,
2727 g_return_val_if_fail (bookmark != NULL, FALSE);
2728 g_return_val_if_fail (uri != NULL, FALSE);
2730 item = g_bookmark_file_lookup_item (bookmark, uri);
2733 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2734 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2735 _("No bookmark found for URI '%s'"),
2740 if (!item->metadata)
2743 for (l = item->metadata->groups; l != NULL; l = l->next)
2745 if (strcmp (l->data, group) == 0)
2754 * g_bookmark_file_add_group:
2755 * @bookmark: a #GBookmarkFile
2757 * @group: the group name to be added
2759 * Adds @group to the list of groups to which the bookmark for @uri
2762 * If no bookmark for @uri is found then it is created.
2767 g_bookmark_file_add_group (GBookmarkFile *bookmark,
2773 g_return_if_fail (bookmark != NULL);
2774 g_return_if_fail (uri != NULL);
2775 g_return_if_fail (group != NULL && group[0] != '\0');
2777 item = g_bookmark_file_lookup_item (bookmark, uri);
2780 item = bookmark_item_new (uri);
2781 g_bookmark_file_add_item (bookmark, item, NULL);
2784 if (!item->metadata)
2785 item->metadata = bookmark_metadata_new ();
2787 if (!g_bookmark_file_has_group (bookmark, uri, group, NULL))
2789 item->metadata->groups = g_list_prepend (item->metadata->groups,
2792 item->modified = time (NULL);
2797 * g_bookmark_file_remove_group:
2798 * @bookmark: a #GBookmarkFile
2800 * @group: the group name to be removed
2801 * @error: return location for a #GError, or %NULL
2803 * Removes @group from the list of groups to which the bookmark
2804 * for @uri belongs to.
2806 * In the event the URI cannot be found, %FALSE is returned and
2807 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2808 * In the event no group was defined, %FALSE is returned and
2809 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2811 * Return value: %TRUE if @group was successfully removed.
2816 g_bookmark_file_remove_group (GBookmarkFile *bookmark,
2824 g_return_val_if_fail (bookmark != NULL, FALSE);
2825 g_return_val_if_fail (uri != NULL, FALSE);
2827 item = g_bookmark_file_lookup_item (bookmark, uri);
2830 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2831 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2832 _("No bookmark found for URI '%s'"),
2837 if (!item->metadata)
2839 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2840 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2841 _("No groups set in bookmark for URI '%s'"),
2846 for (l = item->metadata->groups; l != NULL; l = l->next)
2848 if (strcmp (l->data, group) == 0)
2850 item->metadata->groups = g_list_remove_link (item->metadata->groups, l);
2854 item->modified = time (NULL);
2864 * g_bookmark_file_set_groups:
2865 * @bookmark: a #GBookmarkFile
2866 * @uri: an item's URI
2867 * @groups: (allow-none): an array of group names, or %NULL to remove all groups
2868 * @length: number of group name values in @groups
2870 * Sets a list of group names for the item with URI @uri. Each previously
2871 * set group name list is removed.
2873 * If @uri cannot be found then an item for it is created.
2878 g_bookmark_file_set_groups (GBookmarkFile *bookmark,
2880 const gchar **groups,
2886 g_return_if_fail (bookmark != NULL);
2887 g_return_if_fail (uri != NULL);
2888 g_return_if_fail (groups != NULL);
2890 item = g_bookmark_file_lookup_item (bookmark, uri);
2893 item = bookmark_item_new (uri);
2894 g_bookmark_file_add_item (bookmark, item, NULL);
2897 if (!item->metadata)
2898 item->metadata = bookmark_metadata_new ();
2900 g_list_free_full (item->metadata->groups, g_free);
2901 item->metadata->groups = NULL;
2905 for (i = 0; groups[i] != NULL && i < length; i++)
2906 item->metadata->groups = g_list_append (item->metadata->groups,
2907 g_strdup (groups[i]));
2910 item->modified = time (NULL);
2914 * g_bookmark_file_get_groups:
2915 * @bookmark: a #GBookmarkFile
2917 * @length: (allow-none): return location for the length of the returned string, or %NULL
2918 * @error: return location for a #GError, or %NULL
2920 * Retrieves the list of group names of the bookmark for @uri.
2922 * In the event the URI cannot be found, %NULL is returned and
2923 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2925 * The returned array is %NULL terminated, so @length may optionally
2928 * Return value: a newly allocated %NULL-terminated array of group names.
2929 * Use g_strfreev() to free it.
2934 g_bookmark_file_get_groups (GBookmarkFile *bookmark,
2944 g_return_val_if_fail (bookmark != NULL, NULL);
2945 g_return_val_if_fail (uri != NULL, NULL);
2947 item = g_bookmark_file_lookup_item (bookmark, uri);
2950 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2951 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2952 _("No bookmark found for URI '%s'"),
2957 if (!item->metadata)
2965 len = g_list_length (item->metadata->groups);
2966 retval = g_new0 (gchar *, len + 1);
2967 for (l = g_list_last (item->metadata->groups), i = 0;
2971 gchar *group_name = (gchar *) l->data;
2973 g_warn_if_fail (group_name != NULL);
2975 retval[i++] = g_strdup (group_name);
2986 * g_bookmark_file_add_application:
2987 * @bookmark: a #GBookmarkFile
2989 * @name: (allow-none): the name of the application registering the bookmark
2991 * @exec: (allow-none): command line to be used to launch the bookmark or %NULL
2993 * Adds the application with @name and @exec to the list of
2994 * applications that have registered a bookmark for @uri into
2997 * Every bookmark inside a #GBookmarkFile must have at least an
2998 * application registered. Each application must provide a name, a
2999 * command line useful for launching the bookmark, the number of times
3000 * the bookmark has been registered by the application and the last
3001 * time the application registered this bookmark.
3003 * If @name is %NULL, the name of the application will be the
3004 * same returned by g_get_application_name(); if @exec is %NULL, the
3005 * command line will be a composition of the program name as
3006 * returned by g_get_prgname() and the "\%u" modifier, which will be
3007 * expanded to the bookmark's URI.
3009 * This function will automatically take care of updating the
3010 * registrations count and timestamping in case an application
3011 * with the same @name had already registered a bookmark for
3012 * @uri inside @bookmark.
3014 * If no bookmark for @uri is found, one is created.
3019 g_bookmark_file_add_application (GBookmarkFile *bookmark,
3025 gchar *app_name, *app_exec;
3027 g_return_if_fail (bookmark != NULL);
3028 g_return_if_fail (uri != NULL);
3030 item = g_bookmark_file_lookup_item (bookmark, uri);
3033 item = bookmark_item_new (uri);
3034 g_bookmark_file_add_item (bookmark, item, NULL);
3037 if (name && name[0] != '\0')
3038 app_name = g_strdup (name);
3040 app_name = g_strdup (g_get_application_name ());
3042 if (exec && exec[0] != '\0')
3043 app_exec = g_strdup (exec);
3045 app_exec = g_strjoin (" ", g_get_prgname(), "%u", NULL);
3047 g_bookmark_file_set_app_info (bookmark, uri,
3059 * g_bookmark_file_remove_application:
3060 * @bookmark: a #GBookmarkFile
3062 * @name: the name of the application
3063 * @error: return location for a #GError or %NULL
3065 * Removes application registered with @name from the list of applications
3066 * that have registered a bookmark for @uri inside @bookmark.
3068 * In the event the URI cannot be found, %FALSE is returned and
3069 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3070 * In the event that no application with name @app_name has registered
3071 * a bookmark for @uri, %FALSE is returned and error is set to
3072 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
3074 * Return value: %TRUE if the application was successfully removed.
3079 g_bookmark_file_remove_application (GBookmarkFile *bookmark,
3087 g_return_val_if_fail (bookmark != NULL, FALSE);
3088 g_return_val_if_fail (uri != NULL, FALSE);
3089 g_return_val_if_fail (name != NULL, FALSE);
3092 retval = g_bookmark_file_set_app_info (bookmark, uri,
3100 g_propagate_error (error, set_error);
3109 * g_bookmark_file_has_application:
3110 * @bookmark: a #GBookmarkFile
3112 * @name: the name of the application
3113 * @error: return location for a #GError or %NULL
3115 * Checks whether the bookmark for @uri inside @bookmark has been
3116 * registered by application @name.
3118 * In the event the URI cannot be found, %FALSE is returned and
3119 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3121 * Return value: %TRUE if the application @name was found
3126 g_bookmark_file_has_application (GBookmarkFile *bookmark,
3133 g_return_val_if_fail (bookmark != NULL, FALSE);
3134 g_return_val_if_fail (uri != NULL, FALSE);
3135 g_return_val_if_fail (name != NULL, FALSE);
3137 item = g_bookmark_file_lookup_item (bookmark, uri);
3140 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3141 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3142 _("No bookmark found for URI '%s'"),
3147 return (NULL != bookmark_item_lookup_app_info (item, name));
3151 * g_bookmark_file_set_app_info:
3152 * @bookmark: a #GBookmarkFile
3154 * @name: an application's name
3155 * @exec: an application's command line
3156 * @count: the number of registrations done for this application
3157 * @stamp: the time of the last registration for this application
3158 * @error: return location for a #GError or %NULL
3160 * Sets the meta-data of application @name inside the list of
3161 * applications that have registered a bookmark for @uri inside
3164 * You should rarely use this function; use g_bookmark_file_add_application()
3165 * and g_bookmark_file_remove_application() instead.
3167 * @name can be any UTF-8 encoded string used to identify an
3169 * @exec can have one of these two modifiers: "\%f", which will
3170 * be expanded as the local file name retrieved from the bookmark's
3171 * URI; "\%u", which will be expanded as the bookmark's URI.
3172 * The expansion is done automatically when retrieving the stored
3173 * command line using the g_bookmark_file_get_app_info() function.
3174 * @count is the number of times the application has registered the
3175 * bookmark; if is < 0, the current registration count will be increased
3176 * by one, if is 0, the application with @name will be removed from
3177 * the list of registered applications.
3178 * @stamp is the Unix time of the last registration; if it is -1, the
3179 * current time will be used.
3181 * If you try to remove an application by setting its registration count to
3182 * zero, and no bookmark for @uri is found, %FALSE is returned and
3183 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
3184 * in the event that no application @name has registered a bookmark
3185 * for @uri, %FALSE is returned and error is set to
3186 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark
3187 * for @uri is found, one is created.
3189 * Return value: %TRUE if the application's meta-data was successfully
3195 g_bookmark_file_set_app_info (GBookmarkFile *bookmark,
3204 BookmarkAppInfo *ai;
3206 g_return_val_if_fail (bookmark != NULL, FALSE);
3207 g_return_val_if_fail (uri != NULL, FALSE);
3208 g_return_val_if_fail (name != NULL, FALSE);
3209 g_return_val_if_fail (exec != NULL, FALSE);
3211 item = g_bookmark_file_lookup_item (bookmark, uri);
3216 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3217 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3218 _("No bookmark found for URI '%s'"),
3224 item = bookmark_item_new (uri);
3225 g_bookmark_file_add_item (bookmark, item, NULL);
3229 if (!item->metadata)
3230 item->metadata = bookmark_metadata_new ();
3232 ai = bookmark_item_lookup_app_info (item, name);
3237 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3238 G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3239 _("No application with name '%s' registered a bookmark for '%s'"),
3246 ai = bookmark_app_info_new (name);
3248 item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
3249 g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
3255 item->metadata->applications = g_list_remove (item->metadata->applications, ai);
3256 g_hash_table_remove (item->metadata->apps_by_name, ai->name);
3257 bookmark_app_info_free (ai);
3259 item->modified = time (NULL);
3268 if (stamp != (time_t) -1)
3271 ai->stamp = time (NULL);
3273 if (exec && exec[0] != '\0')
3276 ai->exec = g_shell_quote (exec);
3279 item->modified = time (NULL);
3284 /* expands the application's command line */
3286 expand_exec_line (const gchar *exec_fmt,
3292 exec = g_string_sized_new (512);
3293 while ((ch = *exec_fmt++) != '\0')
3297 exec = g_string_append_c (exec, ch);
3308 g_string_append (exec, uri);
3313 gchar *file = g_filename_from_uri (uri, NULL, NULL);
3316 g_string_append (exec, file);
3321 g_string_free (exec, TRUE);
3328 exec = g_string_append_c (exec, ch);
3334 return g_string_free (exec, FALSE);
3338 * g_bookmark_file_get_app_info:
3339 * @bookmark: a #GBookmarkFile
3341 * @name: an application's name
3342 * @exec: (allow-none): location for the command line of the application, or %NULL
3343 * @count: (allow-none): return location for the registration count, or %NULL
3344 * @stamp: (allow-none): return location for the last registration time, or %NULL
3345 * @error: return location for a #GError, or %NULL
3347 * Gets the registration informations of @app_name for the bookmark for
3348 * @uri. See g_bookmark_file_set_app_info() for more informations about
3349 * the returned data.
3351 * The string returned in @app_exec must be freed.
3353 * In the event the URI cannot be found, %FALSE is returned and
3354 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
3355 * event that no application with name @app_name has registered a bookmark
3356 * for @uri, %FALSE is returned and error is set to
3357 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
3358 * the command line fails, an error of the #G_SHELL_ERROR domain is
3359 * set and %FALSE is returned.
3361 * Return value: %TRUE on success.
3366 g_bookmark_file_get_app_info (GBookmarkFile *bookmark,
3375 BookmarkAppInfo *ai;
3377 g_return_val_if_fail (bookmark != NULL, FALSE);
3378 g_return_val_if_fail (uri != NULL, FALSE);
3379 g_return_val_if_fail (name != NULL, FALSE);
3381 item = g_bookmark_file_lookup_item (bookmark, uri);
3384 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3385 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3386 _("No bookmark found for URI '%s'"),
3391 ai = bookmark_item_lookup_app_info (item, name);
3394 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3395 G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3396 _("No application with name '%s' registered a bookmark for '%s'"),
3404 GError *unquote_error = NULL;
3405 gchar *command_line;
3407 command_line = g_shell_unquote (ai->exec, &unquote_error);
3410 g_propagate_error (error, unquote_error);
3414 *exec = expand_exec_line (command_line, uri);
3417 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3418 G_BOOKMARK_FILE_ERROR_INVALID_URI,
3419 _("Failed to expand exec line '%s' with URI '%s'"),
3421 g_free (command_line);
3426 g_free (command_line);
3439 * g_bookmark_file_get_applications:
3440 * @bookmark: a #GBookmarkFile
3442 * @length: (allow-none): return location of the length of the returned list, or %NULL
3443 * @error: return location for a #GError, or %NULL
3445 * Retrieves the names of the applications that have registered the
3446 * bookmark for @uri.
3448 * In the event the URI cannot be found, %NULL is returned and
3449 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3451 * Return value: a newly allocated %NULL-terminated array of strings.
3452 * Use g_strfreev() to free it.
3457 g_bookmark_file_get_applications (GBookmarkFile *bookmark,
3467 g_return_val_if_fail (bookmark != NULL, NULL);
3468 g_return_val_if_fail (uri != NULL, NULL);
3470 item = g_bookmark_file_lookup_item (bookmark, uri);
3473 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3474 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3475 _("No bookmark found for URI '%s'"),
3480 if (!item->metadata)
3488 n_apps = g_list_length (item->metadata->applications);
3489 apps = g_new0 (gchar *, n_apps + 1);
3491 for (l = g_list_last (item->metadata->applications), i = 0;
3495 BookmarkAppInfo *ai;
3497 ai = (BookmarkAppInfo *) l->data;
3499 g_warn_if_fail (ai != NULL);
3500 g_warn_if_fail (ai->name != NULL);
3502 apps[i++] = g_strdup (ai->name);
3513 * g_bookmark_file_get_size:
3514 * @bookmark: a #GBookmarkFile
3516 * Gets the number of bookmarks inside @bookmark.
3518 * Return value: the number of bookmarks
3523 g_bookmark_file_get_size (GBookmarkFile *bookmark)
3525 g_return_val_if_fail (bookmark != NULL, 0);
3527 return g_list_length (bookmark->items);
3531 * g_bookmark_file_move_item:
3532 * @bookmark: a #GBookmarkFile
3533 * @old_uri: a valid URI
3534 * @new_uri: (allow-none): a valid URI, or %NULL
3535 * @error: return location for a #GError or %NULL
3537 * Changes the URI of a bookmark item from @old_uri to @new_uri. Any
3538 * existing bookmark for @new_uri will be overwritten. If @new_uri is
3539 * %NULL, then the bookmark is removed.
3541 * In the event the URI cannot be found, %FALSE is returned and
3542 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3544 * Return value: %TRUE if the URI was successfully changed
3549 g_bookmark_file_move_item (GBookmarkFile *bookmark,
3550 const gchar *old_uri,
3551 const gchar *new_uri,
3555 GError *remove_error;
3557 g_return_val_if_fail (bookmark != NULL, FALSE);
3558 g_return_val_if_fail (old_uri != NULL, FALSE);
3560 item = g_bookmark_file_lookup_item (bookmark, old_uri);
3563 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3564 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3565 _("No bookmark found for URI '%s'"),
3570 if (new_uri && new_uri[0] != '\0')
3572 if (g_bookmark_file_has_item (bookmark, new_uri))
3574 remove_error = NULL;
3575 g_bookmark_file_remove_item (bookmark, new_uri, &remove_error);
3578 g_propagate_error (error, remove_error);
3584 g_hash_table_steal (bookmark->items_by_uri, item->uri);
3587 item->uri = g_strdup (new_uri);
3588 item->modified = time (NULL);
3590 g_hash_table_replace (bookmark->items_by_uri, item->uri, item);
3596 remove_error = NULL;
3597 g_bookmark_file_remove_item (bookmark, old_uri, &remove_error);
3600 g_propagate_error (error, remove_error);
3610 * g_bookmark_file_set_icon:
3611 * @bookmark: a #GBookmarkFile
3613 * @href: (allow-none): the URI of the icon for the bookmark, or %NULL
3614 * @mime_type: the MIME type of the icon for the bookmark
3616 * Sets the icon for the bookmark for @uri. If @href is %NULL, unsets
3617 * the currently set icon. @href can either be a full URL for the icon
3618 * file or the icon name following the Icon Naming specification.
3620 * If no bookmark for @uri is found one is created.
3625 g_bookmark_file_set_icon (GBookmarkFile *bookmark,
3628 const gchar *mime_type)
3632 g_return_if_fail (bookmark != NULL);
3633 g_return_if_fail (uri != NULL);
3635 item = g_bookmark_file_lookup_item (bookmark, uri);
3638 item = bookmark_item_new (uri);
3639 g_bookmark_file_add_item (bookmark, item, NULL);
3642 if (!item->metadata)
3643 item->metadata = bookmark_metadata_new ();
3645 g_free (item->metadata->icon_href);
3646 g_free (item->metadata->icon_mime);
3648 item->metadata->icon_href = g_strdup (href);
3650 if (mime_type && mime_type[0] != '\0')
3651 item->metadata->icon_mime = g_strdup (mime_type);
3653 item->metadata->icon_mime = g_strdup ("application/octet-stream");
3655 item->modified = time (NULL);
3659 * g_bookmark_file_get_icon:
3660 * @bookmark: a #GBookmarkFile
3662 * @href: (allow-none): return location for the icon's location or %NULL
3663 * @mime_type: (allow-none): return location for the icon's MIME type or %NULL
3664 * @error: return location for a #GError or %NULL
3666 * Gets the icon of the bookmark for @uri.
3668 * In the event the URI cannot be found, %FALSE is returned and
3669 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3671 * Return value: %TRUE if the icon for the bookmark for the URI was found.
3672 * You should free the returned strings.
3677 g_bookmark_file_get_icon (GBookmarkFile *bookmark,
3685 g_return_val_if_fail (bookmark != NULL, FALSE);
3686 g_return_val_if_fail (uri != NULL, FALSE);
3688 item = g_bookmark_file_lookup_item (bookmark, uri);
3691 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3692 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3693 _("No bookmark found for URI '%s'"),
3698 if ((!item->metadata) || (!item->metadata->icon_href))
3702 *href = g_strdup (item->metadata->icon_href);
3705 *mime_type = g_strdup (item->metadata->icon_mime);