* src/pine.c
[claws.git] / src / pine.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2002 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Functions necessary to access Pine address book file.
22  */
23
24 #include <sys/stat.h>
25 #include <glib.h>
26 #include <string.h>
27
28 #include "utils.h"
29 #include "mgutils.h"
30 #include "pine.h"
31 #include "addritem.h"
32 #include "addrcache.h"
33
34 #define PINE_HOME_FILE  ".addressbook"
35 #define PINEBUFSIZE     2048
36 #define CHAR_QUOTE      '\"'
37 #define CHAR_APOS       '\''
38 #define CHAR_COMMA      ','
39 #define CHAR_AT         '@'
40
41 /*
42 * Create new object.
43 */
44 PineFile *pine_create() {
45         PineFile *pineFile;
46         pineFile = g_new0( PineFile, 1 );
47         pineFile->path = NULL;
48         pineFile->file = NULL;
49         pineFile->retVal = MGU_SUCCESS;
50         pineFile->uniqTable = g_hash_table_new( g_str_hash, g_str_equal );
51         pineFile->cbProgress = NULL;
52         return pineFile;
53 }
54
55 /*
56 * Properties...
57 */
58 void pine_set_file( PineFile* pineFile, const gchar *value ) {
59         g_return_if_fail( pineFile != NULL );
60         pineFile->path = mgu_replace_string( pineFile->path, value );
61         g_strstrip( pineFile->path );
62 }
63
64 /*
65 * Register a callback function. When called, the function will be passed
66 * the following arguments:
67 *       PineFile object,
68 *       File size (long),
69 *       Current position (long)
70 * This can be used for a progress indicator.
71 */
72 void pine_set_callback( PineFile *pineFile, void *func ) {
73         pineFile->cbProgress = func;
74 }
75
76 /*
77  * Free key in table.
78  */
79 static gint pine_free_table_vis( gpointer key, gpointer value, gpointer data ) {
80         g_free( key );
81         key = NULL;
82         value = NULL;
83         return TRUE;
84 }
85
86 /*
87 * Free up object by releasing internal memory.
88 */
89 void pine_free( PineFile *pineFile ) {
90         g_return_if_fail( pineFile != NULL );
91
92         /* Close file */
93         if( pineFile->file ) fclose( pineFile->file );
94
95         /* Free internal stuff */
96         g_free( pineFile->path );
97
98         /* Free unique address table */
99         g_hash_table_freeze( pineFile->uniqTable );
100         g_hash_table_foreach_remove( pineFile->uniqTable, pine_free_table_vis, NULL );
101         g_hash_table_thaw( pineFile->uniqTable );
102         g_hash_table_destroy( pineFile->uniqTable );
103
104         /* Clear pointers */
105         pineFile->file = NULL;
106         pineFile->path = NULL;
107         pineFile->retVal = MGU_SUCCESS;
108         pineFile->uniqTable = NULL;
109         pineFile->cbProgress = NULL;
110
111         /* Now release file object */
112         g_free( pineFile );
113 }
114
115 /*
116  * Display object to specified stream.
117  * Enter: pineFile File object.
118  *        stream   File..
119  */
120 void pine_print_file( PineFile *pineFile, FILE *stream ) {
121         g_return_if_fail( pineFile != NULL );
122         fprintf( stream, "Pine File:\n" );
123         fprintf( stream, "file spec: '%s'\n", pineFile->path );
124         fprintf( stream, "  ret val: %d\n",   pineFile->retVal );
125 }
126
127 /*
128  * Open file for read.
129  * Enter: pineFile File object.
130  * return: TRUE if file opened successfully.
131  */
132 static gint pine_open_file( PineFile* pineFile ) {
133         if( pineFile->path ) {
134                 pineFile->file = fopen( pineFile->path, "rb" );
135                 if( ! pineFile->file ) {
136                         pineFile->retVal = MGU_OPEN_FILE;
137                         return pineFile->retVal;
138                 }
139         }
140         else {
141                 /* printf( "file not specified\n" ); */
142                 pineFile->retVal = MGU_NO_FILE;
143                 return pineFile->retVal;
144         }
145
146         /* Setup a buffer area */
147         pineFile->retVal = MGU_SUCCESS;
148         return pineFile->retVal;
149 }
150
151 /*
152  * Close file.
153  * Enter: pineFile File object.
154  */
155 static void pine_close_file( PineFile *pineFile ) {
156         g_return_if_fail( pineFile != NULL );
157         if( pineFile->file ) fclose( pineFile->file );
158         pineFile->file = NULL;
159 }
160
161 /*
162  * Read line of text from file.
163  * Enter: pineFile File object.
164  * Return: Copy of buffer. Should be g_free'd when done.
165  */
166 static gchar *pine_read_line( PineFile *pineFile ) {
167         gchar buf[ PINEBUFSIZE ];
168         int c;
169         gchar ch;
170         gchar *ptr;
171
172         if( feof( pineFile->file ) ) return NULL;
173
174         ptr = buf;
175         while( TRUE ) {
176                 *ptr = '\0';
177                 c = fgetc( pineFile->file );
178                 if( c == EOF ) {
179                         if( *buf == '\0' ) return NULL;
180                         break;
181                 }
182                 ch = (gchar) c;
183                 if( ch == '\0' ) {
184                         if( *buf == '\0' ) return NULL;
185                         break;
186                 }
187                 if( ch == '\n' ) {
188                         break;
189                 }
190                 *ptr = ch;
191                 ptr++;
192         }
193
194         /* Copy into private buffer */
195         return g_strdup( buf );
196 }
197
198 /*
199  * Parsed address data.
200  */
201 typedef struct _Pine_ParsedRec_ Pine_ParsedRec;
202 struct _Pine_ParsedRec_ {
203         gchar *nickName;
204         gchar *name;
205         gchar *address;
206         gchar *fcc;
207         gchar *comments;
208         gboolean isGroup;
209         GSList *listName;
210         GSList *listAddr;
211 };
212
213 /*
214  * Free data record.
215  * Enter: rec Data record.
216  */
217 static void pine_free_rec( Pine_ParsedRec *rec ) {
218         if( rec ) {
219                 g_free( rec->nickName );
220                 g_free( rec->name );
221                 g_free( rec->address );
222                 g_free( rec->fcc );
223                 g_free( rec->comments );
224                 mgu_clear_slist( rec->listName );
225                 mgu_clear_slist( rec->listAddr );
226                 g_slist_free( rec->listName );
227                 g_slist_free( rec->listAddr );
228                 rec->nickName = NULL;
229                 rec->name = NULL;
230                 rec->address = NULL;
231                 rec->fcc = NULL;
232                 rec->comments = NULL;
233                 rec->isGroup = FALSE;
234                 g_free( rec );
235         }
236 }
237
238 /*
239  * Clean name.
240  */
241 static void pine_clean_name( Pine_ParsedRec *rec ) {
242         gchar *p;
243
244         p = rec->name;
245         if( p == NULL ) return;
246         if( *p == '\0' ) return;
247
248         g_strstrip( rec->name );
249         if( *p == CHAR_APOS || *p == CHAR_QUOTE ) {
250                 return;
251         }
252
253         /* If embedded comma present, surround match with quotes */
254         while( *p ) {
255                 if( *p == CHAR_COMMA ) {
256                         p = g_strdup_printf( "\"%s\"", rec->name );
257                         g_free( rec->name );
258                         rec->name = p;
259                         return;
260                 }
261                 p++;
262         }
263 }
264
265 /*
266  * Parse pine address record.
267  * Enter:  buf Address record buffer.
268  * Return: Data record.
269  */
270 static Pine_ParsedRec *pine_parse_record( gchar *buf ) {
271         Pine_ParsedRec *rec;
272         gchar *p, *f;
273         gint pos, len, i;
274         gchar *tmp[5];
275
276         for( i = 0; i < 5; i++ )
277                 tmp[i] = NULL;
278
279         /* Extract tab separated values */
280         rec = NULL;
281         pos = 0;
282         p = f = buf;
283         while( *p ) {
284                 if( *p == '\t' ) {
285                         len = p - f;
286                         if( len > 0 ) {
287                                 tmp[ pos ] = g_strndup( f, len );
288                                 f = p;
289                                 f++;
290                         }
291                         pos++;
292                 }
293                 p++;
294         }
295
296         /* Extract last value */
297         len = p - f;
298         if( len > 0 ) {
299                 tmp[ pos++ ] = g_strndup( f, len );
300         }
301
302         /* Populate record */
303         if( pos > 0 ) {
304                 rec = g_new0( Pine_ParsedRec, 1 );
305                 rec->isGroup = FALSE;
306                 for( i = 0; i < pos; i++ ) {
307                         f = tmp[i];
308                         if( f ) {
309                                 g_strstrip( f );
310                         }
311                         if( i == 0 ) rec->nickName = f;
312                         else if( i == 1 ) rec->name = f;
313                         else if( i == 2 ) rec->address = f;
314                         else if( i == 3 ) rec->fcc = f;
315                         else if( i == 4 ) rec->comments = f;
316                         tmp[i] = NULL;
317                 }
318
319                 if( rec->address != NULL ) {
320                         /* Strip leading/trailing parens */
321                         p = rec->address;
322                         if( *p == '(' ) {
323                                 len = strlen( p ) - 1;
324                                 *p = ' ';
325                                 *(p + len) = ' ';
326                                 rec->isGroup = TRUE;
327                         }
328                 }
329         }
330
331         return rec;
332 }
333
334 /*
335  * Parse name from email address string.
336  * Enter: buf Start address of buffer to process (not modified).
337  *        atp Pointer to email at (@) character.
338  *        ap  Pointer to start of email address returned.
339  *        ep  Pointer to end of email address returned.
340  * Return: Parsed name or NULL if not present. This should be g_free'd
341  * when done.
342  */
343 static gchar *pine_parse_name(
344                 const gchar *buf, const gchar *atp, const gchar **ap,
345                 const gchar **ep )
346 {
347         gchar *name;
348         const gchar *pos;
349         const gchar *tmp;
350         const gchar *bp;
351         gint ilen;
352
353         name = NULL;
354         *ap = NULL;
355         *ep = NULL;
356
357         /* Find first non-separator char */
358         bp = buf;
359         while( TRUE ) {
360                 if( strchr( ",; \n\r", *bp ) == NULL ) break;
361                 bp++;
362         }
363
364         /* Search back for start of name */
365         tmp = atp;
366         pos = atp;
367         while( pos >= bp ) {
368                 tmp = pos;
369                 if( *pos == '<' ) {
370                         /* Found start of address/end of name part */
371                         ilen = -1 + ( size_t ) ( pos - bp );
372                         name = g_strndup( bp, ilen + 1 );
373                         *(name + ilen + 1) = '\0';
374
375                         /* Remove leading trailing quotes and spaces */
376                         mgu_str_ltc2space( name, '\"', '\"' );
377                         mgu_str_ltc2space( name, '\'', '\'' );
378                         mgu_str_ltc2space( name, '\"', '\"' );
379                         mgu_str_unescape( name );
380                         g_strstrip( name );
381                         break;
382                 }
383                 pos--;
384         }
385         *ap = tmp;
386
387         /* Search forward for end of address */
388         pos = atp + 1;
389         while( TRUE ) {
390                 if( *pos == '>' ) {
391                         pos++;
392                         break;
393                 }
394                 if( strchr( ",; \'\n\r", *pos ) ) break;
395                 pos++;
396         }
397         *ep = pos;
398
399         return name;
400 }
401
402 /*
403  * Parse address list.
404  * Enter: pineFile Pine control data.
405  *        cache    Address cache.
406  *        rec      Data record.
407  */
408 static void pine_parse_address( PineFile *pineFile, AddressCache *cache, Pine_ParsedRec *rec ) {
409         const gchar *buf;
410         gchar addr[ PINEBUFSIZE ];
411         const gchar *bp;
412         const gchar *ep;
413         gchar *atCh;
414         gchar *name;
415         gint len;
416
417         buf = rec->address;
418         while((atCh = strchr( buf, CHAR_AT )) != NULL) {
419                 name = pine_parse_name( buf, atCh, &bp, &ep );
420                 len = ( size_t ) ( ep - bp );
421                 strncpy( addr, bp, len );
422                 addr[ len ] = '\0';
423                 extract_address( addr );
424
425                 if( name == NULL ) name = g_strdup( "" );
426                 rec->listName = g_slist_append( rec->listName, name );
427                 rec->listAddr = g_slist_append( rec->listAddr, g_strdup( addr ) );
428
429                 buf = ep;
430                 if( atCh == ep ) {
431                         buf++;
432                 }
433         }
434 }
435
436 /*
437  * Insert person and address into address cache.
438  * Enter: pineFile Pine control data.
439  *        cache    Address cache.
440  *        address  E-Mail address.
441  *        name     Name.
442  *        remarks  Remarks.
443  * Return: E-Mail object, either inserted or found in hash table.
444  */
445 static ItemEMail *pine_insert_table(
446                 PineFile *pineFile, AddressCache *cache, gchar *address,
447                 gchar *name, gchar *remarks )
448 {
449         ItemPerson *person;
450         ItemEMail *email;
451         gchar *key;
452
453         /* Test whether address already in hash table */
454         key = g_strdup( address );
455         g_strdown( key );
456         email = g_hash_table_lookup( pineFile->uniqTable, key );
457
458         if( email == NULL ) {
459                 /* No - create person */
460                 person = addritem_create_item_person();
461                 addritem_person_set_common_name( person, name );
462                 addrcache_id_person( cache, person );
463                 addrcache_add_person( cache, person );
464
465                 /* Add email for person */
466                 email = addritem_create_item_email();
467                 addritem_email_set_address( email, address );
468                 addritem_email_set_remarks( email, remarks );
469                 addrcache_id_email( cache, email );
470                 addrcache_person_add_email( cache, person, email );
471
472                 /* Insert entry */
473                 g_hash_table_insert( pineFile->uniqTable, key, email );
474         }
475         else {
476                 /* Yes - update person with longest name */
477                 person = ( ItemPerson * ) ADDRITEM_PARENT(email);
478                 if( strlen( name ) > strlen( ADDRITEM_NAME(person) ) ) {
479                         addritem_person_set_common_name( person, name );
480                 }
481
482                 /* Free up */
483                 g_free( key );
484         }
485
486         return email;
487 }
488
489 /*
490  * Parse address line adn build address items.
491  * Enter: pineFile Pine control data.
492  *        cache    Address cache to load.
493  *        line     Address record.
494  */
495 static void pine_build_items( PineFile *pineFile, AddressCache *cache, gchar *line ) {
496         Pine_ParsedRec *rec;
497         GSList *nodeAddr, *nodeName;
498         ItemGroup *group;
499         ItemEMail *email;
500
501         rec = pine_parse_record( line );
502         if( rec ) {
503                 pine_clean_name( rec );
504                 pine_parse_address( pineFile, cache, rec );
505                 /* pine_print_rec( rec, stdout ); */
506                 /* printf( "=========\n" ); */
507
508                 if( rec->isGroup ) {
509                         /* Create group */
510                         group = addritem_create_item_group();
511                         addritem_group_set_name( group, rec->nickName );
512                         addrcache_id_group( cache, group );
513                         addrcache_add_group( cache, group );
514
515                         /* Add email to group */
516                         nodeName = rec->listName;
517                         nodeAddr = rec->listAddr;
518                         while( nodeAddr ) {
519                                 email = pine_insert_table(
520                                                 pineFile, cache, nodeAddr->data,
521                                                 nodeName->data, "" );
522
523                                 /* Add email to group */
524                                 addritem_group_add_email( group, email );
525
526                                 nodeAddr = g_slist_next( nodeAddr );
527                                 nodeName = g_slist_next( nodeName );
528                         }
529                 }
530                 else {
531                         email = pine_insert_table(
532                                         pineFile, cache, rec->address,
533                                         rec->name, rec->comments );
534                 }
535
536                 pine_free_rec( rec );
537         }
538 }
539
540 /*
541  * Read file data into address cache.
542  * Enter: pineFile Pine control data.
543  *        cache    Address cache to load.
544  */
545 static void pine_read_file( PineFile *pineFile, AddressCache *cache ) {
546         GSList *listValue = NULL;
547         gboolean flagEOF = FALSE, flagProc = FALSE, flagDone = FALSE;
548         gchar *line =  NULL, *lineValue = NULL;
549         long posEnd = 0L;
550         long posCur = 0L;
551
552         /* Find EOF for progress indicator */
553         fseek( pineFile->file, 0L, SEEK_END );
554         posEnd = ftell( pineFile->file );
555         fseek( pineFile->file, 0L, SEEK_SET );
556
557         flagProc = FALSE;
558         while( ! flagDone ) {
559                 if( flagEOF ) {
560                         flagDone = TRUE;
561                         flagProc = TRUE;
562                 }
563                 else {
564                         line =  pine_read_line( pineFile );
565                 }
566
567                 posCur = ftell( pineFile->file );
568                 if( pineFile->cbProgress ) {
569                         /* Call progress indicator */
570                         ( pineFile->cbProgress ) ( pineFile, & posEnd, & posCur );
571                 }
572
573                 /* Add line to list */
574                 if( line == NULL ) {
575                         flagEOF = TRUE;
576                 }
577                 else {
578                         /* Check for continuation line (1 space only) */
579                         if( *line == ' ' ) {
580                                 g_strchug( line );
581                                 listValue = g_slist_append(
582                                                 listValue, g_strdup( line ) );
583                                 flagProc = FALSE;
584                         }
585                         else {
586                                 flagProc = TRUE;
587                         }
588                 }
589
590                 if( flagProc ) {
591                         if( listValue != NULL ) {
592                                 /* Process list */
593                                 lineValue = mgu_list_coalesce( listValue );
594                                 if( lineValue ) {
595                                         pine_build_items(
596                                                 pineFile, cache, lineValue );
597                                 }
598                                 g_free( lineValue );
599                                 lineValue = NULL;
600                                 mgu_free_list( listValue );
601                                 listValue = NULL;
602                         }
603                         if( line != NULL ) {
604                                 /* Append to list */
605                                 listValue = g_slist_append(
606                                                 listValue, g_strdup( line ) );
607                         }
608                 }
609
610                 g_free( line );
611                 line = NULL;
612         }
613
614         /* Release data */
615         mgu_free_list( listValue );
616         listValue = NULL;
617 }
618
619 /*
620  * ============================================================================================
621  * Read file into list. Main entry point
622  * Enter:  pineFile Pine control data.
623  *         cache    Address cache to load.
624  * Return: Status code.
625  * ============================================================================================
626  */
627 gint pine_import_data( PineFile *pineFile, AddressCache *cache ) {
628         g_return_val_if_fail( pineFile != NULL, MGU_BAD_ARGS );
629         g_return_val_if_fail( cache != NULL, MGU_BAD_ARGS );
630
631         pineFile->retVal = MGU_SUCCESS;
632         addrcache_clear( cache );
633         cache->dataRead = FALSE;
634         pine_open_file( pineFile );
635         if( pineFile->retVal == MGU_SUCCESS ) {
636                 /* Read data into the cache */
637                 pine_read_file( pineFile, cache );
638                 pine_close_file( pineFile );
639
640                 /* Mark cache */
641                 cache->modified = FALSE;
642                 cache->dataRead = TRUE;
643         }
644         return pineFile->retVal;
645 }
646
647 #define WORK_BUFLEN 1024
648
649 /*
650  * Attempt to find a Pine addressbook file.
651  * Return: Filename, or home directory if not found, or empty string if
652  * no home. Filename should be g_free() when done.
653  */
654 gchar *pine_find_file( void ) {
655         gchar *homedir;
656         gchar str[ WORK_BUFLEN ];
657         gint len;
658         FILE *fp;
659
660         homedir = g_get_home_dir();
661         if( ! homedir ) return g_strdup( "" );
662
663         strcpy( str, homedir );
664         len = strlen( str );
665         if( len > 0 ) {
666                 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
667                         str[ len ] = G_DIR_SEPARATOR;
668                         str[ ++len ] = '\0';
669                 }
670         }
671         strcat( str, PINE_HOME_FILE );
672
673         /* Attempt to open */
674         if( ( fp = fopen( str, "rb" ) ) != NULL ) {
675                 fclose( fp );
676         }
677         else {
678                 /* Truncate filename */
679                 str[ len ] = '\0';
680         }
681         return g_strdup( str );
682 }
683
684 /*
685 * End of Source.
686 */
687