2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002 Match Grun
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * Functions necessary to access Pine address book file.
32 #include "addrcache.h"
34 #define PINE_HOME_FILE ".addressbook"
35 #define PINEBUFSIZE 2048
36 #define CHAR_QUOTE '\"'
37 #define CHAR_APOS '\''
38 #define CHAR_COMMA ','
44 PineFile *pine_create() {
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;
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 );
65 * Register a callback function. When called, the function will be passed
66 * the following arguments:
69 * Current position (long)
70 * This can be used for a progress indicator.
72 void pine_set_callback( PineFile *pineFile, void *func ) {
73 pineFile->cbProgress = func;
79 static gint pine_free_table_vis( gpointer key, gpointer value, gpointer data ) {
87 * Free up object by releasing internal memory.
89 void pine_free( PineFile *pineFile ) {
90 g_return_if_fail( pineFile != NULL );
93 if( pineFile->file ) fclose( pineFile->file );
95 /* Free internal stuff */
96 g_free( pineFile->path );
98 /* Free unique address table */
99 g_hash_table_foreach_remove( pineFile->uniqTable, pine_free_table_vis, NULL );
100 g_hash_table_destroy( pineFile->uniqTable );
103 pineFile->file = NULL;
104 pineFile->path = NULL;
105 pineFile->retVal = MGU_SUCCESS;
106 pineFile->uniqTable = NULL;
107 pineFile->cbProgress = NULL;
109 /* Now release file object */
114 * Display object to specified stream.
115 * Enter: pineFile File object.
118 void pine_print_file( PineFile *pineFile, FILE *stream ) {
119 g_return_if_fail( pineFile != NULL );
120 fprintf( stream, "Pine File:\n" );
121 fprintf( stream, "file spec: '%s'\n", pineFile->path );
122 fprintf( stream, " ret val: %d\n", pineFile->retVal );
126 * Open file for read.
127 * Enter: pineFile File object.
128 * return: TRUE if file opened successfully.
130 static gint pine_open_file( PineFile* pineFile ) {
131 if( pineFile->path ) {
132 pineFile->file = g_fopen( pineFile->path, "rb" );
133 if( ! pineFile->file ) {
134 pineFile->retVal = MGU_OPEN_FILE;
135 return pineFile->retVal;
139 /* printf( "file not specified\n" ); */
140 pineFile->retVal = MGU_NO_FILE;
141 return pineFile->retVal;
144 /* Setup a buffer area */
145 pineFile->retVal = MGU_SUCCESS;
146 return pineFile->retVal;
151 * Enter: pineFile File object.
153 static void pine_close_file( PineFile *pineFile ) {
154 g_return_if_fail( pineFile != NULL );
155 if( pineFile->file ) fclose( pineFile->file );
156 pineFile->file = NULL;
160 * Read line of text from file.
161 * Enter: pineFile File object.
162 * Return: Copy of buffer. Should be g_free'd when done.
164 static gchar *pine_read_line( PineFile *pineFile ) {
165 gchar buf[ PINEBUFSIZE ];
170 if( feof( pineFile->file ) ) return NULL;
175 c = fgetc( pineFile->file );
177 if( *buf == '\0' ) return NULL;
182 if( *buf == '\0' ) return NULL;
192 /* Copy into private buffer */
193 return g_strdup( buf );
197 * Parsed address data.
199 typedef struct _Pine_ParsedRec_ Pine_ParsedRec;
200 struct _Pine_ParsedRec_ {
213 * Enter: rec Data record.
215 static void pine_free_rec( Pine_ParsedRec *rec ) {
217 g_free( rec->nickName );
219 g_free( rec->address );
221 g_free( rec->comments );
222 mgu_clear_slist( rec->listName );
223 mgu_clear_slist( rec->listAddr );
224 g_slist_free( rec->listName );
225 g_slist_free( rec->listAddr );
226 rec->nickName = NULL;
230 rec->comments = NULL;
231 rec->isGroup = FALSE;
239 static void pine_clean_name( Pine_ParsedRec *rec ) {
243 if( p == NULL ) return;
244 if( *p == '\0' ) return;
246 g_strstrip( rec->name );
247 if( *p == CHAR_APOS || *p == CHAR_QUOTE ) {
251 /* If embedded comma present, surround match with quotes */
253 if( *p == CHAR_COMMA ) {
254 p = g_strdup_printf( "\"%s\"", rec->name );
264 * Parse pine address record.
265 * Enter: buf Address record buffer.
266 * Return: Data record.
268 static Pine_ParsedRec *pine_parse_record( gchar *buf ) {
274 for( i = 0; i < 5; i++ )
277 /* Extract tab separated values */
285 tmp[ pos ] = g_strndup( f, len );
294 /* Extract last value */
297 tmp[ pos++ ] = g_strndup( f, len );
300 /* Populate record */
302 rec = g_new0( Pine_ParsedRec, 1 );
303 rec->isGroup = FALSE;
304 for( i = 0; i < pos; i++ ) {
309 if( i == 0 ) rec->nickName = f;
310 else if( i == 1 ) rec->name = f;
311 else if( i == 2 ) rec->address = f;
312 else if( i == 3 ) rec->fcc = f;
313 else if( i == 4 ) rec->comments = f;
317 if( rec->address != NULL ) {
318 /* Strip leading/trailing parens */
321 len = strlen( p ) - 1;
333 * Parse name from email address string.
334 * Enter: buf Start address of buffer to process (not modified).
335 * atp Pointer to email at (@) character.
336 * ap Pointer to start of email address returned.
337 * ep Pointer to end of email address returned.
338 * Return: Parsed name or NULL if not present. This should be g_free'd
341 static gchar *pine_parse_name(
342 const gchar *buf, const gchar *atp, const gchar **ap,
355 /* Find first non-separator char */
358 if( strchr( ",; \n\r", *bp ) == NULL ) break;
362 /* Search back for start of name */
368 /* Found start of address/end of name part */
369 ilen = -1 + ( size_t ) ( pos - bp );
370 name = g_strndup( bp, ilen + 1 );
371 *(name + ilen + 1) = '\0';
373 /* Remove leading trailing quotes and spaces */
374 mgu_str_ltc2space( name, '\"', '\"' );
375 mgu_str_ltc2space( name, '\'', '\'' );
376 mgu_str_ltc2space( name, '\"', '\"' );
377 mgu_str_unescape( name );
385 /* Search forward for end of address */
392 if( strchr( ",; \'\n\r", *pos ) ) break;
401 * Parse address list.
402 * Enter: pineFile Pine control data.
403 * cache Address cache.
406 static void pine_parse_address( PineFile *pineFile, AddressCache *cache, Pine_ParsedRec *rec ) {
408 gchar addr[ PINEBUFSIZE ];
415 g_return_if_fail( rec->address != NULL );
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 );
423 extract_address( addr );
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 ) );
437 * Insert person and address into address cache.
438 * Enter: pineFile Pine control data.
439 * cache Address cache.
440 * address E-Mail address.
443 * Return: E-Mail object, either inserted or found in hash table.
445 static ItemEMail *pine_insert_table(
446 PineFile *pineFile, AddressCache *cache, gchar *address,
447 gchar *name, gchar *remarks )
453 g_return_val_if_fail( address != NULL, NULL );
455 /* create an entry with empty name if needed */
459 /* Test whether address already in hash table */
460 key = g_strdup( address );
462 email = g_hash_table_lookup( pineFile->uniqTable, key );
464 if( email == NULL ) {
465 /* No - create person */
466 person = addritem_create_item_person();
467 addritem_person_set_common_name( person, name );
468 addrcache_id_person( cache, person );
469 addrcache_add_person( cache, person );
471 /* Add email for person */
472 email = addritem_create_item_email();
473 addritem_email_set_address( email, address );
474 addritem_email_set_remarks( email, remarks );
475 addrcache_id_email( cache, email );
476 addrcache_person_add_email( cache, person, email );
479 g_hash_table_insert( pineFile->uniqTable, key, email );
482 /* Yes - update person with longest name */
483 person = ( ItemPerson * ) ADDRITEM_PARENT(email);
484 if( strlen( name ) > strlen( ADDRITEM_NAME(person) ) ) {
485 addritem_person_set_common_name( person, name );
496 * Parse address line adn build address items.
497 * Enter: pineFile Pine control data.
498 * cache Address cache to load.
499 * line Address record.
501 static void pine_build_items( PineFile *pineFile, AddressCache *cache, gchar *line ) {
503 GSList *nodeAddr, *nodeName;
507 rec = pine_parse_record( line );
509 pine_clean_name( rec );
510 pine_parse_address( pineFile, cache, rec );
511 /* pine_print_rec( rec, stdout ); */
512 /* printf( "=========\n" ); */
516 group = addritem_create_item_group();
517 addritem_group_set_name( group, rec->nickName );
518 addrcache_id_group( cache, group );
519 addrcache_add_group( cache, group );
521 /* Add email to group */
522 nodeName = rec->listName;
523 nodeAddr = rec->listAddr;
525 email = pine_insert_table(
526 pineFile, cache, nodeAddr->data,
527 nodeName->data, "" );
529 /* Add email to group */
530 addritem_group_add_email( group, email );
532 nodeAddr = g_slist_next( nodeAddr );
533 nodeName = g_slist_next( nodeName );
537 email = pine_insert_table(
538 pineFile, cache, rec->address,
539 rec->name, rec->comments );
542 pine_free_rec( rec );
547 * Read file data into address cache.
548 * Enter: pineFile Pine control data.
549 * cache Address cache to load.
551 static void pine_read_file( PineFile *pineFile, AddressCache *cache ) {
552 GSList *listValue = NULL;
553 gboolean flagEOF = FALSE, flagProc = FALSE, flagDone = FALSE;
554 gchar *line = NULL, *lineValue = NULL;
558 /* Find EOF for progress indicator */
559 fseek( pineFile->file, 0L, SEEK_END );
560 posEnd = ftell( pineFile->file );
561 fseek( pineFile->file, 0L, SEEK_SET );
564 while( ! flagDone ) {
570 line = pine_read_line( pineFile );
573 posCur = ftell( pineFile->file );
574 if( pineFile->cbProgress ) {
575 /* Call progress indicator */
576 ( pineFile->cbProgress ) ( pineFile, & posEnd, & posCur );
579 /* Add line to list */
584 /* Check for continuation line (1 space only) */
587 listValue = g_slist_append(
588 listValue, g_strdup( line ) );
597 if( listValue != NULL ) {
599 lineValue = mgu_list_coalesce( listValue );
602 pineFile, cache, lineValue );
606 mgu_free_list( listValue );
611 listValue = g_slist_append(
612 listValue, g_strdup( line ) );
621 mgu_free_list( listValue );
626 * ============================================================================================
627 * Read file into list. Main entry point
628 * Enter: pineFile Pine control data.
629 * cache Address cache to load.
630 * Return: Status code.
631 * ============================================================================================
633 gint pine_import_data( PineFile *pineFile, AddressCache *cache ) {
634 g_return_val_if_fail( pineFile != NULL, MGU_BAD_ARGS );
635 g_return_val_if_fail( cache != NULL, MGU_BAD_ARGS );
637 pineFile->retVal = MGU_SUCCESS;
638 addrcache_clear( cache );
639 cache->dataRead = FALSE;
640 pine_open_file( pineFile );
641 if( pineFile->retVal == MGU_SUCCESS ) {
642 /* Read data into the cache */
643 pine_read_file( pineFile, cache );
644 pine_close_file( pineFile );
647 cache->modified = FALSE;
648 cache->dataRead = TRUE;
650 return pineFile->retVal;
653 #define WORK_BUFLEN 1024
656 * Attempt to find a Pine addressbook file.
657 * Return: Filename, or home directory if not found, or empty string if
658 * no home. Filename should be g_free() when done.
660 gchar *pine_find_file( void ) {
661 const gchar *homedir;
662 gchar str[ WORK_BUFLEN ];
666 homedir = g_get_home_dir();
667 if( ! homedir ) return g_strdup( "" );
669 strcpy( str, homedir );
672 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
673 str[ len ] = G_DIR_SEPARATOR;
677 strcat( str, PINE_HOME_FILE );
679 /* Attempt to open */
680 if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
684 /* Truncate filename */
687 return g_strdup( str );