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.
31 #include "addrharvest.h"
34 /* Mail header names of interest */
35 static gchar *_headerFrom_ = HEADER_FROM;
36 static gchar *_headerReplyTo_ = HEADER_REPLY_TO;
37 static gchar *_headerSender_ = HEADER_SENDER;
38 static gchar *_headerErrorsTo_ = HEADER_ERRORS_TO;
39 static gchar *_headerCC_ = HEADER_CC;
40 static gchar *_headerTo_ = HEADER_TO;
42 #define ADDR_BUFFSIZE 1024
43 #define MSG_BUFFSIZE 2048
44 #define MSGNUM_BUFFSIZE 32
45 #define DFL_FOLDER_SIZE 20
47 /* Noise strings included by some other E-Mail clients */
48 #define REM_NAME_STRING "(E-mail)"
49 #define REM_NAME_STRING2 "(E-mail 2)"
51 /* Directories to ignore */
52 #define DIR_IGNORE ".\t..\t.sylpheed_mark\t.sylpheed_cache"
57 typedef struct _HeaderEntry HeaderEntry;
66 * Build header table entry.
67 * Enter: harvester Harvester object.
70 static void addrharvest_build_entry(
71 AddressHarvester* harvester, gchar *name )
75 entry = g_new0( HeaderEntry, 1 );
77 entry->selected = FALSE;
80 harvester->headerTable = g_list_append( harvester->headerTable, entry );
86 static gint addrharvest_free_table_vis( gpointer key, gpointer value, gpointer data ) {
96 static void addrharvest_free_table( AddressHarvester* harvester ) {
100 /* Free header list */
101 node = harvester->headerTable;
103 entry = ( HeaderEntry * ) node->data;
104 entry->header = NULL;
105 entry->selected = FALSE;
106 entry->folder = NULL;
109 node = g_list_next( node );
111 g_list_free( harvester->headerTable );
112 harvester->headerTable = NULL;
114 /* Free duplicate table */
115 g_hash_table_freeze( harvester->dupTable );
116 g_hash_table_foreach_remove( harvester->dupTable, addrharvest_free_table_vis, NULL );
117 g_hash_table_thaw( harvester->dupTable );
118 g_hash_table_destroy( harvester->dupTable );
119 harvester->dupTable = NULL;
126 AddressHarvester *addrharvest_create( void ) {
127 AddressHarvester *harvester;
129 harvester = g_new0( AddressHarvester, 1 );
130 harvester->path = NULL;
131 harvester->dupTable = g_hash_table_new( g_str_hash, g_str_equal );
132 harvester->folderSize = DFL_FOLDER_SIZE;
133 harvester->retVal = MGU_SUCCESS;
135 /* Build header table */
136 harvester->headerTable = NULL;
137 addrharvest_build_entry( harvester, _headerFrom_ );
138 addrharvest_build_entry( harvester, _headerReplyTo_ );
139 addrharvest_build_entry( harvester, _headerSender_ );
140 addrharvest_build_entry( harvester, _headerErrorsTo_ );
141 addrharvest_build_entry( harvester, _headerCC_ );
142 addrharvest_build_entry( harvester, _headerTo_ );
151 * Specify path to folder that will be harvested.
152 * Entry: harvester Harvester object.
153 * value Full directory path.
155 void addrharvest_set_path( AddressHarvester* harvester, const gchar *value ) {
156 g_return_if_fail( harvester != NULL );
157 harvester->path = mgu_replace_string( harvester->path, value );
158 g_strstrip( harvester->path );
162 * Specify maximum folder size.
163 * Entry: harvester Harvester object.
166 void addrharvest_set_folder_size(
167 AddressHarvester* harvester, const gint value )
169 g_return_if_fail( harvester != NULL );
171 harvester->folderSize = value;
176 * Specify folder recursion.
177 * Entry: harvester Harvester object.
178 * value TRUE to process sub-folders, FALSE to process folder only.
180 void addrharvest_set_recurse(
181 AddressHarvester* harvester, const gboolean value )
183 g_return_if_fail( harvester != NULL );
184 harvester->folderRecurse = value;
188 * Search (case insensitive) for header entry with specified name.
189 * Enter: harvester Harvester.
191 * Return: Header, or NULL if not found.
193 static HeaderEntry *addrharvest_find(
194 AddressHarvester* harvester, const gchar *name ) {
199 node = harvester->headerTable;
204 if( g_strcasecmp( entry->header, name ) == 0 ) {
208 node = g_list_next( node );
214 * Set selection for specified heaader.
215 * Enter: harvester Harvester.
217 * value Value to set.
219 void addrharvest_set_header(
220 AddressHarvester* harvester, const gchar *name, const gboolean value )
224 g_return_if_fail( harvester != NULL );
225 entry = addrharvest_find( harvester, name );
226 if( entry != NULL ) {
227 entry->selected = value;
233 * Enter: harvester Harvester.
235 * Return: Address count, or -1 if header not found.
237 gint addrharvest_get_count( AddressHarvester* harvester, const gchar *name ) {
242 g_return_val_if_fail( harvester != NULL, count );
243 entry = addrharvest_find( harvester, name );
244 if( entry != NULL ) {
245 count = entry->count;
251 * Free up object by releasing internal memory.
252 * Enter: harvester Harvester.
254 void addrharvest_free( AddressHarvester *harvester ) {
255 g_return_if_fail( harvester != NULL );
257 /* Free internal stuff */
258 addrharvest_free_table( harvester );
259 g_free( harvester->path );
262 harvester->path = NULL;
263 harvester->retVal = MGU_SUCCESS;
264 harvester->headerTable = NULL;
266 harvester->folderSize = 0;
268 /* Now release object */
273 * Display object to specified stream.
274 * Enter: harvester Harvester.
275 * stream Output stream.
277 void addrharvest_print( AddressHarvester *harvester, FILE *stream ) {
281 g_return_if_fail( harvester != NULL );
282 fprintf( stream, "Address Harvester:\n" );
283 fprintf( stream, " file path: '%s'\n", harvester->path );
284 fprintf( stream, "max folder: %d'\n", harvester->folderSize );
286 node = harvester->headerTable;
289 fprintf( stream, " header: %s", entry->header );
290 fprintf( stream, "\t: %s", entry->selected ? "yes" : "no" );
291 fprintf( stream, "\t: %d\n", entry->count );
292 node = g_list_next( node );
294 fprintf( stream, " ret val: %d\n", harvester->retVal );
298 * Insert address into cache.
299 * Enter: harvester Harvester object.
300 * entry Header object.
301 * cache Address cache to load.
303 * address eMail address.
305 static void addrharvest_insert_cache(
306 AddressHarvester *harvester, HeaderEntry *entry,
307 AddressCache *cache, const gchar *name,
308 const gchar *address )
318 folder = entry->folder;
319 if( folder == NULL ) {
320 newFolder = TRUE; /* No folder yet */
322 if( entry->count % harvester->folderSize == 0 ) {
323 newFolder = TRUE; /* Folder is full */
327 key = g_strdup( address );
329 person = g_hash_table_lookup( harvester->dupTable, key );
331 /* Update existing person to use longest name */
332 value = ADDRITEM_NAME(person);
333 if( strlen( name ) > strlen( value ) ) {
334 addritem_person_set_common_name( person, name );
339 /* Folder if required */
341 cnt = 1 + ( entry->count / harvester->folderSize );
342 folderName =g_strdup_printf( "%s (%d)",
343 entry->header, cnt );
344 folder = addritem_create_item_folder();
345 addritem_folder_set_name( folder, folderName );
346 addritem_folder_set_remarks( folder, "" );
347 addrcache_id_folder( cache, folder );
348 addrcache_add_folder( cache, folder );
349 entry->folder = folder;
350 g_free( folderName );
354 person = addrcache_add_contact(
355 cache, folder, name, address, "" );
356 g_hash_table_insert( harvester->dupTable, key, person );
359 addritem_parse_first_last( person );
363 * Remove specified string from name.
365 * str String to remove.
367 static void addrharvest_del_email( gchar *name, gchar *str ) {
371 lenr = strlen( str );
372 while((p = strcasestr( name, str )) != NULL) {
374 memmove( p, p + lenr, lenn );
379 * Find position of at (@) character in buffer.
380 * Enter: buffer Start of buffer.
381 * Return: Position of at character, or NULL if not found.
382 * Note: This function searches for the last occurrence of an 'at' character
383 * prior to a valid delimiter character for the end of address. This enables
384 * an address to be found where it is also used as the name of the
385 * recipient. For example:
386 * "axle.rose@netscape.com" <axle.rose@netscape.com>
387 * The last occurrence of the at character is detected.
389 static gchar *addrharvest_find_at( const gchar *buffer ) {
393 atCh = strchr( buffer, '@' );
395 /* Search forward for another one */
418 * Find start and end of address string.
419 * Enter: buf Start address of buffer to process (not modified).
420 * atp Pointer to email at (@) character.
421 * bp Pointer to start of email address (returned).
422 * ep Pointer to end of email address (returned).
424 static void addrharvest_find_address(
425 const gchar *buf, const gchar *atp, const gchar **bp,
430 /* Find first non-separator char */
434 if( strchr( ",; \n\r", *p ) == NULL ) break;
439 /* Search forward for end of address */
443 if( strchr( ",;", *p ) ) break;
450 * Extract E-Mail address from buffer. If found, address is removed from
452 * Enter: buffer Address buffer.
453 * Return: E-Mail address, or NULL if none found. Must g_free() when done.
455 static gchar *addrharvest_extract_address( gchar *buffer ) {
457 gchar *atCh, *p, *bp, *ep;
461 atCh = addrharvest_find_at( buffer );
463 /* Search back for start of address */
466 while( p >= buffer ) {
476 /* Search fwd for end */
484 else if( *p == ' ' ) {
495 addr = g_strndup( bp, len + 1 );
496 memmove( bp, ep, len );
505 * Parse address from header buffer creating address in cache.
506 * Enter: harvester Harvester object.
507 * entry Header object.
508 * cache Address cache to load.
509 * hdrBuf Pointer to header buffer.
511 static void addrharvest_parse_address(
512 AddressHarvester *harvester, HeaderEntry *entry,
513 AddressCache *cache, const gchar *hdrBuf )
515 gchar buffer[ ADDR_BUFFSIZE + 2 ];
518 gchar *atCh, *email, *name;
521 /* Search for an address */
522 while((atCh = addrharvest_find_at( hdrBuf )) != NULL) {
523 /* Find addres string */
524 addrharvest_find_address( hdrBuf, atCh, &bp, &ep );
526 /* Copy into buffer */
527 bufLen = ( size_t ) ( ep - bp );
528 if( bufLen > ADDR_BUFFSIZE ) {
529 bufLen = ADDR_BUFFSIZE;
531 strncpy( buffer, bp, bufLen );
532 buffer[ bufLen ] = '\0';
533 buffer[ bufLen + 1 ] = '\0';
534 buffer[ bufLen + 2 ] = '\0';
536 /* Extract address from buffer */
537 email = addrharvest_extract_address( buffer );
539 /* Unescape characters */
540 mgu_str_unescape( buffer );
542 /* Remove noise characaters */
543 addrharvest_del_email( buffer, REM_NAME_STRING );
544 addrharvest_del_email( buffer, REM_NAME_STRING2 );
546 /* Remove leading trailing quotes and spaces */
547 mgu_str_ltc2space( buffer, '\"', '\"' );
548 mgu_str_ltc2space( buffer, '\'', '\'' );
549 mgu_str_ltc2space( buffer, '\"', '\"' );
550 mgu_str_ltc2space( buffer, '(', ')' );
551 g_strstrip( buffer );
553 if( g_strcasecmp( buffer, email ) == 0 ) {
560 /* Insert into address book */
561 addrharvest_insert_cache(
562 harvester, entry, cache, name, email );
570 * Test whether buffer contains a header that appears in header list.
571 * Enter: listHdr Header list.
573 * Return: TRUE if header in list.
575 static gboolean addrharvest_check_hdr( GList *listHdr, gchar *buf ) {
578 gchar *p, *hdr, *nhdr;
582 p = strchr( buf, ':' );
584 len = ( size_t ) ( p - buf );
585 hdr = g_strndup( buf, len );
589 if( g_strcasecmp( nhdr, hdr ) == 0 ) {
593 node = g_list_next( node );
601 * Read header into a linked list of lines.
602 * Enter: fp File to read.
603 * listHdr List of header lines of interest.
604 * done End of headers or end of file reached.
605 * Return: Linked list of lines.
607 static GSList *addrharvest_get_header( FILE *fp, GList *listHdr, gboolean *done ) {
609 gchar buf[ MSG_BUFFSIZE + 2 ];
616 if( fgets( buf, MSG_BUFFSIZE, fp ) == NULL ) {
621 /* Test for end of headers */
622 if( buf[0] == '\r' || buf[0] == '\n' ) {
627 /* Test whether required header */
628 foundHdr = addrharvest_check_hdr( listHdr, buf );
630 /* Read all header lines. Only add reqd ones to list */
636 list = g_slist_append( list, p );
639 /* Read first character */
641 if( ch == ' ' || ch == '\t' ) {
642 /* Continuation character - read into buffer */
643 if( fgets( buf, MSG_BUFFSIZE, fp ) == NULL ) {
652 /* Push back character for next header */
663 * Read specified file into address book.
664 * Enter: harvester Harvester object.
665 * fileName File to read.
666 * cache Address cache to load.
669 static gint addrharvest_readfile(
670 AddressHarvester *harvester, const gchar *fileName,
671 AddressCache *cache, GList *listHdr )
675 gchar *buf, *addr, *p;
680 msgFile = fopen( fileName, "rb" );
682 /* Cannot open file */
683 retVal = MGU_OPEN_FILE;
689 list = addrharvest_get_header( msgFile, listHdr, &done );
696 buf = mgu_list_coalesce( list );
697 mgu_free_list( list );
699 if(( p = strchr( buf, ':' ) ) != NULL ) {
703 entry = addrharvest_find( harvester, buf );
704 if( entry && entry->selected ) {
705 /* Sanitize control characters */
708 if( *p == '\r' || *p == '\n' || *p == '\t' )
712 addrharvest_parse_address(
713 harvester, entry, cache, addr );
724 * Read all files in specified directory into address book. Directories are
725 * traversed recursively if necessary.
726 * Enter: harvester Harvester object.
727 * cache Address cache to load.
728 * msgList List of message numbers, or NULL to process folder.
729 * dir Directory to process.
731 static void addrharvest_harvest_dir(
732 AddressHarvester *harvester, AddressCache *cache, GList *listHdr,
740 if( ( dp = opendir( dir ) ) == NULL ) {
744 /* Process directory */
746 while( ( d = readdir( dp ) ) != NULL ) {
747 stat( d->d_name, &s );
748 if( S_ISDIR( s.st_mode ) ) {
749 if( harvester->folderRecurse ) {
750 if( strstr( DIR_IGNORE, d->d_name ) != NULL )
752 addrharvest_harvest_dir(
753 harvester, cache, listHdr, d->d_name );
756 if( S_ISREG( s.st_mode ) ) {
757 if( ( num = to_number( d->d_name ) ) >= 0 ) {
758 addrharvest_readfile(
759 harvester, d->d_name, cache, listHdr );
768 * Read list of files in specified directory into address book.
769 * Enter: harvester Harvester object.
770 * cache Address cache to load.
771 * msgList List of message numbers, or NULL to process folder.
773 static void addrharvest_harvest_list(
774 AddressHarvester *harvester, AddressCache *cache, GList *listHdr,
780 gchar msgNum[ MSGNUM_BUFFSIZE ];
782 if( ( dp = opendir( harvester->path ) ) == NULL ) {
786 /* Process message list */
787 chdir( harvester->path );
790 num = GPOINTER_TO_UINT( node->data );
791 sprintf( msgNum, "%d", num );
792 addrharvest_readfile( harvester, msgNum, cache, listHdr );
793 node = g_list_next( node );
799 * ============================================================================
800 * Read all files in specified directory into address book.
801 * Enter: harvester Harvester object.
802 * cache Address cache to load.
803 * msgList List of message numbers, or NULL to process folder.
805 * ============================================================================
807 gint addrharvest_harvest(
808 AddressHarvester *harvester, AddressCache *cache, GList *msgList )
814 retVal = MGU_BAD_ARGS;
815 g_return_val_if_fail( harvester != NULL, retVal );
816 g_return_val_if_fail( cache != NULL, retVal );
817 g_return_val_if_fail( harvester->path != NULL, retVal );
820 addrcache_clear( cache );
821 cache->dataRead = FALSE;
823 /* Build list of headers of interest */
825 node = harvester->headerTable;
830 if( entry->selected ) {
833 p = g_strdup( entry->header );
835 listHdr = g_list_append( listHdr, p );
837 node = g_list_next( node );
840 /* Process directory/files */
841 if( msgList == NULL ) {
842 addrharvest_harvest_dir( harvester, cache, listHdr, harvester->path );
845 addrharvest_harvest_list( harvester, cache, listHdr, msgList );
847 mgu_free_dlist( listHdr );
850 cache->modified = FALSE;
851 cache->dataRead = TRUE;
857 * ============================================================================
858 * Test whether any headers have been selected for processing.
859 * Enter: harvester Harvester object.
860 * Return: TRUE if a header was selected, FALSE if none were selected.
861 * ============================================================================
863 gboolean addrharvest_check_header( AddressHarvester *harvester ) {
868 g_return_val_if_fail( harvester != NULL, retVal );
870 node = harvester->headerTable;
874 entry = ( HeaderEntry * ) node->data;
875 if( entry->selected ) return TRUE;
876 node = g_list_next( node );
882 * ============================================================================
884 * ============================================================================