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 ];
169 if( feof( pineFile->file ) )
172 while( i < PINEBUFSIZE-1 ) {
173 c = fgetc( pineFile->file );
193 /* Copy into private buffer */
194 return g_strdup( buf );
198 * Parsed address data.
200 typedef struct _Pine_ParsedRec_ Pine_ParsedRec;
201 struct _Pine_ParsedRec_ {
214 * Enter: rec Data record.
216 static void pine_free_rec( Pine_ParsedRec *rec ) {
218 g_free( rec->nickName );
220 g_free( rec->address );
222 g_free( rec->comments );
223 mgu_clear_slist( rec->listName );
224 mgu_clear_slist( rec->listAddr );
225 g_slist_free( rec->listName );
226 g_slist_free( rec->listAddr );
227 rec->nickName = NULL;
231 rec->comments = NULL;
232 rec->isGroup = FALSE;
240 static void pine_clean_name( Pine_ParsedRec *rec ) {
244 if( p == NULL ) return;
245 if( *p == '\0' ) return;
247 g_strstrip( rec->name );
248 if( *p == CHAR_APOS || *p == CHAR_QUOTE ) {
252 /* If embedded comma present, surround match with quotes */
254 if( *p == CHAR_COMMA ) {
255 p = g_strdup_printf( "\"%s\"", rec->name );
265 * Parse pine address record.
266 * Enter: buf Address record buffer.
267 * Return: Data record.
269 static Pine_ParsedRec *pine_parse_record( gchar *buf ) {
275 for( i = 0; i < 5; i++ )
278 /* Extract tab separated values */
286 tmp[ pos ] = g_strndup( f, len );
295 /* Extract last value */
298 tmp[ pos++ ] = g_strndup( f, len );
301 /* Populate record */
303 rec = g_new0( Pine_ParsedRec, 1 );
304 rec->isGroup = FALSE;
305 for( i = 0; i < pos; i++ ) {
310 if( i == 0 ) rec->nickName = f;
311 else if( i == 1 ) rec->name = f;
312 else if( i == 2 ) rec->address = f;
313 else if( i == 3 ) rec->fcc = f;
314 else if( i == 4 ) rec->comments = f;
318 if( rec->address != NULL ) {
319 /* Strip leading/trailing parens */
322 len = strlen( p ) - 1;
334 * Parse name from email address string.
335 * Enter: buf Start address of buffer to process (not modified).
336 * atp Pointer to email at (@) character.
337 * ap Pointer to start of email address returned.
338 * ep Pointer to end of email address returned.
339 * Return: Parsed name or NULL if not present. This should be g_free'd
342 static gchar *pine_parse_name(
343 const gchar *buf, const gchar *atp, const gchar **ap,
356 /* Find first non-separator char */
359 if( strchr( ",; \n\r", *bp ) == NULL ) break;
363 /* Search back for start of name */
369 /* Found start of address/end of name part */
370 ilen = -1 + ( size_t ) ( pos - bp );
371 name = g_strndup( bp, ilen + 1 );
372 *(name + ilen + 1) = '\0';
374 /* Remove leading trailing quotes and spaces */
375 mgu_str_ltc2space( name, '\"', '\"' );
376 mgu_str_ltc2space( name, '\'', '\'' );
377 mgu_str_ltc2space( name, '\"', '\"' );
378 mgu_str_unescape( name );
386 /* Search forward for end of address */
393 if( strchr( ",; \'\n\r", *pos ) ) break;
402 * Parse address list.
403 * Enter: pineFile Pine control data.
404 * cache Address cache.
407 static void pine_parse_address( PineFile *pineFile, AddressCache *cache, Pine_ParsedRec *rec ) {
409 gchar addr[ PINEBUFSIZE ];
416 g_return_if_fail( rec->address != NULL );
419 while((atCh = strchr( buf, CHAR_AT )) != NULL) {
420 name = pine_parse_name( buf, atCh, &bp, &ep );
421 len = ( size_t ) ( ep - bp );
422 strncpy( addr, bp, len );
424 extract_address( addr );
426 if( name == NULL ) name = g_strdup( "" );
427 rec->listName = g_slist_append( rec->listName, name );
428 rec->listAddr = g_slist_append( rec->listAddr, g_strdup( addr ) );
438 * Insert person and address into address cache.
439 * Enter: pineFile Pine control data.
440 * cache Address cache.
441 * address E-Mail address.
444 * Return: E-Mail object, either inserted or found in hash table.
446 static ItemEMail *pine_insert_table(
447 PineFile *pineFile, AddressCache *cache, gchar *address,
448 gchar *name, gchar *remarks )
454 g_return_val_if_fail( address != NULL, NULL );
456 /* create an entry with empty name if needed */
460 /* Test whether address already in hash table */
461 key = g_strdup( address );
463 email = g_hash_table_lookup( pineFile->uniqTable, key );
465 if( email == NULL ) {
466 /* No - create person */
467 person = addritem_create_item_person();
468 addritem_person_set_common_name( person, name );
469 addrcache_id_person( cache, person );
470 addrcache_add_person( cache, person );
472 /* Add email for person */
473 email = addritem_create_item_email();
474 addritem_email_set_address( email, address );
475 addritem_email_set_remarks( email, remarks );
476 addrcache_id_email( cache, email );
477 addrcache_person_add_email( cache, person, email );
480 g_hash_table_insert( pineFile->uniqTable, key, email );
483 /* Yes - update person with longest name */
484 person = ( ItemPerson * ) ADDRITEM_PARENT(email);
485 if( strlen( name ) > strlen( ADDRITEM_NAME(person) ) ) {
486 addritem_person_set_common_name( person, name );
497 * Parse address line adn build address items.
498 * Enter: pineFile Pine control data.
499 * cache Address cache to load.
500 * line Address record.
502 static void pine_build_items( PineFile *pineFile, AddressCache *cache, gchar *line ) {
504 GSList *nodeAddr, *nodeName;
508 rec = pine_parse_record( line );
510 pine_clean_name( rec );
511 pine_parse_address( pineFile, cache, rec );
512 /* pine_print_rec( rec, stdout ); */
513 /* printf( "=========\n" ); */
517 group = addritem_create_item_group();
518 addritem_group_set_name( group, rec->nickName );
519 addrcache_id_group( cache, group );
520 addrcache_add_group( cache, group );
522 /* Add email to group */
523 nodeName = rec->listName;
524 nodeAddr = rec->listAddr;
526 email = pine_insert_table(
527 pineFile, cache, nodeAddr->data,
528 nodeName->data, "" );
530 /* Add email to group */
531 addritem_group_add_email( group, email );
533 nodeAddr = g_slist_next( nodeAddr );
534 nodeName = g_slist_next( nodeName );
538 email = pine_insert_table(
539 pineFile, cache, rec->address,
540 rec->name, rec->comments );
543 pine_free_rec( rec );
548 * Read file data into address cache.
549 * Enter: pineFile Pine control data.
550 * cache Address cache to load.
552 static void pine_read_file( PineFile *pineFile, AddressCache *cache ) {
553 GSList *listValue = NULL;
554 gboolean flagEOF = FALSE, flagProc = FALSE, flagDone = FALSE;
555 gchar *line = NULL, *lineValue = NULL;
559 /* Find EOF for progress indicator */
560 fseek( pineFile->file, 0L, SEEK_END );
561 posEnd = ftell( pineFile->file );
562 fseek( pineFile->file, 0L, SEEK_SET );
565 while( ! flagDone ) {
571 line = pine_read_line( pineFile );
574 posCur = ftell( pineFile->file );
575 if( pineFile->cbProgress ) {
576 /* Call progress indicator */
577 ( pineFile->cbProgress ) ( pineFile, & posEnd, & posCur );
580 /* Add line to list */
585 /* Check for continuation line (1 space only) */
588 listValue = g_slist_append(
589 listValue, g_strdup( line ) );
598 if( listValue != NULL ) {
600 lineValue = mgu_list_coalesce( listValue );
603 pineFile, cache, lineValue );
607 mgu_free_list( listValue );
612 listValue = g_slist_append(
613 listValue, g_strdup( line ) );
622 mgu_free_list( listValue );
627 * ============================================================================================
628 * Read file into list. Main entry point
629 * Enter: pineFile Pine control data.
630 * cache Address cache to load.
631 * Return: Status code.
632 * ============================================================================================
634 gint pine_import_data( PineFile *pineFile, AddressCache *cache ) {
635 g_return_val_if_fail( pineFile != NULL, MGU_BAD_ARGS );
636 g_return_val_if_fail( cache != NULL, MGU_BAD_ARGS );
638 pineFile->retVal = MGU_SUCCESS;
639 addrcache_clear( cache );
640 cache->dataRead = FALSE;
641 pine_open_file( pineFile );
642 if( pineFile->retVal == MGU_SUCCESS ) {
643 /* Read data into the cache */
644 pine_read_file( pineFile, cache );
645 pine_close_file( pineFile );
648 cache->modified = FALSE;
649 cache->dataRead = TRUE;
651 return pineFile->retVal;
654 #define WORK_BUFLEN 1024
657 * Attempt to find a Pine addressbook file.
658 * Return: Filename, or home directory if not found, or empty string if
659 * no home. Filename should be g_free() when done.
661 gchar *pine_find_file( void ) {
662 const gchar *homedir;
663 gchar str[ WORK_BUFLEN ];
667 homedir = g_get_home_dir();
668 if( ! homedir ) return g_strdup( "" );
670 strcpy( str, homedir );
673 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
674 str[ len ] = G_DIR_SEPARATOR;
678 strcat( str, PINE_HOME_FILE );
680 /* Attempt to open */
681 if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
685 /* Truncate filename */
688 return g_strdup( str );