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