1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * ev-metadata-manager.c
4 * This file is part of ev
6 * Copyright (C) 2003 Paolo Maggi
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330,
21 * Boston, MA 02111-1307, USA.
25 * Modified by the ev Team, 2003. See the AUTHORS file for a
26 * list of people on the ev Team.
27 * See the ChangeLog files for a list of changes.
37 #include <libxml/xmlreader.h>
39 #include "ev-metadata-manager.h"
40 #include "ev-file-helpers.h"
42 #define METADATA_FILE "ev-metadata.xml"
46 typedef struct _EvMetadataManager EvMetadataManager;
48 typedef struct _Item Item;
52 time_t atime; /* time of last access */
57 struct _EvMetadataManager
59 gboolean values_loaded; /* It is true if the file
62 gboolean modified; /* It is true if the file
70 static gboolean ev_metadata_manager_save (gpointer data);
73 static EvMetadataManager *ev_metadata_manager = NULL;
76 item_free (gpointer data)
80 g_return_if_fail (data != NULL);
84 if (item->values != NULL)
85 g_hash_table_destroy (item->values);
90 void ev_metadata_arm_timeout(void)
92 if (ev_metadata_manager->timeout_id)
94 ev_metadata_manager->timeout_id =
95 g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
97 (GSourceFunc)ev_metadata_manager_save,
102 ev_metadata_manager_init (void)
104 ev_metadata_manager = g_new0 (EvMetadataManager, 1);
106 ev_metadata_manager->values_loaded = FALSE;
107 ev_metadata_manager->modified = FALSE;
109 ev_metadata_manager->items =
110 g_hash_table_new_full (g_str_hash,
117 /* This function must be called before exiting ev */
119 ev_metadata_manager_shutdown (void)
121 if (ev_metadata_manager == NULL)
124 if (ev_metadata_manager->timeout_id)
125 g_source_remove (ev_metadata_manager->timeout_id);
127 ev_metadata_manager_save (NULL);
129 if (ev_metadata_manager->items != NULL)
130 g_hash_table_destroy (ev_metadata_manager->items);
132 g_free (ev_metadata_manager);
133 ev_metadata_manager = NULL;
137 value_free (gpointer data)
139 GValue *value = (GValue *)data;
141 g_value_unset (value);
146 parse_value (xmlChar *value, xmlChar *type)
151 ret_type = g_type_from_name ((char *)type);
152 ret = g_new0 (GValue, 1);
153 g_value_init (ret, ret_type);
157 g_value_set_string (ret, (char *)value);
160 g_value_set_int (ret, g_ascii_strtoull ((char *)value, NULL, 0));
163 g_value_set_double (ret, g_ascii_strtod ((char *)value, NULL));
166 g_value_set_boolean (ret, g_ascii_strtoull ((char *)value, NULL, 0));
174 parseItem (xmlDocPtr doc, xmlNodePtr cur)
181 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
184 uri = xmlGetProp (cur, (const xmlChar *)"uri");
188 atime = xmlGetProp (cur, (const xmlChar *)"atime");
195 item = g_new0 (Item, 1);
197 item->atime = g_ascii_strtoull((char*)atime, NULL, 0);
199 item->values = g_hash_table_new_full (g_str_hash,
204 cur = cur->xmlChildrenNode;
208 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
215 key = xmlGetProp (cur, (const xmlChar *)"key");
216 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
217 type = xmlGetProp (cur, (const xmlChar *)"type");
218 value = parse_value (xml_value, type);
220 if ((key != NULL) && (value != NULL))
221 g_hash_table_insert (item->values,
229 if (xml_value != NULL)
236 g_hash_table_insert (ev_metadata_manager->items,
251 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
252 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
254 ev_metadata_manager->values_loaded = TRUE;
256 xmlKeepBlanksDefault (0);
258 /* FIXME: file locking - Paolo */
259 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
260 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
266 doc = xmlParseFile (file_name);
274 cur = xmlDocGetRootElement (doc);
277 g_message ("The metadata file “%s” is empty", METADATA_FILE);
283 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
285 g_message ("File “%s” is of the wrong type", METADATA_FILE);
291 cur = xmlDocGetRootElement (doc);
292 cur = cur->xmlChildrenNode;
296 parseItem (doc, cur);
306 #define LAST_URI "last-used-value"
309 ev_metadata_manager_get_last (const gchar *key,
316 g_assert (ev_metadata_manager->values_loaded);
321 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
327 item->atime = time (NULL);
329 if (item->values == NULL)
332 ret = (GValue *)g_hash_table_lookup (item->values, key);
335 g_value_init (value, G_VALUE_TYPE (ret));
336 g_value_copy (ret, value);
344 ev_metadata_manager_set_last (const gchar *key,
349 g_assert (ev_metadata_manager->values_loaded);
351 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
356 item = g_new0 (Item, 1);
358 g_hash_table_insert (ev_metadata_manager->items,
363 if (item->values == NULL)
364 item->values = g_hash_table_new_full (g_str_hash,
371 new = g_new0 (GValue, 1);
372 g_value_init (new, G_VALUE_TYPE (value));
373 g_value_copy (value, new);
375 g_hash_table_insert (item->values,
379 g_hash_table_remove (item->values,
383 item->atime = time (NULL);
384 ev_metadata_manager->modified = TRUE;
385 ev_metadata_arm_timeout();
390 * ev_metadata_manager_set:
391 * @uri: Uri to set data for, if @NULL, we return default value
392 * @key: Key to set uri
393 * @value: GValue struct filled up with value
394 * @ignore_last: if @TRUE, default value is ignored
396 * Retrieve value for uri in metadata database
398 * Returns: @TRUE if value was taken.
401 ev_metadata_manager_get (const gchar *uri,
404 gboolean ignore_last)
409 g_return_val_if_fail (key != NULL, FALSE);
411 if (ev_metadata_manager == NULL)
414 if (!ev_metadata_manager->values_loaded)
418 res = load_values ();
421 return ev_metadata_manager_get_last (key, value, ignore_last);
425 return ev_metadata_manager_get_last (key, value, ignore_last);
427 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
431 return ev_metadata_manager_get_last (key, value, ignore_last);
433 item->atime = time (NULL);
435 if (item->values == NULL)
436 return ev_metadata_manager_get_last (key, value, ignore_last);
438 ret = (GValue *)g_hash_table_lookup (item->values, key);
441 g_value_init (value, G_VALUE_TYPE (ret));
442 g_value_copy (ret, value);
446 return ev_metadata_manager_get_last (key, value, ignore_last);
450 * ev_metadata_manager_set:
451 * @uri: Uri to set data for, if @NULL, we set default value
452 * @key: Key to set uri
453 * @value: GValue struct containing value
455 * Set value for key in metadata database
458 ev_metadata_manager_set (const gchar *uri,
464 g_return_if_fail (key != NULL);
466 if (ev_metadata_manager == NULL)
469 if (!ev_metadata_manager->values_loaded)
473 res = load_values ();
481 ev_metadata_manager_set_last (key, value);
485 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
490 item = g_new0 (Item, 1);
492 g_hash_table_insert (ev_metadata_manager->items,
497 if (item->values == NULL)
498 item->values = g_hash_table_new_full (g_str_hash,
505 new = g_new0 (GValue, 1);
506 g_value_init (new, G_VALUE_TYPE (value));
507 g_value_copy (value, new);
509 g_hash_table_insert (item->values,
512 ev_metadata_manager_set_last (key, value);
514 g_hash_table_remove (item->values,
518 item->atime = time (NULL);
520 ev_metadata_manager->modified = TRUE;
521 ev_metadata_arm_timeout();
525 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
530 g_return_if_fail (key != NULL);
535 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
537 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
538 xmlSetProp (xml_node,
539 (const xmlChar *)"type",
540 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
542 switch (G_VALUE_TYPE (value)) {
544 string_value = g_strdup (g_value_get_string (value));
547 string_value = g_strdup_printf ("%d", g_value_get_int (value));
551 gchar buf[G_ASCII_DTOSTR_BUF_SIZE];
552 g_ascii_dtostr (buf, G_ASCII_DTOSTR_BUF_SIZE, g_value_get_double (value));
553 string_value = g_strdup_printf ("%s", buf);
557 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
561 g_assert_not_reached ();
564 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
566 g_free (string_value);
570 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
573 const Item *item = (const Item *)data;
576 g_return_if_fail (key != NULL);
581 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
583 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
585 atime = g_strdup_printf ("%ld", item->atime);
586 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
589 g_hash_table_foreach (item->values,
590 (GHFunc)save_values, xml_node);
594 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
596 const Item *item = (const Item *)value;
598 if (*key_to_remove == NULL)
600 *key_to_remove = key;
604 const Item *item_to_remove =
605 g_hash_table_lookup (ev_metadata_manager->items,
608 g_return_if_fail (item_to_remove != NULL);
610 if (item->atime < item_to_remove->atime)
612 *key_to_remove = key;
620 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
622 gpointer key_to_remove = NULL;
624 g_hash_table_foreach (ev_metadata_manager->items,
628 g_return_if_fail (key_to_remove != NULL);
630 g_hash_table_remove (ev_metadata_manager->items,
636 ev_metadata_manager_save (gpointer data)
642 ev_metadata_manager->timeout_id = 0;
644 if (!ev_metadata_manager->modified)
649 xmlIndentTreeOutput = TRUE;
651 doc = xmlNewDoc ((const xmlChar *)"1.0");
655 /* Create metadata root */
656 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
657 xmlDocSetRootElement (doc, root);
659 g_hash_table_foreach (ev_metadata_manager->items,
660 (GHFunc)save_item, root);
662 /* FIXME: lock file - Paolo */
663 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
664 xmlSaveFormatFile (file_name, doc, 1);
669 ev_metadata_manager->modified = FALSE;
675 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
679 g_value_init (&val, G_TYPE_INT);
680 g_value_set_int (&val, value);
682 ev_metadata_manager_set (uri, key, &val);
684 g_value_unset (&val);
688 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
692 g_value_init (&val, G_TYPE_DOUBLE);
693 g_value_set_double (&val, value);
695 ev_metadata_manager_set (uri, key, &val);
697 g_value_unset (&val);
701 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
705 g_value_init (&val, G_TYPE_STRING);
706 g_value_set_string (&val, value);
708 ev_metadata_manager_set (uri, key, &val);
710 g_value_unset (&val);
714 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
718 g_value_init (&val, G_TYPE_BOOLEAN);
719 g_value_set_boolean (&val, value);
721 ev_metadata_manager_set (uri, key, &val);
723 g_value_unset (&val);