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"
36 #include "gfileutils.h"
43 #include "gmessages.h"
48 #include "gstrfuncs.h"
54 * SECTION:bookmarkfile
55 * @title: Bookmark file parser
56 * @short_description: parses files containing bookmarks
58 * GBookmarkFile lets you parse, edit or create files containing bookmarks
59 * to URI, along with some meta-data about the resource pointed by the URI
60 * like its MIME type, the application that is registering the bookmark and
61 * the icon that should be used to represent the bookmark. The data is stored
63 * [Desktop Bookmark Specification](http://www.gnome.org/~ebassi/bookmark-spec).
65 * The syntax of the bookmark files is described in detail inside the
66 * Desktop Bookmark Specification, here is a quick summary: bookmark
67 * files use a sub-class of the XML Bookmark Exchange Language
68 * specification, consisting of valid UTF-8 encoded XML, under the
69 * <xbel> root element; each bookmark is stored inside a
70 * <bookmark> element, using its URI: no relative paths can
71 * be used inside a bookmark file. The bookmark may have a user defined
72 * title and description, to be used instead of the URI. Under the
73 * <metadata> element, with its owner attribute set to
74 * `http://freedesktop.org`, is stored the meta-data about a resource
75 * pointed by its URI. The meta-data consists of the resource's MIME
76 * type; the applications that have registered a bookmark; the groups
77 * to which a bookmark belongs to; a visibility flag, used to set the
78 * bookmark as "private" to the applications and groups that has it
79 * registered; the URI and MIME type of an icon, to be used when
80 * displaying the bookmark inside a GUI.
82 * Here is an example of a bookmark file:
83 * [bookmarks.xbel](https://git.gnome.org/browse/glib/tree/glib/tests/bookmarks.xbel)
85 * A bookmark file might contain more than one bookmark; each bookmark
86 * is accessed through its URI.
88 * The important caveat of bookmark files is that when you add a new
89 * bookmark you must also add the application that is registering it, using
90 * g_bookmark_file_add_application() or g_bookmark_file_set_app_info().
91 * If a bookmark has no applications then it won't be dumped when creating
92 * the on disk representation, using g_bookmark_file_to_data() or
93 * g_bookmark_file_to_file().
95 * The #GBookmarkFile parser was added in GLib 2.12.
98 /* XBEL 1.0 standard entities */
99 #define XBEL_VERSION "1.0"
100 #define XBEL_DTD_NICK "xbel"
101 #define XBEL_DTD_SYSTEM "+//IDN python.org//DTD XML Bookmark " \
102 "Exchange Language 1.0//EN//XML"
104 #define XBEL_DTD_URI "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"
106 #define XBEL_ROOT_ELEMENT "xbel"
107 #define XBEL_FOLDER_ELEMENT "folder" /* unused */
108 #define XBEL_BOOKMARK_ELEMENT "bookmark"
109 #define XBEL_ALIAS_ELEMENT "alias" /* unused */
110 #define XBEL_SEPARATOR_ELEMENT "separator" /* unused */
111 #define XBEL_TITLE_ELEMENT "title"
112 #define XBEL_DESC_ELEMENT "desc"
113 #define XBEL_INFO_ELEMENT "info"
114 #define XBEL_METADATA_ELEMENT "metadata"
116 #define XBEL_VERSION_ATTRIBUTE "version"
117 #define XBEL_FOLDED_ATTRIBUTE "folded" /* unused */
118 #define XBEL_OWNER_ATTRIBUTE "owner"
119 #define XBEL_ADDED_ATTRIBUTE "added"
120 #define XBEL_VISITED_ATTRIBUTE "visited"
121 #define XBEL_MODIFIED_ATTRIBUTE "modified"
122 #define XBEL_ID_ATTRIBUTE "id"
123 #define XBEL_HREF_ATTRIBUTE "href"
124 #define XBEL_REF_ATTRIBUTE "ref" /* unused */
126 #define XBEL_YES_VALUE "yes"
127 #define XBEL_NO_VALUE "no"
129 /* Desktop bookmark spec entities */
130 #define BOOKMARK_METADATA_OWNER "http://freedesktop.org"
132 #define BOOKMARK_NAMESPACE_NAME "bookmark"
133 #define BOOKMARK_NAMESPACE_URI "http://www.freedesktop.org/standards/desktop-bookmarks"
135 #define BOOKMARK_GROUPS_ELEMENT "groups"
136 #define BOOKMARK_GROUP_ELEMENT "group"
137 #define BOOKMARK_APPLICATIONS_ELEMENT "applications"
138 #define BOOKMARK_APPLICATION_ELEMENT "application"
139 #define BOOKMARK_ICON_ELEMENT "icon"
140 #define BOOKMARK_PRIVATE_ELEMENT "private"
142 #define BOOKMARK_NAME_ATTRIBUTE "name"
143 #define BOOKMARK_EXEC_ATTRIBUTE "exec"
144 #define BOOKMARK_COUNT_ATTRIBUTE "count"
145 #define BOOKMARK_TIMESTAMP_ATTRIBUTE "timestamp" /* deprecated by "modified" */
146 #define BOOKMARK_MODIFIED_ATTRIBUTE "modified"
147 #define BOOKMARK_HREF_ATTRIBUTE "href"
148 #define BOOKMARK_TYPE_ATTRIBUTE "type"
150 /* Shared MIME Info entities */
151 #define MIME_NAMESPACE_NAME "mime"
152 #define MIME_NAMESPACE_URI "http://www.freedesktop.org/standards/shared-mime-info"
153 #define MIME_TYPE_ELEMENT "mime-type"
154 #define MIME_TYPE_ATTRIBUTE "type"
157 typedef struct _BookmarkAppInfo BookmarkAppInfo;
158 typedef struct _BookmarkMetadata BookmarkMetadata;
159 typedef struct _BookmarkItem BookmarkItem;
160 typedef struct _ParseData ParseData;
162 struct _BookmarkAppInfo
172 struct _BookmarkMetadata
179 GHashTable *apps_by_name;
184 guint is_private : 1;
198 BookmarkMetadata *metadata;
201 struct _GBookmarkFile
206 /* we store our items in a list and keep a copy inside
207 * an hash table for faster lookup performances
210 GHashTable *items_by_uri;
213 /* parser state machine */
234 static void g_bookmark_file_init (GBookmarkFile *bookmark);
235 static void g_bookmark_file_clear (GBookmarkFile *bookmark);
236 static gboolean g_bookmark_file_parse (GBookmarkFile *bookmark,
240 static gchar * g_bookmark_file_dump (GBookmarkFile *bookmark,
243 static BookmarkItem *g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
245 static void g_bookmark_file_add_item (GBookmarkFile *bookmark,
249 static time_t timestamp_from_iso8601 (const gchar *iso_date);
250 static gchar * timestamp_to_iso8601 (time_t timestamp);
252 /********************************
255 * Application metadata storage *
256 ********************************/
257 static BookmarkAppInfo *
258 bookmark_app_info_new (const gchar *name)
260 BookmarkAppInfo *retval;
262 g_warn_if_fail (name != NULL);
264 retval = g_slice_new (BookmarkAppInfo);
266 retval->name = g_strdup (name);
275 bookmark_app_info_free (BookmarkAppInfo *app_info)
280 g_free (app_info->name);
281 g_free (app_info->exec);
283 g_slice_free (BookmarkAppInfo, app_info);
287 bookmark_app_info_dump (BookmarkAppInfo *app_info)
290 gchar *name, *exec, *modified, *count;
292 g_warn_if_fail (app_info != NULL);
294 if (app_info->count == 0)
297 name = g_markup_escape_text (app_info->name, -1);
298 exec = g_markup_escape_text (app_info->exec, -1);
299 modified = timestamp_to_iso8601 (app_info->stamp);
300 count = g_strdup_printf ("%u", app_info->count);
302 retval = g_strconcat (" "
303 "<" BOOKMARK_NAMESPACE_NAME ":" BOOKMARK_APPLICATION_ELEMENT
304 " " BOOKMARK_NAME_ATTRIBUTE "=\"", name, "\""
305 " " BOOKMARK_EXEC_ATTRIBUTE "=\"", exec, "\""
306 " " BOOKMARK_MODIFIED_ATTRIBUTE "=\"", modified, "\""
307 " " BOOKMARK_COUNT_ATTRIBUTE "=\"", count, "\"/>\n",
319 /***********************
323 ***********************/
324 static BookmarkMetadata *
325 bookmark_metadata_new (void)
327 BookmarkMetadata *retval;
329 retval = g_slice_new (BookmarkMetadata);
331 retval->mime_type = NULL;
333 retval->groups = NULL;
335 retval->applications = NULL;
336 retval->apps_by_name = g_hash_table_new_full (g_str_hash,
341 retval->is_private = FALSE;
343 retval->icon_href = NULL;
344 retval->icon_mime = NULL;
350 bookmark_metadata_free (BookmarkMetadata *metadata)
355 g_free (metadata->mime_type);
357 g_list_free_full (metadata->groups, g_free);
358 g_list_free_full (metadata->applications, (GDestroyNotify) bookmark_app_info_free);
360 g_hash_table_destroy (metadata->apps_by_name);
362 g_free (metadata->icon_href);
363 g_free (metadata->icon_mime);
365 g_slice_free (BookmarkMetadata, metadata);
369 bookmark_metadata_dump (BookmarkMetadata *metadata)
374 if (!metadata->applications)
377 retval = g_string_sized_new (1024);
379 /* metadata container */
380 g_string_append (retval,
382 "<" XBEL_METADATA_ELEMENT
383 " " XBEL_OWNER_ATTRIBUTE "=\"" BOOKMARK_METADATA_OWNER
387 if (metadata->mime_type) {
388 buffer = g_strconcat (" "
389 "<" MIME_NAMESPACE_NAME ":" MIME_TYPE_ELEMENT " "
390 MIME_TYPE_ATTRIBUTE "=\"", metadata->mime_type, "\"/>\n",
392 g_string_append (retval, buffer);
396 if (metadata->groups)
400 /* open groups container */
401 g_string_append (retval,
403 "<" BOOKMARK_NAMESPACE_NAME
404 ":" BOOKMARK_GROUPS_ELEMENT ">\n");
406 for (l = g_list_last (metadata->groups); l != NULL; l = l->prev)
410 group_name = g_markup_escape_text ((gchar *) l->data, -1);
411 buffer = g_strconcat (" "
412 "<" BOOKMARK_NAMESPACE_NAME
413 ":" BOOKMARK_GROUP_ELEMENT ">",
415 "</" BOOKMARK_NAMESPACE_NAME
416 ":" BOOKMARK_GROUP_ELEMENT ">\n", NULL);
417 g_string_append (retval, buffer);
423 /* close groups container */
424 g_string_append (retval,
426 "</" BOOKMARK_NAMESPACE_NAME
427 ":" BOOKMARK_GROUPS_ELEMENT ">\n");
430 if (metadata->applications)
434 /* open applications container */
435 g_string_append (retval,
437 "<" BOOKMARK_NAMESPACE_NAME
438 ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");
440 for (l = g_list_last (metadata->applications); l != NULL; l = l->prev)
442 BookmarkAppInfo *app_info = (BookmarkAppInfo *) l->data;
445 g_warn_if_fail (app_info != NULL);
447 app_data = bookmark_app_info_dump (app_info);
451 retval = g_string_append (retval, app_data);
457 /* close applications container */
458 g_string_append (retval,
460 "</" BOOKMARK_NAMESPACE_NAME
461 ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");
465 if (metadata->icon_href)
467 if (!metadata->icon_mime)
468 metadata->icon_mime = g_strdup ("application/octet-stream");
470 buffer = g_strconcat (" "
471 "<" BOOKMARK_NAMESPACE_NAME
472 ":" BOOKMARK_ICON_ELEMENT
473 " " BOOKMARK_HREF_ATTRIBUTE "=\"", metadata->icon_href,
474 "\" " BOOKMARK_TYPE_ATTRIBUTE "=\"", metadata->icon_mime, "\"/>\n", NULL);
475 g_string_append (retval, buffer);
481 if (metadata->is_private)
482 g_string_append (retval,
484 "<" BOOKMARK_NAMESPACE_NAME
485 ":" BOOKMARK_PRIVATE_ELEMENT "/>\n");
487 /* close metadata container */
488 g_string_append (retval,
490 "</" XBEL_METADATA_ELEMENT ">\n");
492 return g_string_free (retval, FALSE);
495 /******************************************************
498 * Storage for a single bookmark item inside the list *
499 ******************************************************/
500 static BookmarkItem *
501 bookmark_item_new (const gchar *uri)
505 g_warn_if_fail (uri != NULL);
507 item = g_slice_new (BookmarkItem);
508 item->uri = g_strdup (uri);
511 item->description = NULL;
513 item->added = (time_t) -1;
514 item->modified = (time_t) -1;
515 item->visited = (time_t) -1;
517 item->metadata = NULL;
523 bookmark_item_free (BookmarkItem *item)
529 g_free (item->title);
530 g_free (item->description);
533 bookmark_metadata_free (item->metadata);
535 g_slice_free (BookmarkItem, item);
539 bookmark_item_dump (BookmarkItem *item)
542 gchar *added, *visited, *modified;
546 /* at this point, we must have at least a registered application; if we don't
547 * we don't screw up the bookmark file, and just skip this item
549 if (!item->metadata || !item->metadata->applications)
551 g_warning ("Item for URI '%s' has no registered applications: skipping.\n", item->uri);
555 retval = g_string_sized_new (4096);
557 added = timestamp_to_iso8601 (item->added);
558 modified = timestamp_to_iso8601 (item->modified);
559 visited = timestamp_to_iso8601 (item->visited);
561 escaped_uri = g_markup_escape_text (item->uri, -1);
563 buffer = g_strconcat (" <"
564 XBEL_BOOKMARK_ELEMENT
566 XBEL_HREF_ATTRIBUTE "=\"", escaped_uri, "\" "
567 XBEL_ADDED_ATTRIBUTE "=\"", added, "\" "
568 XBEL_MODIFIED_ATTRIBUTE "=\"", modified, "\" "
569 XBEL_VISITED_ATTRIBUTE "=\"", visited, "\">\n",
572 g_string_append (retval, buffer);
574 g_free (escaped_uri);
582 gchar *escaped_title;
584 escaped_title = g_markup_escape_text (item->title, -1);
585 buffer = g_strconcat (" "
586 "<" XBEL_TITLE_ELEMENT ">",
588 "</" XBEL_TITLE_ELEMENT ">\n",
590 g_string_append (retval, buffer);
592 g_free (escaped_title);
596 if (item->description)
600 escaped_desc = g_markup_escape_text (item->description, -1);
601 buffer = g_strconcat (" "
602 "<" XBEL_DESC_ELEMENT ">",
604 "</" XBEL_DESC_ELEMENT ">\n",
606 g_string_append (retval, buffer);
608 g_free (escaped_desc);
616 metadata = bookmark_metadata_dump (item->metadata);
619 buffer = g_strconcat (" "
620 "<" XBEL_INFO_ELEMENT ">\n",
623 "</" XBEL_INFO_ELEMENT ">\n",
625 retval = g_string_append (retval, buffer);
632 g_string_append (retval, " </" XBEL_BOOKMARK_ELEMENT ">\n");
634 return g_string_free (retval, FALSE);
637 static BookmarkAppInfo *
638 bookmark_item_lookup_app_info (BookmarkItem *item,
639 const gchar *app_name)
641 g_warn_if_fail (item != NULL && app_name != NULL);
646 return g_hash_table_lookup (item->metadata->apps_by_name, app_name);
649 /*************************
651 *************************/
654 g_bookmark_file_init (GBookmarkFile *bookmark)
656 bookmark->title = NULL;
657 bookmark->description = NULL;
659 bookmark->items = NULL;
660 bookmark->items_by_uri = g_hash_table_new_full (g_str_hash,
667 g_bookmark_file_clear (GBookmarkFile *bookmark)
669 g_free (bookmark->title);
670 g_free (bookmark->description);
672 g_list_free_full (bookmark->items, (GDestroyNotify) bookmark_item_free);
673 bookmark->items = NULL;
675 if (bookmark->items_by_uri)
677 g_hash_table_destroy (bookmark->items_by_uri);
679 bookmark->items_by_uri = NULL;
687 GHashTable *namespaces;
689 GBookmarkFile *bookmark_file;
690 BookmarkItem *current_item;
694 parse_data_new (void)
698 retval = g_new (ParseData, 1);
700 retval->state = STATE_STARTED;
701 retval->namespaces = g_hash_table_new_full (g_str_hash, g_str_equal,
702 (GDestroyNotify) g_free,
703 (GDestroyNotify) g_free);
704 retval->bookmark_file = NULL;
705 retval->current_item = NULL;
711 parse_data_free (ParseData *parse_data)
713 g_hash_table_destroy (parse_data->namespaces);
718 #define IS_ATTRIBUTE(s,a) ((0 == strcmp ((s), (a))))
721 parse_bookmark_element (GMarkupParseContext *context,
722 ParseData *parse_data,
723 const gchar **attribute_names,
724 const gchar **attribute_values,
727 const gchar *uri, *added, *modified, *visited;
733 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_BOOKMARK));
736 uri = added = modified = visited = NULL;
737 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
739 if (IS_ATTRIBUTE (attr, XBEL_HREF_ATTRIBUTE))
740 uri = attribute_values[i];
741 else if (IS_ATTRIBUTE (attr, XBEL_ADDED_ATTRIBUTE))
742 added = attribute_values[i];
743 else if (IS_ATTRIBUTE (attr, XBEL_MODIFIED_ATTRIBUTE))
744 modified = attribute_values[i];
745 else if (IS_ATTRIBUTE (attr, XBEL_VISITED_ATTRIBUTE))
746 visited = attribute_values[i];
749 /* bookmark is defined by the XBEL spec, so we need
750 * to error out if the element has different or
753 g_set_error (error, G_MARKUP_ERROR,
754 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
755 _("Unexpected attribute '%s' for element '%s'"),
757 XBEL_BOOKMARK_ELEMENT);
764 g_set_error (error, G_MARKUP_ERROR,
765 G_MARKUP_ERROR_INVALID_CONTENT,
766 _("Attribute '%s' of element '%s' not found"),
768 XBEL_BOOKMARK_ELEMENT);
772 g_warn_if_fail (parse_data->current_item == NULL);
774 item = bookmark_item_new (uri);
777 item->added = timestamp_from_iso8601 (added);
780 item->modified = timestamp_from_iso8601 (modified);
783 item->visited = timestamp_from_iso8601 (visited);
786 g_bookmark_file_add_item (parse_data->bookmark_file,
791 bookmark_item_free (item);
793 g_propagate_error (error, add_error);
798 parse_data->current_item = item;
802 parse_application_element (GMarkupParseContext *context,
803 ParseData *parse_data,
804 const gchar **attribute_names,
805 const gchar **attribute_values,
808 const gchar *name, *exec, *count, *stamp, *modified;
814 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_APPLICATION));
817 name = exec = count = stamp = modified = NULL;
818 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
820 if (IS_ATTRIBUTE (attr, BOOKMARK_NAME_ATTRIBUTE))
821 name = attribute_values[i];
822 else if (IS_ATTRIBUTE (attr, BOOKMARK_EXEC_ATTRIBUTE))
823 exec = attribute_values[i];
824 else if (IS_ATTRIBUTE (attr, BOOKMARK_COUNT_ATTRIBUTE))
825 count = attribute_values[i];
826 else if (IS_ATTRIBUTE (attr, BOOKMARK_TIMESTAMP_ATTRIBUTE))
827 stamp = attribute_values[i];
828 else if (IS_ATTRIBUTE (attr, BOOKMARK_MODIFIED_ATTRIBUTE))
829 modified = attribute_values[i];
832 /* the "name" and "exec" attributes are mandatory */
835 g_set_error (error, G_MARKUP_ERROR,
836 G_MARKUP_ERROR_INVALID_CONTENT,
837 _("Attribute '%s' of element '%s' not found"),
838 BOOKMARK_NAME_ATTRIBUTE,
839 BOOKMARK_APPLICATION_ELEMENT);
845 g_set_error (error, G_MARKUP_ERROR,
846 G_MARKUP_ERROR_INVALID_CONTENT,
847 _("Attribute '%s' of element '%s' not found"),
848 BOOKMARK_EXEC_ATTRIBUTE,
849 BOOKMARK_APPLICATION_ELEMENT);
853 g_warn_if_fail (parse_data->current_item != NULL);
854 item = parse_data->current_item;
856 ai = bookmark_item_lookup_app_info (item, name);
859 ai = bookmark_app_info_new (name);
862 item->metadata = bookmark_metadata_new ();
864 item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
865 g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
868 ai->exec = g_strdup (exec);
871 ai->count = atoi (count);
876 ai->stamp = timestamp_from_iso8601 (modified);
879 /* the timestamp attribute has been deprecated but we still parse
880 * it for backward compatibility
883 ai->stamp = (time_t) atol (stamp);
885 ai->stamp = time (NULL);
890 parse_mime_type_element (GMarkupParseContext *context,
891 ParseData *parse_data,
892 const gchar **attribute_names,
893 const gchar **attribute_values,
901 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_MIME));
905 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
907 if (IS_ATTRIBUTE (attr, MIME_TYPE_ATTRIBUTE))
908 type = attribute_values[i];
912 type = "application/octet-stream";
914 g_warn_if_fail (parse_data->current_item != NULL);
915 item = parse_data->current_item;
918 item->metadata = bookmark_metadata_new ();
920 item->metadata->mime_type = g_strdup (type);
924 parse_icon_element (GMarkupParseContext *context,
925 ParseData *parse_data,
926 const gchar **attribute_names,
927 const gchar **attribute_values,
936 g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_ICON));
941 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
943 if (IS_ATTRIBUTE (attr, BOOKMARK_HREF_ATTRIBUTE))
944 href = attribute_values[i];
945 else if (IS_ATTRIBUTE (attr, BOOKMARK_TYPE_ATTRIBUTE))
946 type = attribute_values[i];
949 /* the "href" attribute is mandatory */
952 g_set_error (error, G_MARKUP_ERROR,
953 G_MARKUP_ERROR_INVALID_CONTENT,
954 _("Attribute '%s' of element '%s' not found"),
955 BOOKMARK_HREF_ATTRIBUTE,
956 BOOKMARK_ICON_ELEMENT);
961 type = "application/octet-stream";
963 g_warn_if_fail (parse_data->current_item != NULL);
964 item = parse_data->current_item;
967 item->metadata = bookmark_metadata_new ();
969 item->metadata->icon_href = g_strdup (href);
970 item->metadata->icon_mime = g_strdup (type);
973 /* scans through the attributes of an element for the "xmlns" pragma, and
974 * adds any resulting namespace declaration to a per-parser hashtable, using
975 * the namespace name as a key for the namespace URI; if no key was found,
976 * the namespace is considered as default, and stored under the "default" key.
978 * FIXME: this works on the assumption that the generator of the XBEL file
979 * is either this code or is smart enough to place the namespace declarations
980 * inside the main root node or inside the metadata node and does not redefine
981 * a namespace inside an inner node; this does *not* conform to the
982 * XML-NS standard, although is a close approximation. In order to make this
983 * conformant to the XML-NS specification we should use a per-element
984 * namespace table inside GMarkup and ask it to resolve the namespaces for us.
987 map_namespace_to_name (ParseData *parse_data,
988 const gchar **attribute_names,
989 const gchar **attribute_values)
994 g_warn_if_fail (parse_data != NULL);
996 if (!attribute_names || !attribute_names[0])
1000 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1002 if (g_str_has_prefix (attr, "xmlns"))
1004 gchar *namespace_name, *namespace_uri;
1007 p = g_utf8_strchr (attr, -1, ':');
1009 p = g_utf8_next_char (p);
1013 namespace_name = g_strdup (p);
1014 namespace_uri = g_strdup (attribute_values[i]);
1016 g_hash_table_replace (parse_data->namespaces,
1023 /* checks whether @element_full is equal to @element.
1025 * if @namespace is set, it tries to resolve the namespace to a known URI,
1026 * and if found is prepended to the element name, from which is separated
1027 * using the character specified in the @sep parameter.
1030 is_element_full (ParseData *parse_data,
1031 const gchar *element_full,
1032 const gchar *namespace,
1033 const gchar *element,
1036 gchar *ns_uri, *ns_name;
1037 const gchar *p, *element_name;
1040 g_warn_if_fail (parse_data != NULL);
1041 g_warn_if_fail (element_full != NULL);
1046 /* no namespace requested: dumb element compare */
1048 return (0 == strcmp (element_full, element));
1050 /* search for namespace separator; if none found, assume we are under the
1051 * default namespace, and set ns_name to our "default" marker; if no default
1052 * namespace has been set, just do a plain comparison between @full_element
1055 p = g_utf8_strchr (element_full, -1, ':');
1058 ns_name = g_strndup (element_full, p - element_full);
1059 element_name = g_utf8_next_char (p);
1063 ns_name = g_strdup ("default");
1064 element_name = element_full;
1067 ns_uri = g_hash_table_lookup (parse_data->namespaces, ns_name);
1070 /* no default namespace found */
1073 return (0 == strcmp (element_full, element));
1076 retval = (0 == strcmp (ns_uri, namespace) &&
1077 0 == strcmp (element_name, element));
1084 #define IS_ELEMENT(p,s,e) (is_element_full ((p), (s), NULL, (e), '\0'))
1085 #define IS_ELEMENT_NS(p,s,n,e) (is_element_full ((p), (s), (n), (e), '|'))
1088 start_element_raw_cb (GMarkupParseContext *context,
1089 const gchar *element_name,
1090 const gchar **attribute_names,
1091 const gchar **attribute_values,
1095 ParseData *parse_data = (ParseData *) user_data;
1097 /* we must check for namespace declarations first
1099 * XXX - we could speed up things by checking for namespace declarations
1100 * only on the root node, where they usually are; this would probably break
1101 * on streams not produced by us or by "smart" generators
1103 map_namespace_to_name (parse_data, attribute_names, attribute_values);
1105 switch (parse_data->state)
1108 if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1114 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1116 if ((IS_ATTRIBUTE (attr, XBEL_VERSION_ATTRIBUTE)) &&
1117 (0 == strcmp (attribute_values[i], XBEL_VERSION)))
1118 parse_data->state = STATE_ROOT;
1122 g_set_error (error, G_MARKUP_ERROR,
1123 G_MARKUP_ERROR_INVALID_CONTENT,
1124 _("Unexpected tag '%s', tag '%s' expected"),
1125 element_name, XBEL_ROOT_ELEMENT);
1128 if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1129 parse_data->state = STATE_TITLE;
1130 else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1131 parse_data->state = STATE_DESC;
1132 else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1134 GError *inner_error = NULL;
1136 parse_data->state = STATE_BOOKMARK;
1138 parse_bookmark_element (context,
1144 g_propagate_error (error, inner_error);
1147 g_set_error (error, G_MARKUP_ERROR,
1148 G_MARKUP_ERROR_INVALID_CONTENT,
1149 _("Unexpected tag '%s' inside '%s'"),
1153 case STATE_BOOKMARK:
1154 if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1155 parse_data->state = STATE_TITLE;
1156 else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1157 parse_data->state = STATE_DESC;
1158 else if (IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT))
1159 parse_data->state = STATE_INFO;
1161 g_set_error (error, G_MARKUP_ERROR,
1162 G_MARKUP_ERROR_INVALID_CONTENT,
1163 _("Unexpected tag '%s' inside '%s'"),
1165 XBEL_BOOKMARK_ELEMENT);
1168 if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1174 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1176 if ((IS_ATTRIBUTE (attr, XBEL_OWNER_ATTRIBUTE)) &&
1177 (0 == strcmp (attribute_values[i], BOOKMARK_METADATA_OWNER)))
1179 parse_data->state = STATE_METADATA;
1181 if (!parse_data->current_item->metadata)
1182 parse_data->current_item->metadata = bookmark_metadata_new ();
1187 g_set_error (error, G_MARKUP_ERROR,
1188 G_MARKUP_ERROR_INVALID_CONTENT,
1189 _("Unexpected tag '%s', tag '%s' expected"),
1191 XBEL_METADATA_ELEMENT);
1193 case STATE_METADATA:
1194 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT))
1195 parse_data->state = STATE_APPLICATIONS;
1196 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT))
1197 parse_data->state = STATE_GROUPS;
1198 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT))
1199 parse_data->current_item->metadata->is_private = TRUE;
1200 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1202 GError *inner_error = NULL;
1204 parse_data->state = STATE_ICON;
1206 parse_icon_element (context,
1212 g_propagate_error (error, inner_error);
1214 else if (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT))
1216 GError *inner_error = NULL;
1218 parse_data->state = STATE_MIME;
1220 parse_mime_type_element (context,
1226 g_propagate_error (error, inner_error);
1229 g_set_error (error, G_MARKUP_ERROR,
1230 G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1231 _("Unexpected tag '%s' inside '%s'"),
1233 XBEL_METADATA_ELEMENT);
1235 case STATE_APPLICATIONS:
1236 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATION_ELEMENT))
1238 GError *inner_error = NULL;
1240 parse_data->state = STATE_APPLICATION;
1242 parse_application_element (context,
1248 g_propagate_error (error, inner_error);
1251 g_set_error (error, G_MARKUP_ERROR,
1252 G_MARKUP_ERROR_INVALID_CONTENT,
1253 _("Unexpected tag '%s', tag '%s' expected"),
1255 BOOKMARK_APPLICATION_ELEMENT);
1258 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUP_ELEMENT))
1259 parse_data->state = STATE_GROUP;
1261 g_set_error (error, G_MARKUP_ERROR,
1262 G_MARKUP_ERROR_INVALID_CONTENT,
1263 _("Unexpected tag '%s', tag '%s' expected"),
1265 BOOKMARK_GROUP_ELEMENT);
1268 g_warn_if_reached ();
1274 end_element_raw_cb (GMarkupParseContext *context,
1275 const gchar *element_name,
1279 ParseData *parse_data = (ParseData *) user_data;
1281 if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1282 parse_data->state = STATE_FINISHED;
1283 else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1285 parse_data->current_item = NULL;
1287 parse_data->state = STATE_ROOT;
1289 else if ((IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT)) ||
1290 (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) ||
1291 (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT)))
1293 if (parse_data->current_item)
1294 parse_data->state = STATE_BOOKMARK;
1296 parse_data->state = STATE_ROOT;
1298 else if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1299 parse_data->state = STATE_INFO;
1300 else if (IS_ELEMENT_NS (parse_data, element_name,
1301 BOOKMARK_NAMESPACE_URI,
1302 BOOKMARK_APPLICATION_ELEMENT))
1303 parse_data->state = STATE_APPLICATIONS;
1304 else if (IS_ELEMENT_NS (parse_data, element_name,
1305 BOOKMARK_NAMESPACE_URI,
1306 BOOKMARK_GROUP_ELEMENT))
1307 parse_data->state = STATE_GROUPS;
1308 else if ((IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT)) ||
1309 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT)) ||
1310 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT)) ||
1311 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT)) ||
1312 (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT)))
1313 parse_data->state = STATE_METADATA;
1317 text_raw_cb (GMarkupParseContext *context,
1323 ParseData *parse_data = (ParseData *) user_data;
1326 payload = g_strndup (text, length);
1328 switch (parse_data->state)
1331 if (parse_data->current_item)
1333 g_free (parse_data->current_item->title);
1334 parse_data->current_item->title = g_strdup (payload);
1338 g_free (parse_data->bookmark_file->title);
1339 parse_data->bookmark_file->title = g_strdup (payload);
1343 if (parse_data->current_item)
1345 g_free (parse_data->current_item->description);
1346 parse_data->current_item->description = g_strdup (payload);
1350 g_free (parse_data->bookmark_file->description);
1351 parse_data->bookmark_file->description = g_strdup (payload);
1358 g_warn_if_fail (parse_data->current_item != NULL);
1360 if (!parse_data->current_item->metadata)
1361 parse_data->current_item->metadata = bookmark_metadata_new ();
1363 groups = parse_data->current_item->metadata->groups;
1364 parse_data->current_item->metadata->groups = g_list_prepend (groups, g_strdup (payload));
1368 case STATE_BOOKMARK:
1370 case STATE_METADATA:
1371 case STATE_APPLICATIONS:
1372 case STATE_APPLICATION:
1378 g_warn_if_reached ();
1385 static const GMarkupParser markup_parser =
1387 start_element_raw_cb, /* start_element */
1388 end_element_raw_cb, /* end_element */
1389 text_raw_cb, /* text */
1390 NULL, /* passthrough */
1395 g_bookmark_file_parse (GBookmarkFile *bookmark,
1396 const gchar *buffer,
1400 GMarkupParseContext *context;
1401 ParseData *parse_data;
1402 GError *parse_error, *end_error;
1405 g_warn_if_fail (bookmark != NULL);
1413 if (length == (gsize) -1)
1414 length = strlen (buffer);
1416 parse_data = parse_data_new ();
1417 parse_data->bookmark_file = bookmark;
1419 context = g_markup_parse_context_new (&markup_parser,
1422 (GDestroyNotify) parse_data_free);
1424 retval = g_markup_parse_context_parse (context,
1429 g_propagate_error (error, parse_error);
1432 retval = g_markup_parse_context_end_parse (context, &end_error);
1434 g_propagate_error (error, end_error);
1437 g_markup_parse_context_free (context);
1443 g_bookmark_file_dump (GBookmarkFile *bookmark,
1451 retval = g_string_sized_new (4096);
1453 g_string_append (retval,
1454 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1456 /* XXX - do we really need the doctype? */
1457 "<!DOCTYPE " XBEL_DTD_NICK "\n"
1458 " PUBLIC \"" XBEL_DTD_SYSTEM "\"\n"
1459 " \"" XBEL_DTD_URI "\">\n"
1461 "<" XBEL_ROOT_ELEMENT " " XBEL_VERSION_ATTRIBUTE "=\"" XBEL_VERSION "\"\n"
1462 " xmlns:" BOOKMARK_NAMESPACE_NAME "=\"" BOOKMARK_NAMESPACE_URI "\"\n"
1463 " xmlns:" MIME_NAMESPACE_NAME "=\"" MIME_NAMESPACE_URI "\"\n>");
1465 if (bookmark->title)
1467 gchar *escaped_title;
1469 escaped_title = g_markup_escape_text (bookmark->title, -1);
1471 buffer = g_strconcat (" "
1472 "<" XBEL_TITLE_ELEMENT ">",
1474 "</" XBEL_TITLE_ELEMENT ">\n", NULL);
1476 g_string_append (retval, buffer);
1479 g_free (escaped_title);
1482 if (bookmark->description)
1484 gchar *escaped_desc;
1486 escaped_desc = g_markup_escape_text (bookmark->description, -1);
1488 buffer = g_strconcat (" "
1489 "<" XBEL_DESC_ELEMENT ">",
1491 "</" XBEL_DESC_ELEMENT ">\n", NULL);
1492 g_string_append (retval, buffer);
1495 g_free (escaped_desc);
1498 if (!bookmark->items)
1501 retval = g_string_append (retval, "\n");
1503 /* the items are stored in reverse order */
1504 for (l = g_list_last (bookmark->items);
1508 BookmarkItem *item = (BookmarkItem *) l->data;
1511 item_dump = bookmark_item_dump (item);
1515 retval = g_string_append (retval, item_dump);
1521 g_string_append (retval, "</" XBEL_ROOT_ELEMENT ">");
1524 *length = retval->len;
1526 return g_string_free (retval, FALSE);
1533 /* converts a Unix timestamp in a ISO 8601 compliant string; you
1534 * should free the returned string.
1537 timestamp_to_iso8601 (time_t timestamp)
1541 if (timestamp == (time_t) -1)
1542 g_get_current_time (&stamp);
1545 stamp.tv_sec = timestamp;
1549 return g_time_val_to_iso8601 (&stamp);
1553 timestamp_from_iso8601 (const gchar *iso_date)
1557 if (!g_time_val_from_iso8601 (iso_date, &stamp))
1560 return (time_t) stamp.tv_sec;
1563 G_DEFINE_QUARK (g-bookmark-file-error-quark, g_bookmark_file_error)
1565 /********************
1567 ********************/
1570 * g_bookmark_file_new:
1572 * Creates a new empty #GBookmarkFile object.
1574 * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
1575 * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
1578 * Returns: an empty #GBookmarkFile
1583 g_bookmark_file_new (void)
1585 GBookmarkFile *bookmark;
1587 bookmark = g_new (GBookmarkFile, 1);
1589 g_bookmark_file_init (bookmark);
1595 * g_bookmark_file_free:
1596 * @bookmark: a #GBookmarkFile
1598 * Frees a #GBookmarkFile.
1603 g_bookmark_file_free (GBookmarkFile *bookmark)
1608 g_bookmark_file_clear (bookmark);
1614 * g_bookmark_file_load_from_data:
1615 * @bookmark: an empty #GBookmarkFile struct
1616 * @data: desktop bookmarks loaded in memory
1617 * @length: the length of @data in bytes
1618 * @error: return location for a #GError, or %NULL
1620 * Loads a bookmark file from memory into an empty #GBookmarkFile
1621 * structure. If the object cannot be created then @error is set to a
1622 * #GBookmarkFileError.
1624 * Returns: %TRUE if a desktop bookmark could be loaded.
1629 g_bookmark_file_load_from_data (GBookmarkFile *bookmark,
1634 GError *parse_error;
1637 g_return_val_if_fail (bookmark != NULL, FALSE);
1639 if (length == (gsize) -1)
1640 length = strlen (data);
1642 if (bookmark->items)
1644 g_bookmark_file_clear (bookmark);
1645 g_bookmark_file_init (bookmark);
1649 retval = g_bookmark_file_parse (bookmark, data, length, &parse_error);
1652 g_propagate_error (error, parse_error);
1658 * g_bookmark_file_load_from_file:
1659 * @bookmark: an empty #GBookmarkFile struct
1660 * @filename: the path of a filename to load, in the GLib file name encoding
1661 * @error: return location for a #GError, or %NULL
1663 * Loads a desktop bookmark file into an empty #GBookmarkFile structure.
1664 * If the file could not be loaded then @error is set to either a #GFileError
1665 * or #GBookmarkFileError.
1667 * Returns: %TRUE if a desktop bookmark file could be loaded
1672 g_bookmark_file_load_from_file (GBookmarkFile *bookmark,
1673 const gchar *filename,
1681 g_return_val_if_fail (bookmark != NULL, FALSE);
1682 g_return_val_if_fail (filename != NULL, FALSE);
1685 g_file_get_contents (filename, &buffer, &len, &read_error);
1688 g_propagate_error (error, read_error);
1694 retval = g_bookmark_file_load_from_data (bookmark,
1700 g_propagate_error (error, read_error);
1713 /* Iterates through all the directories in *dirs trying to
1714 * find file. When it successfully locates file, returns a
1715 * string its absolute path. It also leaves the unchecked
1716 * directories in *dirs. You should free the returned string
1718 * Adapted from gkeyfile.c
1721 find_file_in_data_dirs (const gchar *file,
1725 gchar **data_dirs, *data_dir, *path;
1734 while (data_dirs && (data_dir = *data_dirs) && !path)
1736 gchar *candidate_file, *sub_dir;
1738 candidate_file = (gchar *) file;
1739 sub_dir = g_strdup ("");
1740 while (candidate_file != NULL && !path)
1744 path = g_build_filename (data_dir, sub_dir,
1745 candidate_file, NULL);
1747 candidate_file = strchr (candidate_file, '-');
1749 if (candidate_file == NULL)
1755 sub_dir = g_strndup (file, candidate_file - file - 1);
1757 for (p = sub_dir; *p != '\0'; p++)
1760 *p = G_DIR_SEPARATOR;
1771 g_set_error_literal (error, G_BOOKMARK_FILE_ERROR,
1772 G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND,
1773 _("No valid bookmark file found in data dirs"));
1783 * g_bookmark_file_load_from_data_dirs:
1784 * @bookmark: a #GBookmarkFile
1785 * @file: a relative path to a filename to open and parse
1786 * @full_path: (allow-none): return location for a string containing the full path
1787 * of the file, or %NULL
1788 * @error: return location for a #GError, or %NULL
1790 * This function looks for a desktop bookmark file named @file in the
1791 * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
1792 * loads the file into @bookmark and returns the file's full path in
1793 * @full_path. If the file could not be loaded then an %error is
1794 * set to either a #GFileError or #GBookmarkFileError.
1796 * Returns: %TRUE if a key file could be loaded, %FALSE otherwise
1801 g_bookmark_file_load_from_data_dirs (GBookmarkFile *bookmark,
1806 GError *file_error = NULL;
1807 gchar **all_data_dirs, **data_dirs;
1808 const gchar *user_data_dir;
1809 const gchar * const * system_data_dirs;
1812 gboolean found_file;
1814 g_return_val_if_fail (bookmark != NULL, FALSE);
1815 g_return_val_if_fail (!g_path_is_absolute (file), FALSE);
1817 user_data_dir = g_get_user_data_dir ();
1818 system_data_dirs = g_get_system_data_dirs ();
1819 all_data_dirs = g_new0 (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2);
1822 all_data_dirs[i++] = g_strdup (user_data_dir);
1825 while (system_data_dirs[j] != NULL)
1826 all_data_dirs[i++] = g_strdup (system_data_dirs[j++]);
1829 data_dirs = all_data_dirs;
1831 while (*data_dirs != NULL && !found_file)
1833 g_free (output_path);
1835 output_path = find_file_in_data_dirs (file, &data_dirs, &file_error);
1839 g_propagate_error (error, file_error);
1843 found_file = g_bookmark_file_load_from_file (bookmark,
1848 g_propagate_error (error, file_error);
1853 if (found_file && full_path)
1854 *full_path = output_path;
1856 g_free (output_path);
1858 g_strfreev (all_data_dirs);
1865 * g_bookmark_file_to_data:
1866 * @bookmark: a #GBookmarkFile
1867 * @length: (allow-none) (out): return location for the length of the returned string, or %NULL
1868 * @error: return location for a #GError, or %NULL
1870 * This function outputs @bookmark as a string.
1872 * Returns: a newly allocated string holding
1873 * the contents of the #GBookmarkFile
1878 g_bookmark_file_to_data (GBookmarkFile *bookmark,
1882 GError *write_error = NULL;
1885 g_return_val_if_fail (bookmark != NULL, NULL);
1887 retval = g_bookmark_file_dump (bookmark, length, &write_error);
1890 g_propagate_error (error, write_error);
1899 * g_bookmark_file_to_file:
1900 * @bookmark: a #GBookmarkFile
1901 * @filename: path of the output file
1902 * @error: return location for a #GError, or %NULL
1904 * This function outputs @bookmark into a file. The write process is
1905 * guaranteed to be atomic by using g_file_set_contents() internally.
1907 * Returns: %TRUE if the file was successfully written.
1912 g_bookmark_file_to_file (GBookmarkFile *bookmark,
1913 const gchar *filename,
1917 GError *data_error, *write_error;
1921 g_return_val_if_fail (bookmark != NULL, FALSE);
1922 g_return_val_if_fail (filename != NULL, FALSE);
1925 data = g_bookmark_file_to_data (bookmark, &len, &data_error);
1928 g_propagate_error (error, data_error);
1934 g_file_set_contents (filename, data, len, &write_error);
1937 g_propagate_error (error, write_error);
1949 static BookmarkItem *
1950 g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
1953 g_warn_if_fail (bookmark != NULL && uri != NULL);
1955 return g_hash_table_lookup (bookmark->items_by_uri, uri);
1958 /* this function adds a new item to the list */
1960 g_bookmark_file_add_item (GBookmarkFile *bookmark,
1964 g_warn_if_fail (bookmark != NULL);
1965 g_warn_if_fail (item != NULL);
1967 /* this should never happen; and if it does, then we are
1968 * screwing up something big time.
1970 if (G_UNLIKELY (g_bookmark_file_has_item (bookmark, item->uri)))
1972 g_set_error (error, G_BOOKMARK_FILE_ERROR,
1973 G_BOOKMARK_FILE_ERROR_INVALID_URI,
1974 _("A bookmark for URI '%s' already exists"),
1979 bookmark->items = g_list_prepend (bookmark->items, item);
1981 g_hash_table_replace (bookmark->items_by_uri,
1985 if (item->added == (time_t) -1)
1986 item->added = time (NULL);
1988 if (item->modified == (time_t) -1)
1989 item->modified = time (NULL);
1993 * g_bookmark_file_remove_item:
1994 * @bookmark: a #GBookmarkFile
1996 * @error: return location for a #GError, or %NULL
1998 * Removes the bookmark for @uri from the bookmark file @bookmark.
2000 * Returns: %TRUE if the bookmark was removed successfully.
2005 g_bookmark_file_remove_item (GBookmarkFile *bookmark,
2011 g_return_val_if_fail (bookmark != NULL, FALSE);
2012 g_return_val_if_fail (uri != NULL, FALSE);
2014 item = g_bookmark_file_lookup_item (bookmark, uri);
2018 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2019 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2020 _("No bookmark found for URI '%s'"),
2025 bookmark->items = g_list_remove (bookmark->items, item);
2026 g_hash_table_remove (bookmark->items_by_uri, item->uri);
2028 bookmark_item_free (item);
2034 * g_bookmark_file_has_item:
2035 * @bookmark: a #GBookmarkFile
2038 * Looks whether the desktop bookmark has an item with its URI set to @uri.
2040 * Returns: %TRUE if @uri is inside @bookmark, %FALSE otherwise
2045 g_bookmark_file_has_item (GBookmarkFile *bookmark,
2048 g_return_val_if_fail (bookmark != NULL, FALSE);
2049 g_return_val_if_fail (uri != NULL, FALSE);
2051 return (NULL != g_hash_table_lookup (bookmark->items_by_uri, uri));
2055 * g_bookmark_file_get_uris:
2056 * @bookmark: a #GBookmarkFile
2057 * @length: (allow-none) (out): return location for the number of returned URIs, or %NULL
2059 * Returns all URIs of the bookmarks in the bookmark file @bookmark.
2060 * The array of returned URIs will be %NULL-terminated, so @length may
2061 * optionally be %NULL.
2063 * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings.
2064 * Use g_strfreev() to free it.
2069 g_bookmark_file_get_uris (GBookmarkFile *bookmark,
2076 g_return_val_if_fail (bookmark != NULL, NULL);
2078 n_items = g_list_length (bookmark->items);
2079 uris = g_new0 (gchar *, n_items + 1);
2081 /* the items are stored in reverse order, so we walk the list backward */
2082 for (l = g_list_last (bookmark->items), i = 0; l != NULL; l = l->prev)
2084 BookmarkItem *item = (BookmarkItem *) l->data;
2086 g_warn_if_fail (item != NULL);
2088 uris[i++] = g_strdup (item->uri);
2099 * g_bookmark_file_set_title:
2100 * @bookmark: a #GBookmarkFile
2101 * @uri: (allow-none): a valid URI or %NULL
2102 * @title: a UTF-8 encoded string
2104 * Sets @title as the title of the bookmark for @uri inside the
2105 * bookmark file @bookmark.
2107 * If @uri is %NULL, the title of @bookmark is set.
2109 * If a bookmark for @uri cannot be found then it is created.
2114 g_bookmark_file_set_title (GBookmarkFile *bookmark,
2118 g_return_if_fail (bookmark != NULL);
2122 g_free (bookmark->title);
2123 bookmark->title = g_strdup (title);
2129 item = g_bookmark_file_lookup_item (bookmark, uri);
2132 item = bookmark_item_new (uri);
2133 g_bookmark_file_add_item (bookmark, item, NULL);
2136 g_free (item->title);
2137 item->title = g_strdup (title);
2139 item->modified = time (NULL);
2144 * g_bookmark_file_get_title:
2145 * @bookmark: a #GBookmarkFile
2146 * @uri: (allow-none): a valid URI or %NULL
2147 * @error: return location for a #GError, or %NULL
2149 * Returns the title of the bookmark for @uri.
2151 * If @uri is %NULL, the title of @bookmark is returned.
2153 * In the event the URI cannot be found, %NULL is returned and
2154 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2156 * Returns: a newly allocated string or %NULL if the specified
2157 * URI cannot be found.
2162 g_bookmark_file_get_title (GBookmarkFile *bookmark,
2168 g_return_val_if_fail (bookmark != NULL, NULL);
2171 return g_strdup (bookmark->title);
2173 item = g_bookmark_file_lookup_item (bookmark, uri);
2176 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2177 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2178 _("No bookmark found for URI '%s'"),
2183 return g_strdup (item->title);
2187 * g_bookmark_file_set_description:
2188 * @bookmark: a #GBookmarkFile
2189 * @uri: (allow-none): a valid URI or %NULL
2190 * @description: a string
2192 * Sets @description as the description of the bookmark for @uri.
2194 * If @uri is %NULL, the description of @bookmark is set.
2196 * If a bookmark for @uri cannot be found then it is created.
2201 g_bookmark_file_set_description (GBookmarkFile *bookmark,
2203 const gchar *description)
2205 g_return_if_fail (bookmark != NULL);
2209 g_free (bookmark->description);
2210 bookmark->description = g_strdup (description);
2216 item = g_bookmark_file_lookup_item (bookmark, uri);
2219 item = bookmark_item_new (uri);
2220 g_bookmark_file_add_item (bookmark, item, NULL);
2223 g_free (item->description);
2224 item->description = g_strdup (description);
2226 item->modified = time (NULL);
2231 * g_bookmark_file_get_description:
2232 * @bookmark: a #GBookmarkFile
2234 * @error: return location for a #GError, or %NULL
2236 * Retrieves the description of the bookmark for @uri.
2238 * In the event the URI cannot be found, %NULL is returned and
2239 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2241 * Returns: a newly allocated string or %NULL if the specified
2242 * URI cannot be found.
2247 g_bookmark_file_get_description (GBookmarkFile *bookmark,
2253 g_return_val_if_fail (bookmark != NULL, NULL);
2256 return g_strdup (bookmark->description);
2258 item = g_bookmark_file_lookup_item (bookmark, uri);
2261 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2262 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2263 _("No bookmark found for URI '%s'"),
2268 return g_strdup (item->description);
2272 * g_bookmark_file_set_mime_type:
2273 * @bookmark: a #GBookmarkFile
2275 * @mime_type: a MIME type
2277 * Sets @mime_type as the MIME type of the bookmark for @uri.
2279 * If a bookmark for @uri cannot be found then it is created.
2284 g_bookmark_file_set_mime_type (GBookmarkFile *bookmark,
2286 const gchar *mime_type)
2290 g_return_if_fail (bookmark != NULL);
2291 g_return_if_fail (uri != NULL);
2292 g_return_if_fail (mime_type != NULL);
2294 item = g_bookmark_file_lookup_item (bookmark, uri);
2297 item = bookmark_item_new (uri);
2298 g_bookmark_file_add_item (bookmark, item, NULL);
2301 if (!item->metadata)
2302 item->metadata = bookmark_metadata_new ();
2304 g_free (item->metadata->mime_type);
2306 item->metadata->mime_type = g_strdup (mime_type);
2307 item->modified = time (NULL);
2311 * g_bookmark_file_get_mime_type:
2312 * @bookmark: a #GBookmarkFile
2314 * @error: return location for a #GError, or %NULL
2316 * Retrieves the MIME type of the resource pointed by @uri.
2318 * In the event the URI cannot be found, %NULL is returned and
2319 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
2320 * event that the MIME type cannot be found, %NULL is returned and
2321 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2323 * Returns: a newly allocated string or %NULL if the specified
2324 * URI cannot be found.
2329 g_bookmark_file_get_mime_type (GBookmarkFile *bookmark,
2335 g_return_val_if_fail (bookmark != NULL, NULL);
2336 g_return_val_if_fail (uri != NULL, NULL);
2338 item = g_bookmark_file_lookup_item (bookmark, uri);
2341 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2342 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2343 _("No bookmark found for URI '%s'"),
2348 if (!item->metadata)
2350 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2351 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2352 _("No MIME type defined in the bookmark for URI '%s'"),
2357 return g_strdup (item->metadata->mime_type);
2361 * g_bookmark_file_set_is_private:
2362 * @bookmark: a #GBookmarkFile
2364 * @is_private: %TRUE if the bookmark should be marked as private
2366 * Sets the private flag of the bookmark for @uri.
2368 * If a bookmark for @uri cannot be found then it is created.
2373 g_bookmark_file_set_is_private (GBookmarkFile *bookmark,
2375 gboolean is_private)
2379 g_return_if_fail (bookmark != NULL);
2380 g_return_if_fail (uri != NULL);
2382 item = g_bookmark_file_lookup_item (bookmark, uri);
2385 item = bookmark_item_new (uri);
2386 g_bookmark_file_add_item (bookmark, item, NULL);
2389 if (!item->metadata)
2390 item->metadata = bookmark_metadata_new ();
2392 item->metadata->is_private = (is_private == TRUE);
2393 item->modified = time (NULL);
2397 * g_bookmark_file_get_is_private:
2398 * @bookmark: a #GBookmarkFile
2400 * @error: return location for a #GError, or %NULL
2402 * Gets whether the private flag of the bookmark for @uri is set.
2404 * In the event the URI cannot be found, %FALSE is returned and
2405 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
2406 * event that the private flag cannot be found, %FALSE is returned and
2407 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2409 * Returns: %TRUE if the private flag is set, %FALSE otherwise.
2414 g_bookmark_file_get_is_private (GBookmarkFile *bookmark,
2420 g_return_val_if_fail (bookmark != NULL, FALSE);
2421 g_return_val_if_fail (uri != NULL, FALSE);
2423 item = g_bookmark_file_lookup_item (bookmark, uri);
2426 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2427 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2428 _("No bookmark found for URI '%s'"),
2433 if (!item->metadata)
2435 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2436 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2437 _("No private flag has been defined in bookmark for URI '%s'"),
2442 return item->metadata->is_private;
2446 * g_bookmark_file_set_added:
2447 * @bookmark: a #GBookmarkFile
2449 * @added: a timestamp or -1 to use the current time
2451 * Sets the time the bookmark for @uri was added into @bookmark.
2453 * If no bookmark for @uri is found then it is created.
2458 g_bookmark_file_set_added (GBookmarkFile *bookmark,
2464 g_return_if_fail (bookmark != NULL);
2465 g_return_if_fail (uri != NULL);
2467 item = g_bookmark_file_lookup_item (bookmark, uri);
2470 item = bookmark_item_new (uri);
2471 g_bookmark_file_add_item (bookmark, item, NULL);
2474 if (added == (time_t) -1)
2477 item->added = added;
2478 item->modified = added;
2482 * g_bookmark_file_get_added:
2483 * @bookmark: a #GBookmarkFile
2485 * @error: return location for a #GError, or %NULL
2487 * Gets the time the bookmark for @uri was added to @bookmark
2489 * In the event the URI cannot be found, -1 is returned and
2490 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2492 * Returns: a timestamp
2497 g_bookmark_file_get_added (GBookmarkFile *bookmark,
2503 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2504 g_return_val_if_fail (uri != NULL, (time_t) -1);
2506 item = g_bookmark_file_lookup_item (bookmark, uri);
2509 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2510 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2511 _("No bookmark found for URI '%s'"),
2520 * g_bookmark_file_set_modified:
2521 * @bookmark: a #GBookmarkFile
2523 * @modified: a timestamp or -1 to use the current time
2525 * Sets the last time the bookmark for @uri was last modified.
2527 * If no bookmark for @uri is found then it is created.
2529 * The "modified" time should only be set when the bookmark's meta-data
2530 * was actually changed. Every function of #GBookmarkFile that
2531 * modifies a bookmark also changes the modification time, except for
2532 * g_bookmark_file_set_visited().
2537 g_bookmark_file_set_modified (GBookmarkFile *bookmark,
2543 g_return_if_fail (bookmark != NULL);
2544 g_return_if_fail (uri != NULL);
2546 item = g_bookmark_file_lookup_item (bookmark, uri);
2549 item = bookmark_item_new (uri);
2550 g_bookmark_file_add_item (bookmark, item, NULL);
2553 if (modified == (time_t) -1)
2556 item->modified = modified;
2560 * g_bookmark_file_get_modified:
2561 * @bookmark: a #GBookmarkFile
2563 * @error: return location for a #GError, or %NULL
2565 * Gets the time when the bookmark for @uri was last modified.
2567 * In the event the URI cannot be found, -1 is returned and
2568 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2570 * Returns: a timestamp
2575 g_bookmark_file_get_modified (GBookmarkFile *bookmark,
2581 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2582 g_return_val_if_fail (uri != NULL, (time_t) -1);
2584 item = g_bookmark_file_lookup_item (bookmark, uri);
2587 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2588 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2589 _("No bookmark found for URI '%s'"),
2594 return item->modified;
2598 * g_bookmark_file_set_visited:
2599 * @bookmark: a #GBookmarkFile
2601 * @visited: a timestamp or -1 to use the current time
2603 * Sets the time the bookmark for @uri was last visited.
2605 * If no bookmark for @uri is found then it is created.
2607 * The "visited" time should only be set if the bookmark was launched,
2608 * either using the command line retrieved by g_bookmark_file_get_app_info()
2609 * or by the default application for the bookmark's MIME type, retrieved
2610 * using g_bookmark_file_get_mime_type(). Changing the "visited" time
2611 * does not affect the "modified" time.
2616 g_bookmark_file_set_visited (GBookmarkFile *bookmark,
2622 g_return_if_fail (bookmark != NULL);
2623 g_return_if_fail (uri != NULL);
2625 item = g_bookmark_file_lookup_item (bookmark, uri);
2628 item = bookmark_item_new (uri);
2629 g_bookmark_file_add_item (bookmark, item, NULL);
2632 if (visited == (time_t) -1)
2635 item->visited = visited;
2639 * g_bookmark_file_get_visited:
2640 * @bookmark: a #GBookmarkFile
2642 * @error: return location for a #GError, or %NULL
2644 * Gets the time the bookmark for @uri was last visited.
2646 * In the event the URI cannot be found, -1 is returned and
2647 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2649 * Returns: a timestamp.
2654 g_bookmark_file_get_visited (GBookmarkFile *bookmark,
2660 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2661 g_return_val_if_fail (uri != NULL, (time_t) -1);
2663 item = g_bookmark_file_lookup_item (bookmark, uri);
2666 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2667 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2668 _("No bookmark found for URI '%s'"),
2673 return item->visited;
2677 * g_bookmark_file_has_group:
2678 * @bookmark: a #GBookmarkFile
2680 * @group: the group name to be searched
2681 * @error: return location for a #GError, or %NULL
2683 * Checks whether @group appears in the list of groups to which
2684 * the bookmark for @uri belongs to.
2686 * In the event the URI cannot be found, %FALSE is returned and
2687 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2689 * Returns: %TRUE if @group was found.
2694 g_bookmark_file_has_group (GBookmarkFile *bookmark,
2702 g_return_val_if_fail (bookmark != NULL, FALSE);
2703 g_return_val_if_fail (uri != NULL, FALSE);
2705 item = g_bookmark_file_lookup_item (bookmark, uri);
2708 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2709 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2710 _("No bookmark found for URI '%s'"),
2715 if (!item->metadata)
2718 for (l = item->metadata->groups; l != NULL; l = l->next)
2720 if (strcmp (l->data, group) == 0)
2729 * g_bookmark_file_add_group:
2730 * @bookmark: a #GBookmarkFile
2732 * @group: the group name to be added
2734 * Adds @group to the list of groups to which the bookmark for @uri
2737 * If no bookmark for @uri is found then it is created.
2742 g_bookmark_file_add_group (GBookmarkFile *bookmark,
2748 g_return_if_fail (bookmark != NULL);
2749 g_return_if_fail (uri != NULL);
2750 g_return_if_fail (group != NULL && group[0] != '\0');
2752 item = g_bookmark_file_lookup_item (bookmark, uri);
2755 item = bookmark_item_new (uri);
2756 g_bookmark_file_add_item (bookmark, item, NULL);
2759 if (!item->metadata)
2760 item->metadata = bookmark_metadata_new ();
2762 if (!g_bookmark_file_has_group (bookmark, uri, group, NULL))
2764 item->metadata->groups = g_list_prepend (item->metadata->groups,
2767 item->modified = time (NULL);
2772 * g_bookmark_file_remove_group:
2773 * @bookmark: a #GBookmarkFile
2775 * @group: the group name to be removed
2776 * @error: return location for a #GError, or %NULL
2778 * Removes @group from the list of groups to which the bookmark
2779 * for @uri belongs to.
2781 * In the event the URI cannot be found, %FALSE is returned and
2782 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2783 * In the event no group was defined, %FALSE is returned and
2784 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2786 * Returns: %TRUE if @group was successfully removed.
2791 g_bookmark_file_remove_group (GBookmarkFile *bookmark,
2799 g_return_val_if_fail (bookmark != NULL, FALSE);
2800 g_return_val_if_fail (uri != NULL, FALSE);
2802 item = g_bookmark_file_lookup_item (bookmark, uri);
2805 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2806 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2807 _("No bookmark found for URI '%s'"),
2812 if (!item->metadata)
2814 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2815 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2816 _("No groups set in bookmark for URI '%s'"),
2821 for (l = item->metadata->groups; l != NULL; l = l->next)
2823 if (strcmp (l->data, group) == 0)
2825 item->metadata->groups = g_list_remove_link (item->metadata->groups, l);
2829 item->modified = time (NULL);
2839 * g_bookmark_file_set_groups:
2840 * @bookmark: a #GBookmarkFile
2841 * @uri: an item's URI
2842 * @groups: (allow-none): an array of group names, or %NULL to remove all groups
2843 * @length: number of group name values in @groups
2845 * Sets a list of group names for the item with URI @uri. Each previously
2846 * set group name list is removed.
2848 * If @uri cannot be found then an item for it is created.
2853 g_bookmark_file_set_groups (GBookmarkFile *bookmark,
2855 const gchar **groups,
2861 g_return_if_fail (bookmark != NULL);
2862 g_return_if_fail (uri != NULL);
2863 g_return_if_fail (groups != NULL);
2865 item = g_bookmark_file_lookup_item (bookmark, uri);
2868 item = bookmark_item_new (uri);
2869 g_bookmark_file_add_item (bookmark, item, NULL);
2872 if (!item->metadata)
2873 item->metadata = bookmark_metadata_new ();
2875 g_list_free_full (item->metadata->groups, g_free);
2876 item->metadata->groups = NULL;
2880 for (i = 0; groups[i] != NULL && i < length; i++)
2881 item->metadata->groups = g_list_append (item->metadata->groups,
2882 g_strdup (groups[i]));
2885 item->modified = time (NULL);
2889 * g_bookmark_file_get_groups:
2890 * @bookmark: a #GBookmarkFile
2892 * @length: (allow-none) (out): return location for the length of the returned string, or %NULL
2893 * @error: return location for a #GError, or %NULL
2895 * Retrieves the list of group names of the bookmark for @uri.
2897 * In the event the URI cannot be found, %NULL is returned and
2898 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2900 * The returned array is %NULL terminated, so @length may optionally
2903 * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of group names.
2904 * Use g_strfreev() to free it.
2909 g_bookmark_file_get_groups (GBookmarkFile *bookmark,
2919 g_return_val_if_fail (bookmark != NULL, NULL);
2920 g_return_val_if_fail (uri != NULL, NULL);
2922 item = g_bookmark_file_lookup_item (bookmark, uri);
2925 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2926 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2927 _("No bookmark found for URI '%s'"),
2932 if (!item->metadata)
2940 len = g_list_length (item->metadata->groups);
2941 retval = g_new0 (gchar *, len + 1);
2942 for (l = g_list_last (item->metadata->groups), i = 0;
2946 gchar *group_name = (gchar *) l->data;
2948 g_warn_if_fail (group_name != NULL);
2950 retval[i++] = g_strdup (group_name);
2961 * g_bookmark_file_add_application:
2962 * @bookmark: a #GBookmarkFile
2964 * @name: (allow-none): the name of the application registering the bookmark
2966 * @exec: (allow-none): command line to be used to launch the bookmark or %NULL
2968 * Adds the application with @name and @exec to the list of
2969 * applications that have registered a bookmark for @uri into
2972 * Every bookmark inside a #GBookmarkFile must have at least an
2973 * application registered. Each application must provide a name, a
2974 * command line useful for launching the bookmark, the number of times
2975 * the bookmark has been registered by the application and the last
2976 * time the application registered this bookmark.
2978 * If @name is %NULL, the name of the application will be the
2979 * same returned by g_get_application_name(); if @exec is %NULL, the
2980 * command line will be a composition of the program name as
2981 * returned by g_get_prgname() and the "\%u" modifier, which will be
2982 * expanded to the bookmark's URI.
2984 * This function will automatically take care of updating the
2985 * registrations count and timestamping in case an application
2986 * with the same @name had already registered a bookmark for
2987 * @uri inside @bookmark.
2989 * If no bookmark for @uri is found, one is created.
2994 g_bookmark_file_add_application (GBookmarkFile *bookmark,
3000 gchar *app_name, *app_exec;
3002 g_return_if_fail (bookmark != NULL);
3003 g_return_if_fail (uri != NULL);
3005 item = g_bookmark_file_lookup_item (bookmark, uri);
3008 item = bookmark_item_new (uri);
3009 g_bookmark_file_add_item (bookmark, item, NULL);
3012 if (name && name[0] != '\0')
3013 app_name = g_strdup (name);
3015 app_name = g_strdup (g_get_application_name ());
3017 if (exec && exec[0] != '\0')
3018 app_exec = g_strdup (exec);
3020 app_exec = g_strjoin (" ", g_get_prgname(), "%u", NULL);
3022 g_bookmark_file_set_app_info (bookmark, uri,
3034 * g_bookmark_file_remove_application:
3035 * @bookmark: a #GBookmarkFile
3037 * @name: the name of the application
3038 * @error: return location for a #GError or %NULL
3040 * Removes application registered with @name from the list of applications
3041 * that have registered a bookmark for @uri inside @bookmark.
3043 * In the event the URI cannot be found, %FALSE is returned and
3044 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3045 * In the event that no application with name @app_name has registered
3046 * a bookmark for @uri, %FALSE is returned and error is set to
3047 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
3049 * Returns: %TRUE if the application was successfully removed.
3054 g_bookmark_file_remove_application (GBookmarkFile *bookmark,
3062 g_return_val_if_fail (bookmark != NULL, FALSE);
3063 g_return_val_if_fail (uri != NULL, FALSE);
3064 g_return_val_if_fail (name != NULL, FALSE);
3067 retval = g_bookmark_file_set_app_info (bookmark, uri,
3075 g_propagate_error (error, set_error);
3084 * g_bookmark_file_has_application:
3085 * @bookmark: a #GBookmarkFile
3087 * @name: the name of the application
3088 * @error: return location for a #GError or %NULL
3090 * Checks whether the bookmark for @uri inside @bookmark has been
3091 * registered by application @name.
3093 * In the event the URI cannot be found, %FALSE is returned and
3094 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3096 * Returns: %TRUE if the application @name was found
3101 g_bookmark_file_has_application (GBookmarkFile *bookmark,
3108 g_return_val_if_fail (bookmark != NULL, FALSE);
3109 g_return_val_if_fail (uri != NULL, FALSE);
3110 g_return_val_if_fail (name != NULL, FALSE);
3112 item = g_bookmark_file_lookup_item (bookmark, uri);
3115 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3116 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3117 _("No bookmark found for URI '%s'"),
3122 return (NULL != bookmark_item_lookup_app_info (item, name));
3126 * g_bookmark_file_set_app_info:
3127 * @bookmark: a #GBookmarkFile
3129 * @name: an application's name
3130 * @exec: an application's command line
3131 * @count: the number of registrations done for this application
3132 * @stamp: the time of the last registration for this application
3133 * @error: return location for a #GError or %NULL
3135 * Sets the meta-data of application @name inside the list of
3136 * applications that have registered a bookmark for @uri inside
3139 * You should rarely use this function; use g_bookmark_file_add_application()
3140 * and g_bookmark_file_remove_application() instead.
3142 * @name can be any UTF-8 encoded string used to identify an
3144 * @exec can have one of these two modifiers: "\%f", which will
3145 * be expanded as the local file name retrieved from the bookmark's
3146 * URI; "\%u", which will be expanded as the bookmark's URI.
3147 * The expansion is done automatically when retrieving the stored
3148 * command line using the g_bookmark_file_get_app_info() function.
3149 * @count is the number of times the application has registered the
3150 * bookmark; if is < 0, the current registration count will be increased
3151 * by one, if is 0, the application with @name will be removed from
3152 * the list of registered applications.
3153 * @stamp is the Unix time of the last registration; if it is -1, the
3154 * current time will be used.
3156 * If you try to remove an application by setting its registration count to
3157 * zero, and no bookmark for @uri is found, %FALSE is returned and
3158 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
3159 * in the event that no application @name has registered a bookmark
3160 * for @uri, %FALSE is returned and error is set to
3161 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark
3162 * for @uri is found, one is created.
3164 * Returns: %TRUE if the application's meta-data was successfully
3170 g_bookmark_file_set_app_info (GBookmarkFile *bookmark,
3179 BookmarkAppInfo *ai;
3181 g_return_val_if_fail (bookmark != NULL, FALSE);
3182 g_return_val_if_fail (uri != NULL, FALSE);
3183 g_return_val_if_fail (name != NULL, FALSE);
3184 g_return_val_if_fail (exec != NULL, FALSE);
3186 item = g_bookmark_file_lookup_item (bookmark, uri);
3191 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3192 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3193 _("No bookmark found for URI '%s'"),
3199 item = bookmark_item_new (uri);
3200 g_bookmark_file_add_item (bookmark, item, NULL);
3204 if (!item->metadata)
3205 item->metadata = bookmark_metadata_new ();
3207 ai = bookmark_item_lookup_app_info (item, name);
3212 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3213 G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3214 _("No application with name '%s' registered a bookmark for '%s'"),
3221 ai = bookmark_app_info_new (name);
3223 item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
3224 g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
3230 item->metadata->applications = g_list_remove (item->metadata->applications, ai);
3231 g_hash_table_remove (item->metadata->apps_by_name, ai->name);
3232 bookmark_app_info_free (ai);
3234 item->modified = time (NULL);
3243 if (stamp != (time_t) -1)
3246 ai->stamp = time (NULL);
3248 if (exec && exec[0] != '\0')
3251 ai->exec = g_shell_quote (exec);
3254 item->modified = time (NULL);
3259 /* expands the application's command line */
3261 expand_exec_line (const gchar *exec_fmt,
3267 exec = g_string_sized_new (512);
3268 while ((ch = *exec_fmt++) != '\0')
3272 exec = g_string_append_c (exec, ch);
3283 g_string_append (exec, uri);
3288 gchar *file = g_filename_from_uri (uri, NULL, NULL);
3291 g_string_append (exec, file);
3296 g_string_free (exec, TRUE);
3303 exec = g_string_append_c (exec, ch);
3309 return g_string_free (exec, FALSE);
3313 * g_bookmark_file_get_app_info:
3314 * @bookmark: a #GBookmarkFile
3316 * @name: an application's name
3317 * @exec: (allow-none) (out): return location for the command line of the application, or %NULL
3318 * @count: (allow-none) (out): return location for the registration count, or %NULL
3319 * @stamp: (allow-none) (out): return location for the last registration time, or %NULL
3320 * @error: return location for a #GError, or %NULL
3322 * Gets the registration informations of @app_name for the bookmark for
3323 * @uri. See g_bookmark_file_set_app_info() for more informations about
3324 * the returned data.
3326 * The string returned in @app_exec must be freed.
3328 * In the event the URI cannot be found, %FALSE is returned and
3329 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
3330 * event that no application with name @app_name has registered a bookmark
3331 * for @uri, %FALSE is returned and error is set to
3332 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
3333 * the command line fails, an error of the #G_SHELL_ERROR domain is
3334 * set and %FALSE is returned.
3336 * Returns: %TRUE on success.
3341 g_bookmark_file_get_app_info (GBookmarkFile *bookmark,
3350 BookmarkAppInfo *ai;
3352 g_return_val_if_fail (bookmark != NULL, FALSE);
3353 g_return_val_if_fail (uri != NULL, FALSE);
3354 g_return_val_if_fail (name != NULL, FALSE);
3356 item = g_bookmark_file_lookup_item (bookmark, uri);
3359 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3360 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3361 _("No bookmark found for URI '%s'"),
3366 ai = bookmark_item_lookup_app_info (item, name);
3369 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3370 G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3371 _("No application with name '%s' registered a bookmark for '%s'"),
3379 GError *unquote_error = NULL;
3380 gchar *command_line;
3382 command_line = g_shell_unquote (ai->exec, &unquote_error);
3385 g_propagate_error (error, unquote_error);
3389 *exec = expand_exec_line (command_line, uri);
3392 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3393 G_BOOKMARK_FILE_ERROR_INVALID_URI,
3394 _("Failed to expand exec line '%s' with URI '%s'"),
3396 g_free (command_line);
3401 g_free (command_line);
3414 * g_bookmark_file_get_applications:
3415 * @bookmark: a #GBookmarkFile
3417 * @length: (allow-none) (out): return location of the length of the returned list, or %NULL
3418 * @error: return location for a #GError, or %NULL
3420 * Retrieves the names of the applications that have registered the
3421 * bookmark for @uri.
3423 * In the event the URI cannot be found, %NULL is returned and
3424 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3426 * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings.
3427 * Use g_strfreev() to free it.
3432 g_bookmark_file_get_applications (GBookmarkFile *bookmark,
3442 g_return_val_if_fail (bookmark != NULL, NULL);
3443 g_return_val_if_fail (uri != NULL, NULL);
3445 item = g_bookmark_file_lookup_item (bookmark, uri);
3448 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3449 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3450 _("No bookmark found for URI '%s'"),
3455 if (!item->metadata)
3463 n_apps = g_list_length (item->metadata->applications);
3464 apps = g_new0 (gchar *, n_apps + 1);
3466 for (l = g_list_last (item->metadata->applications), i = 0;
3470 BookmarkAppInfo *ai;
3472 ai = (BookmarkAppInfo *) l->data;
3474 g_warn_if_fail (ai != NULL);
3475 g_warn_if_fail (ai->name != NULL);
3477 apps[i++] = g_strdup (ai->name);
3488 * g_bookmark_file_get_size:
3489 * @bookmark: a #GBookmarkFile
3491 * Gets the number of bookmarks inside @bookmark.
3493 * Returns: the number of bookmarks
3498 g_bookmark_file_get_size (GBookmarkFile *bookmark)
3500 g_return_val_if_fail (bookmark != NULL, 0);
3502 return g_list_length (bookmark->items);
3506 * g_bookmark_file_move_item:
3507 * @bookmark: a #GBookmarkFile
3508 * @old_uri: a valid URI
3509 * @new_uri: (allow-none): a valid URI, or %NULL
3510 * @error: return location for a #GError or %NULL
3512 * Changes the URI of a bookmark item from @old_uri to @new_uri. Any
3513 * existing bookmark for @new_uri will be overwritten. If @new_uri is
3514 * %NULL, then the bookmark is removed.
3516 * In the event the URI cannot be found, %FALSE is returned and
3517 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3519 * Returns: %TRUE if the URI was successfully changed
3524 g_bookmark_file_move_item (GBookmarkFile *bookmark,
3525 const gchar *old_uri,
3526 const gchar *new_uri,
3531 g_return_val_if_fail (bookmark != NULL, FALSE);
3532 g_return_val_if_fail (old_uri != NULL, FALSE);
3534 item = g_bookmark_file_lookup_item (bookmark, old_uri);
3537 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3538 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3539 _("No bookmark found for URI '%s'"),
3544 if (new_uri && new_uri[0] != '\0')
3546 if (g_bookmark_file_has_item (bookmark, new_uri))
3548 if (!g_bookmark_file_remove_item (bookmark, new_uri, error))
3552 g_hash_table_steal (bookmark->items_by_uri, item->uri);
3555 item->uri = g_strdup (new_uri);
3556 item->modified = time (NULL);
3558 g_hash_table_replace (bookmark->items_by_uri, item->uri, item);
3564 if (!g_bookmark_file_remove_item (bookmark, old_uri, error))
3572 * g_bookmark_file_set_icon:
3573 * @bookmark: a #GBookmarkFile
3575 * @href: (allow-none): the URI of the icon for the bookmark, or %NULL
3576 * @mime_type: the MIME type of the icon for the bookmark
3578 * Sets the icon for the bookmark for @uri. If @href is %NULL, unsets
3579 * the currently set icon. @href can either be a full URL for the icon
3580 * file or the icon name following the Icon Naming specification.
3582 * If no bookmark for @uri is found one is created.
3587 g_bookmark_file_set_icon (GBookmarkFile *bookmark,
3590 const gchar *mime_type)
3594 g_return_if_fail (bookmark != NULL);
3595 g_return_if_fail (uri != NULL);
3597 item = g_bookmark_file_lookup_item (bookmark, uri);
3600 item = bookmark_item_new (uri);
3601 g_bookmark_file_add_item (bookmark, item, NULL);
3604 if (!item->metadata)
3605 item->metadata = bookmark_metadata_new ();
3607 g_free (item->metadata->icon_href);
3608 g_free (item->metadata->icon_mime);
3610 item->metadata->icon_href = g_strdup (href);
3612 if (mime_type && mime_type[0] != '\0')
3613 item->metadata->icon_mime = g_strdup (mime_type);
3615 item->metadata->icon_mime = g_strdup ("application/octet-stream");
3617 item->modified = time (NULL);
3621 * g_bookmark_file_get_icon:
3622 * @bookmark: a #GBookmarkFile
3624 * @href: (allow-none) (out): return location for the icon's location or %NULL
3625 * @mime_type: (allow-none) (out): return location for the icon's MIME type or %NULL
3626 * @error: return location for a #GError or %NULL
3628 * Gets the icon of the bookmark for @uri.
3630 * In the event the URI cannot be found, %FALSE is returned and
3631 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3633 * Returns: %TRUE if the icon for the bookmark for the URI was found.
3634 * You should free the returned strings.
3639 g_bookmark_file_get_icon (GBookmarkFile *bookmark,
3647 g_return_val_if_fail (bookmark != NULL, FALSE);
3648 g_return_val_if_fail (uri != NULL, FALSE);
3650 item = g_bookmark_file_lookup_item (bookmark, uri);
3653 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3654 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3655 _("No bookmark found for URI '%s'"),
3660 if ((!item->metadata) || (!item->metadata->icon_href))
3664 *href = g_strdup (item->metadata->icon_href);
3667 *mime_type = g_strdup (item->metadata->icon_mime);