2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001 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"
35 #define GNOMECARD_DIR ".gnome"
36 #define GNOMECARD_FILE "GnomeCard"
37 #define GNOMECARD_SECTION "[file]"
38 #define GNOMECARD_PARAM "open"
40 #define VCARD_TEST_LINES 200
43 * Create new cardfile object.
45 VCardFile *vcard_create() {
47 cardFile = g_new0( VCardFile, 1 );
48 cardFile->name = NULL;
49 cardFile->path = NULL;
50 cardFile->file = NULL;
51 cardFile->bufptr = cardFile->buffer;
52 cardFile->addressCache = addrcache_create();
53 cardFile->retVal = MGU_SUCCESS;
54 cardFile->accessFlag = FALSE;
61 void vcard_set_name( VCardFile* cardFile, const gchar *value ) {
62 g_return_if_fail( cardFile != NULL );
63 cardFile->name = mgu_replace_string( cardFile->name, value );
64 g_strstrip( cardFile->name );
66 void vcard_set_file( VCardFile* cardFile, const gchar *value ) {
67 g_return_if_fail( cardFile != NULL );
68 addrcache_refresh( cardFile->addressCache );
69 cardFile->path = mgu_replace_string( cardFile->path, value );
70 g_strstrip( cardFile->path );
72 void vcard_set_accessed( VCardFile *cardFile, const gboolean value ) {
73 g_return_if_fail( cardFile != NULL );
74 cardFile->accessFlag = value;
78 * Test whether file was modified since last access.
79 * Return: TRUE if file was modified.
81 gboolean vcard_get_modified( VCardFile *vcardFile ) {
82 g_return_val_if_fail( vcardFile != NULL, FALSE );
83 return addrcache_check_file( vcardFile->addressCache, vcardFile->path );
85 gboolean vcard_get_accessed( VCardFile *vcardFile ) {
86 g_return_val_if_fail( vcardFile != NULL, FALSE );
87 return addrcache_check_file( vcardFile->addressCache, vcardFile->path );
91 * Test whether file was read.
92 * Return: TRUE if file was read.
94 gboolean vcard_get_read_flag( VCardFile *vcardFile ) {
95 g_return_val_if_fail( vcardFile != NULL, FALSE );
96 return vcardFile->addressCache->dataRead;
100 * Return status code from last file operation.
101 * Return: Status code.
103 gint vcard_get_status( VCardFile *cardFile ) {
104 g_return_val_if_fail( cardFile != NULL, -1 );
105 return cardFile->retVal;
108 ItemFolder *vcard_get_root_folder( VCardFile *cardFile ) {
109 g_return_val_if_fail( cardFile != NULL, NULL );
110 return addrcache_get_root_folder( cardFile->addressCache );
112 gchar *vcard_get_name( VCardFile *cardFile ) {
113 g_return_val_if_fail( cardFile != NULL, NULL );
114 return cardFile->name;
118 * Refresh internal variables to force a file read.
120 void vcard_force_refresh( VCardFile *cardFile ) {
121 addrcache_refresh( cardFile->addressCache );
125 * Create new cardfile object for specified file.
127 VCardFile *vcard_create_path( const gchar *path ) {
129 cardFile = vcard_create();
130 vcard_set_file(cardFile, path);
135 * Free up cardfile object by releasing internal memory.
137 void vcard_free( VCardFile *cardFile ) {
138 g_return_if_fail( cardFile != NULL );
141 if( cardFile->file ) fclose( cardFile->file );
143 /* Free internal stuff */
144 g_free( cardFile->name );
145 g_free( cardFile->path );
148 addrcache_clear( cardFile->addressCache );
149 addrcache_free( cardFile->addressCache );
152 cardFile->file = NULL;
153 cardFile->name = NULL;
154 cardFile->path = NULL;
155 cardFile->addressCache = NULL;
156 cardFile->retVal = MGU_SUCCESS;
157 cardFile->accessFlag = FALSE;
159 /* Now release file object */
165 * Display object to specified stream.
167 void vcard_print_file( VCardFile *cardFile, FILE *stream ) {
168 g_return_if_fail( cardFile != NULL );
170 fprintf( stream, "VCardFile:\n" );
171 fprintf( stream, " name: '%s'\n", cardFile->name );
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 ) {
307 tag = g_strndup( line, len+1 );
317 * Parse tag value from line buffer.
318 * Return: Buffer containing the tag value. Empty string is returned if
319 * no delimiter char found.
321 static gchar *vcard_get_tagvalue( gchar* line, gchar dlm ) {
327 for( lptr = line; *lptr; lptr++ ) {
335 value = g_strndup( start, len+1 );
338 /* Ensure that we get an empty string */
339 value = g_strndup( "", 1 );
346 * Dump linked lists of character strings (for debug).
348 static void vcard_dump_lists( GSList *listName, GSList *listAddr, GSList *listRem, GSList *listID, FILE *stream ) {
349 fprintf( stream, "dump name\n" );
350 fprintf( stream, "------------\n" );
351 mgu_print_list( listName, stdout );
352 fprintf( stream, "dump address\n" );
353 fprintf( stream, "------------\n" );
354 mgu_print_list( listAddr, stdout );
355 fprintf( stream, "dump remarks\n" );
356 fprintf( stdout, "------------\n" );
357 mgu_print_list( listRem, stdout );
358 fprintf( stream, "dump id\n" );
359 fprintf( stdout, "------------\n" );
360 mgu_print_list( listID, stdout );
364 * Build an address list entry and append to list of address items.
366 static void vcard_build_items( VCardFile *cardFile, GSList *listName, GSList *listAddr, GSList *listRem,
369 GSList *nodeName = listName;
370 GSList *nodeID = listID;
373 GSList *nodeAddress = listAddr;
374 GSList *nodeRemarks = listRem;
375 ItemPerson *person = addritem_create_item_person();
376 addritem_person_set_common_name( person, nodeName->data );
377 while( nodeAddress ) {
378 str = nodeAddress->data;
380 ItemEMail *email = addritem_create_item_email();
381 addritem_email_set_address( email, str );
382 str = nodeRemarks->data;
385 if( g_strcasecmp( str, "internet" ) != 0 ) {
386 if( *str != '\0' ) addritem_email_set_remarks( email, str );
390 addrcache_id_email( cardFile->addressCache, email );
391 addrcache_person_add_email( cardFile->addressCache, person, email );
393 nodeAddress = g_slist_next( nodeAddress );
394 nodeRemarks = g_slist_next( nodeRemarks );
396 if( person->listEMail ) {
397 addrcache_id_person( cardFile->addressCache, person );
398 addrcache_add_person( cardFile->addressCache, person );
401 addritem_free_item_person( person );
405 addritem_person_set_external_id( person, str );
407 nodeName = g_slist_next( nodeName );
408 nodeID = g_slist_next( nodeID );
412 /* Unescape characters in quoted-printable string. */
413 static void vcard_unescape_qp( gchar *value ) {
414 gchar *ptr, *src, *dest;
425 if( ch > '0' && ch < '8' ) v = ch - '0';
430 if( ch > '\x60' ) ch -= '\x20';
431 if( ch > '0' && ch < ' ' ) d = ch - '0';
434 if( d > -1 && d < 16 ) {
441 /* Replace = with char and move down in buffer */
455 * Read file data into root folder.
456 * Note that one vCard can have multiple E-Mail addresses (MAIL tags);
457 * these are broken out into separate address items. An address item
458 * is generated for the person identified by FN tag and each EMAIL tag.
459 * If a sub-type is included in the EMAIL entry, this will be used as
460 * the Remarks member. Also note that it is possible for one vCard
461 * entry to have multiple FN tags; this might not make sense. However,
462 * it will generate duplicate address entries for each person listed.
464 static void vcard_read_file( VCardFile *cardFile ) {
465 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL;
466 GSList *listName = NULL, *listAddress = NULL, *listRemarks = NULL, *listID = NULL;
467 /* GSList *listQP = NULL; */
470 gchar *line = vcard_get_line( cardFile );
471 if( line == NULL ) break;
473 /* fprintf( stdout, "%s\n", line ); */
476 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
478 /* fprintf( stdout, "\ttemp: %s\n", tagtemp ); */
479 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
480 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
481 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
482 if( tagname == NULL ) {
487 /* fprintf( stdout, "\tname: %s\n", tagname ); */
488 /* fprintf( stdout, "\ttype: %s\n", tagtype ); */
489 /* fprintf( stdout, "\tvalue: %s\n", tagvalue ); */
492 if( g_strcasecmp( tagtype, VCARD_TYPE_QP ) == 0 ) {
493 /* Quoted-Printable: could span multiple lines */
494 tagvalue = vcard_read_qp( cardFile, tagvalue );
495 vcard_unescape_qp( tagvalue );
496 /* fprintf( stdout, "QUOTED-PRINTABLE !!! final\n>%s<\n", tagvalue ); */
499 if( g_strcasecmp( tagname, VCARD_TAG_START ) == 0 &&
500 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
501 /* fprintf( stdout, "start card\n" ); */
502 vcard_free_lists( listName, listAddress, listRemarks, listID );
503 listName = listAddress = listRemarks = listID = NULL;
505 if( g_strcasecmp( tagname, VCARD_TAG_FULLNAME ) == 0 ) {
506 /* fprintf( stdout, "- full name: %s\n", tagvalue ); */
507 listName = g_slist_append( listName, g_strdup( tagvalue ) );
509 if( g_strcasecmp( tagname, VCARD_TAG_EMAIL ) == 0 ) {
510 /* fprintf( stdout, "- address: %s\n", tagvalue ); */
511 listAddress = g_slist_append( listAddress, g_strdup( tagvalue ) );
512 listRemarks = g_slist_append( listRemarks, g_strdup( tagtype ) );
514 if( g_strcasecmp( tagname, VCARD_TAG_UID ) == 0 ) {
515 /* fprintf( stdout, "- id: %s\n", tagvalue ); */
516 listID = g_slist_append( listID, g_strdup( tagvalue ) );
518 if( g_strcasecmp( tagname, VCARD_TAG_END ) == 0 &&
519 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
520 /* vCard is complete */
521 /* fprintf( stdout, "end card\n--\n" ); */
522 /* vcard_dump_lists( listName, listAddress, listRemarks, listID, stdout ); */
523 vcard_build_items( cardFile, listName, listAddress, listRemarks, listID );
524 vcard_free_lists( listName, listAddress, listRemarks, listID );
525 listName = listAddress = listRemarks = listID = NULL;
535 vcard_free_lists( listName, listAddress, listRemarks, listID );
536 listName = listAddress = listRemarks = listID = NULL;
539 /* ============================================================================================ */
541 * Read file into list. Main entry point
542 * Return: TRUE if file read successfully.
544 /* ============================================================================================ */
545 gint vcard_read_data( VCardFile *cardFile ) {
546 g_return_val_if_fail( cardFile != NULL, -1 );
548 cardFile->retVal = MGU_SUCCESS;
549 cardFile->accessFlag = FALSE;
550 if( addrcache_check_file( cardFile->addressCache, cardFile->path ) ) {
551 addrcache_clear( cardFile->addressCache );
552 vcard_open_file( cardFile );
553 if( cardFile->retVal == MGU_SUCCESS ) {
554 /* Read data into the list */
555 vcard_read_file( cardFile );
556 vcard_close_file( cardFile );
559 addrcache_mark_file( cardFile->addressCache, cardFile->path );
560 cardFile->addressCache->modified = FALSE;
561 cardFile->addressCache->dataRead = TRUE;
564 return cardFile->retVal;
568 * Return link list of persons.
570 GList *vcard_get_list_person( VCardFile *cardFile ) {
571 g_return_val_if_fail( cardFile != NULL, NULL );
572 return addrcache_get_list_person( cardFile->addressCache );
576 * Return link list of folders. This is always NULL since there are
577 * no folders in GnomeCard.
580 GList *vcard_get_list_folder( VCardFile *cardFile ) {
581 g_return_val_if_fail( cardFile != NULL, NULL );
586 * Return link list of all persons. Note that the list contains references
587 * to items. Do *NOT* attempt to use the addrbook_free_xxx() functions...
588 * this will destroy the addressbook data!
589 * Return: List of items, or NULL if none.
591 GList *vcard_get_all_persons( VCardFile *cardFile ) {
592 g_return_val_if_fail( cardFile != NULL, NULL );
593 return addrcache_get_all_persons( cardFile->addressCache );
597 * Validate that all parameters specified.
598 * Return: TRUE if data is good.
600 gboolean vcard_validate( const VCardFile *cardFile ) {
603 g_return_val_if_fail( cardFile != NULL, FALSE );
606 if( cardFile->path ) {
607 if( strlen( cardFile->path ) < 1 ) retVal = FALSE;
612 if( cardFile->name ) {
613 if( strlen( cardFile->name ) < 1 ) retVal = FALSE;
621 #define WORK_BUFLEN 1024
624 * Attempt to find a valid GnomeCard file.
625 * Return: Filename, or home directory if not found. Filename should
626 * be g_free() when done.
628 gchar *vcard_find_gnomecard( void ) {
630 gchar buf[ WORK_BUFLEN ];
631 gchar str[ WORK_BUFLEN ];
636 homedir = g_get_home_dir();
637 if( ! homedir ) return NULL;
639 strcpy( str, homedir );
642 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
643 str[ len ] = G_DIR_SEPARATOR;
647 strcat( str, GNOMECARD_DIR );
648 strcat( str, G_DIR_SEPARATOR_S );
649 strcat( str, GNOMECARD_FILE );
652 if( ( fp = fopen( str, "r" ) ) != NULL ) {
653 /* Read configuration file */
654 lenlbl = strlen( GNOMECARD_SECTION );
655 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
656 if( 0 == g_strncasecmp( buf, GNOMECARD_SECTION, lenlbl ) ) {
661 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
663 if( buf[0] == '[' ) break;
664 for( i = 0; i < lenlbl; i++ ) {
665 if( buf[i] == '=' ) {
666 if( 0 == g_strncasecmp( buf, GNOMECARD_PARAM, i ) ) {
667 fileSpec = g_strdup( buf + i + 1 );
668 g_strstrip( fileSpec );
676 if( fileSpec == NULL ) {
677 /* Use the home directory */
679 fileSpec = g_strdup( str );
686 * Attempt to read file, testing for valid vCard format.
687 * Return: TRUE if file appears to be valid format.
689 gint vcard_test_read_file( const gchar *fileSpec ) {
691 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL, *line;
695 if( ! fileSpec ) return MGU_NO_FILE;
697 cardFile = vcard_create_path( fileSpec );
698 cardFile->retVal = MGU_SUCCESS;
699 vcard_open_file( cardFile );
700 if( cardFile->retVal == MGU_SUCCESS ) {
701 cardFile->retVal = MGU_BAD_FORMAT;
703 lines = VCARD_TEST_LINES;
706 if( ( line = vcard_get_line( cardFile ) ) == NULL ) break;
709 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
711 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
712 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
713 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
714 if( tagname == NULL ) {
720 if( g_strcasecmp( tagtype, VCARD_TYPE_QP ) == 0 ) {
721 /* Quoted-Printable: could span multiple lines */
722 tagvalue = vcard_read_qp( cardFile, tagvalue );
723 vcard_unescape_qp( tagvalue );
725 if( g_strcasecmp( tagname, VCARD_TAG_START ) == 0 &&
726 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
729 if( g_strcasecmp( tagname, VCARD_TAG_END ) == 0 &&
730 g_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
731 /* vCard is complete */
732 if( haveStart ) cardFile->retVal = MGU_SUCCESS;
740 vcard_close_file( cardFile );
742 retVal = cardFile->retVal;
743 vcard_free( cardFile );