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)
99 #if GLIB_CHECK_VERSION (2, 13, 5)
100 ev_metadata_manager->timeout_id =
101 g_timeout_add_seconds_full (G_PRIORITY_DEFAULT_IDLE,
103 (GSourceFunc)ev_metadata_manager_save,
107 ev_metadata_manager->timeout_id =
108 g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
110 (GSourceFunc)ev_metadata_manager_save,
117 * ev_metadata_manager_init:
119 * Creates an EvMetadataManager with default values.
121 * values_loaded -> %FALSE.
122 * timeout_id -> the id of the event source.
123 * items -> a new full empty #GHashTable.
126 ev_metadata_manager_init (void)
128 ev_metadata_manager = g_slice_new0 (EvMetadataManager);
130 ev_metadata_manager->values_loaded = FALSE;
132 ev_metadata_manager->items =
133 g_hash_table_new_full (g_str_hash,
139 /* This function must be called before exiting ev */
141 ev_metadata_manager_shutdown (void)
143 if (ev_metadata_manager == NULL)
146 if (ev_metadata_manager->timeout_id) {
147 g_source_remove (ev_metadata_manager->timeout_id);
148 ev_metadata_manager->timeout_id = 0;
149 ev_metadata_manager_save (NULL);
152 if (ev_metadata_manager->items != NULL)
153 g_hash_table_destroy (ev_metadata_manager->items);
155 g_slice_free (EvMetadataManager, ev_metadata_manager);
156 ev_metadata_manager = NULL;
160 value_free (gpointer data)
162 GValue *value = (GValue *)data;
164 g_value_unset (value);
165 g_slice_free (GValue, value);
169 parse_value (xmlChar *value, xmlChar *type)
174 ret_type = g_type_from_name ((char *)type);
175 ret = g_slice_new0 (GValue);
176 g_value_init (ret, ret_type);
180 g_value_set_string (ret, (char *)value);
183 g_value_set_int (ret, g_ascii_strtoull ((char *)value, NULL, 0));
186 g_value_set_double (ret, g_ascii_strtod ((char *)value, NULL));
189 g_value_set_boolean (ret, g_ascii_strtoull ((char *)value, NULL, 0));
197 parseItem (xmlDocPtr doc, xmlNodePtr cur)
204 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
207 uri = xmlGetProp (cur, (const xmlChar *)"uri");
211 atime = xmlGetProp (cur, (const xmlChar *)"atime");
218 item = g_slice_new0 (Item);
220 item->atime = g_ascii_strtoull((char*)atime, NULL, 0);
222 item->values = g_hash_table_new_full (g_str_hash,
227 cur = cur->xmlChildrenNode;
231 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
238 key = xmlGetProp (cur, (const xmlChar *)"key");
239 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
240 type = xmlGetProp (cur, (const xmlChar *)"type");
241 value = parse_value (xml_value, type);
243 if ((key != NULL) && (value != NULL))
244 g_hash_table_insert (item->values,
252 if (xml_value != NULL)
259 g_hash_table_insert (ev_metadata_manager->items,
274 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
275 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
277 ev_metadata_manager->values_loaded = TRUE;
279 xmlKeepBlanksDefault (0);
281 /* FIXME: file locking - Paolo */
282 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
283 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
289 doc = xmlParseFile (file_name);
297 cur = xmlDocGetRootElement (doc);
300 g_message ("The metadata file “%s” is empty", METADATA_FILE);
306 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
308 g_message ("File “%s” is of the wrong type", METADATA_FILE);
314 cur = xmlDocGetRootElement (doc);
315 cur = cur->xmlChildrenNode;
319 parseItem (doc, cur);
329 #define LAST_URI "last-used-value"
332 ev_metadata_manager_get_last (const gchar *key,
339 g_assert (ev_metadata_manager->values_loaded);
344 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
350 item->atime = time (NULL);
352 if (item->values == NULL)
355 ret = (GValue *)g_hash_table_lookup (item->values, key);
358 g_value_init (value, G_VALUE_TYPE (ret));
359 g_value_copy (ret, value);
367 ev_metadata_manager_set_last (const gchar *key,
372 g_assert (ev_metadata_manager->values_loaded);
374 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
379 item = g_slice_new0 (Item);
381 g_hash_table_insert (ev_metadata_manager->items,
386 if (item->values == NULL)
387 item->values = g_hash_table_new_full (g_str_hash,
394 new = g_slice_new0 (GValue);
395 g_value_init (new, G_VALUE_TYPE (value));
396 g_value_copy (value, new);
398 g_hash_table_insert (item->values,
402 g_hash_table_remove (item->values,
406 item->atime = time (NULL);
407 ev_metadata_arm_timeout ();
412 * ev_metadata_manager_get:
413 * @uri: Uri to set data for, if @NULL, we return default value
414 * @key: Key to set uri
415 * @value: GValue struct filled up with value
416 * @ignore_last: if @TRUE, default value is ignored
418 * Retrieve value for uri in metadata database
420 * Returns: @TRUE if value was taken.
423 ev_metadata_manager_get (const gchar *uri,
426 gboolean ignore_last)
431 g_return_val_if_fail (key != NULL, FALSE);
433 if (ev_metadata_manager == NULL)
436 if (!ev_metadata_manager->values_loaded)
440 res = load_values ();
443 return ev_metadata_manager_get_last (key, value, ignore_last);
447 return ev_metadata_manager_get_last (key, value, ignore_last);
449 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
453 return ev_metadata_manager_get_last (key, value, ignore_last);
455 item->atime = time (NULL);
457 if (item->values == NULL)
458 return ev_metadata_manager_get_last (key, value, ignore_last);
460 ret = (GValue *)g_hash_table_lookup (item->values, key);
463 g_value_init (value, G_VALUE_TYPE (ret));
464 g_value_copy (ret, value);
468 return ev_metadata_manager_get_last (key, value, ignore_last);
472 * ev_metadata_manager_set:
473 * @uri: Uri to set data for, if @NULL, we set default value
474 * @key: Key to set uri
475 * @value: GValue struct containing value
477 * Set value for key in metadata database
480 ev_metadata_manager_set (const gchar *uri,
486 g_return_if_fail (key != NULL);
488 if (ev_metadata_manager == NULL)
491 if (!ev_metadata_manager->values_loaded)
495 res = load_values ();
503 ev_metadata_manager_set_last (key, value);
507 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
512 item = g_slice_new0 (Item);
514 g_hash_table_insert (ev_metadata_manager->items,
519 if (item->values == NULL)
520 item->values = g_hash_table_new_full (g_str_hash,
527 new = g_slice_new0 (GValue);
528 g_value_init (new, G_VALUE_TYPE (value));
529 g_value_copy (value, new);
531 g_hash_table_insert (item->values,
534 ev_metadata_manager_set_last (key, value);
536 g_hash_table_remove (item->values,
540 item->atime = time (NULL);
542 ev_metadata_arm_timeout ();
546 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
551 g_return_if_fail (key != NULL);
556 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
558 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
559 xmlSetProp (xml_node,
560 (const xmlChar *)"type",
561 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
563 switch (G_VALUE_TYPE (value)) {
565 string_value = g_value_dup_string (value);
568 string_value = g_strdup_printf ("%d", g_value_get_int (value));
572 gchar buf[G_ASCII_DTOSTR_BUF_SIZE];
573 g_ascii_dtostr (buf, G_ASCII_DTOSTR_BUF_SIZE, g_value_get_double (value));
574 string_value = g_strdup (buf);
578 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
582 g_assert_not_reached ();
585 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
587 g_free (string_value);
591 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
594 const Item *item = (const Item *)data;
597 g_return_if_fail (key != NULL);
602 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
604 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
606 atime = g_strdup_printf ("%ld", item->atime);
607 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
610 g_hash_table_foreach (item->values,
611 (GHFunc)save_values, xml_node);
615 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
617 const Item *item = (const Item *)value;
619 if (*key_to_remove == NULL)
621 *key_to_remove = key;
625 const Item *item_to_remove =
626 g_hash_table_lookup (ev_metadata_manager->items,
629 g_return_if_fail (item_to_remove != NULL);
631 if (item->atime < item_to_remove->atime)
633 *key_to_remove = key;
641 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
643 gpointer key_to_remove = NULL;
645 g_hash_table_foreach (ev_metadata_manager->items,
649 g_return_if_fail (key_to_remove != NULL);
651 g_hash_table_remove (ev_metadata_manager->items,
657 ev_metadata_manager_save (gpointer data)
663 ev_metadata_manager->timeout_id = 0;
667 xmlIndentTreeOutput = TRUE;
669 doc = xmlNewDoc ((const xmlChar *)"1.0");
673 /* Create metadata root */
674 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
675 xmlDocSetRootElement (doc, root);
677 g_hash_table_foreach (ev_metadata_manager->items,
678 (GHFunc)save_item, root);
680 /* FIXME: lock file - Paolo */
681 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
682 xmlSaveFormatFile (file_name, doc, 1);
691 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
695 g_value_init (&val, G_TYPE_INT);
696 g_value_set_int (&val, value);
698 ev_metadata_manager_set (uri, key, &val);
700 g_value_unset (&val);
704 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
708 g_value_init (&val, G_TYPE_DOUBLE);
709 g_value_set_double (&val, value);
711 ev_metadata_manager_set (uri, key, &val);
713 g_value_unset (&val);
717 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
721 g_value_init (&val, G_TYPE_STRING);
722 g_value_set_string (&val, value);
724 ev_metadata_manager_set (uri, key, &val);
726 g_value_unset (&val);
730 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
734 g_value_init (&val, G_TYPE_BOOLEAN);
735 g_value_set_boolean (&val, value);
737 ev_metadata_manager_set (uri, key, &val);
739 g_value_unset (&val);