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);
91 ev_metadata_manager_init (void)
93 ev_metadata_manager = g_new0 (EvMetadataManager, 1);
95 ev_metadata_manager->values_loaded = FALSE;
96 ev_metadata_manager->modified = FALSE;
98 ev_metadata_manager->items =
99 g_hash_table_new_full (g_str_hash,
104 ev_metadata_manager->timeout_id =
105 g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
107 (GSourceFunc)ev_metadata_manager_save,
112 /* This function must be called before exiting ev */
114 ev_metadata_manager_shutdown (void)
116 if (ev_metadata_manager == NULL)
119 g_source_remove (ev_metadata_manager->timeout_id);
121 ev_metadata_manager_save (NULL);
123 if (ev_metadata_manager->items != NULL)
124 g_hash_table_destroy (ev_metadata_manager->items);
126 g_free (ev_metadata_manager);
127 ev_metadata_manager = NULL;
131 parse_value (xmlChar *value, xmlChar *type)
136 ret_type = g_type_from_name ((char *)type);
137 ret = g_new0 (GValue, 1);
138 g_value_init (ret, ret_type);
142 g_value_set_string (ret, (char *)value);
145 g_value_set_int (ret, g_ascii_strtoull ((char *)value, NULL, 0));
148 g_value_set_double (ret, g_ascii_strtod ((char *)value, NULL));
151 g_value_set_boolean (ret, g_ascii_strtoull ((char *)value, NULL, 0));
159 parseItem (xmlDocPtr doc, xmlNodePtr cur)
166 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
169 uri = xmlGetProp (cur, (const xmlChar *)"uri");
173 atime = xmlGetProp (cur, (const xmlChar *)"atime");
180 item = g_new0 (Item, 1);
182 item->atime = g_ascii_strtoull((char*)atime, NULL, 0);
184 item->values = g_hash_table_new_full (g_str_hash,
189 cur = cur->xmlChildrenNode;
193 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
200 key = xmlGetProp (cur, (const xmlChar *)"key");
201 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
202 type = xmlGetProp (cur, (const xmlChar *)"type");
203 value = parse_value (xml_value, type);
205 if ((key != NULL) && (value != NULL))
206 g_hash_table_insert (item->values,
212 if (xml_value != NULL)
219 g_hash_table_insert (ev_metadata_manager->items,
234 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
235 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
237 ev_metadata_manager->values_loaded = TRUE;
239 xmlKeepBlanksDefault (0);
241 /* FIXME: file locking - Paolo */
242 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
243 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
249 doc = xmlParseFile (file_name);
257 cur = xmlDocGetRootElement (doc);
260 g_message ("The metadata file '%s' is empty", METADATA_FILE);
266 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
268 g_message ("File '%s' is of the wrong type", METADATA_FILE);
274 cur = xmlDocGetRootElement (doc);
275 cur = cur->xmlChildrenNode;
279 parseItem (doc, cur);
290 value_free (gpointer data)
292 GValue *value = (GValue *)data;
294 g_value_unset (value);
299 #define LAST_URI "last-used-value"
302 ev_metadata_manager_get_last (const gchar *key,
309 g_assert (ev_metadata_manager->values_loaded);
314 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
320 item->atime = time (NULL);
322 if (item->values == NULL)
325 ret = (GValue *)g_hash_table_lookup (item->values, key);
328 g_value_init (value, G_VALUE_TYPE (ret));
329 g_value_copy (ret, value);
337 ev_metadata_manager_set_last (const gchar *key,
342 g_assert (ev_metadata_manager->values_loaded);
344 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
349 item = g_new0 (Item, 1);
351 g_hash_table_insert (ev_metadata_manager->items,
356 if (item->values == NULL)
357 item->values = g_hash_table_new_full (g_str_hash,
364 new = g_new0 (GValue, 1);
365 g_value_init (new, G_VALUE_TYPE (value));
366 g_value_copy (value, new);
368 g_hash_table_insert (item->values,
372 g_hash_table_remove (item->values,
376 item->atime = time (NULL);
377 ev_metadata_manager->modified = TRUE;
382 * ev_metadata_manager_set:
383 * @uri: Uri to set data for, if @NULL, we return default value
384 * @key: Key to set uri
385 * @value: GValue struct filled up with value
386 * @ignore_last: if @TRUE, default value is ignored
388 * Retrieve value for uri in metadata database
390 * Returns: @TRUE if value was taken.
393 ev_metadata_manager_get (const gchar *uri,
396 gboolean ignore_last)
401 g_return_val_if_fail (key != NULL, FALSE);
403 if (ev_metadata_manager == NULL)
406 if (!ev_metadata_manager->values_loaded)
410 res = load_values ();
413 return ev_metadata_manager_get_last (key, value, ignore_last);
417 return ev_metadata_manager_get_last (key, value, ignore_last);
419 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
423 return ev_metadata_manager_get_last (key, value, ignore_last);
425 item->atime = time (NULL);
427 if (item->values == NULL)
428 return ev_metadata_manager_get_last (key, value, ignore_last);
430 ret = (GValue *)g_hash_table_lookup (item->values, key);
433 g_value_init (value, G_VALUE_TYPE (ret));
434 g_value_copy (ret, value);
438 return ev_metadata_manager_get_last (key, value, ignore_last);
442 * ev_metadata_manager_set:
443 * @uri: Uri to set data for, if @NULL, we set default value
444 * @key: Key to set uri
445 * @value: GValue struct containing value
447 * Set value for key in metadata database
450 ev_metadata_manager_set (const gchar *uri,
456 g_return_if_fail (key != NULL);
458 if (ev_metadata_manager == NULL)
461 if (!ev_metadata_manager->values_loaded)
465 res = load_values ();
473 ev_metadata_manager_set_last (key, value);
477 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
482 item = g_new0 (Item, 1);
484 g_hash_table_insert (ev_metadata_manager->items,
489 if (item->values == NULL)
490 item->values = g_hash_table_new_full (g_str_hash,
497 new = g_new0 (GValue, 1);
498 g_value_init (new, G_VALUE_TYPE (value));
499 g_value_copy (value, new);
501 g_hash_table_insert (item->values,
504 ev_metadata_manager_set_last (key, value);
506 g_hash_table_remove (item->values,
510 item->atime = time (NULL);
512 ev_metadata_manager->modified = TRUE;
516 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
521 g_return_if_fail (key != NULL);
526 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
528 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
529 xmlSetProp (xml_node,
530 (const xmlChar *)"type",
531 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
533 switch (G_VALUE_TYPE (value)) {
535 string_value = g_strdup (g_value_get_string (value));
538 string_value = g_strdup_printf ("%d", g_value_get_int (value));
541 string_value = g_strdup_printf ("%f", g_value_get_double (value));
544 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
548 g_assert_not_reached ();
551 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
553 g_free (string_value);
557 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
560 const Item *item = (const Item *)data;
563 g_return_if_fail (key != NULL);
568 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
570 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
572 atime = g_strdup_printf ("%ld", item->atime);
573 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
576 g_hash_table_foreach (item->values,
577 (GHFunc)save_values, xml_node);
581 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
583 const Item *item = (const Item *)value;
585 if (*key_to_remove == NULL)
587 *key_to_remove = key;
591 const Item *item_to_remove =
592 g_hash_table_lookup (ev_metadata_manager->items,
595 g_return_if_fail (item_to_remove != NULL);
597 if (item->atime < item_to_remove->atime)
599 *key_to_remove = key;
607 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
609 gpointer key_to_remove = NULL;
611 g_hash_table_foreach (ev_metadata_manager->items,
615 g_return_if_fail (key_to_remove != NULL);
617 g_hash_table_remove (ev_metadata_manager->items,
623 ev_metadata_manager_save (gpointer data)
629 if (!ev_metadata_manager->modified)
634 xmlIndentTreeOutput = TRUE;
636 doc = xmlNewDoc ((const xmlChar *)"1.0");
640 /* Create metadata root */
641 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
642 xmlDocSetRootElement (doc, root);
644 g_hash_table_foreach (ev_metadata_manager->items,
645 (GHFunc)save_item, root);
647 /* FIXME: lock file - Paolo */
648 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
649 xmlSaveFormatFile (file_name, doc, 1);
654 ev_metadata_manager->modified = FALSE;
660 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
664 g_value_init (&val, G_TYPE_INT);
665 g_value_set_int (&val, value);
667 ev_metadata_manager_set (uri, key, &val);
669 g_value_unset (&val);
673 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
677 g_value_init (&val, G_TYPE_DOUBLE);
678 g_value_set_double (&val, value);
680 ev_metadata_manager_set (uri, key, &val);
682 g_value_unset (&val);
686 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
690 g_value_init (&val, G_TYPE_STRING);
691 g_value_set_string (&val, value);
693 ev_metadata_manager_set (uri, key, &val);
695 g_value_unset (&val);
699 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
703 g_value_init (&val, G_TYPE_BOOLEAN);
704 g_value_set_boolean (&val, value);
706 ev_metadata_manager_set (uri, key, &val);
708 g_value_unset (&val);