/* gbookmarkfile.c: parsing and building desktop bookmarks

 *

 * Copyright (C) 2005-2006 Emmanuele Bassi

 * Portions copyright (c) 2009 Nokia Corporation.  All rights reserved.

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 */

#include "config.h"

#include "gbookmarkfile.h"

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include <errno.h>

#include <fcntl.h>

#include <locale.h>

#include <time.h>

#include <stdarg.h>

#include <sys/types.h>

#include <sys/stat.h>

#ifdef HAVE_UNISTD_H

#include <unistd.h>

#endif

#include "gconvert.h"

#include "gdataset.h"

#include "gerror.h"

#include "gfileutils.h"

#include "ghash.h"

#include "glibintl.h"

#include "glist.h"

#include "gslist.h"

#include "gmain.h"

#include "gmarkup.h"

#include "gmem.h"

#include "gmessages.h"

#include "gshell.h"

#include "gslice.h"

#include "gstdio.h"

#include "gstring.h"

#include "gstrfuncs.h"

#include "gtimer.h"

#include "gutils.h"

#include "galias.h"

/* XBEL 1.0 standard entities */

#define XBEL_VERSION		"1.0"

#define XBEL_DTD_NICK		"xbel"

#define XBEL_DTD_SYSTEM		"+//IDN python.org//DTD XML Bookmark " \

				"Exchange Language 1.0//EN//XML"

#define XBEL_DTD_URI		"http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"

#define XBEL_ROOT_ELEMENT	"xbel"

#define XBEL_FOLDER_ELEMENT	"folder" 	/* unused */

#define XBEL_BOOKMARK_ELEMENT	"bookmark"

#define XBEL_ALIAS_ELEMENT	"alias"		/* unused */

#define XBEL_SEPARATOR_ELEMENT	"separator" 	/* unused */

#define XBEL_TITLE_ELEMENT	"title"

#define XBEL_DESC_ELEMENT	"desc"

#define XBEL_INFO_ELEMENT	"info"

#define XBEL_METADATA_ELEMENT	"metadata"

#define XBEL_VERSION_ATTRIBUTE	"version"

#define XBEL_FOLDED_ATTRIBUTE	"folded" 	/* unused */

#define XBEL_OWNER_ATTRIBUTE	"owner"

#define XBEL_ADDED_ATTRIBUTE	"added"

#define XBEL_VISITED_ATTRIBUTE	"visited"

#define XBEL_MODIFIED_ATTRIBUTE "modified"

#define XBEL_ID_ATTRIBUTE	"id"

#define XBEL_HREF_ATTRIBUTE	"href"

#define XBEL_REF_ATTRIBUTE	"ref" 		/* unused */

#define XBEL_YES_VALUE		"yes"

#define XBEL_NO_VALUE		"no"

/* Desktop bookmark spec entities */

#define BOOKMARK_METADATA_OWNER 	"http://freedesktop.org"

#define BOOKMARK_NAMESPACE_NAME 	"bookmark"

#define BOOKMARK_NAMESPACE_URI		"http://www.freedesktop.org/standards/desktop-bookmarks"

#define BOOKMARK_GROUPS_ELEMENT		"groups"

#define BOOKMARK_GROUP_ELEMENT		"group"

#define BOOKMARK_APPLICATIONS_ELEMENT	"applications"

#define BOOKMARK_APPLICATION_ELEMENT	"application"

#define BOOKMARK_ICON_ELEMENT 		"icon"

#define BOOKMARK_PRIVATE_ELEMENT	"private"

#define BOOKMARK_NAME_ATTRIBUTE		"name"

#define BOOKMARK_EXEC_ATTRIBUTE		"exec"

#define BOOKMARK_COUNT_ATTRIBUTE 	"count"

#define BOOKMARK_TIMESTAMP_ATTRIBUTE	"timestamp"     /* deprecated by "modified" */

#define BOOKMARK_MODIFIED_ATTRIBUTE     "modified"

#define BOOKMARK_HREF_ATTRIBUTE 	"href"

#define BOOKMARK_TYPE_ATTRIBUTE 	"type"

/* Shared MIME Info entities */

#define MIME_NAMESPACE_NAME 		"mime"

#define MIME_NAMESPACE_URI 		"http://www.freedesktop.org/standards/shared-mime-info"

#define MIME_TYPE_ELEMENT 		"mime-type"

#define MIME_TYPE_ATTRIBUTE 		"type"

typedef struct _BookmarkAppInfo  BookmarkAppInfo;

typedef struct _BookmarkMetadata BookmarkMetadata;

typedef struct _BookmarkItem     BookmarkItem;

typedef struct _ParseData        ParseData;

struct _BookmarkAppInfo

{

  gchar *name;

  gchar *exec;

  guint count;

  time_t stamp;

};

struct _BookmarkMetadata

{

  gchar *mime_type;

  GList *groups;

  GList *applications;

  GHashTable *apps_by_name;

  gchar *icon_href;

  gchar *icon_mime;

  guint is_private : 1;

};

struct _BookmarkItem

{

  gchar *uri;

