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"
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 * Display object to specified stream.
173 void vcard_print_file( VCardFile *cardFile, FILE *stream ) {
174 g_return_if_fail( cardFile != NULL );
176 fprintf( stream, "VCardFile:\n" );
177 fprintf( stream, "file spec: '%s'\n", cardFile->path );
178 fprintf( stream, " ret val: %d\n", cardFile->retVal );
179 addrcache_print( cardFile->addressCache, stream );
180 addritem_print_item_folder( cardFile->addressCache->rootFolder, stream );
184 * Open file for read.
185 * return: TRUE if file opened successfully.
187 static gint vcard_open_file( VCardFile* cardFile ) {
188 g_return_val_if_fail( cardFile != NULL, -1 );
190 /* fprintf( stdout, "Opening file\n" ); */
191 cardFile->addressCache->dataRead = FALSE;
192 if( cardFile->path ) {
193 cardFile->file = g_fopen( cardFile->path, "rb" );
194 if( ! cardFile->file ) {
195 /* fprintf( stderr, "can't open %s\n", cardFile->path ); */
196 cardFile->retVal = MGU_OPEN_FILE;
197 return cardFile->retVal;
201 /* fprintf( stderr, "file not specified\n" ); */
202 cardFile->retVal = MGU_NO_FILE;
203 return cardFile->retVal;
206 /* Setup a buffer area */
207 cardFile->buffer[0] = '\0';
208 cardFile->bufptr = cardFile->buffer;
209 cardFile->retVal = MGU_SUCCESS;
210 return cardFile->retVal;
216 static void vcard_close_file( VCardFile *cardFile ) {
217 g_return_if_fail( cardFile != NULL );
218 if( cardFile->file ) fclose( cardFile->file );
219 cardFile->file = NULL;
223 * Read line of text from file.
224 * Return: ptr to buffer where line starts.
226 static gchar *vcard_read_line( VCardFile *cardFile ) {
227 while( *cardFile->bufptr == '\n' || *cardFile->bufptr == '\0' ) {
228 if( fgets( cardFile->buffer, VCARDBUFSIZE, cardFile->file ) == NULL )
230 g_strstrip( cardFile->buffer );
231 cardFile->bufptr = cardFile->buffer;
233 return cardFile->bufptr;
237 * Read line of text from file.
238 * Return: ptr to buffer where line starts.
240 static gchar *vcard_get_line( VCardFile *cardFile ) {
241 gchar buf[ VCARDBUFSIZE ];
245 if (vcard_read_line( cardFile ) == NULL ) {
250 /* Copy into private buffer */
251 start = cardFile->bufptr;
252 len = strlen( start );
254 strncpy( buf, start, len );
257 cardFile->bufptr = end + 1;
259 /* Return a copy of buffer */
260 return g_strdup( buf );
264 * Free linked lists of character strings.
266 static void vcard_free_lists( GSList *listName, GSList *listAddr, GSList *listRem, GSList* listID ) {
267 mgu_free_list( listName );
268 mgu_free_list( listAddr );
269 mgu_free_list( listRem );
270 mgu_free_list( listID );
274 * Read quoted-printable text, which may span several lines into one long string.
275 * Param: cardFile - object.
276 * Param: tagvalue - will be placed into the linked list.
278 static gchar *vcard_read_qp( VCardFile *cardFile, char *tagvalue ) {
279 GSList *listQP = NULL;
281 gchar *line = tagvalue;
283 listQP = g_slist_append( listQP, line );
284 len = strlen( line ) - 1;
285 if( line[ len ] != '=' ) break;
287 line = vcard_get_line( cardFile );
290 /* Coalesce linked list into one long buffer. */
291 line = mgu_list_coalesce( listQP );
294 mgu_free_list( listQP );
300 * Parse tag name from line buffer.
301 * Return: Buffer containing the tag name, or NULL if no delimiter char found.
303 static gchar *vcard_get_tagname( char* line, gchar dlm ) {
311 tag = g_strndup( line, len+1 );
321 * Parse tag value from line buffer.
322 * Return: Buffer containing the tag value. Empty string is returned if
323 * no delimiter char found.
325 static gchar *vcard_get_tagvalue( gchar* line, gchar dlm ) {
331 for( lptr = line; *lptr; lptr++ ) {
339 value = g_strndup( start, len+1 );
342 /* Ensure that we get an empty string */
343 value = g_strndup( "", 1 );
350 * Build an address list entry and append to list of address items.
352 static void vcard_build_items(
353 VCardFile *cardFile, GSList *listName, GSList *listAddr,
354 GSList *listRem, GSList *listID )
356 GSList *nodeName = listName;
357 GSList *nodeID = listID;
360 GSList *nodeAddress = listAddr;
361 GSList *nodeRemarks = listRem;
362 ItemPerson *person = addritem_create_item_person();
363 addritem_person_set_common_name( person, nodeName->data );
364 while( nodeAddress ) {
365 str = nodeAddress->data;
367 ItemEMail *email = addritem_create_item_email();
368 addritem_email_set_address( email, str );
369 str = nodeRemarks->data;
372 if( g_utf8_collate( str, "internet" ) != 0 ) {
374 addritem_email_set_remarks( email, str );
378 addrcache_id_email( cardFile->addressCache, email );
379 addrcache_person_add_email( cardFile->addressCache, person, email );
381 nodeAddress = g_slist_next( nodeAddress );
382 nodeRemarks = g_slist_next( nodeRemarks );
384 if( person->listEMail ) {
385 addrcache_id_person( cardFile->addressCache, person );
386 addrcache_add_person( cardFile->addressCache, person );
389 addritem_person_set_external_id( person, str );
393 addritem_free_item_person( person );
395 nodeName = g_slist_next( nodeName );
396 nodeID = g_slist_next( nodeID );
400 /* Unescape characters in quoted-printable string. */
401 static void vcard_unescape_qp( gchar *value ) {
402 gchar *ptr, *src, *dest;
413 if( ch > '0' && ch < '8' ) v = ch - '0';
418 if( ch > '\x60' ) ch -= '\x20';
419 if( ch > '0' && ch < ' ' ) d = ch - '0';
422 if( d > -1 && d < 16 ) {
429 /* Replace = with char and move down in buffer */
443 * Read file data into root folder.
444 * Note that one vCard can have multiple E-Mail addresses (MAIL tags);
445 * these are broken out into separate address items. An address item
446 * is generated for the person identified by FN tag and each EMAIL tag.
447 * If a sub-type is included in the EMAIL entry, this will be used as
448 * the Remarks member. Also note that it is possible for one vCard
449 * entry to have multiple FN tags; this might not make sense. However,
450 * it will generate duplicate address entries for each person listed.
452 static void vcard_read_file( VCardFile *cardFile ) {
453 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL;
454 GSList *listName = NULL, *listAddress = NULL, *listRemarks = NULL, *listID = NULL;
455 /* GSList *listQP = NULL; */
458 gchar *line = vcard_get_line( cardFile );
459 if( line == NULL ) break;
461 /* fprintf( stdout, "%s\n", line ); */
464 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
465 if( tagtemp == NULL ) {
470 /* fprintf( stdout, "\ttemp: %s\n", tagtemp ); */
471 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
472 if( tagvalue == NULL ) {
478 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
479 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
480 if( tagname == NULL ) {
485 /* fprintf( stdout, "\tname: %s\n", tagname ); */
486 /* fprintf( stdout, "\ttype: %s\n", tagtype ); */
487 /* fprintf( stdout, "\tvalue: %s\n", tagvalue ); */
489 if( g_utf8_collate( tagtype, VCARD_TYPE_QP ) == 0 ) {
490 /* Quoted-Printable: could span multiple lines */
491 tagvalue = vcard_read_qp( cardFile, tagvalue );
492 vcard_unescape_qp( tagvalue );
493 /* fprintf( stdout, "QUOTED-PRINTABLE !!! final\n>%s<\n", tagvalue ); */
496 if( g_utf8_collate( tagname, VCARD_TAG_START ) == 0 &&
497 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
498 /* fprintf( stdout, "start card\n" ); */
499 vcard_free_lists( listName, listAddress, listRemarks, listID );
500 listName = listAddress = listRemarks = listID = NULL;
502 if( g_utf8_collate( tagname, VCARD_TAG_FULLNAME ) == 0 ) {
503 /* fprintf( stdout, "- full name: %s\n", tagvalue ); */
504 listName = g_slist_append( listName, g_strdup( tagvalue ) );
506 if( g_utf8_collate( tagname, VCARD_TAG_EMAIL ) == 0 ) {
507 /* fprintf( stdout, "- address: %s\n", tagvalue ); */
508 listAddress = g_slist_append( listAddress, g_strdup( tagvalue ) );
509 listRemarks = g_slist_append( listRemarks, g_strdup( tagtype ) );
511 if( g_utf8_collate( tagname, VCARD_TAG_UID ) == 0 ) {
512 /* fprintf( stdout, "- id: %s\n", tagvalue ); */
513 listID = g_slist_append( listID, g_strdup( tagvalue ) );
515 if( g_utf8_collate( tagname, VCARD_TAG_END ) == 0 &&
516 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
517 /* vCard is complete */
518 /* fprintf( stdout, "end card\n--\n" ); */
519 /* vcard_dump_lists( listName, listAddress, listRemarks, listID, stdout ); */
520 vcard_build_items( cardFile, listName, listAddress, listRemarks, listID );
521 vcard_free_lists( listName, listAddress, listRemarks, listID );
522 listName = listAddress = listRemarks = listID = NULL;
534 vcard_free_lists( listName, listAddress, listRemarks, listID );
535 listName = listAddress = listRemarks = listID = NULL;
538 /* ============================================================================================ */
540 * Read file into list. Main entry point
541 * Return: TRUE if file read successfully.
543 /* ============================================================================================ */
544 gint vcard_read_data( VCardFile *cardFile ) {
545 g_return_val_if_fail( cardFile != NULL, -1 );
547 cardFile->retVal = MGU_SUCCESS;
548 cardFile->addressCache->accessFlag = FALSE;
549 if( addrcache_check_file( cardFile->addressCache, cardFile->path ) ) {
550 addrcache_clear( cardFile->addressCache );
551 vcard_open_file( cardFile );
552 if( cardFile->retVal == MGU_SUCCESS ) {
553 /* Read data into the list */
554 vcard_read_file( cardFile );
555 vcard_close_file( cardFile );
558 addrcache_mark_file( cardFile->addressCache, cardFile->path );
559 cardFile->addressCache->modified = FALSE;
560 cardFile->addressCache->dataRead = TRUE;
563 return cardFile->retVal;
567 * Return link list of persons.
569 GList *vcard_get_list_person( VCardFile *cardFile ) {
570 g_return_val_if_fail( cardFile != NULL, NULL );
571 return addrcache_get_list_person( cardFile->addressCache );
575 * Return link list of folders. This is always NULL since there are
576 * no folders in GnomeCard.
579 GList *vcard_get_list_folder( VCardFile *cardFile ) {
580 g_return_val_if_fail( cardFile != NULL, NULL );
585 * Return link list of all persons. Note that the list contains references
586 * to items. Do *NOT* attempt to use the addrbook_free_xxx() functions...
587 * this will destroy the addressbook data!
588 * Return: List of items, or NULL if none.
590 GList *vcard_get_all_persons( VCardFile *cardFile ) {
591 g_return_val_if_fail( cardFile != NULL, NULL );
592 return addrcache_get_all_persons( cardFile->addressCache );
596 * Validate that all parameters specified.
597 * Return: TRUE if data is good.
599 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 name = addrcache_get_name( cardFile->addressCache );
614 if( strlen( name ) < 1 ) retVal = FALSE;
622 #define WORK_BUFLEN 1024
625 * Attempt to find a valid GnomeCard file.
626 * Return: Filename, or home directory if not found. Filename should
627 * be g_free() when done.
629 gchar *vcard_find_gnomecard( void ) {
630 const gchar *homedir;
631 gchar buf[ WORK_BUFLEN ];
632 gchar str[ WORK_BUFLEN ];
637 homedir = get_home_dir();
638 if( ! homedir ) return NULL;
640 strcpy( str, homedir );
643 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
644 str[ len ] = G_DIR_SEPARATOR;
648 strcat( str, GNOMECARD_DIR );
649 strcat( str, G_DIR_SEPARATOR_S );
650 strcat( str, GNOMECARD_FILE );
653 if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
654 /* Read configuration file */
655 lenlbl = strlen( GNOMECARD_SECTION );
656 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
657 if( 0 == g_ascii_strncasecmp( buf, GNOMECARD_SECTION, lenlbl ) ) {
662 while( fgets( buf, sizeof( buf ), fp ) != NULL ) {
664 if( buf[0] == '[' ) break;
665 for( i = 0; i < lenlbl; i++ ) {
666 if( buf[i] == '=' ) {
667 if( 0 == g_ascii_strncasecmp( buf, GNOMECARD_PARAM, i ) ) {
668 fileSpec = g_strdup( buf + i + 1 );
669 g_strstrip( fileSpec );
677 if( fileSpec == NULL ) {
678 /* Use the home directory */
680 fileSpec = g_strdup( str );
687 * Attempt to read file, testing for valid vCard format.
688 * Return: TRUE if file appears to be valid format.
690 gint vcard_test_read_file( const gchar *fileSpec ) {
692 gchar *tagtemp = NULL, *tagname = NULL, *tagvalue = NULL, *tagtype = NULL, *line;
696 if( ! fileSpec ) return MGU_NO_FILE;
698 cardFile = vcard_create_path( fileSpec );
699 cardFile->retVal = MGU_SUCCESS;
700 vcard_open_file( cardFile );
701 if( cardFile->retVal == MGU_SUCCESS ) {
702 cardFile->retVal = MGU_BAD_FORMAT;
704 lines = VCARD_TEST_LINES;
707 if( ( line = vcard_get_line( cardFile ) ) == NULL ) break;
710 tagtemp = vcard_get_tagname( line, VCARD_SEP_TAG );
711 if( tagtemp == NULL ) {
716 tagvalue = vcard_get_tagvalue( line, VCARD_SEP_TAG );
717 if( tagvalue == NULL ) {
723 tagname = vcard_get_tagname( tagtemp, VCARD_SEP_TYPE );
724 tagtype = vcard_get_tagvalue( tagtemp, VCARD_SEP_TYPE );
725 if( tagname == NULL ) {
730 if( g_utf8_collate( tagtype, VCARD_TYPE_QP ) == 0 ) {
731 /* Quoted-Printable: could span multiple lines */
732 tagvalue = vcard_read_qp( cardFile, tagvalue );
733 vcard_unescape_qp( tagvalue );
735 if( g_utf8_collate( tagname, VCARD_TAG_START ) == 0 &&
736 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
739 if( g_utf8_collate( tagname, VCARD_TAG_END ) == 0 &&
740 g_ascii_strcasecmp( tagvalue, VCARD_NAME ) == 0 ) {
741 /* vCard is complete */
742 if( haveStart ) cardFile->retVal = MGU_SUCCESS;
751 vcard_close_file( cardFile );
753 retVal = cardFile->retVal;
754 vcard_free( cardFile );