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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 * Functions for an E-Mail address harvester.
22 * Code still needs some work. Address parsing not strictly correct.
32 #include "addrharvest.h"
35 /* Mail header names of interest */
36 static gchar *_headerFrom_ = HEADER_FROM;
37 static gchar *_headerReplyTo_ = HEADER_REPLY_TO;
38 static gchar *_headerSender_ = HEADER_SENDER;
39 static gchar *_headerErrorsTo_ = HEADER_ERRORS_TO;
40 static gchar *_headerCC_ = HEADER_CC;
41 static gchar *_headerTo_ = HEADER_TO;
43 #define ADDR_BUFFSIZE 1024
44 #define MSG_BUFFSIZE 2048
45 #define MSGNUM_BUFFSIZE 32
46 #define DFL_FOLDER_SIZE 20
48 /* Noise strings included by some other E-Mail clients */
49 #define REM_NAME_STRING "(E-mail)"
50 #define REM_NAME_STRING2 "(E-mail 2)"
52 /* Directories to ignore */
53 #define DIR_IGNORE ".\t..\t.sylpheed_mark\t.sylpheed_cache"
58 typedef struct _HeaderEntry HeaderEntry;
67 * Build header table entry.
68 * Enter: harvester Harvester object.
71 static void *addrharvest_build_entry(
72 AddressHarvester* harvester, gchar *name )
76 entry = g_new0( HeaderEntry, 1 );
78 entry->selected = FALSE;
81 harvester->headerTable = g_list_append( harvester->headerTable, entry );
84 static void addrharvest_print_hdrentry( HeaderEntry *entry, FILE *stream ) {
85 fprintf( stream, "Header Entry\n" );
86 fprintf( stream, " name : %s\n", entry->header );
87 fprintf( stream, "selected : %s\n", entry->selected ? "yes" : "no" );
93 static gint addrharvest_free_table_vis( gpointer key, gpointer value, gpointer data ) {
103 static void addrharvest_free_table( AddressHarvester* harvester ) {
107 /* Free header list */
108 node = harvester->headerTable;
110 entry = ( HeaderEntry * ) node->data;
111 entry->header = NULL;
112 entry->selected = FALSE;
113 entry->folder = NULL;
116 node = g_list_next( node );
118 g_list_free( harvester->headerTable );
119 harvester->headerTable = NULL;
121 /* Free duplicate table */
122 g_hash_table_freeze( harvester->dupTable );
123 g_hash_table_foreach_remove( harvester->dupTable, addrharvest_free_table_vis, NULL );
124 g_hash_table_thaw( harvester->dupTable );
125 g_hash_table_destroy( harvester->dupTable );
126 harvester->dupTable = NULL;
133 AddressHarvester *addrharvest_create( void ) {
134 AddressHarvester *harvester;
136 harvester = g_new0( AddressHarvester, 1 );
137 harvester->path = NULL;
138 harvester->dupTable = g_hash_table_new( g_str_hash, g_str_equal );
139 harvester->folderSize = DFL_FOLDER_SIZE;
140 harvester->retVal = MGU_SUCCESS;
142 /* Build header table */
143 harvester->headerTable = NULL;
144 addrharvest_build_entry( harvester, _headerFrom_ );
145 addrharvest_build_entry( harvester, _headerReplyTo_ );
146 addrharvest_build_entry( harvester, _headerSender_ );
147 addrharvest_build_entry( harvester, _headerErrorsTo_ );
148 addrharvest_build_entry( harvester, _headerCC_ );
149 addrharvest_build_entry( harvester, _headerTo_ );
158 * Specify path to folder that will be harvested.
159 * Entry: harvester Harvester object.
160 * value Full directory path.
162 void addrharvest_set_path( AddressHarvester* harvester, const gchar *value ) {
163 g_return_if_fail( harvester != NULL );
164 harvester->path = mgu_replace_string( harvester->path, value );
165 g_strstrip( harvester->path );
169 * Specify maximum folder size.
170 * Entry: harvester Harvester object.
173 void addrharvest_set_folder_size(
174 AddressHarvester* harvester, const gint value )
176 g_return_if_fail( harvester != NULL );
178 harvester->folderSize = value;
183 * Specify folder recursion.
184 * Entry: harvester Harvester object.
185 * value TRUE to process sub-folders, FALSE to process folder only.
187 void addrharvest_set_recurse(
188 AddressHarvester* harvester, const gboolean value )
190 g_return_if_fail( harvester != NULL );
191 harvester->folderRecurse = value;
195 * Search (case insensitive) for header entry with specified name.
196 * Enter: harvester Harvester.
198 * Return: Header, or NULL if not found.
200 static HeaderEntry *addrharvest_find(
201 AddressHarvester* harvester, const gchar *name ) {
206 node = harvester->headerTable;
211 if( g_strcasecmp( entry->header, name ) == 0 ) {
215 node = g_list_next( node );
221 * Set selection for specified heaader.
222 * Enter: harvester Harvester.
224 * value Value to set.
226 void addrharvest_set_header(
227 AddressHarvester* harvester, const gchar *name, const gboolean value )
231 g_return_if_fail( harvester != NULL );
232 entry = addrharvest_find( harvester, name );
233 if( entry != NULL ) {
234 entry->selected = value;
240 * Enter: harvester Harvester.
242 * Return: Address count, or -1 if header not found.
244 gint addrharvest_get_count( AddressHarvester* harvester, const gchar *name ) {
249 g_return_val_if_fail( harvester != NULL, count );
250 entry = addrharvest_find( harvester, name );
251 if( entry != NULL ) {
252 count = entry->count;
258 * Free up object by releasing internal memory.
259 * Enter: harvester Harvester.
261 void addrharvest_free( AddressHarvester *harvester ) {
262 g_return_if_fail( harvester != NULL );
264 /* Free internal stuff */
265 addrharvest_free_table( harvester );
266 g_free( harvester->path );
269 harvester->path = NULL;
270 harvester->retVal = MGU_SUCCESS;
271 harvester->headerTable = NULL;
273 harvester->folderSize = 0;
275 /* Now release object */
280 * Display object to specified stream.
281 * Enter: harvester Harvester.
282 * stream Output stream.
284 void addrharvest_print( AddressHarvester *harvester, FILE *stream ) {
288 g_return_if_fail( harvester != NULL );
289 fprintf( stream, "Address Harvester:\n" );
290 fprintf( stream, " file path: '%s'\n", harvester->path );
291 fprintf( stream, "max folder: %d'\n", harvester->folderSize );
293 node = harvester->headerTable;
296 fprintf( stream, " header: %s", entry->header );
297 fprintf( stream, "\t: %s", entry->selected ? "yes" : "no" );
298 fprintf( stream, "\t: %d\n", entry->count );
299 node = g_list_next( node );
301 fprintf( stream, " ret val: %d\n", harvester->retVal );
305 * Insert address into cache.
306 * Enter: harvester Harvester object.
307 * entry Header object.
308 * cache Address cache to load.
310 * address eMail address.
312 static void addrharvest_insert_cache(
313 AddressHarvester *harvester, HeaderEntry *entry,
314 AddressCache *cache, const gchar *name,
315 const gchar *address )
325 folder = entry->folder;
326 if( folder == NULL ) {
327 newFolder = TRUE; /* No folder yet */
329 if( entry->count % harvester->folderSize == 0 ) {
330 newFolder = TRUE; /* Folder is full */
334 key = g_strdup( address );
336 person = g_hash_table_lookup( harvester->dupTable, key );
338 /* Update existing person to use longest name */
339 value = ADDRITEM_NAME(person);
340 if( strlen( name ) > strlen( value ) ) {
341 addritem_person_set_common_name( person, name );
346 /* Folder if required */
348 cnt = 1 + ( entry->count / harvester->folderSize );
349 folderName =g_strdup_printf( "%s (%d)",
350 entry->header, cnt );
351 folder = addritem_create_item_folder();
352 addritem_folder_set_name( folder, folderName );
353 addritem_folder_set_remarks( folder, "" );
354 addrcache_id_folder( cache, folder );
355 addrcache_add_folder( cache, folder );
356 entry->folder = folder;
357 g_free( folderName );
361 person = addrcache_add_contact(
362 cache, folder, name, address, "" );
363 g_hash_table_insert( harvester->dupTable, key, person );
366 addritem_parse_first_last( person );
370 * Remove specified string from name.
372 * str String to remove.
374 static void addrharvest_del_email( gchar *name, gchar *str ) {
378 lenr = strlen( str );
379 while( p = strcasestr( name, str ) ) {
381 memmove( p, p + lenr, lenn );
386 * Find position of at (@) character in buffer.
387 * Enter: buffer Start of buffer.
388 * Return: Position of at character, or NULL if not found.
389 * Note: This function searches for the last occurrence of an 'at' character
390 * prior to a valid delimiter character for the end of address. This enables
391 * an address to be found where it is also used as the name of the
392 * recipient. For example:
393 * "axle.rose@netscape.com" <axle.rose@netscape.com>
394 * The last occurrence of the at character is detected.
396 static gchar *addrharvest_find_at( const gchar *buffer ) {
400 atCh = strchr( buffer, '@' );
402 /* Search forward for another one */
425 * Find start and end of address string.
426 * Enter: buf Start address of buffer to process (not modified).
427 * atp Pointer to email at (@) character.
428 * bp Pointer to start of email address (returned).
429 * ep Pointer to end of email address (returned).
431 static void addrharvest_find_address(
432 const gchar *buf, const gchar *atp, const gchar **bp,
437 /* Find first non-separator char */
441 if( strchr( ",; \n\r", *p ) == NULL ) break;
446 /* Search forward for end of address */
450 if( strchr( ",;", *p ) ) break;
457 * Extract E-Mail address from buffer. If found, address is removed from
459 * Enter: buffer Address buffer.
460 * Return: E-Mail address, or NULL if none found. Must g_free() when done.
462 static gchar *addrharvest_extract_address( gchar *buffer ) {
464 gchar *atCh, *p, *bp, *ep;
468 atCh = addrharvest_find_at( buffer );
470 /* Search back for start of address */
473 while( p >= buffer ) {
483 /* Search fwd for end */
491 else if( *p == ' ' ) {
502 addr = g_strndup( bp, len + 1 );
503 memmove( bp, ep, len );
512 * Parse address from header buffer creating address in cache.
513 * Enter: harvester Harvester object.
514 * entry Header object.
515 * cache Address cache to load.
516 * hdrBuf Pointer to header buffer.
518 static void addrharvest_parse_address(
519 AddressHarvester *harvester, HeaderEntry *entry,
520 AddressCache *cache, const gchar *hdrBuf )
522 gchar buffer[ ADDR_BUFFSIZE + 2 ];
525 gchar *atCh, *email, *name;
528 /* Search for an address */
529 while( atCh = addrharvest_find_at( hdrBuf ) ) {
530 /* Find addres string */
531 addrharvest_find_address( hdrBuf, atCh, &bp, &ep );
533 /* Copy into buffer */
534 bufLen = ( size_t ) ( ep - bp );
535 if( bufLen > ADDR_BUFFSIZE ) {
536 bufLen = ADDR_BUFFSIZE;
538 strncpy( buffer, bp, bufLen );
539 buffer[ bufLen ] = '\0';
540 buffer[ bufLen + 1 ] = '\0';
541 buffer[ bufLen + 2 ] = '\0';
543 /* Extract address from buffer */
544 email = addrharvest_extract_address( buffer );
546 /* Unescape characters */
547 mgu_str_unescape( buffer );
549 /* Remove noise characaters */
550 addrharvest_del_email( buffer, REM_NAME_STRING );
551 addrharvest_del_email( buffer, REM_NAME_STRING2 );
553 /* Remove leading trailing quotes and spaces */
554 mgu_str_ltc2space( buffer, '\"', '\"' );
555 mgu_str_ltc2space( buffer, '\'', '\'' );
556 mgu_str_ltc2space( buffer, '\"', '\"' );
557 mgu_str_ltc2space( buffer, '(', ')' );
558 g_strstrip( buffer );
560 if( g_strcasecmp( buffer, email ) == 0 ) {
567 /* Insert into address book */
568 addrharvest_insert_cache(
569 harvester, entry, cache, name, email );
577 * Test whether buffer contains a header that appears in header list.
578 * Enter: listHdr Header list.
580 * Return: TRUE if header in list.
582 static gboolean addrharvest_check_hdr( GList *listHdr, gchar *buf ) {
585 gchar *p, *hdr, *nhdr;
589 p = strchr( buf, ':' );
591 len = ( size_t ) ( p - buf );
592 hdr = g_strndup( buf, len );
596 if( g_strcasecmp( nhdr, hdr ) == 0 ) {
600 node = g_list_next( node );
608 * Read header into a linked list of lines.
609 * Enter: fp File to read.
610 * listHdr List of header lines of interest.
611 * done End of headers or end of file reached.
612 * Return: Linked list of lines.
614 static GSList *addrharvest_get_header( FILE *fp, GList *listHdr, gboolean *done ) {
616 gchar buf[ MSG_BUFFSIZE + 2 ];
623 if( fgets( buf, MSG_BUFFSIZE, fp ) == NULL ) {
628 /* Test for end of headers */
629 if( buf[0] == '\r' || buf[0] == '\n' ) {
634 /* Test whether required header */
635 foundHdr = addrharvest_check_hdr( listHdr, buf );
637 /* Read all header lines. Only add reqd ones to list */
643 list = g_slist_append( list, p );
646 /* Read first character */
648 if( ch == ' ' || ch == '\t' ) {
649 /* Continuation character - read into buffer */
650 if( fgets( buf, MSG_BUFFSIZE, fp ) == NULL ) {
659 /* Push back character for next header */
670 * Read specified file into address book.
671 * Enter: harvester Harvester object.
672 * fileName File to read.
673 * cache Address cache to load.
676 static gint addrharvest_readfile(
677 AddressHarvester *harvester, const gchar *fileName,
678 AddressCache *cache, GList *listHdr )
682 gchar *buf, *addr, *p;
687 msgFile = fopen( fileName, "rb" );
689 /* Cannot open file */
690 retVal = MGU_OPEN_FILE;
696 list = addrharvest_get_header( msgFile, listHdr, &done );
703 buf = mgu_list_coalesce( list );
704 mgu_free_list( list );
706 if(( p = strchr( buf, ':' ) ) != NULL ) {
710 entry = addrharvest_find( harvester, buf );
711 if( entry && entry->selected ) {
712 /* Sanitize control characters */
715 if( *p == '\r' || *p == '\n' || *p == '\t' )
719 addrharvest_parse_address(
720 harvester, entry, cache, addr );
731 * Read all files in specified directory into address book. Directories are
732 * traversed recursively if necessary.
733 * Enter: harvester Harvester object.
734 * cache Address cache to load.
735 * msgList List of message numbers, or NULL to process folder.
736 * dir Directory to process.
738 static void addrharvest_harvest_dir(
739 AddressHarvester *harvester, AddressCache *cache, GList *listHdr,
747 if( ( dp = opendir( dir ) ) == NULL ) {
751 /* Process directory */
753 while( ( d = readdir( dp ) ) != NULL ) {
754 stat( d->d_name, &s );
755 if( S_ISDIR( s.st_mode ) ) {
756 if( harvester->folderRecurse ) {
757 if( strstr( DIR_IGNORE, d->d_name ) != NULL )
759 addrharvest_harvest_dir(
760 harvester, cache, listHdr, d->d_name );
763 if( S_ISREG( s.st_mode ) ) {
764 if( ( num = to_number( d->d_name ) ) >= 0 ) {
765 addrharvest_readfile(
766 harvester, d->d_name, cache, listHdr );
775 * Read list of files in specified directory into address book.
776 * Enter: harvester Harvester object.
777 * cache Address cache to load.
778 * msgList List of message numbers, or NULL to process folder.
780 static void addrharvest_harvest_list(
781 AddressHarvester *harvester, AddressCache *cache, GList *listHdr,
787 gchar msgNum[ MSGNUM_BUFFSIZE ];
789 if( ( dp = opendir( harvester->path ) ) == NULL ) {
793 /* Process message list */
794 chdir( harvester->path );
797 num = GPOINTER_TO_UINT( node->data );
798 sprintf( msgNum, "%d", num );
799 addrharvest_readfile( harvester, msgNum, cache, listHdr );
800 node = g_list_next( node );
806 * ============================================================================
807 * Read all files in specified directory into address book.
808 * Enter: harvester Harvester object.
809 * cache Address cache to load.
810 * msgList List of message numbers, or NULL to process folder.
812 * ============================================================================
814 gint addrharvest_harvest(
815 AddressHarvester *harvester, AddressCache *cache, GList *msgList )
821 retVal = MGU_BAD_ARGS;
822 g_return_val_if_fail( harvester != NULL, retVal );
823 g_return_val_if_fail( cache != NULL, retVal );
824 g_return_val_if_fail( harvester->path != NULL, retVal );
827 addrcache_clear( cache );
828 cache->dataRead = FALSE;
830 /* Build list of headers of interest */
832 node = harvester->headerTable;
837 if( entry->selected ) {
840 p = g_strdup( entry->header );
842 listHdr = g_list_append( listHdr, p );
844 node = g_list_next( node );
847 /* Process directory/files */
848 if( msgList == NULL ) {
849 addrharvest_harvest_dir( harvester, cache, listHdr, harvester->path );
852 addrharvest_harvest_list( harvester, cache, listHdr, msgList );
854 mgu_free_dlist( listHdr );
857 cache->modified = FALSE;
858 cache->dataRead = TRUE;
864 * ============================================================================
865 * Test whether any headers have been selected for processing.
866 * Enter: harvester Harvester object.
867 * Return: TRUE if a header was selected, FALSE if none were selected.
868 * ============================================================================
870 gboolean addrharvest_check_header( AddressHarvester *harvester ) {
875 g_return_val_if_fail( harvester != NULL, retVal );
877 node = harvester->headerTable;
881 entry = ( HeaderEntry * ) node->data;
882 if( entry->selected ) return TRUE;
883 node = g_list_next( node );
889 * ============================================================================
891 * ============================================================================