  gchar *title;

  gchar *description;

  time_t added;

  time_t modified;

  time_t visited;

  BookmarkMetadata *metadata;

};

struct _GBookmarkFile

{

  gchar *title;

  gchar *description;

  /* we store our items in a list and keep a copy inside

   * an hash table for faster lookup performances

   */

  GList *items;

  GHashTable *items_by_uri;

};

/* parser state machine */

enum

{

  STATE_STARTED        = 0,

  STATE_ROOT,

  STATE_BOOKMARK,

  STATE_TITLE,

  STATE_DESC,

  STATE_INFO,

  STATE_METADATA,

  STATE_APPLICATIONS,

  STATE_APPLICATION,

  STATE_GROUPS,

  STATE_GROUP,

  STATE_MIME,

  STATE_ICON,

  STATE_FINISHED

};

static void          g_bookmark_file_init        (GBookmarkFile  *bookmark);

static void          g_bookmark_file_clear       (GBookmarkFile  *bookmark);

static gboolean      g_bookmark_file_parse       (GBookmarkFile  *bookmark,

						  const gchar    *buffer,

						  gsize           length,

						  GError        **error);

static gchar *       g_bookmark_file_dump        (GBookmarkFile  *bookmark,

						  gsize          *length,

						  GError        **error);

static BookmarkItem *g_bookmark_file_lookup_item (GBookmarkFile  *bookmark,

						  const gchar    *uri);

static void          g_bookmark_file_add_item    (GBookmarkFile  *bookmark,

						  BookmarkItem   *item,

						  GError        **error);

static time_t  timestamp_from_iso8601 (const gchar *iso_date);

static gchar * timestamp_to_iso8601   (time_t       timestamp);

/********************************

 * BookmarkAppInfo              *

 *                              *

 * Application metadata storage *

 ********************************/

static BookmarkAppInfo *

bookmark_app_info_new (const gchar *name)

{

  BookmarkAppInfo *retval;

  g_warn_if_fail (name != NULL);

  retval = g_slice_new (BookmarkAppInfo);

  retval->name = g_strdup (name);

  retval->exec = NULL;

  retval->count = 0;

  retval->stamp = 0;

  return retval;

}

static void

bookmark_app_info_free (BookmarkAppInfo *app_info)

{

  if (!app_info)

    return;

  g_free (app_info->name);

  g_free (app_info->exec);

  g_slice_free (BookmarkAppInfo, app_info);

}

static gchar *

bookmark_app_info_dump (BookmarkAppInfo *app_info)

{

  gchar *retval;

  gchar *name, *exec, *modified, *count;

  g_warn_if_fail (app_info != NULL);

  if (app_info->count == 0)

    return NULL;

  name = g_markup_escape_text (app_info->name, -1);

  exec = g_markup_escape_text (app_info->exec, -1);

  modified = timestamp_to_iso8601 (app_info->stamp);

  count = g_strdup_printf ("%u", app_info->count);

  retval = g_strconcat ("          "

                        "<" BOOKMARK_NAMESPACE_NAME ":" BOOKMARK_APPLICATION_ELEMENT

                        " " BOOKMARK_NAME_ATTRIBUTE "=\"", name, "\""

                        " " BOOKMARK_EXEC_ATTRIBUTE "=\"", exec, "\""

                        " " BOOKMARK_MODIFIED_ATTRIBUTE "=\"", modified, "\""

                        " " BOOKMARK_COUNT_ATTRIBUTE "=\"", count, "\"/>\n",

                        NULL);

  g_free (name);

  g_free (exec);

  g_free (modified);

  g_free (count);

  return retval;

}

/***********************

 * BookmarkMetadata    *

 *                     *

 * Metadata storage    *

 ***********************/

static BookmarkMetadata *

bookmark_metadata_new (void)

{

  BookmarkMetadata *retval;

  retval = g_slice_new (BookmarkMetadata);

  retval->mime_type = NULL;

  retval->groups = NULL;

  retval->applications = NULL;

  retval->apps_by_name = g_hash_table_new_full (g_str_hash,

                                                g_str_equal,

                                                NULL,

                                                NULL);

  retval->is_private = FALSE;

  retval->icon_href = NULL;

  retval->icon_mime = NULL;

  return retval;

}

static void

bookmark_metadata_free (BookmarkMetadata *metadata)

{

  if (!metadata)

    return;

  g_free (metadata->mime_type);

  if (metadata->groups)

    {

      g_list_foreach (metadata->groups,

		      (GFunc) g_free,

		      NULL);

      g_list_free (metadata->groups);

    }

  if (metadata->applications)

    {

      g_list_foreach (metadata->applications,

		      (GFunc) bookmark_app_info_free,

		      NULL);

      g_list_free (metadata->applications);

    }

  g_hash_table_destroy (metadata->apps_by_name);

  g_free (metadata->icon_href);

  g_free (metadata->icon_mime);

  g_slice_free (BookmarkMetadata, metadata);

}

static gchar *

bookmark_metadata_dump (BookmarkMetadata *metadata)

