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"
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 );
87 static gint addrharvest_free_table_vis( gpointer key, gpointer value, gpointer data ) {
97 static void addrharvest_free_table( AddressHarvester* harvester ) {
101 /* Free header list */
102 node = harvester->headerTable;
104 entry = ( HeaderEntry * ) node->data;
105 entry->header = NULL;
106 entry->selected = FALSE;
107 entry->folder = NULL;
110 node = g_list_next( node );
112 g_list_free( harvester->headerTable );
113 harvester->headerTable = NULL;
115 /* Free duplicate table */
116 g_hash_table_freeze( harvester->dupTable );
117 g_hash_table_foreach_remove( harvester->dupTable, addrharvest_free_table_vis, NULL );
118 g_hash_table_thaw( harvester->dupTable );
119 g_hash_table_destroy( harvester->dupTable );
120 harvester->dupTable = NULL;
127 AddressHarvester *addrharvest_create( void ) {
128 AddressHarvester *harvester;
130 harvester = g_new0( AddressHarvester, 1 );
131 harvester->path = NULL;
132 harvester->dupTable = g_hash_table_new( g_str_hash, g_str_equal );
133 harvester->folderSize = DFL_FOLDER_SIZE;
134 harvester->retVal = MGU_SUCCESS;
136 /* Build header table */
137 harvester->headerTable = NULL;
138 addrharvest_build_entry( harvester, _headerFrom_ );
139 addrharvest_build_entry( harvester, _headerReplyTo_ );
140 addrharvest_build_entry( harvester, _headerSender_ );
141 addrharvest_build_entry( harvester, _headerErrorsTo_ );
142 addrharvest_build_entry( harvester, _headerCC_ );
143 addrharvest_build_entry( harvester, _headerTo_ );
152 * Specify path to folder that will be harvested.
153 * Entry: harvester Harvester object.
154 * value Full directory path.
156 void addrharvest_set_path( AddressHarvester* harvester, const gchar *value ) {
157 g_return_if_fail( harvester != NULL );
158 harvester->path = mgu_replace_string( harvester->path, value );
159 g_strstrip( harvester->path );
163 * Specify maximum folder size.
164 * Entry: harvester Harvester object.
167 void addrharvest_set_folder_size(
168 AddressHarvester* harvester, const gint value )
170 g_return_if_fail( harvester != NULL );
172 harvester->folderSize = value;
177 * Specify folder recursion.
178 * Entry: harvester Harvester object.
179 * value TRUE to process sub-folders, FALSE to process folder only.
181 void addrharvest_set_recurse(
182 AddressHarvester* harvester, const gboolean value )
184 g_return_if_fail( harvester != NULL );
185 harvester->folderRecurse = value;
189 * Search (case insensitive) for header entry with specified name.
190 * Enter: harvester Harvester.
192 * Return: Header, or NULL if not found.
194 static HeaderEntry *addrharvest_find(
195 AddressHarvester* harvester, const gchar *name ) {
200 node = harvester->headerTable;
205 if (g_ascii_strncasecmp(entry->header, name,
206 strlen(entry->header)) == 0 ) {
210 node = g_list_next( node );
216 * Set selection for specified heaader.
217 * Enter: harvester Harvester.
219 * value Value to set.
221 void addrharvest_set_header(
222 AddressHarvester* harvester, const gchar *name, const gboolean value )
226 g_return_if_fail( harvester != NULL );
227 entry = addrharvest_find( harvester, name );
228 if( entry != NULL ) {
229 entry->selected = value;
235 * Enter: harvester Harvester.
237 * Return: Address count, or -1 if header not found.
239 gint addrharvest_get_count( AddressHarvester* harvester, const gchar *name ) {
244 g_return_val_if_fail( harvester != NULL, count );
245 entry = addrharvest_find( harvester, name );
246 if( entry != NULL ) {
247 count = entry->count;
253 * Free up object by releasing internal memory.
254 * Enter: harvester Harvester.
256 void addrharvest_free( AddressHarvester *harvester ) {
257 g_return_if_fail( harvester != NULL );
259 /* Free internal stuff */
260 addrharvest_free_table( harvester );
261 g_free( harvester->path );
264 harvester->path = NULL;
265 harvester->retVal = MGU_SUCCESS;
266 harvester->headerTable = NULL;
268 harvester->folderSize = 0;
270 /* Now release object */
275 * Display object to specified stream.
276 * Enter: harvester Harvester.
277 * stream Output stream.
279 void addrharvest_print( AddressHarvester *harvester, FILE *stream ) {
283 g_return_if_fail( harvester != NULL );
284 fprintf( stream, "Address Harvester:\n" );
285 fprintf( stream, " file path: '%s'\n", harvester->path );
286 fprintf( stream, "max folder: %d'\n", harvester->folderSize );
288 node = harvester->headerTable;
291 fprintf( stream, " header: %s", entry->header );
292 fprintf( stream, "\t: %s", entry->selected ? "yes" : "no" );
293 fprintf( stream, "\t: %d\n", entry->count );
294 node = g_list_next( node );
296 fprintf( stream, " ret val: %d\n", harvester->retVal );
300 * Insert address into cache.
301 * Enter: harvester Harvester object.
302 * entry Header object.
303 * cache Address cache to load.
305 * address eMail address.
307 static void addrharvest_insert_cache(
308 AddressHarvester *harvester, HeaderEntry *entry,
309 AddressCache *cache, const gchar *name,
310 const gchar *address )
320 folder = entry->folder;
321 if( folder == NULL ) {
322 newFolder = TRUE; /* No folder yet */
324 if( entry->count % harvester->folderSize == 0 ) {
325 newFolder = TRUE; /* Folder is full */
329 key = g_strdup( address );
331 person = g_hash_table_lookup( harvester->dupTable, key );
333 /* Update existing person to use longest name */
334 value = ADDRITEM_NAME(person);
335 if( strlen( name ) > strlen( value ) ) {
336 addritem_person_set_common_name( person, name );
341 /* Folder if required */
343 cnt = 1 + ( entry->count / harvester->folderSize );
344 folderName =g_strdup_printf( "%s (%d)",
345 entry->header, cnt );
346 folder = addritem_create_item_folder();
347 addritem_folder_set_name( folder, folderName );
348 addritem_folder_set_remarks( folder, "" );
349 addrcache_id_folder( cache, folder );
350 addrcache_add_folder( cache, folder );
351 entry->folder = folder;
352 g_free( folderName );
356 person = addrcache_add_contact(
357 cache, folder, name, address, "" );
358 g_hash_table_insert( harvester->dupTable, key, person );
361 addritem_parse_first_last( person );
365 * Remove specified string from name.
367 * str String to remove.
369 static void addrharvest_del_email( gchar *name, gchar *str ) {
373 lenr = strlen( str );
374 while((p = strcasestr( name, str )) != NULL) {
376 memmove( p, p + lenr, lenn );
381 * Find position of at (@) character in buffer.
382 * Enter: buffer Start of buffer.
383 * Return: Position of at character, or NULL if not found.
384 * Note: This function searches for the last occurrence of an 'at' character
385 * prior to a valid delimiter character for the end of address. This enables
386 * an address to be found where it is also used as the name of the
387 * recipient. For example:
388 * "axle.rose@netscape.com" <axle.rose@netscape.com>
389 * The last occurrence of the at character is detected.
391 static gchar *addrharvest_find_at( const gchar *buffer ) {
395 atCh = strchr( buffer, '@' );
397 /* Search forward for another one */
420 * Find start and end of address string.
421 * Enter: buf Start address of buffer to process (not modified).
422 * atp Pointer to email at (@) character.
423 * bp Pointer to start of email address (returned).
424 * ep Pointer to end of email address (returned).
426 static void addrharvest_find_address(
427 const gchar *buf, const gchar *atp, const gchar **bp,
432 /* Find first non-separator char */
436 if( strchr( ",; \n\r", *p ) == NULL ) break;
441 /* Search forward for end of address */
445 if( strchr( ",;", *p ) ) break;
452 * Extract E-Mail address from buffer. If found, address is removed from
454 * Enter: buffer Address buffer.
455 * Return: E-Mail address, or NULL if none found. Must g_free() when done.
457 static gchar *addrharvest_extract_address( gchar *buffer ) {
459 gchar *atCh, *p, *bp, *ep;
463 atCh = addrharvest_find_at( buffer );
465 /* Search back for start of address */
468 while( p >= buffer ) {
478 /* Search fwd for end */
486 else if( *p == ' ' ) {
497 addr = g_strndup( bp, len + 1 );
498 memmove( bp, ep, len );
507 * Parse address from header buffer creating address in cache.
508 * Enter: harvester Harvester object.
509 * entry Header object.
510 * cache Address cache to load.
511 * hdrBuf Pointer to header buffer.
513 static void addrharvest_parse_address(
514 AddressHarvester *harvester, HeaderEntry *entry,
515 AddressCache *cache, const gchar *hdrBuf )
517 gchar buffer[ ADDR_BUFFSIZE + 2 ];
520 gchar *atCh, *email, *name;
523 /* Search for an address */
524 while((atCh = addrharvest_find_at( hdrBuf )) != NULL) {
525 /* Find addres string */
526 addrharvest_find_address( hdrBuf, atCh, &bp, &ep );
528 /* Copy into buffer */
529 bufLen = ( size_t ) ( ep - bp );
530 if( bufLen > ADDR_BUFFSIZE ) {
531 bufLen = ADDR_BUFFSIZE;
533 strncpy( buffer, bp, bufLen );
534 buffer[ bufLen ] = '\0';
535 buffer[ bufLen + 1 ] = '\0';
536 buffer[ bufLen + 2 ] = '\0';
538 /* Extract address from buffer */
539 email = addrharvest_extract_address( buffer );
541 /* Unescape characters */
542 mgu_str_unescape( buffer );
544 /* Remove noise characaters */
545 addrharvest_del_email( buffer, REM_NAME_STRING );
546 addrharvest_del_email( buffer, REM_NAME_STRING2 );
548 /* Remove leading trailing quotes and spaces */
549 mgu_str_ltc2space( buffer, '\"', '\"' );
550 mgu_str_ltc2space( buffer, '\'', '\'' );
551 mgu_str_ltc2space( buffer, '\"', '\"' );
552 mgu_str_ltc2space( buffer, '(', ')' );
553 g_strstrip( buffer );
555 if( g_ascii_strcasecmp( buffer, email ) == 0 ) {
560 name = conv_unmime_header(buffer, NULL);
563 /* Insert into address book */
564 addrharvest_insert_cache(
565 harvester, entry, cache, name, email );
574 * Test whether buffer contains a header that appears in header list.
575 * Enter: listHdr Header list.
577 * Return: TRUE if header in list.
579 static gboolean addrharvest_check_hdr( GList *listHdr, gchar *buf ) {
582 gchar *p, *hdr, *nhdr;
586 p = strchr( buf, ':' );
588 len = ( size_t ) ( p - buf );
589 hdr = g_strndup( buf, len );
593 if (g_ascii_strncasecmp(nhdr, hdr, strlen(nhdr)) == 0 ) {
597 node = g_list_next( node );
605 * Read header into a linked list of lines.
606 * Enter: fp File to read.
607 * listHdr List of header lines of interest.
608 * done End of headers or end of file reached.
609 * Return: Linked list of lines.
611 static GSList *addrharvest_get_header( FILE *fp, GList *listHdr, gboolean *done ) {
613 gchar buf[ MSG_BUFFSIZE + 2 ];
620 if( fgets( buf, MSG_BUFFSIZE, fp ) == NULL ) {
625 /* Test for end of headers */
626 if( buf[0] == '\r' || buf[0] == '\n' ) {
631 /* Test whether required header */
632 foundHdr = addrharvest_check_hdr( listHdr, buf );
634 /* Read all header lines. Only add reqd ones to list */
640 list = g_slist_append( list, p );
643 /* Read first character */
645 if( ch == ' ' || ch == '\t' ) {
646 /* Continuation character - read into buffer */
647 if( fgets( buf, MSG_BUFFSIZE, fp ) == NULL ) {
656 /* Push back character for next header */
667 * Read specified file into address book.
668 * Enter: harvester Harvester object.
669 * fileName File to read.
670 * cache Address cache to load.
673 static gint addrharvest_readfile(
674 AddressHarvester *harvester, const gchar *fileName,
675 AddressCache *cache, GList *listHdr )
679 gchar *buf, *addr, *p;
684 msgFile = fopen( fileName, "rb" );
686 /* Cannot open file */
687 retVal = MGU_OPEN_FILE;
693 list = addrharvest_get_header( msgFile, listHdr, &done );
700 buf = mgu_list_coalesce( list );
701 mgu_free_list( list );
703 if(( p = strchr( buf, ':' ) ) != NULL ) {
707 entry = addrharvest_find( harvester, buf );
708 if( entry && entry->selected ) {
709 /* Sanitize control characters */
712 if( *p == '\r' || *p == '\n' || *p == '\t' )
716 addrharvest_parse_address(
717 harvester, entry, cache, addr );
728 * Read all files in specified directory into address book. Directories are
729 * traversed recursively if necessary.
730 * Enter: harvester Harvester object.
731 * cache Address cache to load.
732 * msgList List of message numbers, or NULL to process folder.
733 * dir Directory to process.
735 static void addrharvest_harvest_dir(
736 AddressHarvester *harvester, AddressCache *cache, GList *listHdr,
744 if( ( dp = opendir( dir ) ) == NULL ) {
748 /* Process directory */
750 while( ( d = readdir( dp ) ) != NULL ) {
751 stat( d->d_name, &s );
752 if( S_ISDIR( s.st_mode ) ) {
753 if( harvester->folderRecurse ) {
754 if( strstr( DIR_IGNORE, d->d_name ) != NULL )
756 addrharvest_harvest_dir(
757 harvester, cache, listHdr, d->d_name );
760 if( S_ISREG( s.st_mode ) ) {
761 if( ( num = to_number( d->d_name ) ) >= 0 ) {
762 addrharvest_readfile(
763 harvester, d->d_name, cache, listHdr );
772 * Read list of files in specified directory into address book.
773 * Enter: harvester Harvester object.
774 * cache Address cache to load.
775 * msgList List of message numbers, or NULL to process folder.
777 static void addrharvest_harvest_list(
778 AddressHarvester *harvester, AddressCache *cache, GList *listHdr,
784 gchar msgNum[ MSGNUM_BUFFSIZE ];
786 if( ( dp = opendir( harvester->path ) ) == NULL ) {
790 /* Process message list */
791 chdir( harvester->path );
794 num = GPOINTER_TO_UINT( node->data );
795 sprintf( msgNum, "%d", num );
796 addrharvest_readfile( harvester, msgNum, cache, listHdr );
797 node = g_list_next( node );
803 * ============================================================================
804 * Read all files in specified directory into address book.
805 * Enter: harvester Harvester object.
806 * cache Address cache to load.
807 * msgList List of message numbers, or NULL to process folder.
809 * ============================================================================
811 gint addrharvest_harvest(
812 AddressHarvester *harvester, AddressCache *cache, GList *msgList )
818 retVal = MGU_BAD_ARGS;
819 g_return_val_if_fail( harvester != NULL, retVal );
820 g_return_val_if_fail( cache != NULL, retVal );
821 g_return_val_if_fail( harvester->path != NULL, retVal );
824 addrcache_clear( cache );
825 cache->dataRead = FALSE;
827 /* Build list of headers of interest */
829 node = harvester->headerTable;
834 if( entry->selected ) {
837 p = g_strdup( entry->header );
839 listHdr = g_list_append( listHdr, p );
841 node = g_list_next( node );
844 /* Process directory/files */
845 if( msgList == NULL ) {
846 addrharvest_harvest_dir( harvester, cache, listHdr, harvester->path );
849 addrharvest_harvest_list( harvester, cache, listHdr, msgList );
851 mgu_free_dlist( listHdr );
854 cache->modified = FALSE;
855 cache->dataRead = TRUE;
861 * ============================================================================
862 * Test whether any headers have been selected for processing.
863 * Enter: harvester Harvester object.
864 * Return: TRUE if a header was selected, FALSE if none were selected.
865 * ============================================================================
867 gboolean addrharvest_check_header( AddressHarvester *harvester ) {
872 g_return_val_if_fail( harvester != NULL, retVal );
874 node = harvester->headerTable;
878 entry = ( HeaderEntry * ) node->data;
879 if( entry->selected ) return TRUE;
880 node = g_list_next( node );
886 * ============================================================================
888 * ============================================================================