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 value_free (gpointer data)
133 GValue *value = (GValue *)data;
135 g_value_unset (value);
140 parse_value (xmlChar *value, xmlChar *type)
145 ret_type = g_type_from_name ((char *)type);
146 ret = g_new0 (GValue, 1);
147 g_value_init (ret, ret_type);
151 g_value_set_string (ret, (char *)value);
154 g_value_set_int (ret, g_ascii_strtoull ((char *)value, NULL, 0));
157 g_value_set_double (ret, g_ascii_strtod ((char *)value, NULL));
160 g_value_set_boolean (ret, g_ascii_strtoull ((char *)value, NULL, 0));
168 parseItem (xmlDocPtr doc, xmlNodePtr cur)
175 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
178 uri = xmlGetProp (cur, (const xmlChar *)"uri");
182 atime = xmlGetProp (cur, (const xmlChar *)"atime");
189 item = g_new0 (Item, 1);
191 item->atime = g_ascii_strtoull((char*)atime, NULL, 0);
193 item->values = g_hash_table_new_full (g_str_hash,
198 cur = cur->xmlChildrenNode;
202 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
209 key = xmlGetProp (cur, (const xmlChar *)"key");
210 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
211 type = xmlGetProp (cur, (const xmlChar *)"type");
212 value = parse_value (xml_value, type);
214 if ((key != NULL) && (value != NULL))
215 g_hash_table_insert (item->values,
223 if (xml_value != NULL)
230 g_hash_table_insert (ev_metadata_manager->items,
245 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
246 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
248 ev_metadata_manager->values_loaded = TRUE;
250 xmlKeepBlanksDefault (0);
252 /* FIXME: file locking - Paolo */
253 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
254 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
260 doc = xmlParseFile (file_name);
268 cur = xmlDocGetRootElement (doc);
271 g_message ("The metadata file '%s' is empty", METADATA_FILE);
277 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
279 g_message ("File '%s' is of the wrong type", METADATA_FILE);
285 cur = xmlDocGetRootElement (doc);
286 cur = cur->xmlChildrenNode;
290 parseItem (doc, cur);
300 #define LAST_URI "last-used-value"
303 ev_metadata_manager_get_last (const gchar *key,
310 g_assert (ev_metadata_manager->values_loaded);
315 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
321 item->atime = time (NULL);
323 if (item->values == NULL)
326 ret = (GValue *)g_hash_table_lookup (item->values, key);
329 g_value_init (value, G_VALUE_TYPE (ret));
330 g_value_copy (ret, value);
338 ev_metadata_manager_set_last (const gchar *key,
343 g_assert (ev_metadata_manager->values_loaded);
345 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
350 item = g_new0 (Item, 1);
352 g_hash_table_insert (ev_metadata_manager->items,
357 if (item->values == NULL)
358 item->values = g_hash_table_new_full (g_str_hash,
365 new = g_new0 (GValue, 1);
366 g_value_init (new, G_VALUE_TYPE (value));
367 g_value_copy (value, new);
369 g_hash_table_insert (item->values,
373 g_hash_table_remove (item->values,
377 item->atime = time (NULL);
378 ev_metadata_manager->modified = TRUE;
383 * ev_metadata_manager_set:
384 * @uri: Uri to set data for, if @NULL, we return default value
385 * @key: Key to set uri
386 * @value: GValue struct filled up with value
387 * @ignore_last: if @TRUE, default value is ignored
389 * Retrieve value for uri in metadata database
391 * Returns: @TRUE if value was taken.
394 ev_metadata_manager_get (const gchar *uri,
397 gboolean ignore_last)
402 g_return_val_if_fail (key != NULL, FALSE);
404 if (ev_metadata_manager == NULL)
407 if (!ev_metadata_manager->values_loaded)
411 res = load_values ();
414 return ev_metadata_manager_get_last (key, value, ignore_last);
418 return ev_metadata_manager_get_last (key, value, ignore_last);
420 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
424 return ev_metadata_manager_get_last (key, value, ignore_last);
426 item->atime = time (NULL);
428 if (item->values == NULL)
429 return ev_metadata_manager_get_last (key, value, ignore_last);
431 ret = (GValue *)g_hash_table_lookup (item->values, key);
434 g_value_init (value, G_VALUE_TYPE (ret));
435 g_value_copy (ret, value);
439 return ev_metadata_manager_get_last (key, value, ignore_last);
443 * ev_metadata_manager_set:
444 * @uri: Uri to set data for, if @NULL, we set default value
445 * @key: Key to set uri
446 * @value: GValue struct containing value
448 * Set value for key in metadata database
451 ev_metadata_manager_set (const gchar *uri,
457 g_return_if_fail (key != NULL);
459 if (ev_metadata_manager == NULL)
462 if (!ev_metadata_manager->values_loaded)
466 res = load_values ();
474 ev_metadata_manager_set_last (key, value);
478 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
483 item = g_new0 (Item, 1);
485 g_hash_table_insert (ev_metadata_manager->items,
490 if (item->values == NULL)
491 item->values = g_hash_table_new_full (g_str_hash,
498 new = g_new0 (GValue, 1);
499 g_value_init (new, G_VALUE_TYPE (value));
500 g_value_copy (value, new);
502 g_hash_table_insert (item->values,
505 ev_metadata_manager_set_last (key, value);
507 g_hash_table_remove (item->values,
511 item->atime = time (NULL);
513 ev_metadata_manager->modified = TRUE;
517 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
522 g_return_if_fail (key != NULL);
527 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
529 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
530 xmlSetProp (xml_node,
531 (const xmlChar *)"type",
532 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
534 switch (G_VALUE_TYPE (value)) {
536 string_value = g_strdup (g_value_get_string (value));
539 string_value = g_strdup_printf ("%d", g_value_get_int (value));
542 string_value = g_strdup_printf ("%f", g_value_get_double (value));
545 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
549 g_assert_not_reached ();
552 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
554 g_free (string_value);
558 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
561 const Item *item = (const Item *)data;
564 g_return_if_fail (key != NULL);
569 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
571 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
573 atime = g_strdup_printf ("%ld", item->atime);
574 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
577 g_hash_table_foreach (item->values,
578 (GHFunc)save_values, xml_node);
582 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
584 const Item *item = (const Item *)value;
586 if (*key_to_remove == NULL)
588 *key_to_remove = key;
592 const Item *item_to_remove =
593 g_hash_table_lookup (ev_metadata_manager->items,
596 g_return_if_fail (item_to_remove != NULL);
598 if (item->atime < item_to_remove->atime)
600 *key_to_remove = key;
608 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
610 gpointer key_to_remove = NULL;
612 g_hash_table_foreach (ev_metadata_manager->items,
616 g_return_if_fail (key_to_remove != NULL);
618 g_hash_table_remove (ev_metadata_manager->items,
624 ev_metadata_manager_save (gpointer data)
630 if (!ev_metadata_manager->modified)
635 xmlIndentTreeOutput = TRUE;
637 doc = xmlNewDoc ((const xmlChar *)"1.0");
641 /* Create metadata root */
642 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
643 xmlDocSetRootElement (doc, root);
645 g_hash_table_foreach (ev_metadata_manager->items,
646 (GHFunc)save_item, root);
648 /* FIXME: lock file - Paolo */
649 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
650 xmlSaveFormatFile (file_name, doc, 1);
655 ev_metadata_manager->modified = FALSE;
661 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
665 g_value_init (&val, G_TYPE_INT);
666 g_value_set_int (&val, value);
668 ev_metadata_manager_set (uri, key, &val);
670 g_value_unset (&val);
674 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
678 g_value_init (&val, G_TYPE_DOUBLE);
679 g_value_set_double (&val, value);
681 ev_metadata_manager_set (uri, key, &val);
683 g_value_unset (&val);
687 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
691 g_value_init (&val, G_TYPE_STRING);
692 g_value_set_string (&val, value);
694 ev_metadata_manager_set (uri, key, &val);
696 g_value_unset (&val);
700 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
704 g_value_init (&val, G_TYPE_BOOLEAN);
705 g_value_set_boolean (&val, value);
707 ev_metadata_manager_set (uri, key, &val);
709 g_value_unset (&val);