{

  GString *retval;

  gchar *buffer;

  if (!metadata->applications)

    return NULL;

  retval = g_string_sized_new (1024);

  /* metadata container */

  g_string_append (retval,

		   "      "

		   "<" XBEL_METADATA_ELEMENT

		   " " XBEL_OWNER_ATTRIBUTE "=\"" BOOKMARK_METADATA_OWNER

		   "\">\n");

  /* mime type */

  if (metadata->mime_type) {

    buffer = g_strconcat ("        "

			  "<" MIME_NAMESPACE_NAME ":" MIME_TYPE_ELEMENT " "

			  MIME_TYPE_ATTRIBUTE "=\"", metadata->mime_type, "\"/>\n",

			  NULL);    

    g_string_append (retval, buffer);

    g_free (buffer);

  }

  if (metadata->groups)

    {

      GList *l;

      /* open groups container */

      g_string_append (retval,

		       "        "

		       "<" BOOKMARK_NAMESPACE_NAME

		       ":" BOOKMARK_GROUPS_ELEMENT ">\n");

      for (l = g_list_last (metadata->groups); l != NULL; l = l->prev)

        {

          gchar *group_name;

	  group_name = g_markup_escape_text ((gchar *) l->data, -1);

	  buffer = g_strconcat ("          "

				"<" BOOKMARK_NAMESPACE_NAME

				":" BOOKMARK_GROUP_ELEMENT ">",

				group_name,

				"</" BOOKMARK_NAMESPACE_NAME

				":"  BOOKMARK_GROUP_ELEMENT ">\n", NULL);

	  g_string_append (retval, buffer);

	  g_free (buffer);

	  g_free (group_name);

        }

      /* close groups container */

      g_string_append (retval,

		       "        "

		       "</" BOOKMARK_NAMESPACE_NAME

		       ":" BOOKMARK_GROUPS_ELEMENT ">\n");

    }

  if (metadata->applications)

    {

      GList *l;

      /* open applications container */

      g_string_append (retval,

		       "        "

		       "<" BOOKMARK_NAMESPACE_NAME

		       ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");

      for (l = g_list_last (metadata->applications); l != NULL; l = l->prev)

        {

          BookmarkAppInfo *app_info = (BookmarkAppInfo *) l->data;

          gchar *app_data;

	  g_warn_if_fail (app_info != NULL);

          app_data = bookmark_app_info_dump (app_info);

	  if (app_data)

            {

              retval = g_string_append (retval, app_data);

	      g_free (app_data);

	    }

        }

      /* close applications container */

      g_string_append (retval,

		       "        "

		       "</" BOOKMARK_NAMESPACE_NAME

		       ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n");

    }

  /* icon */

  if (metadata->icon_href)

    {

      if (!metadata->icon_mime)

        metadata->icon_mime = g_strdup ("application/octet-stream");

      buffer = g_strconcat ("       "

			    "<" BOOKMARK_NAMESPACE_NAME

			    ":" BOOKMARK_ICON_ELEMENT

			    " " BOOKMARK_HREF_ATTRIBUTE "=\"", metadata->icon_href,

			    "\" " BOOKMARK_TYPE_ATTRIBUTE "=\"", metadata->icon_mime, "\"/>\n", NULL);

      g_string_append (retval, buffer);

      g_free (buffer);

    }

  /* private hint */

  if (metadata->is_private)

    g_string_append (retval,

		     "        "

		     "<" BOOKMARK_NAMESPACE_NAME

		     ":" BOOKMARK_PRIVATE_ELEMENT "/>\n");

  /* close metadata container */

  g_string_append (retval,

		   "      "

		   "</" XBEL_METADATA_ELEMENT ">\n");

  return g_string_free (retval, FALSE);

}

/******************************************************

 * BookmarkItem                                       *

 *                                                    *

 * Storage for a single bookmark item inside the list *

 ******************************************************/

static BookmarkItem *

bookmark_item_new (const gchar *uri)

{

  BookmarkItem *item;

  g_warn_if_fail (uri != NULL);

  item = g_slice_new (BookmarkItem);

  item->uri = g_strdup (uri);

  item->title = NULL;

  item->description = NULL;

  item->added = (time_t) -1;

  item->modified = (time_t) -1;

  item->visited = (time_t) -1;

  item->metadata = NULL;

  return item;

}

static void

bookmark_item_free (BookmarkItem *item)

{

  if (!item)

    return;

  g_free (item->uri);

  g_free (item->title);

  g_free (item->description);

  if (item->metadata)

    bookmark_metadata_free (item->metadata);

  g_slice_free (BookmarkItem, item);

}

static gchar *

bookmark_item_dump (BookmarkItem *item)

{

  GString *retval;

  gchar *added, *visited, *modified;

  gchar *escaped_uri;

  gchar *buffer;

  /* at this point, we must have at least a registered application; if we don't

   * we don't screw up the bookmark file, and just skip this item

   */

  if (!item->metadata || !item->metadata->applications)

    {

      g_warning ("Item for URI '%s' has no registered applications: skipping.\n", item->uri);

      return NULL;

    }