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;
77 * @data: a pointer to a #Item data
79 * It does free the values on the #GHashTable where data points.
82 item_free (gpointer data)
86 g_return_if_fail (data != NULL);
90 if (item->values != NULL)
91 g_hash_table_destroy (item->values);
97 * ev_metadata_manager_init:
99 * Creates an EvMetadataManager with default values.
101 * values_loaded -> %FALSE.
102 * modified -> %FALSE.
103 * timeout_id -> the id of the event source.
104 * items -> a new full empty #GHashTable.
107 ev_metadata_manager_init (void)
109 ev_metadata_manager = g_new0 (EvMetadataManager, 1);
111 ev_metadata_manager->values_loaded = FALSE;
112 ev_metadata_manager->modified = FALSE;
114 ev_metadata_manager->items =
115 g_hash_table_new_full (g_str_hash,
120 ev_metadata_manager->timeout_id =
121 g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
123 (GSourceFunc)ev_metadata_manager_save,
128 /* This function must be called before exiting ev */
130 ev_metadata_manager_shutdown (void)
132 if (ev_metadata_manager == NULL)
135 g_source_remove (ev_metadata_manager->timeout_id);
137 ev_metadata_manager_save (NULL);
139 if (ev_metadata_manager->items != NULL)
140 g_hash_table_destroy (ev_metadata_manager->items);
142 g_free (ev_metadata_manager);
143 ev_metadata_manager = NULL;
147 value_free (gpointer data)
149 GValue *value = (GValue *)data;
151 g_value_unset (value);
156 parse_value (xmlChar *value, xmlChar *type)
161 ret_type = g_type_from_name ((char *)type);
162 ret = g_new0 (GValue, 1);
163 g_value_init (ret, ret_type);
167 g_value_set_string (ret, (char *)value);
170 g_value_set_int (ret, g_ascii_strtoull ((char *)value, NULL, 0));
173 g_value_set_double (ret, g_ascii_strtod ((char *)value, NULL));
176 g_value_set_boolean (ret, g_ascii_strtoull ((char *)value, NULL, 0));
184 parseItem (xmlDocPtr doc, xmlNodePtr cur)
191 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
194 uri = xmlGetProp (cur, (const xmlChar *)"uri");
198 atime = xmlGetProp (cur, (const xmlChar *)"atime");
205 item = g_new0 (Item, 1);
207 item->atime = g_ascii_strtoull((char*)atime, NULL, 0);
209 item->values = g_hash_table_new_full (g_str_hash,
214 cur = cur->xmlChildrenNode;
218 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
225 key = xmlGetProp (cur, (const xmlChar *)"key");
226 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
227 type = xmlGetProp (cur, (const xmlChar *)"type");
228 value = parse_value (xml_value, type);
230 if ((key != NULL) && (value != NULL))
231 g_hash_table_insert (item->values,
239 if (xml_value != NULL)
246 g_hash_table_insert (ev_metadata_manager->items,
261 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
262 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
264 ev_metadata_manager->values_loaded = TRUE;
266 xmlKeepBlanksDefault (0);
268 /* FIXME: file locking - Paolo */
269 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
270 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
276 doc = xmlParseFile (file_name);
284 cur = xmlDocGetRootElement (doc);
287 g_message ("The metadata file “%s” is empty", METADATA_FILE);
293 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
295 g_message ("File “%s” is of the wrong type", METADATA_FILE);
301 cur = xmlDocGetRootElement (doc);
302 cur = cur->xmlChildrenNode;
306 parseItem (doc, cur);
316 #define LAST_URI "last-used-value"
319 ev_metadata_manager_get_last (const gchar *key,
326 g_assert (ev_metadata_manager->values_loaded);
331 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
337 item->atime = time (NULL);
339 if (item->values == NULL)
342 ret = (GValue *)g_hash_table_lookup (item->values, key);
345 g_value_init (value, G_VALUE_TYPE (ret));
346 g_value_copy (ret, value);
354 ev_metadata_manager_set_last (const gchar *key,
359 g_assert (ev_metadata_manager->values_loaded);
361 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
366 item = g_new0 (Item, 1);
368 g_hash_table_insert (ev_metadata_manager->items,
373 if (item->values == NULL)
374 item->values = g_hash_table_new_full (g_str_hash,
381 new = g_new0 (GValue, 1);
382 g_value_init (new, G_VALUE_TYPE (value));
383 g_value_copy (value, new);
385 g_hash_table_insert (item->values,
389 g_hash_table_remove (item->values,
393 item->atime = time (NULL);
394 ev_metadata_manager->modified = TRUE;
399 * ev_metadata_manager_get:
400 * @uri: Uri to set data for, if @NULL, we return default value
401 * @key: Key to set uri
402 * @value: GValue struct filled up with value
403 * @ignore_last: if @TRUE, default value is ignored
405 * Retrieve value for uri in metadata database
407 * Returns: @TRUE if value was taken.
410 ev_metadata_manager_get (const gchar *uri,
413 gboolean ignore_last)
418 g_return_val_if_fail (key != NULL, FALSE);
420 if (ev_metadata_manager == NULL)
423 if (!ev_metadata_manager->values_loaded)
427 res = load_values ();
430 return ev_metadata_manager_get_last (key, value, ignore_last);
434 return ev_metadata_manager_get_last (key, value, ignore_last);
436 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
440 return ev_metadata_manager_get_last (key, value, ignore_last);
442 item->atime = time (NULL);
444 if (item->values == NULL)
445 return ev_metadata_manager_get_last (key, value, ignore_last);
447 ret = (GValue *)g_hash_table_lookup (item->values, key);
450 g_value_init (value, G_VALUE_TYPE (ret));
451 g_value_copy (ret, value);
455 return ev_metadata_manager_get_last (key, value, ignore_last);
459 * ev_metadata_manager_set:
460 * @uri: Uri to set data for, if @NULL, we set default value
461 * @key: Key to set uri
462 * @value: GValue struct containing value
464 * Set value for key in metadata database
467 ev_metadata_manager_set (const gchar *uri,
473 g_return_if_fail (key != NULL);
475 if (ev_metadata_manager == NULL)
478 if (!ev_metadata_manager->values_loaded)
482 res = load_values ();
490 ev_metadata_manager_set_last (key, value);
494 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
499 item = g_new0 (Item, 1);
501 g_hash_table_insert (ev_metadata_manager->items,
506 if (item->values == NULL)
507 item->values = g_hash_table_new_full (g_str_hash,
514 new = g_new0 (GValue, 1);
515 g_value_init (new, G_VALUE_TYPE (value));
516 g_value_copy (value, new);
518 g_hash_table_insert (item->values,
521 ev_metadata_manager_set_last (key, value);
523 g_hash_table_remove (item->values,
527 item->atime = time (NULL);
529 ev_metadata_manager->modified = TRUE;
533 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
538 g_return_if_fail (key != NULL);
543 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
545 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
546 xmlSetProp (xml_node,
547 (const xmlChar *)"type",
548 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
550 switch (G_VALUE_TYPE (value)) {
552 string_value = g_strdup (g_value_get_string (value));
555 string_value = g_strdup_printf ("%d", g_value_get_int (value));
559 gchar buf[G_ASCII_DTOSTR_BUF_SIZE];
560 g_ascii_dtostr (buf, G_ASCII_DTOSTR_BUF_SIZE, g_value_get_double (value));
561 string_value = g_strdup_printf ("%s", buf);
565 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
569 g_assert_not_reached ();
572 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
574 g_free (string_value);
578 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
581 const Item *item = (const Item *)data;
584 g_return_if_fail (key != NULL);
589 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
591 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
593 atime = g_strdup_printf ("%ld", item->atime);
594 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
597 g_hash_table_foreach (item->values,
598 (GHFunc)save_values, xml_node);
602 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
604 const Item *item = (const Item *)value;
606 if (*key_to_remove == NULL)
608 *key_to_remove = key;
612 const Item *item_to_remove =
613 g_hash_table_lookup (ev_metadata_manager->items,
616 g_return_if_fail (item_to_remove != NULL);
618 if (item->atime < item_to_remove->atime)
620 *key_to_remove = key;
628 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
630 gpointer key_to_remove = NULL;
632 g_hash_table_foreach (ev_metadata_manager->items,
636 g_return_if_fail (key_to_remove != NULL);
638 g_hash_table_remove (ev_metadata_manager->items,
644 ev_metadata_manager_save (gpointer data)
650 if (!ev_metadata_manager->modified)
655 xmlIndentTreeOutput = TRUE;
657 doc = xmlNewDoc ((const xmlChar *)"1.0");
661 /* Create metadata root */
662 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
663 xmlDocSetRootElement (doc, root);
665 g_hash_table_foreach (ev_metadata_manager->items,
666 (GHFunc)save_item, root);
668 /* FIXME: lock file - Paolo */
669 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
670 xmlSaveFormatFile (file_name, doc, 1);
675 ev_metadata_manager->modified = FALSE;
681 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
685 g_value_init (&val, G_TYPE_INT);
686 g_value_set_int (&val, value);
688 ev_metadata_manager_set (uri, key, &val);
690 g_value_unset (&val);
694 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
698 g_value_init (&val, G_TYPE_DOUBLE);
699 g_value_set_double (&val, value);
701 ev_metadata_manager_set (uri, key, &val);
703 g_value_unset (&val);
707 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
711 g_value_init (&val, G_TYPE_STRING);
712 g_value_set_string (&val, value);
714 ev_metadata_manager_set (uri, key, &val);
716 g_value_unset (&val);
720 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
724 g_value_init (&val, G_TYPE_BOOLEAN);
725 g_value_set_boolean (&val, value);
727 ev_metadata_manager_set (uri, key, &val);
729 g_value_unset (&val);