2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2002 Match Grun
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
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
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 * Functions to maintain address cache.
31 #include "addrcache.h"
33 #define ID_TIME_OFFSET 998000000
34 #define ADDRCACHE_MAX_SEARCH_COUNT 1000
36 static int _nextCacheID__ = 0;
39 * Generate next cache ID.
41 static int addrcache_next_cache_id() {
44 if( _nextCacheID__ == 0 ) {
47 retVal = _nextCacheID__;
53 * Create new address cache.
55 AddressCache *addrcache_create() {
59 cache = g_new0( AddressCache, 1 );
60 cache->itemHash = g_hash_table_new( g_str_hash, g_str_equal );
61 cache->cacheID = g_strdup_printf( "%d", addrcache_next_cache_id() );
63 cache->dataRead = FALSE;
64 cache->modified = FALSE;
65 cache->dirtyFlag = FALSE;
67 cache->modifyTime = 0;
69 /* Generate the next ID using system time */
73 cache->nextID = t - ID_TIME_OFFSET;
76 cache->tempList = NULL;
77 cache->rootFolder = addritem_create_item_folder();
78 cache->rootFolder->isRoot = TRUE;
79 ADDRITEM_PARENT(cache->rootFolder) = NULL;
86 ItemFolder *addrcache_get_root_folder( AddressCache *cache ) {
87 g_return_val_if_fail( cache != NULL, NULL );
88 return cache->rootFolder;
90 GList *addrcache_get_list_folder( AddressCache *cache ) {
91 g_return_val_if_fail( cache != NULL, NULL );
92 return cache->rootFolder->listFolder;
94 GList *addrcache_get_list_person( AddressCache *cache ) {
95 g_return_val_if_fail( cache != NULL, NULL );
96 return cache->rootFolder->listPerson;
98 gboolean addrcache_get_dirty( AddressCache *cache ) {
99 g_return_val_if_fail( cache != NULL, FALSE );
100 return cache->dirtyFlag;
102 void addrcache_set_dirty( AddressCache *cache, const gboolean value ) {
103 g_return_if_fail( cache != NULL );
104 cache->dirtyFlag = value;
106 gchar *addrcache_get_name( AddressCache *cache ) {
107 g_return_val_if_fail( cache != NULL, NULL );
110 void addrcache_set_name( AddressCache *cache, const gchar *value ) {
111 g_return_if_fail( cache != NULL );
112 cache->name = mgu_replace_string( cache->name, value );
113 g_strstrip( cache->name );
114 cache->dirtyFlag = TRUE;
120 void addrcache_next_id( AddressCache *cache ) {
121 g_return_if_fail( cache != NULL );
126 * Refresh internal variables. This can be used force a reload.
128 void addrcache_refresh( AddressCache *cache ) {
129 cache->dataRead = FALSE;
130 cache->modified = TRUE;
131 cache->modifyTime = 0;
135 * Free hash table visitor function.
137 static gint addrcache_free_item_vis( gpointer key, gpointer value, gpointer data ) {
138 AddrItemObject *obj = ( AddrItemObject * ) value;
139 if( ADDRITEM_TYPE(obj) == ITEMTYPE_PERSON ) {
140 /* Free person and their email */
141 addritem_free_item_person( ( ItemPerson * ) obj );
143 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
144 addritem_free_item_group( ( ItemGroup * ) obj );
146 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_FOLDER ) {
147 addritem_free_item_folder( ( ItemFolder * ) obj );
155 * Free hash table of address cache items.
157 static void addrcache_free_item_hash( GHashTable *table ) {
158 g_return_if_fail( table != NULL );
159 g_hash_table_freeze( table );
160 g_hash_table_foreach_remove( table, addrcache_free_item_vis, NULL );
161 g_hash_table_thaw( table );
162 g_hash_table_destroy( table );
166 * Free up folders and groups.
168 static void addrcache_free_all_folders( ItemFolder *parent ) {
169 GList *node = parent->listFolder;
171 ItemFolder *folder = node->data;
172 addrcache_free_all_folders( folder );
173 node = g_list_next( node );
175 g_list_free( parent->listPerson );
176 g_list_free( parent->listGroup );
177 g_list_free( parent->listFolder );
178 parent->listPerson = NULL;
179 parent->listGroup = NULL;
180 parent->listFolder = NULL;
184 * Clear the address cache.
186 void addrcache_clear( AddressCache *cache ) {
187 g_return_if_fail( cache != NULL );
189 /* Free up folders and hash table */
190 addrcache_free_all_folders( cache->rootFolder );
191 addrcache_free_item_hash( cache->itemHash );
192 cache->itemHash = NULL;
193 ADDRITEM_PARENT(cache->rootFolder) = NULL;
194 addritem_free_item_folder( cache->rootFolder );
195 cache->rootFolder = NULL;
196 g_list_free( cache->tempList );
197 cache->tempList = NULL;
199 /* Reset to initial state */
200 cache->itemHash = g_hash_table_new( g_str_hash, g_str_equal );
201 cache->rootFolder = addritem_create_item_folder();
202 cache->rootFolder->isRoot = TRUE;
203 ADDRITEM_PARENT(cache->rootFolder) = NULL;
205 addrcache_refresh( cache );
210 * Free address cache.
212 void addrcache_free( AddressCache *cache ) {
213 g_return_if_fail( cache != NULL );
215 cache->dirtyFlag = FALSE;
216 addrcache_free_all_folders( cache->rootFolder );
217 addrcache_free_item_hash( cache->itemHash );
218 cache->itemHash = NULL;
219 ADDRITEM_PARENT(cache->rootFolder) = NULL;
220 addritem_free_item_folder( cache->rootFolder );
221 cache->rootFolder = NULL;
222 g_list_free( cache->tempList );
223 cache->tempList = NULL;
224 g_free( cache->cacheID );
225 cache->cacheID = NULL;
226 g_free( cache->name );
232 * Check whether file has changed by comparing with cache.
233 * return: TRUE if file has changed.
235 gboolean addrcache_check_file( AddressCache *cache, gchar *path ) {
237 struct stat filestat;
240 if( 0 == lstat( path, &filestat ) ) {
241 if( filestat.st_mtime == cache->modifyTime ) retVal = FALSE;
248 * Save file time to cache.
249 * return: TRUE if time marked.
251 gboolean addrcache_mark_file( AddressCache *cache, gchar *path ) {
252 gboolean retVal = FALSE;
253 struct stat filestat;
255 if( 0 == lstat( path, &filestat ) ) {
256 cache->modifyTime = filestat.st_mtime;
264 * Print list of items.
266 void addrcache_print_item_list( GList *list, FILE *stream ) {
269 AddrItemObject *obj = node->data;
270 if( ADDRITEM_TYPE(obj) == ITEMTYPE_PERSON ) {
271 addritem_print_item_person( ( ItemPerson * ) obj, stream );
273 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
274 addritem_print_item_group( ( ItemGroup * ) obj, stream );
276 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_FOLDER ) {
277 addritem_print_item_folder( ( ItemFolder * ) obj, stream );
279 node = g_list_next( node );
281 fprintf( stream, "\t---\n" );
285 * Print item hash table visitor function.
287 static void addrcache_print_item_vis( gpointer key, gpointer value, gpointer data ) {
288 AddrItemObject *obj = ( AddrItemObject * ) value;
289 FILE *stream = ( FILE * ) data;
290 if( ADDRITEM_TYPE(obj) == ITEMTYPE_PERSON ) {
291 addritem_print_item_person( ( ItemPerson * ) obj, stream );
293 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_EMAIL ) {
294 printf( "addrcache: print email\n" );
296 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
297 addritem_print_item_group( ( ItemGroup * ) obj, stream );
299 else if( ADDRITEM_TYPE(obj) == ITEMTYPE_FOLDER ) {
300 addritem_print_item_folder( ( ItemFolder * ) obj, stream );
305 * Dump entire address cache hash table contents.
307 void addrcache_print( AddressCache *cache, FILE *stream ) {
308 g_return_if_fail( cache != NULL );
309 fprintf( stream, "AddressCache:\n" );
310 fprintf( stream, "cache id : %s\n", cache->cacheID );
311 fprintf( stream, "next id : %d\n", cache->nextID );
312 fprintf( stream, "name : %s\n", cache->name );
313 fprintf( stream, "mod time : %ld\n", cache->modifyTime );
314 fprintf( stream, "modified : %s\n", cache->modified ? "yes" : "no" );
315 fprintf( stream, "data read: %s\n", cache->dataRead ? "yes" : "no" );
319 * Dump entire address cache hash table contents.
321 void addrcache_dump_hash( AddressCache *cache, FILE *stream ) {
322 g_return_if_fail( cache != NULL );
323 addrcache_print( cache, stream );
324 g_hash_table_foreach( cache->itemHash, addrcache_print_item_vis, stream );
328 * Allocate ID for person.
330 void addrcache_id_person( AddressCache *cache, ItemPerson *person ) {
331 g_return_if_fail( cache != NULL );
332 g_return_if_fail( person != NULL );
333 if( ADDRITEM_ID(person) ) return;
334 addrcache_next_id( cache );
335 ADDRITEM_ID(person) = g_strdup_printf( "%d", cache->nextID );
339 * Allocate ID for group.
341 void addrcache_id_group( AddressCache *cache, ItemGroup *group ) {
342 g_return_if_fail( cache != NULL );
343 g_return_if_fail( group != NULL );
344 if( ADDRITEM_ID(group) ) return;
345 addrcache_next_id( cache );
346 ADDRITEM_ID(group) = g_strdup_printf( "%d", cache->nextID );
350 * Allocate ID for folder.
352 void addrcache_id_folder( AddressCache *cache, ItemFolder *folder ) {
353 g_return_if_fail( cache != NULL );
354 g_return_if_fail( folder != NULL );
355 if( ADDRITEM_ID(folder) ) return;
356 addrcache_next_id( cache );
357 ADDRITEM_ID(folder) = g_strdup_printf( "%d", cache->nextID );
361 * Allocate ID for email address.
363 void addrcache_id_email( AddressCache *cache, ItemEMail *email ) {
364 g_return_if_fail( cache != NULL );
365 g_return_if_fail( email != NULL );
366 if( ADDRITEM_ID(email) ) return;
367 addrcache_next_id( cache );
368 ADDRITEM_ID(email) = g_strdup_printf( "%d", cache->nextID );
372 * Allocate ID for user attribute.
374 void addrcache_id_attribute( AddressCache *cache, UserAttribute *attrib ) {
375 g_return_if_fail( cache != NULL );
376 g_return_if_fail( attrib != NULL );
377 if( attrib->uid ) return;
378 addrcache_next_id( cache );
379 attrib->uid = g_strdup_printf( "%d", cache->nextID );
383 * Add person to hash table.
384 * return: TRUE if item added.
386 gboolean addrcache_hash_add_person( AddressCache *cache, ItemPerson *person ) {
387 if( g_hash_table_lookup( cache->itemHash, ADDRITEM_ID(person) ) ) {
390 g_hash_table_insert( cache->itemHash, ADDRITEM_ID(person), person );
395 * Add email to hash table.
396 * return: TRUE if item added.
398 gboolean addrcache_hash_add_email( AddressCache *cache, ItemEMail *email ) {
399 if( g_hash_table_lookup( cache->itemHash, ADDRITEM_ID(email) ) ) {
402 g_hash_table_insert( cache->itemHash, ADDRITEM_ID(email), email );
407 * Add group to hash table.
408 * return: TRUE if item added.
410 gboolean addrcache_hash_add_group( AddressCache *cache, ItemGroup *group ) {
411 g_return_val_if_fail( cache != NULL, FALSE );
412 g_return_val_if_fail( group != NULL, FALSE );
414 if( g_hash_table_lookup( cache->itemHash, ADDRITEM_ID(group) ) ) {
417 g_hash_table_insert( cache->itemHash, ADDRITEM_ID(group), group );
422 * Add folder to hash table.
423 * return: TRUE if item added.
425 gboolean addrcache_hash_add_folder( AddressCache *cache, ItemFolder *folder ) {
426 g_return_val_if_fail( cache != NULL, FALSE );
427 g_return_val_if_fail( folder != NULL, FALSE );
429 if( g_hash_table_lookup( cache->itemHash, ADDRITEM_ID(folder) ) ) {
432 g_hash_table_insert( cache->itemHash, ADDRITEM_ID(folder), folder );
437 * Add person to specified folder in cache.
439 gboolean addrcache_folder_add_person( AddressCache *cache, ItemFolder *folder, ItemPerson *item ) {
440 gboolean retVal = FALSE;
442 g_return_val_if_fail( cache != NULL, FALSE );
443 g_return_val_if_fail( folder != NULL, FALSE );
444 g_return_val_if_fail( item != NULL, FALSE );
446 retVal = addrcache_hash_add_person( cache, item );
448 addritem_folder_add_person( folder, item );
449 cache->dirtyFlag = TRUE;
455 * Add folder to specified folder in cache.
457 gboolean addrcache_folder_add_folder( AddressCache *cache, ItemFolder *folder, ItemFolder *item ) {
458 gboolean retVal = FALSE;
460 g_return_val_if_fail( cache != NULL, FALSE );
461 g_return_val_if_fail( folder != NULL, FALSE );
462 g_return_val_if_fail( item != NULL, FALSE );
464 retVal = addrcache_hash_add_folder( cache, item );
466 addritem_folder_add_folder( folder, item );
467 cache->dirtyFlag = TRUE;
473 * Add folder to specified folder in cache.
475 gboolean addrcache_folder_add_group( AddressCache *cache, ItemFolder *folder, ItemGroup *item ) {
476 gboolean retVal = FALSE;
478 g_return_val_if_fail( cache != NULL, FALSE );
479 g_return_val_if_fail( folder != NULL, FALSE );
480 g_return_val_if_fail( item != NULL, FALSE );
482 retVal = addrcache_hash_add_group( cache, item );
484 addritem_folder_add_group( folder, item );
485 cache->dirtyFlag = TRUE;
491 * Add person to address cache.
492 * return: TRUE if item added.
494 gboolean addrcache_add_person( AddressCache *cache, ItemPerson *person ) {
495 gboolean retVal = FALSE;
497 g_return_val_if_fail( cache != NULL, FALSE );
498 g_return_val_if_fail( person != NULL, FALSE );
500 retVal = addrcache_hash_add_person( cache, person );
502 addritem_folder_add_person( cache->rootFolder, person );
503 cache->dirtyFlag = TRUE;
509 * Add EMail address to person.
510 * return: TRUE if item added.
512 gboolean addrcache_person_add_email( AddressCache *cache, ItemPerson *person, ItemEMail *email ) {
513 gboolean retVal = FALSE;
515 g_return_val_if_fail( cache != NULL, FALSE );
516 g_return_val_if_fail( person != NULL, FALSE );
517 g_return_val_if_fail( email != NULL, FALSE );
519 retVal = addrcache_hash_add_email( cache, email );
521 addritem_person_add_email( person, email );
522 cache->dirtyFlag = TRUE;
528 * Add group to address cache.
529 * return: TRUE if item added.
531 gboolean addrcache_add_group( AddressCache *cache, ItemGroup *group ) {
532 gboolean retVal = FALSE;
534 g_return_val_if_fail( cache != NULL, FALSE );
535 g_return_val_if_fail( group != NULL, FALSE );
537 retVal = addrcache_hash_add_group( cache, group );
539 addritem_folder_add_group( cache->rootFolder, group );
540 cache->dirtyFlag = TRUE;
546 * Add EMail address to person.
547 * return: TRUE if item added.
549 gboolean addrcache_group_add_email( AddressCache *cache, ItemGroup *group, ItemEMail *email ) {
550 g_return_val_if_fail( cache != NULL, FALSE );
551 g_return_val_if_fail( group != NULL, FALSE );
552 g_return_val_if_fail( email != NULL, FALSE );
554 addritem_group_add_email( group, email );
555 cache->dirtyFlag = TRUE;
560 * Add folder to address cache.
561 * return: TRUE if item added.
563 gboolean addrcache_add_folder( AddressCache *cache, ItemFolder *folder ) {
564 gboolean retVal = FALSE;
566 g_return_val_if_fail( cache != NULL, FALSE );
567 g_return_val_if_fail( folder != NULL, FALSE );
569 retVal = addrcache_hash_add_folder( cache, folder );
571 addritem_folder_add_folder( cache->rootFolder, folder );
572 cache->dirtyFlag = TRUE;
578 * Move person to destination folder.
579 * Enter: cache Cache.
580 * person Person to move.
581 * target Target folder.
583 void addrcache_folder_move_person(
584 AddressCache *cache, ItemPerson *person, ItemFolder *target )
588 g_return_if_fail( cache != NULL );
589 g_return_if_fail( person != NULL );
591 parent = ( ItemFolder * ) ADDRITEM_PARENT(person);
592 if( ! parent ) parent = cache->rootFolder;
593 parent->listPerson = g_list_remove( parent->listPerson, person );
594 target->listPerson = g_list_append( target->listPerson, person );
595 ADDRITEM_PARENT(person) = ADDRITEM_OBJECT(target);
596 cache->dirtyFlag = TRUE;
600 * Move group to destination folder.
601 * Enter: cache Cache.
602 * group Group to move.
603 * target Target folder.
605 void addrcache_folder_move_group(
606 AddressCache *cache, ItemGroup *group, ItemFolder *target )
610 g_return_if_fail( cache != NULL );
611 g_return_if_fail( group != NULL );
613 parent = ( ItemFolder * ) ADDRITEM_PARENT(group);
614 if( ! parent ) parent = cache->rootFolder;
615 parent->listGroup = g_list_remove( parent->listGroup, group );
616 target->listGroup = g_list_append( target->listGroup, group );
617 ADDRITEM_PARENT(group) = ADDRITEM_OBJECT(target);
618 cache->dirtyFlag = TRUE;
622 * Move folder to destination folder.
623 * Enter: cache Cache.
624 * folder Folder to move.
625 * target Target folder.
627 void addrcache_folder_move_folder(
628 AddressCache *cache, ItemFolder *folder, ItemFolder *target )
632 g_return_if_fail( cache != NULL );
633 g_return_if_fail( folder != NULL );
635 parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
636 if( ! parent ) parent = cache->rootFolder;
637 parent->listFolder = g_list_remove( parent->listFolder, folder );
638 target->listFolder = g_list_append( target->listFolder, folder );
639 ADDRITEM_PARENT(folder) = ADDRITEM_OBJECT(target);
640 cache->dirtyFlag = TRUE;
644 * Return pointer to object (either person or group) for specified ID.
645 * param: uid Object ID.
646 * return: Object, or NULL if not found.
648 AddrItemObject *addrcache_get_object( AddressCache *cache, const gchar *uid ) {
649 AddrItemObject *obj = NULL;
652 g_return_val_if_fail( cache != NULL, NULL );
654 if( uid == NULL || *uid == '\0' ) return NULL;
655 obj = ( AddrItemObject * ) g_hash_table_lookup( cache->itemHash, uid );
657 /* Check for matching UID */
658 uidH = ADDRITEM_ID(obj);
660 if( strcmp( uidH, uid ) == 0 ) return obj;
667 * Return pointer for specified object ID.
668 * param: uid Object ID.
669 * return: Person object, or NULL if not found.
671 ItemPerson *addrcache_get_person( AddressCache *cache, const gchar *uid ) {
672 ItemPerson *person = NULL;
673 AddrItemObject *obj = addrcache_get_object( cache, uid );
676 if( ADDRITEM_TYPE(obj) == ITEMTYPE_PERSON ) {
677 person = ( ItemPerson * ) obj;
684 * Return pointer for specified object ID.
685 * param: uid group ID.
686 * return: Group object, or NULL if not found.
688 ItemGroup *addrcache_get_group( AddressCache *cache, const gchar *uid ) {
689 ItemGroup *group = NULL;
690 AddrItemObject *obj = addrcache_get_object( cache, uid );
693 if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
694 group = ( ItemGroup * ) obj;
701 * Find email address in address cache.
702 * param: eid EMail ID.
703 * return: email object for specified object ID and email ID, or NULL if not found.
705 ItemEMail *addrcache_get_email( AddressCache *cache, const gchar *eid ) {
706 ItemEMail *email = NULL;
707 AddrItemObject *obj = addrcache_get_object( cache, eid );
710 if( ADDRITEM_TYPE(obj) == ITEMTYPE_EMAIL ) {
711 email = ( ItemEMail * ) obj;
718 * Remove attribute from person.
719 * param: uid Object ID for person.
721 * return: UserAttribute object, or NULL if not found. Note that object should still be freed.
723 UserAttribute *addrcache_person_remove_attrib_id( AddressCache *cache, const gchar *uid, const gchar *aid ) {
724 UserAttribute *attrib = NULL;
727 if( aid == NULL || *aid == '\0' ) return NULL;
729 person = addrcache_get_person( cache, uid );
731 attrib = addritem_person_remove_attrib_id( person, aid );
732 cache->dirtyFlag = TRUE;
738 * Remove attribute from person.
739 * param: person Person.
740 * attrib Attribute to remove.
741 * return: UserAttribute object. Note that object should still be freed.
743 UserAttribute *addrcache_person_remove_attribute( AddressCache *cache, ItemPerson *person, UserAttribute *attrib ) {
744 UserAttribute *found = NULL;
746 g_return_val_if_fail( cache != NULL, NULL );
748 if( person && attrib ) {
749 found = addritem_person_remove_attribute( person, attrib );
750 cache->dirtyFlag = TRUE;
756 * Remove group from address cache.
757 * param: group Group to remove.
758 * return: Group, or NULL if not found. Note that object should still be freed.
760 ItemGroup *addrcache_remove_group( AddressCache *cache, ItemGroup *group ) {
761 AddrItemObject *obj = NULL;
763 g_return_val_if_fail( cache != NULL, NULL );
766 gchar *uid = ADDRITEM_ID(group);
767 if( uid == NULL || *uid == '\0' ) return NULL;
768 obj = ( AddrItemObject * ) g_hash_table_lookup( cache->itemHash, uid );
770 ItemFolder *parent = ( ItemFolder * ) ADDRITEM_PARENT(group);
771 if( ! parent ) parent = cache->rootFolder;
773 /* Remove group from parent's list and hash table */
774 parent->listGroup = g_list_remove( parent->listGroup, obj );
775 g_hash_table_remove( cache->itemHash, uid );
776 cache->dirtyFlag = TRUE;
784 * Remove specified email from address cache. Note that object is only
785 * removed from cache and not parent objects.
786 * param: email EMail to remove.
787 * return: EMail, or NULL if not found. Note that object should still be freed.
789 ItemEMail *addrcache_remove_email( AddressCache *cache, ItemEMail *email ) {
790 AddrItemObject *obj = NULL;
792 g_return_val_if_fail( cache != NULL, NULL );
795 gchar *eid = ADDRITEM_ID(email);
796 if( eid == NULL || *eid == '\0' ) return NULL;
797 obj = ( AddrItemObject * ) g_hash_table_lookup( cache->itemHash, eid );
799 if( ADDRITEM_TYPE(obj) == ITEMTYPE_EMAIL ) {
800 /* Remove email addresses from hash table. */
801 g_hash_table_remove( cache->itemHash, eid );
802 cache->dirtyFlag = TRUE;
811 * Hash table visitor function to remove email from group.
813 static void addrcache_allgrp_rem_email_vis( gpointer key, gpointer value, gpointer data ) {
814 AddrItemObject *obj = ( AddrItemObject * ) value;
815 ItemEMail *email = ( ItemEMail * ) data;
817 if( ! email ) return;
818 if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
819 ItemGroup *group = ( ItemGroup * ) value;
821 /* Remove each email address that belongs to the person from the list */
822 group->listEMail = g_list_remove( group->listEMail, email );
828 * Remove specified person from address cache.
829 * param: person Person to remove.
830 * return: Person, or NULL if not found. Note that object should still be freed.
832 ItemPerson *addrcache_remove_person( AddressCache *cache, ItemPerson *person ) {
833 AddrItemObject *obj = NULL;
836 g_return_val_if_fail( cache != NULL, NULL );
839 uid = ADDRITEM_ID(person);
840 if( uid == NULL || *uid == '\0' ) return NULL;
841 obj = ( AddrItemObject * ) g_hash_table_lookup( cache->itemHash, uid );
843 if( ADDRITEM_TYPE(obj) == ITEMTYPE_PERSON ) {
847 /* Remove all email addresses for person */
848 /* from groups and from hash table */
849 node = person->listEMail;
855 g_hash_table_foreach( cache->itemHash,
856 addrcache_allgrp_rem_email_vis, email );
857 eid = ADDRITEM_ID( email );
858 g_hash_table_remove( cache->itemHash, eid );
859 node = g_list_next( node );
862 /* Remove person from owning folder */
863 parent = ( ItemFolder * ) ADDRITEM_PARENT(person);
864 if( ! parent ) parent = cache->rootFolder;
865 parent->listPerson = g_list_remove( parent->listPerson, person );
866 g_hash_table_remove( cache->itemHash, uid );
867 cache->dirtyFlag = TRUE;
876 * Remove email address in address cache for specified person.
877 * param: person Person.
878 * email EMail to remove.
879 * return: EMail object, or NULL if not found. Note that object should still be freed.
881 ItemEMail *addrcache_person_remove_email( AddressCache *cache, ItemPerson *person, ItemEMail *email ) {
882 ItemEMail *found = NULL;
884 g_return_val_if_fail( cache != NULL, NULL );
886 if( person && email ) {
887 found = addritem_person_remove_email( person, email );
889 /* Remove email from all groups. */
890 g_hash_table_foreach( cache->itemHash, addrcache_allgrp_rem_email_vis, email );
892 /* Remove email from person's address list */
893 if( person->listEMail ) {
894 person->listEMail = g_list_remove( person->listEMail, email );
896 /* Unlink reference to person. */
897 ADDRITEM_PARENT(email) = NULL;
898 cache->dirtyFlag = TRUE;
905 * Move email address in address cache to new person. If member of group, address
907 * param: cache Cache.
908 * email EMail to remove.
909 * target Target person.
910 * return: EMail object, or NULL if not found. Note that object should still be freed.
912 void addrcache_person_move_email(
913 AddressCache *cache, ItemEMail *email, ItemPerson *target )
917 g_return_if_fail( cache != NULL );
919 if( email == NULL ) return;
920 if( target == NULL ) return;
922 person = ( ItemPerson * ) ADDRITEM_PARENT(email);
925 found = addritem_person_remove_email( person, email );
927 if( person->listEMail ) {
928 person->listEMail = g_list_remove( person->listEMail, found );
929 addritem_person_add_email( target, found );
930 cache->dirtyFlag = TRUE;
937 * Return link list of address items for root level folder. Note that the list contains
938 * references to items and should be g_free() when done. Do *NOT* attempt to use the
939 * addrcache_free_xxx() functions... this will destroy the address cache data!
940 * Return: List of items, or NULL if none.
942 GList *addrcache_folder_get_address_list( AddressCache *cache, ItemFolder *folder ) {
945 ItemFolder *f = folder;
947 g_return_val_if_fail( cache != NULL, NULL );
949 if( ! f ) f = cache->rootFolder;
950 node = f->listPerson;
952 list = g_list_append( list, node->data );
953 node = g_list_next( node );
957 list = g_list_append( list, node->data );
958 node = g_list_next( node );
964 * Return link list of persons for specified folder. Note that the list contains
965 * references to items and should be g_free() when done. Do *NOT* attempt to use the
966 * addrcache_free_xxx() functions... this will destroy the address cache data!
967 * Return: List of items, or NULL if none.
969 GList *addrcache_folder_get_person_list( AddressCache *cache, ItemFolder *folder ) {
970 ItemFolder *f = folder;
972 g_return_val_if_fail( cache != NULL, NULL );
974 if( ! f ) f = cache->rootFolder;
975 return addritem_folder_get_person_list( f );
979 * Return link list of group items for specified folder. Note that the list contains
980 * references to items and should be g_free() when done. Do *NOT* attempt to use the
981 * addrcache_free_xxx() functions... this will destroy the address cache data!
982 * Return: List of items, or NULL if none.
984 GList *addrcache_folder_get_group_list( AddressCache *cache, ItemFolder *folder ) {
985 ItemFolder *f = folder;
987 g_return_val_if_fail( cache != NULL, NULL );
989 if( ! f ) f = cache->rootFolder;
990 return addritem_folder_get_group_list( f );
994 * Return link list of folder items for specified folder. Note that the list contains
995 * references to items and should be g_free() when done. Do *NOT* attempt to used the
996 * addrcache_free_xxx() functions... this will destroy the address cache data!
997 * Return: List of items, or NULL if none.
999 GList *addrcache_folder_get_folder_list( AddressCache *cache, ItemFolder *folder ) {
1002 ItemFolder *f = folder;
1004 g_return_val_if_fail( cache != NULL, NULL );
1006 if( ! f ) f = cache->rootFolder;
1007 node = f->listFolder;
1009 list = g_list_append( list, node->data );
1010 node = g_list_next( node );
1016 * Return link list of address items for root level folder. Note that the list contains
1017 * references to items and should be g_free() when done. Do *NOT* attempt to used the
1018 * addrcache_free_xxx() functions... this will destroy the address cache data!
1019 * Return: List of items, or NULL if none.
1021 GList *addrcache_get_address_list( AddressCache *cache ) {
1022 g_return_val_if_fail( cache != NULL, NULL );
1023 return addrcache_folder_get_address_list( cache, cache->rootFolder );
1027 * Return link list of persons for root level folder. Note that the list contains
1028 * references to items and should be g_free() when done. Do *NOT* attempt to used the
1029 * addrcache_free_xxx() functions... this will destroy the address cache data!
1030 * Return: List of items, or NULL if none.
1032 GList *addrcache_get_person_list( AddressCache *cache ) {
1033 g_return_val_if_fail( cache != NULL, NULL );
1034 return addritem_folder_get_person_list( cache->rootFolder );
1038 * Return link list of group items in root level folder. Note that the list contains
1039 * references to items and should be g_free() when done. Do *NOT* attempt to used the
1040 * addrcache_free_xxx() functions... this will destroy the address cache data!
1041 * Return: List of items, or NULL if none.
1043 GList *addrcache_get_group_list( AddressCache *cache ) {
1044 g_return_val_if_fail( cache != NULL, NULL );
1045 return cache->rootFolder->listGroup;
1049 * Return link list of folder items in root level folder. Note that the list contains
1050 * references to items and should be g_free() when done. Do *NOT* attempt to used the
1051 * addrcache_free_xxx() functions... this will destroy the address cache data!
1052 * Return: List of items, or NULL if none.
1054 GList *addrcache_get_folder_list( AddressCache *cache ) {
1055 g_return_val_if_fail( cache != NULL, NULL );
1056 return cache->rootFolder->listFolder;
1060 * Group visitor function.
1062 static void addrcache_get_grp_person_vis( gpointer key, gpointer value, gpointer data ) {
1063 AddrItemObject *obj = ( AddrItemObject * ) value;
1065 if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
1066 AddressCache *cache = data;
1067 ItemGroup *group = ( ItemGroup * ) obj;
1068 ItemPerson *person = ( ItemPerson * ) cache->tempList->data;
1069 GList *node = group->listEMail;
1071 ItemEMail *email = ( ItemEMail * ) node->data;
1072 if( ADDRITEM_PARENT(email) == ADDRITEM_OBJECT(person) ) {
1073 if( ! g_list_find( cache->tempList, group ) ) {
1074 cache->tempList = g_list_append( cache->tempList, group );
1077 node = g_list_next( node );
1083 * Return linked list of groups which contain a reference to specified person's email
1086 GList *addrcache_get_group_for_person( AddressCache *cache, ItemPerson *person ) {
1089 g_return_val_if_fail( cache != NULL, NULL );
1091 cache->tempList = NULL;
1092 cache->tempList = g_list_append( cache->tempList, person );
1093 g_hash_table_foreach( cache->itemHash, addrcache_get_grp_person_vis, cache );
1094 cache->tempList = g_list_remove( cache->tempList, person );
1095 list = cache->tempList;
1096 cache->tempList = NULL;
1101 * Find root folder for specified folder.
1102 * Enter: folder Folder to search.
1103 * Return: root folder, or NULL if not found.
1105 ItemFolder *addrcache_find_root_folder( ItemFolder *folder ) {
1106 ItemFolder *item = folder;
1110 if( item->isRoot ) break;
1111 if( ++count > ADDRCACHE_MAX_SEARCH_COUNT ) {
1115 item = ( ItemFolder * ) ADDRITEM_PARENT(folder);
1121 * Get all person visitor function.
1123 static void addrcache_get_all_persons_vis( gpointer key, gpointer value, gpointer data ) {
1124 AddrItemObject *obj = ( AddrItemObject * ) value;
1126 if( ADDRITEM_TYPE(obj) == ITEMTYPE_PERSON ) {
1127 AddressCache *cache = data;
1128 cache->tempList = g_list_append( cache->tempList, obj );
1133 * Return link list of all persons in address cache. Note that the list contains
1134 * references to items. Do *NOT* attempt to use the addrcache_free_xxx() functions...
1135 * this will destroy the address cache data!
1136 * Return: List of items, or NULL if none.
1138 GList *addrcache_get_all_persons( AddressCache *cache ) {
1141 g_return_val_if_fail( cache != NULL, NULL );
1143 cache->tempList = NULL;
1144 g_hash_table_foreach( cache->itemHash, addrcache_get_all_persons_vis, cache );
1145 list = cache->tempList;
1146 cache->tempList = NULL;
1151 * Get all groups visitor function.
1153 static void addrcache_get_all_groups_vis( gpointer key, gpointer value, gpointer data ) {
1154 AddrItemObject *obj = ( AddrItemObject * ) value;
1156 if( ADDRITEM_TYPE(obj) == ITEMTYPE_GROUP ) {
1157 AddressCache *cache = data;
1158 cache->tempList = g_list_append( cache->tempList, obj );
1163 * Return link list of all groups in address cache. Note that the list contains
1164 * references to items. Do *NOT* attempt to use the addrcache_free_xxx() functions...
1165 * this will destroy the address cache data!
1166 * Return: List of items, or NULL if none.
1168 GList *addrcache_get_all_groups( AddressCache *cache ) {
1171 g_return_val_if_fail( cache != NULL, NULL );
1173 cache->tempList = NULL;
1174 g_hash_table_foreach( cache->itemHash, addrcache_get_all_groups_vis, cache );
1175 list = cache->tempList;
1176 cache->tempList = NULL;
1181 * Remove folder from cache. Children are re-parented to parent folder.
1182 * param: folder Folder to remove.
1183 * return: Folder, or NULL if not found. Note that object should still be freed.
1185 ItemFolder *addrcache_remove_folder( AddressCache *cache, ItemFolder *folder ) {
1186 AddrItemObject *obj = NULL;
1188 g_return_val_if_fail( cache != NULL, NULL );
1191 gchar *uid = ADDRITEM_ID(folder);
1192 if( uid == NULL || *uid == '\0' ) return NULL;
1193 obj = ( AddrItemObject * ) g_hash_table_lookup( cache->itemHash, uid );
1195 ItemFolder *parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
1197 AddrItemObject *aio;
1198 if( ! parent ) parent = cache->rootFolder;
1200 /* Re-parent children in folder */
1201 node = folder->listFolder;
1203 aio = ( AddrItemObject * ) node->data;
1204 parent->listFolder = g_list_append( parent->listFolder, aio );
1205 aio->parent = ADDRITEM_OBJECT(parent);
1206 node = g_list_next( node );
1208 node = folder->listPerson;
1210 aio = ( AddrItemObject * ) node->data;
1211 parent->listPerson = g_list_append( parent->listPerson, aio );
1212 aio->parent = ADDRITEM_OBJECT(parent);
1213 node = g_list_next( node );
1215 node = folder->listGroup;
1217 aio = ( AddrItemObject * ) node->data;
1218 parent->listGroup = g_list_append( parent->listGroup, aio );
1219 aio->parent = ADDRITEM_OBJECT(parent);
1220 node = g_list_next( node );
1223 /* Remove folder from parent's list and hash table */
1224 parent->listFolder = g_list_remove( parent->listFolder, folder );
1225 ADDRITEM_PARENT(folder) = NULL;
1226 g_hash_table_remove( cache->itemHash, uid );
1227 cache->dirtyFlag = TRUE;
1235 * Remove folder from cache. Children are deleted.
1236 * param: folder Folder to remove.
1237 * return: Folder, or NULL if not found. Note that object should still be freed.
1239 ItemFolder *addrcache_remove_folder_delete( AddressCache *cache, ItemFolder *folder ) {
1240 AddrItemObject *obj = NULL;
1242 g_return_val_if_fail( cache != NULL, NULL );
1245 gchar *uid = ADDRITEM_ID(folder);
1246 if( uid == NULL || *uid == '\0' ) return NULL;
1247 obj = ( AddrItemObject * ) g_hash_table_lookup( cache->itemHash, uid );
1249 ItemFolder *parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
1250 if( ! parent ) parent = cache->rootFolder;
1253 while( folder->listGroup ) {
1254 ItemGroup *item = ( ItemGroup * ) folder->listGroup->data;
1255 item = addrcache_remove_group( cache, item );
1257 addritem_free_item_group( item );
1262 while( folder->listPerson ) {
1263 ItemPerson *item = ( ItemPerson * ) folder->listPerson->data;
1264 item = addrcache_remove_person( cache, item );
1266 addritem_free_item_person( item );
1271 /* Recursive deletion of folder */
1272 while( folder->listFolder ) {
1273 ItemFolder *item = ( ItemFolder * ) folder->listFolder->data;
1274 item = addrcache_remove_folder_delete( cache, item );
1276 addritem_free_item_folder( item );
1281 /* Remove folder from parent's list and hash table */
1282 parent->listFolder = g_list_remove( parent->listFolder, folder );
1283 ADDRITEM_PARENT(folder) = NULL;
1284 g_hash_table_remove( cache->itemHash, uid );
1285 cache->dirtyFlag = TRUE;
1293 * Add person and address data to cache.
1294 * Enter: cache Cache.
1295 * folder Folder where to add person, or NULL for root folder.
1297 * address EMail address.
1299 * Return: Person added. Do not *NOT* to use the addrbook_free_xxx() functions...
1300 * this will destroy the address book data.
1302 ItemPerson *addrcache_add_contact( AddressCache *cache, ItemFolder *folder, const gchar *name,
1303 const gchar *address, const gchar *remarks )
1305 ItemPerson *person = NULL;
1306 ItemEMail *email = NULL;
1307 ItemFolder *f = folder;
1309 g_return_val_if_fail( cache != NULL, NULL );
1311 if( ! f ) f = cache->rootFolder;
1313 /* Create person object */
1314 person = addritem_create_item_person();
1315 addritem_person_set_common_name( person, name );
1316 addrcache_id_person( cache, person );
1317 addrcache_folder_add_person( cache, f, person );
1319 /* Create email object */
1320 email = addritem_create_item_email();
1321 addritem_email_set_address( email, address );
1322 addritem_email_set_remarks( email, remarks );
1323 addrcache_id_email( cache, email );
1324 addritem_person_add_email( person, email );
1325 cache->dirtyFlag = TRUE;