glib/gbookmarkfile.c

   1 /* gbookmarkfile.c: parsing and building desktop bookmarks
   2  *
   3  * Copyright (C) 2005-2006 Emmanuele Bassi
   4  *
   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.
   9  *
  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.
  14  *
  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,
  18  */
  19
  20 #include "config.h"
  21
  22 #include "gbookmarkfile.h"
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <errno.h>
  28 #include <fcntl.h>
  29 #include <locale.h>
  30 #include <time.h>
  31 #include <stdarg.h>
  32 #include <sys/types.h>
  33 #include <sys/stat.h>
  34 #ifdef HAVE_UNISTD_H
  35 #include <unistd.h>
  36 #endif
  37
  38 #include "gconvert.h"
  39 #include "gdataset.h"
  40 #include "gerror.h"
  41 #include "gfileutils.h"
  42 #include "ghash.h"
  43 #include "glibintl.h"
  44 #include "glist.h"
  45 #include "gslist.h"
  46 #include "gmain.h"
  47 #include "gmarkup.h"
  48 #include "gmem.h"
  49 #include "gmessages.h"
  50 #include "gshell.h"
  51 #include "gslice.h"
  52 #include "gstdio.h"
  53 #include "gstring.h"
  54 #include "gstrfuncs.h"
  55 #include "gtimer.h"
  56 #include "gutils.h"
  57
  58
  59 /**
  60  * SECTION:bookmarkfile
  61  * @title: Bookmark file parser
  62  * @short_description: parses files containing bookmarks
  63  *
  64  * GBookmarkFile lets you parse, edit or create files containing bookmarks
  65  * to URI, along with some meta-data about the resource pointed by the URI
  66  * like its MIME type, the application that is registering the bookmark and
  67  * the icon that should be used to represent the bookmark. The data is stored
  68  * using the
  69  * <ulink url="http://www.gnome.org/~ebassi/bookmark-spec">Desktop Bookmark
  70  * Specification</ulink>.
  71  *
  72  * The syntax of the bookmark files is described in detail inside the Desktop
  73  * Bookmark Specification, here is a quick summary: bookmark files use a
  74  * sub-class of the <ulink url="">XML Bookmark Exchange Language</ulink>
  75  * specification, consisting of valid UTF-8 encoded XML, under the
  76  * <literal>xbel</literal> root element; each bookmark is stored inside a
  77  * <literal>bookmark</literal> element, using its URI: no relative paths can
  78  * be used inside a bookmark file. The bookmark may have a user defined title
  79  * and description, to be used instead of the URI. Under the
  80  * <literal>metadata</literal> element, with its <literal>owner</literal>
  81  * attribute set to <literal>http://freedesktop.org</literal>, is stored the
  82  * meta-data about a resource pointed by its URI. The meta-data consists of
  83  * the resource's MIME type; the applications that have registered a bookmark;
  84  * the groups to which a bookmark belongs to; a visibility flag, used to set
  85  * the bookmark as "private" to the applications and groups that has it
  86  * registered; the URI and MIME type of an icon, to be used when displaying
  87  * the bookmark inside a GUI.
  88  * |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../glib/tests/bookmarks.xbel"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]|
  89  *
  90  * A bookmark file might contain more than one bookmark; each bookmark
  91  * is accessed through its URI.
  92  *
  93  * The important caveat of bookmark files is that when you add a new
  94  * bookmark you must also add the application that is registering it, using
  95  * g_bookmark_file_add_application() or g_bookmark_file_set_app_info().
  96  * If a bookmark has no applications then it won't be dumped when creating
  97  * the on disk representation, using g_bookmark_file_to_data() or
  98  * g_bookmark_file_to_file().
  99  *
 100  * The #GBookmarkFile parser was added in GLib 2.12.
 101  */
 102
 103 /* XBEL 1.0 standard entities */
 104 #define XBEL_VERSION            "1.0"
 105 #define XBEL_DTD_NICK           "xbel"
 106 #define XBEL_DTD_SYSTEM         "+//IDN python.org//DTD XML Bookmark " \
 107                                 "Exchange Language 1.0//EN//XML"
 108
 109 #define XBEL_DTD_URI            "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"
 110
 111 #define XBEL_ROOT_ELEMENT       "xbel"
 112 #define XBEL_FOLDER_ELEMENT     "folder"        /* unused */
 113 #define XBEL_BOOKMARK_ELEMENT   "bookmark"
 114 #define XBEL_ALIAS_ELEMENT      "alias"         /* unused */
 115 #define XBEL_SEPARATOR_ELEMENT  "separator"     /* unused */
 116 #define XBEL_TITLE_ELEMENT      "title"
 117 #define XBEL_DESC_ELEMENT       "desc"
 118 #define XBEL_INFO_ELEMENT       "info"
 119 #define XBEL_METADATA_ELEMENT   "metadata"
 120
 121 #define XBEL_VERSION_ATTRIBUTE  "version"
 122 #define XBEL_FOLDED_ATTRIBUTE   "folded"        /* unused */
 123 #define XBEL_OWNER_ATTRIBUTE    "owner"
 124 #define XBEL_ADDED_ATTRIBUTE    "added"
 125 #define XBEL_VISITED_ATTRIBUTE  "visited"
 126 #define XBEL_MODIFIED_ATTRIBUTE "modified"
 127 #define XBEL_ID_ATTRIBUTE       "id"
 128 #define XBEL_HREF_ATTRIBUTE     "href"
 129 #define XBEL_REF_ATTRIBUTE      "ref"           /* unused */
 130
 131 #define XBEL_YES_VALUE          "yes"
 132 #define XBEL_NO_VALUE           "no"
 133
 134 /* Desktop bookmark spec entities */
 135 #define BOOKMARK_METADATA_OWNER         "http://freedesktop.org"
 136
 137 #define BOOKMARK_NAMESPACE_NAME         "bookmark"
 138 #define BOOKMARK_NAMESPACE_URI          "http://www.freedesktop.org/standards/desktop-bookmarks"
 139
 140 #define BOOKMARK_GROUPS_ELEMENT         "groups"
 141 #define BOOKMARK_GROUP_ELEMENT          "group"
 142 #define BOOKMARK_APPLICATIONS_ELEMENT   "applications"
 143 #define BOOKMARK_APPLICATION_ELEMENT    "application"
 144 #define BOOKMARK_ICON_ELEMENT           "icon"
 145 #define BOOKMARK_PRIVATE_ELEMENT        "private"
 146
 147 #define BOOKMARK_NAME_ATTRIBUTE         "name"
 148 #define BOOKMARK_EXEC_ATTRIBUTE         "exec"
 149 #define BOOKMARK_COUNT_ATTRIBUTE        "count"
 150 #define BOOKMARK_TIMESTAMP_ATTRIBUTE    "timestamp"     /* deprecated by "modified" */
 151 #define BOOKMARK_MODIFIED_ATTRIBUTE     "modified"
 152 #define BOOKMARK_HREF_ATTRIBUTE         "href"
 153 #define BOOKMARK_TYPE_ATTRIBUTE         "type"
 154
 155 /* Shared MIME Info entities */
 156 #define MIME_NAMESPACE_NAME             "mime"
 157 #define MIME_NAMESPACE_URI              "http://www.freedesktop.org/standards/shared-mime-info"
 158 #define MIME_TYPE_ELEMENT               "mime-type"
 159 #define MIME_TYPE_ATTRIBUTE             "type"
 160
 161
 162 typedef struct _BookmarkAppInfo  BookmarkAppInfo;
 163 typedef struct _BookmarkMetadata BookmarkMetadata;
 164 typedef struct _BookmarkItem     BookmarkItem;
 165 typedef struct _ParseData        ParseData;
 166
 167 struct _BookmarkAppInfo
 168 {
 169   gchar *name;
 170   gchar *exec;
 171
 172   guint count;
 173
 174   time_t stamp;
 175 };
 176
 177 struct _BookmarkMetadata
 178 {
 179   gchar *mime_type;
 180
 181   GList *groups;
 182
 183   GList *applications;
 184   GHashTable *apps_by_name;
 185
 186   gchar *icon_href;
 187   gchar *icon_mime;
 188
 189   guint is_private : 1;
 190 };
 191
 192 struct _BookmarkItem
 193 {
 194   gchar *uri;
 195
 196   gchar *title;
 197   gchar *description;
 198
 199   time_t added;
 200   time_t modified;
 201   time_t visited;
 202
 203   BookmarkMetadata *metadata;
 204 };
 205
 206 struct _GBookmarkFile
 207 {
 208   gchar *title;
 209   gchar *description;
 210
 211   /* we store our items in a list and keep a copy inside
 212    * an hash table for faster lookup performances
 213    */
 214   GList *items;
 215   GHashTable *items_by_uri;
 216 };
 217
 218 /* parser state machine */
 219 enum
 220 {
 221   STATE_STARTED        = 0,
 222
 223   STATE_ROOT,
 224   STATE_BOOKMARK,
 225   STATE_TITLE,
 226   STATE_DESC,
 227   STATE_INFO,
 228   STATE_METADATA,
 229   STATE_APPLICATIONS,
 230   STATE_APPLICATION,
 231   STATE_GROUPS,
 232   STATE_GROUP,
 233   STATE_MIME,
 234   STATE_ICON,
 235
 236   STATE_FINISHED
 237 };
 238
 239 static void          g_bookmark_file_init        (GBookmarkFile  *bookmark);
 240 static void          g_bookmark_file_clear       (GBookmarkFile  *bookmark);
 241 static gboolean      g_bookmark_file_parse       (GBookmarkFile  *bookmark,
 242                                                   const gchar    *buffer,
 243                                                   gsize           length,
 244                                                   GError        **error);
 245 static gchar *       g_bookmark_file_dump        (GBookmarkFile  *bookmark,
 246                                                   gsize          *length,
 247                                                   GError        **error);
 248 static BookmarkItem *g_bookmark_file_lookup_item (GBookmarkFile  *bookmark,
 249                                                   const gchar    *uri);
 250 static void          g_bookmark_file_add_item    (GBookmarkFile  *bookmark,
 251                                                   BookmarkItem   *item,
 252                                                   GError        **error);
 253
 254 static time_t  timestamp_from_iso8601 (const gchar *iso_date);
 255 static gchar * timestamp_to_iso8601   (time_t       timestamp);
 256
 257 /********************************
 258  * BookmarkAppInfo              *
 259  *                              *
 260  * Application metadata storage *
 261  ********************************/
 262 static BookmarkAppInfo *
 263 bookmark_app_info_new (const gchar *name)
 264 {
 265   BookmarkAppInfo *retval;
 266
 267   g_warn_if_fail (name != NULL);
 268
 269   retval = g_slice_new (BookmarkAppInfo);
 270
 271   retval->name = g_strdup (name);
 272   retval->exec = NULL;
 273   retval->count = 0;
 274   retval->stamp = 0;
 275
 276   return retval;
 277 }
 278
 279 static void
 280 bookmark_app_info_free (BookmarkAppInfo *app_info)
 281 {
 282   if (!app_info)
 283     return;
 284
 285   g_free (app_info->name);
 286   g_free (app_info->exec);
 287
 288   g_slice_free (BookmarkAppInfo, app_info);
 289 }
 290
 291 static gchar *
 292 bookmark_app_info_dump (BookmarkAppInfo *app_info)
 293 {
 294   gchar *retval;
 295   gchar *name, *exec, *modified, *count;
 296
 297   g_warn_if_fail (app_info != NULL);
 298
 299   if (app_info->count == 0)
 300     return NULL;
 301
 302   name = g_markup_escape_text (app_info->name, -1);
 303   exec = g_markup_escape_text (app_info->exec, -1);
 304   modified = timestamp_to_iso8601 (app_info->stamp);
 305   count = g_strdup_printf ("%u", app_info->count);
 306
 307   retval = g_strconcat ("          "
 308                         "<" BOOKMARK_NAMESPACE_NAME ":" BOOKMARK_APPLICATION_ELEMENT
 309                         " " BOOKMARK_NAME_ATTRIBUTE "=\"", name, "\""
 310                         " " BOOKMARK_EXEC_ATTRIBUTE "=\"", exec, "\""
 311                         " " BOOKMARK_MODIFIED_ATTRIBUTE "=\"", modified, "\""
 312                         " " BOOKMARK_COUNT_ATTRIBUTE "=\"", count, "\"/>\n",
 313                         NULL);
 314
 315   g_free (name);
 316   g_free (exec);
 317   g_free (modified);
 318   g_free (count);
 319
 320   return retval;
 321 }
 322
 323
 324 /***********************
 325  * BookmarkMetadata    *
 326  *                     *
 327  * Metadata storage    *
 328  ***********************/
 329 static BookmarkMetadata *
 330 bookmark_metadata_new (void)
 331 {
 332   BookmarkMetadata *retval;
 333
 334   retval = g_slice_new (BookmarkMetadata);
 335
 336   retval->mime_type = NULL;
 337
 338   retval->groups = NULL;
 339
 340   retval->applications = NULL;
 341   retval->apps_by_name = g_hash_table_new_full (g_str_hash,
 342                                                 g_str_equal,
 343                                                 NULL,
 344                                                 NULL);
 345
 346   retval->is_private = FALSE;
 347
 348   retval->icon_href = NULL;
 349   retval->icon_mime = NULL;
 350
 351   return retval;
 352 }
 353
 354 static void
 355 bookmark_metadata_free (BookmarkMetadata *metadata)
 356 {
 357   if (!metadata)
 358     return;
 359
 360   g_free (metadata->mime_type);
 361
 362   g_list_free_full (metadata->groups, g_free);
 363   g_list_free_full (metadata->applications, (GDestroyNotify) bookmark_app_info_free);
 364
 365   g_hash_table_destroy (metadata->apps_by_name);
 366
 367   g_free (metadata->icon_href);
 368   g_free (metadata->icon_mime);
 369
 370   g_slice_free (BookmarkMetadata, metadata);
 371 }
 372
 373 static gchar *
 374 bookmark_metadata_dump (BookmarkMetadata *metadata)
 375 {
 376   GString *retval;
 377   gchar *buffer;
 378
 379   if (!metadata->applications)
 380     return NULL;
 381
 382   retval = g_string_sized_new (1024);
 383
 384   /* metadata container */
 385   g_string_append (retval,
 386                    "      "
 387                    "<" XBEL_METADATA_ELEMENT
 388                    " " XBEL_OWNER_ATTRIBUTE "=\"" BOOKMARK_METADATA_OWNER
 389                    "\">\n");
 390
 391   /* mime type */
 392   if (metadata->mime_type) {
 393     buffer = g_strconcat ("        "
 394                           "<" MIME_NAMESPACE_NAME ":" MIME_TYPE_ELEMENT " "
 395                           MIME_TYPE_ATTRIBUTE "=\"", metadata->mime_type, "\"/>\n",
 396                           NULL);
 397     g_string_append (retval, buffer);
 398     g_free (buffer);
 399   }
 400
 401   if (metadata->groups)
 402     {
 403       GList *l;
 404
 405       /* open groups container */
 406       g_string_append (retval,
 407                        "        "
 408                        "<" BOOKMARK_NAMESPACE_NAME
 409                        ":" BOOKMARK_GROUPS_ELEMENT ">\n");
 410
 411       for (l = g_list_last (metadata->groups); l != NULL; l = l->prev)
 412         {
 413           gchar *group_name;
 414
 415           group_name = g_markup_escape_text ((gchar *) l->data, -1);
 416           buffer = g_strconcat ("          "
 417                                 "<" BOOKMARK_NAMESPACE_NAME
 418                                 ":" BOOKMARK_GROUP_ELEMENT ">",
 419                                 group_name,
 420                                 "</" BOOKMARK_NAMESPACE_NAME
 421                                 ":"  BOOKMARK_GROUP_ELEMENT ">\n", NULL);
 422           g_string_append (retval, buffer);
 423
 424           g_free (buffer);
 425           g_free (group_name);
 426         }
 427
 428       /* close groups container */
 429       g_string_append (retval,
 430                        "        "
 431                        "</" BOOKMARK_NAMESPACE_NAME
 432                        ":" BOOKMARK_GROUPS_ELEMENT ">\n");
 433     }
 434
 435   if (metadata->applications)
 436     {
 437       GList *l;
 438
 439       /* open applications container */
 440       g_string_append (retval,
 441                        "        "
 442                        "<" BOOKMARK_NAMESPACE_NAME
 443                        ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");
 444
 445       for (l = g_list_last (metadata->applications); l != NULL; l = l->prev)
 446         {
 447           BookmarkAppInfo *app_info = (BookmarkAppInfo *) l->data;
 448           gchar *app_data;
 449
 450           g_warn_if_fail (app_info != NULL);
 451
 452           app_data = bookmark_app_info_dump (app_info);
 453
 454           if (app_data)
 455             {
 456               retval = g_string_append (retval, app_data);
 457
 458               g_free (app_data);
 459             }
 460         }
 461
 462       /* close applications container */
 463       g_string_append (retval,
 464                        "        "
 465                        "</" BOOKMARK_NAMESPACE_NAME
 466                        ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");
 467     }
 468
 469   /* icon */
 470   if (metadata->icon_href)
 471     {
 472       if (!metadata->icon_mime)
 473         metadata->icon_mime = g_strdup ("application/octet-stream");
 474
 475       buffer = g_strconcat ("       "
 476                             "<" BOOKMARK_NAMESPACE_NAME
 477                             ":" BOOKMARK_ICON_ELEMENT
 478                             " " BOOKMARK_HREF_ATTRIBUTE "=\"", metadata->icon_href,
 479                             "\" " BOOKMARK_TYPE_ATTRIBUTE "=\"", metadata->icon_mime, "\"/>\n", NULL);
 480       g_string_append (retval, buffer);
 481
 482       g_free (buffer);
 483     }
 484
 485   /* private hint */
 486   if (metadata->is_private)
 487     g_string_append (retval,
 488                      "        "
 489                      "<" BOOKMARK_NAMESPACE_NAME
 490                      ":" BOOKMARK_PRIVATE_ELEMENT "/>\n");
 491
 492   /* close metadata container */
 493   g_string_append (retval,
 494                    "      "
 495                    "</" XBEL_METADATA_ELEMENT ">\n");
 496
 497   return g_string_free (retval, FALSE);
 498 }
 499
 500 /******************************************************
 501  * BookmarkItem                                       *
 502  *                                                    *
 503  * Storage for a single bookmark item inside the list *
 504  ******************************************************/
 505 static BookmarkItem *
 506 bookmark_item_new (const gchar *uri)
 507 {
 508   BookmarkItem *item;
 509
 510   g_warn_if_fail (uri != NULL);
 511
 512   item = g_slice_new (BookmarkItem);
 513   item->uri = g_strdup (uri);
 514
 515   item->title = NULL;
 516   item->description = NULL;
 517
 518   item->added = (time_t) -1;
 519   item->modified = (time_t) -1;
 520   item->visited = (time_t) -1;
 521
 522   item->metadata = NULL;
 523
 524   return item;
 525 }
 526
 527 static void
 528 bookmark_item_free (BookmarkItem *item)
 529 {
 530   if (!item)
 531     return;
 532
 533   g_free (item->uri);
 534   g_free (item->title);
 535   g_free (item->description);
 536
 537   if (item->metadata)
 538     bookmark_metadata_free (item->metadata);
 539
 540   g_slice_free (BookmarkItem, item);
 541 }
 542
 543 static gchar *
 544 bookmark_item_dump (BookmarkItem *item)
 545 {
 546   GString *retval;
 547   gchar *added, *visited, *modified;
 548   gchar *escaped_uri;
 549   gchar *buffer;
 550
 551   /* at this point, we must have at least a registered application; if we don't
 552    * we don't screw up the bookmark file, and just skip this item
 553    */
 554   if (!item->metadata || !item->metadata->applications)
 555     {
 556       g_warning ("Item for URI '%s' has no registered applications: skipping.\n", item->uri);
 557       return NULL;
 558     }
 559
 560   retval = g_string_sized_new (4096);
 561
 562   added = timestamp_to_iso8601 (item->added);
 563   modified = timestamp_to_iso8601 (item->modified);
 564   visited = timestamp_to_iso8601 (item->visited);
 565
 566   escaped_uri = g_markup_escape_text (item->uri, -1);
 567
 568   buffer = g_strconcat ("  <"
 569                         XBEL_BOOKMARK_ELEMENT
 570                         " "
 571                         XBEL_HREF_ATTRIBUTE "=\"", escaped_uri, "\" "
 572                         XBEL_ADDED_ATTRIBUTE "=\"", added, "\" "
 573                         XBEL_MODIFIED_ATTRIBUTE "=\"", modified, "\" "
 574                         XBEL_VISITED_ATTRIBUTE "=\"", visited, "\">\n",
 575                         NULL);
 576
 577   g_string_append (retval, buffer);
 578
 579   g_free (escaped_uri);
 580   g_free (visited);
 581   g_free (modified);
 582   g_free (added);
 583   g_free (buffer);
 584
 585   if (item->title)
 586     {
 587       gchar *escaped_title;
 588
 589       escaped_title = g_markup_escape_text (item->title, -1);
 590       buffer = g_strconcat ("    "
 591                             "<" XBEL_TITLE_ELEMENT ">",
 592                             escaped_title,
 593                             "</" XBEL_TITLE_ELEMENT ">\n",
 594                             NULL);
 595       g_string_append (retval, buffer);
 596
 597       g_free (escaped_title);
 598       g_free (buffer);
 599     }
 600
 601   if (item->description)
 602     {
 603       gchar *escaped_desc;
 604
 605       escaped_desc = g_markup_escape_text (item->description, -1);
 606       buffer = g_strconcat ("    "
 607                             "<" XBEL_DESC_ELEMENT ">",
 608                             escaped_desc,
 609                             "</" XBEL_DESC_ELEMENT ">\n",
 610                             NULL);
 611       g_string_append (retval, buffer);
 612
 613       g_free (escaped_desc);
 614       g_free (buffer);
 615     }
 616
 617   if (item->metadata)
 618     {
 619       gchar *metadata;
 620
 621       metadata = bookmark_metadata_dump (item->metadata);
 622       if (metadata)
 623         {
 624           buffer = g_strconcat ("    "
 625                                 "<" XBEL_INFO_ELEMENT ">\n",
 626                                 metadata,
 627                                 "    "
 628                                 "</" XBEL_INFO_ELEMENT ">\n",
 629                                 NULL);
 630           retval = g_string_append (retval, buffer);
 631
 632           g_free (buffer);
 633           g_free (metadata);
 634         }
 635     }
 636
 637   g_string_append (retval, "  </" XBEL_BOOKMARK_ELEMENT ">\n");
 638
 639   return g_string_free (retval, FALSE);
 640 }
 641
 642 static BookmarkAppInfo *
 643 bookmark_item_lookup_app_info (BookmarkItem *item,
 644                                const gchar  *app_name)
 645 {
 646   g_warn_if_fail (item != NULL && app_name != NULL);
 647
 648   if (!item->metadata)
 649     return NULL;
 650
 651   return g_hash_table_lookup (item->metadata->apps_by_name, app_name);
 652 }
 653
 654 /*************************
 655  *    GBookmarkFile    *
 656  *************************/
 657
 658 static void
 659 g_bookmark_file_init (GBookmarkFile *bookmark)
 660 {
 661   bookmark->title = NULL;
 662   bookmark->description = NULL;
 663
 664   bookmark->items = NULL;
 665   bookmark->items_by_uri = g_hash_table_new_full (g_str_hash,
 666                                                   g_str_equal,
 667                                                   NULL,
 668                                                   NULL);
 669 }
 670
 671 static void
 672 g_bookmark_file_clear (GBookmarkFile *bookmark)
 673 {
 674   g_free (bookmark->title);
 675   g_free (bookmark->description);
 676
 677   g_list_free_full (bookmark->items, (GDestroyNotify) bookmark_item_free);
 678   bookmark->items = NULL;
 679
 680   if (bookmark->items_by_uri)
 681     {
 682       g_hash_table_destroy (bookmark->items_by_uri);
 683
 684       bookmark->items_by_uri = NULL;
 685     }
 686 }
 687
 688 struct _ParseData
 689 {
 690   gint state;
 691
 692   GHashTable *namespaces;
 693
 694   GBookmarkFile *bookmark_file;
 695   BookmarkItem *current_item;
 696 };
 697
 698 static ParseData *
 699 parse_data_new (void)
 700 {
 701   ParseData *retval;
 702
 703   retval = g_new (ParseData, 1);
 704
 705   retval->state = STATE_STARTED;
 706   retval->namespaces = g_hash_table_new_full (g_str_hash, g_str_equal,
 707                                               (GDestroyNotify) g_free,
 708                                               (GDestroyNotify) g_free);
 709   retval->bookmark_file = NULL;
 710   retval->current_item = NULL;
 711
 712   return retval;
 713 }
 714
 715 static void
 716 parse_data_free (ParseData *parse_data)
 717 {
 718   g_hash_table_destroy (parse_data->namespaces);
 719
 720   g_free (parse_data);
 721 }
 722
 723 #define IS_ATTRIBUTE(s,a)       ((0 == strcmp ((s), (a))))
 724
 725 static void
 726 parse_bookmark_element (GMarkupParseContext  *context,
 727                         ParseData            *parse_data,
 728                         const gchar         **attribute_names,
 729                         const gchar         **attribute_values,
 730                         GError              **error)
 731 {
 732   const gchar *uri, *added, *modified, *visited;
 733   const gchar *attr;
 734   gint i;
 735   BookmarkItem *item;
 736   GError *add_error;
 737
 738   g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_BOOKMARK));
 739
 740   i = 0;
 741   uri = added = modified = visited = NULL;
 742   for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
 743     {
 744       if (IS_ATTRIBUTE (attr, XBEL_HREF_ATTRIBUTE))
 745         uri = attribute_values[i];
 746       else if (IS_ATTRIBUTE (attr, XBEL_ADDED_ATTRIBUTE))
 747         added = attribute_values[i];
 748       else if (IS_ATTRIBUTE (attr, XBEL_MODIFIED_ATTRIBUTE))
 749         modified = attribute_values[i];
 750       else if (IS_ATTRIBUTE (attr, XBEL_VISITED_ATTRIBUTE))
 751         visited = attribute_values[i];
 752       else
 753         {
 754           /* bookmark is defined by the XBEL spec, so we need
 755            * to error out if the element has different or
 756            * missing attributes
 757            */
 758           g_set_error (error, G_MARKUP_ERROR,
 759                        G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
 760                        _("Unexpected attribute '%s' for element '%s'"),
 761                        attr,
 762                        XBEL_BOOKMARK_ELEMENT);
 763           return;
 764         }
 765     }
 766
 767   if (!uri)
 768     {
 769       g_set_error (error, G_MARKUP_ERROR,
 770                    G_MARKUP_ERROR_INVALID_CONTENT,
 771                    _("Attribute '%s' of element '%s' not found"),
 772                    XBEL_HREF_ATTRIBUTE,
 773                    XBEL_BOOKMARK_ELEMENT);
 774       return;
 775     }
 776
 777   g_warn_if_fail (parse_data->current_item == NULL);
 778
 779   item = bookmark_item_new (uri);
 780
 781   if (added)
 782     item->added = timestamp_from_iso8601 (added);
 783
 784   if (modified)
 785     item->modified = timestamp_from_iso8601 (modified);
 786
 787   if (visited)
 788     item->visited = timestamp_from_iso8601 (visited);
 789
 790   add_error = NULL;
 791   g_bookmark_file_add_item (parse_data->bookmark_file,
 792                             item,
 793                             &add_error);
 794   if (add_error)
 795     {
 796       bookmark_item_free (item);
 797
 798       g_propagate_error (error, add_error);
 799
 800       return;
 801     }
 802
 803   parse_data->current_item = item;
 804 }
 805
 806 static void
 807 parse_application_element (GMarkupParseContext  *context,
 808                            ParseData            *parse_data,
 809                            const gchar         **attribute_names,
 810                            const gchar         **attribute_values,
 811                            GError              **error)
 812 {
 813   const gchar *name, *exec, *count, *stamp, *modified;
 814   const gchar *attr;
 815   gint i;
 816   BookmarkItem *item;
 817   BookmarkAppInfo *ai;
 818
 819   g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_APPLICATION));
 820
 821   i = 0;
 822   name = exec = count = stamp = modified = NULL;
 823   for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
 824     {
 825       if (IS_ATTRIBUTE (attr, BOOKMARK_NAME_ATTRIBUTE))
 826         name = attribute_values[i];
 827       else if (IS_ATTRIBUTE (attr, BOOKMARK_EXEC_ATTRIBUTE))
 828         exec = attribute_values[i];
 829       else if (IS_ATTRIBUTE (attr, BOOKMARK_COUNT_ATTRIBUTE))
 830         count = attribute_values[i];
 831       else if (IS_ATTRIBUTE (attr, BOOKMARK_TIMESTAMP_ATTRIBUTE))
 832         stamp = attribute_values[i];
 833       else if (IS_ATTRIBUTE (attr, BOOKMARK_MODIFIED_ATTRIBUTE))
 834         modified = attribute_values[i];
 835     }
 836
 837   /* the "name" and "exec" attributes are mandatory */
 838   if (!name)
 839     {
 840       g_set_error (error, G_MARKUP_ERROR,
 841                    G_MARKUP_ERROR_INVALID_CONTENT,
 842                    _("Attribute '%s' of element '%s' not found"),
 843                    BOOKMARK_NAME_ATTRIBUTE,
 844                    BOOKMARK_APPLICATION_ELEMENT);
 845       return;
 846     }
 847
 848   if (!exec)
 849     {
 850       g_set_error (error, G_MARKUP_ERROR,
 851                    G_MARKUP_ERROR_INVALID_CONTENT,
 852                    _("Attribute '%s' of element '%s' not found"),
 853                    BOOKMARK_EXEC_ATTRIBUTE,
 854                    BOOKMARK_APPLICATION_ELEMENT);
 855       return;
 856     }
 857
 858   g_warn_if_fail (parse_data->current_item != NULL);
 859   item = parse_data->current_item;
 860
 861   ai = bookmark_item_lookup_app_info (item, name);
 862   if (!ai)
 863     {
 864       ai = bookmark_app_info_new (name);
 865
 866       if (!item->metadata)
 867         item->metadata = bookmark_metadata_new ();
 868
 869       item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
 870       g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
 871     }
 872
 873   ai->exec = g_strdup (exec);
 874
 875   if (count)
 876     ai->count = atoi (count);
 877   else
 878     ai->count = 1;
 879
 880   if (modified)
 881     ai->stamp = timestamp_from_iso8601 (modified);
 882   else
 883     {
 884       /* the timestamp attribute has been deprecated but we still parse
 885        * it for backward compatibility
 886        */
 887       if (stamp)
 888         ai->stamp = (time_t) atol (stamp);
 889       else
 890         ai->stamp = time (NULL);
 891     }
 892 }
 893
 894 static void
 895 parse_mime_type_element (GMarkupParseContext  *context,
 896                          ParseData            *parse_data,
 897                          const gchar         **attribute_names,
 898                          const gchar         **attribute_values,
 899                          GError              **error)
 900 {
 901   const gchar *type;
 902   const gchar *attr;
 903   gint i;
 904   BookmarkItem *item;
 905
 906   g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_MIME));
 907
 908   i = 0;
 909   type = NULL;
 910   for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
 911     {
 912       if (IS_ATTRIBUTE (attr, MIME_TYPE_ATTRIBUTE))
 913         type = attribute_values[i];
 914     }
 915
 916   if (!type)
 917     type = "application/octet-stream";
 918
 919   g_warn_if_fail (parse_data->current_item != NULL);
 920   item = parse_data->current_item;
 921
 922   if (!item->metadata)
 923     item->metadata = bookmark_metadata_new ();
 924
 925   item->metadata->mime_type = g_strdup (type);
 926 }
 927
 928 static void
 929 parse_icon_element (GMarkupParseContext  *context,
 930                     ParseData            *parse_data,
 931                     const gchar         **attribute_names,
 932                     const gchar         **attribute_values,
 933                     GError              **error)
 934 {
 935   const gchar *href;
 936   const gchar *type;
 937   const gchar *attr;
 938   gint i;
 939   BookmarkItem *item;
 940
 941   g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_ICON));
 942
 943   i = 0;
 944   href = NULL;
 945   type = NULL;
 946   for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i])
 947     {
 948       if (IS_ATTRIBUTE (attr, BOOKMARK_HREF_ATTRIBUTE))
 949         href = attribute_values[i];
 950       else if (IS_ATTRIBUTE (attr, BOOKMARK_TYPE_ATTRIBUTE))
 951         type = attribute_values[i];
 952     }
 953
 954   /* the "href" attribute is mandatory */
 955   if (!href)
 956     {
 957       g_set_error (error, G_MARKUP_ERROR,
 958                    G_MARKUP_ERROR_INVALID_CONTENT,
 959                    _("Attribute '%s' of element '%s' not found"),
 960                    BOOKMARK_HREF_ATTRIBUTE,
 961                    BOOKMARK_ICON_ELEMENT);
 962       return;
 963     }
 964
 965   if (!type)
 966     type = "application/octet-stream";
 967
 968   g_warn_if_fail (parse_data->current_item != NULL);
 969   item = parse_data->current_item;
 970
 971   if (!item->metadata)
 972     item->metadata = bookmark_metadata_new ();
 973
 974   item->metadata->icon_href = g_strdup (href);
 975   item->metadata->icon_mime = g_strdup (type);
 976 }
 977
 978 /* scans through the attributes of an element for the "xmlns" pragma, and
 979  * adds any resulting namespace declaration to a per-parser hashtable, using
 980  * the namespace name as a key for the namespace URI; if no key was found,
 981  * the namespace is considered as default, and stored under the "default" key.
 982  *
 983  * FIXME: this works on the assumption that the generator of the XBEL file
 984  * is either this code or is smart enough to place the namespace declarations
 985  * inside the main root node or inside the metadata node and does not redefine
 986  * a namespace inside an inner node; this does *not* conform to the
 987  * XML-NS standard, although is a close approximation.  In order to make this
 988  * conformant to the XML-NS specification we should use a per-element
 989  * namespace table inside GMarkup and ask it to resolve the namespaces for us.
 990  */
 991 static void
 992 map_namespace_to_name (ParseData    *parse_data,
 993                        const gchar **attribute_names,
 994                        const gchar **attribute_values)
 995 {
 996   const gchar *attr;
 997   gint i;
 998
 999   g_warn_if_fail (parse_data != NULL);
1000
1001   if (!attribute_names || !attribute_names[0])
1002     return;
1003
1004   i = 0;
1005   for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1006     {
1007       if (g_str_has_prefix (attr, "xmlns"))
1008         {
1009           gchar *namespace_name, *namespace_uri;
1010           gchar *p;
1011
1012           p = g_utf8_strchr (attr, -1, ':');
1013           if (p)
1014             p = g_utf8_next_char (p);
1015           else
1016             p = "default";
1017
1018           namespace_name = g_strdup (p);
1019           namespace_uri = g_strdup (attribute_values[i]);
1020
1021           g_hash_table_replace (parse_data->namespaces,
1022                                 namespace_name,
1023                                 namespace_uri);
1024         }
1025      }
1026 }
1027
1028 /* checks whether @element_full is equal to @element.
1029  *
1030  * if @namespace is set, it tries to resolve the namespace to a known URI,
1031  * and if found is prepended to the element name, from which is separated
1032  * using the character specified in the @sep parameter.
1033  */
1034 static gboolean
1035 is_element_full (ParseData   *parse_data,
1036                  const gchar *element_full,
1037                  const gchar *namespace,
1038                  const gchar *element,
1039                  const gchar  sep)
1040 {
1041   gchar *ns_uri, *ns_name;
1042   const gchar *p, *element_name;
1043   gboolean retval;
1044
1045   g_warn_if_fail (parse_data != NULL);
1046   g_warn_if_fail (element_full != NULL);
1047
1048   if (!element)
1049     return FALSE;
1050
1051   /* no namespace requested: dumb element compare */
1052   if (!namespace)
1053     return (0 == strcmp (element_full, element));
1054
1055   /* search for namespace separator; if none found, assume we are under the
1056    * default namespace, and set ns_name to our "default" marker; if no default
1057    * namespace has been set, just do a plain comparison between @full_element
1058    * and @element.
1059    */
1060   p = g_utf8_strchr (element_full, -1, ':');
1061   if (p)
1062     {
1063       ns_name = g_strndup (element_full, p - element_full);
1064       element_name = g_utf8_next_char (p);
1065     }
1066   else
1067     {
1068       ns_name = g_strdup ("default");
1069       element_name = element_full;
1070     }
1071
1072   ns_uri = g_hash_table_lookup (parse_data->namespaces, ns_name);
1073   if (!ns_uri)
1074     {
1075       /* no default namespace found */
1076       g_free (ns_name);
1077
1078       return (0 == strcmp (element_full, element));
1079     }
1080
1081   retval = (0 == strcmp (ns_uri, namespace) &&
1082             0 == strcmp (element_name, element));
1083
1084   g_free (ns_name);
1085
1086   return retval;
1087 }
1088
1089 #define IS_ELEMENT(p,s,e)       (is_element_full ((p), (s), NULL, (e), '\0'))
1090 #define IS_ELEMENT_NS(p,s,n,e)  (is_element_full ((p), (s), (n), (e), '|'))
1091
1092 static void
1093 start_element_raw_cb (GMarkupParseContext *context,
1094                       const gchar         *element_name,
1095                       const gchar        **attribute_names,
1096                       const gchar        **attribute_values,
1097                       gpointer             user_data,
1098                       GError             **error)
1099 {
1100   ParseData *parse_data = (ParseData *) user_data;
1101
1102   /* we must check for namespace declarations first
1103    *
1104    * XXX - we could speed up things by checking for namespace declarations
1105    * only on the root node, where they usually are; this would probably break
1106    * on streams not produced by us or by "smart" generators
1107    */
1108   map_namespace_to_name (parse_data, attribute_names, attribute_values);
1109
1110   switch (parse_data->state)
1111     {
1112     case STATE_STARTED:
1113       if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1114         {
1115           const gchar *attr;
1116           gint i;
1117
1118           i = 0;
1119           for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1120             {
1121               if ((IS_ATTRIBUTE (attr, XBEL_VERSION_ATTRIBUTE)) &&
1122                   (0 == strcmp (attribute_values[i], XBEL_VERSION)))
1123                 parse_data->state = STATE_ROOT;
1124             }
1125         }
1126       else
1127         g_set_error (error, G_MARKUP_ERROR,
1128                      G_MARKUP_ERROR_INVALID_CONTENT,
1129                      _("Unexpected tag '%s', tag '%s' expected"),
1130                      element_name, XBEL_ROOT_ELEMENT);
1131       break;
1132     case STATE_ROOT:
1133       if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1134         parse_data->state = STATE_TITLE;
1135       else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1136         parse_data->state = STATE_DESC;
1137       else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1138         {
1139           GError *inner_error = NULL;
1140
1141           parse_data->state = STATE_BOOKMARK;
1142
1143           parse_bookmark_element (context,
1144                                   parse_data,
1145                                   attribute_names,
1146                                   attribute_values,
1147                                   &inner_error);
1148           if (inner_error)
1149             g_propagate_error (error, inner_error);
1150         }
1151       else
1152         g_set_error (error, G_MARKUP_ERROR,
1153                      G_MARKUP_ERROR_INVALID_CONTENT,
1154                      _("Unexpected tag '%s' inside '%s'"),
1155                      element_name,
1156                      XBEL_ROOT_ELEMENT);
1157       break;
1158     case STATE_BOOKMARK:
1159       if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT))
1160         parse_data->state = STATE_TITLE;
1161       else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))
1162         parse_data->state = STATE_DESC;
1163       else if (IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT))
1164         parse_data->state = STATE_INFO;
1165       else
1166         g_set_error (error, G_MARKUP_ERROR,
1167                      G_MARKUP_ERROR_INVALID_CONTENT,
1168                      _("Unexpected tag '%s' inside '%s'"),
1169                      element_name,
1170                      XBEL_BOOKMARK_ELEMENT);
1171       break;
1172     case STATE_INFO:
1173       if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1174         {
1175           const gchar *attr;
1176           gint i;
1177
1178           i = 0;
1179           for (attr = attribute_names[i]; attr; attr = attribute_names[++i])
1180             {
1181               if ((IS_ATTRIBUTE (attr, XBEL_OWNER_ATTRIBUTE)) &&
1182                   (0 == strcmp (attribute_values[i], BOOKMARK_METADATA_OWNER)))
1183                 {
1184                   parse_data->state = STATE_METADATA;
1185
1186                   if (!parse_data->current_item->metadata)
1187                     parse_data->current_item->metadata = bookmark_metadata_new ();
1188                 }
1189             }
1190         }
1191       else
1192         g_set_error (error, G_MARKUP_ERROR,
1193                      G_MARKUP_ERROR_INVALID_CONTENT,
1194                      _("Unexpected tag '%s', tag '%s' expected"),
1195                      element_name,
1196                      XBEL_METADATA_ELEMENT);
1197       break;
1198     case STATE_METADATA:
1199       if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT))
1200         parse_data->state = STATE_APPLICATIONS;
1201       else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT))
1202         parse_data->state = STATE_GROUPS;
1203       else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT))
1204         parse_data->current_item->metadata->is_private = TRUE;
1205       else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1206         {
1207           GError *inner_error = NULL;
1208
1209           parse_data->state = STATE_ICON;
1210
1211           parse_icon_element (context,
1212                               parse_data,
1213                               attribute_names,
1214                               attribute_values,
1215                               &inner_error);
1216           if (inner_error)
1217             g_propagate_error (error, inner_error);
1218         }
1219       else if (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT))
1220         {
1221           GError *inner_error = NULL;
1222
1223           parse_data->state = STATE_MIME;
1224
1225           parse_mime_type_element (context,
1226                                    parse_data,
1227                                    attribute_names,
1228                                    attribute_values,
1229                                    &inner_error);
1230           if (inner_error)
1231             g_propagate_error (error, inner_error);
1232         }
1233       else
1234         g_set_error (error, G_MARKUP_ERROR,
1235                      G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1236                      _("Unexpected tag '%s' inside '%s'"),
1237                      element_name,
1238                      XBEL_METADATA_ELEMENT);
1239       break;
1240     case STATE_APPLICATIONS:
1241       if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATION_ELEMENT))
1242         {
1243           GError *inner_error = NULL;
1244
1245           parse_data->state = STATE_APPLICATION;
1246
1247           parse_application_element (context,
1248                                      parse_data,
1249                                      attribute_names,
1250                                      attribute_values,
1251                                      &inner_error);
1252           if (inner_error)
1253             g_propagate_error (error, inner_error);
1254         }
1255       else
1256         g_set_error (error, G_MARKUP_ERROR,
1257                      G_MARKUP_ERROR_INVALID_CONTENT,
1258                      _("Unexpected tag '%s', tag '%s' expected"),
1259                      element_name,
1260                      BOOKMARK_APPLICATION_ELEMENT);
1261       break;
1262     case STATE_GROUPS:
1263       if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUP_ELEMENT))
1264         parse_data->state = STATE_GROUP;
1265       else
1266         g_set_error (error, G_MARKUP_ERROR,
1267                      G_MARKUP_ERROR_INVALID_CONTENT,
1268                      _("Unexpected tag '%s', tag '%s' expected"),
1269                      element_name,
1270                      BOOKMARK_GROUP_ELEMENT);
1271       break;
1272     case STATE_ICON:
1273       if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT))
1274         {
1275           GError *inner_error = NULL;
1276
1277           parse_icon_element (context,
1278                               parse_data,
1279                               attribute_names,
1280                               attribute_values,
1281                               &inner_error);
1282           if (inner_error)
1283             g_propagate_error (error, inner_error);
1284         }
1285       else
1286         g_set_error (error, G_MARKUP_ERROR,
1287                      G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1288                      _("Unexpected tag '%s' inside '%s'"),
1289                      element_name,
1290                      XBEL_METADATA_ELEMENT);
1291       break;
1292     default:
1293       g_warn_if_reached ();
1294       break;
1295     }
1296 }
1297
1298 static void
1299 end_element_raw_cb (GMarkupParseContext *context,
1300                     const gchar         *element_name,
1301                     gpointer             user_data,
1302                     GError             **error)
1303 {
1304   ParseData *parse_data = (ParseData *) user_data;
1305
1306   if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT))
1307     parse_data->state = STATE_FINISHED;
1308   else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT))
1309     {
1310       parse_data->current_item = NULL;
1311
1312       parse_data->state = STATE_ROOT;
1313     }
1314   else if ((IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT)) ||
1315            (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) ||
1316            (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT)))
1317     {
1318       if (parse_data->current_item)
1319         parse_data->state = STATE_BOOKMARK;
1320       else
1321         parse_data->state = STATE_ROOT;
1322     }
1323   else if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT))
1324     parse_data->state = STATE_INFO;
1325   else if (IS_ELEMENT_NS (parse_data, element_name,
1326                           BOOKMARK_NAMESPACE_URI,
1327                           BOOKMARK_APPLICATION_ELEMENT))
1328     parse_data->state = STATE_APPLICATIONS;
1329   else if (IS_ELEMENT_NS (parse_data, element_name,
1330                           BOOKMARK_NAMESPACE_URI,
1331                           BOOKMARK_GROUP_ELEMENT))
1332     parse_data->state = STATE_GROUPS;
1333   else if ((IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT)) ||
1334            (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT)) ||
1335            (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT)) ||
1336            (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT)) ||
1337            (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT)))
1338     parse_data->state = STATE_METADATA;
1339 }
1340
1341 static void
1342 text_raw_cb (GMarkupParseContext *context,
1343              const gchar         *text,
1344              gsize                length,
1345              gpointer             user_data,
1346              GError             **error)
1347 {
1348   ParseData *parse_data = (ParseData *) user_data;
1349   gchar *payload;
1350
1351   payload = g_strndup (text, length);
1352
1353   switch (parse_data->state)
1354     {
1355     case STATE_TITLE:
1356       if (parse_data->current_item)
1357         {
1358           g_free (parse_data->current_item->title);
1359           parse_data->current_item->title = g_strdup (payload);
1360         }
1361       else
1362         {
1363           g_free (parse_data->bookmark_file->title);
1364           parse_data->bookmark_file->title = g_strdup (payload);
1365         }
1366       break;
1367     case STATE_DESC:
1368       if (parse_data->current_item)
1369         {
1370           g_free (parse_data->current_item->description);
1371           parse_data->current_item->description = g_strdup (payload);
1372         }
1373       else
1374         {
1375           g_free (parse_data->bookmark_file->description);
1376           parse_data->bookmark_file->description = g_strdup (payload);
1377         }
1378       break;
1379     case STATE_GROUP:
1380       {
1381       GList *groups;
1382
1383       g_warn_if_fail (parse_data->current_item != NULL);
1384
1385       if (!parse_data->current_item->metadata)
1386         parse_data->current_item->metadata = bookmark_metadata_new ();
1387
1388       groups = parse_data->current_item->metadata->groups;
1389       parse_data->current_item->metadata->groups = g_list_prepend (groups, g_strdup (payload));
1390       }
1391       break;
1392     case STATE_ROOT:
1393     case STATE_BOOKMARK:
1394     case STATE_INFO:
1395     case STATE_METADATA:
1396     case STATE_APPLICATIONS:
1397     case STATE_APPLICATION:
1398     case STATE_GROUPS:
1399     case STATE_MIME:
1400     case STATE_ICON:
1401       break;
1402     default:
1403       g_warn_if_reached ();
1404       break;
1405     }
1406
1407   g_free (payload);
1408 }
1409
1410 static const GMarkupParser markup_parser =
1411 {
1412   start_element_raw_cb, /* start_element */
1413   end_element_raw_cb,   /* end_element */
1414   text_raw_cb,          /* text */
1415   NULL,                 /* passthrough */
1416   NULL
1417 };
1418
1419 static gboolean
1420 g_bookmark_file_parse (GBookmarkFile  *bookmark,
1421                          const gchar  *buffer,
1422                          gsize         length,
1423                          GError       **error)
1424 {
1425   GMarkupParseContext *context;
1426   ParseData *parse_data;
1427   GError *parse_error, *end_error;
1428   gboolean retval;
1429
1430   g_warn_if_fail (bookmark != NULL);
1431
1432   if (!buffer)
1433     return FALSE;
1434
1435   parse_error = NULL;
1436   end_error = NULL;
1437
1438   if (length == (gsize) -1)
1439     length = strlen (buffer);
1440
1441   parse_data = parse_data_new ();
1442   parse_data->bookmark_file = bookmark;
1443
1444   context = g_markup_parse_context_new (&markup_parser,
1445                                         0,
1446                                         parse_data,
1447                                         (GDestroyNotify) parse_data_free);
1448
1449   retval = g_markup_parse_context_parse (context,
1450                                          buffer,
1451                                          length,
1452                                          &parse_error);
1453   if (!retval)
1454     g_propagate_error (error, parse_error);
1455   else
1456    {
1457      retval = g_markup_parse_context_end_parse (context, &end_error);
1458       if (!retval)
1459         g_propagate_error (error, end_error);
1460    }
1461
1462   g_markup_parse_context_free (context);
1463
1464   return retval;
1465 }
1466
1467 static gchar *
1468 g_bookmark_file_dump (GBookmarkFile  *bookmark,
1469                       gsize          *length,
1470                       GError        **error)
1471 {
1472   GString *retval;
1473   gchar *buffer;
1474   GList *l;
1475
1476   retval = g_string_sized_new (4096);
1477
1478   g_string_append (retval,
1479                    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1480 #if 0
1481                    /* XXX - do we really need the doctype? */
1482                    "<!DOCTYPE " XBEL_DTD_NICK "\n"
1483                    "  PUBLIC \"" XBEL_DTD_SYSTEM "\"\n"
1484                    "         \"" XBEL_DTD_URI "\">\n"
1485 #endif
1486                    "<" XBEL_ROOT_ELEMENT " " XBEL_VERSION_ATTRIBUTE "=\"" XBEL_VERSION "\"\n"
1487                    "      xmlns:" BOOKMARK_NAMESPACE_NAME "=\"" BOOKMARK_NAMESPACE_URI "\"\n"
1488                    "      xmlns:" MIME_NAMESPACE_NAME     "=\"" MIME_NAMESPACE_URI "\"\n>");
1489
1490   if (bookmark->title)
1491     {
1492       gchar *escaped_title;
1493
1494       escaped_title = g_markup_escape_text (bookmark->title, -1);
1495
1496       buffer = g_strconcat ("  "
1497                             "<" XBEL_TITLE_ELEMENT ">",
1498                             escaped_title,
1499                             "</" XBEL_TITLE_ELEMENT ">\n", NULL);
1500
1501       g_string_append (retval, buffer);
1502
1503       g_free (buffer);
1504       g_free (escaped_title);
1505     }
1506
1507   if (bookmark->description)
1508     {
1509       gchar *escaped_desc;
1510
1511       escaped_desc = g_markup_escape_text (bookmark->description, -1);
1512
1513       buffer = g_strconcat ("  "
1514                             "<" XBEL_DESC_ELEMENT ">",
1515                             escaped_desc,
1516                             "</" XBEL_DESC_ELEMENT ">\n", NULL);
1517       g_string_append (retval, buffer);
1518
1519       g_free (buffer);
1520       g_free (escaped_desc);
1521     }
1522
1523   if (!bookmark->items)
1524     goto out;
1525   else
1526     retval = g_string_append (retval, "\n");
1527
1528   /* the items are stored in reverse order */
1529   for (l = g_list_last (bookmark->items);
1530        l != NULL;
1531        l = l->prev)
1532     {
1533       BookmarkItem *item = (BookmarkItem *) l->data;
1534       gchar *item_dump;
1535
1536       item_dump = bookmark_item_dump (item);
1537       if (!item_dump)
1538         continue;
1539
1540       retval = g_string_append (retval, item_dump);
1541
1542       g_free (item_dump);
1543     }
1544
1545 out:
1546   g_string_append (retval, "</" XBEL_ROOT_ELEMENT ">");
1547
1548   if (length)
1549     *length = retval->len;
1550
1551   return g_string_free (retval, FALSE);
1552 }
1553
1554 /**************
1555  *    Misc    *
1556  **************/
1557
1558 /* converts a Unix timestamp in a ISO 8601 compliant string; you
1559  * should free the returned string.
1560  */
1561 static gchar *
1562 timestamp_to_iso8601 (time_t timestamp)
1563 {
1564   GTimeVal stamp;
1565
1566   if (timestamp == (time_t) -1)
1567     g_get_current_time (&stamp);
1568   else
1569     {
1570       stamp.tv_sec = timestamp;
1571       stamp.tv_usec = 0;
1572     }
1573
1574   return g_time_val_to_iso8601 (&stamp);
1575 }
1576
1577 static time_t
1578 timestamp_from_iso8601 (const gchar *iso_date)
1579 {
1580   GTimeVal stamp;
1581
1582   if (!g_time_val_from_iso8601 (iso_date, &stamp))
1583     return (time_t) -1;
1584
1585   return (time_t) stamp.tv_sec;
1586 }
1587
1588
1589
1590 GQuark
1591 g_bookmark_file_error_quark (void)
1592 {
1593   return g_quark_from_static_string ("g-bookmark-file-error-quark");
1594 }
1595
1596
1597
1598 /********************
1599  *    Public API    *
1600  ********************/
1601
1602 /**
1603  * g_bookmark_file_new:
1604  *
1605  * Creates a new empty #GBookmarkFile object.
1606  *
1607  * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
1608  * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
1609  * file.
1610  *
1611  * Return value: an empty #GBookmarkFile
1612  *
1613  * Since: 2.12
1614  */
1615 GBookmarkFile *
1616 g_bookmark_file_new (void)
1617 {
1618   GBookmarkFile *bookmark;
1619
1620   bookmark = g_new (GBookmarkFile, 1);
1621
1622   g_bookmark_file_init (bookmark);
1623
1624   return bookmark;
1625 }
1626
1627 /**
1628  * g_bookmark_file_free:
1629  * @bookmark: a #GBookmarkFile
1630  *
1631  * Frees a #GBookmarkFile.
1632  *
1633  * Since: 2.12
1634  */
1635 void
1636 g_bookmark_file_free (GBookmarkFile *bookmark)
1637 {
1638   if (!bookmark)
1639     return;
1640
1641   g_bookmark_file_clear (bookmark);
1642
1643   g_free (bookmark);
1644 }
1645
1646 /**
1647  * g_bookmark_file_load_from_data:
1648  * @bookmark: an empty #GBookmarkFile struct
1649  * @data: desktop bookmarks loaded in memory
1650  * @length: the length of @data in bytes
1651  * @error: return location for a #GError, or %NULL
1652  *
1653  * Loads a bookmark file from memory into an empty #GBookmarkFile
1654  * structure.  If the object cannot be created then @error is set to a
1655  * #GBookmarkFileError.
1656  *
1657  * Return value: %TRUE if a desktop bookmark could be loaded.
1658  *
1659  * Since: 2.12
1660  */
1661 gboolean
1662 g_bookmark_file_load_from_data (GBookmarkFile  *bookmark,
1663                                 const gchar    *data,
1664                                 gsize           length,
1665                                 GError        **error)
1666 {
1667   GError *parse_error;
1668   gboolean retval;
1669
1670   g_return_val_if_fail (bookmark != NULL, FALSE);
1671
1672   if (length == (gsize) -1)
1673     length = strlen (data);
1674
1675   if (bookmark->items)
1676     {
1677       g_bookmark_file_clear (bookmark);
1678       g_bookmark_file_init (bookmark);
1679     }
1680
1681   parse_error = NULL;
1682   retval = g_bookmark_file_parse (bookmark, data, length, &parse_error);
1683
1684   if (!retval)
1685     g_propagate_error (error, parse_error);
1686
1687   return retval;
1688 }
1689
1690 /**
1691  * g_bookmark_file_load_from_file:
1692  * @bookmark: an empty #GBookmarkFile struct
1693  * @filename: the path of a filename to load, in the GLib file name encoding
1694  * @error: return location for a #GError, or %NULL
1695  *
1696  * Loads a desktop bookmark file into an empty #GBookmarkFile structure.
1697  * If the file could not be loaded then @error is set to either a #GFileError
1698  * or #GBookmarkFileError.
1699  *
1700  * Return value: %TRUE if a desktop bookmark file could be loaded
1701  *
1702  * Since: 2.12
1703  */
1704 gboolean
1705 g_bookmark_file_load_from_file (GBookmarkFile  *bookmark,
1706                                 const gchar    *filename,
1707                                 GError        **error)
1708 {
1709   gchar *buffer;
1710   gsize len;
1711   GError *read_error;
1712   gboolean retval;
1713
1714   g_return_val_if_fail (bookmark != NULL, FALSE);
1715   g_return_val_if_fail (filename != NULL, FALSE);
1716
1717   read_error = NULL;
1718   g_file_get_contents (filename, &buffer, &len, &read_error);
1719   if (read_error)
1720     {
1721       g_propagate_error (error, read_error);
1722
1723       return FALSE;
1724     }
1725
1726   read_error = NULL;
1727   retval = g_bookmark_file_load_from_data (bookmark,
1728                                            buffer,
1729                                            len,
1730                                            &read_error);
1731   if (read_error)
1732     {
1733       g_propagate_error (error, read_error);
1734
1735       g_free (buffer);
1736
1737       return FALSE;
1738     }
1739
1740   g_free (buffer);
1741
1742   return retval;
1743 }
1744
1745
1746 /* Iterates through all the directories in *dirs trying to
1747  * find file.  When it successfully locates file, returns a
1748  * string its absolute path.  It also leaves the unchecked
1749  * directories in *dirs.  You should free the returned string
1750  *
1751  * Adapted from gkeyfile.c
1752  */
1753 static gchar *
1754 find_file_in_data_dirs (const gchar   *file,
1755                         gchar       ***dirs,
1756                         GError       **error)
1757 {
1758   gchar **data_dirs, *data_dir, *path;
1759
1760   path = NULL;
1761
1762   if (dirs == NULL)
1763     return NULL;
1764
1765   data_dirs = *dirs;
1766   path = NULL;
1767   while (data_dirs && (data_dir = *data_dirs) && !path)
1768     {
1769       gchar *candidate_file, *sub_dir;
1770
1771       candidate_file = (gchar *) file;
1772       sub_dir = g_strdup ("");
1773       while (candidate_file != NULL && !path)
1774         {
1775           gchar *p;
1776
1777           path = g_build_filename (data_dir, sub_dir,
1778                                    candidate_file, NULL);
1779
1780           candidate_file = strchr (candidate_file, '-');
1781
1782           if (candidate_file == NULL)
1783             break;
1784
1785           candidate_file++;
1786
1787           g_free (sub_dir);
1788           sub_dir = g_strndup (file, candidate_file - file - 1);
1789
1790           for (p = sub_dir; *p != '\0'; p++)
1791             {
1792               if (*p == '-')
1793                 *p = G_DIR_SEPARATOR;
1794             }
1795         }
1796       g_free (sub_dir);
1797       data_dirs++;
1798     }
1799
1800   *dirs = data_dirs;
1801
1802   if (!path)
1803     {
1804       g_set_error_literal (error, G_BOOKMARK_FILE_ERROR,
1805                            G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND,
1806                            _("No valid bookmark file found in data dirs"));
1807
1808       return NULL;
1809     }
1810
1811   return path;
1812 }
1813
1814
1815 /**
1816  * g_bookmark_file_load_from_data_dirs:
1817  * @bookmark: a #GBookmarkFile
1818  * @file: a relative path to a filename to open and parse
1819  * @full_path: (allow-none): return location for a string containing the full path
1820  *   of the file, or %NULL
1821  * @error: return location for a #GError, or %NULL
1822  *
1823  * This function looks for a desktop bookmark file named @file in the
1824  * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
1825  * loads the file into @bookmark and returns the file's full path in
1826  * @full_path.  If the file could not be loaded then an %error is
1827  * set to either a #GFileError or #GBookmarkFileError.
1828  *
1829  * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
1830  *
1831  * Since: 2.12
1832  */
1833 gboolean
1834 g_bookmark_file_load_from_data_dirs (GBookmarkFile  *bookmark,
1835                                      const gchar    *file,
1836                                      gchar         **full_path,
1837                                      GError        **error)
1838 {
1839   GError *file_error = NULL;
1840   gchar **all_data_dirs, **data_dirs;
1841   const gchar *user_data_dir;
1842   const gchar * const * system_data_dirs;
1843   gsize i, j;
1844   gchar *output_path;
1845   gboolean found_file;
1846
1847   g_return_val_if_fail (bookmark != NULL, FALSE);
1848   g_return_val_if_fail (!g_path_is_absolute (file), FALSE);
1849
1850   user_data_dir = g_get_user_data_dir ();
1851   system_data_dirs = g_get_system_data_dirs ();
1852   all_data_dirs = g_new0 (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2);
1853
1854   i = 0;
1855   all_data_dirs[i++] = g_strdup (user_data_dir);
1856
1857   j = 0;
1858   while (system_data_dirs[j] != NULL)
1859     all_data_dirs[i++] = g_strdup (system_data_dirs[j++]);
1860
1861   found_file = FALSE;
1862   data_dirs = all_data_dirs;
1863   output_path = NULL;
1864   while (*data_dirs != NULL && !found_file)
1865     {
1866       g_free (output_path);
1867
1868       output_path = find_file_in_data_dirs (file, &data_dirs, &file_error);
1869
1870       if (file_error)
1871         {
1872           g_propagate_error (error, file_error);
1873           break;
1874         }
1875
1876       found_file = g_bookmark_file_load_from_file (bookmark,
1877                                                    output_path,
1878                                                    &file_error);
1879       if (file_error)
1880         {
1881           g_propagate_error (error, file_error);
1882           break;
1883         }
1884     }
1885
1886   if (found_file && full_path)
1887     *full_path = output_path;
1888   else
1889     g_free (output_path);
1890
1891   g_strfreev (all_data_dirs);
1892
1893   return found_file;
1894 }
1895
1896
1897 /**
1898  * g_bookmark_file_to_data:
1899  * @bookmark: a #GBookmarkFile
1900  * @length: (allow-none): return location for the length of the returned string, or %NULL
1901  * @error: return location for a #GError, or %NULL
1902  *
1903  * This function outputs @bookmark as a string.
1904  *
1905  * Return value: a newly allocated string holding
1906  *   the contents of the #GBookmarkFile
1907  *
1908  * Since: 2.12
1909  */
1910 gchar *
1911 g_bookmark_file_to_data (GBookmarkFile  *bookmark,
1912                          gsize          *length,
1913                          GError        **error)
1914 {
1915   GError *write_error = NULL;
1916   gchar *retval;
1917
1918   g_return_val_if_fail (bookmark != NULL, NULL);
1919
1920   retval = g_bookmark_file_dump (bookmark, length, &write_error);
1921   if (write_error)
1922     {
1923       g_propagate_error (error, write_error);
1924
1925       return NULL;
1926     }
1927
1928   return retval;
1929 }
1930
1931 /**
1932  * g_bookmark_file_to_file:
1933  * @bookmark: a #GBookmarkFile
1934  * @filename: path of the output file
1935  * @error: return location for a #GError, or %NULL
1936  *
1937  * This function outputs @bookmark into a file.  The write process is
1938  * guaranteed to be atomic by using g_file_set_contents() internally.
1939  *
1940  * Return value: %TRUE if the file was successfully written.
1941  *
1942  * Since: 2.12
1943  */
1944 gboolean
1945 g_bookmark_file_to_file (GBookmarkFile  *bookmark,
1946                          const gchar    *filename,
1947                          GError        **error)
1948 {
1949   gchar *data;
1950   GError *data_error, *write_error;
1951   gsize len;
1952   gboolean retval;
1953
1954   g_return_val_if_fail (bookmark != NULL, FALSE);
1955   g_return_val_if_fail (filename != NULL, FALSE);
1956
1957   data_error = NULL;
1958   data = g_bookmark_file_to_data (bookmark, &len, &data_error);
1959   if (data_error)
1960     {
1961       g_propagate_error (error, data_error);
1962
1963       return FALSE;
1964     }
1965
1966   write_error = NULL;
1967   g_file_set_contents (filename, data, len, &write_error);
1968   if (write_error)
1969     {
1970       g_propagate_error (error, write_error);
1971
1972       retval = FALSE;
1973     }
1974   else
1975     retval = TRUE;
1976
1977   g_free (data);
1978
1979   return retval;
1980 }
1981
1982 static BookmarkItem *
1983 g_bookmark_file_lookup_item (GBookmarkFile *bookmark,
1984                              const gchar   *uri)
1985 {
1986   g_warn_if_fail (bookmark != NULL && uri != NULL);
1987
1988   return g_hash_table_lookup (bookmark->items_by_uri, uri);
1989 }
1990
1991 /* this function adds a new item to the list */
1992 static void
1993 g_bookmark_file_add_item (GBookmarkFile  *bookmark,
1994                           BookmarkItem   *item,
1995                           GError        **error)
1996 {
1997   g_warn_if_fail (bookmark != NULL);
1998   g_warn_if_fail (item != NULL);
1999
2000   /* this should never happen; and if it does, then we are
2001    * screwing up something big time.
2002    */
2003   if (G_UNLIKELY (g_bookmark_file_has_item (bookmark, item->uri)))
2004     {
2005       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2006                    G_BOOKMARK_FILE_ERROR_INVALID_URI,
2007                    _("A bookmark for URI '%s' already exists"),
2008                    item->uri);
2009       return;
2010     }
2011
2012   bookmark->items = g_list_prepend (bookmark->items, item);
2013
2014   g_hash_table_replace (bookmark->items_by_uri,
2015                         item->uri,
2016                         item);
2017
2018   if (item->added == (time_t) -1)
2019     item->added = time (NULL);
2020
2021   if (item->modified == (time_t) -1)
2022     item->modified = time (NULL);
2023 }
2024
2025 /**
2026  * g_bookmark_file_remove_item:
2027  * @bookmark: a #GBookmarkFile
2028  * @uri: a valid URI
2029  * @error: return location for a #GError, or %NULL
2030  *
2031  * Removes the bookmark for @uri from the bookmark file @bookmark.
2032  *
2033  * Return value: %TRUE if the bookmark was removed successfully.
2034  *
2035  * Since: 2.12
2036  */
2037 gboolean
2038 g_bookmark_file_remove_item (GBookmarkFile  *bookmark,
2039                              const gchar    *uri,
2040                              GError        **error)
2041 {
2042   BookmarkItem *item;
2043
2044   g_return_val_if_fail (bookmark != NULL, FALSE);
2045   g_return_val_if_fail (uri != NULL, FALSE);
2046
2047   item = g_bookmark_file_lookup_item (bookmark, uri);
2048
2049   if (!item)
2050     {
2051       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2052                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2053                    _("No bookmark found for URI '%s'"),
2054                    uri);
2055       return FALSE;
2056     }
2057
2058   bookmark->items = g_list_remove (bookmark->items, item);
2059   g_hash_table_remove (bookmark->items_by_uri, item->uri);
2060
2061   bookmark_item_free (item);
2062
2063   return TRUE;
2064 }
2065
2066 /**
2067  * g_bookmark_file_has_item:
2068  * @bookmark: a #GBookmarkFile
2069  * @uri: a valid URI
2070  *
2071  * Looks whether the desktop bookmark has an item with its URI set to @uri.
2072  *
2073  * Return value: %TRUE if @uri is inside @bookmark, %FALSE otherwise
2074  *
2075  * Since: 2.12
2076  */
2077 gboolean
2078 g_bookmark_file_has_item (GBookmarkFile *bookmark,
2079                           const gchar   *uri)
2080 {
2081   g_return_val_if_fail (bookmark != NULL, FALSE);
2082   g_return_val_if_fail (uri != NULL, FALSE);
2083
2084   return (NULL != g_hash_table_lookup (bookmark->items_by_uri, uri));
2085 }
2086
2087 /**
2088  * g_bookmark_file_get_uris:
2089  * @bookmark: a #GBookmarkFile
2090  * @length: (allow-none): return location for the number of returned URIs, or %NULL
2091  *
2092  * Returns all URIs of the bookmarks in the bookmark file @bookmark.
2093  * The array of returned URIs will be %NULL-terminated, so @length may
2094  * optionally be %NULL.
2095  *
2096  * Return value: a newly allocated %NULL-terminated array of strings.
2097  *   Use g_strfreev() to free it.
2098  *
2099  * Since: 2.12
2100  */
2101 gchar **
2102 g_bookmark_file_get_uris (GBookmarkFile *bookmark,
2103                           gsize         *length)
2104 {
2105   GList *l;
2106   gchar **uris;
2107   gsize i, n_items;
2108
2109   g_return_val_if_fail (bookmark != NULL, NULL);
2110
2111   n_items = g_list_length (bookmark->items);
2112   uris = g_new0 (gchar *, n_items + 1);
2113
2114   /* the items are stored in reverse order, so we walk the list backward */
2115   for (l = g_list_last (bookmark->items), i = 0; l != NULL; l = l->prev)
2116     {
2117       BookmarkItem *item = (BookmarkItem *) l->data;
2118
2119       g_warn_if_fail (item != NULL);
2120
2121       uris[i++] = g_strdup (item->uri);
2122     }
2123   uris[i] = NULL;
2124
2125   if (length)
2126     *length = i;
2127
2128   return uris;
2129 }
2130
2131 /**
2132  * g_bookmark_file_set_title:
2133  * @bookmark: a #GBookmarkFile
2134  * @uri: (allow-none): a valid URI or %NULL
2135  * @title: a UTF-8 encoded string
2136  *
2137  * Sets @title as the title of the bookmark for @uri inside the
2138  * bookmark file @bookmark.
2139  *
2140  * If @uri is %NULL, the title of @bookmark is set.
2141  *
2142  * If a bookmark for @uri cannot be found then it is created.
2143  *
2144  * Since: 2.12
2145  */
2146 void
2147 g_bookmark_file_set_title (GBookmarkFile *bookmark,
2148                            const gchar   *uri,
2149                            const gchar   *title)
2150 {
2151   g_return_if_fail (bookmark != NULL);
2152
2153   if (!uri)
2154     {
2155       g_free (bookmark->title);
2156       bookmark->title = g_strdup (title);
2157     }
2158   else
2159     {
2160       BookmarkItem *item;
2161
2162       item = g_bookmark_file_lookup_item (bookmark, uri);
2163       if (!item)
2164         {
2165           item = bookmark_item_new (uri);
2166           g_bookmark_file_add_item (bookmark, item, NULL);
2167         }
2168
2169       g_free (item->title);
2170       item->title = g_strdup (title);
2171
2172       item->modified = time (NULL);
2173     }
2174 }
2175
2176 /**
2177  * g_bookmark_file_get_title:
2178  * @bookmark: a #GBookmarkFile
2179  * @uri: (allow-none): a valid URI or %NULL
2180  * @error: return location for a #GError, or %NULL
2181  *
2182  * Returns the title of the bookmark for @uri.
2183  *
2184  * If @uri is %NULL, the title of @bookmark is returned.
2185  *
2186  * In the event the URI cannot be found, %NULL is returned and
2187  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2188  *
2189  * Return value: a newly allocated string or %NULL if the specified
2190  *   URI cannot be found.
2191  *
2192  * Since: 2.12
2193  */
2194 gchar *
2195 g_bookmark_file_get_title (GBookmarkFile  *bookmark,
2196                            const gchar    *uri,
2197                            GError        **error)
2198 {
2199   BookmarkItem *item;
2200
2201   g_return_val_if_fail (bookmark != NULL, NULL);
2202
2203   if (!uri)
2204     return g_strdup (bookmark->title);
2205
2206   item = g_bookmark_file_lookup_item (bookmark, uri);
2207   if (!item)
2208     {
2209       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2210                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2211                    _("No bookmark found for URI '%s'"),
2212                    uri);
2213       return NULL;
2214     }
2215
2216   return g_strdup (item->title);
2217 }
2218
2219 /**
2220  * g_bookmark_file_set_description:
2221  * @bookmark: a #GBookmarkFile
2222  * @uri: (allow-none): a valid URI or %NULL
2223  * @description: a string
2224  *
2225  * Sets @description as the description of the bookmark for @uri.
2226  *
2227  * If @uri is %NULL, the description of @bookmark is set.
2228  *
2229  * If a bookmark for @uri cannot be found then it is created.
2230  *
2231  * Since: 2.12
2232  */
2233 void
2234 g_bookmark_file_set_description (GBookmarkFile *bookmark,
2235                                  const gchar   *uri,
2236                                  const gchar   *description)
2237 {
2238   g_return_if_fail (bookmark != NULL);
2239
2240   if (!uri)
2241     {
2242       g_free (bookmark->description);
2243       bookmark->description = g_strdup (description);
2244     }
2245   else
2246     {
2247       BookmarkItem *item;
2248
2249       item = g_bookmark_file_lookup_item (bookmark, uri);
2250       if (!item)
2251         {
2252           item = bookmark_item_new (uri);
2253           g_bookmark_file_add_item (bookmark, item, NULL);
2254         }
2255
2256       g_free (item->description);
2257       item->description = g_strdup (description);
2258
2259       item->modified = time (NULL);
2260     }
2261 }
2262
2263 /**
2264  * g_bookmark_file_get_description:
2265  * @bookmark: a #GBookmarkFile
2266  * @uri: a valid URI
2267  * @error: return location for a #GError, or %NULL
2268  *
2269  * Retrieves the description of the bookmark for @uri.
2270  *
2271  * In the event the URI cannot be found, %NULL is returned and
2272  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2273  *
2274  * Return value: a newly allocated string or %NULL if the specified
2275  *   URI cannot be found.
2276  *
2277  * Since: 2.12
2278  */
2279 gchar *
2280 g_bookmark_file_get_description (GBookmarkFile  *bookmark,
2281                                  const gchar    *uri,
2282                                  GError        **error)
2283 {
2284   BookmarkItem *item;
2285
2286   g_return_val_if_fail (bookmark != NULL, NULL);
2287
2288   if (!uri)
2289     return g_strdup (bookmark->description);
2290
2291   item = g_bookmark_file_lookup_item (bookmark, uri);
2292   if (!item)
2293     {
2294       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2295                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2296                    _("No bookmark found for URI '%s'"),
2297                    uri);
2298       return NULL;
2299     }
2300
2301   return g_strdup (item->description);
2302 }
2303
2304 /**
2305  * g_bookmark_file_set_mime_type:
2306  * @bookmark: a #GBookmarkFile
2307  * @uri: a valid URI
2308  * @mime_type: a MIME type
2309  *
2310  * Sets @mime_type as the MIME type of the bookmark for @uri.
2311  *
2312  * If a bookmark for @uri cannot be found then it is created.
2313  *
2314  * Since: 2.12
2315  */
2316 void
2317 g_bookmark_file_set_mime_type (GBookmarkFile *bookmark,
2318                                const gchar   *uri,
2319                                const gchar   *mime_type)
2320 {
2321   BookmarkItem *item;
2322
2323   g_return_if_fail (bookmark != NULL);
2324   g_return_if_fail (uri != NULL);
2325   g_return_if_fail (mime_type != NULL);
2326
2327   item = g_bookmark_file_lookup_item (bookmark, uri);
2328   if (!item)
2329     {
2330       item = bookmark_item_new (uri);
2331       g_bookmark_file_add_item (bookmark, item, NULL);
2332     }
2333
2334   if (!item->metadata)
2335     item->metadata = bookmark_metadata_new ();
2336
2337   g_free (item->metadata->mime_type);
2338
2339   item->metadata->mime_type = g_strdup (mime_type);
2340   item->modified = time (NULL);
2341 }
2342
2343 /**
2344  * g_bookmark_file_get_mime_type:
2345  * @bookmark: a #GBookmarkFile
2346  * @uri: a valid URI
2347  * @error: return location for a #GError, or %NULL
2348  *
2349  * Retrieves the MIME type of the resource pointed by @uri.
2350  *
2351  * In the event the URI cannot be found, %NULL is returned and
2352  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
2353  * event that the MIME type cannot be found, %NULL is returned and
2354  * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2355  *
2356  * Return value: a newly allocated string or %NULL if the specified
2357  *   URI cannot be found.
2358  *
2359  * Since: 2.12
2360  */
2361 gchar *
2362 g_bookmark_file_get_mime_type (GBookmarkFile  *bookmark,
2363                                const gchar    *uri,
2364                                GError        **error)
2365 {
2366   BookmarkItem *item;
2367
2368   g_return_val_if_fail (bookmark != NULL, NULL);
2369   g_return_val_if_fail (uri != NULL, NULL);
2370
2371   item = g_bookmark_file_lookup_item (bookmark, uri);
2372   if (!item)
2373     {
2374       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2375                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2376                    _("No bookmark found for URI '%s'"),
2377                    uri);
2378       return NULL;
2379     }
2380
2381   if (!item->metadata)
2382     {
2383       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2384                    G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2385                    _("No MIME type defined in the bookmark for URI '%s'"),
2386                    uri);
2387       return NULL;
2388     }
2389
2390   return g_strdup (item->metadata->mime_type);
2391 }
2392
2393 /**
2394  * g_bookmark_file_set_is_private:
2395  * @bookmark: a #GBookmarkFile
2396  * @uri: a valid URI
2397  * @is_private: %TRUE if the bookmark should be marked as private
2398  *
2399  * Sets the private flag of the bookmark for @uri.
2400  *
2401  * If a bookmark for @uri cannot be found then it is created.
2402  *
2403  * Since: 2.12
2404  */
2405 void
2406 g_bookmark_file_set_is_private (GBookmarkFile *bookmark,
2407                                 const gchar   *uri,
2408                                 gboolean       is_private)
2409 {
2410   BookmarkItem *item;
2411
2412   g_return_if_fail (bookmark != NULL);
2413   g_return_if_fail (uri != NULL);
2414
2415   item = g_bookmark_file_lookup_item (bookmark, uri);
2416   if (!item)
2417     {
2418       item = bookmark_item_new (uri);
2419       g_bookmark_file_add_item (bookmark, item, NULL);
2420     }
2421
2422   if (!item->metadata)
2423     item->metadata = bookmark_metadata_new ();
2424
2425   item->metadata->is_private = (is_private == TRUE);
2426   item->modified = time (NULL);
2427 }
2428
2429 /**
2430  * g_bookmark_file_get_is_private:
2431  * @bookmark: a #GBookmarkFile
2432  * @uri: a valid URI
2433  * @error: return location for a #GError, or %NULL
2434  *
2435  * Gets whether the private flag of the bookmark for @uri is set.
2436  *
2437  * In the event the URI cannot be found, %FALSE is returned and
2438  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
2439  * event that the private flag cannot be found, %FALSE is returned and
2440  * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2441  *
2442  * Return value: %TRUE if the private flag is set, %FALSE otherwise.
2443  *
2444  * Since: 2.12
2445  */
2446 gboolean
2447 g_bookmark_file_get_is_private (GBookmarkFile  *bookmark,
2448                                 const gchar    *uri,
2449                                 GError        **error)
2450 {
2451   BookmarkItem *item;
2452
2453   g_return_val_if_fail (bookmark != NULL, FALSE);
2454   g_return_val_if_fail (uri != NULL, FALSE);
2455
2456   item = g_bookmark_file_lookup_item (bookmark, uri);
2457   if (!item)
2458     {
2459       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2460                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2461                    _("No bookmark found for URI '%s'"),
2462                    uri);
2463       return FALSE;
2464     }
2465
2466   if (!item->metadata)
2467     {
2468       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2469                    G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2470                    _("No private flag has been defined in bookmark for URI '%s'"),
2471                     uri);
2472       return FALSE;
2473     }
2474
2475   return item->metadata->is_private;
2476 }
2477
2478 /**
2479  * g_bookmark_file_set_added:
2480  * @bookmark: a #GBookmarkFile
2481  * @uri: a valid URI
2482  * @added: a timestamp or -1 to use the current time
2483  *
2484  * Sets the time the bookmark for @uri was added into @bookmark.
2485  *
2486  * If no bookmark for @uri is found then it is created.
2487  *
2488  * Since: 2.12
2489  */
2490 void
2491 g_bookmark_file_set_added (GBookmarkFile *bookmark,
2492                            const gchar   *uri,
2493                            time_t         added)
2494 {
2495   BookmarkItem *item;
2496
2497   g_return_if_fail (bookmark != NULL);
2498   g_return_if_fail (uri != NULL);
2499
2500   item = g_bookmark_file_lookup_item (bookmark, uri);
2501   if (!item)
2502     {
2503       item = bookmark_item_new (uri);
2504       g_bookmark_file_add_item (bookmark, item, NULL);
2505     }
2506
2507   if (added == (time_t) -1)
2508     time (&added);
2509
2510   item->added = added;
2511   item->modified = added;
2512 }
2513
2514 /**
2515  * g_bookmark_file_get_added:
2516  * @bookmark: a #GBookmarkFile
2517  * @uri: a valid URI
2518  * @error: return location for a #GError, or %NULL
2519  *
2520  * Gets the time the bookmark for @uri was added to @bookmark
2521  *
2522  * In the event the URI cannot be found, -1 is returned and
2523  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2524  *
2525  * Return value: a timestamp
2526  *
2527  * Since: 2.12
2528  */
2529 time_t
2530 g_bookmark_file_get_added (GBookmarkFile  *bookmark,
2531                            const gchar    *uri,
2532                            GError        **error)
2533 {
2534   BookmarkItem *item;
2535
2536   g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2537   g_return_val_if_fail (uri != NULL, (time_t) -1);
2538
2539   item = g_bookmark_file_lookup_item (bookmark, uri);
2540   if (!item)
2541     {
2542       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2543                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2544                    _("No bookmark found for URI '%s'"),
2545                    uri);
2546       return (time_t) -1;
2547     }
2548
2549   return item->added;
2550 }
2551
2552 /**
2553  * g_bookmark_file_set_modified:
2554  * @bookmark: a #GBookmarkFile
2555  * @uri: a valid URI
2556  * @modified: a timestamp or -1 to use the current time
2557  *
2558  * Sets the last time the bookmark for @uri was last modified.
2559  *
2560  * If no bookmark for @uri is found then it is created.
2561  *
2562  * The "modified" time should only be set when the bookmark's meta-data
2563  * was actually changed.  Every function of #GBookmarkFile that
2564  * modifies a bookmark also changes the modification time, except for
2565  * g_bookmark_file_set_visited().
2566  *
2567  * Since: 2.12
2568  */
2569 void
2570 g_bookmark_file_set_modified (GBookmarkFile *bookmark,
2571                               const gchar   *uri,
2572                               time_t         modified)
2573 {
2574   BookmarkItem *item;
2575
2576   g_return_if_fail (bookmark != NULL);
2577   g_return_if_fail (uri != NULL);
2578
2579   item = g_bookmark_file_lookup_item (bookmark, uri);
2580   if (!item)
2581     {
2582       item = bookmark_item_new (uri);
2583       g_bookmark_file_add_item (bookmark, item, NULL);
2584     }
2585
2586   if (modified == (time_t) -1)
2587     time (&modified);
2588
2589   item->modified = modified;
2590 }
2591
2592 /**
2593  * g_bookmark_file_get_modified:
2594  * @bookmark: a #GBookmarkFile
2595  * @uri: a valid URI
2596  * @error: return location for a #GError, or %NULL
2597  *
2598  * Gets the time when the bookmark for @uri was last modified.
2599  *
2600  * In the event the URI cannot be found, -1 is returned and
2601  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2602  *
2603  * Return value: a timestamp
2604  *
2605  * Since: 2.12
2606  */
2607 time_t
2608 g_bookmark_file_get_modified (GBookmarkFile  *bookmark,
2609                               const gchar    *uri,
2610                               GError        **error)
2611 {
2612   BookmarkItem *item;
2613
2614   g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2615   g_return_val_if_fail (uri != NULL, (time_t) -1);
2616
2617   item = g_bookmark_file_lookup_item (bookmark, uri);
2618   if (!item)
2619     {
2620       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2621                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2622                    _("No bookmark found for URI '%s'"),
2623                    uri);
2624       return (time_t) -1;
2625     }
2626
2627   return item->modified;
2628 }
2629
2630 /**
2631  * g_bookmark_file_set_visited:
2632  * @bookmark: a #GBookmarkFile
2633  * @uri: a valid URI
2634  * @visited: a timestamp or -1 to use the current time
2635  *
2636  * Sets the time the bookmark for @uri was last visited.
2637  *
2638  * If no bookmark for @uri is found then it is created.
2639  *
2640  * The "visited" time should only be set if the bookmark was launched,
2641  * either using the command line retrieved by g_bookmark_file_get_app_info()
2642  * or by the default application for the bookmark's MIME type, retrieved
2643  * using g_bookmark_file_get_mime_type().  Changing the "visited" time
2644  * does not affect the "modified" time.
2645  *
2646  * Since: 2.12
2647  */
2648 void
2649 g_bookmark_file_set_visited (GBookmarkFile *bookmark,
2650                              const gchar   *uri,
2651                              time_t         visited)
2652 {
2653   BookmarkItem *item;
2654
2655   g_return_if_fail (bookmark != NULL);
2656   g_return_if_fail (uri != NULL);
2657
2658   item = g_bookmark_file_lookup_item (bookmark, uri);
2659   if (!item)
2660     {
2661       item = bookmark_item_new (uri);
2662       g_bookmark_file_add_item (bookmark, item, NULL);
2663     }
2664
2665   if (visited == (time_t) -1)
2666     time (&visited);
2667
2668   item->visited = visited;
2669 }
2670
2671 /**
2672  * g_bookmark_file_get_visited:
2673  * @bookmark: a #GBookmarkFile
2674  * @uri: a valid URI
2675  * @error: return location for a #GError, or %NULL
2676  *
2677  * Gets the time the bookmark for @uri was last visited.
2678  *
2679  * In the event the URI cannot be found, -1 is returned and
2680  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2681  *
2682  * Return value: a timestamp.
2683  *
2684  * Since: 2.12
2685  */
2686 time_t
2687 g_bookmark_file_get_visited (GBookmarkFile  *bookmark,
2688                              const gchar    *uri,
2689                              GError        **error)
2690 {
2691   BookmarkItem *item;
2692
2693   g_return_val_if_fail (bookmark != NULL, (time_t) -1);
2694   g_return_val_if_fail (uri != NULL, (time_t) -1);
2695
2696   item = g_bookmark_file_lookup_item (bookmark, uri);
2697   if (!item)
2698     {
2699       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2700                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2701                    _("No bookmark found for URI '%s'"),
2702                    uri);
2703       return (time_t) -1;
2704     }
2705
2706   return item->visited;
2707 }
2708
2709 /**
2710  * g_bookmark_file_has_group:
2711  * @bookmark: a #GBookmarkFile
2712  * @uri: a valid URI
2713  * @group: the group name to be searched
2714  * @error: return location for a #GError, or %NULL
2715  *
2716  * Checks whether @group appears in the list of groups to which
2717  * the bookmark for @uri belongs to.
2718  *
2719  * In the event the URI cannot be found, %FALSE is returned and
2720  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2721  *
2722  * Return value: %TRUE if @group was found.
2723  *
2724  * Since: 2.12
2725  */
2726 gboolean
2727 g_bookmark_file_has_group (GBookmarkFile  *bookmark,
2728                            const gchar    *uri,
2729                            const gchar    *group,
2730                            GError        **error)
2731 {
2732   BookmarkItem *item;
2733   GList *l;
2734
2735   g_return_val_if_fail (bookmark != NULL, FALSE);
2736   g_return_val_if_fail (uri != NULL, FALSE);
2737
2738   item = g_bookmark_file_lookup_item (bookmark, uri);
2739   if (!item)
2740     {
2741       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2742                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2743                    _("No bookmark found for URI '%s'"),
2744                    uri);
2745       return FALSE;
2746     }
2747
2748   if (!item->metadata)
2749     return FALSE;
2750
2751   for (l = item->metadata->groups; l != NULL; l = l->next)
2752     {
2753       if (strcmp (l->data, group) == 0)
2754         return TRUE;
2755     }
2756
2757   return FALSE;
2758
2759 }
2760
2761 /**
2762  * g_bookmark_file_add_group:
2763  * @bookmark: a #GBookmarkFile
2764  * @uri: a valid URI
2765  * @group: the group name to be added
2766  *
2767  * Adds @group to the list of groups to which the bookmark for @uri
2768  * belongs to.
2769  *
2770  * If no bookmark for @uri is found then it is created.
2771  *
2772  * Since: 2.12
2773  */
2774 void
2775 g_bookmark_file_add_group (GBookmarkFile *bookmark,
2776                            const gchar   *uri,
2777                            const gchar   *group)
2778 {
2779   BookmarkItem *item;
2780
2781   g_return_if_fail (bookmark != NULL);
2782   g_return_if_fail (uri != NULL);
2783   g_return_if_fail (group != NULL && group[0] != '\0');
2784
2785   item = g_bookmark_file_lookup_item (bookmark, uri);
2786   if (!item)
2787     {
2788       item = bookmark_item_new (uri);
2789       g_bookmark_file_add_item (bookmark, item, NULL);
2790     }
2791
2792   if (!item->metadata)
2793     item->metadata = bookmark_metadata_new ();
2794
2795   if (!g_bookmark_file_has_group (bookmark, uri, group, NULL))
2796     {
2797       item->metadata->groups = g_list_prepend (item->metadata->groups,
2798                                                g_strdup (group));
2799
2800       item->modified = time (NULL);
2801     }
2802 }
2803
2804 /**
2805  * g_bookmark_file_remove_group:
2806  * @bookmark: a #GBookmarkFile
2807  * @uri: a valid URI
2808  * @group: the group name to be removed
2809  * @error: return location for a #GError, or %NULL
2810  *
2811  * Removes @group from the list of groups to which the bookmark
2812  * for @uri belongs to.
2813  *
2814  * In the event the URI cannot be found, %FALSE is returned and
2815  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2816  * In the event no group was defined, %FALSE is returned and
2817  * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
2818  *
2819  * Return value: %TRUE if @group was successfully removed.
2820  *
2821  * Since: 2.12
2822  */
2823 gboolean
2824 g_bookmark_file_remove_group (GBookmarkFile  *bookmark,
2825                               const gchar    *uri,
2826                               const gchar    *group,
2827                               GError        **error)
2828 {
2829   BookmarkItem *item;
2830   GList *l;
2831
2832   g_return_val_if_fail (bookmark != NULL, FALSE);
2833   g_return_val_if_fail (uri != NULL, FALSE);
2834
2835   item = g_bookmark_file_lookup_item (bookmark, uri);
2836   if (!item)
2837     {
2838       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2839                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2840                    _("No bookmark found for URI '%s'"),
2841                    uri);
2842       return FALSE;
2843     }
2844
2845   if (!item->metadata)
2846     {
2847       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2848                    G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
2849                    _("No groups set in bookmark for URI '%s'"),
2850                    uri);
2851       return FALSE;
2852     }
2853
2854   for (l = item->metadata->groups; l != NULL; l = l->next)
2855     {
2856       if (strcmp (l->data, group) == 0)
2857         {
2858           item->metadata->groups = g_list_remove_link (item->metadata->groups, l);
2859           g_free (l->data);
2860           g_list_free_1 (l);
2861
2862           item->modified = time (NULL);
2863
2864           return TRUE;
2865         }
2866     }
2867
2868   return FALSE;
2869 }
2870
2871 /**
2872  * g_bookmark_file_set_groups:
2873  * @bookmark: a #GBookmarkFile
2874  * @uri: an item's URI
2875  * @groups: (allow-none): an array of group names, or %NULL to remove all groups
2876  * @length: number of group name values in @groups
2877  *
2878  * Sets a list of group names for the item with URI @uri.  Each previously
2879  * set group name list is removed.
2880  *
2881  * If @uri cannot be found then an item for it is created.
2882  *
2883  * Since: 2.12
2884  */
2885 void
2886 g_bookmark_file_set_groups (GBookmarkFile  *bookmark,
2887                             const gchar    *uri,
2888                             const gchar   **groups,
2889                             gsize           length)
2890 {
2891   BookmarkItem *item;
2892   gsize i;
2893
2894   g_return_if_fail (bookmark != NULL);
2895   g_return_if_fail (uri != NULL);
2896   g_return_if_fail (groups != NULL);
2897
2898   item = g_bookmark_file_lookup_item (bookmark, uri);
2899   if (!item)
2900     {
2901       item = bookmark_item_new (uri);
2902       g_bookmark_file_add_item (bookmark, item, NULL);
2903     }
2904
2905   if (!item->metadata)
2906     item->metadata = bookmark_metadata_new ();
2907
2908   g_list_free_full (item->metadata->groups, g_free);
2909   item->metadata->groups = NULL;
2910
2911   if (groups)
2912     {
2913       for (i = 0; groups[i] != NULL && i < length; i++)
2914         item->metadata->groups = g_list_append (item->metadata->groups,
2915                                                 g_strdup (groups[i]));
2916     }
2917
2918   item->modified = time (NULL);
2919 }
2920
2921 /**
2922  * g_bookmark_file_get_groups:
2923  * @bookmark: a #GBookmarkFile
2924  * @uri: a valid URI
2925  * @length: (allow-none): return location for the length of the returned string, or %NULL
2926  * @error: return location for a #GError, or %NULL
2927  *
2928  * Retrieves the list of group names of the bookmark for @uri.
2929  *
2930  * In the event the URI cannot be found, %NULL is returned and
2931  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
2932  *
2933  * The returned array is %NULL terminated, so @length may optionally
2934  * be %NULL.
2935  *
2936  * Return value: a newly allocated %NULL-terminated array of group names.
2937  *   Use g_strfreev() to free it.
2938  *
2939  * Since: 2.12
2940  */
2941 gchar **
2942 g_bookmark_file_get_groups (GBookmarkFile  *bookmark,
2943                             const gchar    *uri,
2944                             gsize          *length,
2945                             GError        **error)
2946 {
2947   BookmarkItem *item;
2948   GList *l;
2949   gsize len, i;
2950   gchar **retval;
2951
2952   g_return_val_if_fail (bookmark != NULL, NULL);
2953   g_return_val_if_fail (uri != NULL, NULL);
2954
2955   item = g_bookmark_file_lookup_item (bookmark, uri);
2956   if (!item)
2957     {
2958       g_set_error (error, G_BOOKMARK_FILE_ERROR,
2959                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
2960                    _("No bookmark found for URI '%s'"),
2961                    uri);
2962       return NULL;
2963     }
2964
2965   if (!item->metadata)
2966     {
2967       if (length)
2968         *length = 0;
2969
2970       return NULL;
2971     }
2972
2973   len = g_list_length (item->metadata->groups);
2974   retval = g_new0 (gchar *, len + 1);
2975   for (l = g_list_last (item->metadata->groups), i = 0;
2976        l != NULL;
2977        l = l->prev)
2978     {
2979       gchar *group_name = (gchar *) l->data;
2980
2981       g_warn_if_fail (group_name != NULL);
2982
2983       retval[i++] = g_strdup (group_name);
2984     }
2985   retval[i] = NULL;
2986
2987   if (length)
2988     *length = len;
2989
2990   return retval;
2991 }
2992
2993 /**
2994  * g_bookmark_file_add_application:
2995  * @bookmark: a #GBookmarkFile
2996  * @uri: a valid URI
2997  * @name: (allow-none): the name of the application registering the bookmark
2998  *   or %NULL
2999  * @exec: (allow-none): command line to be used to launch the bookmark or %NULL
3000  *
3001  * Adds the application with @name and @exec to the list of
3002  * applications that have registered a bookmark for @uri into
3003  * @bookmark.
3004  *
3005  * Every bookmark inside a #GBookmarkFile must have at least an
3006  * application registered.  Each application must provide a name, a
3007  * command line useful for launching the bookmark, the number of times
3008  * the bookmark has been registered by the application and the last
3009  * time the application registered this bookmark.
3010  *
3011  * If @name is %NULL, the name of the application will be the
3012  * same returned by g_get_application_name(); if @exec is %NULL, the
3013  * command line will be a composition of the program name as
3014  * returned by g_get_prgname() and the "\%u" modifier, which will be
3015  * expanded to the bookmark's URI.
3016  *
3017  * This function will automatically take care of updating the
3018  * registrations count and timestamping in case an application
3019  * with the same @name had already registered a bookmark for
3020  * @uri inside @bookmark.
3021  *
3022  * If no bookmark for @uri is found, one is created.
3023  *
3024  * Since: 2.12
3025  */
3026 void
3027 g_bookmark_file_add_application (GBookmarkFile *bookmark,
3028                                  const gchar   *uri,
3029                                  const gchar   *name,
3030                                  const gchar   *exec)
3031 {
3032   BookmarkItem *item;
3033   gchar *app_name, *app_exec;
3034
3035   g_return_if_fail (bookmark != NULL);
3036   g_return_if_fail (uri != NULL);
3037
3038   item = g_bookmark_file_lookup_item (bookmark, uri);
3039   if (!item)
3040     {
3041       item = bookmark_item_new (uri);
3042       g_bookmark_file_add_item (bookmark, item, NULL);
3043     }
3044
3045   if (name && name[0] != '\0')
3046     app_name = g_strdup (name);
3047   else
3048     app_name = g_strdup (g_get_application_name ());
3049
3050   if (exec && exec[0] != '\0')
3051     app_exec = g_strdup (exec);
3052   else
3053     app_exec = g_strjoin (" ", g_get_prgname(), "%u", NULL);
3054
3055   g_bookmark_file_set_app_info (bookmark, uri,
3056                                 app_name,
3057                                 app_exec,
3058                                 -1,
3059                                 (time_t) -1,
3060                                 NULL);
3061
3062   g_free (app_exec);
3063   g_free (app_name);
3064 }
3065
3066 /**
3067  * g_bookmark_file_remove_application:
3068  * @bookmark: a #GBookmarkFile
3069  * @uri: a valid URI
3070  * @name: the name of the application
3071  * @error: return location for a #GError or %NULL
3072  *
3073  * Removes application registered with @name from the list of applications
3074  * that have registered a bookmark for @uri inside @bookmark.
3075  *
3076  * In the event the URI cannot be found, %FALSE is returned and
3077  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3078  * In the event that no application with name @app_name has registered
3079  * a bookmark for @uri,  %FALSE is returned and error is set to
3080  * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
3081  *
3082  * Return value: %TRUE if the application was successfully removed.
3083  *
3084  * Since: 2.12
3085  */
3086 gboolean
3087 g_bookmark_file_remove_application (GBookmarkFile  *bookmark,
3088                                     const gchar    *uri,
3089                                     const gchar    *name,
3090                                     GError        **error)
3091 {
3092   GError *set_error;
3093   gboolean retval;
3094
3095   g_return_val_if_fail (bookmark != NULL, FALSE);
3096   g_return_val_if_fail (uri != NULL, FALSE);
3097   g_return_val_if_fail (name != NULL, FALSE);
3098
3099   set_error = NULL;
3100   retval = g_bookmark_file_set_app_info (bookmark, uri,
3101                                          name,
3102                                          "",
3103                                          0,
3104                                          (time_t) -1,
3105                                          &set_error);
3106   if (set_error)
3107     {
3108       g_propagate_error (error, set_error);
3109
3110       return FALSE;
3111     }
3112
3113   return retval;
3114 }
3115
3116 /**
3117  * g_bookmark_file_has_application:
3118  * @bookmark: a #GBookmarkFile
3119  * @uri: a valid URI
3120  * @name: the name of the application
3121  * @error: return location for a #GError or %NULL
3122  *
3123  * Checks whether the bookmark for @uri inside @bookmark has been
3124  * registered by application @name.
3125  *
3126  * In the event the URI cannot be found, %FALSE is returned and
3127  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3128  *
3129  * Return value: %TRUE if the application @name was found
3130  *
3131  * Since: 2.12
3132  */
3133 gboolean
3134 g_bookmark_file_has_application (GBookmarkFile  *bookmark,
3135                                  const gchar    *uri,
3136                                  const gchar    *name,
3137                                  GError        **error)
3138 {
3139   BookmarkItem *item;
3140
3141   g_return_val_if_fail (bookmark != NULL, FALSE);
3142   g_return_val_if_fail (uri != NULL, FALSE);
3143   g_return_val_if_fail (name != NULL, FALSE);
3144
3145   item = g_bookmark_file_lookup_item (bookmark, uri);
3146   if (!item)
3147     {
3148       g_set_error (error, G_BOOKMARK_FILE_ERROR,
3149                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3150                    _("No bookmark found for URI '%s'"),
3151                    uri);
3152       return FALSE;
3153     }
3154
3155   return (NULL != bookmark_item_lookup_app_info (item, name));
3156 }
3157
3158 /**
3159  * g_bookmark_file_set_app_info:
3160  * @bookmark: a #GBookmarkFile
3161  * @uri: a valid URI
3162  * @name: an application's name
3163  * @exec: an application's command line
3164  * @count: the number of registrations done for this application
3165  * @stamp: the time of the last registration for this application
3166  * @error: return location for a #GError or %NULL
3167  *
3168  * Sets the meta-data of application @name inside the list of
3169  * applications that have registered a bookmark for @uri inside
3170  * @bookmark.
3171  *
3172  * You should rarely use this function; use g_bookmark_file_add_application()
3173  * and g_bookmark_file_remove_application() instead.
3174  *
3175  * @name can be any UTF-8 encoded string used to identify an
3176  * application.
3177  * @exec can have one of these two modifiers: "\%f", which will
3178  * be expanded as the local file name retrieved from the bookmark's
3179  * URI; "\%u", which will be expanded as the bookmark's URI.
3180  * The expansion is done automatically when retrieving the stored
3181  * command line using the g_bookmark_file_get_app_info() function.
3182  * @count is the number of times the application has registered the
3183  * bookmark; if is < 0, the current registration count will be increased
3184  * by one, if is 0, the application with @name will be removed from
3185  * the list of registered applications.
3186  * @stamp is the Unix time of the last registration; if it is -1, the
3187  * current time will be used.
3188  *
3189  * If you try to remove an application by setting its registration count to
3190  * zero, and no bookmark for @uri is found, %FALSE is returned and
3191  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
3192  * in the event that no application @name has registered a bookmark
3193  * for @uri,  %FALSE is returned and error is set to
3194  * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.  Otherwise, if no bookmark
3195  * for @uri is found, one is created.
3196  *
3197  * Return value: %TRUE if the application's meta-data was successfully
3198  *   changed.
3199  *
3200  * Since: 2.12
3201  */
3202 gboolean
3203 g_bookmark_file_set_app_info (GBookmarkFile  *bookmark,
3204                               const gchar    *uri,
3205                               const gchar    *name,
3206                               const gchar    *exec,
3207                               gint            count,
3208                               time_t          stamp,
3209                               GError        **error)
3210 {
3211   BookmarkItem *item;
3212   BookmarkAppInfo *ai;
3213
3214   g_return_val_if_fail (bookmark != NULL, FALSE);
3215   g_return_val_if_fail (uri != NULL, FALSE);
3216   g_return_val_if_fail (name != NULL, FALSE);
3217   g_return_val_if_fail (exec != NULL, FALSE);
3218
3219   item = g_bookmark_file_lookup_item (bookmark, uri);
3220   if (!item)
3221     {
3222       if (count == 0)
3223         {
3224           g_set_error (error, G_BOOKMARK_FILE_ERROR,
3225                        G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3226                        _("No bookmark found for URI '%s'"),
3227                        uri);
3228           return FALSE;
3229         }
3230       else
3231         {
3232           item = bookmark_item_new (uri);
3233           g_bookmark_file_add_item (bookmark, item, NULL);
3234         }
3235     }
3236
3237   if (!item->metadata)
3238     item->metadata = bookmark_metadata_new ();
3239
3240   ai = bookmark_item_lookup_app_info (item, name);
3241   if (!ai)
3242     {
3243       if (count == 0)
3244         {
3245           g_set_error (error, G_BOOKMARK_FILE_ERROR,
3246                        G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3247                        _("No application with name '%s' registered a bookmark for '%s'"),
3248                        name,
3249                        uri);
3250           return FALSE;
3251         }
3252       else
3253         {
3254           ai = bookmark_app_info_new (name);
3255
3256           item->metadata->applications = g_list_prepend (item->metadata->applications, ai);
3257           g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai);
3258         }
3259     }
3260
3261   if (count == 0)
3262     {
3263       item->metadata->applications = g_list_remove (item->metadata->applications, ai);
3264       g_hash_table_remove (item->metadata->apps_by_name, ai->name);
3265       bookmark_app_info_free (ai);
3266
3267       item->modified = time (NULL);
3268
3269       return TRUE;
3270     }
3271   else if (count > 0)
3272     ai->count = count;
3273   else
3274     ai->count += 1;
3275
3276   if (stamp != (time_t) -1)
3277     ai->stamp = stamp;
3278   else
3279     ai->stamp = time (NULL);
3280
3281   if (exec && exec[0] != '\0')
3282     {
3283       g_free (ai->exec);
3284       ai->exec = g_shell_quote (exec);
3285     }
3286
3287   item->modified = time (NULL);
3288
3289   return TRUE;
3290 }
3291
3292 /* expands the application's command line */
3293 static gchar *
3294 expand_exec_line (const gchar *exec_fmt,
3295                   const gchar *uri)
3296 {
3297   GString *exec;
3298   gchar ch;
3299
3300   exec = g_string_sized_new (512);
3301   while ((ch = *exec_fmt++) != '\0')
3302    {
3303      if (ch != '%')
3304        {
3305          exec = g_string_append_c (exec, ch);
3306          continue;
3307        }
3308
3309      ch = *exec_fmt++;
3310      switch (ch)
3311        {
3312        case '\0':
3313          goto out;
3314        case 'U':
3315        case 'u':
3316          g_string_append (exec, uri);
3317          break;
3318        case 'F':
3319        case 'f':
3320          {
3321            gchar *file = g_filename_from_uri (uri, NULL, NULL);
3322            if (file)
3323              {
3324                g_string_append (exec, file);
3325                g_free (file);
3326              }
3327            else
3328              {
3329                g_string_free (exec, TRUE);
3330                return NULL;
3331              }
3332          }
3333          break;
3334        case '%':
3335        default:
3336          exec = g_string_append_c (exec, ch);
3337          break;
3338        }
3339    }
3340
3341  out:
3342   return g_string_free (exec, FALSE);
3343 }
3344
3345 /**
3346  * g_bookmark_file_get_app_info:
3347  * @bookmark: a #GBookmarkFile
3348  * @uri: a valid URI
3349  * @name: an application's name
3350  * @exec: (allow-none): location for the command line of the application, or %NULL
3351  * @count: (allow-none): return location for the registration count, or %NULL
3352  * @stamp: (allow-none): return location for the last registration time, or %NULL
3353  * @error: return location for a #GError, or %NULL
3354  *
3355  * Gets the registration informations of @app_name for the bookmark for
3356  * @uri.  See g_bookmark_file_set_app_info() for more informations about
3357  * the returned data.
3358  *
3359  * The string returned in @app_exec must be freed.
3360  *
3361  * In the event the URI cannot be found, %FALSE is returned and
3362  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
3363  * event that no application with name @app_name has registered a bookmark
3364  * for @uri,  %FALSE is returned and error is set to
3365  * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
3366  * the command line fails, an error of the #G_SHELL_ERROR domain is
3367  * set and %FALSE is returned.
3368  *
3369  * Return value: %TRUE on success.
3370  *
3371  * Since: 2.12
3372  */
3373 gboolean
3374 g_bookmark_file_get_app_info (GBookmarkFile  *bookmark,
3375                               const gchar    *uri,
3376                               const gchar    *name,
3377                               gchar         **exec,
3378                               guint          *count,
3379                               time_t         *stamp,
3380                               GError        **error)
3381 {
3382   BookmarkItem *item;
3383   BookmarkAppInfo *ai;
3384
3385   g_return_val_if_fail (bookmark != NULL, FALSE);
3386   g_return_val_if_fail (uri != NULL, FALSE);
3387   g_return_val_if_fail (name != NULL, FALSE);
3388
3389   item = g_bookmark_file_lookup_item (bookmark, uri);
3390   if (!item)
3391     {
3392       g_set_error (error, G_BOOKMARK_FILE_ERROR,
3393                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3394                    _("No bookmark found for URI '%s'"),
3395                    uri);
3396       return FALSE;
3397     }
3398
3399   ai = bookmark_item_lookup_app_info (item, name);
3400   if (!ai)
3401     {
3402       g_set_error (error, G_BOOKMARK_FILE_ERROR,
3403                    G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
3404                    _("No application with name '%s' registered a bookmark for '%s'"),
3405                    name,
3406                    uri);
3407       return FALSE;
3408     }
3409
3410   if (exec)
3411     {
3412       GError *unquote_error = NULL;
3413       gchar *command_line;
3414
3415       command_line = g_shell_unquote (ai->exec, &unquote_error);
3416       if (unquote_error)
3417         {
3418           g_propagate_error (error, unquote_error);
3419           return FALSE;
3420         }
3421
3422       *exec = expand_exec_line (command_line, uri);
3423       if (!*exec)
3424         {
3425           g_set_error (error, G_BOOKMARK_FILE_ERROR,
3426                        G_BOOKMARK_FILE_ERROR_INVALID_URI,
3427                        _("Failed to expand exec line '%s' with URI '%s'"),
3428                      ai->exec, uri);
3429           g_free (command_line);
3430
3431           return FALSE;
3432         }
3433       else
3434         g_free (command_line);
3435     }
3436
3437   if (count)
3438     *count = ai->count;
3439
3440   if (stamp)
3441     *stamp = ai->stamp;
3442
3443   return TRUE;
3444 }
3445
3446 /**
3447  * g_bookmark_file_get_applications:
3448  * @bookmark: a #GBookmarkFile
3449  * @uri: a valid URI
3450  * @length: (allow-none): return location of the length of the returned list, or %NULL
3451  * @error: return location for a #GError, or %NULL
3452  *
3453  * Retrieves the names of the applications that have registered the
3454  * bookmark for @uri.
3455  *
3456  * In the event the URI cannot be found, %NULL is returned and
3457  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3458  *
3459  * Return value: a newly allocated %NULL-terminated array of strings.
3460  *   Use g_strfreev() to free it.
3461  *
3462  * Since: 2.12
3463  */
3464 gchar **
3465 g_bookmark_file_get_applications (GBookmarkFile  *bookmark,
3466                                   const gchar    *uri,
3467                                   gsize          *length,
3468                                   GError        **error)
3469 {
3470   BookmarkItem *item;
3471   GList *l;
3472   gchar **apps;
3473   gsize i, n_apps;
3474
3475   g_return_val_if_fail (bookmark != NULL, NULL);
3476   g_return_val_if_fail (uri != NULL, NULL);
3477
3478   item = g_bookmark_file_lookup_item (bookmark, uri);
3479   if (!item)
3480     {
3481       g_set_error (error, G_BOOKMARK_FILE_ERROR,
3482                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3483                    _("No bookmark found for URI '%s'"),
3484                    uri);
3485       return NULL;
3486     }
3487
3488   if (!item->metadata)
3489     {
3490       if (length)
3491         *length = 0;
3492
3493       return NULL;
3494     }
3495
3496   n_apps = g_list_length (item->metadata->applications);
3497   apps = g_new0 (gchar *, n_apps + 1);
3498
3499   for (l = g_list_last (item->metadata->applications), i = 0;
3500        l != NULL;
3501        l = l->prev)
3502     {
3503       BookmarkAppInfo *ai;
3504
3505       ai = (BookmarkAppInfo *) l->data;
3506
3507       g_warn_if_fail (ai != NULL);
3508       g_warn_if_fail (ai->name != NULL);
3509
3510       apps[i++] = g_strdup (ai->name);
3511     }
3512   apps[i] = NULL;
3513
3514   if (length)
3515     *length = i;
3516
3517   return apps;
3518 }
3519
3520 /**
3521  * g_bookmark_file_get_size:
3522  * @bookmark: a #GBookmarkFile
3523  *
3524  * Gets the number of bookmarks inside @bookmark.
3525  *
3526  * Return value: the number of bookmarks
3527  *
3528  * Since: 2.12
3529  */
3530 gint
3531 g_bookmark_file_get_size (GBookmarkFile *bookmark)
3532 {
3533   g_return_val_if_fail (bookmark != NULL, 0);
3534
3535   return g_list_length (bookmark->items);
3536 }
3537
3538 /**
3539  * g_bookmark_file_move_item:
3540  * @bookmark: a #GBookmarkFile
3541  * @old_uri: a valid URI
3542  * @new_uri: (allow-none): a valid URI, or %NULL
3543  * @error: return location for a #GError or %NULL
3544  *
3545  * Changes the URI of a bookmark item from @old_uri to @new_uri.  Any
3546  * existing bookmark for @new_uri will be overwritten.  If @new_uri is
3547  * %NULL, then the bookmark is removed.
3548  *
3549  * In the event the URI cannot be found, %FALSE is returned and
3550  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3551  *
3552  * Return value: %TRUE if the URI was successfully changed
3553  *
3554  * Since: 2.12
3555  */
3556 gboolean
3557 g_bookmark_file_move_item (GBookmarkFile  *bookmark,
3558                            const gchar    *old_uri,
3559                            const gchar    *new_uri,
3560                            GError        **error)
3561 {
3562   BookmarkItem *item;
3563   GError *remove_error;
3564
3565   g_return_val_if_fail (bookmark != NULL, FALSE);
3566   g_return_val_if_fail (old_uri != NULL, FALSE);
3567
3568   item = g_bookmark_file_lookup_item (bookmark, old_uri);
3569   if (!item)
3570     {
3571       g_set_error (error, G_BOOKMARK_FILE_ERROR,
3572                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3573                    _("No bookmark found for URI '%s'"),
3574                    old_uri);
3575       return FALSE;
3576     }
3577
3578   if (new_uri && new_uri[0] != '\0')
3579     {
3580       if (g_bookmark_file_has_item (bookmark, new_uri))
3581         {
3582           remove_error = NULL;
3583           g_bookmark_file_remove_item (bookmark, new_uri, &remove_error);
3584           if (remove_error)
3585             {
3586               g_propagate_error (error, remove_error);
3587
3588               return FALSE;
3589             }
3590         }
3591
3592       g_hash_table_steal (bookmark->items_by_uri, item->uri);
3593
3594       g_free (item->uri);
3595       item->uri = g_strdup (new_uri);
3596       item->modified = time (NULL);
3597
3598       g_hash_table_replace (bookmark->items_by_uri, item->uri, item);
3599
3600       return TRUE;
3601     }
3602   else
3603     {
3604       remove_error = NULL;
3605       g_bookmark_file_remove_item (bookmark, old_uri, &remove_error);
3606       if (remove_error)
3607         {
3608           g_propagate_error (error, remove_error);
3609
3610           return FALSE;
3611         }
3612
3613       return TRUE;
3614     }
3615 }
3616
3617 /**
3618  * g_bookmark_file_set_icon:
3619  * @bookmark: a #GBookmarkFile
3620  * @uri: a valid URI
3621  * @href: (allow-none): the URI of the icon for the bookmark, or %NULL
3622  * @mime_type: the MIME type of the icon for the bookmark
3623  *
3624  * Sets the icon for the bookmark for @uri. If @href is %NULL, unsets
3625  * the currently set icon. @href can either be a full URL for the icon
3626  * file or the icon name following the Icon Naming specification.
3627  *
3628  * If no bookmark for @uri is found one is created.
3629  *
3630  * Since: 2.12
3631  */
3632 void
3633 g_bookmark_file_set_icon (GBookmarkFile *bookmark,
3634                           const gchar   *uri,
3635                           const gchar   *href,
3636                           const gchar   *mime_type)
3637 {
3638   BookmarkItem *item;
3639
3640   g_return_if_fail (bookmark != NULL);
3641   g_return_if_fail (uri != NULL);
3642
3643   item = g_bookmark_file_lookup_item (bookmark, uri);
3644   if (!item)
3645     {
3646       item = bookmark_item_new (uri);
3647       g_bookmark_file_add_item (bookmark, item, NULL);
3648     }
3649
3650   if (!item->metadata)
3651     item->metadata = bookmark_metadata_new ();
3652
3653   g_free (item->metadata->icon_href);
3654   g_free (item->metadata->icon_mime);
3655
3656   item->metadata->icon_href = g_strdup (href);
3657
3658   if (mime_type && mime_type[0] != '\0')
3659     item->metadata->icon_mime = g_strdup (mime_type);
3660   else
3661     item->metadata->icon_mime = g_strdup ("application/octet-stream");
3662
3663   item->modified = time (NULL);
3664 }
3665
3666 /**
3667  * g_bookmark_file_get_icon:
3668  * @bookmark: a #GBookmarkFile
3669  * @uri: a valid URI
3670  * @href: (allow-none): return location for the icon's location or %NULL
3671  * @mime_type: (allow-none): return location for the icon's MIME type or %NULL
3672  * @error: return location for a #GError or %NULL
3673  *
3674  * Gets the icon of the bookmark for @uri.
3675  *
3676  * In the event the URI cannot be found, %FALSE is returned and
3677  * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
3678  *
3679  * Return value: %TRUE if the icon for the bookmark for the URI was found.
3680  *   You should free the returned strings.
3681  *
3682  * Since: 2.12
3683  */
3684 gboolean
3685 g_bookmark_file_get_icon (GBookmarkFile  *bookmark,
3686                           const gchar    *uri,
3687                           gchar         **href,
3688                           gchar         **mime_type,
3689                           GError        **error)
3690 {
3691   BookmarkItem *item;
3692
3693   g_return_val_if_fail (bookmark != NULL, FALSE);
3694   g_return_val_if_fail (uri != NULL, FALSE);
3695
3696   item = g_bookmark_file_lookup_item (bookmark, uri);
3697   if (!item)
3698     {
3699       g_set_error (error, G_BOOKMARK_FILE_ERROR,
3700                    G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
3701                    _("No bookmark found for URI '%s'"),
3702                    uri);
3703       return FALSE;
3704     }
3705
3706   if ((!item->metadata) || (!item->metadata->icon_href))
3707     return FALSE;
3708
3709   if (href)
3710     *href = g_strdup (item->metadata->icon_href);
3711
3712   if (mime_type)
3713     *mime_type = g_strdup (item->metadata->icon_mime);
3714
3715   return TRUE;
3716 }