1635cdaaa36093bbe18195757188872a9fe21b10
[claws.git] / src / ldif.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2001-2003 Match Grun
4  *
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.
9  *
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.
14  *
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  */
19
20 /*
21  * Functions necessary to access LDIF files (LDAP Data Interchange Format
22  * files).
23  */
24
25 #include <glib.h>
26 #include <glib/gi18n.h>
27 #include <string.h>
28 #include <sys/stat.h>
29
30 #include "mgutils.h"
31 #include "ldif.h"
32 #include "addritem.h"
33 #include "addrcache.h"
34
35 #include "base64.h"
36 #include "utils.h"
37
38 #define LDIF_SEP_TAG    ':'
39 #define LDIF_LANG_TAG   ';'
40
41 /**
42  * Create new object.
43  * \return Initialized LDIF file object.
44  */
45 LdifFile *ldif_create() {
46         LdifFile *ldifFile;
47         ldifFile = g_new0( LdifFile, 1 );
48         ldifFile->path = NULL;
49         ldifFile->file = NULL;
50         ldifFile->bufptr = ldifFile->buffer;
51         ldifFile->hashFields = g_hash_table_new( g_str_hash, g_str_equal );
52         ldifFile->tempList = NULL;
53         ldifFile->dirtyFlag = TRUE;
54         ldifFile->accessFlag = FALSE;
55         ldifFile->retVal = MGU_SUCCESS;
56         ldifFile->cbProgress = NULL;
57         ldifFile->importCount = 0;
58         return ldifFile;
59 }
60
61 /**
62  * Specify full file specification of LDIF file.
63  * \param ldifFile LDIF import control object.
64  * \param value    Value of access flag.
65  */
66 void ldif_set_file( LdifFile *ldifFile, const gchar *value ) {
67         g_return_if_fail( ldifFile != NULL );
68
69         if( ldifFile->path ) {
70                 if( strcmp( ldifFile->path, value ) != 0 )
71                         ldifFile->dirtyFlag = TRUE;
72         }
73         else {
74                 ldifFile->dirtyFlag = TRUE;
75         }
76         ldifFile->path = mgu_replace_string( ldifFile->path, value );
77         g_strstrip( ldifFile->path );
78         ldifFile->importCount = 0;
79 }
80
81 /**
82  * Set the file access indicator.
83  * \param ldifFile LDIF import control object.
84  * \param value    File specification.
85  */
86 void ldif_set_accessed( LdifFile *ldifFile, const gboolean value ) {
87         g_return_if_fail( ldifFile != NULL );
88         ldifFile->accessFlag = value;
89 }
90
91 /**
92  * Register a progress indicator callback function.
93  *
94  * \param ldifFile LDIF import control object.
95  * \param func     Function to be called. When called, the function will be
96  *                 passed the following arguments:
97  *
98  * <ul>
99  * <li>LdifFile object,</li>
100  * <li>File size (long),</li>
101  * <li>Current position (long)</li>
102  * </ul>
103  */
104 void ldif_set_callback( LdifFile *ldifFile, void *func ) {
105         ldifFile->cbProgress = func;
106 }
107
108 /**
109  * Create field record object.
110  * \return Initialized LDIF field object.
111  */
112 static Ldif_FieldRec *ldif_create_fieldrec( const gchar *field ) {
113         Ldif_FieldRec *rec = g_new0( Ldif_FieldRec, 1 );
114         rec->tagName = g_strdup( field );
115         rec->userName = NULL;
116         rec->reserved = FALSE;
117         rec->selected = FALSE;
118         return rec;
119 }
120
121 /**
122  * Free field record object.
123  * \param rec LDIF field object.
124  */
125 static void ldif_free_fieldrec( Ldif_FieldRec *rec ) {
126         if( rec ) {
127                 g_free( rec->tagName );
128                 g_free( rec->userName );
129                 rec->tagName = NULL;
130                 rec->userName = NULL;
131                 rec->reserved = FALSE;
132                 rec->selected = FALSE;
133                 g_free( rec );
134         }
135 }
136
137 /**
138  * Set user name for field record.
139  * \param rec   LDIF field object.
140  * \param value User name to set. Note that reserved fields cannot be
141  *              named.
142  */
143 void ldif_field_set_name( Ldif_FieldRec *rec, const gchar *value ) {
144         g_return_if_fail( rec != NULL );
145
146         if( ! rec->reserved ) {
147                 rec->userName = mgu_replace_string( rec->userName, value );
148                 g_strstrip( rec->userName );
149         }
150 }
151
152 /**
153  * Specify selection for field record.
154  * \param rec   LDIF field object.
155  * \param value Set to <i>TRUE</i> to select field. Note that reserved
156  *              fields cannot be unselected.
157  */
158 void ldif_field_set_selected( Ldif_FieldRec *rec, const gboolean value ) {
159         g_return_if_fail( rec != NULL );
160
161         if( ! rec->reserved ) {
162                 rec->selected = value;
163         }
164 }
165
166 /**
167  * Toggle selection for field record. Note that reserved fields cannot be
168  * toggled.
169  * \param rec   LDIF field object.
170  */
171 void ldif_field_toggle( Ldif_FieldRec *rec ) {
172         g_return_if_fail( rec != NULL );
173
174         if( ! rec->reserved ) {
175                 rec->selected = !rec->selected;
176         }
177 }
178
179 /**
180  * Free hash table entry visitor function.
181  * \param  key   Key.
182  * \param  value Value (the LDIF field record).
183  * \param  data  User data.
184  * \return <code>-1</code>.
185 */
186 static gint ldif_hash_free_vis( gpointer key, gpointer value, gpointer data ) {
187         ldif_free_fieldrec( ( Ldif_FieldRec * ) value );
188         value = NULL;
189         key = NULL;
190         return -1;
191 }
192
193 /**
194  * Free up object by releasing internal memory.
195  * \param ldifFile LDIF import control object.
196  */
197 void ldif_free( LdifFile *ldifFile ) {
198         g_return_if_fail( ldifFile != NULL );
199
200         /* Close file */
201         if( ldifFile->file ) fclose( ldifFile->file );
202
203         /* Free internal stuff */
204         g_free( ldifFile->path );
205
206         /* Free field list */
207         g_hash_table_foreach_remove( ldifFile->hashFields, ldif_hash_free_vis, NULL );
208         g_hash_table_destroy( ldifFile->hashFields );
209         ldifFile->hashFields = NULL;
210
211         /* Clear pointers */
212         ldifFile->file = NULL;
213         ldifFile->path = NULL;
214         ldifFile->retVal = MGU_SUCCESS;
215         ldifFile->tempList = NULL;
216         ldifFile->dirtyFlag = FALSE;
217         ldifFile->accessFlag = FALSE;
218         ldifFile->cbProgress = NULL;
219
220         /* Now release file object */
221         g_free( ldifFile );
222 }
223
224 /**
225  * Display field record.
226  * \param rec    LDIF field object.
227  * \param stream File output stream.
228  */
229 void ldif_print_fieldrec( Ldif_FieldRec *rec, FILE *stream ) {
230         fprintf( stream, "\ttag:\t%s", rec->reserved ? "yes" : "no" );
231         fprintf( stream, "\t%s", rec->selected ? "yes" : "no" );
232         fprintf( stream, "\t:%s:\t:%s:\n", rec->userName, rec->tagName );
233 }
234
235 /**
236  * Display field record.
237  * \param key   Key.
238  * \param value Value (the LDIF field record).
239  * \param data  User data (file output stream).
240  * 
241  */
242 static void ldif_print_file_vis( gpointer key, gpointer value, gpointer data ) {
243         Ldif_FieldRec *rec = value;
244         FILE *stream = data;
245         ldif_print_fieldrec( rec, stream );
246 }
247
248 /**
249  * Display object to specified stream.
250  * \param ldifFile LDIF import control object.
251  * \param stream   File output stream.
252  */
253 void ldif_print_file( LdifFile *ldifFile, FILE *stream ) {
254         g_return_if_fail( ldifFile != NULL );
255         fprintf( stream, "LDIF File:\n" );
256         fprintf( stream, "file spec: '%s'\n", ldifFile->path );
257         fprintf( stream, "  ret val: %d\n",   ldifFile->retVal );
258         fprintf( stream, "   fields: {\n" );
259         g_hash_table_foreach( ldifFile->hashFields, ldif_print_file_vis, stream );
260         fprintf( stream, "} ---\n" );
261 }
262
263 /**
264  * Open file for read.
265  * \param  ldifFile LDIF import control object.
266  * \return <i>TRUE</i> if file opened successfully.
267  */
268 static gint ldif_open_file( LdifFile* ldifFile ) {
269         /* printf( "Opening file\n" ); */
270         if( ldifFile->path ) {
271                 ldifFile->file = g_fopen( ldifFile->path, "rb" );
272                 if( ! ldifFile->file ) {
273                         /* printf( "can't open %s\n", ldifFile->path ); */
274                         ldifFile->retVal = MGU_OPEN_FILE;
275                         return ldifFile->retVal;
276                 }
277         }
278         else {
279                 /* printf( "file not specified\n" ); */
280                 ldifFile->retVal = MGU_NO_FILE;
281                 return ldifFile->retVal;
282         }
283
284         /* Setup a buffer area */
285         ldifFile->buffer[0] = '\0';
286         ldifFile->bufptr = ldifFile->buffer;
287         ldifFile->retVal = MGU_SUCCESS;
288         return ldifFile->retVal;
289 }
290
291 /**
292  * Close file.
293  * \param  ldifFile LDIF import control object.
294  */
295 static void ldif_close_file( LdifFile *ldifFile ) {
296         g_return_if_fail( ldifFile != NULL );
297         if( ldifFile->file ) fclose( ldifFile->file );
298         ldifFile->file = NULL;
299 }
300
301 /**
302  * Read line of text from file.
303  * \param  ldifFile LDIF import control object.
304  * \return ptr to buffer where line starts.
305  */
306 static gchar *ldif_get_line( LdifFile *ldifFile ) {
307         gchar buf[ LDIFBUFSIZE ];
308         gint ch;
309         int i = 0;
310
311         if( feof( ldifFile->file ) ) 
312                 return NULL;
313
314         while( i < LDIFBUFSIZE-1 ) {
315                 ch = fgetc( ldifFile->file );
316                 if( ch == '\0' || ch == EOF ) {
317                         if( i == 0 ) return NULL;
318                         break;
319                 }
320 #if HAVE_DOSISH_SYSTEM
321 #else
322                 if( ch == '\r' ) 
323                         continue;
324 #endif
325                 if( ch == '\n' ) 
326                         break;
327                 buf[i] = ch;
328                 i++;
329         }
330         buf[i] = '\0';
331
332         /* Return a copy of buffer */
333         return g_strdup( buf );
334 }
335
336 /**
337  * Parse tag name from line buffer.
338  * \param  line Buffer.
339  * \param  flag64 Base-64 encoder flag.
340  * \return Buffer containing the tag name, or NULL if no delimiter char found.
341  *         If a double delimiter (::) is found, flag64 is set.
342  */
343 static gchar *ldif_get_tagname( char* line, gboolean *flag64 ) {
344         gint len = 0;
345         gchar *tag = NULL;
346         gchar *lptr = line;
347         gchar *sptr = NULL;
348
349         while( *lptr++ ) {
350                 /* Check for language tag */
351                 if( *lptr == LDIF_LANG_TAG ) {
352                         if( sptr == NULL ) sptr = lptr;
353                 }
354
355                 /* Check for delimiter */
356                 if( *lptr == LDIF_SEP_TAG ) {
357                         if( sptr ) {
358                                 len = sptr - line;
359                         }
360                         else {
361                                 len = lptr - line;
362                         }
363
364                         /* Base-64 encoding? */
365                         if( * ++lptr == LDIF_SEP_TAG ) *flag64 = TRUE;
366
367                         tag = g_strndup( line, len+1 );
368                         tag[ len ] = '\0';
369                         g_strdown( tag );
370                         return tag;
371                 }
372         }
373         return tag;
374 }
375
376 /**
377  * Parse tag value from line buffer.
378  * \param  line Buffer.
379  * \return Buffer containing the tag value. Empty string is returned if
380  *         no delimiter char found.
381  */
382 static gchar *ldif_get_tagvalue( gchar* line ) {
383         gchar *value = NULL;
384         gchar *start = NULL;
385         gchar *lptr;
386         gint len = 0;
387
388         for( lptr = line; *lptr; lptr++ ) {
389                 if( *lptr == LDIF_SEP_TAG ) {
390                         if( ! start )
391                                 start = lptr + 1;
392                 }
393         }
394         if( start ) {
395                 if( *start == LDIF_SEP_TAG ) start++;
396                 len = lptr - start;
397                 value = g_strndup( start, len+1 );
398                 g_strstrip( value );
399         }
400         else {
401                 /* Ensure that we get an empty string */
402                 value = g_strndup( "", 1 );
403         }
404         value[ len ] = '\0';
405         return value;
406 }
407
408 /**
409  * Parsed address data record.
410  */
411 typedef struct _Ldif_ParsedRec_ Ldif_ParsedRec;
412 struct _Ldif_ParsedRec_ {
413         GSList *listCName;
414         GSList *listFName;
415         GSList *listLName;
416         GSList *listNName;
417         GSList *listAddress;
418         GSList *listID;
419         GSList *userAttr;
420 };
421
422 /**
423  * User attribute data record.
424  */
425 typedef struct _Ldif_UserAttr_ Ldif_UserAttr;
426 struct _Ldif_UserAttr_ {
427         gchar *name;
428         gchar *value;
429 };
430
431 /**
432  * Build an address list entry and append to list of address items in the
433  * address cache. Name is formatted as "<first-name> <last-name>".
434  * \param ldifFile LDIF import control object.
435  * \param rec      LDIF field object.
436  * \param cache    Address cache to be populated with data.
437  */
438 static void ldif_build_items(
439                 LdifFile *ldifFile, Ldif_ParsedRec *rec, AddressCache *cache )
440 {
441         GSList *nodeFirst;
442         GSList *nodeAddress;
443         GSList *nodeAttr;
444         gchar *firstName = NULL, *lastName = NULL, *fullName = NULL;
445         gchar *nickName = NULL;
446         gint iLen = 0, iLenT = 0;
447         ItemPerson *person;
448         ItemEMail *email;
449
450         nodeAddress = rec->listAddress;
451         if( nodeAddress == NULL ) return;
452
453         /* Find longest first name in list */
454         nodeFirst = rec->listFName;
455         while( nodeFirst ) {
456                 if( firstName == NULL ) {
457                         firstName = nodeFirst->data;
458                         iLen = strlen( firstName );
459                 }
460                 else {
461                         if( ( iLenT = strlen( nodeFirst->data ) ) > iLen ) {
462                                 firstName = nodeFirst->data;
463                                 iLen = iLenT;
464                         }
465                 }
466                 nodeFirst = g_slist_next( nodeFirst );
467         }
468
469         /* Format name */
470         if( rec->listLName ) {
471                 lastName = rec->listLName->data;
472         }
473
474         if( firstName ) {
475                 if( lastName ) {
476                         fullName = g_strdup_printf(
477                                 "%s %s", firstName, lastName );
478                 }
479                 else {
480                         fullName = g_strdup_printf( "%s", firstName );
481                 }
482         }
483         else {
484                 if( lastName ) {
485                         fullName = g_strdup_printf( "%s", lastName );
486                 }
487         }
488         if( fullName ) {
489                 g_strchug( fullName ); g_strchomp( fullName );
490         }
491
492         if( rec->listNName ) {
493                 nickName = rec->listNName->data;
494         }
495
496         person = addritem_create_item_person();
497         addritem_person_set_common_name( person, fullName );
498         addritem_person_set_first_name( person, firstName );
499         addritem_person_set_last_name( person, lastName );
500         addritem_person_set_nick_name( person, nickName );
501         addrcache_id_person( cache, person );
502         addrcache_add_person( cache, person );
503         ++ldifFile->importCount;
504
505         /* Add address item */
506         while( nodeAddress ) {
507                 email = addritem_create_item_email();
508                 addritem_email_set_address( email, nodeAddress->data );
509                 addrcache_id_email( cache, email );
510                 addrcache_person_add_email( cache, person, email );
511                 nodeAddress = g_slist_next( nodeAddress );
512         }
513         g_free( fullName );
514         fullName = firstName = lastName = NULL;
515
516         /* Add user attributes */
517         nodeAttr = rec->userAttr;
518         while( nodeAttr ) {
519                 Ldif_UserAttr *attr = nodeAttr->data;
520                 UserAttribute *attrib = addritem_create_attribute();
521                 addritem_attrib_set_name( attrib, attr->name );
522                 addritem_attrib_set_value( attrib, attr->value );
523                 addritem_person_add_attribute( person, attrib );
524                 nodeAttr = g_slist_next( nodeAttr );
525         }
526         nodeAttr = NULL;
527 }
528
529 /**
530  * Add selected field as user attribute.
531  * \param rec       LDIF field object.
532  * \param tagName   LDIF tag name.
533  * \param tagValue  Data value.
534  * \param hashField Hash table to populate.
535  */
536 static void ldif_add_user_attr(
537                 Ldif_ParsedRec *rec, gchar *tagName, gchar *tagValue,
538                 GHashTable *hashField )
539 {
540         Ldif_FieldRec *fld = NULL;
541         Ldif_UserAttr *attr = NULL;
542         gchar *name;
543
544         fld = g_hash_table_lookup( hashField, tagName );
545         if( fld ) {
546                 if( ! fld->selected ) return;
547
548                 name = fld->tagName;
549                 if( fld->userName ) {
550                         name = fld->userName;
551                 }
552                 attr = g_new0( Ldif_UserAttr, 1 );
553                 attr->name = g_strdup( name );
554                 attr->value = g_strdup( tagValue );
555                 rec->userAttr = g_slist_append( rec->userAttr, attr );
556         }
557 }
558
559 /**
560  * Add value to parsed data.
561  * \param rec       LDIF field object.
562  * \param tagName   LDIF tag name.
563  * \param tagValue  Data value.
564  * \param hashField Hash table to populate.
565  */
566 static void ldif_add_value(
567                Ldif_ParsedRec *rec, gchar *tagName, gchar *tagValue,
568                GHashTable *hashField )
569 {
570         gchar *nm, *val;
571
572         nm = g_strdup( tagName );
573         g_strdown( nm );
574         if( tagValue ) {
575                 val = g_strdup( tagValue );
576         }
577         else {
578                 val = g_strdup( "" );
579         }
580         g_strstrip( val );
581
582         if( g_utf8_collate( nm, LDIF_TAG_COMMONNAME ) == 0 ) {
583                 rec->listCName = g_slist_append( rec->listCName, val );
584         }
585         else if( g_utf8_collate( nm, LDIF_TAG_FIRSTNAME ) == 0 ) {
586                 rec->listFName = g_slist_append( rec->listFName, val );
587         }
588         else if( g_utf8_collate( nm, LDIF_TAG_LASTNAME ) == 0 ) {
589                 rec->listLName = g_slist_append( rec->listLName, val );
590         }
591         else if( g_utf8_collate( nm, LDIF_TAG_NICKNAME ) == 0 ) {
592                 rec->listNName = g_slist_append( rec->listNName, val );
593         }
594         else if( g_utf8_collate( nm, LDIF_TAG_EMAIL ) == 0 ) {
595                 rec->listAddress = g_slist_append( rec->listAddress, val );
596         }
597         else {
598                 /* Add field as user attribute */
599                 ldif_add_user_attr( rec, tagName, tagValue, hashField );
600         }
601         g_free( nm );
602 }
603
604 /**
605  * Clear parsed data record.
606  * \param rec LDIF field object.
607  */
608 static void ldif_clear_rec( Ldif_ParsedRec *rec ) {
609         GSList *list;
610
611         /* Free up user attributes */
612         list = rec->userAttr;
613         while( list ) {
614                 Ldif_UserAttr *attr = list->data;
615                 g_free( attr->name );
616                 g_free( attr->value );
617                 g_free( attr );
618                 list = g_slist_next( list );
619         }
620         g_slist_free( rec->userAttr );
621
622         g_slist_free( rec->listCName );
623         g_slist_free( rec->listFName );
624         g_slist_free( rec->listLName );
625         g_slist_free( rec->listNName );
626         g_slist_free( rec->listAddress );
627         g_slist_free( rec->listID );
628
629         rec->userAttr = NULL;
630         rec->listCName = NULL;
631         rec->listFName = NULL;
632         rec->listLName = NULL;
633         rec->listNName = NULL;
634         rec->listAddress = NULL;
635         rec->listID = NULL;
636 }
637
638 #if 0
639 /**
640  * Print parsed data.
641  * \param rec    LDIF field object.
642  * \param stream Output stream.
643  */
644 static void ldif_print_record( Ldif_ParsedRec *rec, FILE *stream ) {
645         GSList *list;
646
647         fprintf( stream, "LDIF Parsed Record:\n" );
648         fprintf( stream, "common name:" );
649         mgu_print_list( rec->listCName, stream );
650         if( ! rec->listCName ) fprintf( stream, "\n" );
651         fprintf( stream, "first name:" );
652         mgu_print_list( rec->listFName, stream );
653         if( ! rec->listFName ) fprintf( stream, "\n" );
654         fprintf( stream, "last name:" );
655         mgu_print_list( rec->listLName, stream );
656         if( ! rec->listLName ) fprintf( stream, "\n" );
657         fprintf( stream, "nick name:" );
658         mgu_print_list( rec->listNName, stream );
659         if( ! rec->listNName ) fprintf( stream, "\n" );
660         fprintf( stream, "address:" );
661         mgu_print_list( rec->listAddress, stream );
662         if( ! rec->listAddress ) fprintf( stream, "\n" );
663         fprintf( stream, "id:" );
664         mgu_print_list( rec->listID, stream );
665         if( ! rec->listID ) fprintf( stream, "\n" );
666
667         list = rec->userAttr;
668         while( list ) {
669                 Ldif_UserAttr *attr = list->data;
670                 fprintf( stream, "n/v:\t%s:\t:%s:\n", attr->name, attr->value );
671                 list = g_slist_next( list );
672         }
673         list = NULL;
674 }
675 #endif
676
677 /**
678  * Read file data into address cache.
679  * Note that one LDIF record identifies one entity uniquely with the
680  * distinguished name (dn) tag. Each person can have multiple E-Mail
681  * addresses. Also, each person can have many common name (cn) tags.
682  *
683  * \param  ldifFile LDIF import control object.
684  * \param  cache    Address cache to be populated with data.
685  */
686 static void ldif_read_file( LdifFile *ldifFile, AddressCache *cache ) {
687         gchar *tagName = NULL, *tagValue = NULL;
688         gchar *lastTag = NULL, *fullValue = NULL;
689         GSList *listValue = NULL;
690         gboolean flagEOF = FALSE, flagEOR = FALSE;
691         gboolean flag64 = FALSE, last64 = FALSE;
692         Ldif_ParsedRec *rec;
693         long posEnd = 0L;
694         long posCur = 0L;
695         GHashTable *hashField;
696
697         hashField = ldifFile->hashFields;
698         rec = g_new0( Ldif_ParsedRec, 1 );
699         ldif_clear_rec( rec );
700
701         /* Find EOF for progress indicator */
702         fseek( ldifFile->file, 0L, SEEK_END );
703         posEnd = ftell( ldifFile->file );
704         fseek( ldifFile->file, 0L, SEEK_SET );
705
706         while( ! flagEOF ) {
707                 gchar *line =  ldif_get_line( ldifFile );
708
709                 posCur = ftell( ldifFile->file );
710                 if( ldifFile->cbProgress ) {
711                         /* Call progress indicator */
712                         ( ldifFile->cbProgress ) ( ldifFile, & posEnd, & posCur );
713                 }
714
715                 flag64 = FALSE;
716                 if( line == NULL ) {
717                         flagEOF = flagEOR = TRUE;
718                 }
719                 else if( *line == '\0' ) {
720                         flagEOR = TRUE;
721                 }
722
723                 if( flagEOR ) {
724                         /* EOR, Output address data */
725                         if( lastTag ) {
726                                 /* Save record */
727                                 fullValue = mgu_list_coalesce( listValue );
728
729                                 /* Base-64 encoded data */
730                                 /*
731                                 if( last64 ) {
732                                         ldif_dump_b64( fullValue );
733                                 }
734                                 */
735
736                                 ldif_add_value( rec, lastTag, fullValue, hashField );
737                                 /* ldif_print_record( rec, stdout ); */
738                                 ldif_build_items( ldifFile, rec, cache );
739                                 ldif_clear_rec( rec );
740                                 g_free( lastTag );
741                                 mgu_free_list( listValue );
742                                 lastTag = NULL;
743                                 listValue = NULL;
744                                 last64 = FALSE;
745                         }
746                 }
747                 if( line ) {
748                         flagEOR = FALSE;
749                         if( *line == ' ' ) {
750                                 /* Continuation line */
751                                 listValue = g_slist_append(
752                                         listValue, g_strdup( line+1 ) );
753                         }
754                         else if( *line == '=' ) {
755                                 /* Base-64 encoded continuation field */
756                                 listValue = g_slist_append(
757                                         listValue, g_strdup( line ) );
758                         }
759                         else {
760                                 /* Parse line */
761                                 tagName = ldif_get_tagname( line, &flag64 );
762                                 if( tagName ) {
763                                         tagValue = ldif_get_tagvalue( line );
764                                         if( tagValue ) {
765                                                 if( lastTag ) {
766                                                         /* Save data */
767                                                         fullValue =
768                                                                 mgu_list_coalesce( listValue );
769                                                         /* Base-64 encoded data */
770                                                         /*
771                                                         if( last64 ) {
772                                                                 ldif_dump_b64( fullValue );
773                                                         }
774                                                         */
775
776                                                         ldif_add_value(
777                                                                 rec, lastTag, fullValue,
778                                                                 hashField );
779                                                         g_free( lastTag );
780                                                         mgu_free_list( listValue );
781                                                         lastTag = NULL;
782                                                         listValue = NULL;
783                                                         last64 = FALSE;
784                                                 }
785
786                                                 lastTag = g_strdup( tagName );
787                                                 listValue = g_slist_append(
788                                                         listValue,
789                                                         g_strdup( tagValue ) );
790                                                 g_free( tagValue );
791                                                 last64 = flag64;
792                                         }
793                                         g_free( tagName );
794                                 }
795                         }
796                 }
797                 g_free( line );
798         }
799
800         /* Release data */
801         ldif_clear_rec( rec );
802         g_free( rec );
803         g_free( lastTag );
804         mgu_free_list( listValue );
805 }
806
807 /**
808  * Add list of field names to hash table.
809  * \param table Hashtable.
810  * \param list  List of fields.
811  */
812 static void ldif_hash_add_list( GHashTable *table, GSList *list ) {
813         GSList *node = list;
814
815         /* mgu_print_list( list, stdout ); */
816         while( node ) {
817                 gchar *tag = node->data;
818                 if( ! g_hash_table_lookup( table, tag ) ) {
819                         Ldif_FieldRec *rec = NULL;
820                         gchar *key = g_strdup( tag );
821
822                         rec = ldif_create_fieldrec( tag );
823                         if( g_utf8_collate( tag, LDIF_TAG_DN ) == 0 ) {
824                                 rec->reserved = rec->selected = TRUE;
825                                 rec->userName = g_strdup( "dn" );
826                         }
827                         else if( g_utf8_collate( tag, LDIF_TAG_COMMONNAME ) == 0 ) {
828                                 rec->reserved = rec->selected = TRUE;
829                                 rec->userName = g_strdup( _( "Display Name" ) );
830                         }
831                         else if( g_utf8_collate( tag, LDIF_TAG_FIRSTNAME ) == 0 ) {
832                                 rec->reserved = rec->selected = TRUE;
833                                 rec->userName = g_strdup( _( "First Name" ) );
834                         }
835                         else if( g_utf8_collate( tag, LDIF_TAG_LASTNAME ) == 0 ) {
836                                 rec->reserved = rec->selected = TRUE;
837                                 rec->userName = g_strdup( _( "Last Name" ) );
838                         }
839                         else if( g_utf8_collate( tag, LDIF_TAG_NICKNAME ) == 0 ) {
840                                 rec->reserved = rec->selected = TRUE;
841                                 rec->userName = g_strdup( _( "Nick Name" ) );
842                         }
843                         else if( g_utf8_collate( tag, LDIF_TAG_EMAIL ) == 0 ) {
844                                 rec->reserved = rec->selected = TRUE;
845                                 rec->userName = g_strdup( _( "E-Mail Address" ) );
846                         }
847                         g_hash_table_insert( table, key, rec );
848                 }
849                 node = g_slist_next( node );
850         }
851 }
852
853 /**
854  * Sorted list comparison function.
855  * \param  ptr1 First field.
856  * \param  ptr2 Second field.
857  * \return <code>-1, 0, +1</code> if first record less than, equal,
858  *         greater than second.
859  */
860 static gint ldif_field_compare( gconstpointer ptr1, gconstpointer ptr2 ) {
861         const Ldif_FieldRec *rec1 = ptr1;
862         const Ldif_FieldRec *rec2 = ptr2;
863
864         if( rec1->reserved ) {
865                 if( ! rec2->reserved ) {
866                         return +1;
867                 }
868         }
869         else {
870                 if( rec2->reserved ) {
871                         return -1;
872                 }
873         }
874         return g_utf8_collate( rec1->tagName, rec2->tagName );
875 }
876
877 /*
878  * Append hash table entry to list - visitor function.
879  * \param key   Key.
880  * \param value Data value.
881  * \param data  User data (the LDIF import control object).
882  */
883 static void ldif_hash2list_vis( gpointer key, gpointer value, gpointer data ) {
884         LdifFile *ldf = data;
885         ldf->tempList =
886                 g_list_insert_sorted( ldf->tempList, value, ldif_field_compare );
887 }
888
889 /**
890  * Read tag names for file data.
891  * \param  ldifFile LDIF import control object.
892  */
893 static void ldif_read_tag_list( LdifFile *ldifFile ) {
894         gchar *tagName = NULL;
895         GSList *listTags = NULL;
896         gboolean flagEOF = FALSE, flagEOR = FALSE, flagMail = FALSE;
897         gboolean flag64 = FALSE;
898         long posEnd = 0L;
899         long posCur = 0L;
900
901         /* Clear hash table */
902         g_hash_table_foreach_remove(
903                 ldifFile->hashFields, ldif_hash_free_vis, NULL );
904
905         /* Find EOF for progress indicator */
906         fseek( ldifFile->file, 0L, SEEK_END );
907         posEnd = ftell( ldifFile->file );
908         fseek( ldifFile->file, 0L, SEEK_SET );
909
910         /* Process file */
911         while( ! flagEOF ) {
912                 gchar *line = ldif_get_line( ldifFile );
913                 posCur = ftell( ldifFile->file );
914                 if( ldifFile->cbProgress ) {
915                         /* Call progress indicator */
916                         ( ldifFile->cbProgress ) ( ldifFile, & posEnd, & posCur );
917                 }
918
919                 flag64 = FALSE;
920                 if( line == NULL ) {
921                         flagEOF = flagEOR = TRUE;
922                 }
923                 else if( *line == '\0' ) {
924                         flagEOR = TRUE;
925                 }
926
927                 if( flagEOR ) {
928                         /* EOR, Output address data */
929                         /* Save field list to hash table */
930                         if( flagMail ) {
931                                 ldif_hash_add_list(
932                                         ldifFile->hashFields, listTags );
933                         }
934                         mgu_free_list( listTags );
935                         listTags = NULL;
936                         flagMail = FALSE;
937                 }
938                 if( line ) {
939                         flagEOR = FALSE;
940                         if( *line == ' ' ) {
941                                 /* Continuation line */
942                         }
943                         else if( *line == '=' ) {
944                                 /* Base-64 encoded continuation field */
945                         }
946                         else {
947                                 /* Parse line */
948                                 tagName = ldif_get_tagname( line, &flag64 );
949                                 if( tagName ) {
950                                         /* Add tag to list */
951                                         listTags = g_slist_append( listTags, tagName );
952
953                                         if( g_utf8_collate(
954                                                 tagName, LDIF_TAG_EMAIL ) == 0 )
955                                         {
956                                                 flagMail = TRUE;
957                                         }
958                                 }
959                         }
960                 }
961                 g_free( line );
962         }
963
964         /* Release data */
965         mgu_free_list( listTags );
966         listTags = NULL;
967 }
968
969 /**
970  * Read file into list. Main entry point
971  * \param  ldifFile LDIF import control object.
972  * \param  cache    Address cache to load.
973  * \return Status code.
974  */
975 gint ldif_import_data( LdifFile *ldifFile, AddressCache *cache ) {
976         g_return_val_if_fail( ldifFile != NULL, MGU_BAD_ARGS );
977         ldifFile->retVal = MGU_SUCCESS;
978         addrcache_clear( cache );
979         cache->dataRead = FALSE;
980         ldif_open_file( ldifFile );
981         if( ldifFile->retVal == MGU_SUCCESS ) {
982                 /* Read data into the cache */
983                 ldif_read_file( ldifFile, cache );
984                 ldif_close_file( ldifFile );
985
986                 /* Mark cache */
987                 cache->modified = FALSE;
988                 cache->dataRead = TRUE;
989         }
990         return ldifFile->retVal;
991 }
992
993 /**
994  * Process entire file reading list of unique fields. List of fields may be
995  * accessed with the <code>ldif_get_fieldlist()</code> function.
996  * \param  ldifFile LDIF import control object.
997  * \return Status code.
998  */
999 gint ldif_read_tags( LdifFile *ldifFile ) {
1000         g_return_val_if_fail( ldifFile != NULL, MGU_BAD_ARGS );
1001         ldifFile->retVal = MGU_SUCCESS;
1002         if( ldifFile->dirtyFlag ) {
1003                 ldif_open_file( ldifFile );
1004                 if( ldifFile->retVal == MGU_SUCCESS ) {
1005                         /* Read data into the cache */
1006                         ldif_read_tag_list( ldifFile );
1007                         ldif_close_file( ldifFile );
1008                         ldifFile->dirtyFlag = FALSE;
1009                         ldifFile->accessFlag = TRUE;
1010                 }
1011         }
1012         return ldifFile->retVal;
1013 }
1014
1015 /**
1016  * Return list of fields for LDIF file.
1017  * \param  ldifFile LDIF import control object.
1018  * \return Linked list of <code>Ldif_FieldRec</code> objects. This list may be
1019  *         <code>g_free()</code>. Note that the objects in the list should not
1020  *         be freed since they refer to objects inside the internal cache.
1021  *         These objects will be freed when LDIF file object is freed.
1022  */
1023 GList *ldif_get_fieldlist( LdifFile *ldifFile ) {
1024         GList *list = NULL;
1025
1026         g_return_val_if_fail( ldifFile != NULL, NULL );
1027         if( ldifFile->hashFields ) {
1028                 ldifFile->tempList = NULL;
1029                 g_hash_table_foreach( ldifFile->hashFields, ldif_hash2list_vis, ldifFile );
1030                 list = ldifFile->tempList;
1031                 ldifFile->tempList = NULL;
1032         }
1033         return list;
1034 }
1035
1036 /**
1037  * Output LDIF name-value pair to stream. Only non-empty names and values will
1038  * be output to file.
1039  * \param stream File output stream.
1040  * \param name   Name.
1041  * \param value  Data value.
1042  * \return <i>TRUE</i> if data output.
1043  */
1044 gboolean ldif_write_value( FILE *stream, const gchar *name, const gchar *value ) {
1045         if( name == NULL ) return FALSE;
1046         if( value == NULL ) return FALSE;
1047         if( strlen( name ) < 1 ) return FALSE;
1048         if( strlen( value ) < 1 ) return FALSE;
1049         fprintf( stream, "%s: ", name );
1050         fprintf( stream, "%s\n", value );
1051         return TRUE;
1052 }
1053
1054 /**
1055  * Output LDIF End of Record to stream.
1056  * \param stream File output stream.
1057  * \return <i>TRUE</i> if data output.
1058  */
1059 void ldif_write_eor( FILE *stream ) {
1060         /* Simple but caller should not need to know how to end record. */
1061         fprintf( stream, "\n" );
1062 }
1063
1064 /*
1065  * ============================================================================
1066  * End of Source.
1067  * ============================================================================
1068  */
1069