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 3 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, see <http://www.gnu.org/licenses/>.
21 * Functions necessary to access vCard files. vCard files are used
22 * by GnomeCard for addressbook, and Netscape for sending business
23 * card information. Refer to RFC2426 for more information.
33 #include "addrcache.h"
34 #include "adbookbase.h"
37 #define GNOMECARD_DIR ".gnome"
38 #define GNOMECARD_FILE "GnomeCard"
39 #define GNOMECARD_SECTION "[file]"
40 #define GNOMECARD_PARAM "open"
42 #define VCARD_TEST_LINES 200
45 * Create new cardfile object.
47 VCardFile *vcard_create() {
49 cardFile = g_new0( VCardFile, 1 );
50 cardFile->type = ADBOOKTYPE_VCARD;
51 cardFile->addressCache = addrcache_create();
52 cardFile->retVal = MGU_SUCCESS;
54 cardFile->file = NULL;
55 cardFile->path = NULL;
56 cardFile->bufptr = cardFile->buffer;
63 void vcard_set_name( VCardFile* cardFile, const gchar *value ) {
64 g_return_if_fail( cardFile != NULL );
65 addrcache_set_name( cardFile->addressCache, value );
67 void vcard_set_file( VCardFile* cardFile, const gchar *value ) {
68 g_return_if_fail( cardFile != NULL );
69 addrcache_refresh( cardFile->addressCache );
70 cardFile->path = mgu_replace_string( cardFile->path, value );
71 g_strstrip( cardFile->path );
73 void vcard_set_accessed( VCardFile *cardFile, const gboolean value ) {
74 g_return_if_fail( cardFile != NULL );
75 cardFile->addressCache->accessFlag = value;
79 * Test whether file was modified since last access.
80 * Return: TRUE if file was modified.
82 gboolean vcard_get_modified( VCardFile *cardFile ) {
83 g_return_val_if_fail( cardFile != NULL, FALSE );
84 cardFile->addressCache->modified =
85 addrcache_check_file( cardFile->addressCache, cardFile->path );
86 return cardFile->addressCache->modified;
88 gboolean vcard_get_accessed( VCardFile *cardFile ) {
89 g_return_val_if_fail( cardFile != NULL, FALSE );
90 return cardFile->addressCache->accessFlag;
94 * Test whether file was read.
95 * Return: TRUE if file was read.
97 gboolean vcard_get_read_flag( VCardFile *cardFile ) {
98 g_return_val_if_fail( cardFile != NULL, FALSE );
99 return cardFile->addressCache->dataRead;
101 void vcard_set_read_flag( VCardFile *cardFile, const gboolean value ) {
102 g_return_if_fail( cardFile != NULL );
103 cardFile->addressCache->dataRead = value;
107 * Return status code from last file operation.
108 * Return: Status code.
110 gint vcard_get_status( VCardFile *cardFile ) {
111 g_return_val_if_fail( cardFile != NULL, -1 );
112 return cardFile->retVal;
115 ItemFolder *vcard_get_root_folder( VCardFile *cardFile ) {
116 g_return_val_if_fail( cardFile != NULL, NULL );
117 return addrcache_get_root_folder( cardFile->addressCache );
119 gchar *vcard_get_name( VCardFile *cardFile ) {
120 g_return_val_if_fail( cardFile != NULL, NULL );
121 return addrcache_get_name( cardFile->addressCache );
125 * Refresh internal variables to force a file read.
127 void vcard_force_refresh( VCardFile *cardFile ) {
128 addrcache_refresh( cardFile->addressCache );
132 * Create new cardfile object for specified file.
134 VCardFile *vcard_create_path( const gchar *path ) {
136 cardFile = vcard_create();
137 vcard_set_file(cardFile, path);
142 * Free up cardfile object by releasing internal memory.
144 void vcard_free( VCardFile *cardFile ) {
145 g_return_if_fail( cardFile != NULL );
148 if( cardFile->file ) fclose( cardFile->file );
151 addrcache_clear( cardFile->addressCache );
152 addrcache_free( cardFile->addressCache );
154 /* Free internal stuff */
155 g_free( cardFile->path );
158 cardFile->file = NULL;
159 cardFile->path = NULL;
160 cardFile->bufptr = NULL;
162 cardFile->type = ADBOOKTYPE_NONE;
163 cardFile->addressCache = NULL;
164 cardFile->retVal = MGU_SUCCESS;
166 /* Now release file object */
171 * Open file for read.
172 * return: TRUE if file opened successfully.
174 static gint vcard_open_file( VCardFile* cardFile ) {
175 g_return_val_if_fail( cardFile != NULL, -1 );
177 /* fprintf( stdout, "Opening file\n" ); */
178 cardFile->addressCache->dataRead = FALSE;
179 if( cardFile->path ) {
180 cardFile->file = g_fopen( cardFile->path, "rb" );
181 if( ! cardFile->file ) {
182 /* fprintf( stderr, "can't open %s\n", cardFile->path ); */
183 cardFile->retVal = MGU_OPEN_FILE;
184 return cardFile->retVal;
188 /* fprintf( stderr, "file not specified\n" ); */
189 cardFile->retVal = MGU_NO_FILE;
190 return cardFile->retVal;
193 /* Setup a buffer area */
194 cardFile->buffer[0] = '\0';
195 cardFile->bufptr = cardFile->buffer;
196 cardFile->retVal = MGU_SUCCESS;
197 return cardFile->retVal;
203 static void vcard_close_file( VCardFile *cardFile ) {
204 g_return_if_fail( cardFile != NULL );
205 if( cardFile->file ) fclose( cardFile->file );
206 cardFile->file = NULL;
210 * Read line of text from file.
211 * Return: ptr to buffer where line starts.
213 static gchar *vcard_read_line( VCardFile *cardFile ) {
214 while( *cardFile->bufptr == '\n' || *cardFile->bufptr == '\0' ) {
215 if( fgets( cardFile->buffer, VCARDBUFSIZE, cardFile->file ) == NULL )
217 g_strstrip( cardFile->buffer );
218 cardFile->bufptr = cardFile->buffer;
220 return cardFile->bufptr;
224 * Read line of text from file.
225 * Return: ptr to buffer where line starts.
227 static gchar *vcard_get_line( VCardFile *cardFile ) {
228 gchar buf[ VCARDBUFSIZE ];
232 if (vcard_read_line( cardFile ) == NULL ) {
237 /* Copy into private buffer */
238 start = cardFile->bufptr;
239 len = strlen( start );
241 strncpy( buf, start, len );
244 cardFile->bufptr = end + 1;
246 /* Return a copy of buffer */
247 return g_strdup( buf );
251 * Free linked lists of character strings.
253 static void vcard_free_lists( GSList *listName, GSList *listAddr, GSList *listRem, GSList* listID ) {
254 mgu_free_list( listName );
255 mgu_free_list( listAddr );
256 mgu_free_list( listRem );
257 mgu_free_list( listID );
261 * Read quoted-printable text, which may span several lines into one long string.
262 * Param: cardFile - object.
263 * Param: tagvalue - will be placed into the linked list.
265 static gchar *vcard_read_qp( VCardFile *cardFile, char *tagvalue ) {
266 GSList *listQP = NULL;
268 gchar *line = tagvalue;
270 listQP = g_slist_append( listQP, line );
271 len = strlen( line ) - 1;
272 if( line[ len ] != '=' ) break;
274 line = vcard_get_line( cardFile );
277 /* Coalesce linked list into one long buffer. */
278 line = mgu_list_coalesce( listQP );
281 mgu_free_list( listQP );
287 * Parse tag name from line buffer.
288 * Return: Buffer containing the tag name, or NULL if no delimiter char found.
290 static gchar *vcard_get_tagname( char* line, gchar dlm ) {
298 tag = g_strndup( line, len+1 );
308 * Parse tag value from line buffer.
309 * Return: Buffer containing the tag value. Empty string is returned if
310 * no delimiter char found.
312 static gchar *vcard_get_tagvalue( gchar* line, gchar dlm ) {
318 for( lptr = line; *lptr; lptr++ ) {
326 value = g_strndup( start, len+1 );
329 /* Ensure that we get an empty string */
330 value = g_strndup( "", 1 );
337 * Build an address list entry and append to list of address items.
339 static void vcard_build_items(
340 VCardFile *cardFile, GSList *listName, GSList *listAddr,
341 GSList *listRem, GSList *listID )
343 GSList *nodeName = listName;
344 GSList *nodeID = listID;
347 GSList *nodeAddress = listAddr;
348 GSList *nodeRemarks = listRem;
349 ItemPerson *person = addritem_create_item_person();
350 addritem_person_set_common_name( person, nodeName->data );
351 while( nodeAddress ) {
352 str = nodeAddress->data;
354 ItemEMail *email = addritem_create_item_email();
355 addritem_email_set_address( email, str );
356 str = nodeRemarks->data;
359 if( g_utf8_collate( str, "internet" ) != 0 ) {
361 addritem_email_set_remarks( email, str );
365 addrcache_id_email( cardFile->addressCache, email );
366 addrcache_person_add_email( cardFile->addressCache, person, email );
368 nodeAddress = g_slist_next( nodeAddress );
369 nodeRemarks = g_slist_next( nodeRemarks );
371 if( person->listEMail ) {
372 addrcache_id_person( cardFile->addressCache, person );
373 addrcache_add_person( cardFile->addressCache, person );
376 addritem_person_set_external_id( person, str );
380 addritem_free_item_person( person );
382 nodeName = g_slist_next( nodeName );
383 nodeID = g_slist_next( nodeID );
387 /* Unescape characters in quoted-printable string. */
388 static void vcard_unescape_qp( gchar *value ) {
389 gchar *ptr, *src, *dest;
400 if( ch > '0' && ch < '8' ) v = ch - '0';
405 if( ch > '\x60' ) ch -= '\x20';
406 if( ch > '0' && ch < ' ' ) d = ch - '0';
409 if( d > -1 && d < 16 ) {
416 /* Replace = with char and move down in buffer */
430 * Read file data into root folder.
431 * Note that one vCard can have multiple E-Mail addresses (MAIL tags);
432 * these are broken out into separate address items. An address item
433 * is generated for the person identified by FN tag and each EMAIL tag.
434 * If a sub-type is included in the EMAIL entry, this will be used as
435 * the Remarks member. Also note that it is possible for one vCard
436 * entry to have multiple FN tags; this might not make sense. However,
437 * it will generate duplicate address entries for each person listed.
439 static void vcard_read_file( VCardFile *cardFile ) {
440 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL;
441 GSList *listName = NULL, *listAddress = NULL, *listRemarks = NULL, *listID = NULL;
442 /* GSList *listQP = NULL; */
445 gchar *line = vcard_get_line( cardFile );
446 if( line == NULL ) break;
448 /* fprintf( stdout, "%s\n", line ); */
451 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
452 if( tagtemp == NULL ) {
457 /* fprintf( stdout, "\ttemp: %s\n", tagtemp ); */
458 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
459 if( tagvalue == NULL ) {
465 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
466 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
467 if( tagname == NULL ) {
472 /* fprintf( stdout, "\tname: %s\n", tagname ); */
473 /* fprintf( stdout, "\ttype: %s\n", tagtype ); */
474 /* fprintf( stdout, "\tvalue: %s\n", tagvalue ); */
476 if( g_utf8_collate( tagtype, VCARD_TYPE_QP ) == 0 ) {
477 /* Quoted-Printable: could span multiple lines */
478 tagvalue = vcard_read_qp( cardFile, tagvalue );
479 vcard_unescape_qp( tagvalue );
480 /* fprintf( stdout, "QUOTED-PRINTABLE !!! final\n>%s<\n", tagvalue ); */
483 if( g_utf8_collate( tagname, VCARD_TAG_START ) == 0 &&
484 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
485 /* fprintf( stdout, "start card\n" ); */
486 vcard_free_lists( listName, listAddress, listRemarks, listID );
487 listName = listAddress = listRemarks = listID = NULL;
489 if( g_utf8_collate( tagname, VCARD_TAG_FULLNAME ) == 0 ) {
490 /* fprintf( stdout, "- full name: %s\n", tagvalue ); */
491 listName = g_slist_append( listName, g_strdup( tagvalue ) );
493 if( g_utf8_collate( tagname, VCARD_TAG_EMAIL ) == 0 ) {
494 /* fprintf( stdout, "- address: %s\n", tagvalue ); */
495 listAddress = g_slist_append( listAddress, g_strdup( tagvalue ) );
496 listRemarks = g_slist_append( listRemarks, g_strdup( tagtype ) );
498 if( g_utf8_collate( tagname, VCARD_TAG_UID ) == 0 ) {
499 /* fprintf( stdout, "- id: %s\n", tagvalue ); */
500 listID = g_slist_append( listID, g_strdup( tagvalue ) );
502 if( g_utf8_collate( tagname, VCARD_TAG_END ) == 0 &&
503 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
504 /* vCard is complete */
505 /* fprintf( stdout, "end card\n--\n" ); */
506 /* vcard_dump_lists( listName, listAddress, listRemarks, listID, stdout ); */
507 vcard_build_items( cardFile, listName, listAddress, listRemarks, listID );
508 vcard_free_lists( listName, listAddress, listRemarks, listID );
509 listName = listAddress = listRemarks = listID = NULL;
521 vcard_free_lists( listName, listAddress, listRemarks, listID );
522 listName = listAddress = listRemarks = listID = NULL;
525 /* ============================================================================================ */
527 * Read file into list. Main entry point
528 * Return: TRUE if file read successfully.
530 /* ============================================================================================ */
531 gint vcard_read_data( VCardFile *cardFile ) {
532 g_return_val_if_fail( cardFile != NULL, -1 );
534 cardFile->retVal = MGU_SUCCESS;
535 cardFile->addressCache->accessFlag = FALSE;
536 if( addrcache_check_file( cardFile->addressCache, cardFile->path ) ) {
537 addrcache_clear( cardFile->addressCache );
538 vcard_open_file( cardFile );
539 if( cardFile->retVal == MGU_SUCCESS ) {
540 /* Read data into the list */
541 vcard_read_file( cardFile );
542 vcard_close_file( cardFile );
545 addrcache_mark_file( cardFile->addressCache, cardFile->path );
546 cardFile->addressCache->modified = FALSE;
547 cardFile->addressCache->dataRead = TRUE;
550 return cardFile->retVal;
554 * Return link list of persons.
556 GList *vcard_get_list_person( VCardFile *cardFile ) {
557 g_return_val_if_fail( cardFile != NULL, NULL );
558 return addrcache_get_list_person( cardFile->addressCache );
562 * Return link list of folders. This is always NULL since there are
563 * no folders in GnomeCard.
566 GList *vcard_get_list_folder( VCardFile *cardFile ) {
567 g_return_val_if_fail( cardFile != NULL, NULL );
572 * Return link list of all persons. Note that the list contains references
573 * to items. Do *NOT* attempt to use the addrbook_free_xxx() functions...
574 * this will destroy the addressbook data!
575 * Return: List of items, or NULL if none.
577 GList *vcard_get_all_persons( VCardFile *cardFile ) {
578 g_return_val_if_fail( cardFile != NULL, NULL );
579 return addrcache_get_all_persons( cardFile->addressCache );
583 * Validate that all parameters specified.
584 * Return: TRUE if data is good.
586 gboolean vcard_validate( const VCardFile *cardFile ) {
590 g_return_val_if_fail( cardFile != NULL, FALSE );
593 if( cardFile->path ) {
594 if( strlen( cardFile->path ) < 1 ) retVal = FALSE;
599 name = addrcache_get_name( cardFile->addressCache );
601 if( strlen( name ) < 1 ) retVal = FALSE;
609 #define WORK_BUFLEN 1024
612 * Attempt to find a valid GnomeCard file.
613 * Return: Filename, or home directory if not found. Filename should
614 * be g_free() when done.
616 gchar *vcard_find_gnomecard( void ) {
617 const gchar *homedir;
618 gchar buf[ WORK_BUFLEN ];
619 gchar str[ WORK_BUFLEN ];
624 homedir = get_home_dir();
625 if( ! homedir ) return NULL;
627 strcpy( str, homedir );
630 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
631 str[ len ] = G_DIR_SEPARATOR;
635 strcat( str, GNOMECARD_DIR );
636 strcat( str, G_DIR_SEPARATOR_S );
637 strcat( str, GNOMECARD_FILE );
640 if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
641 /* Read configuration file */
642 lenlbl = strlen( GNOMECARD_SECTION );
643 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
644 if( 0 == g_ascii_strncasecmp( buf, GNOMECARD_SECTION, lenlbl ) ) {
649 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
651 if( buf[0] == '[' ) break;
652 for( i = 0; i < lenlbl; i++ ) {
653 if( buf[i] == '=' ) {
654 if( 0 == g_ascii_strncasecmp( buf, GNOMECARD_PARAM, i ) ) {
655 fileSpec = g_strdup( buf + i + 1 );
656 g_strstrip( fileSpec );
664 if( fileSpec == NULL ) {
665 /* Use the home directory */
667 fileSpec = g_strdup( str );
674 * Attempt to read file, testing for valid vCard format.
675 * Return: TRUE if file appears to be valid format.
677 gint vcard_test_read_file( const gchar *fileSpec ) {
679 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL, *line;
683 if( ! fileSpec ) return MGU_NO_FILE;
685 cardFile = vcard_create_path( fileSpec );
686 cardFile->retVal = MGU_SUCCESS;
687 vcard_open_file( cardFile );
688 if( cardFile->retVal == MGU_SUCCESS ) {
689 cardFile->retVal = MGU_BAD_FORMAT;
691 lines = VCARD_TEST_LINES;
694 if( ( line = vcard_get_line( cardFile ) ) == NULL ) break;
697 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
698 if( tagtemp == NULL ) {
703 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
704 if( tagvalue == NULL ) {
710 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
711 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
712 if( tagname == NULL ) {
717 if( g_utf8_collate( tagtype, VCARD_TYPE_QP ) == 0 ) {
718 /* Quoted-Printable: could span multiple lines */
719 tagvalue = vcard_read_qp( cardFile, tagvalue );
720 vcard_unescape_qp( tagvalue );
722 if( g_utf8_collate( tagname, VCARD_TAG_START ) == 0 &&
723 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
726 if( g_utf8_collate( tagname, VCARD_TAG_END ) == 0 &&
727 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
728 /* vCard is complete */
729 if( haveStart ) cardFile->retVal = MGU_SUCCESS;
738 vcard_close_file( cardFile );
740 retVal = cardFile->retVal;
741 vcard_free( cardFile );