2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2007 Match Grun and the Claws Mail team
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 3 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, see <http://www.gnu.org/licenses/>.
21 * General functions for accessing address index file.
31 #include <glib/gi18n.h>
35 #include "addrcache.h"
37 #include "addressbook.h"
38 #include "addrindex.h"
40 #include "addrquery.h"
41 #include "addr_compl.h"
43 #include "alertpanel.h"
45 #ifndef DEV_STANDALONE
46 #include "prefs_gtk.h"
57 #include "ldapserver.h"
59 #include "ldapquery.h"
60 #include "ldapupdate.h"
64 #define TAG_ADDRESS_INDEX "addressbook"
66 #define TAG_IF_ADDRESS_BOOK "book_list"
67 #define TAG_IF_VCARD "vcard_list"
68 #define TAG_IF_JPILOT "jpilot_list"
69 #define TAG_IF_LDAP "ldap_list"
71 #define TAG_DS_ADDRESS_BOOK "book"
72 #define TAG_DS_VCARD "vcard"
73 #define TAG_DS_JPILOT "jpilot"
74 #define TAG_DS_LDAP "server"
76 /* XML Attribute names */
77 #define ATTAG_BOOK_NAME "name"
78 #define ATTAG_BOOK_FILE "file"
80 #define ATTAG_VCARD_NAME "name"
81 #define ATTAG_VCARD_FILE "file"
83 #define ATTAG_JPILOT_NAME "name"
84 #define ATTAG_JPILOT_FILE "file"
85 #define ATTAG_JPILOT_CUSTOM_1 "custom-1"
86 #define ATTAG_JPILOT_CUSTOM_2 "custom-2"
87 #define ATTAG_JPILOT_CUSTOM_3 "custom-3"
88 #define ATTAG_JPILOT_CUSTOM_4 "custom-4"
89 #define ATTAG_JPILOT_CUSTOM "custom-"
91 #define ATTAG_LDAP_NAME "name"
92 #define ATTAG_LDAP_HOST "host"
93 #define ATTAG_LDAP_PORT "port"
94 #define ATTAG_LDAP_BASE_DN "base-dn"
95 #define ATTAG_LDAP_BIND_DN "bind-dn"
96 #define ATTAG_LDAP_BIND_PASS "bind-pass"
97 #define ATTAG_LDAP_CRITERIA "criteria"
98 #define ATTAG_LDAP_MAX_ENTRY "max-entry"
99 #define ATTAG_LDAP_TIMEOUT "timeout"
100 #define ATTAG_LDAP_MAX_AGE "max-age"
101 #define ATTAG_LDAP_DYN_SEARCH "dyn-search"
102 #define ATTAG_LDAP_MATCH_OPT "match-opt"
103 #define ATTAG_LDAP_ENABLE_TLS "enable-tls"
104 #define ATTAG_LDAP_ENABLE_SSL "enable-ssl"
106 #define ELTAG_LDAP_ATTR_SRCH "attribute"
107 #define ATTAG_LDAP_ATTR_NAME "name"
109 /* Attribute values */
110 #define ATVAL_BOOLEAN_YES "yes"
111 #define ATVAL_BOOLEAN_NO "no"
112 #define ATVAL_LDAP_MATCH_BEGIN "begin-with"
113 #define ATVAL_LDAP_MATCH_CONTAINS "contains"
116 #define ATTAG_LDAP_DEFAULT "default"
118 #define DISP_NEW_COMMON _("Common addresses")
119 #define DISP_NEW_PERSONAL _("Personal addresses")
121 /* Old address book */
122 #define TAG_IF_OLD_COMMON "common_address"
123 #define TAG_IF_OLD_PERSONAL "personal_address"
125 #define DISP_OLD_COMMON _("Common address")
126 #define DISP_OLD_PERSONAL _("Personal address")
131 static AddressIndex *_addressIndex_ = NULL;
134 * Define attribute name-value pair.
136 typedef struct _AddressIfAttr AddressIfAttrib;
137 struct _AddressIfAttr {
142 static AddressDataSource *addrindex_create_datasource ( AddressIfType ifType );
144 static GList *addrindex_ds_get_all_persons ( AddressDataSource *ds );
145 static GList *addrindex_ds_get_all_groups ( AddressDataSource *ds );
146 static AddressDataSource *addrindex_get_datasource ( AddressIndex *addrIndex,
147 const gchar *cacheID );
148 static AddressInterface *addrindex_get_interface ( AddressIndex *addrIndex,
149 AddressIfType ifType );
150 static gint addrindex_write_to ( AddressIndex *addrIndex,
151 const gchar *newFile );
154 * Define DOM fragment.
156 typedef struct _AddressIfFrag AddressIfFragment;
157 struct _AddressIfFrag {
164 * Build interface with default values.
166 * \param type Interface type.
167 * \param name Interface name.
168 * \param tagIf XML tag name for interface in address index file.
169 * \param tagDS XML tag name for datasource in address index file.
170 * \return Address interface object.
172 static AddressInterface *addrindex_create_interface(
173 gint type, gchar *name, gchar *tagIf, gchar *tagDS )
175 AddressInterface *iface = g_new0( AddressInterface, 1 );
177 ADDRITEM_TYPE(iface) = ITEMTYPE_INTERFACE;
178 ADDRITEM_ID(iface) = NULL;
179 ADDRITEM_NAME(iface) = g_strdup( name );
180 ADDRITEM_PARENT(iface) = NULL;
181 ADDRITEM_SUBTYPE(iface) = type;
183 iface->name = g_strdup( name );
184 iface->listTag = g_strdup( tagIf );
185 iface->itemTag = g_strdup( tagDS );
186 iface->legacyFlag = FALSE;
187 iface->haveLibrary = TRUE;
188 iface->useInterface = TRUE;
189 iface->readOnly = TRUE;
191 /* Set callbacks to NULL values - override for each interface */
192 iface->getAccessFlag = NULL;
193 iface->getModifyFlag = NULL;
194 iface->getReadFlag = NULL;
195 iface->getStatusCode = NULL;
196 iface->getReadData = NULL;
197 iface->getRootFolder = NULL;
198 iface->getListFolder = NULL;
199 iface->getListPerson = NULL;
200 iface->getAllPersons = NULL;
201 iface->getAllGroups = NULL;
202 iface->getName = NULL;
203 iface->listSource = NULL;
206 iface->externalQuery = FALSE;
207 iface->searchOrder = 0; /* Ignored */
208 iface->startSearch = NULL;
209 iface->stopSearch = NULL;
215 * Build table of of all address book interfaces.
216 * \param addrIndex Address index object.
218 static void addrindex_build_if_list( AddressIndex *addrIndex ) {
219 AddressInterface *iface;
221 /* Create intrinsic XML address book interface */
222 iface = addrindex_create_interface(
223 ADDR_IF_BOOK, "Address Book", TAG_IF_ADDRESS_BOOK,
224 TAG_DS_ADDRESS_BOOK );
225 iface->readOnly = FALSE;
226 iface->getModifyFlag = ( void * ) addrbook_get_modified;
227 iface->getAccessFlag = ( void * ) addrbook_get_accessed;
228 iface->getReadFlag = ( void * ) addrbook_get_read_flag;
229 iface->getStatusCode = ( void * ) addrbook_get_status;
230 iface->getReadData = ( void * ) addrbook_read_data;
231 iface->getRootFolder = ( void * ) addrbook_get_root_folder;
232 iface->getListFolder = ( void * ) addrbook_get_list_folder;
233 iface->getListPerson = ( void * ) addrbook_get_list_person;
234 iface->getAllPersons = ( void * ) addrbook_get_all_persons;
235 iface->getAllGroups = ( void * ) addrbook_get_all_groups;
236 iface->getName = ( void * ) addrbook_get_name;
237 iface->setAccessFlag = ( void * ) addrbook_set_accessed;
238 iface->searchOrder = 0;
240 /* Add to list of interfaces in address book */
241 addrIndex->interfaceList =
242 g_list_append( addrIndex->interfaceList, iface );
243 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
245 /* Create vCard interface */
246 iface = addrindex_create_interface(
247 ADDR_IF_VCARD, "vCard", TAG_IF_VCARD, TAG_DS_VCARD );
248 iface->getModifyFlag = ( void * ) vcard_get_modified;
249 iface->getAccessFlag = ( void * ) vcard_get_accessed;
250 iface->getReadFlag = ( void * ) vcard_get_read_flag;
251 iface->getStatusCode = ( void * ) vcard_get_status;
252 iface->getReadData = ( void * ) vcard_read_data;
253 iface->getRootFolder = ( void * ) vcard_get_root_folder;
254 iface->getListFolder = ( void * ) vcard_get_list_folder;
255 iface->getListPerson = ( void * ) vcard_get_list_person;
256 iface->getAllPersons = ( void * ) vcard_get_all_persons;
257 iface->getName = ( void * ) vcard_get_name;
258 iface->setAccessFlag = ( void * ) vcard_set_accessed;
259 iface->searchOrder = 0;
260 addrIndex->interfaceList =
261 g_list_append( addrIndex->interfaceList, iface );
262 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
264 /* Create JPilot interface */
265 iface = addrindex_create_interface(
266 ADDR_IF_JPILOT, "J-Pilot", TAG_IF_JPILOT,
269 iface->haveLibrary = jpilot_test_pilot_lib();
270 iface->useInterface = iface->haveLibrary;
271 iface->getModifyFlag = ( void * ) jpilot_get_modified;
272 iface->getAccessFlag = ( void * ) jpilot_get_accessed;
273 iface->getReadFlag = ( void * ) jpilot_get_read_flag;
274 iface->getStatusCode = ( void * ) jpilot_get_status;
275 iface->getReadData = ( void * ) jpilot_read_data;
276 iface->getRootFolder = ( void * ) jpilot_get_root_folder;
277 iface->getListFolder = ( void * ) jpilot_get_list_folder;
278 iface->getListPerson = ( void * ) jpilot_get_list_person;
279 iface->getAllPersons = ( void * ) jpilot_get_all_persons;
280 iface->getName = ( void * ) jpilot_get_name;
281 iface->setAccessFlag = ( void * ) jpilot_set_accessed;
282 iface->searchOrder = 0;
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 /* Create LDAP interface */
292 iface = addrindex_create_interface(
293 ADDR_IF_LDAP, "LDAP", TAG_IF_LDAP, TAG_DS_LDAP );
295 iface->readOnly = FALSE;
296 /* iface->haveLibrary = ldapsvr_test_ldap_lib(); */
297 iface->haveLibrary = ldaputil_test_ldap_lib();
298 iface->useInterface = iface->haveLibrary;
299 iface->getModifyFlag = ( void * ) ldapsvr_get_modified;
300 iface->getAccessFlag = ( void * ) ldapsvr_get_accessed;
301 iface->getReadFlag = ( void * ) ldapsvr_get_read_flag;
302 iface->getStatusCode = ( void * ) ldapsvr_get_status;
303 iface->getReadData = ( void * ) ldapsvr_read_data;
304 iface->getRootFolder = ( void * ) ldapsvr_get_root_folder;
305 iface->getListFolder = ( void * ) ldapsvr_get_list_folder;
306 iface->getListPerson = ( void * ) ldapsvr_get_list_person;
307 iface->getName = ( void * ) ldapsvr_get_name;
308 iface->setAccessFlag = ( void * ) ldapsvr_set_accessed;
309 iface->externalQuery = TRUE;
310 iface->searchOrder = 1;
312 iface->useInterface = FALSE;
313 iface->haveLibrary = FALSE;
315 addrIndex->interfaceList =
316 g_list_append( addrIndex->interfaceList, iface );
317 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
319 /* Two old legacy data sources (pre 0.7.0) */
320 iface = addrindex_create_interface(
321 ADDR_IF_COMMON, "Old Address - common",
322 TAG_IF_OLD_COMMON, NULL );
323 iface->legacyFlag = TRUE;
324 addrIndex->interfaceList =
325 g_list_append( addrIndex->interfaceList, iface );
326 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
328 iface = addrindex_create_interface(
329 ADDR_IF_COMMON, "Old Address - personal",
330 TAG_IF_OLD_PERSONAL, NULL );
331 iface->legacyFlag = TRUE;
332 addrIndex->interfaceList =
333 g_list_append( addrIndex->interfaceList, iface );
334 ADDRITEM_PARENT(iface) = ADDRITEM_OBJECT(addrIndex);
340 * \param fragment Fragment to free.
342 static void addrindex_free_fragment( AddressIfFragment *fragment ) {
346 node = fragment->children;
348 AddressIfFragment *child = node->data;
349 addrindex_free_fragment( child );
351 node = g_list_next( node );
353 g_list_free( fragment->children );
355 /* Free attributes */
356 node = fragment->attributes;
358 AddressIfAttrib *nv = node->data;
363 node = g_list_next( node );
365 g_list_free( fragment->attributes );
367 g_free( fragment->name );
368 fragment->name = NULL;
369 fragment->attributes = NULL;
370 fragment->children = NULL;
376 * Create a new data source.
377 * \param ifType Interface type to create.
378 * \return Initialized data source.
380 AddressDataSource *addrindex_create_datasource( AddressIfType ifType ) {
381 AddressDataSource *ds = g_new0( AddressDataSource, 1 );
383 ADDRITEM_TYPE(ds) = ITEMTYPE_DATASOURCE;
384 ADDRITEM_ID(ds) = NULL;
385 ADDRITEM_NAME(ds) = NULL;
386 ADDRITEM_PARENT(ds) = NULL;
387 ADDRITEM_SUBTYPE(ds) = 0;
389 ds->rawDataSource = NULL;
390 ds->interface = NULL;
395 * Free up data source.
396 * \param ds Data source to free.
398 void addrindex_free_datasource( AddressDataSource *ds ) {
399 AddressInterface *iface;
401 g_return_if_fail( ds != NULL );
403 iface = ds->interface;
404 if( ds->rawDataSource != NULL ) {
405 if( iface != NULL ) {
406 if( iface->useInterface ) {
407 if( iface->type == ADDR_IF_BOOK ) {
408 AddressBookFile *abf = ds->rawDataSource;
409 addrbook_free_book( abf );
411 else if( iface->type == ADDR_IF_VCARD ) {
412 VCardFile *vcf = ds->rawDataSource;
416 else if( iface->type == ADDR_IF_JPILOT ) {
417 JPilotFile *jpf = ds->rawDataSource;
422 else if( iface->type == ADDR_IF_LDAP ) {
423 LdapServer *server = ds->rawDataSource;
424 ldapsvr_free( server );
431 AddressIfFragment *fragment = ds->rawDataSource;
432 addrindex_free_fragment( fragment );
437 ADDRITEM_TYPE(ds) = ITEMTYPE_NONE;
438 ADDRITEM_ID(ds) = NULL;
439 ADDRITEM_NAME(ds) = NULL;
440 ADDRITEM_PARENT(ds) = NULL;
441 ADDRITEM_SUBTYPE(ds) = 0;
442 ds->type = ADDR_IF_NONE;
443 ds->interface = NULL;
444 ds->rawDataSource = NULL;
450 * Free up all data sources for specified interface.
451 * \param iface Address interface to process.
453 static void addrindex_free_all_datasources( AddressInterface *iface ) {
454 GList *node = iface->listSource;
456 AddressDataSource *ds = node->data;
457 addrindex_free_datasource( ds );
459 node = g_list_next( node );
464 * Free up specified interface.
465 * \param iface Interface to process.
467 static void addrindex_free_interface( AddressInterface *iface ) {
468 /* Free up data sources */
469 addrindex_free_all_datasources( iface );
470 g_list_free( iface->listSource );
472 /* Free internal storage */
473 g_free( ADDRITEM_ID(iface) );
474 g_free( ADDRITEM_NAME(iface) );
475 g_free( iface->name );
476 g_free( iface->listTag );
477 g_free( iface->itemTag );
479 /* Clear all pointers */
480 ADDRITEM_TYPE(iface) = ITEMTYPE_NONE;
481 ADDRITEM_ID(iface) = NULL;
482 ADDRITEM_NAME(iface) = NULL;
483 ADDRITEM_PARENT(iface) = NULL;
484 ADDRITEM_SUBTYPE(iface) = 0;
485 iface->type = ADDR_IF_NONE;
487 iface->listTag = NULL;
488 iface->itemTag = NULL;
489 iface->legacyFlag = FALSE;
490 iface->useInterface = FALSE;
491 iface->haveLibrary = FALSE;
492 iface->listSource = NULL;
495 iface->searchOrder = 0;
496 iface->startSearch = NULL;
497 iface->stopSearch = NULL;
503 * Return cache ID for specified data source.
505 * \param addrIndex Address index.
506 * \param ds Data source.
507 * \return ID or NULL if not found. This should be <code>g_free()</code>
510 gchar *addrindex_get_cache_id( AddressIndex *addrIndex, AddressDataSource *ds ) {
511 gchar *cacheID = NULL;
512 AddrBookBase *adbase;
515 g_return_val_if_fail( addrIndex != NULL, NULL );
516 g_return_val_if_fail( ds != NULL, NULL );
518 adbase = ( AddrBookBase * ) ds->rawDataSource;
520 cache = adbase->addressCache;
522 cacheID = g_strdup( cache->cacheID );
530 * Return reference to data source for specified cacheID.
531 * \param addrIndex Address index.
533 * \return Data source, or NULL if not found.
535 static AddressDataSource *addrindex_get_datasource(
536 AddressIndex *addrIndex, const gchar *cacheID )
538 g_return_val_if_fail( addrIndex != NULL, NULL );
539 g_return_val_if_fail( cacheID != NULL, NULL );
540 return ( AddressDataSource * ) g_hash_table_lookup( addrIndex->hashCache, cacheID );
544 * Return reference to address cache for specified cacheID.
545 * \param addrIndex Address index.
547 * \return Address cache, or NULL if not found.
549 AddressCache *addrindex_get_cache( AddressIndex *addrIndex, const gchar *cacheID ) {
550 AddressDataSource *ds;
551 AddrBookBase *adbase;
554 g_return_val_if_fail( addrIndex != NULL, NULL );
555 g_return_val_if_fail( cacheID != NULL, NULL );
558 ds = addrindex_get_datasource( addrIndex, cacheID );
560 adbase = ( AddrBookBase * ) ds->rawDataSource;
561 cache = adbase->addressCache;
567 * Add data source into hash table.
568 * \param addrIndex Address index.
569 * \param ds Data source.
571 static void addrindex_hash_add_cache(
572 AddressIndex *addrIndex, AddressDataSource *ds )
576 cacheID = addrindex_get_cache_id( addrIndex, ds );
578 g_hash_table_insert( addrIndex->hashCache, cacheID, ds );
583 * Free hash table callback function.
585 static gboolean addrindex_free_cache_cb( gpointer key, gpointer value, gpointer data ) {
593 * Free hash table of address cache items.
595 static void addrindex_free_cache_hash( GHashTable *table ) {
596 g_hash_table_foreach_remove( table, addrindex_free_cache_cb, NULL );
597 g_hash_table_destroy( table );
601 * Remove data source from internal hashtable.
602 * \param addrIndex Address index.
603 * \param ds Data source to remove.
605 static void addrindex_hash_remove_cache(
606 AddressIndex *addrIndex, AddressDataSource *ds )
610 cacheID = addrindex_get_cache_id( addrIndex, ds );
612 g_hash_table_remove( addrIndex->hashCache, cacheID );
619 * Create a new address index. This is created as a singleton object.
620 * \return Initialized address index object.
622 AddressIndex *addrindex_create_index( void ) {
625 if( _addressIndex_ == NULL ) {
626 index = g_new0( AddressIndex, 1 );
627 ADDRITEM_TYPE(index) = ITEMTYPE_INDEX;
628 ADDRITEM_ID(index) = NULL;
629 ADDRITEM_NAME(index) = g_strdup( "Address Index" );
630 ADDRITEM_PARENT(index) = NULL;
631 ADDRITEM_SUBTYPE(index) = 0;
632 index->filePath = NULL;
633 index->fileName = NULL;
634 index->retVal = MGU_SUCCESS;
635 index->needsConversion = FALSE;
636 index->wasConverted = FALSE;
637 index->conversionError = FALSE;
638 index->interfaceList = NULL;
639 index->lastType = ADDR_IF_NONE;
640 index->dirtyFlag = FALSE;
641 index->hashCache = g_hash_table_new( g_str_hash, g_str_equal );
642 index->loadedFlag = FALSE;
643 index->searchOrder = NULL;
644 addrindex_build_if_list( index );
645 _addressIndex_ = index;
647 return _addressIndex_;
651 * Property - Specify file path to address index file.
652 * \param addrIndex Address index.
653 * \param value Path to index file.
655 void addrindex_set_file_path( AddressIndex *addrIndex, const gchar *value ) {
656 g_return_if_fail( addrIndex != NULL );
657 addrIndex->filePath = mgu_replace_string( addrIndex->filePath, value );
661 * Property - Specify file name to address index file.
662 * \param addrIndex Address index.
663 * \param value File name.
665 void addrindex_set_file_name( AddressIndex *addrIndex, const gchar *value ) {
666 g_return_if_fail( addrIndex != NULL );
667 addrIndex->fileName = mgu_replace_string( addrIndex->fileName, value );
671 * Return list of address interfaces.
672 * \param addrIndex Address index.
673 * \return List of address interfaces.
675 GList *addrindex_get_interface_list( AddressIndex *addrIndex ) {
676 g_return_val_if_fail( addrIndex != NULL, NULL );
677 return addrIndex->interfaceList;
681 * Perform any other initialization of address index.
683 void addrindex_initialize( void ) {
685 addrcompl_initialize();
689 * Perform any other teardown of address index.
691 void addrindex_teardown( void ) {
692 addrcompl_teardown();
697 * Free up address index.
698 * \param addrIndex Address index.
700 void addrindex_free_index( AddressIndex *addrIndex ) {
703 g_return_if_fail( addrIndex != NULL );
706 g_list_free( addrIndex->searchOrder );
707 addrIndex->searchOrder = NULL;
709 /* Free internal storage */
710 g_free( ADDRITEM_ID(addrIndex) );
711 g_free( ADDRITEM_NAME(addrIndex) );
712 g_free( addrIndex->filePath );
713 g_free( addrIndex->fileName );
716 ADDRITEM_TYPE(addrIndex) = ITEMTYPE_NONE;
717 ADDRITEM_ID(addrIndex) = NULL;
718 ADDRITEM_NAME(addrIndex) = NULL;
719 ADDRITEM_PARENT(addrIndex) = NULL;
720 ADDRITEM_SUBTYPE(addrIndex) = 0;
721 addrIndex->filePath = NULL;
722 addrIndex->fileName = NULL;
723 addrIndex->retVal = MGU_SUCCESS;
724 addrIndex->needsConversion = FALSE;
725 addrIndex->wasConverted = FALSE;
726 addrIndex->conversionError = FALSE;
727 addrIndex->lastType = ADDR_IF_NONE;
728 addrIndex->dirtyFlag = FALSE;
730 /* Free up interfaces */
731 node = addrIndex->interfaceList;
733 AddressInterface *iface = node->data;
734 addrindex_free_interface( iface );
735 node = g_list_next( node );
737 g_list_free( addrIndex->interfaceList );
738 addrIndex->interfaceList = NULL;
740 /* Free up hash cache */
741 addrindex_free_cache_hash( addrIndex->hashCache );
742 addrIndex->hashCache = NULL;
744 addrIndex->loadedFlag = FALSE;
748 _addressIndex_ = NULL;
752 * Print address index.
753 * \param addrIndex Address index.
754 * \parem stream Stream to print.
756 void addrindex_print_index( AddressIndex *addrIndex, FILE *stream ) {
757 g_return_if_fail( addrIndex != NULL );
758 fprintf( stream, "AddressIndex:\n" );
759 fprintf( stream, "\tfile path: '%s'\n", addrIndex->filePath );
760 fprintf( stream, "\tfile name: '%s'\n", addrIndex->fileName );
761 fprintf( stream, "\t status: %d\n", addrIndex->retVal );
762 fprintf( stream, "\tconverted: '%s'\n",
763 addrIndex->wasConverted ? "yes" : "no" );
764 fprintf( stream, "\tcvt error: '%s'\n",
765 addrIndex->conversionError ? "yes" : "no" );
766 fprintf( stream, "\t---\n" );
770 * Retrieve reference to address interface for specified interface type.
771 * \param addrIndex Address index.
772 * \param ifType Interface type.
773 * \return Address interface, or NULL if not found.
775 static AddressInterface *addrindex_get_interface(
776 AddressIndex *addrIndex, AddressIfType ifType )
778 AddressInterface *retVal = NULL;
781 g_return_val_if_fail( addrIndex != NULL, NULL );
783 node = addrIndex->interfaceList;
785 AddressInterface *iface = node->data;
786 node = g_list_next( node );
787 if( iface->type == ifType ) {
796 * Add raw data source to index. The raw data object (an AddressBookFile or
797 * VCardFile object, for example) should be supplied as the raw dataSource
800 * \param addrIndex Address index.
801 * \param ifType Interface type to add.
802 * \param dataSource Actual raw data source to add.
803 * \return Data source added, or NULL if invalid interface type.
805 AddressDataSource *addrindex_index_add_datasource(
806 AddressIndex *addrIndex, AddressIfType ifType, gpointer dataSource )
808 AddressInterface *iface;
809 AddressDataSource *ds = NULL;
811 g_return_val_if_fail( addrIndex != NULL, NULL );
812 g_return_val_if_fail( dataSource != NULL, NULL );
814 iface = addrindex_get_interface( addrIndex, ifType );
816 ds = addrindex_create_datasource( ifType );
817 ADDRITEM_PARENT(ds) = ADDRITEM_OBJECT(iface);
819 ds->rawDataSource = dataSource;
820 ds->interface = iface;
821 iface->listSource = g_list_append( iface->listSource, ds );
822 addrIndex->dirtyFlag = TRUE;
824 addrindex_hash_add_cache( addrIndex, ds );
830 * Remove specified data source from index.
831 * \param addrIndex Address index.
832 * \param dataSource Data source to add.
833 * \return Reference to data source if removed, or NULL if data source was not
834 * found in index. Note the this object must still be freed.
836 AddressDataSource *addrindex_index_remove_datasource(
837 AddressIndex *addrIndex, AddressDataSource *dataSource )
839 AddressDataSource *retVal = FALSE;
840 AddressInterface *iface;
842 g_return_val_if_fail( addrIndex != NULL, NULL );
843 g_return_val_if_fail( dataSource != NULL, NULL );
845 iface = addrindex_get_interface( addrIndex, dataSource->type );
847 iface->listSource = g_list_remove( iface->listSource, dataSource );
848 addrIndex->dirtyFlag = TRUE;
849 dataSource->interface = NULL;
851 /* Remove cache from hash table */
852 addrindex_hash_remove_cache( addrIndex, dataSource );
860 * Retrieve a reference to address interface for specified interface type and
861 * XML interface tag name.
862 * \param addrIndex Address index.
863 * \param tag XML interface tag name to match.
864 * \param ifType Interface type to match.
865 * \return Reference to address index, or NULL if not found in index.
867 static AddressInterface *addrindex_tag_get_interface(
868 AddressIndex *addrIndex, gchar *tag, AddressIfType ifType )
870 AddressInterface *retVal = NULL;
871 GList *node = addrIndex->interfaceList;
874 AddressInterface *iface = node->data;
875 node = g_list_next( node );
877 if( strcmp( iface->listTag, tag ) == 0 ) {
883 if( iface->type == ifType ) {
893 * Retrieve a reference to address interface for specified interface type and
894 * XML datasource tag name.
895 * \param addrIndex Address index.
896 * \param ifType Interface type to match.
897 * \param tag XML datasource tag name to match.
898 * \return Reference to address index, or NULL if not found in index.
900 static AddressInterface *addrindex_tag_get_datasource(
901 AddressIndex *addrIndex, AddressIfType ifType, gchar *tag )
903 AddressInterface *retVal = NULL;
904 GList *node = addrIndex->interfaceList;
907 AddressInterface *iface = node->data;
908 node = g_list_next( node );
909 if( iface->type == ifType && iface->itemTag ) {
910 if( strcmp( iface->itemTag, tag ) == 0 ) {
919 /* **********************************************************************
920 * Interface XML parsing functions.
921 * ***********************************************************************
925 * Write start of XML element to file.
927 * \param lvl Indentation level.
928 * \param name Element name.
930 static void addrindex_write_elem_s( FILE *fp, const gint lvl, const gchar *name ) {
932 for( i = 0; i < lvl; i++ ) fputs( " ", fp );
938 * Write end of XML element to file.
940 * \param lvl Indentation level.
941 * \param name Element name.
943 static void addrindex_write_elem_e( FILE *fp, const gint lvl, const gchar *name ) {
945 for( i = 0; i < lvl; i++ ) fputs( " ", fp );
952 * Write XML attribute to file.
954 * \param name Attribute name.
955 * \param value Attribute value.
957 static void addrindex_write_attr( FILE *fp, const gchar *name, const gchar *value ) {
961 xml_file_put_escape_str( fp, value );
966 * Return DOM fragment for current XML tag from file.
967 * \param file XML file being processed.
968 * \return Fragment representing DOM fragment for configuration element.
970 static AddressIfFragment *addrindex_read_fragment( XMLFile *file ) {
971 AddressIfFragment *fragment;
972 AddressIfFragment *child;
982 /* g_print( "addrindex_read_fragment\n" ); */
984 prevLevel = file->level;
986 /* Get current tag name */
987 xtag = xml_get_current_tag( file );
989 /* Create new fragment */
990 fragment = g_new0( AddressIfFragment, 1 );
991 fragment->name = g_strdup( xtag->tag );
992 fragment->children = NULL;
993 fragment->attributes = NULL;
995 /* Read attributes */
997 attr = xml_get_current_tag_attr( file );
999 name = ((XMLAttr *)attr->data)->name;
1000 value = ((XMLAttr *)attr->data)->value;
1001 nv = g_new0( AddressIfAttrib, 1 );
1002 nv->name = g_strdup( name );
1003 nv->value = g_strdup( value );
1004 list = g_list_append( list, nv );
1005 attr = g_list_next( attr );
1007 fragment->attributes = list;
1009 /* Now read the children */
1011 rc = xml_parse_next_tag( file );
1016 if( file->level < prevLevel ) {
1017 /* We must be above level we start at */
1020 child = addrindex_read_fragment( file );
1021 fragment->children = g_list_append( fragment->children, child );
1028 * Write DOM fragment to file.
1029 * \param fp File to write.
1030 * \param fragment DOM fragment for configuration element.
1031 * \param lvl Indent level.
1033 static void addrindex_write_fragment(
1034 FILE *fp, const AddressIfFragment *fragment, const gint lvl )
1039 addrindex_write_elem_s( fp, lvl, fragment->name );
1040 node = fragment->attributes;
1042 AddressIfAttrib *nv = node->data;
1043 addrindex_write_attr( fp, nv->name, nv->value );
1044 node = g_list_next( node );
1046 if( fragment->children ) {
1049 /* Output children */
1050 node = fragment->children;
1052 AddressIfFragment *child = node->data;
1053 addrindex_write_fragment( fp, child, 1+lvl );
1054 node = g_list_next( node );
1057 /* Output closing tag */
1058 addrindex_write_elem_e( fp, lvl, fragment->name );
1067 * Read/parse address index file, creating a data source for a regular
1068 * intrinsic XML addressbook.
1069 * \param file Address index file.
1070 * \return Data source.
1072 static AddressDataSource *addrindex_parse_book( XMLFile *file ) {
1073 AddressDataSource *ds;
1074 AddressBookFile *abf;
1077 ds = addrindex_create_datasource( ADDR_IF_BOOK );
1078 abf = addrbook_create_book();
1079 attr = xml_get_current_tag_attr( file );
1081 gchar *name = ((XMLAttr *)attr->data)->name;
1082 gchar *value = ((XMLAttr *)attr->data)->value;
1083 if( strcmp( name, ATTAG_BOOK_NAME ) == 0 ) {
1084 addrbook_set_name( abf, value );
1086 else if( strcmp( name, ATTAG_BOOK_FILE ) == 0) {
1087 addrbook_set_file( abf, value );
1089 attr = g_list_next( attr );
1091 ds->rawDataSource = abf;
1095 static void addrindex_write_book( FILE *fp, AddressDataSource *ds, gint lvl ) {
1096 AddressBookFile *abf = ds->rawDataSource;
1098 addrindex_write_elem_s( fp, lvl, TAG_DS_ADDRESS_BOOK );
1099 addrindex_write_attr( fp, ATTAG_BOOK_NAME, addrbook_get_name( abf ) );
1100 addrindex_write_attr( fp, ATTAG_BOOK_FILE, abf->fileName );
1101 fputs( " />\n", fp );
1105 static AddressDataSource *addrindex_parse_vcard( XMLFile *file ) {
1106 AddressDataSource *ds;
1110 ds = addrindex_create_datasource( ADDR_IF_VCARD );
1111 vcf = vcard_create();
1112 attr = xml_get_current_tag_attr( file );
1114 gchar *name = ((XMLAttr *)attr->data)->name;
1115 gchar *value = ((XMLAttr *)attr->data)->value;
1116 if( strcmp( name, ATTAG_VCARD_NAME ) == 0 ) {
1117 vcard_set_name( vcf, value );
1119 else if( strcmp( name, ATTAG_VCARD_FILE ) == 0) {
1120 vcard_set_file( vcf, value );
1122 attr = g_list_next( attr );
1124 ds->rawDataSource = vcf;
1128 static void addrindex_write_vcard( FILE *fp, AddressDataSource *ds, gint lvl ) {
1129 VCardFile *vcf = ds->rawDataSource;
1131 addrindex_write_elem_s( fp, lvl, TAG_DS_VCARD );
1132 addrindex_write_attr( fp, ATTAG_VCARD_NAME, vcard_get_name( vcf ) );
1133 addrindex_write_attr( fp, ATTAG_VCARD_FILE, vcf->path );
1134 fputs( " />\n", fp );
1139 static AddressDataSource *addrindex_parse_jpilot( XMLFile *file ) {
1140 AddressDataSource *ds;
1144 ds = addrindex_create_datasource( ADDR_IF_JPILOT );
1145 jpf = jpilot_create();
1146 attr = xml_get_current_tag_attr( file );
1148 gchar *name = ((XMLAttr *)attr->data)->name;
1149 gchar *value = ((XMLAttr *)attr->data)->value;
1150 if( strcmp( name, ATTAG_JPILOT_NAME ) == 0 ) {
1151 jpilot_set_name( jpf, value );
1153 else if( strcmp( name, ATTAG_JPILOT_FILE ) == 0 ) {
1154 jpilot_set_file( jpf, value );
1156 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_1 ) == 0 ) {
1157 jpilot_add_custom_label( jpf, value );
1159 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_2 ) == 0 ) {
1160 jpilot_add_custom_label( jpf, value );
1162 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_3 ) == 0 ) {
1163 jpilot_add_custom_label( jpf, value );
1165 else if( strcmp( name, ATTAG_JPILOT_CUSTOM_4 ) == 0 ) {
1166 jpilot_add_custom_label( jpf, value );
1168 attr = g_list_next( attr );
1170 ds->rawDataSource = jpf;
1174 static void addrindex_write_jpilot( FILE *fp,AddressDataSource *ds, gint lvl ) {
1175 JPilotFile *jpf = ds->rawDataSource;
1179 GList *customLbl = jpilot_get_custom_labels( jpf );
1180 addrindex_write_elem_s( fp, lvl, TAG_DS_JPILOT );
1181 addrindex_write_attr( fp, ATTAG_JPILOT_NAME, jpilot_get_name( jpf ) );
1182 addrindex_write_attr( fp, ATTAG_JPILOT_FILE, jpf->path );
1187 g_snprintf( name, sizeof(name), "%s%d",
1188 ATTAG_JPILOT_CUSTOM, ind );
1189 addrindex_write_attr( fp, name, node->data );
1191 node = g_list_next( node );
1193 fputs( " />\n", fp );
1199 * Just read/write DOM fragments (preserve data found in file).
1201 static AddressDataSource *addrindex_parse_jpilot( XMLFile *file ) {
1202 AddressDataSource *ds;
1204 ds = addrindex_create_datasource( ADDR_IF_JPILOT );
1205 ds->rawDataSource = addrindex_read_fragment( file );
1209 static void addrindex_write_jpilot( FILE *fp, AddressDataSource *ds, gint lvl ) {
1210 AddressIfFragment *fragment = ds->rawDataSource;
1212 addrindex_write_fragment( fp, fragment, lvl );
1219 * Parse LDAP criteria attribute data from XML file.
1220 * \param file Index file.
1221 * \param ctl LDAP control object to populate.
1223 static void addrindex_parse_ldap_attrlist( XMLFile *file, LdapControl *ctl ) {
1232 if( file == NULL ) {
1237 prevLevel = file->level;
1238 xtagPrev = xml_get_current_tag( file );
1240 rc = xml_parse_next_tag( file );
1242 /* Terminate prematurely */
1243 mgu_free_dlist( list );
1247 if( file->level < prevLevel ) {
1248 /* We must be above level we start at */
1252 /* Get a tag (element) */
1253 xtag = xml_get_current_tag( file );
1254 if( strcmp( xtag->tag, ELTAG_LDAP_ATTR_SRCH ) == 0 ) {
1255 /* LDAP criteria attribute */
1256 attr = xml_get_current_tag_attr( file );
1258 gchar *name = ((XMLAttr *)attr->data)->name;
1259 gchar *value = ((XMLAttr *)attr->data)->value;
1260 if( strcmp( name, ATTAG_LDAP_ATTR_NAME ) == 0 ) {
1261 if( value && strlen( value ) > 0 ) {
1262 list = g_list_append(
1263 list, g_strdup( value ) );
1266 attr = g_list_next( attr );
1270 if( xtag != xtagPrev ) {
1271 /* Found a new tag */
1278 /* Build list of search attributes */
1279 ldapctl_criteria_list_clear( ctl );
1282 ldapctl_criteria_list_add( ctl, node->data );
1283 g_free( node->data );
1285 node = g_list_next( node );
1287 g_list_free( list );
1292 void ldapsvr_set_control( LdapServer *server, LdapControl *ctl );
1294 * Parse LDAP control data from XML file.
1295 * \param file Index file.
1296 * \return Initialized data soruce object.
1298 static AddressDataSource *addrindex_parse_ldap( XMLFile *file ) {
1299 AddressDataSource *ds;
1303 gchar *serverName = NULL;
1304 gchar *criteria = NULL;
1305 gboolean bDynSearch;
1306 gboolean bTLS, bSSL;
1309 /* g_print( "addrindex_parse_ldap\n" ); */
1310 /* Set up some defaults */
1314 iMatch = LDAPCTL_MATCH_BEGINWITH;
1316 ds = addrindex_create_datasource( ADDR_IF_LDAP );
1317 ctl = ldapctl_create();
1318 attr = xml_get_current_tag_attr( file );
1320 gchar *name = ((XMLAttr *)attr->data)->name;
1321 gchar *value = ((XMLAttr *)attr->data)->value;
1322 gint ivalue = atoi( value );
1324 if( strcmp( name, ATTAG_LDAP_NAME ) == 0 ) {
1325 g_free( serverName );
1326 serverName = g_strdup( value );
1328 else if( strcmp( name, ATTAG_LDAP_HOST ) == 0 ) {
1329 ldapctl_set_host( ctl, value );
1331 else if( strcmp( name, ATTAG_LDAP_PORT ) == 0 ) {
1332 ldapctl_set_port( ctl, ivalue );
1334 else if( strcmp( name, ATTAG_LDAP_BASE_DN ) == 0 ) {
1335 ldapctl_set_base_dn( ctl, value );
1337 else if( strcmp( name, ATTAG_LDAP_BIND_DN ) == 0 ) {
1338 ldapctl_set_bind_dn( ctl, value );
1340 else if( strcmp( name, ATTAG_LDAP_BIND_PASS ) == 0 ) {
1341 ldapctl_set_bind_password( ctl, value );
1343 else if( strcmp( name, ATTAG_LDAP_CRITERIA ) == 0 ) {
1345 criteria = g_strdup( value );
1346 g_print("criteria %s\n", criteria);
1348 else if( strcmp( name, ATTAG_LDAP_MAX_ENTRY ) == 0 ) {
1349 ldapctl_set_max_entries( ctl, ivalue );
1351 else if( strcmp( name, ATTAG_LDAP_TIMEOUT ) == 0 ) {
1352 ldapctl_set_timeout( ctl, ivalue );
1354 else if( strcmp( name, ATTAG_LDAP_MAX_AGE ) == 0 ) {
1355 ldapctl_set_max_query_age( ctl, ivalue );
1357 else if( strcmp( name, ATTAG_LDAP_DYN_SEARCH ) == 0 ) {
1359 if( strcmp( value, ATVAL_BOOLEAN_YES ) == 0 ) {
1363 else if( strcmp( name, ATTAG_LDAP_MATCH_OPT ) == 0 ) {
1364 iMatch = LDAPCTL_MATCH_BEGINWITH;
1365 if( strcmp( value, ATVAL_LDAP_MATCH_CONTAINS ) == 0 ) {
1366 iMatch = LDAPCTL_MATCH_CONTAINS;
1369 else if( strcmp( name, ATTAG_LDAP_ENABLE_TLS ) == 0 ) {
1371 if( strcmp( value, ATVAL_BOOLEAN_YES ) == 0 ) {
1375 else if( strcmp( name, ATTAG_LDAP_ENABLE_SSL ) == 0 ) {
1377 if( strcmp( value, ATVAL_BOOLEAN_YES ) == 0 ) {
1381 attr = g_list_next( attr );
1384 server = ldapsvr_create_noctl();
1385 ldapsvr_set_name( server, serverName );
1386 ldapsvr_set_search_flag( server, bDynSearch );
1387 ldapctl_set_matching_option( ctl, iMatch );
1389 ldapctl_set_tls( ctl, bTLS );
1390 ldapctl_set_ssl( ctl, bSSL );
1392 g_free( serverName );
1393 ldapsvr_set_control( server, ctl );
1394 ds->rawDataSource = server;
1396 addrindex_parse_ldap_attrlist( file, ctl );
1398 * If criteria have been specified and no attributes were listed, then
1399 * convert old style criteria into an attribute list. Any criteria will
1400 * be dropped when saving data.
1403 if( ! ldapctl_get_criteria_list( ctl ) ) {
1404 ldapctl_parse_ldap_search( ctl, criteria );
1408 /* ldapsvr_print_data( server, stdout ); */
1413 static void addrindex_write_ldap( FILE *fp, AddressDataSource *ds, gint lvl ) {
1414 LdapServer *server = ds->rawDataSource;
1415 LdapControl *ctl = NULL;
1420 ctl = server->control;
1422 if( ctl == NULL ) return;
1424 /* Output start element with attributes */
1425 addrindex_write_elem_s( fp, lvl, TAG_DS_LDAP );
1426 addrindex_write_attr( fp, ATTAG_LDAP_NAME, ldapsvr_get_name( server ) );
1427 addrindex_write_attr( fp, ATTAG_LDAP_HOST, ctl->hostName );
1429 sprintf( value, "%d", ctl->port );
1430 addrindex_write_attr( fp, ATTAG_LDAP_PORT, value );
1432 addrindex_write_attr( fp, ATTAG_LDAP_BASE_DN, ctl->baseDN );
1433 addrindex_write_attr( fp, ATTAG_LDAP_BIND_DN, ctl->bindDN );
1434 addrindex_write_attr( fp, ATTAG_LDAP_BIND_PASS, ctl->bindPass );
1436 sprintf( value, "%d", ctl->maxEntries );
1437 addrindex_write_attr( fp, ATTAG_LDAP_MAX_ENTRY, value );
1438 sprintf( value, "%d", ctl->timeOut );
1439 addrindex_write_attr( fp, ATTAG_LDAP_TIMEOUT, value );
1440 sprintf( value, "%d", ctl->maxQueryAge );
1441 addrindex_write_attr( fp, ATTAG_LDAP_MAX_AGE, value );
1443 addrindex_write_attr( fp, ATTAG_LDAP_DYN_SEARCH,
1444 server->searchFlag ?
1445 ATVAL_BOOLEAN_YES : ATVAL_BOOLEAN_NO );
1447 addrindex_write_attr( fp, ATTAG_LDAP_MATCH_OPT,
1448 ( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) ?
1449 ATVAL_LDAP_MATCH_CONTAINS : ATVAL_LDAP_MATCH_BEGIN );
1451 addrindex_write_attr( fp, ATTAG_LDAP_ENABLE_TLS,
1453 ATVAL_BOOLEAN_YES : ATVAL_BOOLEAN_NO );
1454 addrindex_write_attr( fp, ATTAG_LDAP_ENABLE_SSL,
1456 ATVAL_BOOLEAN_YES : ATVAL_BOOLEAN_NO );
1460 /* Output attributes */
1461 node = ldapctl_get_criteria_list( ctl );
1463 addrindex_write_elem_s( fp, 1+lvl, ELTAG_LDAP_ATTR_SRCH );
1464 addrindex_write_attr( fp, ATTAG_LDAP_ATTR_NAME, node->data );
1466 node = g_list_next( node );
1469 /* End of element */
1470 addrindex_write_elem_e( fp, lvl, TAG_DS_LDAP );
1475 * Just read/write DOM fragments (preserve data found in file).
1477 static AddressDataSource *addrindex_parse_ldap( XMLFile *file ) {
1478 AddressDataSource *ds;
1480 ds = addrindex_create_datasource( ADDR_IF_LDAP );
1481 ds->rawDataSource = addrindex_read_fragment( file );
1485 static void addrindex_write_ldap( FILE *fp, AddressDataSource *ds, gint lvl ) {
1486 AddressIfFragment *fragment = ds->rawDataSource;
1488 addrindex_write_fragment( fp, fragment, lvl );
1493 /* **********************************************************************
1494 * Address index I/O functions.
1495 * ***********************************************************************
1498 * Read address index file, creating appropriate data sources for each address
1501 * \param addrIndex Address index.
1502 * \param file Address index file.
1504 static void addrindex_read_index( AddressIndex *addrIndex, XMLFile *file ) {
1507 AddressInterface *iface = NULL, *dsIFace = NULL;
1508 AddressDataSource *ds;
1511 addrIndex->loadedFlag = FALSE;
1513 prev_level = file->level;
1514 rc = xml_parse_next_tag( file );
1515 if( file->level == 0 ) return;
1517 xtag = xml_get_current_tag( file );
1519 iface = addrindex_tag_get_interface( addrIndex, xtag->tag, ADDR_IF_NONE );
1521 addrIndex->lastType = iface->type;
1522 if( iface->legacyFlag ) addrIndex->needsConversion = TRUE;
1525 dsIFace = addrindex_tag_get_datasource(
1526 addrIndex, addrIndex->lastType, xtag->tag );
1528 /* Add data source to list */
1530 if( addrIndex->lastType == ADDR_IF_BOOK ) {
1531 ds = addrindex_parse_book( file );
1532 if( ds->rawDataSource ) {
1533 addrbook_set_path( ds->rawDataSource,
1534 addrIndex->filePath );
1537 else if( addrIndex->lastType == ADDR_IF_VCARD ) {
1538 ds = addrindex_parse_vcard( file );
1540 else if( addrIndex->lastType == ADDR_IF_JPILOT ) {
1541 ds = addrindex_parse_jpilot( file );
1543 else if( addrIndex->lastType == ADDR_IF_LDAP ) {
1544 ds = addrindex_parse_ldap( file );
1547 ds->interface = dsIFace;
1548 addrindex_hash_add_cache( addrIndex, ds );
1549 dsIFace->listSource =
1550 g_list_append( dsIFace->listSource, ds );
1558 * Search order sorting comparison function for building search order list.
1560 static gint addrindex_search_order_compare( gconstpointer ptrA, gconstpointer ptrB ) {
1561 AddressInterface *ifaceA = ( AddressInterface * ) ptrA;
1562 AddressInterface *ifaceB = ( AddressInterface * ) ptrB;
1564 return ifaceA->searchOrder - ifaceB->searchOrder;
1568 * Build list of data sources to process.
1569 * \param addrIndex Address index object.
1571 static void addrindex_build_search_order( AddressIndex *addrIndex ) {
1574 /* Clear existing list */
1575 g_list_free( addrIndex->searchOrder );
1576 addrIndex->searchOrder = NULL;
1578 /* Build new list */
1579 nodeIf = addrIndex->interfaceList;
1581 AddressInterface *iface = nodeIf->data;
1582 if( iface->useInterface ) {
1583 if( iface->searchOrder > 0 ) {
1584 /* Add to search order list */
1585 addrIndex->searchOrder = g_list_insert_sorted(
1586 addrIndex->searchOrder, iface,
1587 addrindex_search_order_compare );
1590 nodeIf = g_list_next( nodeIf );
1594 static gint addrindex_read_file( AddressIndex *addrIndex ) {
1595 XMLFile *file = NULL;
1596 gchar *fileSpec = NULL;
1598 g_return_val_if_fail( addrIndex != NULL, -1 );
1600 fileSpec = g_strconcat( addrIndex->filePath, G_DIR_SEPARATOR_S, addrIndex->fileName, NULL );
1601 addrIndex->retVal = MGU_NO_FILE;
1602 file = xml_open_file( fileSpec );
1605 if( file == NULL ) {
1607 g_print( " file '%s' does not exist.\n", addrIndex->fileName );
1609 return addrIndex->retVal;
1612 addrIndex->retVal = MGU_BAD_FORMAT;
1613 if( xml_get_dtd( file ) == 0 ) {
1614 if( xml_parse_next_tag( file ) == 0 ) {
1615 if( xml_compare_tag( file, TAG_ADDRESS_INDEX ) ) {
1616 addrindex_read_index( addrIndex, file );
1617 addrIndex->retVal = MGU_SUCCESS;
1621 xml_close_file( file );
1623 addrindex_build_search_order( addrIndex );
1625 return addrIndex->retVal;
1628 static void addrindex_write_index( AddressIndex *addrIndex, FILE *fp ) {
1629 GList *nodeIF, *nodeDS;
1631 gint lvlItem = 1 + lvlList;
1633 nodeIF = addrIndex->interfaceList;
1635 AddressInterface *iface = nodeIF->data;
1636 if( ! iface->legacyFlag ) {
1637 nodeDS = iface->listSource;
1638 addrindex_write_elem_s( fp, lvlList, iface->listTag );
1641 AddressDataSource *ds = nodeDS->data;
1643 if( iface->type == ADDR_IF_BOOK ) {
1644 addrindex_write_book( fp, ds, lvlItem );
1646 if( iface->type == ADDR_IF_VCARD ) {
1647 addrindex_write_vcard( fp, ds, lvlItem );
1649 if( iface->type == ADDR_IF_JPILOT ) {
1650 addrindex_write_jpilot( fp, ds, lvlItem );
1652 if( iface->type == ADDR_IF_LDAP ) {
1653 addrindex_write_ldap( fp, ds, lvlItem );
1656 nodeDS = g_list_next( nodeDS );
1658 addrindex_write_elem_e( fp, lvlList, iface->listTag );
1660 nodeIF = g_list_next( nodeIF );
1665 * Write data to specified file.
1666 * Enter: addrIndex Address index object.
1667 * newFile New file name.
1668 * return: Status code, from addrIndex->retVal.
1669 * Note: File will be created in directory specified by addrIndex.
1671 static gint addrindex_write_to( AddressIndex *addrIndex, const gchar *newFile ) {
1674 #ifndef DEV_STANDALONE
1678 g_return_val_if_fail( addrIndex != NULL, -1 );
1680 fileSpec = g_strconcat( addrIndex->filePath, G_DIR_SEPARATOR_S, newFile, NULL );
1681 addrIndex->retVal = MGU_OPEN_FILE;
1682 #ifdef DEV_STANDALONE
1683 fp = g_fopen( fileSpec, "wb" );
1686 fputs( "<?xml version=\"1.0\" ?>\n", fp );
1688 pfile = prefs_write_open( fileSpec );
1692 fprintf( fp, "<?xml version=\"1.0\" encoding=\"%s\" ?>\n", CS_INTERNAL );
1694 addrindex_write_elem_s( fp, 0, TAG_ADDRESS_INDEX );
1697 addrindex_write_index( addrIndex, fp );
1698 addrindex_write_elem_e( fp, 0, TAG_ADDRESS_INDEX );
1700 addrIndex->retVal = MGU_SUCCESS;
1701 #ifdef DEV_STANDALONE
1704 if( prefs_file_close( pfile ) < 0 ) {
1705 addrIndex->retVal = MGU_ERROR_WRITE;
1711 return addrIndex->retVal;
1715 * Save address index data to original file.
1716 * return: Status code, from addrIndex->retVal.
1718 gint addrindex_save_data( AddressIndex *addrIndex ) {
1724 g_return_val_if_fail( addrIndex != NULL, -1 );
1727 nodeIf = addrIndex->interfaceList;
1728 /* save LDAP interfaces */
1730 AddressInterface *iface = nodeIf->data;
1731 if( iface->type == ADDR_IF_LDAP ) {
1732 nodeDS = iface->listSource;
1734 AddressDataSource *ds = nodeDS->data;
1735 LdapServer *abf = ds->rawDataSource;
1736 if( ldapsvr_get_read_flag( abf ) ) {
1737 if( ldapsvr_get_modified( abf ) ) {
1738 ldapsvr_update_book( abf, NULL );
1739 if( abf->retVal != LDAPRC_SUCCESS ) {
1740 alertpanel( _("Address(es) update"),
1741 _("Update failed. Changes not written to Directory."),
1742 GTK_STOCK_CLOSE, NULL, NULL );
1745 abf->retVal = MGU_SUCCESS;
1746 ldapsvr_set_modified( abf, FALSE );
1750 nodeDS = g_list_next( nodeDS );
1754 nodeIf = g_list_next( nodeIf );
1757 addrIndex->retVal = MGU_NO_FILE;
1758 if( addrIndex->fileName == NULL || *addrIndex->fileName == '\0' ) return addrIndex->retVal;
1759 if( addrIndex->filePath == NULL || *addrIndex->filePath == '\0' ) return addrIndex->retVal;
1761 addrindex_write_to( addrIndex, addrIndex->fileName );
1762 if( addrIndex->retVal == MGU_SUCCESS ) {
1763 addrIndex->dirtyFlag = FALSE;
1765 return addrIndex->retVal;
1769 * Save all address book files which may have changed.
1770 * Return: Status code, set if there was a problem saving data.
1772 gint addrindex_save_all_books( AddressIndex *addrIndex ) {
1773 gint retVal = MGU_SUCCESS;
1774 GList *nodeIf, *nodeDS;
1776 nodeIf = addrIndex->interfaceList;
1778 AddressInterface *iface = nodeIf->data;
1779 if( iface->type == ADDR_IF_BOOK ) {
1780 nodeDS = iface->listSource;
1782 AddressDataSource *ds = nodeDS->data;
1783 AddressBookFile *abf = ds->rawDataSource;
1784 if( addrbook_get_dirty( abf ) ) {
1785 if( addrbook_get_read_flag( abf ) ) {
1786 addrbook_save_data( abf );
1787 if( abf->retVal != MGU_SUCCESS ) {
1788 retVal = abf->retVal;
1792 nodeDS = g_list_next( nodeDS );
1796 nodeIf = g_list_next( nodeIf );
1802 /* **********************************************************************
1803 * Address book conversion to new format.
1804 * ***********************************************************************
1807 #define ELTAG_IF_OLD_FOLDER "folder"
1808 #define ELTAG_IF_OLD_GROUP "group"
1809 #define ELTAG_IF_OLD_ITEM "item"
1810 #define ELTAG_IF_OLD_NAME "name"
1811 #define ELTAG_IF_OLD_ADDRESS "address"
1812 #define ELTAG_IF_OLD_REMARKS "remarks"
1813 #define ATTAG_IF_OLD_NAME "name"
1815 #define TEMPNODE_ROOT 0
1816 #define TEMPNODE_FOLDER 1
1817 #define TEMPNODE_GROUP 2
1818 #define TEMPNODE_ADDRESS 3
1820 typedef struct _AddressCvt_Node AddressCvtNode;
1821 struct _AddressCvt_Node {
1830 * Parse current address item.
1832 static AddressCvtNode *addrindex_parse_item( XMLFile *file ) {
1837 nn = g_new0( AddressCvtNode, 1 );
1838 nn->type = TEMPNODE_ADDRESS;
1841 level = file->level;
1844 xml_parse_next_tag(file);
1845 if (file->level < level) return nn;
1847 element = xml_get_element( file );
1848 if( xml_compare_tag( file, ELTAG_IF_OLD_NAME ) ) {
1849 nn->name = g_strdup( element );
1851 if( xml_compare_tag( file, ELTAG_IF_OLD_ADDRESS ) ) {
1852 nn->address = g_strdup( element );
1854 if( xml_compare_tag( file, ELTAG_IF_OLD_REMARKS ) ) {
1855 nn->remarks = g_strdup( element );
1858 xml_parse_next_tag(file);
1863 * Create a temporary node below specified node.
1865 static AddressCvtNode *addrindex_add_object( AddressCvtNode *node, gint type, gchar *name, gchar *addr, char *rem ) {
1867 nn = g_new0( AddressCvtNode, 1 );
1869 nn->name = g_strdup( name );
1870 nn->remarks = g_strdup( rem );
1871 node->list = g_list_append( node->list, nn );
1876 * Process current temporary node.
1878 static void addrindex_add_obj( XMLFile *file, AddressCvtNode *node ) {
1881 AddressCvtNode *newNode = NULL;
1886 prev_level = file->level;
1887 xml_parse_next_tag( file );
1888 if (file->level < prev_level) return;
1892 if( xml_compare_tag( file, ELTAG_IF_OLD_GROUP ) ) {
1893 attr = xml_get_current_tag_attr(file);
1895 name = ((XMLAttr *)attr->data)->name;
1896 if( strcmp( name, ATTAG_IF_OLD_NAME ) == 0 ) {
1897 value = ((XMLAttr *)attr->data)->value;
1900 newNode = addrindex_add_object( node, TEMPNODE_GROUP, value, "", "" );
1901 addrindex_add_obj( file, newNode );
1904 else if( xml_compare_tag( file, ELTAG_IF_OLD_FOLDER ) ) {
1905 attr = xml_get_current_tag_attr(file);
1907 name = ((XMLAttr *)attr->data)->name;
1908 if( strcmp( name, ATTAG_IF_OLD_NAME ) == 0 ) {
1909 value = ((XMLAttr *)attr->data)->value;
1912 newNode = addrindex_add_object( node, TEMPNODE_FOLDER, value, "", "" );
1913 addrindex_add_obj( file, newNode );
1915 else if( xml_compare_tag( file, ELTAG_IF_OLD_ITEM ) ) {
1916 newNode = addrindex_parse_item( file );
1917 node->list = g_list_append( node->list, newNode );
1920 /* g_print( "invalid: !!! \n" ); */
1921 attr = xml_get_current_tag_attr( file );
1927 * Consume all nodes below current tag.
1929 static void addrindex_consume_tree( XMLFile *file ) {
1936 prev_level = file->level;
1937 xml_parse_next_tag( file );
1938 if (file->level < prev_level) return;
1940 xtag = xml_get_current_tag( file );
1941 /* g_print( "tag : %s\n", xtag->tag ); */
1942 element = xml_get_element( file );
1943 attr = xml_get_current_tag_attr( file );
1944 /* show_attribs( attr ); */
1945 /* g_print( "\ttag value : %s :\n", element ); */
1946 addrindex_consume_tree( file );
1951 * Print temporary tree.
1953 static void addrindex_print_node( AddressCvtNode *node, FILE *stream ) {
1956 fprintf( stream, "Node:\ttype :%d:\n", node->type );
1957 fprintf( stream, "\tname :%s:\n", node->name );
1958 fprintf( stream, "\taddr :%s:\n", node->address );
1959 fprintf( stream, "\trems :%s:\n", node->remarks );
1961 fprintf( stream, "\t--list----\n" );
1965 AddressCvtNode *lNode = list->data;
1966 list = g_list_next( list );
1967 addrindex_print_node( lNode, stream );
1969 fprintf( stream, "\t==list-%d==\n", node->type );
1973 * Free up temporary tree.
1975 static void addrindex_free_node( AddressCvtNode *node ) {
1976 GList *list = node->list;
1979 AddressCvtNode *lNode = list->data;
1980 list = g_list_next( list );
1981 addrindex_free_node( lNode );
1983 node->type = TEMPNODE_ROOT;
1984 g_free( node->name );
1985 g_free( node->address );
1986 g_free( node->remarks );
1987 g_list_free( node->list );
1992 * Process address book for specified node.
1994 static void addrindex_process_node(
1995 AddressBookFile *abf, AddressCvtNode *node, ItemFolder *parent,
1996 ItemGroup *parentGrp, ItemFolder *folderGrp )
1999 ItemFolder *itemFolder = NULL;
2000 ItemGroup *itemGParent = parentGrp;
2001 ItemFolder *itemGFolder = folderGrp;
2002 AddressCache *cache = abf->addressCache;
2004 if( node->type == TEMPNODE_ROOT ) {
2005 itemFolder = parent;
2007 else if( node->type == TEMPNODE_FOLDER ) {
2008 itemFolder = addritem_create_item_folder();
2009 addritem_folder_set_name( itemFolder, node->name );
2010 addrcache_id_folder( cache, itemFolder );
2011 addrcache_folder_add_folder( cache, parent, itemFolder );
2014 else if( node->type == TEMPNODE_GROUP ) {
2015 ItemGroup *itemGroup;
2018 /* Create a folder for group */
2019 fName = g_strdup_printf( "Cvt - %s", node->name );
2020 itemGFolder = addritem_create_item_folder();
2021 addritem_folder_set_name( itemGFolder, fName );
2022 addrcache_id_folder( cache, itemGFolder );
2023 addrcache_folder_add_folder( cache, parent, itemGFolder );
2026 /* Add group into folder */
2027 itemGroup = addritem_create_item_group();
2028 addritem_group_set_name( itemGroup, node->name );
2029 addrcache_id_group( cache, itemGroup );
2030 addrcache_folder_add_group( cache, itemGFolder, itemGroup );
2031 itemGParent = itemGroup;
2033 else if( node->type == TEMPNODE_ADDRESS ) {
2034 ItemPerson *itemPerson;
2035 ItemEMail *itemEMail;
2037 /* Create person and email objects */
2038 itemPerson = addritem_create_item_person();
2039 addritem_person_set_common_name( itemPerson, node->name );
2040 addrcache_id_person( cache, itemPerson );
2041 itemEMail = addritem_create_item_email();
2042 addritem_email_set_address( itemEMail, node->address );
2043 addritem_email_set_remarks( itemEMail, node->remarks );
2044 addrcache_id_email( cache, itemEMail );
2045 addrcache_person_add_email( cache, itemPerson, itemEMail );
2047 /* Add person into appropriate folder */
2049 addrcache_folder_add_person( cache, itemGFolder, itemPerson );
2052 addrcache_folder_add_person( cache, parent, itemPerson );
2055 /* Add email address only into group */
2057 addrcache_group_add_email( cache, parentGrp, itemEMail );
2063 AddressCvtNode *lNode = list->data;
2064 list = g_list_next( list );
2065 addrindex_process_node( abf, lNode, itemFolder, itemGParent, itemGFolder );
2070 * Process address book to specified file number.
2072 static gboolean addrindex_process_book( AddressIndex *addrIndex, XMLFile *file, gchar *displayName ) {
2073 gboolean retVal = FALSE;
2074 AddressBookFile *abf = NULL;
2075 AddressCvtNode *rootNode = NULL;
2076 gchar *newFile = NULL;
2077 GList *fileList = NULL;
2080 /* Setup root node */
2081 rootNode = g_new0( AddressCvtNode, 1 );
2082 rootNode->type = TEMPNODE_ROOT;
2083 rootNode->name = g_strdup( "root" );
2084 rootNode->list = NULL;
2085 addrindex_add_obj( file, rootNode );
2086 /* addrindex_print_node( rootNode, stdout ); */
2088 /* Create new address book */
2089 abf = addrbook_create_book();
2090 addrbook_set_name( abf, displayName );
2091 addrbook_set_path( abf, addrIndex->filePath );
2093 /* Determine next available file number */
2094 fileList = addrbook_get_bookfile_list( abf );
2096 fileNum = 1 + abf->maxValue;
2098 g_list_free( fileList );
2101 newFile = addrbook_gen_new_file_name( fileNum );
2103 addrbook_set_file( abf, newFile );
2106 addrindex_process_node( abf, rootNode, abf->addressCache->rootFolder, NULL, NULL );
2108 /* addrbook_dump_book( abf, stdout ); */
2109 addrbook_save_data( abf );
2110 addrIndex->retVal = abf->retVal;
2111 if( abf->retVal == MGU_SUCCESS ) retVal = TRUE;
2113 addrbook_free_book( abf );
2115 addrindex_free_node( rootNode );
2118 /* Create entries in address index */
2120 abf = addrbook_create_book();
2121 addrbook_set_name( abf, displayName );
2122 addrbook_set_path( abf, addrIndex->filePath );
2123 addrbook_set_file( abf, newFile );
2124 addrindex_index_add_datasource( addrIndex, ADDR_IF_BOOK, abf );
2131 * Process tree converting data.
2133 static void addrindex_convert_tree( AddressIndex *addrIndex, XMLFile *file ) {
2141 prev_level = file->level;
2142 xml_parse_next_tag( file );
2143 if (file->level < prev_level) return;
2145 xtag = xml_get_current_tag( file );
2146 /* g_print( "tag : %d : %s\n", prev_level, xtag->tag ); */
2147 if( strcmp( xtag->tag, TAG_IF_OLD_COMMON ) == 0 ) {
2148 if( addrindex_process_book( addrIndex, file, DISP_OLD_COMMON ) ) {
2149 addrIndex->needsConversion = FALSE;
2150 addrIndex->wasConverted = TRUE;
2155 if( strcmp( xtag->tag, TAG_IF_OLD_PERSONAL ) == 0 ) {
2156 if( addrindex_process_book( addrIndex, file, DISP_OLD_PERSONAL ) ) {
2157 addrIndex->needsConversion = FALSE;
2158 addrIndex->wasConverted = TRUE;
2163 element = xml_get_element( file );
2164 attr = xml_get_current_tag_attr( file );
2165 /* show_attribs( attr ); */
2166 /* g_print( "\ttag value : %s :\n", element ); */
2167 addrindex_consume_tree( file );
2171 static gint addrindex_convert_data( AddressIndex *addrIndex ) {
2172 XMLFile *file = NULL;
2175 fileSpec = g_strconcat( addrIndex->filePath, G_DIR_SEPARATOR_S, addrIndex->fileName, NULL );
2176 addrIndex->retVal = MGU_NO_FILE;
2177 file = xml_open_file( fileSpec );
2180 if( file == NULL ) {
2181 /* g_print( " file '%s' does not exist.\n", addrIndex->fileName ); */
2182 return addrIndex->retVal;
2185 addrIndex->retVal = MGU_BAD_FORMAT;
2186 if( xml_get_dtd( file ) == 0 ) {
2187 if( xml_parse_next_tag( file ) == 0 ) {
2188 if( xml_compare_tag( file, TAG_ADDRESS_INDEX ) ) {
2189 addrindex_convert_tree( addrIndex, file );
2193 xml_close_file( file );
2194 return addrIndex->retVal;
2198 * Create a new address book file.
2200 static gboolean addrindex_create_new_book( AddressIndex *addrIndex, gchar *displayName ) {
2201 gboolean retVal = FALSE;
2202 AddressBookFile *abf = NULL;
2203 gchar *newFile = NULL;
2204 GList *fileList = NULL;
2207 /* Create new address book */
2208 abf = addrbook_create_book();
2209 addrbook_set_name( abf, displayName );
2210 addrbook_set_path( abf, addrIndex->filePath );
2212 /* Determine next available file number */
2213 fileList = addrbook_get_bookfile_list( abf );
2215 fileNum = 1 + abf->maxValue;
2217 g_list_free( fileList );
2220 newFile = addrbook_gen_new_file_name( fileNum );
2222 addrbook_set_file( abf, newFile );
2225 addrbook_save_data( abf );
2226 addrIndex->retVal = abf->retVal;
2227 if( abf->retVal == MGU_SUCCESS ) retVal = TRUE;
2228 addrbook_free_book( abf );
2231 /* Create entries in address index */
2233 abf = addrbook_create_book();
2234 addrbook_set_name( abf, displayName );
2235 addrbook_set_path( abf, addrIndex->filePath );
2236 addrbook_set_file( abf, newFile );
2237 addrindex_index_add_datasource( addrIndex, ADDR_IF_BOOK, abf );
2244 * Read data for address index performing a conversion if necesary.
2245 * Enter: addrIndex Address index object.
2246 * return: Status code, from addrIndex->retVal.
2247 * Note: New address book files will be created in directory specified by
2248 * addrIndex. Three files will be created, for the following:
2249 * "Common addresses"
2250 * "Personal addresses"
2251 * "Gathered addresses" - a new address book.
2253 gint addrindex_read_data( AddressIndex *addrIndex ) {
2254 g_return_val_if_fail( addrIndex != NULL, -1 );
2256 addrIndex->conversionError = FALSE;
2257 addrindex_read_file( addrIndex );
2258 if( addrIndex->retVal == MGU_SUCCESS ) {
2259 if( addrIndex->needsConversion ) {
2260 if( addrindex_convert_data( addrIndex ) == MGU_SUCCESS ) {
2261 addrIndex->conversionError = TRUE;
2264 addrIndex->conversionError = TRUE;
2267 addrIndex->dirtyFlag = TRUE;
2269 return addrIndex->retVal;
2273 * Create new address books for a new address index.
2274 * Enter: addrIndex Address index object.
2275 * return: Status code, from addrIndex->retVal.
2276 * Note: New address book files will be created in directory specified by
2277 * addrIndex. Three files will be created, for the following:
2278 * "Common addresses"
2279 * "Personal addresses"
2280 * "Gathered addresses" - a new address book.
2282 gint addrindex_create_new_books( AddressIndex *addrIndex ) {
2285 g_return_val_if_fail( addrIndex != NULL, -1 );
2287 flg = addrindex_create_new_book( addrIndex, DISP_NEW_COMMON );
2289 flg = addrindex_create_new_book( addrIndex, DISP_NEW_PERSONAL );
2290 addrIndex->dirtyFlag = TRUE;
2292 return addrIndex->retVal;
2295 /* **********************************************************************
2296 * New interface stuff.
2297 * ***********************************************************************
2301 * Return modified flag for specified data source.
2303 gboolean addrindex_ds_get_modify_flag( AddressDataSource *ds ) {
2304 gboolean retVal = FALSE;
2305 AddressInterface *iface;
2307 if( ds == NULL ) return retVal;
2308 iface = ds->interface;
2309 if( iface == NULL ) return retVal;
2310 if( iface->getModifyFlag ) {
2311 retVal = ( iface->getModifyFlag ) ( ds->rawDataSource );
2317 * Return accessed flag for specified data source.
2319 gboolean addrindex_ds_get_access_flag( AddressDataSource *ds ) {
2320 gboolean retVal = FALSE;
2321 AddressInterface *iface;
2323 if( ds == NULL ) return retVal;
2324 iface = ds->interface;
2325 if( iface == NULL ) return retVal;
2326 if( iface->getAccessFlag ) {
2327 retVal = ( iface->getAccessFlag ) ( ds->rawDataSource );
2333 * Return data read flag for specified data source.
2335 gboolean addrindex_ds_get_read_flag( AddressDataSource *ds ) {
2336 gboolean retVal = TRUE;
2337 AddressInterface *iface;
2339 if( ds == NULL ) return retVal;
2340 iface = ds->interface;
2341 if( iface == NULL ) return retVal;
2342 if( iface->getReadFlag ) {
2343 retVal = ( iface->getReadFlag ) ( ds->rawDataSource );
2349 * Return status code for specified data source.
2351 gint addrindex_ds_get_status_code( AddressDataSource *ds ) {
2352 gint retVal = MGU_SUCCESS;
2353 AddressInterface *iface;
2355 if( ds == NULL ) return retVal;
2356 iface = ds->interface;
2357 if( iface == NULL ) return retVal;
2358 if( iface->getStatusCode ) {
2359 retVal = ( iface->getStatusCode ) ( ds->rawDataSource );
2365 * Return data read flag for specified data source.
2367 gint addrindex_ds_read_data( AddressDataSource *ds ) {
2368 gint retVal = MGU_SUCCESS;
2369 AddressInterface *iface;
2371 if( ds == NULL ) return retVal;
2372 iface = ds->interface;
2373 if( iface == NULL ) return retVal;
2374 if( iface->getReadData ) {
2376 gchar *name = ( iface->getName ) ( ds->rawDataSource );
2377 g_print( "addrindex_ds_read_data...reading:::%s:::\n", name );
2379 retVal = ( iface->getReadData ) ( ds->rawDataSource );
2385 * Return data read flag for specified data source.
2387 ItemFolder *addrindex_ds_get_root_folder( AddressDataSource *ds ) {
2388 ItemFolder *retVal = NULL;
2389 AddressInterface *iface;
2391 if( ds == NULL ) return retVal;
2392 iface = ds->interface;
2393 if( iface == NULL ) return retVal;
2394 if( iface->getRootFolder ) {
2395 retVal = ( iface->getRootFolder ) ( ds->rawDataSource );
2401 * Return name for specified data source.
2403 gchar *addrindex_ds_get_name( AddressDataSource *ds ) {
2404 gchar *retVal = FALSE;
2405 AddressInterface *iface;
2407 if( ds == NULL ) return retVal;
2408 iface = ds->interface;
2409 if( iface == NULL ) return retVal;
2410 if( iface->getName ) {
2411 retVal = ( iface->getName ) ( ds->rawDataSource );
2417 * Set the access flag inside the data source.
2419 void addrindex_ds_set_access_flag( AddressDataSource *ds, gboolean *value ) {
2420 AddressInterface *iface;
2422 if( ds == NULL ) return;
2423 iface = ds->interface;
2424 if( iface == NULL ) return;
2425 if( iface->setAccessFlag ) {
2426 ( iface->setAccessFlag ) ( ds->rawDataSource, value );
2431 * Return read only flag for specified data source.
2433 gboolean addrindex_ds_get_readonly( AddressDataSource *ds ) {
2434 AddressInterface *iface;
2435 if( ds == NULL ) return TRUE;
2436 iface = ds->interface;
2437 if( iface == NULL ) return TRUE;
2438 return iface->readOnly;
2442 * Return list of all persons for specified data source.
2444 static GList *addrindex_ds_get_all_persons( AddressDataSource *ds ) {
2445 GList *retVal = NULL;
2446 AddressInterface *iface;
2448 if( ds == NULL ) return retVal;
2449 iface = ds->interface;
2450 if( iface == NULL ) return retVal;
2451 if( iface->getAllPersons ) {
2452 retVal = ( iface->getAllPersons ) ( ds->rawDataSource );
2458 * Return list of all groups for specified data source.
2460 static GList *addrindex_ds_get_all_groups( AddressDataSource *ds ) {
2461 GList *retVal = NULL;
2462 AddressInterface *iface;
2464 if( ds == NULL ) return retVal;
2465 iface = ds->interface;
2466 if( iface == NULL ) return retVal;
2467 if( iface->getAllGroups ) {
2468 retVal = ( iface->getAllGroups ) ( ds->rawDataSource );
2473 /* **********************************************************************
2474 * Address search stuff.
2475 * ***********************************************************************
2479 * Setup or register the dynamic search that will be performed. The search
2480 * is registered with the query manager.
2482 * \param searchTerm Search term. A private copy will be made.
2483 * \param callBackEntry Callback function that should be called when
2484 * each entry is received.
2485 * \param callBackEnd Callback function that should be called when
2486 * search has finished running.
2487 * \return ID allocated to query that will be executed.
2489 gint addrindex_setup_search(
2490 const gchar *searchTerm, void *callBackEnd, void *callBackEntry )
2495 /* Set up a dynamic address query */
2496 req = qrymgr_add_request( searchTerm, callBackEnd, callBackEntry );
2497 queryID = req->queryID;
2498 qryreq_set_search_type( req, ADDRSEARCH_DYNAMIC );
2500 /* g_print( "***> query ID ::%d::\n", queryID ); */
2507 * Function prototypes (not in header file or circular reference errors are
2510 LdapQuery *ldapsvr_new_dynamic_search(
2511 LdapServer *server, QueryRequest *req );
2512 LdapQuery *ldapsvr_new_explicit_search(
2513 LdapServer *server, QueryRequest *req, ItemFolder *folder );
2514 void ldapsvr_execute_query( LdapServer *server, LdapQuery *qry );
2519 * Execute the previously registered dynamic search.
2521 * \param req Address query object to execute.
2522 * \return <i>TRUE</i> if search started successfully, or <i>FALSE</i> if
2525 static gboolean addrindex_start_dynamic( QueryRequest *req ) {
2526 AddressInterface *iface;
2527 AddressDataSource *ds;
2532 /* g_print( "addrindex_start_dynamic::%d::\n", req->queryID ); */
2533 nodeIf = _addressIndex_->searchOrder;
2535 iface = nodeIf->data;
2536 nodeIf = g_list_next( nodeIf );
2538 if( ! iface->useInterface ) {
2541 if( ! iface->externalQuery ) {
2546 nodeDS = iface->listSource;
2549 nodeDS = g_list_next( nodeDS );
2551 if( type == ADDR_IF_LDAP ) {
2555 server = ds->rawDataSource;
2556 if( ! server->searchFlag ) {
2559 if( ldapsvr_reuse_previous( server, req ) ) {
2563 /* Start a new dynamic search */
2564 qry = ldapsvr_new_dynamic_search( server, req );
2566 ldapsvr_execute_query( server, qry );
2576 * Stop the previously registered search.
2578 * \param queryID ID of search query to stop.
2580 void addrindex_stop_search( const gint queryID ){
2582 AddrQueryObject *aqo;
2585 /* g_print( "addrindex_stop_search/queryID=%d\n", queryID ); */
2586 /* If query ID does not match, search has not been setup */
2587 req = qrymgr_find_request( queryID );
2592 /* Stop all queries that were associated with request */
2593 node = req->queryList;
2597 if( aqo->queryType == ADDRQUERY_LDAP ) {
2598 LdapQuery *qry = ( LdapQuery * ) aqo;
2599 ldapqry_set_stop_flag( qry, TRUE );
2603 node = g_list_next( node );
2606 /* Delete query request */
2607 qrymgr_delete_request( queryID );
2611 * Setup or register the explicit search that will be performed. The search is
2612 * registered with the query manager.
2614 * \param ds Data source to search.
2615 * \param searchTerm Search term to locate.
2616 * \param folder Folder to receive search results; may be NULL.
2617 * \param callbackEnd Function to call when search has terminated.
2618 * \param callbackEntry Function to called for each entry processed.
2619 * \return ID allocated to query that will be executed.
2621 gint addrindex_setup_explicit_search(
2622 AddressDataSource *ds, const gchar *searchTerm, ItemFolder *folder,
2623 void *callBackEnd, void *callBackEntry )
2630 /* Name the query */
2631 name = g_strdup_printf( "Search '%s'", searchTerm );
2633 /* Set up query request */
2634 if (!strcmp(searchTerm, "*"))
2635 mySearch = g_strdup("*@");
2637 mySearch = g_strdup(searchTerm);
2639 req = qrymgr_add_request( mySearch, callBackEnd, callBackEntry );
2643 qryreq_set_search_type( req, ADDRSEARCH_EXPLICIT );
2644 queryID = req->queryID;
2646 if( ds->type == ADDR_IF_LDAP ) {
2650 server = ds->rawDataSource;
2651 ldapsvr_new_explicit_search( server, req, folder );
2655 qrymgr_delete_request( queryID );
2664 * Execute the previously registered explicit search.
2666 * \param req Address query request object to execute.
2667 * \return <i>TRUE</i> if search started successfully, or <i>FALSE</i> if
2670 static gboolean addrindex_start_explicit( QueryRequest *req ) {
2672 AddrQueryObject *aqo;
2676 /* Note: there should only be one query in the list. */
2677 aqo = req->queryList->data;
2679 if( aqo->queryType == ADDRQUERY_LDAP ) {
2683 qry = ( LdapQuery * ) aqo;
2684 server = qry->server;
2686 /* Start the search */
2688 ldapsvr_execute_query( server, qry );
2695 * Start the previously registered search.
2697 * \param queryID ID of search query to be executed.
2698 * \return <i>TRUE</i> if search started successfully, or <i>FALSE</i> if
2701 gboolean addrindex_start_search( const gint queryID ) {
2704 AddrSearchType searchType;
2707 /* g_print( "addrindex_start_search/queryID=%d\n", queryID ); */
2708 req = qrymgr_find_request( queryID );
2713 searchType = req->searchType;
2714 if( searchType == ADDRSEARCH_DYNAMIC ) {
2715 retVal = addrindex_start_dynamic( req );
2717 else if( searchType == ADDRSEARCH_EXPLICIT ) {
2718 retVal = addrindex_start_explicit( req );
2725 * Remove results (folder and data) for specified data source and folder.
2726 * \param ds Data source to process.
2727 * \param folder Results folder to remove.
2729 void addrindex_remove_results( AddressDataSource *ds, ItemFolder *folder ) {
2730 AddrBookBase *adbase;
2731 AddressCache *cache;
2734 /* g_print( "addrindex_remove_results/start\n" ); */
2736 /* Test for folder */
2737 if( folder->folderType != ADDRFOLDER_QUERY_RESULTS ) return;
2738 /* g_print( "folder name ::%s::\n", ADDRITEM_NAME(folder) ); */
2739 adbase = ( AddrBookBase * ) ds->rawDataSource;
2740 if( adbase == NULL ) return;
2741 cache = adbase->addressCache;
2743 /* Hide folder to prevent re-display */
2744 addritem_folder_set_hidden( folder, TRUE );
2746 if( ds->type == ADDR_IF_LDAP ) {
2751 qry = ( LdapQuery * ) folder->folderData;
2752 queryID = ADDRQUERY_ID(qry);
2753 /* g_print( "calling ldapquery_remove_results...queryID=%d\n", queryID ); */
2754 delFlag = ldapquery_remove_results( qry );
2756 ldapqry_free( qry );
2758 /* g_print( "calling ldapquery_remove_results...done\n" ); */
2761 g_print( "delFlag IS-TRUE\n" );
2764 g_print( "delFlag IS-FALSE\n" );
2769 /* g_print( "addrindex_remove_results/end\n" ); */
2771 /* Delete query request */
2773 qrymgr_delete_request( queryID );
2777 /* **********************************************************************
2778 * Address completion stuff.
2779 * ***********************************************************************
2782 static void addrindex_load_completion_load_persons(
2783 gint (*callBackFunc) ( const gchar *, const gchar *,
2784 const gchar *, const gchar *, GList * ),
2785 AddressDataSource *ds)
2787 GList *listP, *nodeP;
2791 /* Read address book */
2792 if( addrindex_ds_get_modify_flag( ds ) ) {
2793 addrindex_ds_read_data( ds );
2796 if( ! addrindex_ds_get_read_flag( ds ) ) {
2797 addrindex_ds_read_data( ds );
2800 /* Get all groups */
2801 listP = addrindex_ds_get_all_groups( ds );
2804 ItemGroup *group = nodeP->data;
2805 GList *emails = NULL;
2806 for (nodeM = group->listEMail; nodeM; nodeM = g_list_next(nodeM)) {
2807 ItemEMail *email = nodeM->data;
2809 emails = g_list_append(emails, email);
2811 callBackFunc( ((AddrItemObject *)group)->name, NULL,
2812 NULL, NULL, emails );
2813 nodeP = g_list_next( nodeP );
2816 /* Free up the list */
2817 g_list_free( listP );
2818 /* Get all persons */
2819 listP = addrindex_ds_get_all_persons( ds );
2822 ItemPerson *person = nodeP->data;
2823 nodeM = person->listEMail;
2825 /* Figure out name to use */
2826 sName = ADDRITEM_NAME(person);
2827 if( sName == NULL || *sName == '\0' ) {
2828 sName = person->nickName;
2831 /* Process each E-Mail address */
2833 ItemEMail *email = nodeM->data;
2835 callBackFunc( sName, email->address, person->nickName,
2836 ADDRITEM_NAME(email), NULL );
2838 nodeM = g_list_next( nodeM );
2840 nodeP = g_list_next( nodeP );
2843 /* Free up the list */
2844 g_list_free( listP );
2848 * This function is used by the address completion function to load
2849 * addresses for all non-external address book interfaces.
2851 * \param callBackFunc Function to be called when an address is
2853 * \param folderpath Addressbook's Book/folder path to restrict to (if NULL or ""
2854 * or "Any", assume the whole addressbook
2855 * \return <i>TRUE</i> if data loaded, <i>FALSE</i> if address index not loaded.
2858 gboolean addrindex_load_completion(
2859 gint (*callBackFunc) ( const gchar *, const gchar *,
2860 const gchar *, const gchar *, GList * ),
2863 GList *nodeIf, *nodeDS;
2865 if( folderpath != NULL ) {
2866 AddressDataSource *book;
2869 /* split the folder path we've received, we'll try to match this path, subpath by
2870 subpath against the book/folder structure in order and restrict loading of
2871 addresses to that subpart (if matches). book/folder path must exist and
2872 folderpath must not be empty or NULL */
2874 if( ! addressbook_peek_folder_exists( folderpath, &book, &folder ) ) {
2875 g_warning("addrindex_load_completion: folder path '%s' doesn't exist\n", folderpath);
2879 if( folder != NULL ) {
2886 debug_print("addrindex_load_completion: folder %p '%s'\n", folder, folder->obj.name);
2888 /* Load email addresses */
2889 items = addritem_folder_get_person_list( folder );
2890 for( ; items != NULL; items = g_list_next( items ) ) {
2891 person = items->data;
2892 nodeM = person->listEMail;
2894 /* Figure out name to use */
2895 sName = ADDRITEM_NAME(person);
2896 if( sName == NULL || *sName == '\0' ) {
2897 sName = person->nickName;
2900 /* Process each E-Mail address */
2902 ItemEMail *email = nodeM->data;
2904 callBackFunc( sName, email->address, person->nickName,
2905 ADDRITEM_NAME(email), NULL );
2907 nodeM = g_list_next( nodeM );
2910 /* Free up the list */
2911 mgu_clear_list( items );
2912 g_list_free( items );
2918 if( book != NULL ) {
2920 AddressBookFile *abf = book->rawDataSource;
2922 debug_print("addrindex_load_completion: book %p '%s'\n", book, abf?abf->fileName:"(null)");
2924 addrindex_load_completion_load_persons( callBackFunc, book );
2929 g_warning("addrindex_load_completion: book/folder path is valid but got no pointer\n");
2936 nodeIf = addrindex_get_interface_list( _addressIndex_ );
2938 AddressInterface *iface = nodeIf->data;
2940 nodeIf = g_list_next( nodeIf );
2942 if( ! iface->useInterface || iface->externalQuery )
2945 nodeDS = iface->listSource;
2947 addrindex_load_completion_load_persons( callBackFunc, nodeDS->data );
2948 nodeDS = g_list_next( nodeDS );
2957 * This function can be used to collect information about
2958 * addressbook entries that contain a specific attribute.
2960 * \param attr Name of attribute to look for
2961 * \param callBackFunc Function to be called when a matching attribute was found
2962 * \return <i>TRUE</i>
2964 gboolean addrindex_load_person_attribute(
2966 gint (*callBackFunc) ( ItemPerson *, const gchar * ) )
2968 AddressDataSource *ds;
2969 GList *nodeIf, *nodeDS;
2970 GList *listP, *nodeP;
2973 nodeIf = addrindex_get_interface_list( _addressIndex_ );
2976 AddressInterface *iface = nodeIf->data;
2978 nodeIf = g_list_next( nodeIf );
2980 if( ! iface->useInterface || iface->externalQuery )
2983 nodeDS = iface->listSource;
2987 /* Read address book */
2988 if( addrindex_ds_get_modify_flag( ds ) ) {
2989 addrindex_ds_read_data( ds );
2992 if( ! addrindex_ds_get_read_flag( ds ) ) {
2993 addrindex_ds_read_data( ds );
2996 /* Check addressbook name */
2997 cur_bname = addrindex_ds_get_name( ds );
2999 /* Get all persons */
3000 listP = addrindex_ds_get_all_persons( ds );
3003 ItemPerson *person = nodeP->data;
3005 /* Return all ItemPerson's if attr is NULL */
3006 if( attr == NULL ) {
3007 callBackFunc(person, cur_bname);
3010 /* Return ItemPerson's with specific attribute */
3012 nodeA = person->listAttrib;
3013 /* Process each User Attribute */
3015 UserAttribute *attrib = nodeA->data;
3017 !strcmp( attrib->name,attr ) ) {
3018 callBackFunc(person, cur_bname);
3020 nodeA = g_list_next( nodeA );
3023 nodeP = g_list_next( nodeP );
3025 /* Free up the list */
3026 g_list_free( listP );
3028 nodeDS = g_list_next( nodeDS );