1
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
4
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
6
* This program is free software; you can redistribute it and/or
7
* modify it under the terms of version 2 of the GNU Lesser General Public
8
* License as published by the Free Software Foundation.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
* General Public License for more details.
15
* You should have received a copy of the GNU Lesser General Public
16
* License along with this program; if not, write to the
17
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18
* Boston, MA 02110-1301, USA.
20
* Author: Ettore Perazzoli <ettore@ximian.com>
29
#include "e-source-group.h"
31
#define XC (const xmlChar *)
32
#define GC (const gchar *)
34
/* Private members. */
36
struct _ESourceGroupPrivate {
43
gboolean ignore_source_changed;
46
GHashTable *properties;
57
static guint signals[LAST_SIGNAL] = { 0 };
62
source_changed_callback (ESource *source,
65
if (!group->priv->ignore_source_changed)
66
g_signal_emit (group, signals[CHANGED], 0);
69
/* GObject methods. */
71
G_DEFINE_TYPE (ESourceGroup, e_source_group, G_TYPE_OBJECT)
74
impl_dispose (GObject *object)
76
ESourceGroupPrivate *priv = E_SOURCE_GROUP (object)->priv;
78
if (priv->sources != NULL) {
81
for (p = priv->sources; p != NULL; p = p->next) {
82
ESource *source = E_SOURCE (p->data);
84
g_signal_handlers_disconnect_by_func (source,
85
G_CALLBACK (source_changed_callback),
87
g_object_unref (source);
90
g_slist_free (priv->sources);
94
(* G_OBJECT_CLASS (e_source_group_parent_class)->dispose) (object);
98
impl_finalize (GObject *object)
100
ESourceGroupPrivate *priv = E_SOURCE_GROUP (object)->priv;
104
g_free (priv->base_uri);
106
g_hash_table_destroy (priv->properties);
110
(* G_OBJECT_CLASS (e_source_group_parent_class)->finalize) (object);
113
/* Initialization. */
116
e_source_group_class_init (ESourceGroupClass *class)
118
GObjectClass *object_class = G_OBJECT_CLASS (class);
120
object_class->dispose = impl_dispose;
121
object_class->finalize = impl_finalize;
124
g_signal_new ("changed",
125
G_OBJECT_CLASS_TYPE (object_class),
127
G_STRUCT_OFFSET (ESourceGroupClass, changed),
129
g_cclosure_marshal_VOID__VOID,
132
signals[SOURCE_ADDED] =
133
g_signal_new ("source_added",
134
G_OBJECT_CLASS_TYPE (object_class),
136
G_STRUCT_OFFSET (ESourceGroupClass, source_added),
138
g_cclosure_marshal_VOID__OBJECT,
141
signals[SOURCE_REMOVED] =
142
g_signal_new ("source_removed",
143
G_OBJECT_CLASS_TYPE (object_class),
145
G_STRUCT_OFFSET (ESourceGroupClass, source_removed),
147
g_cclosure_marshal_VOID__OBJECT,
153
e_source_group_init (ESourceGroup *source_group)
155
ESourceGroupPrivate *priv;
157
priv = g_new0 (ESourceGroupPrivate, 1);
158
source_group->priv = priv;
160
priv->properties = g_hash_table_new_full (g_str_hash, g_str_equal,
165
import_properties (ESourceGroup *source_group,
166
xmlNodePtr prop_root)
168
ESourceGroupPrivate *priv = source_group->priv;
169
xmlNodePtr prop_node;
171
for (prop_node = prop_root->children; prop_node; prop_node = prop_node->next) {
172
xmlChar *name, *value;
174
if (!prop_node->name || strcmp (GC prop_node->name, "property"))
177
name = xmlGetProp (prop_node, XC "name");
178
value = xmlGetProp (prop_node, XC "value");
181
g_hash_table_insert (priv->properties, g_strdup (GC name), g_strdup (GC value));
198
compare_str_hash (gpointer key, gpointer value, hash_compare_data *cd)
200
gpointer value2 = g_hash_table_lookup (cd->table2, key);
201
if (value2 == NULL || g_str_equal (value, value2) == FALSE)
206
compare_str_hashes (GHashTable *table1, GHashTable *table2)
208
hash_compare_data cd;
210
if (g_hash_table_size (table1) != g_hash_table_size (table2))
215
g_hash_table_foreach (table1, (GHFunc) compare_str_hash, &cd);
220
property_dump_cb (const gchar *key, const gchar *value, xmlNodePtr root)
224
node = xmlNewChild (root, NULL, XC "property", NULL);
225
xmlSetProp (node, XC "name", XC key);
226
xmlSetProp (node, XC "value", XC value);
229
/* Public methods. */
232
e_source_group_new (const gchar *name,
233
const gchar *base_uri)
237
g_return_val_if_fail (name != NULL, NULL);
238
g_return_val_if_fail (base_uri != NULL, NULL);
240
new = g_object_new (e_source_group_get_type (), NULL);
241
new->priv->uid = e_uid_new ();
243
e_source_group_set_name (new, name);
244
e_source_group_set_base_uri (new, base_uri);
250
e_source_group_new_from_xml (const gchar *xml)
255
doc = xmlParseDoc (XC xml);
259
group = e_source_group_new_from_xmldoc (doc);
266
e_source_group_new_from_xmldoc (xmlDocPtr doc)
272
xmlChar *readonly_str;
273
ESourceGroup *new = NULL;
275
g_return_val_if_fail (doc != NULL, NULL);
277
root = doc->children;
278
if (strcmp (GC root->name, "group") != 0)
281
uid = xmlGetProp (root, XC "uid");
282
name = xmlGetProp (root, XC "name");
283
base_uri = xmlGetProp (root, XC "base_uri");
284
readonly_str = xmlGetProp (root, XC "readonly");
286
if (uid == NULL || name == NULL || base_uri == NULL)
289
new = g_object_new (e_source_group_get_type (), NULL);
294
new->priv->uid = g_strdup (GC uid);
296
e_source_group_set_name (new, GC name);
298
/* XXX The "On This Computer" group used to specify an
299
* absolute "file:" URI pointing to its local storage
300
* directory, but that caused all kinds of portability
301
* issues so now we just use "local:" and leave the
302
* absolute file system path implicit. */
303
if (g_str_has_prefix (GC base_uri, "file:"))
304
e_source_group_set_base_uri (new, "local:");
306
e_source_group_set_base_uri (new, GC base_uri);
308
for (p = root->children; p != NULL; p = p->next) {
311
if (p->name && !strcmp (GC p->name, "properties")) {
312
import_properties (new, p);
316
new_source = e_source_new_from_xml_node (p);
318
if (new_source == NULL) {
319
g_object_unref (new);
323
e_source_group_add_source (new, new_source, -1);
324
g_object_unref (new_source);
327
e_source_group_set_readonly (new, readonly_str && !strcmp (GC readonly_str, "yes"));
335
if (base_uri != NULL)
337
if (readonly_str != NULL)
338
xmlFree (readonly_str);
343
e_source_group_update_from_xml (ESourceGroup *group,
345
gboolean *changed_return)
350
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), FALSE);
351
g_return_val_if_fail (xml != NULL, FALSE);
353
xmldoc = xmlParseDoc (XC xml);
355
success = e_source_group_update_from_xmldoc (group, xmldoc, changed_return);
363
e_source_group_update_from_xmldoc (ESourceGroup *group,
365
gboolean *changed_return)
367
GHashTable *new_sources_hash;
368
GSList *new_sources_list = NULL;
369
xmlNodePtr root, nodep;
370
xmlChar *name, *base_uri, *readonly_str;
372
gboolean changed = FALSE;
375
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), FALSE);
376
g_return_val_if_fail (doc != NULL, FALSE);
378
*changed_return = FALSE;
380
root = doc->children;
381
if (strcmp (GC root->name, "group") != 0)
384
name = xmlGetProp (root, XC "name");
388
base_uri = xmlGetProp (root, XC "base_uri");
389
if (base_uri == NULL) {
394
if (strcmp (group->priv->name, GC name) != 0) {
395
g_free (group->priv->name);
396
group->priv->name = g_strdup (GC name);
401
/* XXX The "On This Computer" group used to specify an
402
* absolute "file:" URI pointing to its local storage
403
* directory, but that caused all kinds of portability
404
* issues so now we just use "local:" and leave the
405
* absolute file system path implicit. */
406
if (g_str_has_prefix (GC base_uri, "file:")) {
407
g_free (group->priv->base_uri);
408
group->priv->base_uri = g_strdup ("local:");
410
} else if (strcmp (group->priv->base_uri, GC base_uri) != 0) {
411
g_free (group->priv->base_uri);
412
group->priv->base_uri = g_strdup (GC base_uri);
417
readonly_str = xmlGetProp (root, XC "readonly");
418
readonly = readonly_str && !strcmp (GC readonly_str, "yes");
419
if (readonly != group->priv->readonly) {
420
group->priv->readonly = readonly;
423
xmlFree (readonly_str);
425
if (g_hash_table_size (group->priv->properties) && !root->children) {
426
g_hash_table_destroy (group->priv->properties);
427
group->priv->properties = g_hash_table_new_full (g_str_hash, g_str_equal,
432
new_sources_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
434
for (nodep = root->children; nodep != NULL; nodep = nodep->next) {
435
ESource *existing_source;
441
if (!strcmp (GC nodep->name, "properties")) {
442
GHashTable *temp = group->priv->properties;
443
group->priv->properties = g_hash_table_new_full (g_str_hash, g_str_equal,
445
import_properties (group, nodep);
446
if (!compare_str_hashes (temp, group->priv->properties))
448
g_hash_table_destroy (temp);
452
uid = e_source_uid_from_xml_node (nodep);
456
existing_source = e_source_group_peek_source_by_uid (group, uid);
457
if (g_hash_table_lookup (new_sources_hash, existing_source) != NULL) {
462
if (existing_source == NULL) {
463
ESource *new_source = e_source_new_from_xml_node (nodep);
465
if (new_source != NULL) {
466
e_source_set_group (new_source, group);
467
g_signal_connect (new_source, "changed", G_CALLBACK (source_changed_callback), group);
468
new_sources_list = g_slist_prepend (new_sources_list, new_source);
470
g_hash_table_insert (new_sources_hash, new_source, new_source);
472
g_signal_emit (group, signals[SOURCE_ADDED], 0, new_source);
476
gboolean source_changed;
478
group->priv->ignore_source_changed++;
480
if (e_source_update_from_xml_node (existing_source, nodep, &source_changed)) {
481
new_sources_list = g_slist_prepend (new_sources_list, existing_source);
482
g_object_ref (existing_source);
483
g_hash_table_insert (new_sources_hash, existing_source, existing_source);
489
group->priv->ignore_source_changed--;
495
new_sources_list = g_slist_reverse (new_sources_list);
497
/* Emit "group_removed" and disconnect the "changed" signal for all the
498
groups that we haven't found in the new list. */
499
q = new_sources_list;
500
for (p = group->priv->sources; p != NULL; p = p->next) {
501
ESource *source = E_SOURCE (p->data);
503
if (g_hash_table_lookup (new_sources_hash, source) == NULL) {
506
g_signal_emit (group, signals[SOURCE_REMOVED], 0, source);
507
g_signal_handlers_disconnect_by_func (source, source_changed_callback, group);
510
if (!changed && q != NULL) {
511
if (q->data != p->data)
517
g_hash_table_destroy (new_sources_hash);
519
/* Replace the original group list with the new one. */
520
g_slist_foreach (group->priv->sources, (GFunc) g_object_unref, NULL);
521
g_slist_free (group->priv->sources);
523
group->priv->sources = new_sources_list;
525
/* FIXME if the order changes, the function doesn't notice. */
528
g_signal_emit (group, signals[CHANGED], 0);
529
*changed_return = TRUE;
532
return TRUE; /* Success. */
536
e_source_group_uid_from_xmldoc (xmlDocPtr doc)
538
xmlNodePtr root = doc->children;
542
if (root && root->name) {
543
if (strcmp (GC root->name, "group") != 0)
549
name = xmlGetProp (root, XC "uid");
553
retval = g_strdup (GC name);
559
e_source_group_set_name (ESourceGroup *group,
562
g_return_if_fail (E_IS_SOURCE_GROUP (group));
563
g_return_if_fail (name != NULL);
565
if (group->priv->readonly)
568
if (group->priv->name != NULL &&
569
strcmp (group->priv->name, name) == 0)
572
g_free (group->priv->name);
573
group->priv->name = g_strdup (name);
575
g_signal_emit (group, signals[CHANGED], 0);
578
void e_source_group_set_base_uri (ESourceGroup *group,
579
const gchar *base_uri)
581
g_return_if_fail (E_IS_SOURCE_GROUP (group));
582
g_return_if_fail (base_uri != NULL);
584
if (group->priv->readonly)
587
if (group->priv->base_uri == base_uri)
590
g_free (group->priv->base_uri);
591
group->priv->base_uri = g_strdup (base_uri);
593
g_signal_emit (group, signals[CHANGED], 0);
596
void e_source_group_set_readonly (ESourceGroup *group,
601
g_return_if_fail (E_IS_SOURCE_GROUP (group));
603
if (group->priv->readonly)
606
if (group->priv->readonly == readonly)
609
group->priv->readonly = readonly;
610
for (i = group->priv->sources; i != NULL; i = i->next)
611
e_source_set_readonly (E_SOURCE (i->data), readonly);
613
g_signal_emit (group, signals[CHANGED], 0);
617
e_source_group_peek_uid (ESourceGroup *group)
619
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), NULL);
621
return group->priv->uid;
625
e_source_group_peek_name (ESourceGroup *group)
627
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), NULL);
629
return group->priv->name;
633
e_source_group_peek_base_uri (ESourceGroup *group)
635
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), NULL);
637
return group->priv->base_uri;
641
e_source_group_get_readonly (ESourceGroup *group)
643
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), FALSE);
645
return group->priv->readonly;
649
e_source_group_peek_sources (ESourceGroup *group)
651
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), NULL);
653
return group->priv->sources;
657
e_source_group_peek_source_by_uid (ESourceGroup *group,
662
for (p = group->priv->sources; p != NULL; p = p->next) {
663
if (strcmp (e_source_peek_uid (E_SOURCE (p->data)), uid) == 0)
664
return E_SOURCE (p->data);
671
e_source_group_peek_source_by_name (ESourceGroup *group,
676
for (p = group->priv->sources; p != NULL; p = p->next) {
677
if (strcmp (e_source_peek_name (E_SOURCE (p->data)), name) == 0)
678
return E_SOURCE (p->data);
685
e_source_group_add_source (ESourceGroup *group,
689
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), FALSE);
691
if (group->priv->readonly)
694
if (e_source_group_peek_source_by_uid (group, e_source_peek_uid (source)) != NULL)
697
e_source_set_group (source, group);
698
e_source_set_readonly (source, group->priv->readonly);
699
g_object_ref (source);
701
g_signal_connect (source, "changed", G_CALLBACK (source_changed_callback), group);
703
group->priv->sources = g_slist_insert (group->priv->sources, source, position);
704
g_signal_emit (group, signals[SOURCE_ADDED], 0, source);
705
g_signal_emit (group, signals[CHANGED], 0);
711
e_source_group_remove_source (ESourceGroup *group,
716
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), FALSE);
717
g_return_val_if_fail (E_IS_SOURCE (source), FALSE);
719
if (group->priv->readonly)
722
for (p = group->priv->sources; p != NULL; p = p->next) {
723
if (E_SOURCE (p->data) == source) {
724
group->priv->sources = g_slist_remove_link (group->priv->sources, p);
725
g_signal_handlers_disconnect_by_func (source,
726
G_CALLBACK (source_changed_callback),
728
g_signal_emit (group, signals[SOURCE_REMOVED], 0, source);
729
g_signal_emit (group, signals[CHANGED], 0);
730
g_object_unref (source);
739
e_source_group_remove_source_by_uid (ESourceGroup *group,
744
g_return_val_if_fail (E_IS_SOURCE_GROUP (group), FALSE);
745
g_return_val_if_fail (uid != NULL, FALSE);
747
if (group->priv->readonly)
750
for (p = group->priv->sources; p != NULL; p = p->next) {
751
ESource *source = E_SOURCE (p->data);
753
if (strcmp (e_source_peek_uid (source), uid) == 0) {
754
group->priv->sources = g_slist_remove_link (group->priv->sources, p);
755
g_signal_handlers_disconnect_by_func (source,
756
G_CALLBACK (source_changed_callback),
758
g_signal_emit (group, signals[SOURCE_REMOVED], 0, source);
759
g_signal_emit (group, signals[CHANGED], 0);
760
g_object_unref (source);
769
e_source_group_to_xml (ESourceGroup *group)
774
gchar *returned_buffer;
775
gint xml_buffer_size;
778
doc = xmlNewDoc (XC "1.0");
780
root = xmlNewDocNode (doc, NULL, XC "group", NULL);
781
xmlSetProp (root, XC "uid", XC e_source_group_peek_uid (group));
782
xmlSetProp (root, XC "name", XC e_source_group_peek_name (group));
783
xmlSetProp (root, XC "base_uri", XC e_source_group_peek_base_uri (group));
784
xmlSetProp (root, XC "readonly", XC (group->priv->readonly ? "yes" : "no"));
786
if (g_hash_table_size (group->priv->properties) != 0) {
787
xmlNodePtr properties_node;
789
properties_node = xmlNewChild (root, NULL, XC "properties", NULL);
790
g_hash_table_foreach (group->priv->properties, (GHFunc) property_dump_cb, properties_node);
793
xmlDocSetRootElement (doc, root);
795
for (p = group->priv->sources; p != NULL; p = p->next)
796
e_source_dump_to_xml_node (E_SOURCE (p->data), root);
798
xmlDocDumpMemory (doc, &xml_buffer, &xml_buffer_size);
801
returned_buffer = g_malloc (xml_buffer_size + 1);
802
memcpy (returned_buffer, xml_buffer, xml_buffer_size);
803
returned_buffer[xml_buffer_size] = '\0';
804
xmlFree (xml_buffer);
806
return returned_buffer;
810
find_esource_from_uid (gconstpointer a, gconstpointer b)
812
return g_ascii_strcasecmp (e_source_peek_uid ((ESource *)(a)), (gchar *)(b));
816
compare_source_lists (GSList *a, GSList *b)
818
gboolean retval = TRUE;
821
if (g_slist_length(a) != g_slist_length(b))
824
for (l = a; l != NULL && retval; l = l->next) {
825
GSList *elem = g_slist_find_custom (b, e_source_peek_uid ((ESource *)(l->data)), (GCompareFunc) find_esource_from_uid);
827
if (!elem || !e_source_equal ((ESource *)(l->data), (ESource *)(elem->data)))
835
* e_source_group_equal:
836
* @a: An ESourceGroup
837
* @b: Another ESourceGroup
839
* Compares if @a is equivalent to @b.
841
* Returns: %TRUE if @a is equivalent to @b,
847
e_source_group_equal (ESourceGroup *a, ESourceGroup *b)
849
g_return_val_if_fail (E_IS_SOURCE_GROUP (a), FALSE);
850
g_return_val_if_fail (E_IS_SOURCE_GROUP (b), FALSE);
852
/* Compare group stuff */
855
&& g_ascii_strcasecmp (a->priv->uid, b->priv->uid))
860
&& g_ascii_strcasecmp (a->priv->name, b->priv->name))
863
if (a->priv->base_uri
865
&& g_ascii_strcasecmp (a->priv->base_uri, b->priv->base_uri))
868
if (a->priv->readonly != b->priv->readonly)
871
if (!compare_str_hashes (a->priv->properties, b->priv->properties))
874
/* Compare ESources in the groups */
875
if (!compare_source_lists (a->priv->sources, b->priv->sources))
882
* e_source_group_xmlstr_equal:
883
* @a: XML representation of an ESourceGroup
884
* @b: XML representation of another ESourceGroup
886
* Compares if @a is equivalent to @b.
888
* Returns: %TRUE if @a is equivalent to @b,
894
e_source_group_xmlstr_equal (const gchar *a, const gchar *b)
896
ESourceGroup *grpa, *grpb;
899
grpa = e_source_group_new_from_xml (a);
900
grpb = e_source_group_new_from_xml (b);
902
retval = e_source_group_equal (grpa, grpb);
904
g_object_unref (grpa);
905
g_object_unref (grpb);
911
* e_source_group_get_property:
916
e_source_group_get_property (ESourceGroup *source_group,
917
const gchar *property)
919
ESourceGroupPrivate *priv;
921
g_return_val_if_fail (E_IS_SOURCE_GROUP (source_group), NULL);
922
priv = source_group->priv;
924
return g_strdup (g_hash_table_lookup (priv->properties, property));
928
* e_source_group_set_property:
933
e_source_group_set_property (ESourceGroup *source_group,
934
const gchar *property,
937
ESourceGroupPrivate *priv;
939
g_return_if_fail (E_IS_SOURCE_GROUP (source_group));
940
priv = source_group->priv;
943
g_hash_table_replace (priv->properties, g_strdup (property), g_strdup (value));
945
g_hash_table_remove (priv->properties, property);
947
g_signal_emit (source_group, signals[CHANGED], 0);
951
* e_source_group_foreach_property:
956
e_source_group_foreach_property (ESourceGroup *source_group, GHFunc func, gpointer data)
958
ESourceGroupPrivate *priv;
960
g_return_if_fail (E_IS_SOURCE_GROUP (source_group));
961
priv = source_group->priv;
963
g_hash_table_foreach (priv->properties, func, data);