2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-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 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"
36 #define GNOMECARD_DIR ".gnome"
37 #define GNOMECARD_FILE "GnomeCard"
38 #define GNOMECARD_SECTION "[file]"
39 #define GNOMECARD_PARAM "open"
41 #define VCARD_TEST_LINES 200
44 * Create new cardfile object.
46 VCardFile *vcard_create() {
48 cardFile = g_new0( VCardFile, 1 );
49 cardFile->type = ADBOOKTYPE_VCARD;
50 cardFile->addressCache = addrcache_create();
51 cardFile->accessFlag = FALSE;
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->accessFlag = value;
79 * Test whether file was modified since last access.
80 * Return: TRUE if file was modified.
82 gboolean vcard_get_modified( VCardFile *vcardFile ) {
83 g_return_val_if_fail( vcardFile != NULL, FALSE );
84 return addrcache_check_file( vcardFile->addressCache, vcardFile->path );
86 gboolean vcard_get_accessed( VCardFile *vcardFile ) {
87 g_return_val_if_fail( vcardFile != NULL, FALSE );
88 return addrcache_check_file( vcardFile->addressCache, vcardFile->path );
92 * Test whether file was read.
93 * Return: TRUE if file was read.
95 gboolean vcard_get_read_flag( VCardFile *vcardFile ) {
96 g_return_val_if_fail( vcardFile != NULL, FALSE );
97 return vcardFile->addressCache->dataRead;
101 * Return status code from last file operation.
102 * Return: Status code.
104 gint vcard_get_status( VCardFile *cardFile ) {
105 g_return_val_if_fail( cardFile != NULL, -1 );
106 return cardFile->retVal;
109 ItemFolder *vcard_get_root_folder( VCardFile *cardFile ) {
110 g_return_val_if_fail( cardFile != NULL, NULL );
111 return addrcache_get_root_folder( cardFile->addressCache );
113 gchar *vcard_get_name( VCardFile *cardFile ) {
114 g_return_val_if_fail( cardFile != NULL, NULL );
115 return addrcache_get_name( cardFile->addressCache );
119 * Refresh internal variables to force a file read.
121 void vcard_force_refresh( VCardFile *cardFile ) {
122 addrcache_refresh( cardFile->addressCache );
126 * Create new cardfile object for specified file.
128 VCardFile *vcard_create_path( const gchar *path ) {
130 cardFile = vcard_create();
131 vcard_set_file(cardFile, path);
136 * Free up cardfile object by releasing internal memory.
138 void vcard_free( VCardFile *cardFile ) {
139 g_return_if_fail( cardFile != NULL );
142 if( cardFile->file ) fclose( cardFile->file );
145 addrcache_clear( cardFile->addressCache );
146 addrcache_free( cardFile->addressCache );
148 /* Free internal stuff */
149 g_free( cardFile->path );
152 cardFile->file = NULL;
153 cardFile->path = NULL;
154 cardFile->bufptr = NULL;
156 cardFile->type = ADBOOKTYPE_NONE;
157 cardFile->addressCache = NULL;
158 cardFile->accessFlag = FALSE;
159 cardFile->retVal = MGU_SUCCESS;
161 /* Now release file object */
166 * Display object to specified stream.
168 void vcard_print_file( VCardFile *cardFile, FILE *stream ) {
169 g_return_if_fail( cardFile != NULL );
171 fprintf( stream, "VCardFile:\n" );
172 fprintf( stream, "file spec: '%s'\n", cardFile->path );
173 fprintf( stream, " ret val: %d\n", cardFile->retVal );
174 addrcache_print( cardFile->addressCache, stream );
175 addritem_print_item_folder( cardFile->addressCache->rootFolder, stream );
179 * Open file for read.
180 * return: TRUE if file opened successfully.
182 static gint vcard_open_file( VCardFile* cardFile ) {
183 g_return_val_if_fail( cardFile != NULL, -1 );
185 /* fprintf( stdout, "Opening file\n" ); */
186 cardFile->addressCache->dataRead = FALSE;
187 if( cardFile->path ) {
188 cardFile->file = fopen( cardFile->path, "r" );
189 if( ! cardFile->file ) {
190 /* fprintf( stderr, "can't open %s\n", cardFile->path ); */
191 cardFile->retVal = MGU_OPEN_FILE;
192 return cardFile->retVal;
196 /* fprintf( stderr, "file not specified\n" ); */
197 cardFile->retVal = MGU_NO_FILE;
198 return cardFile->retVal;
201 /* Setup a buffer area */
202 cardFile->buffer[0] = '\0';
203 cardFile->bufptr = cardFile->buffer;
204 cardFile->retVal = MGU_SUCCESS;
205 return cardFile->retVal;
211 static void vcard_close_file( VCardFile *cardFile ) {
212 g_return_if_fail( cardFile != NULL );
213 if( cardFile->file ) fclose( cardFile->file );
214 cardFile->file = NULL;
218 * Read line of text from file.
219 * Return: ptr to buffer where line starts.
221 static gchar *vcard_read_line( VCardFile *cardFile ) {
222 while( *cardFile->bufptr == '\n' || *cardFile->bufptr == '\0' ) {
223 if( fgets( cardFile->buffer, VCARDBUFSIZE, cardFile->file ) == NULL )
225 g_strstrip( cardFile->buffer );
226 cardFile->bufptr = cardFile->buffer;
228 return cardFile->bufptr;
232 * Read line of text from file.
233 * Return: ptr to buffer where line starts.
235 static gchar *vcard_get_line( VCardFile *cardFile ) {
236 gchar buf[ VCARDBUFSIZE ];
240 if (vcard_read_line( cardFile ) == NULL ) {
245 /* Copy into private buffer */
246 start = cardFile->bufptr;
247 len = strlen( start );
249 strncpy( buf, start, len );
252 cardFile->bufptr = end + 1;
254 /* Return a copy of buffer */
255 return g_strdup( buf );
259 * Free linked lists of character strings.
261 static void vcard_free_lists( GSList *listName, GSList *listAddr, GSList *listRem, GSList* listID ) {
262 mgu_free_list( listName );
263 mgu_free_list( listAddr );
264 mgu_free_list( listRem );
265 mgu_free_list( listID );
269 * Read quoted-printable text, which may span several lines into one long string.
270 * Param: cardFile - object.
271 * Param: tagvalue - will be placed into the linked list.
273 static gchar *vcard_read_qp( VCardFile *cardFile, char *tagvalue ) {
274 GSList *listQP = NULL;
276 gchar *line = tagvalue;
278 listQP = g_slist_append( listQP, line );
279 len = strlen( line ) - 1;
281 if( line[ len ] != '=' ) break;
284 line = vcard_get_line( cardFile );
287 /* Coalesce linked list into one long buffer. */
288 line = mgu_list_coalesce( listQP );
291 mgu_free_list( listQP );
297 * Parse tag name from line buffer.
298 * Return: Buffer containing the tag name, or NULL if no delimiter char found.
300 static gchar *vcard_get_tagname( char* line, gchar dlm ) {
308 tag = g_strndup( line, len+1 );
318 * Parse tag value from line buffer.
319 * Return: Buffer containing the tag value. Empty string is returned if
320 * no delimiter char found.
322 static gchar *vcard_get_tagvalue( gchar* line, gchar dlm ) {
328 for( lptr = line; *lptr; lptr++ ) {
336 value = g_strndup( start, len+1 );
339 /* Ensure that we get an empty string */
340 value = g_strndup( "", 1 );
347 * Dump linked lists of character strings (for debug).
349 static void vcard_dump_lists( GSList *listName, GSList *listAddr, GSList *listRem, GSList *listID, FILE *stream ) {
350 fprintf( stream, "dump name\n" );
351 fprintf( stream, "------------\n" );
352 mgu_print_list( listName, stdout );
353 fprintf( stream, "dump address\n" );
354 fprintf( stream, "------------\n" );
355 mgu_print_list( listAddr, stdout );
356 fprintf( stream, "dump remarks\n" );
357 fprintf( stdout, "------------\n" );
358 mgu_print_list( listRem, stdout );
359 fprintf( stream, "dump id\n" );
360 fprintf( stdout, "------------\n" );
361 mgu_print_list( listID, stdout );
365 * Build an address list entry and append to list of address items.
367 static void vcard_build_items( VCardFile *cardFile, GSList *listName, GSList *listAddr, GSList *listRem,
370 GSList *nodeName = listName;
371 GSList *nodeID = listID;
374 GSList *nodeAddress = listAddr;
375 GSList *nodeRemarks = listRem;
376 ItemPerson *person = addritem_create_item_person();
377 addritem_person_set_common_name( person, nodeName->data );
378 while( nodeAddress ) {
379 str = nodeAddress->data;
381 ItemEMail *email = addritem_create_item_email();
382 addritem_email_set_address( email, str );
383 str = nodeRemarks->data;
386 if( g_strcasecmp( str, "internet" ) != 0 ) {
387 if( *str != '\0' ) addritem_email_set_remarks( email, str );
391 addrcache_id_email( cardFile->addressCache, email );
392 addrcache_person_add_email( cardFile->addressCache, person, email );
394 nodeAddress = g_slist_next( nodeAddress );
395 nodeRemarks = g_slist_next( nodeRemarks );
397 if( person->listEMail ) {
398 addrcache_id_person( cardFile->addressCache, person );
399 addrcache_add_person( cardFile->addressCache, person );
402 addritem_free_item_person( person );
406 addritem_person_set_external_id( person, str );
408 nodeName = g_slist_next( nodeName );
409 nodeID = g_slist_next( nodeID );
413 /* Unescape characters in quoted-printable string. */
414 static void vcard_unescape_qp( gchar *value ) {
415 gchar *ptr, *src, *dest;
426 if( ch > '0' && ch < '8' ) v = ch - '0';
431 if( ch > '\x60' ) ch -= '\x20';
432 if( ch > '0' && ch < ' ' ) d = ch - '0';
435 if( d > -1 && d < 16 ) {
442 /* Replace = with char and move down in buffer */
456 * Read file data into root folder.
457 * Note that one vCard can have multiple E-Mail addresses (MAIL tags);
458 * these are broken out into separate address items. An address item
459 * is generated for the person identified by FN tag and each EMAIL tag.
460 * If a sub-type is included in the EMAIL entry, this will be used as
461 * the Remarks member. Also note that it is possible for one vCard
462 * entry to have multiple FN tags; this might not make sense. However,
463 * it will generate duplicate address entries for each person listed.
465 static void vcard_read_file( VCardFile *cardFile ) {
466 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL;
467 GSList *listName = NULL, *listAddress = NULL, *listRemarks = NULL, *listID = NULL;
468 /* GSList *listQP = NULL; */
471 gchar *line = vcard_get_line( cardFile );
472 if( line == NULL ) break;
474 /* fprintf( stdout, "%s\n", line ); */
477 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
478 if( tagtemp == NULL ) {
483 /* fprintf( stdout, "\ttemp: %s\n", tagtemp ); */
484 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
485 if( tagvalue == NULL ) {
491 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
492 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
493 if( tagname == NULL ) {
498 /* fprintf( stdout, "\tname: %s\n", tagname ); */
499 /* fprintf( stdout, "\ttype: %s\n", tagtype ); */
500 /* fprintf( stdout, "\tvalue: %s\n", tagvalue ); */
502 if( g_strcasecmp( tagtype, VCARD_TYPE_QP ) == 0 ) {
503 /* Quoted-Printable: could span multiple lines */
504 tagvalue = vcard_read_qp( cardFile, tagvalue );
505 vcard_unescape_qp( tagvalue );
506 /* fprintf( stdout, "QUOTED-PRINTABLE !!! final\n>%s<\n", tagvalue ); */
509 if( g_strcasecmp( tagname, VCARD_TAG_START ) == 0 &&
510 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
511 /* fprintf( stdout, "start card\n" ); */
512 vcard_free_lists( listName, listAddress, listRemarks, listID );
513 listName = listAddress = listRemarks = listID = NULL;
515 if( g_strcasecmp( tagname, VCARD_TAG_FULLNAME ) == 0 ) {
516 /* fprintf( stdout, "- full name: %s\n", tagvalue ); */
517 listName = g_slist_append( listName, g_strdup( tagvalue ) );
519 if( g_strcasecmp( tagname, VCARD_TAG_EMAIL ) == 0 ) {
520 /* fprintf( stdout, "- address: %s\n", tagvalue ); */
521 listAddress = g_slist_append( listAddress, g_strdup( tagvalue ) );
522 listRemarks = g_slist_append( listRemarks, g_strdup( tagtype ) );
524 if( g_strcasecmp( tagname, VCARD_TAG_UID ) == 0 ) {
525 /* fprintf( stdout, "- id: %s\n", tagvalue ); */
526 listID = g_slist_append( listID, g_strdup( tagvalue ) );
528 if( g_strcasecmp( tagname, VCARD_TAG_END ) == 0 &&
529 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
530 /* vCard is complete */
531 /* fprintf( stdout, "end card\n--\n" ); */
532 /* vcard_dump_lists( listName, listAddress, listRemarks, listID, stdout ); */
533 vcard_build_items( cardFile, listName, listAddress, listRemarks, listID );
534 vcard_free_lists( listName, listAddress, listRemarks, listID );
535 listName = listAddress = listRemarks = listID = NULL;
547 vcard_free_lists( listName, listAddress, listRemarks, listID );
548 listName = listAddress = listRemarks = listID = NULL;
551 /* ============================================================================================ */
553 * Read file into list. Main entry point
554 * Return: TRUE if file read successfully.
556 /* ============================================================================================ */
557 gint vcard_read_data( VCardFile *cardFile ) {
558 g_return_val_if_fail( cardFile != NULL, -1 );
560 cardFile->retVal = MGU_SUCCESS;
561 cardFile->accessFlag = FALSE;
562 if( addrcache_check_file( cardFile->addressCache, cardFile->path ) ) {
563 addrcache_clear( cardFile->addressCache );
564 vcard_open_file( cardFile );
565 if( cardFile->retVal == MGU_SUCCESS ) {
566 /* Read data into the list */
567 vcard_read_file( cardFile );
568 vcard_close_file( cardFile );
571 addrcache_mark_file( cardFile->addressCache, cardFile->path );
572 cardFile->addressCache->modified = FALSE;
573 cardFile->addressCache->dataRead = TRUE;
576 return cardFile->retVal;
580 * Return link list of persons.
582 GList *vcard_get_list_person( VCardFile *cardFile ) {
583 g_return_val_if_fail( cardFile != NULL, NULL );
584 return addrcache_get_list_person( cardFile->addressCache );
588 * Return link list of folders. This is always NULL since there are
589 * no folders in GnomeCard.
592 GList *vcard_get_list_folder( VCardFile *cardFile ) {
593 g_return_val_if_fail( cardFile != NULL, NULL );
598 * Return link list of all persons. Note that the list contains references
599 * to items. Do *NOT* attempt to use the addrbook_free_xxx() functions...
600 * this will destroy the addressbook data!
601 * Return: List of items, or NULL if none.
603 GList *vcard_get_all_persons( VCardFile *cardFile ) {
604 g_return_val_if_fail( cardFile != NULL, NULL );
605 return addrcache_get_all_persons( cardFile->addressCache );
609 * Validate that all parameters specified.
610 * Return: TRUE if data is good.
612 gboolean vcard_validate( const VCardFile *cardFile ) {
616 g_return_val_if_fail( cardFile != NULL, FALSE );
619 if( cardFile->path ) {
620 if( strlen( cardFile->path ) < 1 ) retVal = FALSE;
625 name = addrcache_get_name( cardFile->addressCache );
627 if( strlen( name ) < 1 ) retVal = FALSE;
635 #define WORK_BUFLEN 1024
638 * Attempt to find a valid GnomeCard file.
639 * Return: Filename, or home directory if not found. Filename should
640 * be g_free() when done.
642 gchar *vcard_find_gnomecard( void ) {
644 gchar buf[ WORK_BUFLEN ];
645 gchar str[ WORK_BUFLEN ];
650 homedir = g_get_home_dir();
651 if( ! homedir ) return NULL;
653 strcpy( str, homedir );
656 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
657 str[ len ] = G_DIR_SEPARATOR;
661 strcat( str, GNOMECARD_DIR );
662 strcat( str, G_DIR_SEPARATOR_S );
663 strcat( str, GNOMECARD_FILE );
666 if( ( fp = fopen( str, "r" ) ) != NULL ) {
667 /* Read configuration file */
668 lenlbl = strlen( GNOMECARD_SECTION );
669 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
670 if( 0 == g_strncasecmp( buf, GNOMECARD_SECTION, lenlbl ) ) {
675 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
677 if( buf[0] == '[' ) break;
678 for( i = 0; i < lenlbl; i++ ) {
679 if( buf[i] == '=' ) {
680 if( 0 == g_strncasecmp( buf, GNOMECARD_PARAM, i ) ) {
681 fileSpec = g_strdup( buf + i + 1 );
682 g_strstrip( fileSpec );
690 if( fileSpec == NULL ) {
691 /* Use the home directory */
693 fileSpec = g_strdup( str );
700 * Attempt to read file, testing for valid vCard format.
701 * Return: TRUE if file appears to be valid format.
703 gint vcard_test_read_file( const gchar *fileSpec ) {
705 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL, *line;
709 if( ! fileSpec ) return MGU_NO_FILE;
711 cardFile = vcard_create_path( fileSpec );
712 cardFile->retVal = MGU_SUCCESS;
713 vcard_open_file( cardFile );
714 if( cardFile->retVal == MGU_SUCCESS ) {
715 cardFile->retVal = MGU_BAD_FORMAT;
717 lines = VCARD_TEST_LINES;
720 if( ( line = vcard_get_line( cardFile ) ) == NULL ) break;
723 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
724 if( tagtemp == NULL ) {
729 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
730 if( tagvalue == NULL ) {
736 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
737 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
738 if( tagname == NULL ) {
743 if( g_strcasecmp( tagtype, VCARD_TYPE_QP ) == 0 ) {
744 /* Quoted-Printable: could span multiple lines */
745 tagvalue = vcard_read_qp( cardFile, tagvalue );
746 vcard_unescape_qp( tagvalue );
748 if( g_strcasecmp( tagname, VCARD_TAG_START ) == 0 &&
749 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
752 if( g_strcasecmp( tagname, VCARD_TAG_END ) == 0 &&
753 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
754 /* vCard is complete */
755 if( haveStart ) cardFile->retVal = MGU_SUCCESS;
764 vcard_close_file( cardFile );
766 retVal = cardFile->retVal;
767 vcard_free( cardFile );