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"
53 #include "gstrfuncs.h"
59 /* XBEL 1.0 standard entities */
60 #define XBEL_VERSION "1.0"
61 #define XBEL_DTD_NICK "xbel"
62 #define XBEL_DTD_SYSTEM "+//IDN python.org//DTD XML Bookmark " \
63 "Exchange Language 1.0//EN//XML"
65 #define XBEL_DTD_URI "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"
67 #define XBEL_ROOT_ELEMENT "xbel"
68 #define XBEL_FOLDER_ELEMENT "folder" /* unused */
69 #define XBEL_BOOKMARK_ELEMENT "bookmark"
70 #define XBEL_ALIAS_ELEMENT "alias" /* unused */
71 #define XBEL_SEPARATOR_ELEMENT "separator" /* unused */
72 #define XBEL_TITLE_ELEMENT "title"
73 #define XBEL_DESC_ELEMENT "desc"
74 #define XBEL_INFO_ELEMENT "info"
75 #define XBEL_METADATA_ELEMENT "metadata"
77 #define XBEL_VERSION_ATTRIBUTE "version"
78 #define XBEL_FOLDED_ATTRIBUTE "folded" /* unused */
79 #define XBEL_OWNER_ATTRIBUTE "owner"
80 #define XBEL_ADDED_ATTRIBUTE "added"
81 #define XBEL_VISITED_ATTRIBUTE "visited"
82 #define XBEL_MODIFIED_ATTRIBUTE "modified"
83 #define XBEL_ID_ATTRIBUTE "id"
84 #define XBEL_HREF_ATTRIBUTE "href"
85 #define XBEL_REF_ATTRIBUTE "ref" /* unused */
87 #define XBEL_YES_VALUE "yes"
88 #define XBEL_NO_VALUE "no"
90 /* Desktop bookmark spec entities */
91 #define BOOKMARK_METADATA_OWNER "http://freedesktop.org"
93 #define BOOKMARK_NAMESPACE_NAME "bookmark"
94 #define BOOKMARK_NAMESPACE_URI "http://www.freedesktop.org/standards/desktop-bookmarks"
96 #define BOOKMARK_GROUPS_ELEMENT "groups"
97 #define BOOKMARK_GROUP_ELEMENT "group"
98 #define BOOKMARK_APPLICATIONS_ELEMENT "applications"
99 #define BOOKMARK_APPLICATION_ELEMENT "application"
100 #define BOOKMARK_ICON_ELEMENT "icon"
101 #define BOOKMARK_PRIVATE_ELEMENT "private"
103 #define BOOKMARK_NAME_ATTRIBUTE "name"
104 #define BOOKMARK_EXEC_ATTRIBUTE "exec"
105 #define BOOKMARK_COUNT_ATTRIBUTE "count"
106 #define BOOKMARK_TIMESTAMP_ATTRIBUTE "timestamp"
107 #define BOOKMARK_HREF_ATTRIBUTE "href"
108 #define BOOKMARK_TYPE_ATTRIBUTE "type"
110 /* Shared MIME Info entities */
111 #define MIME_NAMESPACE_NAME "mime"
112 #define MIME_NAMESPACE_URI "http://www.freedesktop.org/standards/shared-mime-info"
113 #define MIME_TYPE_ELEMENT "mime-type"
114 #define MIME_TYPE_ATTRIBUTE "type"
117 typedef struct _BookmarkAppInfo BookmarkAppInfo;
118 typedef struct _BookmarkMetadata BookmarkMetadata;
119 typedef struct _BookmarkItem BookmarkItem;
120 typedef struct _ParseData ParseData;
122 struct _BookmarkAppInfo
132 struct _BookmarkMetadata
139 GHashTable *apps_by_name;
144 guint is_private : 1;
158 BookmarkMetadata *metadata;
161 struct _GBookmarkFile
166 /* we store our items in a list and keep a copy inside
167 * an hash table for faster lookup performances
170 GHashTable *items_by_uri;
173 /* parser state machine */
194 static void g_bookmark_file_init (GBookmarkFile *bookmark);
195 static void g_bookmark_file_clear (GBookmarkFile *bookmark);
196 static gboolean g_bookmark_file_parse (GBookmarkFile *bookmark,
200 static gchar * g_bookmark_file_dump (GBookmarkFile *bookmark,
203 static BookmarkItem *g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
205 static void g_bookmark_file_add_item (GBookmarkFile *bookmark,
209 static time_t timestamp_from_iso8601 (const gchar *iso_date);
210 static gchar * timestamp_to_iso8601 (time_t timestamp);
212 /********************************
215 * Application metadata storage *
216 ********************************/
217 static BookmarkAppInfo *
218 bookmark_app_info_new (const gchar *name)
220 BookmarkAppInfo *retval;
222 g_assert (name != NULL);
224 retval = g_slice_new (BookmarkAppInfo);
226 retval->name = g_strdup (name);
229 retval->stamp = time (NULL);
235 bookmark_app_info_free (BookmarkAppInfo *app_info)
241 g_free (app_info->name);
244 g_free (app_info->exec);
246 g_slice_free (BookmarkAppInfo, app_info);
250 bookmark_app_info_dump (BookmarkAppInfo *app_info)
255 g_assert (app_info != NULL);
257 if (app_info->count == 0)
260 name = g_markup_escape_text (app_info->name, -1);
261 exec = g_markup_escape_text (app_info->exec, -1);
263 retval = g_strdup_printf (" <%s:%s %s=\"%s\" %s=\"%s\" %s=\"%ld\" %s=\"%u\"/>\n",
264 BOOKMARK_NAMESPACE_NAME,
265 BOOKMARK_APPLICATION_ELEMENT,
266 BOOKMARK_NAME_ATTRIBUTE, name,
267 BOOKMARK_EXEC_ATTRIBUTE, exec,
268 BOOKMARK_TIMESTAMP_ATTRIBUTE, (time_t) app_info->stamp,
269 BOOKMARK_COUNT_ATTRIBUTE, app_info->count);
278 /***********************
282 ***********************/
283 static BookmarkMetadata *
284 bookmark_metadata_new (void)
286 BookmarkMetadata *retval;
288 retval = g_slice_new (BookmarkMetadata);
290 retval->mime_type = NULL;
292 retval->groups = NULL;
294 retval->applications = NULL;
295 retval->apps_by_name = g_hash_table_new_full (g_str_hash,
300 retval->is_private = FALSE;
302 retval->icon_href = NULL;
303 retval->icon_mime = NULL;
309 bookmark_metadata_free (BookmarkMetadata *metadata)
314 if (metadata->mime_type)
315 g_free (metadata->mime_type);
317 if (metadata->groups)
319 g_list_foreach (metadata->groups,
322 g_list_free (metadata->groups);
325 if (metadata->applications)
327 g_list_foreach (metadata->applications,
328 (GFunc) bookmark_app_info_free,
330 g_list_free (metadata->applications);
332 g_hash_table_destroy (metadata->apps_by_name);
335 if (metadata->icon_href)
336 g_free (metadata->icon_href);
338 if (metadata->icon_mime)
339 g_free (metadata->icon_mime);
341 g_slice_free (BookmarkMetadata, metadata);
345 bookmark_metadata_dump (BookmarkMetadata *metadata)
349 if (!metadata->applications)
352 retval = g_string_new (NULL);
354 /* metadata container */
355 g_string_append_printf (retval,
357 XBEL_METADATA_ELEMENT,
358 XBEL_OWNER_ATTRIBUTE, BOOKMARK_METADATA_OWNER);
361 if (metadata->mime_type)
362 g_string_append_printf (retval,
363 " <%s:%s %s=\"%s\"/>\n",
366 MIME_TYPE_ATTRIBUTE, metadata->mime_type);
368 if (metadata->groups)
372 /* open groups container */
373 g_string_append_printf (retval,
375 BOOKMARK_NAMESPACE_NAME,
376 BOOKMARK_GROUPS_ELEMENT);
378 for (l = g_list_last (metadata->groups); l != NULL; l = l->prev)
382 group_name = g_markup_escape_text ((gchar *) l->data, -1);
383 g_string_append_printf (retval,
384 " <%s:%s>%s</%s:%s>\n",
385 BOOKMARK_NAMESPACE_NAME,
386 BOOKMARK_GROUP_ELEMENT,
388 BOOKMARK_NAMESPACE_NAME,
389 BOOKMARK_GROUP_ELEMENT);
393 /* close groups container */
394 g_string_append_printf (retval,
396 BOOKMARK_NAMESPACE_NAME,
397 BOOKMARK_GROUPS_ELEMENT);
400 if (metadata->applications)
404 /* open applications container */
405 g_string_append_printf (retval,
407 BOOKMARK_NAMESPACE_NAME,
408 BOOKMARK_APPLICATIONS_ELEMENT);
410 for (l = g_list_last (metadata->applications); l != NULL; l = l->prev)
412 BookmarkAppInfo *app_info = (BookmarkAppInfo *) l->data;
415 g_assert (app_info != NULL);
417 app_data = bookmark_app_info_dump (app_info);
421 retval = g_string_append (retval, app_data);
427 /* close applications container */
428 g_string_append_printf (retval,
430 BOOKMARK_NAMESPACE_NAME,
431 BOOKMARK_APPLICATIONS_ELEMENT);
435 if (metadata->icon_href)
437 if (!metadata->icon_mime)
438 metadata->icon_mime = g_strdup ("application/octet-stream");
440 g_string_append_printf (retval,
441 " <%s:%s %s=\"%s\" %s=\"%s\"/>\n",
442 BOOKMARK_NAMESPACE_NAME,
443 BOOKMARK_ICON_ELEMENT,
444 BOOKMARK_HREF_ATTRIBUTE, metadata->icon_href,
445 BOOKMARK_TYPE_ATTRIBUTE, metadata->icon_mime);
449 if (metadata->is_private)
450 g_string_append_printf (retval,
452 BOOKMARK_NAMESPACE_NAME,
453 BOOKMARK_PRIVATE_ELEMENT);
455 /* close metadata container */
456 g_string_append_printf (retval, " </%s>\n", XBEL_METADATA_ELEMENT);
458 return g_string_free (retval, FALSE);
461 /******************************************************
464 * Storage for a single bookmark item inside the list *
465 ******************************************************/
466 static BookmarkItem *
467 bookmark_item_new (const gchar *uri)
471 g_assert (uri != NULL);
473 item = g_slice_new (BookmarkItem);
474 item->uri = g_strdup (uri);
477 item->description = NULL;
479 item->added = (time_t) -1;
480 item->modified = (time_t) -1;
481 item->visited = (time_t) -1;
483 item->metadata = NULL;
489 bookmark_item_free (BookmarkItem *item)
498 g_free (item->title);
500 if (item->description)
501 g_free (item->description);
504 bookmark_metadata_free (item->metadata);
506 g_slice_free (BookmarkItem, item);
510 bookmark_item_dump (BookmarkItem *item)
513 gchar *added, *visited, *modified;
516 /* at this point, we must have at least a registered application; if we don't
517 * we don't screw up the bookmark file, and just skip this item
519 if (!item->metadata || !item->metadata->applications)
521 g_warning ("Item for URI '%s' has no registered applications: skipping.\n", item->uri);
525 retval = g_string_new (NULL);
527 added = timestamp_to_iso8601 (item->added);
528 modified = timestamp_to_iso8601 (item->modified);
529 visited = timestamp_to_iso8601 (item->visited);
531 escaped_uri = g_markup_escape_text (item->uri, -1);
533 g_string_append_printf (retval,
534 " <%s %s=\"%s\" %s=\"%s\" %s=\"%s\" %s=\"%s\">\n",
535 XBEL_BOOKMARK_ELEMENT,
536 XBEL_HREF_ATTRIBUTE, escaped_uri,
537 XBEL_ADDED_ATTRIBUTE, added,
538 XBEL_MODIFIED_ATTRIBUTE, modified,
539 XBEL_VISITED_ATTRIBUTE, visited);
540 g_free (escaped_uri);
547 gchar *escaped_title;
549 escaped_title = g_markup_escape_text (item->title, -1);
550 g_string_append_printf (retval,
555 g_free (escaped_title);
558 if (item->description)
562 escaped_desc = g_markup_escape_text (item->description, -1);
563 g_string_append_printf (retval,
568 g_free (escaped_desc);
575 /* open info container */
576 g_string_append_printf (retval, " <%s>\n", XBEL_INFO_ELEMENT);
578 metadata = bookmark_metadata_dump (item->metadata);
581 retval = g_string_append (retval, metadata);
586 /* close info container */
587 g_string_append_printf (retval, " </%s>\n", XBEL_INFO_ELEMENT);
590 g_string_append_printf (retval, " </%s>\n", XBEL_BOOKMARK_ELEMENT);
592 return g_string_free (retval, FALSE);
595 static BookmarkAppInfo *
596 bookmark_item_lookup_app_info (BookmarkItem *item,
597 const gchar *app_name)
599 g_assert (item != NULL && app_name != NULL);
604 return g_hash_table_lookup (item->metadata->apps_by_name, app_name);
607 /*************************
609 *************************/
612 g_bookmark_file_init (GBookmarkFile *bookmark)
614 bookmark->title = NULL;
615 bookmark->description = NULL;
617 bookmark->items = NULL;
618 bookmark->items_by_uri = g_hash_table_new_full (g_str_hash,
625 g_bookmark_file_clear (GBookmarkFile *bookmark)
627 g_free (bookmark->title);
628 g_free (bookmark->description);
632 g_list_foreach (bookmark->items,
633 (GFunc) bookmark_item_free,
635 g_list_free (bookmark->items);
637 bookmark->items = NULL;
640 if (bookmark->items_by_uri)
642 g_hash_table_destroy (bookmark->items_by_uri);
644 bookmark->items_by_uri = NULL;
652 GHashTable *namespaces;
654 GBookmarkFile *bookmark_file;
655 BookmarkItem *current_item;
659 parse_data_new (void)
663 retval = g_new (ParseData, 1);
665 retval->state = STATE_STARTED;
666 retval->namespaces = g_hash_table_new_full (g_str_hash, g_str_equal,
667 (GDestroyNotify) g_free,
668 (GDestroyNotify) g_free);
669 retval->bookmark_file = NULL;
670 retval->current_item = NULL;
676 parse_data_free (ParseData *parse_data)
678 g_hash_table_destroy (parse_data->namespaces);
683 #define IS_ATTRIBUTE(s,a) ((0 == strcmp ((s), (a))))
686 parse_bookmark_element (GMarkupParseContext *context,
687 ParseData *parse_data,
688 const gchar **attribute_names,
689 const gchar **attribute_values,
692 const gchar *uri, *added, *modified, *visited;
698 g_assert ((parse_data != NULL) && (parse_data->state == STATE_BOOKMARK));
701 uri = added = modified = visited = NULL;
702 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
704 if (IS_ATTRIBUTE (attr, XBEL_HREF_ATTRIBUTE))
705 uri = attribute_values[i];
706 else if (IS_ATTRIBUTE (attr, XBEL_ADDED_ATTRIBUTE))
707 added = attribute_values[i];
708 else if (IS_ATTRIBUTE (attr, XBEL_MODIFIED_ATTRIBUTE))
709 modified = attribute_values[i];
710 else if (IS_ATTRIBUTE (attr, XBEL_VISITED_ATTRIBUTE))
711 visited = attribute_values[i];
714 g_set_error (error, G_MARKUP_ERROR,
715 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
716 _("Unexpected attribute '%s' for element '%s'"),
718 XBEL_BOOKMARK_ELEMENT);
725 g_set_error (error, G_MARKUP_ERROR,
726 G_MARKUP_ERROR_INVALID_CONTENT,
727 _("Attribute '%s' of element '%s' not found"),
729 XBEL_BOOKMARK_ELEMENT);
733 g_assert (parse_data->current_item == NULL);
735 item = bookmark_item_new (uri);
738 item->added = timestamp_from_iso8601 (added);
741 item->modified = timestamp_from_iso8601 (modified);
744 item->visited = timestamp_from_iso8601 (visited);
747 g_bookmark_file_add_item (parse_data->bookmark_file,
752 bookmark_item_free (item);
754 g_propagate_error (error, add_error);
759 parse_data->current_item = item;
763 parse_application_element (GMarkupParseContext *context,
764 ParseData *parse_data,
765 const gchar **attribute_names,
766 const gchar **attribute_values,
769 const gchar *name, *exec, *count, *stamp;
775 g_assert ((parse_data != NULL) && (parse_data->state == STATE_APPLICATION));
778 name = exec = count = stamp = NULL;
779 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
781 if (IS_ATTRIBUTE (attr, BOOKMARK_NAME_ATTRIBUTE))
782 name = attribute_values[i];
783 else if (IS_ATTRIBUTE (attr, BOOKMARK_EXEC_ATTRIBUTE))
784 exec = attribute_values[i];
785 else if (IS_ATTRIBUTE (attr, BOOKMARK_COUNT_ATTRIBUTE))
786 count = attribute_values[i];
787 else if (IS_ATTRIBUTE (attr, BOOKMARK_TIMESTAMP_ATTRIBUTE))
788 stamp = attribute_values[i];
791 g_set_error (error, G_MARKUP_ERROR,
792 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
793 _("Unexpected attribute '%s' for element '%s'"),
795 BOOKMARK_APPLICATION_ELEMENT);
802 g_set_error (error, G_MARKUP_ERROR,
803 G_MARKUP_ERROR_INVALID_CONTENT,
804 _("Attribute '%s' of element '%s' not found"),
805 BOOKMARK_NAME_ATTRIBUTE,
806 BOOKMARK_APPLICATION_ELEMENT);
812 g_set_error (error, G_MARKUP_ERROR,
813 G_MARKUP_ERROR_INVALID_CONTENT,
814 _("Attribute '%s' of element '%s' not found"),
815 BOOKMARK_EXEC_ATTRIBUTE,
816 BOOKMARK_APPLICATION_ELEMENT);
820 g_assert (parse_data->current_item != NULL);
821 item = parse_data->current_item;
823 ai = bookmark_item_lookup_app_info (item, name);
826 ai = bookmark_app_info_new (name);
829 item->metadata = bookmark_metadata_new ();
831 item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
832 g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
835 ai->exec = g_strdup (exec);
838 ai->count = atoi (count);
843 ai->stamp = (time_t) atol (stamp);
845 ai->stamp = time (NULL);
849 parse_mime_type_element (GMarkupParseContext *context,
850 ParseData *parse_data,
851 const gchar **attribute_names,
852 const gchar **attribute_values,
860 g_assert ((parse_data != NULL) && (parse_data->state == STATE_MIME));
864 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
866 if (IS_ATTRIBUTE (attr, MIME_TYPE_ATTRIBUTE))
867 type = attribute_values[i];
870 g_set_error (error, G_MARKUP_ERROR,
871 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
872 _("Unexpected attribute '%s' for element '%s'"),
880 type = "application/octet-stream";
882 g_assert (parse_data->current_item != NULL);
883 item = parse_data->current_item;
886 item->metadata = bookmark_metadata_new ();
888 item->metadata->mime_type = g_strdup (type);
892 parse_icon_element (GMarkupParseContext *context,
893 ParseData *parse_data,
894 const gchar **attribute_names,
895 const gchar **attribute_values,
904 g_assert ((parse_data != NULL) && (parse_data->state == STATE_ICON));
909 for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
911 if (IS_ATTRIBUTE (attr, BOOKMARK_HREF_ATTRIBUTE))
912 href = attribute_values[i];
913 else if (IS_ATTRIBUTE (attr, BOOKMARK_TYPE_ATTRIBUTE))
914 type = attribute_values[i];
917 g_set_error (error, G_MARKUP_ERROR,
918 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
919 _("Unexpected attribute '%s' for element '%s'"),
921 BOOKMARK_ICON_ELEMENT);
928 g_set_error (error, G_MARKUP_ERROR,
929 G_MARKUP_ERROR_INVALID_CONTENT,
930 _("Attribute '%s' of element '%s' not found"),
931 BOOKMARK_HREF_ATTRIBUTE,
932 BOOKMARK_ICON_ELEMENT);
937 type = "application/octet-stream";
939 g_assert (parse_data->current_item != NULL);
940 item = parse_data->current_item;
943 item->metadata = bookmark_metadata_new ();
945 item->metadata->icon_href = g_strdup (href);
946 item->metadata->icon_mime = g_strdup (type);
949 /* scans through the attributes of an element for the "xmlns" pragma, and
950 * adds any resulting namespace declaration to a per-parser hashtable, using
951 * the namespace name as a key for the namespace URI; if no key was found,
952 * the namespace is considered as default, and stored under the "default" key.
954 * FIXME: this works on the assumption that the generator of the XBEL file
955 * is either this code or is smart enough to place the namespace declarations
956 * inside the main root node or inside the metadata node and does not redefine
957 * a namespace inside an inner node; this does *not* conform to the
958 * XML-NS standard, although is a close approximation. In order to make this
959 * conformant to the XML-NS specification we should use a per-element
960 * namespace table inside GMarkup and ask it to resolve the namespaces for us.
963 map_namespace_to_name (ParseData *parse_data,
964 const gchar **attribute_names,
965 const gchar **attribute_values)
970 g_assert (parse_data != NULL);
972 if (!attribute_names || !attribute_names[0])
976 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
978 if (g_str_has_prefix (attr, "xmlns"))
980 gchar *namespace_name, *namespace_uri;
983 p = g_utf8_strchr (attr, -1, ':');
985 p = g_utf8_next_char (p);
989 namespace_name = g_strdup (p);
990 namespace_uri = g_strdup (attribute_values[i]);
992 g_hash_table_replace (parse_data->namespaces,
999 /* checks whether @element_full is equal to @element.
1001 * if @namespace is set, it tries to resolve the namespace to a known URI,
1002 * and if found is prepended to the element name, from which is separated
1003 * using the character specified in the @sep parameter.
1006 is_element_full (ParseData *parse_data,
1007 const gchar *element_full,
1008 const gchar *namespace,
1009 const gchar *element,
1012 gchar *ns_uri, *ns_name, *s, *resolved;
1013 const gchar *p, *element_name;
1016 g_assert (parse_data != NULL);
1017 g_assert (element_full != NULL);
1022 /* no namespace requested: dumb element compare */
1024 return (0 == strcmp (element_full, element));
1026 /* search for namespace separator; if none found, assume we are under the
1027 * default namespace, and set ns_name to our "default" marker; if no default
1028 * namespace has been set, just do a plain comparison between @full_element
1031 p = strchr (element_full, ':');
1034 ns_name = g_strndup (element_full, p - element_full);
1035 element_name = g_utf8_next_char (p);
1039 ns_name = g_strdup ("default");
1040 element_name = element_full;
1043 ns_uri = g_hash_table_lookup (parse_data->namespaces, ns_name);
1046 /* no default namespace found */
1049 return (0 == strcmp (element_full, element));
1052 resolved = g_strdup_printf ("%s%c%s", ns_uri, sep, element_name);
1053 s = g_strdup_printf ("%s%c%s", namespace, sep, element);
1054 retval = (0 == strcmp (resolved, s));
1063 #define IS_ELEMENT(p,s,e) (is_element_full ((p), (s), NULL, (e), '\0'))
1064 #define IS_ELEMENT_NS(p,s,n,e) (is_element_full ((p), (s), (n), (e), '|'))
1067 start_element_raw_cb (GMarkupParseContext *context,
1068 const gchar *element_name,
1069 const gchar **attribute_names,
1070 const gchar **attribute_values,
1074 ParseData *parse_data = (ParseData *) user_data;
1076 /* we must check for namespace declarations first
1078 * XXX - we could speed up things by checking for namespace declarations
1079 * only on the root node, where they usually are; this would probably break
1080 * on streams not produced by us or by "smart" generators
1082 map_namespace_to_name (parse_data, attribute_names, attribute_values);
1084 switch (parse_data->state)
1087 if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1093 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1095 if ((IS_ATTRIBUTE (attr, XBEL_VERSION_ATTRIBUTE)) &&
1096 (0 == strcmp (attribute_values[i], XBEL_VERSION)))
1097 parse_data->state = STATE_ROOT;
1101 g_set_error (error, G_MARKUP_ERROR,
1102 G_MARKUP_ERROR_INVALID_CONTENT,
1103 _("Unexpected tag '%s', tag '%s' expected"),
1104 element_name, XBEL_ROOT_ELEMENT);
1107 if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1108 parse_data->state = STATE_TITLE;
1109 else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1110 parse_data->state = STATE_DESC;
1111 else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1113 GError *inner_error = NULL;
1115 parse_data->state = STATE_BOOKMARK;
1117 parse_bookmark_element (context,
1123 g_propagate_error (error, inner_error);
1126 g_set_error (error, G_MARKUP_ERROR,
1127 G_MARKUP_ERROR_INVALID_CONTENT,
1128 _("Unexpected tag '%s' inside '%s'"),
1132 case STATE_BOOKMARK:
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_INFO_ELEMENT))
1138 parse_data->state = STATE_INFO;
1140 g_set_error (error, G_MARKUP_ERROR,
1141 G_MARKUP_ERROR_INVALID_CONTENT,
1142 _("Unexpected tag '%s' inside '%s'"),
1144 XBEL_BOOKMARK_ELEMENT);
1147 if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1153 for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1155 if ((IS_ATTRIBUTE (attr, XBEL_OWNER_ATTRIBUTE)) &&
1156 (0 == strcmp (attribute_values[i], BOOKMARK_METADATA_OWNER)))
1158 parse_data->state = STATE_METADATA;
1160 if (!parse_data->current_item->metadata)
1161 parse_data->current_item->metadata = bookmark_metadata_new ();
1166 g_set_error (error, G_MARKUP_ERROR,
1167 G_MARKUP_ERROR_INVALID_CONTENT,
1168 _("Unexpected tag '%s', tag '%s' expected"),
1170 XBEL_METADATA_ELEMENT);
1172 case STATE_METADATA:
1173 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT))
1174 parse_data->state = STATE_APPLICATIONS;
1175 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT))
1176 parse_data->state = STATE_GROUPS;
1177 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT))
1178 parse_data->current_item->metadata->is_private = TRUE;
1179 else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1181 GError *inner_error = NULL;
1183 parse_data->state = STATE_ICON;
1185 parse_icon_element (context,
1191 g_propagate_error (error, inner_error);
1193 else if (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT))
1195 GError *inner_error = NULL;
1197 parse_data->state = STATE_MIME;
1199 parse_mime_type_element (context,
1205 g_propagate_error (error, inner_error);
1208 g_set_error (error, G_MARKUP_ERROR,
1209 G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1210 _("Unexpected tag '%s' inside '%s'"),
1212 XBEL_METADATA_ELEMENT);
1214 case STATE_APPLICATIONS:
1215 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATION_ELEMENT))
1217 GError *inner_error = NULL;
1219 parse_data->state = STATE_APPLICATION;
1221 parse_application_element (context,
1227 g_propagate_error (error, inner_error);
1230 g_set_error (error, G_MARKUP_ERROR,
1231 G_MARKUP_ERROR_INVALID_CONTENT,
1232 _("Unexpected tag '%s', tag '%s' expected"),
1234 BOOKMARK_APPLICATION_ELEMENT);
1237 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUP_ELEMENT))
1238 parse_data->state = STATE_GROUP;
1240 g_set_error (error, G_MARKUP_ERROR,
1241 G_MARKUP_ERROR_INVALID_CONTENT,
1242 _("Unexpected tag '%s', tag '%s' expected"),
1244 BOOKMARK_GROUP_ELEMENT);
1247 if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1249 GError *inner_error = NULL;
1251 parse_icon_element (context,
1257 g_propagate_error (error, inner_error);
1260 g_set_error (error, G_MARKUP_ERROR,
1261 G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1262 _("Unexpected tag '%s' inside '%s'"),
1264 XBEL_METADATA_ELEMENT);
1267 g_assert_not_reached ();
1273 end_element_raw_cb (GMarkupParseContext *context,
1274 const gchar *element_name,
1278 ParseData *parse_data = (ParseData *) user_data;
1280 if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1281 parse_data->state = STATE_FINISHED;
1282 else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1284 parse_data->current_item = NULL;
1286 parse_data->state = STATE_ROOT;
1288 else if ((IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT)) ||
1289 (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) ||
1290 (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT)))
1292 if (parse_data->current_item)
1293 parse_data->state = STATE_BOOKMARK;
1295 parse_data->state = STATE_ROOT;
1297 else if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1298 parse_data->state = STATE_INFO;
1299 else if (IS_ELEMENT_NS (parse_data, element_name,
1300 BOOKMARK_NAMESPACE_URI,
1301 BOOKMARK_APPLICATION_ELEMENT))
1302 parse_data->state = STATE_APPLICATIONS;
1303 else if (IS_ELEMENT_NS (parse_data, element_name,
1304 BOOKMARK_NAMESPACE_URI,
1305 BOOKMARK_GROUP_ELEMENT))
1306 parse_data->state = STATE_GROUPS;
1307 else if ((IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT)) ||
1308 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT)) ||
1309 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT)) ||
1310 (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT)) ||
1311 (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT)))
1312 parse_data->state = STATE_METADATA;
1316 text_raw_cb (GMarkupParseContext *context,
1322 ParseData *parse_data = (ParseData *) user_data;
1325 payload = g_strndup (text, length);
1327 switch (parse_data->state)
1330 if (parse_data->current_item)
1332 g_free (parse_data->current_item->title);
1333 parse_data->current_item->title = g_strdup (payload);
1337 g_free (parse_data->bookmark_file->title);
1338 parse_data->bookmark_file->title = g_strdup (payload);
1342 if (parse_data->current_item)
1344 g_free (parse_data->current_item->description);
1345 parse_data->current_item->description = g_strdup (payload);
1349 g_free (parse_data->bookmark_file->description);
1350 parse_data->bookmark_file->description = g_strdup (payload);
1357 g_assert (parse_data->current_item != NULL);
1359 if (!parse_data->current_item->metadata)
1360 parse_data->current_item->metadata = bookmark_metadata_new ();
1362 groups = parse_data->current_item->metadata->groups;
1363 parse_data->current_item->metadata->groups = g_list_prepend (groups, g_strdup (payload));
1367 case STATE_BOOKMARK:
1369 case STATE_METADATA:
1370 case STATE_APPLICATIONS:
1371 case STATE_APPLICATION:
1377 g_assert_not_reached ();
1384 static const GMarkupParser markup_parser =
1386 start_element_raw_cb, /* start_element */
1387 end_element_raw_cb, /* end_element */
1388 text_raw_cb, /* text */
1389 NULL, /* passthrough */
1394 g_bookmark_file_parse (GBookmarkFile *bookmark,
1395 const gchar *buffer,
1399 GMarkupParseContext *context;
1400 ParseData *parse_data;
1401 GError *parse_error, *end_error;
1404 g_assert (bookmark != NULL);
1410 length = strlen (buffer);
1412 parse_data = parse_data_new ();
1413 parse_data->bookmark_file = bookmark;
1415 context = g_markup_parse_context_new (&markup_parser,
1418 (GDestroyNotify) parse_data_free);
1421 retval = g_markup_parse_context_parse (context,
1427 g_propagate_error (error, parse_error);
1433 retval = g_markup_parse_context_end_parse (context, &end_error);
1436 g_propagate_error (error, end_error);
1441 g_markup_parse_context_free (context);
1447 g_bookmark_file_dump (GBookmarkFile *bookmark,
1454 retval = g_string_new (NULL);
1456 g_string_append_printf (retval,
1457 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1459 /* XXX - do we really need the doctype? */
1465 " xmlns:%s=\"%s\"\n"
1466 " xmlns:%s=\"%s\"\n>",
1468 /* XXX - do we really need the doctype? */
1470 XBEL_DTD_SYSTEM, XBEL_DTD_URI,
1473 XBEL_VERSION_ATTRIBUTE, XBEL_VERSION,
1474 BOOKMARK_NAMESPACE_NAME, BOOKMARK_NAMESPACE_URI,
1475 MIME_NAMESPACE_NAME, MIME_NAMESPACE_URI);
1477 if (bookmark->title)
1479 gchar *escaped_title;
1481 escaped_title = g_markup_escape_text (bookmark->title, -1);
1483 g_string_append_printf (retval, " <%s>%s</%s>\n",
1486 XBEL_TITLE_ELEMENT);
1488 g_free (escaped_title);
1491 if (bookmark->description)
1493 gchar *escaped_desc;
1495 escaped_desc = g_markup_escape_text (bookmark->description, -1);
1497 g_string_append_printf (retval, " <%s>%s</%s>\n",
1502 g_free (escaped_desc);
1505 if (!bookmark->items)
1508 retval = g_string_append (retval, "\n");
1510 for (l = g_list_last (bookmark->items);
1514 BookmarkItem *item = (BookmarkItem *) l->data;
1517 item_dump = bookmark_item_dump (item);
1521 retval = g_string_append (retval, item_dump);
1527 g_string_append_printf (retval, "</%s>", XBEL_ROOT_ELEMENT);
1530 *length = retval->len;
1532 return g_string_free (retval, FALSE);
1539 /* converts a Unix timestamp in a ISO 8601 compliant string; you
1540 * should free the returned string.
1543 timestamp_to_iso8601 (time_t timestamp)
1547 if (timestamp == (time_t) -1)
1548 g_get_current_time (&stamp);
1551 stamp.tv_sec = timestamp;
1555 return g_time_val_to_iso8601 (&stamp);
1559 timestamp_from_iso8601 (const gchar *iso_date)
1563 if (!g_time_val_from_iso8601 (iso_date, &stamp))
1566 return (time_t) stamp.tv_sec;
1572 g_bookmark_file_error_quark (void)
1574 return g_quark_from_static_string ("egg-bookmark-file-error-quark");
1579 /********************
1581 ********************/
1584 * g_bookmark_file_new:
1586 * Creates a new empty #GBookmarkFile object.
1588 * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
1589 * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
1592 * Return value: an empty #GBookmarkFile
1597 g_bookmark_file_new (void)
1599 GBookmarkFile *bookmark;
1601 bookmark = g_new (GBookmarkFile, 1);
1603 g_bookmark_file_init (bookmark);
1609 * g_bookmark_file_free:
1610 * @bookmark: a #GBookmarkFile
1612 * Frees a #GBookmarkFile.
1617 g_bookmark_file_free (GBookmarkFile *bookmark)
1622 g_bookmark_file_clear (bookmark);
1628 * g_bookmark_file_load_from_data:
1629 * @bookmark: an empty #GBookmarkFile struct
1630 * @data: desktop bookmarks loaded in memory
1631 * @length: the length of @data in bytes
1632 * @error: return location for a #GError, or %NULL
1634 * Loads a bookmark file from memory into an empty #GBookmarkFile
1635 * structure. If the object cannot be created then @error is set to a
1636 * #GBookmarkFileError.
1638 * Return value: %TRUE if a desktop bookmark could be loaded.
1643 g_bookmark_file_load_from_data (GBookmarkFile *bookmark,
1648 GError *parse_error;
1651 g_return_val_if_fail (bookmark != NULL, FALSE);
1652 g_return_val_if_fail (data != NULL, FALSE);
1653 g_return_val_if_fail (length != 0, FALSE);
1655 if (length == (gsize) -1)
1656 length = strlen (data);
1658 if (bookmark->items)
1660 g_bookmark_file_clear (bookmark);
1661 g_bookmark_file_init (bookmark);
1665 retval = g_bookmark_file_parse (bookmark, data, length, &parse_error);
1668 g_propagate_error (error, parse_error);
1677 * g_bookmark_file_load_from_file:
1678 * @bookmark: an empty #GBookmarkFile struct
1679 * @filename: the path of a filename to load, in the GLib file name encoding
1680 * @error: return location for a #GError, or %NULL
1682 * Loads a desktop bookmark file into an empty #GBookmarkFile structure.
1683 * If the file could not be loaded then @error is set to either a #GFileError
1684 * or #GBookmarkFileError.
1686 * Return value: %TRUE if a desktop bookmark file could be loaded
1691 g_bookmark_file_load_from_file (GBookmarkFile *bookmark,
1692 const gchar *filename,
1700 g_return_val_if_fail (bookmark != NULL, FALSE);
1701 g_return_val_if_fail (filename != NULL, FALSE);
1704 g_file_get_contents (filename, &buffer, &len, &read_error);
1707 g_propagate_error (error, read_error);
1713 retval = g_bookmark_file_load_from_data (bookmark,
1719 g_propagate_error (error, read_error);
1732 /* Iterates through all the directories in *dirs trying to
1733 * find file. When it successfully locates file, returns a
1734 * string its absolute path. It also leaves the unchecked
1735 * directories in *dirs. You should free the returned string
1737 * Adapted from gkeyfile.c
1740 find_file_in_data_dirs (const gchar *file,
1744 gchar **data_dirs, *data_dir, *path;
1753 while (data_dirs && (data_dir = *data_dirs) && !path)
1755 gchar *candidate_file, *sub_dir;
1757 candidate_file = (gchar *) file;
1758 sub_dir = g_strdup ("");
1759 while (candidate_file != NULL && !path)
1763 path = g_build_filename (data_dir, sub_dir,
1764 candidate_file, NULL);
1766 candidate_file = strchr (candidate_file, '-');
1768 if (candidate_file == NULL)
1774 sub_dir = g_strndup (file, candidate_file - file - 1);
1776 for (p = sub_dir; *p != '\0'; p++)
1779 *p = G_DIR_SEPARATOR;
1790 g_set_error (error, G_BOOKMARK_FILE_ERROR,
1791 G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND,
1792 _("No valid bookmark file found in data dirs"));
1802 * g_bookmark_file_load_from_data_dirs:
1803 * @bookmark: a #GBookmarkFile
1804 * @file: a relative path to a filename to open and parse
1805 * @full_path: return location for a string containing the full path
1806 * of the file, or %NULL
1807 * @error: return location for a #GError, or %NULL
1809 * This function looks for a desktop bookmark file named @file in the
1810 * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
1811 * loads the file into @bookmark and returns the file's full path in
1812 * @full_path. If the file could not be loaded then an %error is
1813 * set to either a #GFileError or #GBookmarkFileError.
1815 * Return value: %TRUE if a key file could be loaded, %FALSE othewise
1820 g_bookmark_file_load_from_data_dirs (GBookmarkFile *bookmark,
1825 GError *file_error = NULL;
1826 gchar **all_data_dirs, **data_dirs;
1827 const gchar *user_data_dir;
1828 const gchar * const * system_data_dirs;
1831 gboolean found_file;
1833 g_return_val_if_fail (bookmark != NULL, FALSE);
1834 g_return_val_if_fail (!g_path_is_absolute (file), FALSE);
1836 user_data_dir = g_get_user_data_dir ();
1837 system_data_dirs = g_get_system_data_dirs ();
1838 all_data_dirs = g_new0 (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2);
1841 all_data_dirs[i++] = g_strdup (user_data_dir);
1844 while (system_data_dirs[j] != NULL)
1845 all_data_dirs[i++] = g_strdup (system_data_dirs[j++]);
1848 data_dirs = all_data_dirs;
1850 while (*data_dirs != NULL && !found_file)
1852 g_free (output_path);
1854 output_path = find_file_in_data_dirs (file, &data_dirs, &file_error);
1858 g_propagate_error (error, file_error);
1862 found_file = g_bookmark_file_load_from_file (bookmark,
1867 g_propagate_error (error, file_error);
1872 if (found_file && full_path)
1873 *full_path = output_path;
1875 g_free (output_path);
1877 g_strfreev (all_data_dirs);
1884 * g_bookmark_file_to_data:
1885 * @bookmark: a #GBookmarkFile
1886 * @length: return location for the length of the returned string, or %NULL
1887 * @error: return location for a #GError, or %NULL
1889 * This function outputs @bookmark as a string.
1891 * Return value: a newly allocated string holding
1892 * the contents of the #GBookmarkFile
1897 g_bookmark_file_to_data (GBookmarkFile *bookmark,
1901 GError *write_error = NULL;
1904 g_return_val_if_fail (bookmark != NULL, NULL);
1906 retval = g_bookmark_file_dump (bookmark, length, &write_error);
1909 g_propagate_error (error, write_error);
1918 * g_bookmark_file_to_file:
1919 * @bookmark: a #GBookmarkFile
1920 * @filename: path of the output file
1921 * @error: return location for a #GError, or %NULL
1923 * This function outputs @bookmark into a file. The write process is
1924 * guaranteed to be atomic by using g_file_set_contents() internally.
1926 * Return value: %TRUE if the file was successfully written.
1931 g_bookmark_file_to_file (GBookmarkFile *bookmark,
1932 const gchar *filename,
1936 GError *data_error, *write_error;
1940 g_return_val_if_fail (bookmark != NULL, FALSE);
1941 g_return_val_if_fail (filename != NULL, FALSE);
1944 data = g_bookmark_file_to_data (bookmark, &len, &data_error);
1947 g_propagate_error (error, data_error);
1953 g_file_set_contents (filename, data, len, &write_error);
1956 g_propagate_error (error, write_error);
1968 static BookmarkItem *
1969 g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
1972 g_assert (bookmark != NULL && uri != NULL);
1974 return g_hash_table_lookup (bookmark->items_by_uri, uri);
1977 /* this function adds a new item to the list */
1979 g_bookmark_file_add_item (GBookmarkFile *bookmark,
1983 g_assert (bookmark != NULL);
1984 g_assert (item != NULL);
1986 /* this should never happen; and if it does, then we are
1987 * screwing up something big time.
1989 if (G_UNLIKELY (g_bookmark_file_has_item (bookmark, item->uri)))
1991 g_set_error (error, G_BOOKMARK_FILE_ERROR,
1992 G_BOOKMARK_FILE_ERROR_INVALID_URI,
1993 _("A bookmark for URI '%s' already exists"),
1998 bookmark->items = g_list_prepend (bookmark->items, item);
2000 g_hash_table_replace (bookmark->items_by_uri,
2004 if (item->added == (time_t) -1)
2005 item->added = time (NULL);
2007 if (item->modified == (time_t) -1)
2008 item->modified = time (NULL);
2012 * g_bookmark_file_remove_item:
2013 * @bookmark: a #GBookmarkFile
2015 * @error: return location for a #GError, or %NULL
2017 * Removes the bookmark for @uri from the bookmark file @bookmark.
2019 * Return value: %TRUE if the bookmark was removed successfully.
2024 g_bookmark_file_remove_item (GBookmarkFile *bookmark,
2030 g_return_val_if_fail (bookmark != NULL, FALSE);
2031 g_return_val_if_fail (uri != NULL, FALSE);
2033 item = g_bookmark_file_lookup_item (bookmark, uri);
2037 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2038 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2039 _("No bookmark found for URI '%s'"),
2044 bookmark->items = g_list_remove (bookmark->items, item);
2045 g_hash_table_remove (bookmark->items_by_uri, item->uri);
2047 bookmark_item_free (item);
2053 * g_bookmark_file_has_item:
2054 * @bookmark: a #GBookmarkFile
2057 * Looks whether the desktop bookmark has an item with its URI set to @uri.
2059 * Return value: %TRUE if @uri is inside @bookmark, %FALSE otherwise
2064 g_bookmark_file_has_item (GBookmarkFile *bookmark,
2067 g_return_val_if_fail (bookmark != NULL, FALSE);
2068 g_return_val_if_fail (uri != NULL, FALSE);
2070 return (NULL != g_hash_table_lookup (bookmark->items_by_uri, uri));
2074 * g_bookmark_file_get_uris:
2075 * @bookmark: a #GBookmarkFile
2076 * @length: return location for the number of returned URIs, or %NULL
2078 * Returns all URIs of the bookmarks in the bookmark file @bookmark.
2079 * The array of returned URIs will be %NULL-terminated, so @length may
2080 * optionally be %NULL.
2082 * Return value: a newly allocated %NULL-terminated array of strings.
2083 * Use g_strfreev() to free it.
2088 g_bookmark_file_get_uris (GBookmarkFile *bookmark,
2095 g_return_val_if_fail (bookmark != NULL, NULL);
2097 n_items = g_list_length (bookmark->items);
2098 uris = g_new0 (gchar *, n_items + 1);
2100 for (l = g_list_last (bookmark->items), i = 0; l != NULL; l = l->prev)
2102 BookmarkItem *item = (BookmarkItem *) l->data;
2104 g_assert (item != NULL);
2106 uris[i++] = g_strdup (item->uri);
2117 * g_bookmark_file_set_title:
2118 * @bookmark: a #GBookmarkFile
2119 * @uri: a valid URI or %NULL
2120 * @title: a UTF-8 encoded string
2122 * Sets @title as the title of the bookmark for @uri inside the
2123 * bookmark file @bookmark.
2125 * If @uri is %NULL, the title of @bookmark is set.
2127 * If a bookmark for @uri cannot be found then it is created.
2132 g_bookmark_file_set_title (GBookmarkFile *bookmark,
2136 g_return_if_fail (bookmark != NULL);
2140 g_free (bookmark->title);
2141 bookmark->title = g_strdup (title);
2147 item = g_bookmark_file_lookup_item (bookmark, uri);
2150 item = bookmark_item_new (uri);
2151 g_bookmark_file_add_item (bookmark, item, NULL);
2154 g_free (item->title);
2155 item->title = g_strdup (title);
2157 item->modified = time (NULL);
2162 * g_bookmark_file_get_title:
2163 * @bookmark: a #GBookmarkFile
2164 * @uri: a valid URI or %NULL
2165 * @error: return location for a #GError, or %NULL
2167 * Returns the title of the bookmark for @uri.
2169 * If @uri is %NULL, the title of @bookmark is returned.
2171 * In the event the URI cannot be found, %NULL is returned and
2172 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2174 * Return value: a newly allocated string or %NULL if the specified
2175 * URI cannot be found.
2180 g_bookmark_file_get_title (GBookmarkFile *bookmark,
2186 g_return_val_if_fail (bookmark != NULL, NULL);
2189 return g_strdup (bookmark->title);
2191 item = g_bookmark_file_lookup_item (bookmark, uri);
2194 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2195 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2196 _("No bookmark found for URI '%s'"),
2201 return g_strdup (item->title);
2205 * g_bookmark_file_set_description:
2206 * @bookmark: a #GBookmarkFile
2207 * @uri: a valid URI or %NULL
2208 * @description: a string
2210 * Sets @description as the description of the bookmark for @uri.
2212 * If @uri is %NULL, the description of @bookmark is set.
2214 * If a bookmark for @uri cannot be found then it is created.
2219 g_bookmark_file_set_description (GBookmarkFile *bookmark,
2221 const gchar *description)
2223 g_return_if_fail (bookmark != NULL);
2227 g_free (bookmark->description);
2228 bookmark->description = g_strdup (description);
2234 item = g_bookmark_file_lookup_item (bookmark, uri);
2237 item = bookmark_item_new (uri);
2238 g_bookmark_file_add_item (bookmark, item, NULL);
2241 g_free (item->description);
2242 item->description = g_strdup (description);
2244 item->modified = time (NULL);
2249 * g_bookmark_file_get_description:
2250 * @bookmark: a #GBookmarkFile
2252 * @error: return location for a #GError, or %NULL
2254 * Retrieves the description of the bookmark for @uri.
2256 * In the event the URI cannot be found, %NULL is returned and
2257 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2259 * Return value: a newly allocated string or %NULL if the specified
2260 * URI cannot be found.
2265 g_bookmark_file_get_description (GBookmarkFile *bookmark,
2271 g_return_val_if_fail (bookmark != NULL, NULL);
2274 return g_strdup (bookmark->description);
2276 item = g_bookmark_file_lookup_item (bookmark, uri);
2279 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2280 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2281 _("No bookmark found for URI '%s'"),
2286 return g_strdup (item->description);
2290 * g_bookmark_file_set_mime_type:
2291 * @bookmark: a #GBookmarkFile
2293 * @mime_type: a MIME type
2295 * Sets @mime_type as the MIME type of the bookmark for @uri.
2297 * If a bookmark for @uri cannot be found then it is created.
2302 g_bookmark_file_set_mime_type (GBookmarkFile *bookmark,
2304 const gchar *mime_type)
2308 g_return_if_fail (bookmark != NULL);
2309 g_return_if_fail (uri != NULL);
2310 g_return_if_fail (mime_type != NULL);
2312 item = g_bookmark_file_lookup_item (bookmark, uri);
2315 item = bookmark_item_new (uri);
2316 g_bookmark_file_add_item (bookmark, item, NULL);
2319 if (!item->metadata)
2320 item->metadata = bookmark_metadata_new ();
2322 if (item->metadata->mime_type != NULL)
2323 g_free (item->metadata->mime_type);
2325 item->metadata->mime_type = g_strdup (mime_type);
2326 item->modified = time (NULL);
2330 * g_bookmark_file_get_mime_type:
2331 * @bookmark: a #GBookmarkFile
2333 * @error: return location for a #GError, or %NULL
2335 * Retrieves the MIME type of the resource pointed by @uri.
2337 * In the event the URI cannot be found, %NULL is returned and
2338 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
2339 * event that the MIME type cannot be found, %NULL is returned and
2340 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2342 * Return value: a newly allocated string or %NULL if the specified
2343 * URI cannot be found.
2348 g_bookmark_file_get_mime_type (GBookmarkFile *bookmark,
2354 g_return_val_if_fail (bookmark != NULL, NULL);
2355 g_return_val_if_fail (uri != NULL, NULL);
2357 item = g_bookmark_file_lookup_item (bookmark, uri);
2360 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2361 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2362 _("No bookmark found for URI '%s'"),
2367 if (!item->metadata)
2369 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2370 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2371 _("No MIME type defined in the bookmark for URI '%s'"),
2376 return g_strdup (item->metadata->mime_type);
2380 * g_bookmark_file_set_is_private:
2381 * @bookmark: a #GBookmarkFile
2383 * @is_private: %TRUE if the bookmark should be marked as private
2385 * Sets the private flag of the bookmark for @uri.
2387 * If a bookmark for @uri cannot be found then it is created.
2392 g_bookmark_file_set_is_private (GBookmarkFile *bookmark,
2394 gboolean is_private)
2398 g_return_if_fail (bookmark != NULL);
2399 g_return_if_fail (uri != NULL);
2401 item = g_bookmark_file_lookup_item (bookmark, uri);
2404 item = bookmark_item_new (uri);
2405 g_bookmark_file_add_item (bookmark, item, NULL);
2408 if (!item->metadata)
2409 item->metadata = bookmark_metadata_new ();
2411 item->metadata->is_private = (is_private == TRUE);
2412 item->modified = time (NULL);
2416 * g_bookmark_file_get_is_private:
2417 * @bookmark: a #GBookmarkFile
2419 * @error: return location for a #GError, or %NULL
2421 * Gets whether the private flag of the bookmark for @uri is set.
2423 * In the event the URI cannot be found, %FALSE is returned and
2424 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
2425 * event that the private flag cannot be found, %FALSE is returned and
2426 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2428 * Return value: %TRUE if the private flag is set, %FALSE otherwise.
2433 g_bookmark_file_get_is_private (GBookmarkFile *bookmark,
2439 g_return_val_if_fail (bookmark != NULL, FALSE);
2440 g_return_val_if_fail (uri != NULL, FALSE);
2442 item = g_bookmark_file_lookup_item (bookmark, uri);
2445 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2446 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2447 _("No bookmark found for URI '%s'"),
2452 if (!item->metadata)
2454 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2455 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2456 _("No private flag has been defined in bookmark for URI '%s'"),
2461 return item->metadata->is_private;
2465 * g_bookmark_file_set_added:
2466 * @bookmark: a #GBookmarkFile
2468 * @added: a timestamp or -1 to use the current time
2470 * Sets the time the bookmark for @uri was added into @bookmark.
2472 * If no bookmark for @uri is found then it is created.
2477 g_bookmark_file_set_added (GBookmarkFile *bookmark,
2483 g_return_if_fail (bookmark != NULL);
2484 g_return_if_fail (uri != NULL);
2486 item = g_bookmark_file_lookup_item (bookmark, uri);
2489 item = bookmark_item_new (uri);
2490 g_bookmark_file_add_item (bookmark, item, NULL);
2493 if (added == (time_t) -1)
2496 item->added = added;
2497 item->modified = added;
2501 * g_bookmark_file_get_added:
2502 * @bookmark: a #GBookmarkFile
2504 * @error: return location for a #GError, or %NULL
2506 * Gets the time the bookmark for @uri was added to @bookmark
2508 * In the event the URI cannot be found, -1 is returned and
2509 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2511 * Return value: a timestamp
2516 g_bookmark_file_get_added (GBookmarkFile *bookmark,
2522 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2523 g_return_val_if_fail (uri != NULL, (time_t) -1);
2525 item = g_bookmark_file_lookup_item (bookmark, uri);
2528 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2529 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2530 _("No bookmark found for URI '%s'"),
2539 * g_bookmark_file_set_modified:
2540 * @bookmark: a #GBookmarkFile
2542 * @modified: a timestamp or -1 to use the current time
2544 * Sets the last time the bookmark for @uri was last modified.
2546 * If no bookmark for @uri is found then it is created.
2548 * The "modified" time should only be set when the bookmark's meta-data
2549 * was actually changed. Every function of #GBookmarkFile that
2550 * modifies a bookmark also changes the modification time, except for
2551 * g_bookmark_file_set_visited().
2556 g_bookmark_file_set_modified (GBookmarkFile *bookmark,
2562 g_return_if_fail (bookmark != NULL);
2563 g_return_if_fail (uri != NULL);
2565 item = g_bookmark_file_lookup_item (bookmark, uri);
2568 item = bookmark_item_new (uri);
2569 g_bookmark_file_add_item (bookmark, item, NULL);
2572 if (modified == (time_t) -1)
2575 item->modified = modified;
2579 * g_bookmark_file_get_modified:
2580 * @bookmark: a #GBookmarkFile
2582 * @error: return location for a #GError, or %NULL
2584 * Gets the time when the bookmark for @uri was last modified.
2586 * In the event the URI cannot be found, -1 is returned and
2587 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2589 * Return value: a timestamp
2594 g_bookmark_file_get_modified (GBookmarkFile *bookmark,
2600 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2601 g_return_val_if_fail (uri != NULL, (time_t) -1);
2603 item = g_bookmark_file_lookup_item (bookmark, uri);
2606 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2607 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2608 _("No bookmark found for URI '%s'"),
2613 return item->modified;
2617 * g_bookmark_file_set_visited:
2618 * @bookmark: a #GBookmarkFile
2620 * @visited: a timestamp or -1 to use the current time
2622 * Sets the time the bookmark for @uri was last visited.
2624 * If no bookmark for @uri is found then it is created.
2626 * The "visited" time should only be set if the bookmark was launched,
2627 * either using the command line retrieved by g_bookmark_file_get_app_info()
2628 * or by the default application for the bookmark's MIME type, retrieved
2629 * using g_bookmark_file_get_mime_type(). Changing the "visited" time
2630 * does not affect the "modified" time.
2635 g_bookmark_file_set_visited (GBookmarkFile *bookmark,
2641 g_return_if_fail (bookmark != NULL);
2642 g_return_if_fail (uri != NULL);
2644 item = g_bookmark_file_lookup_item (bookmark, uri);
2647 item = bookmark_item_new (uri);
2648 g_bookmark_file_add_item (bookmark, item, NULL);
2651 if (visited == (time_t) -1)
2654 item->visited = visited;
2658 * g_bookmark_file_get_visited:
2659 * @bookmark: a #GBookmarkFile
2661 * @error: return location for a #GError, or %NULL
2663 * Gets the time the bookmark for @uri was last visited.
2665 * In the event the URI cannot be found, -1 is returned and
2666 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2668 * Return value: a timestamp.
2673 g_bookmark_file_get_visited (GBookmarkFile *bookmark,
2679 g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2680 g_return_val_if_fail (uri != NULL, (time_t) -1);
2682 item = g_bookmark_file_lookup_item (bookmark, uri);
2685 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2686 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2687 _("No bookmark found for URI '%s'"),
2692 return item->visited;
2696 * g_bookmark_file_has_group:
2697 * @bookmark: a #GBookmarkFile
2699 * @group: the group name to be searched
2700 * @error: return location for a #GError, or %NULL
2702 * Checks whether @group appears in the list of groups to which
2703 * the bookmark for @uri belongs to.
2705 * In the event the URI cannot be found, %FALSE is returned and
2706 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2708 * Return value: %TRUE if @group was found.
2713 g_bookmark_file_has_group (GBookmarkFile *bookmark,
2721 g_return_val_if_fail (bookmark != NULL, FALSE);
2722 g_return_val_if_fail (uri != NULL, FALSE);
2724 item = g_bookmark_file_lookup_item (bookmark, uri);
2727 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2728 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2729 _("No bookmark found for URI '%s'"),
2734 if (!item->metadata)
2737 for (l = item->metadata->groups; l != NULL; l = l->next)
2739 if (strcmp (l->data, group) == 0)
2748 * g_bookmark_file_add_group:
2749 * @bookmark: a #GBookmarkFile
2751 * @group: the group name to be added
2753 * Adds @group to the list of groups to which the bookmark for @uri
2756 * If no bookmark for @uri is found then it is created.
2761 g_bookmark_file_add_group (GBookmarkFile *bookmark,
2767 g_return_if_fail (bookmark != NULL);
2768 g_return_if_fail (uri != NULL);
2769 g_return_if_fail (group != NULL && group[0] != '\0');
2771 item = g_bookmark_file_lookup_item (bookmark, uri);
2774 item = bookmark_item_new (uri);
2775 g_bookmark_file_add_item (bookmark, item, NULL);
2778 if (!item->metadata)
2779 item->metadata = bookmark_metadata_new ();
2781 if (!g_bookmark_file_has_group (bookmark, uri, group, NULL))
2783 item->metadata->groups = g_list_prepend (item->metadata->groups,
2786 item->modified = time (NULL);
2791 * g_bookmark_file_remove_group:
2792 * @bookmark: a #GBookmarkFile
2794 * @group: the group name to be removed
2795 * @error: return location for a #GError, or %NULL
2797 * Removes @group from the list of groups to which the bookmark
2798 * for @uri belongs to.
2800 * In the event the URI cannot be found, %FALSE is returned and
2801 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2802 * In the event no group was defined, %FALSE is returned and
2803 * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2805 * Return value: %TRUE if @group was successfully removed.
2810 g_bookmark_file_remove_group (GBookmarkFile *bookmark,
2818 g_return_val_if_fail (bookmark != NULL, FALSE);
2819 g_return_val_if_fail (uri != NULL, FALSE);
2821 item = g_bookmark_file_lookup_item (bookmark, uri);
2824 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2825 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2826 _("No bookmark found for URI '%s'"),
2831 if (!item->metadata)
2833 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2834 G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2835 _("No groups set in bookmark for URI '%s'"),
2840 for (l = item->metadata->groups; l != NULL; l = l->next)
2842 if (strcmp (l->data, group) == 0)
2844 item->metadata->groups = g_list_remove_link (item->metadata->groups, l);
2847 item->modified = time (NULL);
2857 * g_bookmark_file_set_groups:
2858 * @bookmark: a #GBookmarkFile
2859 * @uri: an item's URI
2860 * @groups: an array of group names, or %NULL to remove all groups
2861 * @length: number of group name values in @groups
2863 * Sets a list of group names for the item with URI @uri. Each previously
2864 * set group name list is removed.
2866 * If @uri cannot be found then an item for it is created.
2871 g_bookmark_file_set_groups (GBookmarkFile *bookmark,
2873 const gchar **groups,
2879 g_return_if_fail (bookmark != NULL);
2880 g_return_if_fail (uri != NULL);
2881 g_return_if_fail (groups != NULL);
2883 item = g_bookmark_file_lookup_item (bookmark, uri);
2886 item = bookmark_item_new (uri);
2887 g_bookmark_file_add_item (bookmark, item, NULL);
2890 if (!item->metadata)
2891 item->metadata = bookmark_metadata_new ();
2893 if (item->metadata->groups != NULL)
2895 g_list_foreach (item->metadata->groups,
2898 g_list_free (item->metadata->groups);
2899 item->metadata->groups = NULL;
2904 for (i = 0; groups[i] != NULL && i < length; i++)
2905 item->metadata->groups = g_list_append (item->metadata->groups,
2906 g_strdup (groups[i]));
2909 item->modified = time (NULL);
2913 * g_bookmark_file_get_groups:
2914 * @bookmark: a #GBookmarkFile
2916 * @length: return location for the length of the returned string, or %NULL
2917 * @error: return location for a #GError, or %NULL
2919 * Retrieves the list of group names of the bookmark for @uri.
2921 * In the event the URI cannot be found, %NULL is returned and
2922 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2924 * The returned array is %NULL terminated, so @length may optionally
2927 * Return value: a newly allocated %NULL-terminated array of group names.
2928 * Use g_strfreev() to free it.
2931 g_bookmark_file_get_groups (GBookmarkFile *bookmark,
2941 g_return_val_if_fail (bookmark != NULL, NULL);
2942 g_return_val_if_fail (uri != NULL, NULL);
2944 item = g_bookmark_file_lookup_item (bookmark, uri);
2947 g_set_error (error, G_BOOKMARK_FILE_ERROR,
2948 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2949 _("No bookmark found for URI '%s'"),
2954 if (!item->metadata)
2962 len = g_list_length (item->metadata->groups);
2963 retval = g_new0 (gchar *, len + 1);
2964 for (l = g_list_last (item->metadata->groups), i = 0;
2968 gchar *group_name = (gchar *) l->data;
2970 g_assert (group_name != NULL);
2972 retval[i++] = g_strdup (group_name);
2983 * g_bookmark_file_add_application:
2984 * @bookmark: a #GBookmarkFile
2986 * @name: the name of the application registering the bookmark
2988 * @exec: command line to be used to launch the bookmark or %NULL
2990 * Adds the application with @name and @exec to the list of
2991 * applications that have registered a bookmark for @uri into
2994 * Every bookmark inside a #GBookmarkFile must have at least an
2995 * application registered. Each application must provide a name, a
2996 * command line useful for launching the bookmark, the number of times
2997 * the bookmark has been registered by the application and the last
2998 * time the application registered this bookmark.
3000 * If @name is %NULL, the name of the application will be the
3001 * same returned by g_get_application(); if @exec is %NULL, the
3002 * command line will be a composition of the program name as
3003 * returned by g_get_prgname() and the "%u" modifier, which will be
3004 * expanded to the bookmark's URI.
3006 * This function will automatically take care of updating the
3007 * registrations count and timestamping in case an application
3008 * with the same @name had already registered a bookmark for
3009 * @uri inside @bookmark.
3011 * If no bookmark for @uri is found, one is created.
3016 g_bookmark_file_add_application (GBookmarkFile *bookmark,
3022 gchar *app_name, *app_exec;
3024 g_return_if_fail (bookmark != NULL);
3025 g_return_if_fail (uri != NULL);
3027 item = g_bookmark_file_lookup_item (bookmark, uri);
3030 item = bookmark_item_new (uri);
3031 g_bookmark_file_add_item (bookmark, item, NULL);
3034 if (name && name[0] != '\0')
3035 app_name = g_strdup (name);
3037 app_name = g_strdup (g_get_application_name ());
3039 if (exec && exec[0] != '\0')
3040 app_exec = g_strdup (exec);
3042 app_exec = g_strjoin (" ", g_get_prgname(), "%u", NULL);
3044 g_bookmark_file_set_app_info (bookmark, uri,
3056 * g_bookmark_file_remove_application:
3057 * @bookmark: a #GBookmarkFile
3059 * @name: the name of the application
3060 * @error: return location for a #GError or %NULL
3062 * Removes application registered with @name from the list of applications
3063 * that have registered a bookmark for @uri inside @bookmark.
3065 * In the event the URI cannot be found, %FALSE is returned and
3066 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3067 * In the event that no application with name @app_name has registered
3068 * a bookmark for @uri, %FALSE is returned and error is set to
3069 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
3071 * Return value: %TRUE if the application was successfully removed.
3076 g_bookmark_file_remove_application (GBookmarkFile *bookmark,
3084 g_return_val_if_fail (bookmark != NULL, FALSE);
3085 g_return_val_if_fail (uri != NULL, FALSE);
3086 g_return_val_if_fail (name != NULL, FALSE);
3089 retval = g_bookmark_file_set_app_info (bookmark, uri,
3097 g_propagate_error (error, set_error);
3106 * g_bookmark_file_has_application:
3107 * @bookmark: a #GBookmarkFile
3109 * @name: the name of the application
3110 * @error: return location for a #GError or %NULL
3112 * Checks whether the bookmark for @uri inside @bookmark has been
3113 * registered by application @name.
3115 * In the event the URI cannot be found, %FALSE is returned and
3116 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3118 * Return value: %TRUE if the application @name was found
3123 g_bookmark_file_has_application (GBookmarkFile *bookmark,
3130 g_return_val_if_fail (bookmark != NULL, FALSE);
3131 g_return_val_if_fail (uri != NULL, FALSE);
3132 g_return_val_if_fail (name != NULL, FALSE);
3134 item = g_bookmark_file_lookup_item (bookmark, uri);
3137 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3138 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3139 _("No bookmark found for URI '%s'"),
3144 return (NULL != bookmark_item_lookup_app_info (item, name));
3148 * g_bookmark_file_set_app_info:
3149 * @bookmark: a #GBookmarkFile
3151 * @name: an application's name
3152 * @exec: an application's command line
3153 * @count: the number of registrations done for this application
3154 * @stamp: the time of the last registration for this application
3155 * @error: return location for a #GError or %NULL
3157 * Sets the meta-data of application @name inside the list of
3158 * applications that have registered a bookmark for @uri inside
3161 * You should rarely use this function; use g_bookmark_file_add_application()
3162 * and g_bookmark_file_remove_application() instead.
3164 * @name can be any UTF-8 encoded string used to identify an
3166 * @exec can have one of these two modifiers: "%f", which will
3167 * be expanded as the local file name retrieved from the bookmark's
3168 * URI; "%u", which will be expanded as the bookmark's URI.
3169 * The expansion is done automatically when retrieving the stored
3170 * command line using the g_bookmark_file_get_app_info() function.
3171 * @count is the number of times the application has registered the
3172 * bookmark; if is < 0, the current registration count will be increased
3173 * by one, if is 0, the application with @name will be removed from
3174 * the list of registered applications.
3175 * @stamp is the Unix time of the last registration; if it is -1, the
3176 * current time will be used.
3178 * If you try to remove an application by setting its registration count to
3179 * zero, and no bookmark for @uri is found, %FALSE is returned and
3180 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
3181 * in the event that no application @name has registered a bookmark
3182 * for @uri, %FALSE is returned and error is set to
3183 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark
3184 * for @uri is found, one is created.
3186 * Return value: %TRUE if the application's meta-data was successfully
3192 g_bookmark_file_set_app_info (GBookmarkFile *bookmark,
3201 BookmarkAppInfo *ai;
3203 g_return_val_if_fail (bookmark != NULL, FALSE);
3204 g_return_val_if_fail (uri != NULL, FALSE);
3205 g_return_val_if_fail (name != NULL, FALSE);
3206 g_return_val_if_fail (exec != NULL, FALSE);
3208 item = g_bookmark_file_lookup_item (bookmark, uri);
3213 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3214 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3215 _("No bookmark found for URI '%s'"),
3221 item = bookmark_item_new (uri);
3222 g_bookmark_file_add_item (bookmark, item, NULL);
3226 ai = bookmark_item_lookup_app_info (item, name);
3231 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3232 G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3233 _("No application with name '%s' registered a bookmark for '%s'"),
3240 ai = bookmark_app_info_new (name);
3242 item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
3243 g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
3249 item->metadata->applications = g_list_remove (item->metadata->applications, ai);
3250 g_hash_table_remove (item->metadata->apps_by_name, ai->name);
3252 item->modified = time (NULL);
3261 if (stamp != (time_t) -1)
3264 ai->stamp = time (NULL);
3266 if (exec && exec[0] != '\0')
3269 ai->exec = g_strdup (exec);
3272 item->modified = time (NULL);
3277 /* expands the application's command line */
3279 expand_exec_line (const gchar *exec_fmt,
3285 exec = g_string_new (NULL);
3286 while ((ch = *exec_fmt++) != '\0')
3290 exec = g_string_append_c (exec, ch);
3300 g_string_append (exec, uri);
3304 gchar *file = g_filename_from_uri (uri, NULL, NULL);
3305 g_string_append (exec, file);
3311 exec = g_string_append_c (exec, ch);
3317 return g_string_free (exec, FALSE);
3321 * g_bookmark_file_get_app_info:
3322 * @bookmark: a #GBookmarkFile
3324 * @name: an application's name
3325 * @exec: location for the command line of the application, or %NULL
3326 * @count: return location for the registration count, or %NULL
3327 * @stamp: return location for the last registration time, or %NULL
3328 * @error: return location for a #GError, or %NULL
3330 * Gets the registration informations of @app_name for the bookmark for
3331 * @uri. See g_bookmark_file_set_app_info() for more informations about
3332 * the returned data.
3334 * The string returned in @app_exec must be freed.
3336 * In the event the URI cannot be found, %FALSE is returned and
3337 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
3338 * event that no application with name @app_name has registered a bookmark
3339 * for @uri, %FALSE is returned and error is set to
3340 * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
3342 * Return value: %TRUE on success.
3347 g_bookmark_file_get_app_info (GBookmarkFile *bookmark,
3356 BookmarkAppInfo *ai;
3358 g_return_val_if_fail (bookmark != NULL, FALSE);
3359 g_return_val_if_fail (uri != NULL, FALSE);
3360 g_return_val_if_fail (name != NULL, FALSE);
3362 item = g_bookmark_file_lookup_item (bookmark, uri);
3365 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3366 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3367 _("No bookmark found for URI '%s'"),
3372 ai = bookmark_item_lookup_app_info (item, name);
3375 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3376 G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3377 _("No application with name '%s' registered a bookmark for '%s'"),
3384 *exec = expand_exec_line (ai->exec, uri);
3396 * g_bookmark_file_get_applications:
3397 * @bookmark: a #GBookmarkFile
3399 * @length: return location of the length of the returned list, or %NULL
3400 * @error: return location for a #GError, or %NULL
3402 * Retrieves the names of the applications that have registered the
3403 * bookmark for @uri.
3405 * In the event the URI cannot be found, %NULL is returned and
3406 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3408 * Return value: a newly allocated %NULL-terminated array of strings.
3409 * Use g_strfreev() to free it.
3414 g_bookmark_file_get_applications (GBookmarkFile *bookmark,
3424 g_return_val_if_fail (bookmark != NULL, NULL);
3425 g_return_val_if_fail (uri != NULL, NULL);
3427 item = g_bookmark_file_lookup_item (bookmark, uri);
3430 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3431 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3432 _("No bookmark found for URI '%s'"),
3437 if (!item->metadata)
3445 n_apps = g_list_length (item->metadata->applications);
3446 apps = g_new0 (gchar *, n_apps + 1);
3448 for (l = g_list_last (item->metadata->applications), i = 0;
3452 BookmarkAppInfo *ai;
3454 ai = (BookmarkAppInfo *) l->data;
3456 g_assert (ai != NULL);
3457 g_assert (ai->name != NULL);
3459 apps[i++] = g_strdup (ai->name);
3470 * g_bookmark_file_get_size:
3471 * @bookmark: a #GBookmarkFile
3473 * Gets the number of bookmarks inside @bookmark.
3475 * Return value: the number of bookmarks
3480 g_bookmark_file_get_size (GBookmarkFile *bookmark)
3482 g_return_val_if_fail (bookmark != NULL, 0);
3484 return g_list_length (bookmark->items);
3488 * g_bookmark_file_move_item:
3489 * @bookmark: a #GBookmarkFile
3490 * @old_uri: a valid URI
3491 * @new_uri: a valid URI, or %NULL
3492 * @error: return location for a #GError or %NULL
3494 * Changes the URI of a bookmark item from @old_uri to @new_uri. Any
3495 * existing bookmark for @new_uri will be overwritten. If @new_uri is
3496 * %NULL, then the bookmark is removed.
3498 * In the event the URI cannot be found, %FALSE is returned and
3499 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3501 * Return value: %TRUE if the URI was successfully changed
3506 g_bookmark_file_move_item (GBookmarkFile *bookmark,
3507 const gchar *old_uri,
3508 const gchar *new_uri,
3512 GError *remove_error;
3514 g_return_val_if_fail (bookmark != NULL, FALSE);
3515 g_return_val_if_fail (old_uri != NULL, FALSE);
3517 item = g_bookmark_file_lookup_item (bookmark, old_uri);
3520 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3521 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3522 _("No bookmark found for URI '%s'"),
3527 if (new_uri && new_uri[0] != '\0')
3529 if (g_bookmark_file_has_item (bookmark, new_uri))
3531 remove_error = NULL;
3532 g_bookmark_file_remove_item (bookmark, new_uri, &remove_error);
3535 g_propagate_error (error, remove_error);
3541 g_hash_table_steal (bookmark->items_by_uri, item->uri);
3544 item->uri = g_strdup (new_uri);
3545 item->modified = time (NULL);
3547 g_hash_table_replace (bookmark->items_by_uri, item->uri, item);
3553 remove_error = NULL;
3554 g_bookmark_file_remove_item (bookmark, old_uri, &remove_error);
3557 g_propagate_error (error, remove_error);
3567 * g_bookmark_file_set_icon:
3568 * @bookmark: a #GBookmarkFile
3570 * @href: the URI of the icon for the bookmark, or %NULL
3571 * @mime_type: the MIME type of the icon for the bookmark
3573 * Sets the icon for the bookmark for @uri. If @href is %NULL, unsets
3574 * the currently set icon.
3576 * If no bookmark for @uri is found it is created.
3581 g_bookmark_file_set_icon (GBookmarkFile *bookmark,
3584 const gchar *mime_type)
3588 g_return_if_fail (bookmark != NULL);
3589 g_return_if_fail (uri != NULL);
3591 item = g_bookmark_file_lookup_item (bookmark, uri);
3594 item = bookmark_item_new (uri);
3595 g_bookmark_file_add_item (bookmark, item, NULL);
3598 if (!item->metadata)
3599 item->metadata = bookmark_metadata_new ();
3601 g_free (item->metadata->icon_href);
3602 g_free (item->metadata->icon_mime);
3604 item->metadata->icon_href = g_strdup (href);
3606 if (mime_type && mime_type[0] != '\0')
3607 item->metadata->icon_mime = g_strdup (mime_type);
3609 item->metadata->icon_mime = g_strdup ("application/octet-stream");
3611 item->modified = time (NULL);
3615 * g_bookmark_file_get_icon:
3616 * @bookmark: a #GBookmarkFile
3618 * @href: return location for the icon's location or %NULL
3619 * @mime_type: return location for the icon's MIME type or %NULL
3620 * @error: return location for a #GError or %NULL
3622 * Gets the icon of the bookmark for @uri.
3624 * In the event the URI cannot be found, %FALSE is returned and
3625 * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3627 * Return value: %TRUE if the icon for the bookmark for the URI was found.
3628 * You should free the returned strings.
3633 g_bookmark_file_get_icon (GBookmarkFile *bookmark,
3641 g_return_val_if_fail (bookmark != NULL, FALSE);
3642 g_return_val_if_fail (uri != NULL, FALSE);
3644 item = g_bookmark_file_lookup_item (bookmark, uri);
3647 g_set_error (error, G_BOOKMARK_FILE_ERROR,
3648 G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3649 _("No bookmark found for URI '%s'"),
3654 if ((!item->metadata) || (!item->metadata->icon_href))
3658 *href = g_strdup (item->metadata->icon_href);
3661 *mime_type = g_strdup (item->metadata->icon_mime);
3666 #define __G_BOOKMARK_FILE_C__
3667 #include "galiasdef.c"