2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2003 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 * General functions for accessing address index file.
35 #include "addrcache.h"
37 #include "addrindex.h"
39 #include "addrquery.h"
41 #ifndef DEV_STANDALONE
42 #include "prefs_gtk.h"
53 #include "ldapserver.h"
55 #include "ldapquery.h"
58 #define TAG_ADDRESS_INDEX "addressbook"
60 #define TAG_IF_ADDRESS_BOOK "book_list"
61 #define TAG_IF_VCARD "vcard_list"
62 #define TAG_IF_JPILOT "jpilot_list"
63 #define TAG_IF_LDAP "ldap_list"
65 #define TAG_DS_ADDRESS_BOOK "book"
66 #define TAG_DS_VCARD "vcard"
67 #define TAG_DS_JPILOT "jpilot"
68 #define TAG_DS_LDAP "server"
70 /* XML Attribute names */
71 #define ATTAG_BOOK_NAME "name"
72 #define ATTAG_BOOK_FILE "file"
74 #define ATTAG_VCARD_NAME "name"
75 #define ATTAG_VCARD_FILE "file"
77 #define ATTAG_JPILOT_NAME "name"
78 #define ATTAG_JPILOT_FILE "file"
79 #define ATTAG_JPILOT_CUSTOM_1 "custom-1"
80 #define ATTAG_JPILOT_CUSTOM_2 "custom-2"
81 #define ATTAG_JPILOT_CUSTOM_3 "custom-3"
82 #define ATTAG_JPILOT_CUSTOM_4 "custom-4"
83 #define ATTAG_JPILOT_CUSTOM "custom-"
85 #define ATTAG_LDAP_NAME "name"
86 #define ATTAG_LDAP_HOST "host"
87 #define ATTAG_LDAP_PORT "port"
88 #define ATTAG_LDAP_BASE_DN "base-dn"
89 #define ATTAG_LDAP_BIND_DN "bind-dn"
90 #define ATTAG_LDAP_BIND_PASS "bind-pass"
91 #define ATTAG_LDAP_CRITERIA "criteria"
92 #define ATTAG_LDAP_MAX_ENTRY "max-entry"
93 #define ATTAG_LDAP_TIMEOUT "timeout"
94 #define ATTAG_LDAP_MAX_AGE "max-age"
95 #define ATTAG_LDAP_DYN_SEARCH "dyn-search"
97 #define ELTAG_LDAP_ATTR_SRCH "attribute"
98 #define ATTAG_LDAP_ATTR_NAME "name"
101 #define ATTAG_LDAP_DEFAULT "default"
105 N_("Personal address")
108 #define DISP_NEW_COMMON _("Common address")
109 #define DISP_NEW_PERSONAL _("Personal address")
111 /* Old address book */
112 #define TAG_IF_OLD_COMMON "common_address"
113 #define TAG_IF_OLD_PERSONAL "personal_address"
115 #define DISP_OLD_COMMON _("Common address")
116 #define DISP_OLD_PERSONAL _("Personal address")
119 * Define attribute name-value pair.
121 typedef struct _AddressIfAttr AddressIfAttrib;
122 struct _AddressIfAttr {
128 * Define DOM fragment.
130 typedef struct _AddressIfFrag AddressIfFragment;
131 struct _AddressIfFrag {
138 * Build interface with default values.
140 * \param type Interface type.
141 * \param name Interface name.
142 * \param tagIf XML tag name for interface in address index file.
143 * \param tagDS XML tag name for datasource in address index file.
144 * \return Address interface object.
146 static AddressInterface *addrindex_create_interface(
147 gint type, gchar *name, gchar *tagIf, gchar *tagDS )
149 AddressInterface *iface = g_new0( AddressInterface, 1 );
151 ADDRITEM_TYPE(iface) = ITEMTYPE_INTERFACE;
152 ADDRITEM_ID(iface) = NULL;
153 ADDRITEM_NAME(iface) = g_strdup( name );
154 ADDRITEM_PARENT(iface) = NULL;
155 ADDRITEM_SUBTYPE(iface) = type;
157 iface->name = g_strdup( name );
158 iface->listTag = g_strdup( tagIf );
159 iface->itemTag = g_strdup( tagDS );
160 iface->legacyFlag = FALSE;
161 iface->haveLibrary = TRUE;
162 iface->useInterface = TRUE;
163 iface->readOnly = TRUE;
165 /* Set callbacks to NULL values - override for each interface */
166 iface->getAccessFlag = NULL;
167 iface->getModifyFlag = NULL;
168 iface->getReadFlag = NULL;
169 iface->getStatusCode = NULL;
170 iface->getReadData = NULL;
171 iface->getRootFolder = NULL;
172 iface->getListFolder = NULL;
173 iface->getListPerson = NULL;
174 iface->getAllPersons = NULL;
175 iface->getAllGroups = NULL;
176 iface->getName = NULL;
177 iface->listSource = NULL;
180 iface->externalQuery = FALSE;
181 iface->searchOrder = 0; /* Ignored */
182 iface->startSearch = NULL;
183 iface->stopSearch = NULL;
189 * Build table of of all address book interfaces.
190 * \param addrIndex Address index object.
192 static void addrindex_build_if_list( AddressIndex *addrIndex ) {
193 AddressInterface *iface;
195 /* Create intrinsic XML address book interface */
196 iface = addrindex_create_interface(
197 ADDR_IF_BOOK, "Address Book", TAG_IF_ADDRESS_BOOK,
198 TAG_DS_ADDRESS_BOOK );
199 iface->readOnly = FALSE;
200 iface->getModifyFlag = ( void * ) addrbook_get_modified;
201 iface->getAccessFlag = ( void * ) addrbook_get_accessed;
202 iface->getReadFlag = ( void * ) addrbook_get_read_flag;
203 iface->getStatusCode = ( void * ) addrbook_get_status;
204 iface->getReadData = ( void * ) addrbook_read_data;
205 iface->getRootFolder = ( void * ) addrbook_get_root_folder;
206 iface->getListFolder = ( void * ) addrbook_get_list_folder;
207 iface->getListPerson = ( void * ) addrbook_get_list_person;
208 iface->getAllPersons = ( void * ) addrbook_get_all_persons;
209 iface->getName = ( void * ) addrbook_get_name;
210 iface->setAccessFlag = ( void * ) addrbook_set_accessed;
211 iface->searchOrder = 2;
213 /* Add to list of interfaces in address book */
214 addrIndex->interfaceList =
215 g_list_append( addrIndex->interfaceList, iface );
216 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
218 /* Create vCard interface */
219 iface = addrindex_create_interface(
220 ADDR_IF_VCARD, "vCard", TAG_IF_VCARD, TAG_DS_VCARD );
221 iface->getModifyFlag = ( void * ) vcard_get_modified;
222 iface->getAccessFlag = ( void * ) vcard_get_accessed;
223 iface->getReadFlag = ( void * ) vcard_get_read_flag;
224 iface->getStatusCode = ( void * ) vcard_get_status;
225 iface->getReadData = ( void * ) vcard_read_data;
226 iface->getRootFolder = ( void * ) vcard_get_root_folder;
227 iface->getListFolder = ( void * ) vcard_get_list_folder;
228 iface->getListPerson = ( void * ) vcard_get_list_person;
229 iface->getAllPersons = ( void * ) vcard_get_all_persons;
230 iface->getName = ( void * ) vcard_get_name;
231 iface->setAccessFlag = ( void * ) vcard_set_accessed;
232 iface->searchOrder = 3;
233 addrIndex->interfaceList =
234 g_list_append( addrIndex->interfaceList, iface );
235 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
237 /* Create JPilot interface */
238 iface = addrindex_create_interface(
239 ADDR_IF_JPILOT, "J-Pilot", TAG_IF_JPILOT,
242 iface->haveLibrary = jpilot_test_pilot_lib();
243 iface->useInterface = iface->haveLibrary;
244 iface->getModifyFlag = ( void * ) jpilot_get_modified;
245 iface->getAccessFlag = ( void * ) jpilot_get_accessed;
246 iface->getReadFlag = ( void * ) jpilot_get_read_flag;
247 iface->getStatusCode = ( void * ) jpilot_get_status;
248 iface->getReadData = ( void * ) jpilot_read_data;
249 iface->getRootFolder = ( void * ) jpilot_get_root_folder;
250 iface->getListFolder = ( void * ) jpilot_get_list_folder;
251 iface->getListPerson = ( void * ) jpilot_get_list_person;
252 iface->getAllPersons = ( void * ) jpilot_get_all_persons;
253 iface->getName = ( void * ) jpilot_get_name;
254 iface->setAccessFlag = ( void * ) jpilot_set_accessed;
255 iface->searchOrder = 3;
257 iface->useInterface = FALSE;
258 iface->haveLibrary = FALSE;
260 addrIndex->interfaceList =
261 g_list_append( addrIndex->interfaceList, iface );
262 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
264 /* Create LDAP interface */
265 iface = addrindex_create_interface(
266 ADDR_IF_LDAP, "LDAP", TAG_IF_LDAP, TAG_DS_LDAP );
268 /* iface->haveLibrary = ldapsvr_test_ldap_lib(); */
269 iface->haveLibrary = ldaputil_test_ldap_lib();
270 iface->useInterface = iface->haveLibrary;
271 /* iface->getModifyFlag = ( void * ) ldapsvr_get_modified; */
272 iface->getAccessFlag = ( void * ) ldapsvr_get_accessed;
273 /* iface->getReadFlag = ( void * ) ldapsvr_get_read_flag; */
274 iface->getStatusCode = ( void * ) ldapsvr_get_status;
275 /* iface->getReadData = ( void * ) ldapsvr_read_data; */
276 iface->getRootFolder = ( void * ) ldapsvr_get_root_folder;
277 iface->getListFolder = ( void * ) ldapsvr_get_list_folder;
278 iface->getListPerson = ( void * ) ldapsvr_get_list_person;
279 iface->getName = ( void * ) ldapsvr_get_name;
280 iface->setAccessFlag = ( void * ) ldapsvr_set_accessed;
281 iface->externalQuery = TRUE;
282 iface->searchOrder = 1;
284 iface->useInterface = FALSE;
285 iface->haveLibrary = FALSE;
287 addrIndex->interfaceList =
288 g_list_append( addrIndex->interfaceList, iface );
289 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
291 /* Two old legacy data sources (pre 0.7.0) */
292 iface = addrindex_create_interface(
293 ADDR_IF_COMMON, "Old Address - common",
294 TAG_IF_OLD_COMMON, NULL );
295 iface->legacyFlag = TRUE;
296 addrIndex->interfaceList =
297 g_list_append( addrIndex->interfaceList, iface );
298 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
300 iface = addrindex_create_interface(
301 ADDR_IF_COMMON, "Old Address - personal",
302 TAG_IF_OLD_PERSONAL, NULL );
303 iface->legacyFlag = TRUE;
304 addrIndex->interfaceList =
305 g_list_append( addrIndex->interfaceList, iface );
306 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
312 * \param fragment Fragment to free.
314 static addrindex_free_fragment( AddressIfFragment *fragment ) {
318 node = fragment->children;
320 AddressIfFragment *child = node->data;
321 addrindex_free_fragment( child );
323 node = g_list_next( node );
325 g_list_free( fragment->children );
327 /* Free attributes */
328 node = fragment->attributes;
330 AddressIfAttrib *nv = node->data;
335 node = g_list_next( node );
337 g_list_free( fragment->attributes );
339 g_free( fragment->name );
340 fragment->name = NULL;
341 fragment->attributes = NULL;
342 fragment->children = NULL;
348 * Create a new data source.
349 * \param ifType Interface type to create.
350 * \return Initialized data source.
352 AddressDataSource *addrindex_create_datasource( AddressIfType ifType ) {
353 AddressDataSource *ds = g_new0( AddressDataSource, 1 );
355 ADDRITEM_TYPE(ds) = ITEMTYPE_DATASOURCE;
356 ADDRITEM_ID(ds) = NULL;
357 ADDRITEM_NAME(ds) = NULL;
358 ADDRITEM_PARENT(ds) = NULL;
359 ADDRITEM_SUBTYPE(ds) = 0;
361 ds->rawDataSource = NULL;
362 ds->interface = NULL;
367 * Free up data source.
368 * \param ds Data source to free.
370 void addrindex_free_datasource( AddressDataSource *ds ) {
371 AddressInterface *iface;
374 g_return_if_fail( ds != NULL );
376 iface = ds->interface;
377 if( ds->rawDataSource != NULL ) {
378 if( iface != NULL ) {
379 if( iface->useInterface ) {
380 if( iface->type == ADDR_IF_BOOK ) {
381 AddressBookFile *abf = ds->rawDataSource;
382 addrbook_free_book( abf );
384 else if( iface->type == ADDR_IF_VCARD ) {
385 VCardFile *vcf = ds->rawDataSource;
389 else if( iface->type == ADDR_IF_JPILOT ) {
390 JPilotFile *jpf = ds->rawDataSource;
395 else if( iface->type == ADDR_IF_LDAP ) {
396 LdapServer *server = ds->rawDataSource;
397 cache = server->addressCache;
398 addrcache_use_index( cache, FALSE );
399 ldapsvr_free( server );
406 AddressIfFragment *fragment = ds->rawDataSource;
407 addrindex_free_fragment( fragment );
412 ADDRITEM_TYPE(ds) = ITEMTYPE_NONE;
413 ADDRITEM_ID(ds) = NULL;
414 ADDRITEM_NAME(ds) = NULL;
415 ADDRITEM_PARENT(ds) = NULL;
416 ADDRITEM_SUBTYPE(ds) = 0;
417 ds->type = ADDR_IF_NONE;
418 ds->interface = NULL;
419 ds->rawDataSource = NULL;
425 * Free up all data sources for specified interface.
426 * \param iface Address interface to process.
428 static void addrindex_free_all_datasources( AddressInterface *iface ) {
429 GList *node = iface->listSource;
431 AddressDataSource *ds = node->data;
432 addrindex_free_datasource( ds );
434 node = g_list_next( node );
439 * Free up specified interface.
440 * \param iface Interface to process.
442 static void addrindex_free_interface( AddressInterface *iface ) {
443 /* Free up data sources */
444 addrindex_free_all_datasources( iface );
445 g_list_free( iface->listSource );
447 /* Free internal storage */
448 g_free( ADDRITEM_ID(iface) );
449 g_free( ADDRITEM_NAME(iface) );
450 g_free( iface->name );
451 g_free( iface->listTag );
452 g_free( iface->itemTag );
454 /* Clear all pointers */
455 ADDRITEM_TYPE(iface) = ITEMTYPE_NONE;
456 ADDRITEM_ID(iface) = NULL;
457 ADDRITEM_NAME(iface) = NULL;
458 ADDRITEM_PARENT(iface) = NULL;
459 ADDRITEM_SUBTYPE(iface) = 0;
460 iface->type = ADDR_IF_NONE;
462 iface->listTag = NULL;
463 iface->itemTag = NULL;
464 iface->legacyFlag = FALSE;
465 iface->useInterface = FALSE;
466 iface->haveLibrary = FALSE;
467 iface->listSource = NULL;
470 iface->searchOrder = 0;
471 iface->startSearch = NULL;
472 iface->stopSearch = NULL;
478 * Return cache ID for specified data source.
480 * \param addrIndex Address index.
481 * \param ds Data source.
482 * \return ID or NULL if not found. This should be <code>g_free()</code>
485 gchar *addrindex_get_cache_id( AddressIndex *addrIndex, AddressDataSource *ds ) {
486 gchar *cacheID = NULL;
487 AddrBookBase *adbase;
490 g_return_val_if_fail( addrIndex != NULL, NULL );
491 g_return_val_if_fail( ds != NULL, NULL );
493 adbase = ( AddrBookBase * ) ds->rawDataSource;
495 cache = adbase->addressCache;
497 cacheID = g_strdup( cache->cacheID );
505 * Return reference to data source for specified cacheID.
506 * \param addrIndex Address index.
508 * \return Data source, or NULL if not found.
510 AddressDataSource *addrindex_get_datasource(
511 AddressIndex *addrIndex, const gchar *cacheID )
513 g_return_val_if_fail( addrIndex != NULL, NULL );
514 g_return_val_if_fail( cacheID != NULL, NULL );
515 return ( AddressDataSource * ) g_hash_table_lookup( addrIndex->hashCache, cacheID );
519 * Return reference to address cache for specified cacheID.
520 * \param addrIndex Address index.
522 * \return Address cache, or NULL if not found.
524 AddressCache *addrindex_get_cache( AddressIndex *addrIndex, const gchar *cacheID ) {
525 AddressDataSource *ds;
526 AddrBookBase *adbase;
529 g_return_val_if_fail( addrIndex != NULL, NULL );
530 g_return_val_if_fail( cacheID != NULL, NULL );
533 ds = addrindex_get_datasource( addrIndex, cacheID );
535 adbase = ( AddrBookBase * ) ds->rawDataSource;
536 cache = adbase->addressCache;
542 * Add data source into hash table.
543 * \param addrIndex Address index.
544 * \param ds Data source.
546 static void addrindex_hash_add_cache(
547 AddressIndex *addrIndex, AddressDataSource *ds )
551 cacheID = addrindex_get_cache_id( addrIndex, ds );
553 g_hash_table_insert( addrIndex->hashCache, cacheID, ds );
558 * Free hash table callback function.
560 static gboolean addrindex_free_cache_cb( gpointer key, gpointer value, gpointer data ) {
568 * Free hash table of address cache items.
570 static void addrindex_free_cache_hash( GHashTable *table ) {
571 g_hash_table_freeze( table );
572 g_hash_table_foreach_remove( table, addrindex_free_cache_cb, NULL );
573 g_hash_table_thaw( table );
574 g_hash_table_destroy( table );
578 * Remove data source from internal hashtable.
579 * \param addrIndex Address index.
580 * \param ds Data source to remove.
582 static void addrindex_hash_remove_cache(
583 AddressIndex *addrIndex, AddressDataSource *ds )
587 cacheID = addrindex_get_cache_id( addrIndex, ds );
589 g_hash_table_remove( addrIndex->hashCache, cacheID );
596 * Create a new address index.
597 * \return Initialized address index object.
599 AddressIndex *addrindex_create_index( void ) {
600 AddressIndex *addrIndex = g_new0( AddressIndex, 1 );
602 ADDRITEM_TYPE(addrIndex) = ITEMTYPE_INDEX;
603 ADDRITEM_ID(addrIndex) = NULL;
604 ADDRITEM_NAME(addrIndex) = g_strdup( "Address Index" );
605 ADDRITEM_PARENT(addrIndex) = NULL;
606 ADDRITEM_SUBTYPE(addrIndex) = 0;
607 addrIndex->filePath = NULL;
608 addrIndex->fileName = NULL;
609 addrIndex->retVal = MGU_SUCCESS;
610 addrIndex->needsConversion = FALSE;
611 addrIndex->wasConverted = FALSE;
612 addrIndex->conversionError = FALSE;
613 addrIndex->interfaceList = NULL;
614 addrIndex->lastType = ADDR_IF_NONE;
615 addrIndex->dirtyFlag = FALSE;
616 addrIndex->hashCache = g_hash_table_new( g_str_hash, g_str_equal );
617 addrIndex->loadedFlag = FALSE;
618 addrIndex->searchOrder = NULL;
619 addrindex_build_if_list( addrIndex );
624 * Property - Specify file path to address index file.
625 * \param addrIndex Address index.
626 * \param value Path to index file.
628 void addrindex_set_file_path( AddressIndex *addrIndex, const gchar *value ) {
629 g_return_if_fail( addrIndex != NULL );
630 addrIndex->filePath = mgu_replace_string( addrIndex->filePath, value );
634 * Property - Specify file name to address index file.
635 * \param addrIndex Address index.
636 * \param value File name.
638 void addrindex_set_file_name( AddressIndex *addrIndex, const gchar *value ) {
639 g_return_if_fail( addrIndex != NULL );
640 addrIndex->fileName = mgu_replace_string( addrIndex->fileName, value );
644 * Property - Specify file path to be used.
645 * \param addrIndex Address index.
646 * \param value Path to JPilot file.
648 void addrindex_set_dirty( AddressIndex *addrIndex, const gboolean value ) {
649 g_return_if_fail( addrIndex != NULL );
650 addrIndex->dirtyFlag = value;
654 * Property - get loaded flag. Note that this flag is set after reading data
655 * from the address books.
656 * \param addrIndex Address index.
657 * \return <i>TRUE</i> if address index data was loaded.
659 gboolean addrindex_get_loaded( AddressIndex *addrIndex ) {
660 g_return_val_if_fail( addrIndex != NULL, FALSE );
661 return addrIndex->loadedFlag;
665 * Return list of address interfaces.
666 * \param addrIndex Address index.
667 * \return List of address interfaces.
669 GList *addrindex_get_interface_list( AddressIndex *addrIndex ) {
670 g_return_val_if_fail( addrIndex != NULL, NULL );
671 return addrIndex->interfaceList;
675 * Perform any other initialization of address index.
676 * \param addrIndex Address index.
678 /* void addrindex_initialize( AddressIndex *addrIndex ) {
679 addrcompl_initialize();
683 * Perform any other teardown of address index.
684 * \param addrIndex Address index.
686 /* void addrindex_teardown( AddressIndex *addrIndex ) {
687 addrcompl_teardown();
691 * Free up address index.
692 * \param addrIndex Address index.
694 void addrindex_free_index( AddressIndex *addrIndex ) {
697 g_return_if_fail( addrIndex != NULL );
700 g_list_free( addrIndex->searchOrder );
701 addrIndex->searchOrder = NULL;
703 /* Free internal storage */
704 g_free( ADDRITEM_ID(addrIndex) );
705 g_free( ADDRITEM_NAME(addrIndex) );
706 g_free( addrIndex->filePath );
707 g_free( addrIndex->fileName );
710 ADDRITEM_TYPE(addrIndex) = ITEMTYPE_NONE;
711 ADDRITEM_ID(addrIndex) = NULL;
712 ADDRITEM_NAME(addrIndex) = NULL;
713 ADDRITEM_PARENT(addrIndex) = NULL;
714 ADDRITEM_SUBTYPE(addrIndex) = 0;
715 addrIndex->filePath = NULL;
716 addrIndex->fileName = NULL;
717 addrIndex->retVal = MGU_SUCCESS;
718 addrIndex->needsConversion = FALSE;
719 addrIndex->wasConverted = FALSE;
720 addrIndex->conversionError = FALSE;
721 addrIndex->lastType = ADDR_IF_NONE;
722 addrIndex->dirtyFlag = FALSE;
724 /* Free up interfaces */
725 node = addrIndex->interfaceList;
727 AddressInterface *iface = node->data;
728 addrindex_free_interface( iface );
729 node = g_list_next( node );
731 g_list_free( addrIndex->interfaceList );
732 addrIndex->interfaceList = NULL;
734 /* Free up hash cache */
735 addrindex_free_cache_hash( addrIndex->hashCache );
736 addrIndex->hashCache = NULL;
738 addrIndex->loadedFlag = FALSE;
744 * Print address index.
745 * \param addrIndex Address index.
746 * \parem stream Stream to print.
748 void addrindex_print_index( AddressIndex *addrIndex, FILE *stream ) {
749 g_return_if_fail( addrIndex != NULL );
750 fprintf( stream, "AddressIndex:\n" );
751 fprintf( stream, "\tfile path: '%s'\n", addrIndex->filePath );
752 fprintf( stream, "\tfile name: '%s'\n", addrIndex->fileName );
753 fprintf( stream, "\t status: %d\n", addrIndex->retVal );
754 fprintf( stream, "\tconverted: '%s'\n",
755 addrIndex->wasConverted ? "yes" : "no" );
756 fprintf( stream, "\tcvt error: '%s'\n",
757 addrIndex->conversionError ? "yes" : "no" );
758 fprintf( stream, "\t---\n" );
762 * Retrieve reference to address interface for specified interface type.
763 * \param addrIndex Address index.
764 * \param ifType Interface type.
765 * \return Address interface, or NULL if not found.
767 AddressInterface *addrindex_get_interface(
768 AddressIndex *addrIndex, AddressIfType ifType )
770 AddressInterface *retVal = NULL;
773 g_return_val_if_fail( addrIndex != NULL, NULL );
775 node = addrIndex->interfaceList;
777 AddressInterface *iface = node->data;
778 node = g_list_next( node );
779 if( iface->type == ifType ) {
788 * Add raw data source to index. The raw data object (an AddressBookFile or
789 * VCardFile object, for example) should be supplied as the raw dataSource
792 * \param addrIndex Address index.
793 * \param ifType Interface type to add.
794 * \param dataSource Actual raw data source to add.
795 * \return Data source added, or NULL if invalid interface type.
797 AddressDataSource *addrindex_index_add_datasource(
798 AddressIndex *addrIndex, AddressIfType ifType, gpointer dataSource )
800 AddressInterface *iface;
801 AddressDataSource *ds = NULL;
803 g_return_val_if_fail( addrIndex != NULL, NULL );
804 g_return_val_if_fail( dataSource != NULL, NULL );
806 iface = addrindex_get_interface( addrIndex, ifType );
808 ds = addrindex_create_datasource( ifType );
809 ADDRITEM_PARENT(ds) = ADDRITEM_OBJECT(iface);
811 ds->rawDataSource = dataSource;
812 ds->interface = iface;
813 iface->listSource = g_list_append( iface->listSource, ds );
814 addrIndex->dirtyFlag = TRUE;
816 addrindex_hash_add_cache( addrIndex, ds );
822 * Remove specified data source from index.
823 * \param addrIndex Address index.
824 * \param dataSource Data source to add.
825 * \return Reference to data source if removed, or NULL if data source was not
826 * found in index. Note the this object must still be freed.
828 AddressDataSource *addrindex_index_remove_datasource(
829 AddressIndex *addrIndex, AddressDataSource *dataSource )
831 AddressDataSource *retVal = FALSE;
832 AddressInterface *iface;
834 g_return_val_if_fail( addrIndex != NULL, NULL );
835 g_return_val_if_fail( dataSource != NULL, NULL );
837 iface = addrindex_get_interface( addrIndex, dataSource->type );
839 iface->listSource = g_list_remove( iface->listSource, dataSource );
840 addrIndex->dirtyFlag = TRUE;
841 dataSource->interface = NULL;
843 /* Remove cache from hash table */
844 addrindex_hash_remove_cache( addrIndex, dataSource );
852 * Retrieve a reference to address interface for specified interface type and
853 * XML interface tag name.
854 * \param addrIndex Address index.
855 * \param tag XML interface tag name to match.
856 * \param ifType Interface type to match.
857 * \return Reference to address index, or NULL if not found in index.
859 static AddressInterface *addrindex_tag_get_interface(
860 AddressIndex *addrIndex, gchar *tag, AddressIfType ifType )
862 AddressInterface *retVal = NULL;
863 GList *node = addrIndex->interfaceList;
866 AddressInterface *iface = node->data;
867 node = g_list_next( node );
869 if( strcmp( iface->listTag, tag ) == 0 ) {
875 if( iface->type == ifType ) {
885 * Retrieve a reference to address interface for specified interface type and
886 * XML datasource tag name.
887 * \param addrIndex Address index.
888 * \param ifType Interface type to match.
889 * \param tag XML datasource tag name to match.
890 * \return Reference to address index, or NULL if not found in index.
892 static AddressInterface *addrindex_tag_get_datasource(
893 AddressIndex *addrIndex, AddressIfType ifType, gchar *tag )
895 AddressInterface *retVal = NULL;
896 GList *node = addrIndex->interfaceList;
899 AddressInterface *iface = node->data;
900 node = g_list_next( node );
901 if( iface->type == ifType && iface->itemTag ) {
902 if( strcmp( iface->itemTag, tag ) == 0 ) {
911 /* **********************************************************************
912 * Interface XML parsing functions.
913 * ***********************************************************************
917 * Write start of XML element to file.
919 * \param lvl Indentation level.
920 * \param name Element name.
922 static void addrindex_write_elem_s( FILE *fp, const gint lvl, const gchar *name ) {
924 for( i = 0; i < lvl; i++ ) fputs( " ", fp );
930 * Write end of XML element to file.
932 * \param lvl Indentation level.
933 * \param name Element name.
935 static void addrindex_write_elem_e( FILE *fp, const gint lvl, const gchar *name ) {
937 for( i = 0; i < lvl; i++ ) fputs( " ", fp );
944 * Write XML attribute to file.
946 * \param name Attribute name.
947 * \param value Attribute value.
949 static void addrindex_write_attr( FILE *fp, const gchar *name, const gchar *value ) {
953 xml_file_put_escape_str( fp, value );
958 * Return DOM fragment for current XML tag from file.
959 * \param file XML file being processed.
960 * \return Fragment representing DOM fragment for configuration element.
962 static AddressIfFragment *addrindex_read_fragment( XMLFile *file ) {
963 AddressIfFragment *fragment;
964 AddressIfFragment *child;
974 prevLevel = file->level;
976 /* Get current tag name */
977 xtag = xml_get_current_tag( file );
979 /* Create new fragment */
980 fragment = g_new0( AddressIfFragment, 1 );
981 fragment->name = g_strdup( xtag->tag );
982 fragment->children = NULL;
983 fragment->attributes = NULL;
985 /* Read attributes */
987 attr = xml_get_current_tag_attr( file );
989 name = ((XMLAttr *)attr->data)->name;
990 value = ((XMLAttr *)attr->data)->value;
991 nv = g_new0( AddressIfAttrib, 1 );
992 nv->name = g_strdup( name );
993 nv->value = g_strdup( value );
994 list = g_list_append( list, nv );
995 attr = g_list_next( attr );
997 fragment->attributes = list;
999 /* Now read the children */
1001 rc = xml_parse_next_tag( file );
1006 if( file->level < prevLevel ) {
1007 /* We must be above level we start at */
1010 child = addrindex_read_fragment( file );
1011 fragment->children = g_list_append( fragment->children, child );
1018 * Write DOM fragment to file.
1019 * \param fp File to write.
1020 * \param fragment DOM fragment for configuration element.
1021 * \param lvl Indent level.
1023 static void addrindex_write_fragment(
1024 FILE *fp, const AddressIfFragment *fragment, const gint lvl )
1029 addrindex_write_elem_s( fp, lvl, fragment->name );
1030 node = fragment->attributes;
1032 AddressIfAttrib *nv = node->data;
1033 addrindex_write_attr( fp, nv->name, nv->value );
1034 node = g_list_next( node );
1036 if( fragment->children ) {
1039 /* Output children */
1040 node = fragment->children;
1042 AddressIfFragment *child = node->data;
1043 addrindex_write_fragment( fp, child, 1+lvl );
1044 node = g_list_next( node );
1047 /* Output closing tag */
1048 addrindex_write_elem_e( fp, lvl, fragment->name );
1057 static void addrindex_print_fragment_r(
1058 const AddressIfFragment *fragment, FILE *stream, gint lvl )
1063 for( i = 0; i < lvl; i++ )
1064 fprintf( stream, " " );
1065 fprintf( stream, "Element:%s:\n", fragment->name );
1066 node = fragment->attributes;
1068 AddressIfAttrib *nv = node->data;
1069 for( i = 0; i < lvl; i++ )
1070 fprintf( stream, " " );
1071 fprintf( stream, " %s : %s\n", nv->name, nv->value );
1072 node = g_list_next( node );
1074 node = fragment->children;
1076 AddressIfFragment *child = node->data;
1077 addrindex_print_fragment_r( child, stream, 1+lvl );
1078 node = g_list_next( node );
1082 static void addrindex_print_fragment( const AddressIfFragment *fragment, FILE *stream ) {
1083 addrindex_print_fragment_r( fragment, stream, 0 );
1088 * Read/parse address index file, creating a data source for a regular
1089 * intrinsic XML addressbook.
1090 * \param file Address index file.
1091 * \return Data source.
1093 static AddressDataSource *addrindex_parse_book( XMLFile *file ) {
1094 AddressDataSource *ds;
1095 AddressBookFile *abf;
1098 ds = addrindex_create_datasource( ADDR_IF_BOOK );
1099 abf = addrbook_create_book();
1100 attr = xml_get_current_tag_attr( file );
1102 gchar *name = ((XMLAttr *)attr->data)->name;
1103 gchar *value = ((XMLAttr *)attr->data)->value;
1104 if( strcmp( name, ATTAG_BOOK_NAME ) == 0 ) {
1105 addrbook_set_name( abf, value );
1107 else if( strcmp( name, ATTAG_BOOK_FILE ) == 0) {
1108 addrbook_set_file( abf, value );
1110 attr = g_list_next( attr );
1112 ds->rawDataSource = abf;
1116 static void addrindex_write_book( FILE *fp, AddressDataSource *ds, gint lvl ) {
1117 AddressBookFile *abf = ds->rawDataSource;
1119 addrindex_write_elem_s( fp, lvl, TAG_DS_ADDRESS_BOOK );
1120 addrindex_write_attr( fp, ATTAG_BOOK_NAME, addrbook_get_name( abf ) );
1121 addrindex_write_attr( fp, ATTAG_BOOK_FILE, abf->fileName );
1122 fputs( " />\n", fp );
1126 static AddressDataSource *addrindex_parse_vcard( XMLFile *file ) {
1127 AddressDataSource *ds;
1131 ds = addrindex_create_datasource( ADDR_IF_VCARD );
1132 vcf = vcard_create();
1133 attr = xml_get_current_tag_attr( file );
1135 gchar *name = ((XMLAttr *)attr->data)->name;
1136 gchar *value = ((XMLAttr *)attr->data)->value;
1137 if( strcmp( name, ATTAG_VCARD_NAME ) == 0 ) {
1138 vcard_set_name( vcf, value );
1140 else if( strcmp( name, ATTAG_VCARD_FILE ) == 0) {
1141 vcard_set_file( vcf, value );
1143 attr = g_list_next( attr );
1145 ds->rawDataSource = vcf;
1149 static void addrindex_write_vcard( FILE *fp, AddressDataSource *ds, gint lvl ) {
1150 VCardFile *vcf = ds->rawDataSource;
1152 addrindex_write_elem_s( fp, lvl, TAG_DS_VCARD );
1153 addrindex_write_attr( fp, ATTAG_VCARD_NAME, vcard_get_name( vcf ) );
1154 addrindex_write_attr( fp, ATTAG_VCARD_FILE, vcf->path );
1155 fputs( " />\n", fp );
1160 static AddressDataSource *addrindex_parse_jpilot( XMLFile *file ) {
1161 AddressDataSource *ds;
1165 ds = addrindex_create_datasource( ADDR_IF_JPILOT );
1166 jpf = jpilot_create();
1167 attr = xml_get_current_tag_attr( file );
1169 gchar *name = ((XMLAttr *)attr->data)->name;
1170 gchar *value = ((XMLAttr *)attr->data)->value;
1171 if( strcmp( name, ATTAG_JPILOT_NAME ) == 0 ) {
1172 jpilot_set_name( jpf, value );
1174 else if( strcmp( name, ATTAG_JPILOT_FILE ) == 0 ) {
1175 jpilot_set_file( jpf, value );
1177 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_1 ) == 0 ) {
1178 jpilot_add_custom_label( jpf, value );
1180 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_2 ) == 0 ) {
1181 jpilot_add_custom_label( jpf, value );
1183 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_3 ) == 0 ) {
1184 jpilot_add_custom_label( jpf, value );
1186 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_4 ) == 0 ) {
1187 jpilot_add_custom_label( jpf, value );
1189 attr = g_list_next( attr );
1191 ds->rawDataSource = jpf;
1195 static void addrindex_write_jpilot( FILE *fp,AddressDataSource *ds, gint lvl ) {
1196 JPilotFile *jpf = ds->rawDataSource;
1200 GList *customLbl = jpilot_get_custom_labels( jpf );
1201 addrindex_write_elem_s( fp, lvl, TAG_DS_JPILOT );
1202 addrindex_write_attr( fp, ATTAG_JPILOT_NAME, jpilot_get_name( jpf ) );
1203 addrindex_write_attr( fp, ATTAG_JPILOT_FILE, jpf->path );
1208 g_snprintf( name, sizeof(name), "%s%d",
1209 ATTAG_JPILOT_CUSTOM, ind );
1210 addrindex_write_attr( fp, name, node->data );
1212 node = g_list_next( node );
1214 fputs( " />\n", fp );
1222 * Parse LDAP criteria attribute data from XML file.
1223 * \param file Index file.
1224 * \param ctl LDAP control object to populate.
1226 static void addrindex_parse_ldap_attrlist( XMLFile *file, LdapControl *ctl ) {
1235 if( file == NULL ) {
1240 prevLevel = file->level;
1241 xtagPrev = xml_get_current_tag( file );
1243 rc = xml_parse_next_tag( file );
1245 /* Terminate prematurely */
1246 mgu_free_dlist( list );
1250 if( file->level < prevLevel ) {
1251 /* We must be above level we start at */
1255 /* Get a tag (element) */
1256 xtag = xml_get_current_tag( file );
1257 if( strcmp( xtag->tag, ELTAG_LDAP_ATTR_SRCH ) == 0 ) {
1258 /* LDAP criteria attribute */
1259 attr = xml_get_current_tag_attr( file );
1261 gchar *name = ((XMLAttr *)attr->data)->name;
1262 gchar *value = ((XMLAttr *)attr->data)->value;
1263 if( strcmp( name, ATTAG_LDAP_ATTR_NAME ) == 0 ) {
1264 if( value && strlen( value ) > 0 ) {
1265 list = g_list_append(
1266 list, g_strdup( value ) );
1269 attr = g_list_next( attr );
1273 if( xtag != xtagPrev ) {
1274 /* Found a new tag */
1281 /* Build list of search attributes */
1282 ldapctl_criteria_list_clear( ctl );
1285 ldapctl_criteria_list_add( ctl, node->data );
1286 g_free( node->data );
1288 node = g_list_next( node );
1290 g_list_free( list );
1295 static AddressDataSource *addrindex_parse_ldap( XMLFile *file ) {
1296 AddressDataSource *ds;
1300 gchar *serverName = NULL;
1301 gchar *criteria = NULL;
1302 gboolean bSearch = FALSE;
1303 gboolean cvtFlag = TRUE;
1305 ds = addrindex_create_datasource( ADDR_IF_LDAP );
1306 ctl = ldapctl_create();
1307 attr = xml_get_current_tag_attr( file );
1309 gchar *name = ((XMLAttr *)attr->data)->name;
1310 gchar *value = ((XMLAttr *)attr->data)->value;
1311 gint ivalue = atoi( value );
1313 if( strcmp( name, ATTAG_LDAP_NAME ) == 0 ) {
1314 if( serverName ) g_free( serverName );
1315 serverName = g_strdup( value );
1317 else if( strcmp( name, ATTAG_LDAP_HOST ) == 0 ) {
1318 ldapctl_set_host( ctl, value );
1320 else if( strcmp( name, ATTAG_LDAP_PORT ) == 0 ) {
1321 ldapctl_set_port( ctl, ivalue );
1323 else if( strcmp( name, ATTAG_LDAP_BASE_DN ) == 0 ) {
1324 ldapctl_set_base_dn( ctl, value );
1326 else if( strcmp( name, ATTAG_LDAP_BIND_DN ) == 0 ) {
1327 ldapctl_set_bind_dn( ctl, value );
1329 else if( strcmp( name, ATTAG_LDAP_BIND_PASS ) == 0 ) {
1330 ldapctl_set_bind_password( ctl, value );
1332 else if( strcmp( name, ATTAG_LDAP_CRITERIA ) == 0 ) {
1333 if( criteria ) g_free( criteria );
1334 criteria = g_strdup( value );
1336 else if( strcmp( name, ATTAG_LDAP_MAX_ENTRY ) == 0 ) {
1337 ldapctl_set_max_entries( ctl, ivalue );
1339 else if( strcmp( name, ATTAG_LDAP_TIMEOUT ) == 0 ) {
1340 ldapctl_set_timeout( ctl, ivalue );
1342 else if( strcmp( name, ATTAG_LDAP_MAX_AGE ) == 0 ) {
1343 ldapctl_set_max_query_age( ctl, ivalue );
1345 else if( strcmp( name, ATTAG_LDAP_DYN_SEARCH ) == 0 ) {
1348 if( strcmp( value, "yes" ) == 0 ) {
1352 attr = g_list_next( attr );
1355 server = ldapsvr_create_noctl();
1356 ldapsvr_set_name( server, serverName );
1357 ldapsvr_set_search_flag( server, bSearch );
1358 g_free( serverName );
1359 ldapsvr_set_control( server, ctl );
1360 ds->rawDataSource = server;
1362 addrindex_parse_ldap_attrlist( file, ctl );
1364 * If criteria have been specified and no attributes were listed, then
1365 * convert old style criteria into an attribute list. Any criteria will
1366 * be dropped when saving data.
1369 if( ! ldapctl_get_criteria_list( ctl ) ) {
1370 ldapctl_parse_ldap_search( ctl, criteria );
1375 * If no search flag was found, then we are converting from old format
1376 * server data to new format.
1379 ldapsvr_set_search_flag( server, TRUE );
1381 /* ldapsvr_print_data( server, stdout ); */
1386 static void addrindex_write_ldap( FILE *fp, AddressDataSource *ds, gint lvl ) {
1387 LdapServer *server = ds->rawDataSource;
1388 LdapControl *ctl = NULL;
1393 ctl = server->control;
1395 if( ctl == NULL ) return;
1397 /* Output start element with attributes */
1398 addrindex_write_elem_s( fp, lvl, TAG_DS_LDAP );
1399 addrindex_write_attr( fp, ATTAG_LDAP_NAME, ldapsvr_get_name( server ) );
1400 addrindex_write_attr( fp, ATTAG_LDAP_HOST, ctl->hostName );
1402 sprintf( value, "%d", ctl->port );
1403 addrindex_write_attr( fp, ATTAG_LDAP_PORT, value );
1405 addrindex_write_attr( fp, ATTAG_LDAP_BASE_DN, ctl->baseDN );
1406 addrindex_write_attr( fp, ATTAG_LDAP_BIND_DN, ctl->bindDN );
1407 addrindex_write_attr( fp, ATTAG_LDAP_BIND_PASS, ctl->bindPass );
1409 sprintf( value, "%d", ctl->maxEntries );
1410 addrindex_write_attr( fp, ATTAG_LDAP_MAX_ENTRY, value );
1411 sprintf( value, "%d", ctl->timeOut );
1412 addrindex_write_attr( fp, ATTAG_LDAP_TIMEOUT, value );
1413 sprintf( value, "%d", ctl->maxQueryAge );
1414 addrindex_write_attr( fp, ATTAG_LDAP_MAX_AGE, value );
1416 addrindex_write_attr( fp, ATTAG_LDAP_DYN_SEARCH,
1417 server->searchFlag ? "yes" : "no" );
1421 /* Output attributes */
1422 node = ldapctl_get_criteria_list( ctl );
1424 addrindex_write_elem_s( fp, 1+lvl, ELTAG_LDAP_ATTR_SRCH );
1425 addrindex_write_attr( fp, ATTAG_LDAP_ATTR_NAME, node->data );
1427 node = g_list_next( node );
1430 /* End of element */
1431 addrindex_write_elem_e( fp, lvl, TAG_DS_LDAP );
1436 /* **********************************************************************
1437 * Address index I/O functions.
1438 * ***********************************************************************
1441 * Read address index file, creating appropriate data sources for each address
1444 * \param addrIndex Address index.
1445 * \param file Address index file.
1447 static void addrindex_read_index( AddressIndex *addrIndex, XMLFile *file ) {
1450 AddressInterface *iface = NULL, *dsIFace = NULL;
1451 AddressDataSource *ds;
1454 addrIndex->loadedFlag = FALSE;
1456 prev_level = file->level;
1457 rc = xml_parse_next_tag( file );
1458 if( file->level == 0 ) return;
1460 xtag = xml_get_current_tag( file );
1462 iface = addrindex_tag_get_interface( addrIndex, xtag->tag, ADDR_IF_NONE );
1464 addrIndex->lastType = iface->type;
1465 if( iface->legacyFlag ) addrIndex->needsConversion = TRUE;
1468 dsIFace = addrindex_tag_get_datasource(
1469 addrIndex, addrIndex->lastType, xtag->tag );
1471 /* Add data source to list */
1473 if( addrIndex->lastType == ADDR_IF_BOOK ) {
1474 ds = addrindex_parse_book( file );
1475 if( ds->rawDataSource ) {
1476 addrbook_set_path( ds->rawDataSource,
1477 addrIndex->filePath );
1480 else if( addrIndex->lastType == ADDR_IF_VCARD ) {
1481 ds = addrindex_parse_vcard( file );
1484 else if( addrIndex->lastType == ADDR_IF_JPILOT ) {
1485 ds = addrindex_parse_jpilot( file );
1489 else if( addrIndex->lastType == ADDR_IF_LDAP ) {
1490 ds = addrindex_parse_ldap( file );
1494 ds->interface = dsIFace;
1495 addrindex_hash_add_cache( addrIndex, ds );
1496 dsIFace->listSource =
1497 g_list_append( dsIFace->listSource, ds );
1505 * Search order sorting comparison function for building search order list.
1507 static gint addrindex_search_order_compare( gconstpointer ptrA, gconstpointer ptrB ) {
1508 AddressInterface *ifaceA = ( AddressInterface * ) ptrA;
1509 AddressInterface *ifaceB = ( AddressInterface * ) ptrB;
1511 return ifaceA->searchOrder - ifaceB->searchOrder;
1515 * Build list of data sources to process.
1516 * \param addrIndex Address index object.
1518 static void addrindex_build_search_order( AddressIndex *addrIndex ) {
1519 AddressInterface *iface;
1522 /* Clear existing list */
1523 g_list_free( addrIndex->searchOrder );
1524 addrIndex->searchOrder = NULL;
1526 /* Build new list */
1527 nodeIf = addrIndex->interfaceList;
1529 AddressInterface *iface = nodeIf->data;
1530 if( iface->searchOrder > 0 ) {
1531 /* Add to search order list */
1532 addrIndex->searchOrder = g_list_insert_sorted(
1533 addrIndex->searchOrder, iface,
1534 addrindex_search_order_compare );
1536 nodeIf = g_list_next( nodeIf );
1539 nodeIf = addrIndex->searchOrder;
1541 AddressInterface *iface = nodeIf->data;
1542 nodeIf = g_list_next( nodeIf );
1547 static gint addrindex_read_file( AddressIndex *addrIndex ) {
1548 XMLFile *file = NULL;
1549 gchar *fileSpec = NULL;
1551 g_return_val_if_fail( addrIndex != NULL, -1 );
1553 fileSpec = g_strconcat( addrIndex->filePath, G_DIR_SEPARATOR_S, addrIndex->fileName, NULL );
1554 addrIndex->retVal = MGU_NO_FILE;
1555 file = xml_open_file( fileSpec );
1558 if( file == NULL ) {
1560 fprintf( stdout, " file '%s' does not exist.\n", addrIndex->fileName );
1562 return addrIndex->retVal;
1565 addrIndex->retVal = MGU_BAD_FORMAT;
1566 if( xml_get_dtd( file ) == 0 ) {
1567 if( xml_parse_next_tag( file ) == 0 ) {
1568 if( xml_compare_tag( file, TAG_ADDRESS_INDEX ) ) {
1569 addrindex_read_index( addrIndex, file );
1570 addrIndex->retVal = MGU_SUCCESS;
1574 xml_close_file( file );
1576 addrindex_build_search_order( addrIndex );
1578 return addrIndex->retVal;
1581 static void addrindex_write_index( AddressIndex *addrIndex, FILE *fp ) {
1582 GList *nodeIF, *nodeDS;
1584 gint lvlItem = 1 + lvlList;
1586 nodeIF = addrIndex->interfaceList;
1588 AddressInterface *iface = nodeIF->data;
1589 if( ! iface->legacyFlag ) {
1590 nodeDS = iface->listSource;
1591 addrindex_write_elem_s( fp, lvlList, iface->listTag );
1594 AddressDataSource *ds = nodeDS->data;
1596 if( iface->type == ADDR_IF_BOOK ) {
1597 addrindex_write_book( fp, ds, lvlItem );
1599 if( iface->type == ADDR_IF_VCARD ) {
1600 addrindex_write_vcard( fp, ds, lvlItem );
1603 if( iface->type == ADDR_IF_JPILOT ) {
1604 addrindex_write_jpilot( fp, ds, lvlItem );
1608 if( iface->type == ADDR_IF_LDAP ) {
1609 addrindex_write_ldap( fp, ds, lvlItem );
1613 nodeDS = g_list_next( nodeDS );
1615 addrindex_write_elem_e( fp, lvlList, iface->listTag );
1617 nodeIF = g_list_next( nodeIF );
1622 * Write data to specified file.
1623 * Enter: addrIndex Address index object.
1624 * newFile New file name.
1625 * return: Status code, from addrIndex->retVal.
1626 * Note: File will be created in directory specified by addrIndex.
1628 gint addrindex_write_to( AddressIndex *addrIndex, const gchar *newFile ) {
1631 #ifndef DEV_STANDALONE
1635 g_return_val_if_fail( addrIndex != NULL, -1 );
1637 fileSpec = g_strconcat( addrIndex->filePath, G_DIR_SEPARATOR_S, newFile, NULL );
1638 addrIndex->retVal = MGU_OPEN_FILE;
1639 #ifdef DEV_STANDALONE
1640 fp = fopen( fileSpec, "wb" );
1643 fputs( "<?xml version=\"1.0\" ?>\n", fp );
1645 pfile = prefs_write_open( fileSpec );
1649 fprintf( fp, "<?xml version=\"1.0\" encoding=\"%s\" ?>\n",
1650 conv_get_current_charset_str() );
1652 addrindex_write_elem_s( fp, 0, TAG_ADDRESS_INDEX );
1655 addrindex_write_index( addrIndex, fp );
1656 addrindex_write_elem_e( fp, 0, TAG_ADDRESS_INDEX );
1658 addrIndex->retVal = MGU_SUCCESS;
1659 #ifdef DEV_STANDALONE
1662 if( prefs_file_close( pfile ) < 0 ) {
1663 addrIndex->retVal = MGU_ERROR_WRITE;
1669 return addrIndex->retVal;
1673 * Save address index data to original file.
1674 * return: Status code, from addrIndex->retVal.
1676 gint addrindex_save_data( AddressIndex *addrIndex ) {
1677 g_return_val_if_fail( addrIndex != NULL, -1 );
1679 addrIndex->retVal = MGU_NO_FILE;
1680 if( addrIndex->fileName == NULL || *addrIndex->fileName == '\0' ) return addrIndex->retVal;
1681 if( addrIndex->filePath == NULL || *addrIndex->filePath == '\0' ) return addrIndex->retVal;
1683 addrindex_write_to( addrIndex, addrIndex->fileName );
1684 if( addrIndex->retVal == MGU_SUCCESS ) {
1685 addrIndex->dirtyFlag = FALSE;
1687 return addrIndex->retVal;
1691 * Save all address book files which may have changed.
1692 * Return: Status code, set if there was a problem saving data.
1694 gint addrindex_save_all_books( AddressIndex *addrIndex ) {
1695 gint retVal = MGU_SUCCESS;
1696 GList *nodeIf, *nodeDS;
1698 nodeIf = addrIndex->interfaceList;
1700 AddressInterface *iface = nodeIf->data;
1701 if( iface->type == ADDR_IF_BOOK ) {
1702 nodeDS = iface->listSource;
1704 AddressDataSource *ds = nodeDS->data;
1705 AddressBookFile *abf = ds->rawDataSource;
1706 if( addrbook_get_dirty( abf ) ) {
1707 if( addrbook_get_read_flag( abf ) ) {
1708 addrbook_save_data( abf );
1709 if( abf->retVal != MGU_SUCCESS ) {
1710 retVal = abf->retVal;
1714 nodeDS = g_list_next( nodeDS );
1718 nodeIf = g_list_next( nodeIf );
1724 /* **********************************************************************
1725 * Address book conversion to new format.
1726 * ***********************************************************************
1729 #define ELTAG_IF_OLD_FOLDER "folder"
1730 #define ELTAG_IF_OLD_GROUP "group"
1731 #define ELTAG_IF_OLD_ITEM "item"
1732 #define ELTAG_IF_OLD_NAME "name"
1733 #define ELTAG_IF_OLD_ADDRESS "address"
1734 #define ELTAG_IF_OLD_REMARKS "remarks"
1735 #define ATTAG_IF_OLD_NAME "name"
1737 #define TEMPNODE_ROOT 0
1738 #define TEMPNODE_FOLDER 1
1739 #define TEMPNODE_GROUP 2
1740 #define TEMPNODE_ADDRESS 3
1742 typedef struct _AddressCvt_Node AddressCvtNode;
1743 struct _AddressCvt_Node {
1752 * Parse current address item.
1754 static AddressCvtNode *addrindex_parse_item( XMLFile *file ) {
1759 nn = g_new0( AddressCvtNode, 1 );
1760 nn->type = TEMPNODE_ADDRESS;
1763 level = file->level;
1766 xml_parse_next_tag(file);
1767 if (file->level < level) return nn;
1769 element = xml_get_element( file );
1770 if( xml_compare_tag( file, ELTAG_IF_OLD_NAME ) ) {
1771 nn->name = g_strdup( element );
1773 if( xml_compare_tag( file, ELTAG_IF_OLD_ADDRESS ) ) {
1774 nn->address = g_strdup( element );
1776 if( xml_compare_tag( file, ELTAG_IF_OLD_REMARKS ) ) {
1777 nn->remarks = g_strdup( element );
1779 xml_parse_next_tag(file);
1784 * Create a temporary node below specified node.
1786 static AddressCvtNode *addrindex_add_object( AddressCvtNode *node, gint type, gchar *name, gchar *addr, char *rem ) {
1788 nn = g_new0( AddressCvtNode, 1 );
1790 nn->name = g_strdup( name );
1791 nn->remarks = g_strdup( rem );
1792 node->list = g_list_append( node->list, nn );
1797 * Process current temporary node.
1799 static void addrindex_add_obj( XMLFile *file, AddressCvtNode *node ) {
1802 AddressCvtNode *newNode = NULL;
1807 prev_level = file->level;
1808 xml_parse_next_tag( file );
1809 if (file->level < prev_level) return;
1813 if( xml_compare_tag( file, ELTAG_IF_OLD_GROUP ) ) {
1814 attr = xml_get_current_tag_attr(file);
1816 name = ((XMLAttr *)attr->data)->name;
1817 if( strcmp( name, ATTAG_IF_OLD_NAME ) == 0 ) {
1818 value = ((XMLAttr *)attr->data)->value;
1821 newNode = addrindex_add_object( node, TEMPNODE_GROUP, value, "", "" );
1822 addrindex_add_obj( file, newNode );
1825 else if( xml_compare_tag( file, ELTAG_IF_OLD_FOLDER ) ) {
1826 attr = xml_get_current_tag_attr(file);
1828 name = ((XMLAttr *)attr->data)->name;
1829 if( strcmp( name, ATTAG_IF_OLD_NAME ) == 0 ) {
1830 value = ((XMLAttr *)attr->data)->value;
1833 newNode = addrindex_add_object( node, TEMPNODE_FOLDER, value, "", "" );
1834 addrindex_add_obj( file, newNode );
1836 else if( xml_compare_tag( file, ELTAG_IF_OLD_ITEM ) ) {
1837 newNode = addrindex_parse_item( file );
1838 node->list = g_list_append( node->list, newNode );
1841 /* printf( "invalid: !!! \n" ); */
1842 attr = xml_get_current_tag_attr( file );
1848 * Consume all nodes below current tag.
1850 static void addrindex_consume_tree( XMLFile *file ) {
1857 prev_level = file->level;
1858 xml_parse_next_tag( file );
1859 if (file->level < prev_level) return;
1861 xtag = xml_get_current_tag( file );
1862 /* printf( "tag : %s\n", xtag->tag ); */
1863 element = xml_get_element( file );
1864 attr = xml_get_current_tag_attr( file );
1865 /* show_attribs( attr ); */
1866 /* printf( "\ttag value : %s :\n", element ); */
1867 addrindex_consume_tree( file );
1872 * Print temporary tree.
1874 static void addrindex_print_node( AddressCvtNode *node, FILE *stream ) {
1877 fprintf( stream, "Node:\ttype :%d:\n", node->type );
1878 fprintf( stream, "\tname :%s:\n", node->name );
1879 fprintf( stream, "\taddr :%s:\n", node->address );
1880 fprintf( stream, "\trems :%s:\n", node->remarks );
1882 fprintf( stream, "\t--list----\n" );
1886 AddressCvtNode *lNode = list->data;
1887 list = g_list_next( list );
1888 addrindex_print_node( lNode, stream );
1890 fprintf( stream, "\t==list-%d==\n", node->type );
1894 * Free up temporary tree.
1896 static void addrindex_free_node( AddressCvtNode *node ) {
1897 GList *list = node->list;
1900 AddressCvtNode *lNode = list->data;
1901 list = g_list_next( list );
1902 addrindex_free_node( lNode );
1904 node->type = TEMPNODE_ROOT;
1905 g_free( node->name );
1906 g_free( node->address );
1907 g_free( node->remarks );
1908 g_list_free( node->list );
1913 * Process address book for specified node.
1915 static void addrindex_process_node(
1916 AddressBookFile *abf, AddressCvtNode *node, ItemFolder *parent,
1917 ItemGroup *parentGrp, ItemFolder *folderGrp )
1920 ItemFolder *itemFolder = NULL;
1921 ItemGroup *itemGParent = parentGrp;
1922 ItemFolder *itemGFolder = folderGrp;
1923 AddressCache *cache = abf->addressCache;
1925 if( node->type == TEMPNODE_ROOT ) {
1926 itemFolder = parent;
1928 else if( node->type == TEMPNODE_FOLDER ) {
1929 itemFolder = addritem_create_item_folder();
1930 addritem_folder_set_name( itemFolder, node->name );
1931 addrcache_id_folder( cache, itemFolder );
1932 addrcache_folder_add_folder( cache, parent, itemFolder );
1935 else if( node->type == TEMPNODE_GROUP ) {
1936 ItemGroup *itemGroup;
1939 /* Create a folder for group */
1940 fName = g_strdup_printf( "Cvt - %s", node->name );
1941 itemGFolder = addritem_create_item_folder();
1942 addritem_folder_set_name( itemGFolder, fName );
1943 addrcache_id_folder( cache, itemGFolder );
1944 addrcache_folder_add_folder( cache, parent, itemGFolder );
1947 /* Add group into folder */
1948 itemGroup = addritem_create_item_group();
1949 addritem_group_set_name( itemGroup, node->name );
1950 addrcache_id_group( cache, itemGroup );
1951 addrcache_folder_add_group( cache, itemGFolder, itemGroup );
1952 itemGParent = itemGroup;
1954 else if( node->type == TEMPNODE_ADDRESS ) {
1955 ItemPerson *itemPerson;
1956 ItemEMail *itemEMail;
1958 /* Create person and email objects */
1959 itemPerson = addritem_create_item_person();
1960 addritem_person_set_common_name( itemPerson, node->name );
1961 addrcache_id_person( cache, itemPerson );
1962 itemEMail = addritem_create_item_email();
1963 addritem_email_set_address( itemEMail, node->address );
1964 addritem_email_set_remarks( itemEMail, node->remarks );
1965 addrcache_id_email( cache, itemEMail );
1966 addrcache_person_add_email( cache, itemPerson, itemEMail );
1968 /* Add person into appropriate folder */
1970 addrcache_folder_add_person( cache, itemGFolder, itemPerson );
1973 addrcache_folder_add_person( cache, parent, itemPerson );
1976 /* Add email address only into group */
1978 addrcache_group_add_email( cache, parentGrp, itemEMail );
1984 AddressCvtNode *lNode = list->data;
1985 list = g_list_next( list );
1986 addrindex_process_node( abf, lNode, itemFolder, itemGParent, itemGFolder );
1991 * Process address book to specified file number.
1993 static gboolean addrindex_process_book( AddressIndex *addrIndex, XMLFile *file, gchar *displayName ) {
1994 gboolean retVal = FALSE;
1995 AddressBookFile *abf = NULL;
1996 AddressCvtNode *rootNode = NULL;
1997 gchar *newFile = NULL;
1998 GList *fileList = NULL;
2001 /* Setup root node */
2002 rootNode = g_new0( AddressCvtNode, 1 );
2003 rootNode->type = TEMPNODE_ROOT;
2004 rootNode->name = g_strdup( "root" );
2005 rootNode->list = NULL;
2006 addrindex_add_obj( file, rootNode );
2007 /* addrindex_print_node( rootNode, stdout ); */
2009 /* Create new address book */
2010 abf = addrbook_create_book();
2011 addrbook_set_name( abf, displayName );
2012 addrbook_set_path( abf, addrIndex->filePath );
2014 /* Determine next available file number */
2015 fileList = addrbook_get_bookfile_list( abf );
2017 fileNum = 1 + abf->maxValue;
2019 g_list_free( fileList );
2022 newFile = addrbook_gen_new_file_name( fileNum );
2024 addrbook_set_file( abf, newFile );
2027 addrindex_process_node( abf, rootNode, abf->addressCache->rootFolder, NULL, NULL );
2029 /* addrbook_dump_book( abf, stdout ); */
2030 addrbook_save_data( abf );
2031 addrIndex->retVal = abf->retVal;
2032 if( abf->retVal == MGU_SUCCESS ) retVal = TRUE;
2034 addrbook_free_book( abf );
2036 addrindex_free_node( rootNode );
2039 /* Create entries in address index */
2041 abf = addrbook_create_book();
2042 addrbook_set_name( abf, displayName );
2043 addrbook_set_path( abf, addrIndex->filePath );
2044 addrbook_set_file( abf, newFile );
2045 addrindex_index_add_datasource( addrIndex, ADDR_IF_BOOK, abf );
2052 * Process tree converting data.
2054 static void addrindex_convert_tree( AddressIndex *addrIndex, XMLFile *file ) {
2062 prev_level = file->level;
2063 xml_parse_next_tag( file );
2064 if (file->level < prev_level) return;
2066 xtag = xml_get_current_tag( file );
2067 /* printf( "tag : %d : %s\n", prev_level, xtag->tag ); */
2068 if( strcmp( xtag->tag, TAG_IF_OLD_COMMON ) == 0 ) {
2069 if( addrindex_process_book( addrIndex, file, DISP_OLD_COMMON ) ) {
2070 addrIndex->needsConversion = FALSE;
2071 addrIndex->wasConverted = TRUE;
2076 if( strcmp( xtag->tag, TAG_IF_OLD_PERSONAL ) == 0 ) {
2077 if( addrindex_process_book( addrIndex, file, DISP_OLD_PERSONAL ) ) {
2078 addrIndex->needsConversion = FALSE;
2079 addrIndex->wasConverted = TRUE;
2084 element = xml_get_element( file );
2085 attr = xml_get_current_tag_attr( file );
2086 /* show_attribs( attr ); */
2087 /* printf( "\ttag value : %s :\n", element ); */
2088 addrindex_consume_tree( file );
2092 static gint addrindex_convert_data( AddressIndex *addrIndex ) {
2093 XMLFile *file = NULL;
2096 fileSpec = g_strconcat( addrIndex->filePath, G_DIR_SEPARATOR_S, addrIndex->fileName, NULL );
2097 addrIndex->retVal = MGU_NO_FILE;
2098 file = xml_open_file( fileSpec );
2101 if( file == NULL ) {
2102 /* fprintf( stdout, " file '%s' does not exist.\n", addrIndex->fileName ); */
2103 return addrIndex->retVal;
2106 addrIndex->retVal = MGU_BAD_FORMAT;
2107 if( xml_get_dtd( file ) == 0 ) {
2108 if( xml_parse_next_tag( file ) == 0 ) {
2109 if( xml_compare_tag( file, TAG_ADDRESS_INDEX ) ) {
2110 addrindex_convert_tree( addrIndex, file );
2114 xml_close_file( file );
2115 return addrIndex->retVal;
2119 * Create a new address book file.
2121 static gboolean addrindex_create_new_book( AddressIndex *addrIndex, gchar *displayName ) {
2122 gboolean retVal = FALSE;
2123 AddressBookFile *abf = NULL;
2124 gchar *newFile = NULL;
2125 GList *fileList = NULL;
2128 /* Create new address book */
2129 abf = addrbook_create_book();
2130 addrbook_set_name( abf, displayName );
2131 addrbook_set_path( abf, addrIndex->filePath );
2133 /* Determine next available file number */
2134 fileList = addrbook_get_bookfile_list( abf );
2136 fileNum = 1 + abf->maxValue;
2138 g_list_free( fileList );
2141 newFile = addrbook_gen_new_file_name( fileNum );
2143 addrbook_set_file( abf, newFile );
2146 addrbook_save_data( abf );
2147 addrIndex->retVal = abf->retVal;
2148 if( abf->retVal == MGU_SUCCESS ) retVal = TRUE;
2149 addrbook_free_book( abf );
2152 /* Create entries in address index */
2154 abf = addrbook_create_book();
2155 addrbook_set_name( abf, displayName );
2156 addrbook_set_path( abf, addrIndex->filePath );
2157 addrbook_set_file( abf, newFile );
2158 addrindex_index_add_datasource( addrIndex, ADDR_IF_BOOK, abf );
2165 * Read data for address index performing a conversion if necesary.
2166 * Enter: addrIndex Address index object.
2167 * return: Status code, from addrIndex->retVal.
2168 * Note: New address book files will be created in directory specified by
2169 * addrIndex. Three files will be created, for the following:
2170 * "Common addresses"
2171 * "Personal addresses"
2172 * "Gathered addresses" - a new address book.
2174 gint addrindex_read_data( AddressIndex *addrIndex ) {
2175 g_return_val_if_fail( addrIndex != NULL, -1 );
2177 addrIndex->conversionError = FALSE;
2178 addrindex_read_file( addrIndex );
2179 if( addrIndex->retVal == MGU_SUCCESS ) {
2180 if( addrIndex->needsConversion ) {
2181 if( addrindex_convert_data( addrIndex ) == MGU_SUCCESS ) {
2182 addrIndex->conversionError = TRUE;
2185 addrIndex->conversionError = TRUE;
2188 addrIndex->dirtyFlag = TRUE;
2190 return addrIndex->retVal;
2194 * Create new address books for a new address index.
2195 * Enter: addrIndex Address index object.
2196 * return: Status code, from addrIndex->retVal.
2197 * Note: New address book files will be created in directory specified by
2198 * addrIndex. Three files will be created, for the following:
2199 * "Common addresses"
2200 * "Personal addresses"
2201 * "Gathered addresses" - a new address book.
2203 gint addrindex_create_new_books( AddressIndex *addrIndex ) {
2206 g_return_val_if_fail( addrIndex != NULL, -1 );
2208 flg = addrindex_create_new_book( addrIndex, DISP_NEW_COMMON );
2210 flg = addrindex_create_new_book( addrIndex, DISP_NEW_PERSONAL );
2211 addrIndex->dirtyFlag = TRUE;
2213 return addrIndex->retVal;
2216 /* **********************************************************************
2217 * New interface stuff.
2218 * ***********************************************************************
2222 * Return modified flag for specified data source.
2224 gboolean addrindex_ds_get_modify_flag( AddressDataSource *ds ) {
2225 gboolean retVal = FALSE;
2226 AddressInterface *iface;
2228 if( ds == NULL ) return retVal;
2229 iface = ds->interface;
2230 if( iface == NULL ) return retVal;
2231 if( iface->getModifyFlag ) {
2232 retVal = ( iface->getModifyFlag ) ( ds->rawDataSource );
2238 * Return accessed flag for specified data source.
2240 gboolean addrindex_ds_get_access_flag( AddressDataSource *ds ) {
2241 gboolean retVal = FALSE;
2242 AddressInterface *iface;
2244 if( ds == NULL ) return retVal;
2245 iface = ds->interface;
2246 if( iface == NULL ) return retVal;
2247 if( iface->getAccessFlag ) {
2248 retVal = ( iface->getAccessFlag ) ( ds->rawDataSource );
2254 * Return data read flag for specified data source.
2256 gboolean addrindex_ds_get_read_flag( AddressDataSource *ds ) {
2257 gboolean retVal = TRUE;
2258 AddressInterface *iface;
2260 if( ds == NULL ) return retVal;
2261 iface = ds->interface;
2262 if( iface == NULL ) return retVal;
2263 if( iface->getReadFlag ) {
2264 retVal = ( iface->getReadFlag ) ( ds->rawDataSource );
2270 * Return status code for specified data source.
2272 gint addrindex_ds_get_status_code( AddressDataSource *ds ) {
2273 gint retVal = MGU_SUCCESS;
2274 AddressInterface *iface;
2276 if( ds == NULL ) return retVal;
2277 iface = ds->interface;
2278 if( iface == NULL ) return retVal;
2279 if( iface->getStatusCode ) {
2280 retVal = ( iface->getStatusCode ) ( ds->rawDataSource );
2286 * Return data read flag for specified data source.
2288 gint addrindex_ds_read_data( AddressDataSource *ds ) {
2289 gint retVal = MGU_SUCCESS;
2290 AddressInterface *iface;
2292 if( ds == NULL ) return retVal;
2293 iface = ds->interface;
2294 if( iface == NULL ) return retVal;
2295 if( iface->getReadData ) {
2296 retVal = ( iface->getReadData ) ( ds->rawDataSource );
2302 * Return data read flag for specified data source.
2304 ItemFolder *addrindex_ds_get_root_folder( AddressDataSource *ds ) {
2305 ItemFolder *retVal = NULL;
2306 AddressInterface *iface;
2308 if( ds == NULL ) return retVal;
2309 iface = ds->interface;
2310 if( iface == NULL ) return retVal;
2311 if( iface->getRootFolder ) {
2312 retVal = ( iface->getRootFolder ) ( ds->rawDataSource );
2318 * Return list of folders for specified data source.
2320 GList *addrindex_ds_get_list_folder( AddressDataSource *ds ) {
2321 GList *retVal = FALSE;
2322 AddressInterface *iface;
2324 if( ds == NULL ) return retVal;
2325 iface = ds->interface;
2326 if( iface == NULL ) return retVal;
2327 if( iface->getListFolder ) {
2328 retVal = ( iface->getListFolder ) ( ds->rawDataSource );
2334 * Return list of persons in root folder for specified data source.
2336 GList *addrindex_ds_get_list_person( AddressDataSource *ds ) {
2337 GList *retVal = FALSE;
2338 AddressInterface *iface;
2340 if( ds == NULL ) return retVal;
2341 iface = ds->interface;
2342 if( iface == NULL ) return retVal;
2343 if( iface->getListPerson ) {
2344 retVal = ( iface->getListPerson ) ( ds->rawDataSource );
2350 * Return name for specified data source.
2352 gchar *addrindex_ds_get_name( AddressDataSource *ds ) {
2353 gchar *retVal = FALSE;
2354 AddressInterface *iface;
2356 if( ds == NULL ) return retVal;
2357 iface = ds->interface;
2358 if( iface == NULL ) return retVal;
2359 if( iface->getName ) {
2360 retVal = ( iface->getName ) ( ds->rawDataSource );
2366 * Set the access flag inside the data source.
2368 void addrindex_ds_set_access_flag( AddressDataSource *ds, gboolean *value ) {
2369 AddressInterface *iface;
2371 if( ds == NULL ) return;
2372 iface = ds->interface;
2373 if( iface == NULL ) return;
2374 if( iface->setAccessFlag ) {
2375 ( iface->setAccessFlag ) ( ds->rawDataSource, value );
2380 * Return read only flag for specified data source.
2382 gboolean addrindex_ds_get_readonly( AddressDataSource *ds ) {
2383 AddressInterface *iface;
2384 if( ds == NULL ) return TRUE;
2385 iface = ds->interface;
2386 if( iface == NULL ) return TRUE;
2387 return iface->readOnly;
2391 * Return list of all persons for specified data source.
2393 GList *addrindex_ds_get_all_persons( AddressDataSource *ds ) {
2394 GList *retVal = NULL;
2395 AddressInterface *iface;
2397 if( ds == NULL ) return retVal;
2398 iface = ds->interface;
2399 if( iface == NULL ) return retVal;
2400 if( iface->getAllPersons ) {
2401 retVal = ( iface->getAllPersons ) ( ds->rawDataSource );
2407 * Return list of all groups for specified data source.
2409 GList *addrindex_ds_get_all_groups( AddressDataSource *ds ) {
2410 GList *retVal = NULL;
2411 AddressInterface *iface;
2413 if( ds == NULL ) return retVal;
2414 iface = ds->interface;
2415 if( iface == NULL ) return retVal;
2416 if( iface->getAllGroups ) {
2417 retVal = ( iface->getAllGroups ) ( ds->rawDataSource );
2422 /* **********************************************************************
2423 * Address search stuff.
2424 * ***********************************************************************
2428 * Current query ID. This is incremented for each query created.
2430 static gint _currentQueryID_ = 0;
2433 * Variables for the search that is being performed.
2435 static gchar *_searchTerm_ = NULL;
2436 static gpointer _searchTarget_ = NULL;
2437 static AddrSearchCallbackFunc *_searchCallback_ = NULL;
2440 * Setup or register the search that will be performed.
2441 * \param addrIndex Address index object.
2442 * \param searchTerm Search term. A private copy will be made.
2443 * \param target Target object that will receive data.
2444 * \param callBack Callback function.
2445 * \return ID allocated to query that will be executed.
2447 gint addrindex_setup_search(
2448 AddressIndex *addrIndex, const gchar *searchTerm,
2449 const gpointer target, AddrSearchCallbackFunc callBack )
2453 /* printf( "search term ::%s::\n", searchTerm ); */
2454 g_free( _searchTerm_ );
2455 _searchTerm_ = g_strdup( searchTerm );
2457 queryID = ++_currentQueryID_;
2458 _searchTarget_ = target;
2459 _searchCallback_ = callBack;
2460 /* printf( "query ID ::%d::\n", queryID ); */
2465 * Perform the search for specified address cache.
2466 * \param cache Cache to be searched.
2467 * \param queryID ID of search query to be executed.
2469 static void addrindex_search_cache( AddressCache *cache, const gint queryID ) {
2470 AddrCacheIndex *index;
2473 index = cache->searchIndex;
2474 if( index == NULL ) return;
2475 if( index->invalid ) {
2476 addrcache_build_index( cache );
2480 printf( "query ::%d:: searching index for ::%s::\n", queryID, _searchTerm_ );
2482 listEMail = addrcindex_search( index, _searchTerm_ );
2483 ( _searchCallback_ ) ( queryID, listEMail, _searchTarget_ );
2484 g_list_free( listEMail );
2486 /* printf( "searching index done\n" ); */
2491 * LDAP callback entry point for each address entry found.
2492 * \param qry LDAP query.
2493 * \param listEMail List of Item EMail objects found.
2495 static void addrindex_ldap_entry_cb( LdapQuery *qry, GList *listEMail ) {
2499 printf( "\naddrindex::addrindex_ldap_entry_cb ::%s::\n", qry->queryName );
2503 ItemEMail *email = node->data;
2504 /* printf( "\temail ::%s::\n", email->address ); */
2505 node = g_list_next( node );
2507 if( _searchCallback_ ) {
2508 ( _searchCallback_ ) ( qry->queryID, listEMail, _searchTarget_ );
2510 g_list_free( listEMail );
2514 * LDAP callback entry point for completion of search.
2515 * \param qry LDAP query.
2517 static void addrindex_ldap_end_cb( LdapQuery *qry ) {
2518 /* printf( "\naddrindex::addrindex_ldap_end_cb ::%s::\n", qry->queryName ); */
2522 * Return results of previous query.
2524 * \return List of ItemEMail objects.
2526 static void addrindex_ldap_use_previous( const ItemFolder *folder, const gint queryID )
2533 if( _searchCallback_ ) {
2534 node = folder->listPerson;
2536 AddrItemObject *aio = node->data;
2537 if( aio && aio->type == ITEMTYPE_PERSON ) {
2538 ItemPerson *person = node->data;
2539 nodeEM = person->listEMail;
2541 ItemEMail *email = nodeEM->data;
2542 nodeEM = g_list_next( nodeEM );
2543 listEMail = g_list_append( listEMail, email );
2546 node = g_list_next( node );
2548 ( _searchCallback_ ) ( queryID, listEMail, _searchTarget_ );
2549 g_list_free( listEMail );
2553 LdapQuery *ldapsvr_locate_query( LdapServer *server, const gchar *searchTerm );
2556 * Construct an LDAP query and initiate an LDAP search.
2557 * \param server LDAP server object.
2558 * \param queryID ID of search query to be executed.
2560 static void addrindex_search_ldap( LdapServer *server, const gint queryID ) {
2564 if( ! server->searchFlag ) return;
2565 /* printf( "Searching ::%s::\n", ldapsvr_get_name( server ) ); */
2567 /* Retire any aged queries */
2568 ldapsvr_retire_query( server );
2570 /* Test whether any queries for the same term exist */
2571 qry = ldapsvr_locate_query( server, _searchTerm_ );
2573 ItemFolder *folder = qry->folder;
2575 /* Touch query to ensure it hangs around for a bit longer */
2576 ldapqry_touch( qry );
2578 addrindex_ldap_use_previous( folder, queryID );
2583 /* Construct a query */
2584 qry = ldapqry_create();
2585 ldapqry_set_query_id( qry, queryID );
2586 ldapqry_set_search_value( qry, _searchTerm_ );
2587 ldapqry_set_query_type( qry, LDAPQUERY_DYNAMIC );
2588 ldapqry_set_callback_entry( qry, addrindex_ldap_entry_cb );
2589 ldapqry_set_callback_end( qry, addrindex_ldap_end_cb );
2591 /* Name the query */
2592 name = g_strdup_printf( "Search for '%s'", _searchTerm_ );
2593 ldapqry_set_name( qry, name );
2596 ldapsvr_add_query( server, qry );
2597 /* printf( "addrindex_search_ldap::executing dynamic search...\n" ); */
2598 ldapsvr_execute_query( server, qry );
2602 * Construct an LDAP query and initiate an LDAP search.
2603 * \param server LDAP server object to search.
2604 * \param searchTerm Search term to locate.
2605 * \param callbackEnd Function to call when search has terminated.
2608 void addrindex_search_ldap_noid(
2609 LdapServer *server, const gchar *searchTerm, void * callbackEnd )
2614 /* Construct a query */
2615 qry = ldapqry_create();
2616 ldapqry_set_search_value( qry, searchTerm );
2617 ldapqry_set_query_type( qry, LDAPQUERY_STATIC );
2618 ldapqry_set_callback_end( qry, callbackEnd );
2620 /* Name the query */
2621 name = g_strdup_printf( "Static Search for '%s'", searchTerm );
2622 ldapqry_set_name( qry, name );
2625 ldapsvr_add_query( server, qry );
2626 /* printf( "addrindex_search_ldap_noid::executing static search...\n" ); */
2627 ldapsvr_execute_query( server, qry );
2632 * Perform the previously registered search.
2633 * \param addrIndex Address index object.
2634 * \param queryID ID of search query to be executed.
2635 * \return <i>TRUE</i> if search started successfully, or <i>FALSE</i> if
2638 gboolean addrindex_start_search( AddressIndex *addrIndex, const gint queryID ) {
2639 AddressInterface *iface;
2640 AddressDataSource *ds;
2641 AddressCache *cache;
2646 /* printf( "addrindex_start_search::%d::\n", queryID ); */
2647 nodeIf = addrIndex->searchOrder;
2649 iface = nodeIf->data;
2650 nodeIf = g_list_next( nodeIf );
2652 if( ! iface->useInterface ) {
2657 nodeDS = iface->listSource;
2660 nodeDS = g_list_next( nodeDS );
2663 if( type == ADDR_IF_BOOK ) {
2664 AddressBookFile *abf = ds->rawDataSource;
2665 cache = abf->addressCache;
2667 else if( type == ADDR_IF_VCARD ) {
2668 VCardFile *vcf = ds->rawDataSource;
2669 cache = vcf->addressCache;
2672 else if( type == ADDR_IF_JPILOT ) {
2673 JPilotFile *jpf = ds->rawDataSource;
2674 cache = jpf->addressCache;
2678 else if( type == ADDR_IF_LDAP ) {
2679 LdapServer *server = ds->rawDataSource;
2680 addrindex_search_ldap( server, queryID );
2684 addrindex_search_cache( cache, queryID );
2692 * Stop the previously registered search.
2693 * \param addrIndex Address index object.
2694 * \param queryID ID of search query to stop.
2696 void addrindex_stop_search( AddressIndex *addrIndex, const gint queryID ){
2698 AddressInterface *iface;
2699 AddressDataSource *ds;
2704 /* If query ID does not match, search has not been setup */
2705 /* if( queryID != _queryID_ ) return; */
2707 /* printf( "addrindex_stop_search::%d::\n", queryID ); */
2708 nodeIf = addrIndex->searchOrder;
2710 iface = nodeIf->data;
2711 nodeIf = g_list_next( nodeIf );
2713 if( ! iface->useInterface ) {
2718 nodeDS = iface->listSource;
2721 nodeDS = g_list_next( nodeDS );
2722 if( type == ADDR_IF_LDAP ) {
2723 LdapServer *server = ds->rawDataSource;
2724 ldapsvr_stop_all_query( server );
2732 * Read all address books that do not support dynamic queries.
2733 * \param addrIndex Address index object.
2735 void addrindex_read_all( AddressIndex *addrIndex ) {
2736 AddressInterface *iface;
2737 AddressDataSource *ds;
2741 nodeIf = addrIndex->searchOrder;
2743 iface = nodeIf->data;
2744 nodeIf = g_list_next( nodeIf );
2746 if( ! iface->useInterface ) {
2749 if( iface->externalQuery ) {
2752 nodeDS = iface->listSource;
2755 nodeDS = g_list_next( nodeDS );
2757 /* Read address book */
2758 if( addrindex_ds_get_modify_flag( ds ) ) {
2759 addrindex_ds_read_data( ds );
2763 if( ! addrindex_ds_get_read_flag( ds ) ) {
2764 addrindex_ds_read_data( ds );
2769 addrIndex->loadedFlag = TRUE;
2773 * Perform a simple search of all non-query type data sources for specified
2774 * search term. If several entries are found, only the first item is
2775 * returned. Interfaces that require a time-consuming "external query" are
2776 * ignored for this search.
2778 * \param addrIndex Address index object.
2779 * \param searchTerm Search term to find. Typically an email address.
2780 * \return List of references to zero or mail E-Mail object that was found in
2781 * the address books, or <i>NULL</i> if nothing found. This list
2782 * *SHOULD* be freed when done.
2784 GList *addrindex_quick_search_list(
2785 AddressIndex *addrIndex, const gchar *searchTerm )
2787 GList *listRet = NULL;
2789 AddressInterface *iface;
2790 AddressDataSource *ds;
2791 AddressCache *cache;
2792 AddrCacheIndex *index;
2799 nodeIf = addrIndex->searchOrder;
2801 iface = nodeIf->data;
2802 nodeIf = g_list_next( nodeIf );
2804 if( ! iface->useInterface ) {
2805 /* Ignore interfaces that don't have a library */
2808 if( iface->externalQuery ) {
2809 /* Ignore interfaces that require a "query" */
2814 nodeDS = iface->listSource;
2817 nodeDS = g_list_next( nodeDS );
2820 if( type == ADDR_IF_BOOK ) {
2821 AddressBookFile *abf = ds->rawDataSource;
2822 cache = abf->addressCache;
2824 else if( type == ADDR_IF_VCARD ) {
2825 VCardFile *vcf = ds->rawDataSource;
2826 cache = vcf->addressCache;
2829 else if( type == ADDR_IF_JPILOT ) {
2830 JPilotFile *jpf = ds->rawDataSource;
2831 cache = jpf->addressCache;
2835 index = cache->searchIndex;
2836 if( index == NULL ) {
2839 if( index->invalid ) {
2840 addrcache_build_index( cache );
2842 listEMail = addrcindex_search( index, searchTerm );
2845 email = listEMail->data;
2846 listRet = g_list_append( listRet, email );
2847 nodeEM = g_list_next( nodeEM );
2849 g_list_free( listEMail );
2857 * Perform a simple search of all non-query type data sources for specified
2858 * search term. If several entries are found, only the first item is
2859 * returned. Interfaces that require a time-consuming "external query" are
2860 * ignored for this search.
2862 * \param addrIndex Address index object.
2863 * \param searchTerm Search term to find. Typically an email address.
2864 * \return Reference to a single E-Mail object that was found in the address
2865 * book, or <i>NULL</i> if nothing found. This should *NOT* be freed
2868 ItemEMail *addrindex_quick_search_single(
2869 AddressIndex *addrIndex, const gchar *searchTerm )
2871 ItemEMail *email = NULL;
2872 AddressInterface *iface;
2873 AddressDataSource *ds;
2874 AddressCache *cache;
2875 AddrCacheIndex *index;
2881 /* printf( "addrindex_quick_search::%s::\n", searchTerm ); */
2882 nodeIf = addrIndex->searchOrder;
2884 iface = nodeIf->data;
2885 nodeIf = g_list_next( nodeIf );
2887 if( ! iface->useInterface ) {
2890 if( iface->externalQuery ) {
2895 nodeDS = iface->listSource;
2898 nodeDS = g_list_next( nodeDS );
2901 if( type == ADDR_IF_BOOK ) {
2902 AddressBookFile *abf = ds->rawDataSource;
2903 cache = abf->addressCache;
2905 else if( type == ADDR_IF_VCARD ) {
2906 VCardFile *vcf = ds->rawDataSource;
2907 cache = vcf->addressCache;
2910 else if( type == ADDR_IF_JPILOT ) {
2911 JPilotFile *jpf = ds->rawDataSource;
2912 cache = jpf->addressCache;
2916 index = cache->searchIndex;
2917 if( index == NULL ) {
2920 if( index->invalid ) {
2921 addrcache_build_index( cache );
2924 listEMail = addrcindex_search( index, searchTerm );
2926 email = listEMail->data;
2928 g_list_free( listEMail );