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 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 MUTT address book file.
33 #include "addrcache.h"
35 #define MUTT_HOME_FILE ".muttrc"
36 #define MUTTBUFSIZE 2048
37 #define MUTT_TAG_ALIAS "alias"
42 MuttFile *mutt_create() {
44 muttFile = g_new0( MuttFile, 1 );
45 muttFile->path = NULL;
46 muttFile->file = NULL;
47 muttFile->retVal = MGU_SUCCESS;
48 muttFile->uniqTable = g_hash_table_new( g_str_hash, g_str_equal );
49 muttFile->cbProgress = NULL;
56 void mutt_set_file( MuttFile* muttFile, const gchar *value ) {
57 g_return_if_fail( muttFile != NULL );
58 muttFile->path = mgu_replace_string( muttFile->path, value );
59 g_strstrip( muttFile->path );
65 static gint mutt_free_table_vis( gpointer key, gpointer value, gpointer data ) {
73 * Free up object by releasing internal memory.
75 void mutt_free( MuttFile *muttFile ) {
76 g_return_if_fail( muttFile != NULL );
79 if( muttFile->file ) fclose( muttFile->file );
81 /* Free internal stuff */
82 g_free( muttFile->path );
84 /* Free unique address table */
85 g_hash_table_foreach_remove( muttFile->uniqTable, mutt_free_table_vis, NULL );
86 g_hash_table_destroy( muttFile->uniqTable );
89 muttFile->file = NULL;
90 muttFile->path = NULL;
91 muttFile->retVal = MGU_SUCCESS;
92 muttFile->uniqTable = NULL;
93 muttFile->cbProgress = NULL;
95 /* Now release file object */
100 * Open file for read.
101 * return: TRUE if file opened successfully.
103 static gint mutt_open_file( MuttFile* muttFile ) {
104 if( muttFile->path ) {
105 muttFile->file = g_fopen( muttFile->path, "rb" );
106 if( ! muttFile->file ) {
107 muttFile->retVal = MGU_OPEN_FILE;
108 return muttFile->retVal;
112 /* printf( "file not specified\n" ); */
113 muttFile->retVal = MGU_NO_FILE;
114 return muttFile->retVal;
117 /* Setup a buffer area */
118 muttFile->retVal = MGU_SUCCESS;
119 return muttFile->retVal;
125 static void mutt_close_file( MuttFile *muttFile ) {
126 g_return_if_fail( muttFile != NULL );
127 if( muttFile->file ) fclose( muttFile->file );
128 muttFile->file = NULL;
132 * Read line of text from file.
133 * Enter: muttFile File object.
134 * flagCont Continuation flag, set if back-slash character at EOL.
135 * Return: ptr to buffer where line starts.
137 static gchar *mutt_get_line( MuttFile *muttFile, gboolean *flagCont ) {
138 gchar buf[ MUTTBUFSIZE ];
143 if( feof( muttFile->file ) )
146 memset(buf, 0, MUTTBUFSIZE);
149 while( i < MUTTBUFSIZE-1 ) {
150 ch = fgetc( muttFile->file );
151 if( ch == '\0' || ch == EOF ) {
158 /* Replace backslash with NULL */
172 /* Copy into private buffer */
173 return g_strdup( buf );
177 * Parsed address data.
179 typedef struct _Mutt_ParsedRec_ Mutt_ParsedRec;
180 struct _Mutt_ParsedRec_ {
187 * Enter: rec Data record.
189 static void mutt_free_rec( Mutt_ParsedRec *rec ) {
191 g_free( rec->address );
200 * Parse recipient list for each address.
201 * Enter: rcpList Recipients extracted from file.
202 * addrCount Updated with recipient count.
203 * Return: Linked list of recipients.
205 static GSList *mutt_parse_rcplist( gchar *rcpList, gint *addrCount ) {
206 gchar *ptr, *pStart, *pEnd, *pAddr, *pName, *address, *name;
217 address = name = NULL;
218 pName = pAddr = NULL;
221 if( ! isspace( *ptr ) ) break;
237 if( isspace( ch ) ) {
244 /* Extract address */
246 address = g_strndup( pStart, pAddr - pStart );
249 address = g_strdup( pStart );
251 g_strstrip( address );
265 if( isspace( ch ) ) continue;
269 /* Extract name (if any) */
271 /* Look for closing parens */
283 name = g_strndup( pName, pEnd - pName );
288 name = g_strdup( pName );
294 name = g_strdup( "" );
298 rec = g_new0( Mutt_ParsedRec, 1 );
299 rec->address = address;
301 list = g_slist_append( list, rec );
304 /* mutt_print_rec( rec, stdout ); */
311 * Insert person and address into address cache.
312 * Enter: muttFile MUTT control data.
313 * cache Address cache.
314 * address E-Mail address.
316 * Return: E-Mail object, either inserted or found in hash table.
318 static ItemEMail *mutt_insert_table(
319 MuttFile *muttFile, AddressCache *cache, gchar *address,
326 /* Test whether address already in hash table */
327 key = g_strdup( address );
329 email = g_hash_table_lookup( muttFile->uniqTable, key );
331 if( email == NULL ) {
332 /* No - create person */
333 person = addritem_create_item_person();
334 addritem_person_set_common_name( person, name );
335 addrcache_id_person( cache, person );
336 addrcache_add_person( cache, person );
338 /* Add email for person */
339 email = addritem_create_item_email();
340 addritem_email_set_address( email, address );
341 addrcache_id_email( cache, email );
342 addrcache_person_add_email( cache, person, email );
345 g_hash_table_insert( muttFile->uniqTable, key, email );
348 /* Yes - update person with longest name */
349 person = ( ItemPerson * ) ADDRITEM_PARENT(email);
350 if( strlen( name ) > strlen( ADDRITEM_NAME(person) ) ) {
351 addritem_person_set_common_name( person, name );
362 * Build address book entries.
363 * Enter: muttFile MUTT control data.
364 * cache Address cache.
366 * listAddr List of address items.
367 * addrCount Address list count.
369 static void mutt_build_address(
370 MuttFile *muttFile, AddressCache *cache,
371 gchar *aliasName, GSList *listAddr, gint addrCount )
379 if( listAddr != NULL && addrCount > 1 ) {
380 group = addritem_create_item_group();
381 addritem_group_set_name( group, aliasName );
382 addrcache_id_group( cache, group );
383 addrcache_add_group( cache, group );
391 /* Insert person/email */
392 email = mutt_insert_table(
393 muttFile, cache, rec->address, rec->name );
395 /* Add email to group */
397 addritem_group_add_email( group, email );
400 mutt_free_rec( rec );
401 node = g_slist_next( node );
406 * Parse address line adn build address items.
407 * Enter: muttFile MUTT control data.
408 * cache Address cache.
411 static void mutt_build_items( MuttFile *muttFile, AddressCache *cache, gchar *line ) {
414 gchar *aliasTag, *aliasName, *recipient;
417 /* printf( "\nBUILD >%s<\n", line ); */
418 list = mgu_parse_string( line, 3, &tCount );
421 mgu_free_dlist( list );
427 aliasTag = list->data;
428 node = g_list_next( list );
429 aliasName = node->data;
430 node = g_list_next( node );
431 recipient = node->data;
434 if( strcmp( aliasTag, MUTT_TAG_ALIAS ) == 0 ) {
436 /* printf( "aliasName :%s:\n", aliasName ); */
437 /* printf( "recipient :%s:\n", recipient ); */
438 addrList = mutt_parse_rcplist( recipient, &aCount );
439 /* printf( "---\n" ); */
440 mutt_build_address( muttFile, cache, aliasName, addrList, aCount );
443 mgu_free_dlist( list );
449 * Read file data into address cache.
450 * Enter: muttFile MUTT control data.
451 * cache Address cache.
453 static void mutt_read_file( MuttFile *muttFile, AddressCache *cache ) {
454 GSList *listValue = NULL;
455 gboolean flagEOF = FALSE, flagCont = FALSE, lastCont = FALSE;
456 gchar *line = NULL, *lineValue = NULL;
460 /* Find EOF for progress indicator */
461 fseek( muttFile->file, 0L, SEEK_END );
462 posEnd = ftell( muttFile->file );
463 fseek( muttFile->file, 0L, SEEK_SET );
467 line = mutt_get_line( muttFile, &flagCont );
469 posCur = ftell( muttFile->file );
470 if( muttFile->cbProgress ) {
471 /* Call progress indicator */
472 ( muttFile->cbProgress ) ( muttFile, & posEnd, & posCur );
475 if( line == NULL ) flagEOF = TRUE;
478 lineValue = mgu_list_coalesce( listValue );
480 mutt_build_items( muttFile, cache, lineValue );
484 mgu_free_list( listValue );
489 /* Add line to list */
490 listValue = g_slist_append( listValue, g_strdup( line ) );
497 mgu_free_list( listValue );
502 * ============================================================================================
503 * Read file into list. Main entry point
504 * Enter: muttFile MUTT control data.
505 * cache Address cache to load.
506 * Return: Status code.
507 * ============================================================================================
509 gint mutt_import_data( MuttFile *muttFile, AddressCache *cache ) {
510 g_return_val_if_fail( muttFile != NULL, MGU_BAD_ARGS );
511 g_return_val_if_fail( cache != NULL, MGU_BAD_ARGS );
512 muttFile->retVal = MGU_SUCCESS;
513 addrcache_clear( cache );
514 cache->dataRead = FALSE;
515 mutt_open_file( muttFile );
516 if( muttFile->retVal == MGU_SUCCESS ) {
517 /* Read data into the cache */
518 mutt_read_file( muttFile, cache );
519 mutt_close_file( muttFile );
522 cache->modified = FALSE;
523 cache->dataRead = TRUE;
525 return muttFile->retVal;
528 #define WORK_BUFLEN 1024
531 * Attempt to find a Mutt file.
532 * Return: Filename, or home directory if not found, or empty string if
533 * no home. Filename should be g_free() when done.
535 gchar *mutt_find_file( void ) {
536 const gchar *homedir;
537 gchar str[ WORK_BUFLEN ];
541 homedir = get_home_dir();
542 if( ! homedir ) return g_strdup( "" );
544 strcpy( str, homedir );
547 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
548 str[ len ] = G_DIR_SEPARATOR;
552 strcat( str, MUTT_HOME_FILE );
554 /* Attempt to open */
555 if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
559 /* Truncate filename */
562 return g_strdup( str );