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 _GeditMetadataManager GeditMetadataManager;
48 typedef struct _Item Item;
52 time_t atime; /* time of last access */
57 struct _GeditMetadataManager
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 GeditMetadataManager *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 if (ev_metadata_manager != NULL)
96 ev_metadata_manager = g_new0 (GeditMetadataManager, 1);
98 ev_metadata_manager->values_loaded = FALSE;
99 ev_metadata_manager->modified = FALSE;
101 ev_metadata_manager->items =
102 g_hash_table_new_full (g_str_hash,
107 ev_metadata_manager->timeout_id =
108 g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
110 (GSourceFunc)ev_metadata_manager_save,
117 /* This function must be called before exiting ev */
119 ev_metadata_manager_shutdown (void)
121 if (ev_metadata_manager == NULL)
124 g_source_remove (ev_metadata_manager->timeout_id);
126 ev_metadata_manager_save (NULL);
128 if (ev_metadata_manager->items != NULL)
129 g_hash_table_destroy (ev_metadata_manager->items);
131 g_free (ev_metadata_manager);
132 ev_metadata_manager = NULL;
136 parse_value (xmlChar *value, xmlChar *type)
141 ret_type = g_type_from_name ((char *)type);
142 ret = g_new0 (GValue, 1);
143 g_value_init (ret, ret_type);
147 g_value_set_string (ret, (char *)value);
150 g_value_set_int (ret, atoi ((char *)value));
153 g_value_set_double (ret, atof ((char *)value));
156 g_value_set_boolean (ret, atoi ((char *)value));
164 parseItem (xmlDocPtr doc, xmlNodePtr cur)
171 if (xmlStrcmp (cur->name, (const xmlChar *)"document") != 0)
174 uri = xmlGetProp (cur, (const xmlChar *)"uri");
178 atime = xmlGetProp (cur, (const xmlChar *)"atime");
185 item = g_new0 (Item, 1);
187 item->atime = atol ((char *)atime);
189 item->values = g_hash_table_new_full (g_str_hash,
194 cur = cur->xmlChildrenNode;
198 if (xmlStrcmp (cur->name, (const xmlChar *)"entry") == 0)
205 key = xmlGetProp (cur, (const xmlChar *)"key");
206 xml_value = xmlGetProp (cur, (const xmlChar *)"value");
207 type = xmlGetProp (cur, (const xmlChar *)"type");
208 value = parse_value (xml_value, type);
210 if ((key != NULL) && (value != NULL))
211 g_hash_table_insert (item->values,
217 if (xml_value != NULL)
224 g_hash_table_insert (ev_metadata_manager->items,
239 g_return_val_if_fail (ev_metadata_manager != NULL, FALSE);
240 g_return_val_if_fail (ev_metadata_manager->values_loaded == FALSE, FALSE);
242 ev_metadata_manager->values_loaded = TRUE;
244 xmlKeepBlanksDefault (0);
246 /* FIXME: file locking - Paolo */
247 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
248 if (!g_file_test (file_name, G_FILE_TEST_EXISTS))
254 doc = xmlParseFile (file_name);
262 cur = xmlDocGetRootElement (doc);
265 g_message ("The metadata file '%s' is empty", METADATA_FILE);
271 if (xmlStrcmp (cur->name, (const xmlChar *) "metadata"))
273 g_message ("File '%s' is of the wrong type", METADATA_FILE);
279 cur = xmlDocGetRootElement (doc);
280 cur = cur->xmlChildrenNode;
284 parseItem (doc, cur);
295 ev_metadata_manager_get (const gchar *uri,
302 g_return_val_if_fail (uri != NULL, FALSE);
303 g_return_val_if_fail (key != NULL, FALSE);
305 if (ev_metadata_manager == NULL)
306 ev_metadata_manager_init ();
308 if (!ev_metadata_manager->values_loaded)
312 res = load_values ();
318 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
324 item->atime = time (NULL);
326 if (item->values == NULL)
329 ret = (GValue *)g_hash_table_lookup (item->values, key);
334 g_value_init (value, G_VALUE_TYPE (ret));
335 g_value_copy (ret, value);
342 value_free (gpointer data)
344 GValue *value = (GValue *)data;
346 g_value_unset (value);
351 ev_metadata_manager_set (const gchar *uri,
357 g_return_if_fail (uri != NULL);
358 g_return_if_fail (key != NULL);
360 if (ev_metadata_manager == NULL)
361 ev_metadata_manager_init ();
363 if (!ev_metadata_manager->values_loaded)
367 res = load_values ();
373 item = (Item *)g_hash_table_lookup (ev_metadata_manager->items,
378 item = g_new0 (Item, 1);
380 g_hash_table_insert (ev_metadata_manager->items,
385 if (item->values == NULL)
386 item->values = g_hash_table_new_full (g_str_hash,
393 new = g_new0 (GValue, 1);
394 g_value_init (new, G_VALUE_TYPE (value));
395 g_value_copy (value, new);
397 g_hash_table_insert (item->values,
401 g_hash_table_remove (item->values,
405 item->atime = time (NULL);
407 ev_metadata_manager->modified = TRUE;
411 save_values (const gchar *key, GValue *value, xmlNodePtr parent)
416 g_return_if_fail (key != NULL);
421 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"entry", NULL);
423 xmlSetProp (xml_node, (const xmlChar *)"key", (const xmlChar *)key);
424 xmlSetProp (xml_node,
425 (const xmlChar *)"type",
426 (const xmlChar *)g_type_name (G_VALUE_TYPE (value)));
428 switch (G_VALUE_TYPE (value)) {
430 string_value = g_strdup (g_value_get_string (value));
433 string_value = g_strdup_printf ("%d", g_value_get_int (value));
436 string_value = g_strdup_printf ("%f", g_value_get_double (value));
439 string_value = g_strdup_printf ("%d", g_value_get_boolean (value));
443 g_assert_not_reached ();
446 xmlSetProp (xml_node, (const xmlChar *)"value", (const xmlChar *)string_value);
448 g_free (string_value);
452 save_item (const gchar *key, const gpointer *data, xmlNodePtr parent)
455 const Item *item = (const Item *)data;
458 g_return_if_fail (key != NULL);
463 xml_node = xmlNewChild (parent, NULL, (const xmlChar *)"document", NULL);
465 xmlSetProp (xml_node, (const xmlChar *)"uri", (const xmlChar *)key);
467 /* FIXME: is the cast right? - Paolo */
468 atime = g_strdup_printf ("%d", (int)item->atime);
469 xmlSetProp (xml_node, (const xmlChar *)"atime", (const xmlChar *)atime);
473 g_hash_table_foreach (item->values,
474 (GHFunc)save_values, xml_node);
478 get_oldest (const gchar *key, const gpointer value, const gchar ** key_to_remove)
480 const Item *item = (const Item *)value;
482 if (*key_to_remove == NULL)
484 *key_to_remove = key;
488 const Item *item_to_remove =
489 g_hash_table_lookup (ev_metadata_manager->items,
492 g_return_if_fail (item_to_remove != NULL);
494 if (item->atime < item_to_remove->atime)
496 *key_to_remove = key;
504 while (g_hash_table_size (ev_metadata_manager->items) > MAX_ITEMS)
506 gpointer key_to_remove = NULL;
508 g_hash_table_foreach (ev_metadata_manager->items,
512 g_return_if_fail (key_to_remove != NULL);
514 g_hash_table_remove (ev_metadata_manager->items,
520 ev_metadata_manager_save (gpointer data)
526 if (!ev_metadata_manager->modified)
531 xmlIndentTreeOutput = TRUE;
533 doc = xmlNewDoc ((const xmlChar *)"1.0");
537 /* Create metadata root */
538 root = xmlNewDocNode (doc, NULL, (const xmlChar *)"metadata", NULL);
539 xmlDocSetRootElement (doc, root);
541 g_hash_table_foreach (ev_metadata_manager->items,
542 (GHFunc)save_item, root);
544 /* FIXME: lock file - Paolo */
545 file_name = g_build_filename (ev_dot_dir (), METADATA_FILE, NULL);
546 xmlSaveFormatFile (file_name, doc, 1);
551 ev_metadata_manager->modified = FALSE;
557 ev_metadata_manager_set_int (const gchar *uri, const gchar *key, int value)
561 g_value_init (&val, G_TYPE_INT);
562 g_value_set_int (&val, value);
564 ev_metadata_manager_set (uri, key, &val);
566 g_value_unset (&val);
570 ev_metadata_manager_set_double (const gchar *uri, const gchar *key, double value)
574 g_value_init (&val, G_TYPE_DOUBLE);
575 g_value_set_double (&val, value);
577 ev_metadata_manager_set (uri, key, &val);
579 g_value_unset (&val);
583 ev_metadata_manager_set_string (const gchar *uri, const gchar *key, const gchar *value)
587 g_value_init (&val, G_TYPE_STRING);
588 g_value_set_string (&val, value);
590 ev_metadata_manager_set (uri, key, &val);
592 g_value_unset (&val);
596 ev_metadata_manager_set_boolean (const gchar *uri, const gchar *key, gboolean value)
600 g_value_init (&val, G_TYPE_BOOLEAN);
601 g_value_set_boolean (&val, value);
603 ev_metadata_manager_set (uri, key, &val);
605 g_value_unset (&val);