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
67 static gboolean ev_metadata_manager_save (gpointer data);
70 static EvMetadataManager *ev_metadata_manager = NULL;
74 * @data: a pointer to a #Item data
76 * It does free the values on the #GHashTable where data points.
79 item_free (gpointer data)
81 Item *item = (Item *) data;
83 if (item->values != NULL)
84 g_hash_table_destroy (item->values);
86 g_slice_free (Item, item);
90 * ev_metadata_arm_timeout
92 * Setup a timeout for saving the metadata to disk.
95 ev_metadata_arm_timeout(void)
97 if (ev_metadata_manager->timeout_id)
100 ev_metadata_manager->timeout_id =
101 g_timeout_add_seconds_full (G_PRIORITY_DEFAULT_IDLE,
103 (GSourceFunc)ev_metadata_manager_save,
109 * ev_metadata_manager_init:
111 * Creates an EvMetadataManager with default values.
113 * values_loaded -> %FALSE.
114 * timeout_id -> the id of the event source.
115 * items -> a new full empty #GHashTable.
118 ev_metadata_manager_init (void)
120 ev_metadata_manager = g_slice_new0 (EvMetadataManager);
122 ev_metadata_manager->values_loaded = FALSE;
124 ev_metadata_manager->items =
125 g_hash_table_new_full (g_str_hash,
131 /* This function must be called before exiting ev */
133 ev_metadata_manager_shutdown (void)
135 if (ev_metadata_manager == NULL)
138 if (ev_metadata_manager->timeout_id) {
139 g_source_remove (ev_metadata_manager->timeout_id);
140 ev_metadata_manager->timeout_id = 0;
141 ev_metadata_manager_save (NULL);
144 if (ev_metadata_manager->items != NULL)
145 g_hash_table_destroy (ev_metadata_manager->items);
147 g_slice_free (EvMetadataManager, ev_metadata_manager);
148 ev_metadata_manager = NULL;
152 value_free (gpointer data)
154 GValue *value = (GValue *)data;
156 g_value_unset (value);
157 g_slice_free (GValue, value);
161 parse_value (xmlChar *value, xmlChar *type)
166 ret_type = g_type_from_name ((char *)type);
167 ret = g_slice_new0 (GValue);
168 g_value_init (ret, ret_type);
172 g_value_set_string (ret, (char *)value);
175 g_value_set_int (ret, g_ascii_strtoull ((char *)value, NULL, 0));
178 g_value_set_double (ret, g_ascii_strtod ((char *)value, NULL));
181 g_value_set_boolean (ret, g_ascii_strtoull ((char *)value, NULL, 0));
189 parseItem (xmlDocPtr doc, xmlNodePtr cur)
196 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
199 uri = xmlGetProp (cur, (const xmlChar *)"uri");
203 atime = xmlGetProp (cur, (const xmlChar *)"atime");
210 item = g_slice_new0 (Item);
212 item->atime = g_ascii_strtoull((char*)atime, NULL, 0);
214 item->values = g_hash_table_new_full (g_str_hash,
219 cur = cur->xmlChildrenNode;
223 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
230 key = xmlGetProp (cur, (const xmlChar *)"key");
231 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
232 type = xmlGetProp (cur, (const xmlChar *)"type");
233 value = parse_value (xml_value, type);
235 if ((key != NULL) && (value != NULL))
236 g_hash_table_insert (item->values,
244 if (xml_value != NULL)
251 g_hash_table_insert (ev_metadata_manager->items,
266 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
267 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
269 ev_metadata_manager->values_loaded = TRUE;
271 xmlKeepBlanksDefault (0);
273 /* FIXME: file locking - Paolo */
274 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
275 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
281 doc = xmlParseFile (file_name);
289 cur = xmlDocGetRootElement (doc);
292 g_message ("The metadata file “%s” is empty", METADATA_FILE);
298 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
300 g_message ("File “%s” is of the wrong type", METADATA_FILE);
306 cur = xmlDocGetRootElement (doc);
307 cur = cur->xmlChildrenNode;
311 parseItem (doc, cur);
321 #define LAST_URI "last-used-value"
324 ev_metadata_manager_get_last (const gchar *key,
331 g_assert (ev_metadata_manager->values_loaded);
336 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
342 item->atime = time (NULL);
344 if (item->values == NULL)
347 ret = (GValue *)g_hash_table_lookup (item->values, key);
350 g_value_init (value, G_VALUE_TYPE (ret));
351 g_value_copy (ret, value);
359 ev_metadata_manager_set_last (const gchar *key,
364 g_assert (ev_metadata_manager->values_loaded);
366 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
371 item = g_slice_new0 (Item);
373 g_hash_table_insert (ev_metadata_manager->items,
378 if (item->values == NULL)
379 item->values = g_hash_table_new_full (g_str_hash,
386 new = g_slice_new0 (GValue);
387 g_value_init (new, G_VALUE_TYPE (value));
388 g_value_copy (value, new);
390 g_hash_table_insert (item->values,
394 g_hash_table_remove (item->values,
398 item->atime = time (NULL);
399 ev_metadata_arm_timeout ();
404 * ev_metadata_manager_get:
405 * @uri: Uri to set data for, if @NULL, we return default value
406 * @key: Key to set uri
407 * @value: GValue struct filled up with value
408 * @ignore_last: if @TRUE, default value is ignored
410 * Retrieve value for uri in metadata database
412 * Returns: @TRUE if value was taken.
415 ev_metadata_manager_get (const gchar *uri,
418 gboolean ignore_last)
423 g_return_val_if_fail (key != NULL, FALSE);
425 if (ev_metadata_manager == NULL)
428 if (!ev_metadata_manager->values_loaded)
432 res = load_values ();
435 return ev_metadata_manager_get_last (key, value, ignore_last);
439 return ev_metadata_manager_get_last (key, value, ignore_last);
441 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
445 return ev_metadata_manager_get_last (key, value, ignore_last);
447 item->atime = time (NULL);
449 if (item->values == NULL)
450 return ev_metadata_manager_get_last (key, value, ignore_last);
452 ret = (GValue *)g_hash_table_lookup (item->values, key);
455 g_value_init (value, G_VALUE_TYPE (ret));
456 g_value_copy (ret, value);
460 return ev_metadata_manager_get_last (key, value, ignore_last);
464 * ev_metadata_manager_set:
465 * @uri: Uri to set data for, if @NULL, we set default value
466 * @key: Key to set uri
467 * @value: GValue struct containing value
469 * Set value for key in metadata database
472 ev_metadata_manager_set (const gchar *uri,
478 g_return_if_fail (key != NULL);
480 if (ev_metadata_manager == NULL)
483 if (!ev_metadata_manager->values_loaded)
487 res = load_values ();
495 ev_metadata_manager_set_last (key, value);
499 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
504 item = g_slice_new0 (Item);
506 g_hash_table_insert (ev_metadata_manager->items,
511 if (item->values == NULL)
512 item->values = g_hash_table_new_full (g_str_hash,
519 new = g_slice_new0 (GValue);
520 g_value_init (new, G_VALUE_TYPE (value));
521 g_value_copy (value, new);
523 g_hash_table_insert (item->values,
526 ev_metadata_manager_set_last (key, value);
528 g_hash_table_remove (item->values,
532 item->atime = time (NULL);
534 ev_metadata_arm_timeout ();
538 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
543 g_return_if_fail (key != NULL);
548 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
550 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
551 xmlSetProp (xml_node,
552 (const xmlChar *)"type",
553 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
555 switch (G_VALUE_TYPE (value)) {
557 string_value = g_value_dup_string (value);
560 string_value = g_strdup_printf ("%d", g_value_get_int (value));
564 gchar buf[G_ASCII_DTOSTR_BUF_SIZE];
565 g_ascii_dtostr (buf, G_ASCII_DTOSTR_BUF_SIZE, g_value_get_double (value));
566 string_value = g_strdup (buf);
570 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
574 g_assert_not_reached ();
577 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
579 g_free (string_value);
583 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
586 const Item *item = (const Item *)data;
589 g_return_if_fail (key != NULL);
594 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
596 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
598 atime = g_strdup_printf ("%ld", item->atime);
599 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
602 g_hash_table_foreach (item->values,
603 (GHFunc)save_values, xml_node);
607 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
609 const Item *item = (const Item *)value;
611 if (*key_to_remove == NULL)
613 *key_to_remove = key;
617 const Item *item_to_remove =
618 g_hash_table_lookup (ev_metadata_manager->items,
621 g_return_if_fail (item_to_remove != NULL);
623 if (item->atime < item_to_remove->atime)
625 *key_to_remove = key;
633 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
635 gpointer key_to_remove = NULL;
637 g_hash_table_foreach (ev_metadata_manager->items,
641 g_return_if_fail (key_to_remove != NULL);
643 g_hash_table_remove (ev_metadata_manager->items,
649 ev_metadata_manager_save (gpointer data)
655 ev_metadata_manager->timeout_id = 0;
659 xmlIndentTreeOutput = TRUE;
661 doc = xmlNewDoc ((const xmlChar *)"1.0");
665 /* Create metadata root */
666 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
667 xmlDocSetRootElement (doc, root);
669 g_hash_table_foreach (ev_metadata_manager->items,
670 (GHFunc)save_item, root);
672 /* FIXME: lock file - Paolo */
673 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
674 xmlSaveFormatFile (file_name, doc, 1);
683 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
687 g_value_init (&val, G_TYPE_INT);
688 g_value_set_int (&val, value);
690 ev_metadata_manager_set (uri, key, &val);
692 g_value_unset (&val);
696 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
700 g_value_init (&val, G_TYPE_DOUBLE);
701 g_value_set_double (&val, value);
703 ev_metadata_manager_set (uri, key, &val);
705 g_value_unset (&val);
709 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
713 g_value_init (&val, G_TYPE_STRING);
714 g_value_set_string (&val, value);
716 ev_metadata_manager_set (uri, key, &val);
718 g_value_unset (&val);
722 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
726 g_value_init (&val, G_TYPE_BOOLEAN);
727 g_value_set_boolean (&val, value);
729 ev_metadata_manager_set (uri, key, &val);
731 g_value_unset (&val);