2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2012 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 JPilot database files.
22 * JPilot is Copyright(c) by Judd Montgomery.
23 * Visit http://www.jpilot.org for more details.
28 #include "claws-features.h"
39 #include <netinet/in.h>
41 #ifdef HAVE_LIBPISOCK_PI_ARGS_H
42 # include <libpisock/pi-args.h>
43 # include <libpisock/pi-appinfo.h>
44 # include <libpisock/pi-address.h>
45 # include <libpisock/pi-version.h>
48 # include <pi-appinfo.h>
49 # include <pi-address.h>
50 # include <pi-version.h>
55 #include "addrcache.h"
58 #include "adbookbase.h"
61 #define JPILOT_DBHOME_DIR ".jpilot"
62 #define JPILOT_DBHOME_FILE "AddressDB.pdb"
63 #define PILOT_LINK_LIB_NAME "libpisock.so"
65 #define IND_LABEL_LASTNAME 0 /* Index of last name in address data */
66 #define IND_LABEL_FIRSTNAME 1 /* Index of first name in address data */
67 #define IND_PHONE_EMAIL 4 /* Index of E-Mail address in phone labels */
68 #define OFFSET_PHONE_LABEL 3 /* Offset to phone data in address data */
69 #define IND_CUSTOM_LABEL 14 /* Offset to custom label names */
70 #define NUM_CUSTOM_LABEL 4 /* Number of custom labels */
72 /* Shamelessly copied from JPilot (libplugin.h) */
74 unsigned char db_name[32];
75 unsigned char flags[2];
76 unsigned char version[2];
77 unsigned char creation_time[4];
78 unsigned char modification_time[4];
79 unsigned char backup_time[4];
80 unsigned char modification_number[4];
81 unsigned char app_info_offset[4];
82 unsigned char sort_info_offset[4];
83 unsigned char type[4];/*Database ID */
84 unsigned char creator_id[4];/*Application ID */
85 unsigned char unique_id_seed[4];
86 unsigned char next_record_list_id[4];
87 unsigned char number_of_records[2];
90 /* Shamelessly copied from JPilot (libplugin.h) */
96 time_t modification_time;
98 unsigned int modification_number;
99 unsigned int app_info_offset;
100 unsigned int sort_info_offset;
101 char type[5];/*Database ID */
102 char creator_id[5];/*Application ID */
103 char unique_id_seed[5];
104 unsigned int next_record_list_id;
105 unsigned int number_of_records;
108 /* Shamelessly copied from JPilot (libplugin.h) */
110 unsigned char Offset[4]; /*4 bytes offset from BOF to record */
111 unsigned char attrib;
112 unsigned char unique_ID[3];
115 /* Shamelessly copied from JPilot (libplugin.h) */
116 typedef struct mem_rec_header_s {
117 unsigned int rec_num;
119 unsigned int unique_id;
120 unsigned char attrib;
121 struct mem_rec_header_s *next;
124 /* Shamelessly copied from JPilot (libplugin.h) */
125 #define SPENT_PC_RECORD_BIT 256
129 MODIFIED_PALM_REC = 101L,
130 DELETED_PALM_REC = 102L,
132 DELETED_PC_REC = SPENT_PC_RECORD_BIT + 104L,
133 DELETED_DELETED_PALM_REC = SPENT_PC_RECORD_BIT + 105L
136 /* Shamelessly copied from JPilot (libplugin.h) */
139 unsigned int unique_id;
140 unsigned char attrib;
145 /* Shamelessly copied from JPilot (libplugin.h) */
147 unsigned long header_len;
148 unsigned long header_version;
149 unsigned long rec_len;
150 unsigned long unique_id;
151 unsigned long rt; /* Record Type */
152 unsigned char attrib;
160 gboolean convert_charcode = TRUE;
162 static const gchar *jpilot_get_charset(void)
164 static const gchar *charset = NULL;
167 charset = getenv("PILOT_CHARSET");
176 * Create new pilot file object.
177 * \return Initialized JPilot file object.
179 JPilotFile *jpilot_create() {
180 JPilotFile *pilotFile;
181 pilotFile = g_new0( JPilotFile, 1 );
182 pilotFile->type = ADBOOKTYPE_JPILOT;
183 pilotFile->addressCache = addrcache_create();
184 pilotFile->retVal = MGU_SUCCESS;
186 pilotFile->file = NULL;
187 pilotFile->path = NULL;
188 pilotFile->readMetadata = FALSE;
189 pilotFile->customLabels = NULL;
190 pilotFile->labelInd = NULL;
191 pilotFile->havePC3 = FALSE;
192 pilotFile->pc3ModifyTime = 0;
197 * Create new pilot file object for specified file.
198 * \param path Path to JPilot address book.
199 * \return Initialized JPilot file object.
201 JPilotFile *jpilot_create_path( const gchar *path ) {
202 JPilotFile *pilotFile;
203 pilotFile = jpilot_create();
204 jpilot_set_file( pilotFile, path );
211 void jpilot_set_name( JPilotFile* pilotFile, const gchar *value ) {
212 cm_return_if_fail( pilotFile != NULL );
213 addrcache_set_name( pilotFile->addressCache, value );
215 void jpilot_set_file( JPilotFile* pilotFile, const gchar *value ) {
216 cm_return_if_fail( pilotFile != NULL );
217 addrcache_refresh( pilotFile->addressCache );
218 pilotFile->readMetadata = FALSE;
219 pilotFile->path = mgu_replace_string( pilotFile->path, value );
221 void jpilot_set_accessed( JPilotFile *pilotFile, const gboolean value ) {
222 cm_return_if_fail( pilotFile != NULL );
223 pilotFile->addressCache->accessFlag = value;
226 gint jpilot_get_status( JPilotFile *pilotFile ) {
227 cm_return_val_if_fail( pilotFile != NULL, -1 );
228 return pilotFile->retVal;
230 ItemFolder *jpilot_get_root_folder( JPilotFile *pilotFile ) {
231 cm_return_val_if_fail( pilotFile != NULL, NULL );
232 return addrcache_get_root_folder( pilotFile->addressCache );
234 gchar *jpilot_get_name( JPilotFile *pilotFile ) {
235 cm_return_val_if_fail( pilotFile != NULL, NULL );
236 return addrcache_get_name( pilotFile->addressCache );
240 * Test whether file was read.
241 * \param pilotFile JPilot control data.
242 * \return <i>TRUE</i> if file was read.
244 gboolean jpilot_get_read_flag( JPilotFile *pilotFile ) {
245 cm_return_val_if_fail( pilotFile != NULL, FALSE );
246 return pilotFile->addressCache->dataRead;
250 * Free up custom label list.
251 * \param pilotFile JPilot control data.
253 void jpilot_clear_custom_labels( JPilotFile *pilotFile ) {
256 cm_return_if_fail( pilotFile != NULL );
258 /* Release custom labels */
259 mgu_free_dlist( pilotFile->customLabels );
260 pilotFile->customLabels = NULL;
262 /* Release indexes */
263 node = pilotFile->labelInd;
266 node = g_list_next( node );
268 g_list_free( pilotFile->labelInd );
269 pilotFile->labelInd = NULL;
271 /* Force a fresh read */
272 addrcache_refresh( pilotFile->addressCache );
276 * Append a custom label, representing an E-Mail address field to the
278 * \param pilotFile JPilot control data.
280 void jpilot_add_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
281 cm_return_if_fail( pilotFile != NULL );
284 gchar *labelCopy = g_strdup( labelName );
285 g_strstrip( labelCopy );
286 if( *labelCopy == '\0' ) {
290 pilotFile->customLabels = g_list_append( pilotFile->customLabels, labelCopy );
291 /* Force a fresh read */
292 addrcache_refresh( pilotFile->addressCache );
298 * Get list of custom labels.
299 * \param pilotFile JPilot control data.
300 * \return List of labels. Must use g_free() when done.
302 GList *jpilot_get_custom_labels( JPilotFile *pilotFile ) {
303 GList *retVal = NULL;
306 cm_return_val_if_fail( pilotFile != NULL, NULL );
308 node = pilotFile->customLabels;
310 retVal = g_list_append( retVal, g_strdup( node->data ) );
311 node = g_list_next( node );
317 * Return filespec of PC3 file corresponding to JPilot PDB file.
318 * \param pilotFile JPilot control data.
319 * \return File specification; should be g_free() when done.
321 static gchar *jpilot_get_pc3_file( JPilotFile *pilotFile ) {
325 if( pilotFile == NULL ) return NULL;
326 if( pilotFile->path == NULL ) return NULL;
328 fileSpec = g_strdup( pilotFile->path );
329 len = strlen( fileSpec );
332 for( i = len; i > 0; i-- ) {
333 if( *(fileSpec + i) == '.' ) {
340 if( len - pos == 3 ) {
341 *r++ = 'p'; *r++ = 'c'; *r = '3';
350 * Save PC3 file time to cache.
351 * \param pilotFile JPilot control data.
352 * \return <i>TRUE</i> if time marked.
354 static gboolean jpilot_mark_files( JPilotFile *pilotFile ) {
355 gboolean retVal = FALSE;
359 /* Mark PDB file cache */
360 retVal = addrcache_mark_file( pilotFile->addressCache, pilotFile->path );
362 /* Now mark PC3 file */
363 pilotFile->havePC3 = FALSE;
364 pilotFile->pc3ModifyTime = 0;
365 pcFile = jpilot_get_pc3_file( pilotFile );
366 if( pcFile == NULL ) return retVal;
367 if( 0 == g_stat( pcFile, &filestat ) ) {
368 pilotFile->havePC3 = TRUE;
369 pilotFile->pc3ModifyTime = filestat.st_mtime;
377 * Check whether JPilot PDB or PC3 file has changed by comparing
379 * \param pilotFile JPilot control data.
380 * \return <i>TRUE</i> if file has changed.
382 static gboolean jpilot_check_files( JPilotFile *pilotFile ) {
383 gboolean retVal = TRUE;
387 /* Check main file */
388 if( addrcache_check_file( pilotFile->addressCache, pilotFile->path ) )
392 if( ! pilotFile->havePC3 ) return FALSE;
393 pcFile = jpilot_get_pc3_file( pilotFile );
394 if( pcFile == NULL ) return FALSE;
396 if( 0 == g_stat( pcFile, &filestat ) ) {
397 if( filestat.st_mtime == pilotFile->pc3ModifyTime ) retVal = FALSE;
404 * Test whether file was modified since last access.
405 * Return: TRUE if file was modified.
407 gboolean jpilot_get_modified( JPilotFile *pilotFile ) {
408 cm_return_val_if_fail( pilotFile != NULL, FALSE );
409 pilotFile->addressCache->modified = jpilot_check_files( pilotFile );
410 return pilotFile->addressCache->modified;
412 gboolean jpilot_get_accessed( JPilotFile *pilotFile ) {
413 cm_return_val_if_fail( pilotFile != NULL, FALSE );
414 return pilotFile->addressCache->accessFlag;
418 * Free up pilot file object by releasing internal memory.
419 * \param pilotFile JPilot control data.
421 void jpilot_free( JPilotFile *pilotFile ) {
422 cm_return_if_fail( pilotFile != NULL );
424 /* Release custom labels */
425 jpilot_clear_custom_labels( pilotFile );
428 addrcache_clear( pilotFile->addressCache );
429 addrcache_free( pilotFile->addressCache );
431 /* Free internal stuff */
432 g_free( pilotFile->path );
434 pilotFile->file = NULL;
435 pilotFile->path = NULL;
436 pilotFile->readMetadata = FALSE;
437 pilotFile->havePC3 = FALSE;
438 pilotFile->pc3ModifyTime = 0;
440 pilotFile->type = ADBOOKTYPE_NONE;
441 pilotFile->addressCache = NULL;
442 pilotFile->retVal = MGU_SUCCESS;
444 /* Now release file object */
448 /* Shamelessly copied from JPilot (libplugin.c) */
449 static unsigned int bytes_to_bin(unsigned char *bytes, unsigned int num_bytes) {
452 for (i=0;i<num_bytes;i++) {
458 /* Shamelessly copied from JPilot (utils.c) */
459 /* These next 2 functions were copied from pi-file.c in the pilot-link app */
460 /* Exact value of "Jan 1, 1970 0:00:00 GMT" - "Jan 1, 1904 0:00:00 GMT" */
461 #define PILOT_TIME_DELTA (unsigned)(2082844800)
463 static time_t pilot_time_to_unix_time ( unsigned long raw_time ) {
464 return (time_t)(raw_time - PILOT_TIME_DELTA);
467 /* Shamelessly copied from JPilot (libplugin.c) */
468 static int raw_header_to_header(RawDBHeader *rdbh, DBHeader *dbh) {
471 strncpy(dbh->db_name, rdbh->db_name, 31);
472 dbh->db_name[31] = '\0';
473 dbh->flags = bytes_to_bin(rdbh->flags, 2);
474 dbh->version = bytes_to_bin(rdbh->version, 2);
475 temp = bytes_to_bin(rdbh->creation_time, 4);
476 dbh->creation_time = pilot_time_to_unix_time(temp);
477 temp = bytes_to_bin(rdbh->modification_time, 4);
478 dbh->modification_time = pilot_time_to_unix_time(temp);
479 temp = bytes_to_bin(rdbh->backup_time, 4);
480 dbh->backup_time = pilot_time_to_unix_time(temp);
481 dbh->modification_number = bytes_to_bin(rdbh->modification_number, 4);
482 dbh->app_info_offset = bytes_to_bin(rdbh->app_info_offset, 4);
483 dbh->sort_info_offset = bytes_to_bin(rdbh->sort_info_offset, 4);
484 strncpy(dbh->type, rdbh->type, 4);
486 strncpy(dbh->creator_id, rdbh->creator_id, 4);
487 dbh->creator_id[4] = '\0';
488 strncpy(dbh->unique_id_seed, rdbh->unique_id_seed, 4);
489 dbh->unique_id_seed[4] = '\0';
490 dbh->next_record_list_id = bytes_to_bin(rdbh->next_record_list_id, 4);
491 dbh->number_of_records = bytes_to_bin(rdbh->number_of_records, 2);
495 /* Shamelessly copied from JPilot (libplugin.c) */
496 /* returns 1 if found */
498 static int find_next_offset( mem_rec_header *mem_rh, long fpos,
499 unsigned int *next_offset, unsigned char *attrib, unsigned int *unique_id )
501 mem_rec_header *temp_mem_rh;
502 unsigned char found = 0;
503 unsigned long found_at;
506 for (temp_mem_rh=mem_rh; temp_mem_rh; temp_mem_rh = temp_mem_rh->next) {
507 if ((temp_mem_rh->offset > fpos) && (temp_mem_rh->offset < found_at)) {
508 found_at = temp_mem_rh->offset;
509 /* *attrib = temp_mem_rh->attrib; */
510 /* *unique_id = temp_mem_rh->unique_id; */
512 if ((temp_mem_rh->offset == fpos)) {
514 *attrib = temp_mem_rh->attrib;
515 *unique_id = temp_mem_rh->unique_id;
518 *next_offset = found_at;
522 /* Shamelessly copied from JPilot (libplugin.c) */
523 static void free_mem_rec_header(mem_rec_header **mem_rh) {
524 mem_rec_header *h, *next_h;
525 for (h=*mem_rh; h; h=next_h) {
532 /* Shamelessly copied from JPilot (libplugin.c) */
534 static int jpilot_get_info_size( FILE *in, int *size ) {
541 fseek(in, 0, SEEK_SET);
542 r = fread(&rdbh, sizeof(RawDBHeader), 1, in);
544 return MGU_ERROR_READ;
549 raw_header_to_header(&rdbh, &dbh);
550 if (dbh.app_info_offset==0) {
554 if (dbh.sort_info_offset!=0) {
555 *size = dbh.sort_info_offset - dbh.app_info_offset;
558 if (dbh.number_of_records==0) {
559 fseek(in, 0, SEEK_END);
560 *size=ftell(in) - dbh.app_info_offset;
564 r = fread(&rh, sizeof(record_header), 1, in);
566 return MGU_ERROR_READ;
568 offset = ((rh.Offset[0]*256+rh.Offset[1])*256+rh.Offset[2])*256+rh.Offset[3];
569 *size=offset - dbh.app_info_offset;
575 * Read address file into address list. Based on JPilot's
576 * libplugin.c (jp_get_app_info)
578 static gint jpilot_get_file_info( JPilotFile *pilotFile, unsigned char **buf, int *buf_size ) {
581 unsigned int rec_size;
585 if( ( !buf_size ) || ( ! buf ) ) {
592 if( pilotFile->path ) {
593 in = g_fopen( pilotFile->path, "rb" );
595 return MGU_OPEN_FILE;
602 num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
606 return MGU_ERROR_READ;
614 /* Convert header into something recognizable */
615 raw_header_to_header(&rdbh, &dbh);
617 num = jpilot_get_info_size(in, &rec_size);
620 return MGU_ERROR_READ;
623 if (fseek(in, dbh.app_info_offset, SEEK_SET) < 0) {
625 return MGU_ERROR_READ;
627 *buf = ( char * ) malloc(rec_size);
630 return MGU_OO_MEMORY;
632 num = fread(*buf, rec_size, 1, in);
637 return MGU_ERROR_READ;
642 *buf_size = rec_size;
647 /* Shamelessly copied from JPilot (libplugin.c) */
648 static int unpack_header(PC3RecordHeader *header, unsigned char *packed_header) {
654 memcpy(&l, p, sizeof(l));
655 header->header_len=ntohl(l);
658 memcpy(&l, p, sizeof(l));
659 header->header_version=ntohl(l);
662 memcpy(&l, p, sizeof(l));
663 header->rec_len=ntohl(l);
666 memcpy(&l, p, sizeof(l));
667 header->unique_id=ntohl(l);
670 memcpy(&l, p, sizeof(l));
674 memcpy(&(header->attrib), p, sizeof(unsigned char));
675 p+=sizeof(unsigned char);
680 /* Shamelessly copied from JPilot (libplugin.c) */
681 static int read_header(FILE *pc_in, PC3RecordHeader *header) {
684 unsigned char packed_header[256];
687 memset(header, 0, sizeof(PC3RecordHeader));
689 num = fread(&l, sizeof(l), 1, pc_in);
696 memcpy(packed_header, &l, sizeof(l));
698 if (len > 255 || len < sizeof(l)) {
701 num = fread(packed_header+sizeof(l), len-sizeof(l), 1, pc_in);
708 unpack_header(header, packed_header);
713 * Read next record from PC3 file. Based on JPilot function
714 * <code>pc_read_next_rec()</code> (libplugin.c)
716 * \param in File handle.
717 * \param br Record buffer.
718 * \return Status/error code. <code>MGU_SUCCESS</code> if data read
721 static gint jpilot_read_next_pc( FILE *in, buf_rec *br ) {
722 PC3RecordHeader header;
729 num = read_header( in, &header );
732 return MGU_ERROR_READ;
733 else if( feof( in ) )
738 rec_len = header.rec_len;
739 record = malloc( rec_len );
741 return MGU_OO_MEMORY;
743 num = fread( record, rec_len, 1, in );
747 return MGU_ERROR_READ;
751 br->unique_id = header.unique_id;
752 br->attrib = header.attrib;
760 * Read address file into a linked list. Based on JPilot function
761 * <code>jp_read_DB_files()</code> (from libplugin.c)
763 * \param pilotFile JPilot control data.
764 * \param records Pointer to linked list of records read.
765 * \return Status/error code. <code>MGU_SUCCESS</code> if data read
768 static gint jpilot_read_db_files( JPilotFile *pilotFile, GList **records ) {
772 int num_records, recs_returned, i, num, r;
773 unsigned int offset, prev_offset, next_offset = 0, rec_size;
775 long fpos; /*file position indicator */
776 unsigned char attrib = '\0';
777 unsigned int unique_id = 0;
778 mem_rec_header *mem_rh, *temp_mem_rh, *last_mem_rh;
785 mem_rh = last_mem_rh = NULL;
789 if( pilotFile->path == NULL ) {
793 in = g_fopen( pilotFile->path, "rb" );
795 return MGU_OPEN_FILE;
798 /* Read the database header */
799 num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
803 return MGU_ERROR_READ;
810 raw_header_to_header( &rdbh, &dbh );
812 /* Read each record entry header */
813 num_records = dbh.number_of_records;
817 for( i = 1; i < num_records + 1; i++ ) {
818 num = fread( &rh, sizeof( record_header ), 1, in );
826 free_mem_rec_header( &mem_rh );
832 ( ( rh.Offset[0] * 256 + rh.Offset[1] ) * 256
833 + rh.Offset[2] ) * 256
835 if( offset < prev_offset ) {
838 prev_offset = offset;
839 temp_mem_rh = ( mem_rec_header * ) malloc( sizeof( mem_rec_header ) );
840 if( ! temp_mem_rh ) {
843 temp_mem_rh->next = NULL;
844 temp_mem_rh->rec_num = i;
845 temp_mem_rh->offset = offset;
846 temp_mem_rh->attrib = rh.attrib;
847 temp_mem_rh->unique_id =
848 ( rh.unique_ID[0] * 256 + rh.unique_ID[1] ) * 256
850 if( mem_rh == NULL ) {
851 mem_rh = temp_mem_rh;
852 last_mem_rh = temp_mem_rh;
855 last_mem_rh->next = temp_mem_rh;
856 last_mem_rh = temp_mem_rh;
860 temp_mem_rh = mem_rh;
865 mem_rh, 0, &next_offset, &attrib, &unique_id );
869 next_offset = mem_rh->offset;
870 attrib = mem_rh->attrib;
871 unique_id = mem_rh->unique_id;
874 if (fseek( in, next_offset, SEEK_SET ) < 0) {
876 return MGU_ERROR_READ;
878 while( ! feof( in ) ) {
882 mem_rh, fpos, &next_offset, &attrib,
885 next_offset = 0xFFFFFF;
887 attrib = temp_mem_rh->attrib;
888 unique_id = temp_mem_rh->unique_id;
889 if ( temp_mem_rh->next ) {
890 temp_mem_rh = temp_mem_rh->next;
891 next_offset = temp_mem_rh->offset;
895 rec_size = next_offset - fpos;
896 buf = malloc( rec_size );
898 num = fread( buf, rec_size, 1, in );
906 temp_br = malloc( sizeof( buf_rec ) );
911 temp_br->rt = PALM_REC;
912 temp_br->unique_id = unique_id;
913 temp_br->attrib = attrib;
915 temp_br->size = rec_size;
917 *records = g_list_append( *records, temp_br );
923 free_mem_rec_header( &mem_rh );
925 /* Read the PC3 file, if present */
926 pcFile = jpilot_get_pc3_file( pilotFile );
927 if( pcFile == NULL ) return MGU_SUCCESS;
928 pc_in = g_fopen( pcFile, "rb");
931 if( pc_in == NULL ) {
935 while( ! feof( pc_in ) ) {
938 temp_br = malloc( sizeof( buf_rec ) );
942 r = jpilot_read_next_pc( pc_in, temp_br );
943 if( r != MGU_SUCCESS ) {
944 if( (r != MGU_EOF) && (r != MGU_ERROR_READ) ) {
945 free( temp_br->buf );
952 if( ( temp_br->rt != DELETED_PC_REC )
953 && ( temp_br->rt != DELETED_PALM_REC )
954 && ( temp_br->rt != MODIFIED_PALM_REC )
955 && ( temp_br->rt != DELETED_DELETED_PALM_REC ) )
957 *records = g_list_append( *records, temp_br );
962 if( ( temp_br->rt == DELETED_PALM_REC )
963 || ( temp_br->rt == MODIFIED_PALM_REC ) )
965 temp_list = *records;
967 while( temp_list->next ) {
968 temp_list=temp_list->next;
971 for( ; temp_list; temp_list=temp_list->prev ) {
972 if( ( ( buf_rec * )temp_list->data )->unique_id ==
973 temp_br->unique_id ) {
974 ( ( buf_rec * )temp_list->data )->rt =
981 free( temp_br->buf );
991 * Parse buffer containing multiple e-mail addresses into a linked list of
992 * addresses. Separator characters are " ,;|" and control characters. Address
993 * is only extracted if it contains an "at" (@) character.
995 * \param buf Buffer to process.
996 * \return List of strings.
998 static GList *jpilot_parse_email( gchar *buf ) {
1003 gboolean valid, done;
1005 valid = done = FALSE;
1010 if( *p == ' ' || *p == ',' || *p == ';' || *p == '|' || *p < 32 ) {
1025 em = g_strndup( st, len );
1026 list = g_list_append( list, em );
1034 if( *p == '@' ) valid = TRUE;
1042 #define FULLNAME_BUFSIZE 256
1043 #define EMAIL_BUFSIZE 256
1046 * Process a single label entry field, parsing multiple e-mail address entries.
1048 * \param pilotFile JPilot control data.
1049 * \param labelEntry Label entry data.
1050 * \param person Person.
1052 static void jpilot_parse_label( JPilotFile *pilotFile, gchar *labelEntry, ItemPerson *person ) {
1053 gchar buffer[ EMAIL_BUFSIZE ];
1059 g_strlcpy( buffer, labelEntry, sizeof(buffer) );
1060 node = list = jpilot_parse_email( buffer );
1062 email = addritem_create_item_email();
1063 addritem_email_set_address( email, node->data );
1064 if (convert_charcode) {
1065 gchar *convertBuff = NULL;
1066 convertBuff = conv_codeset_strdup( labelEntry,
1067 jpilot_get_charset(),
1070 addritem_email_set_remarks( email, convertBuff );
1071 g_free( convertBuff );
1074 addritem_email_set_remarks(email, buffer);
1077 addrcache_id_email( pilotFile->addressCache, email );
1078 addrcache_person_add_email( pilotFile->addressCache, person, email );
1079 node = g_list_next( node );
1081 mgu_free_dlist( list );
1087 * Unpack address, building new data inside cache.
1088 * \param pilotFile JPilot control data.
1089 * \param buf Record buffer.
1090 * \param folderInd Array of (category) folders to load.
1092 static void jpilot_load_address(
1093 JPilotFile *pilotFile, buf_rec *buf, ItemFolder *folderInd[] )
1095 struct Address addr;
1101 gchar fullName[ FULLNAME_BUFSIZE ];
1107 gchar **firstName = NULL;
1108 gchar **lastName = NULL;
1109 #if (PILOT_LINK_MAJOR > 11)
1110 pi_buffer_t *RecordBuffer;
1111 RecordBuffer = pi_buffer_new(buf->size);
1113 memcpy(RecordBuffer->data, buf->buf, buf->size);
1114 RecordBuffer->used = buf->size;
1115 if (unpack_Address(&addr, RecordBuffer, address_v1) == -1) {
1116 pi_buffer_free(RecordBuffer);
1119 pi_buffer_free(RecordBuffer);
1123 num = unpack_Address(&addr, buf->buf, buf->size);
1127 #endif /* PILOT_LINK_0_12 */
1129 addrEnt = addr.entry;
1130 attrib = buf->attrib;
1131 unique_id = buf->unique_id;
1132 cat_id = attrib & 0x0F;
1135 if( addrEnt[ IND_LABEL_FIRSTNAME ] ) {
1136 firstName = g_strsplit( addrEnt[ IND_LABEL_FIRSTNAME ], "\01", 2 );
1139 if( addrEnt[ IND_LABEL_LASTNAME ] ) {
1140 lastName = g_strsplit( addrEnt[ IND_LABEL_LASTNAME ], "\01", 2 );
1143 if( name_order == FAMILY_LAST ) {
1144 g_snprintf( fullName, FULLNAME_BUFSIZE, "%s %s",
1145 firstName ? firstName[0] : "",
1146 lastName ? lastName[0] : "" );
1149 g_snprintf( fullName, FULLNAME_BUFSIZE, "%s %s",
1150 lastName ? lastName[0] : "",
1151 firstName ? firstName[0] : "" );
1155 g_strfreev( firstName );
1158 g_strfreev( lastName );
1161 g_strstrip( fullName );
1163 if( convert_charcode ) {
1164 gchar *nameConv = NULL;
1165 nameConv = conv_codeset_strdup( fullName,
1166 jpilot_get_charset(),
1169 strncpy2( fullName, nameConv, FULLNAME_BUFSIZE );
1173 person = addritem_create_item_person();
1174 addritem_person_set_common_name( person, fullName );
1175 addritem_person_set_first_name( person, addrEnt[ IND_LABEL_FIRSTNAME ] );
1176 addritem_person_set_last_name( person, addrEnt[ IND_LABEL_LASTNAME ] );
1177 addrcache_id_person( pilotFile->addressCache, person );
1179 extID = g_strdup_printf( "%d", unique_id );
1180 addritem_person_set_external_id( person, extID );
1184 /* Add entry for each email address listed under phone labels. */
1185 indPhoneLbl = addr.phoneLabel;
1186 for( k = 0; k < JPILOT_NUM_ADDR_PHONE; k++ ) {
1187 if( indPhoneLbl[k] == IND_PHONE_EMAIL ) {
1188 labelEntry = addrEnt[ OFFSET_PHONE_LABEL + k ];
1189 jpilot_parse_label( pilotFile, labelEntry, person );
1193 /* Add entry for each custom label */
1194 node = pilotFile->labelInd;
1198 ind = GPOINTER_TO_INT( node->data );
1201 * g_print( "%d : %20s : %s\n", ind, ai->labels[ind],
1204 labelEntry = addrEnt[ind];
1205 jpilot_parse_label( pilotFile, labelEntry, person );
1208 node = g_list_next( node );
1211 if( person->listEMail ) {
1212 /* Add to specified category */
1213 addrcache_folder_add_person(
1214 pilotFile->addressCache,
1215 folderInd[cat_id], person );
1218 addritem_free_item_person( person );
1221 /* Free up pointer allocated inside address */
1222 free_Address( & addr );
1226 * Free up address list.
1227 * \param records List of records to free.
1229 static void jpilot_free_addrlist( GList *records ) {
1239 node = g_list_next( node );
1243 g_list_free( records );
1247 * Read metadata from file.
1248 * \param pilotFile JPilot control data.
1249 * \return Status/error code. <code>MGU_SUCCESS</code> if data read
1252 static gint jpilot_read_metadata( JPilotFile *pilotFile ) {
1254 unsigned int rec_size;
1258 cm_return_val_if_fail( pilotFile != NULL, -1 );
1260 pilotFile->readMetadata = FALSE;
1261 addrcache_clear( pilotFile->addressCache );
1263 /* Read file info */
1264 retVal = jpilot_get_file_info( pilotFile, &buf, &rec_size);
1265 if( retVal != MGU_SUCCESS ) {
1266 pilotFile->retVal = retVal;
1267 return pilotFile->retVal;
1270 num = unpack_AddressAppInfo( &pilotFile->addrInfo, buf, rec_size );
1275 pilotFile->retVal = MGU_ERROR_READ;
1276 return pilotFile->retVal;
1279 pilotFile->readMetadata = TRUE;
1280 pilotFile->retVal = MGU_SUCCESS;
1281 return pilotFile->retVal;
1285 * Setup labels and indexes from metadata.
1286 * \param pilotFile JPilot control data.
1287 * \return <i>TRUE</i> is setup successfully.
1289 static gboolean jpilot_setup_labels( JPilotFile *pilotFile ) {
1290 gboolean retVal = FALSE;
1291 struct AddressAppInfo *ai;
1294 cm_return_val_if_fail( pilotFile != NULL, -1 );
1296 /* Release indexes */
1297 node = pilotFile->labelInd;
1300 node = g_list_next( node );
1302 pilotFile->labelInd = NULL;
1304 if( pilotFile->readMetadata ) {
1305 ai = & pilotFile->addrInfo;
1306 node = pilotFile->customLabels;
1308 gchar *lbl = node->data;
1311 for( i = 0; i < JPILOT_NUM_LABELS; i++ ) {
1312 gchar *labelName = ai->labels[i];
1314 if( convert_charcode ) {
1315 gchar *convertBuff = NULL;
1316 convertBuff = conv_codeset_strdup( labelName,
1317 jpilot_get_charset(),
1320 labelName = convertBuff;
1324 if( g_utf8_collate( labelName, lbl ) == 0 ) {
1329 pilotFile->labelInd = g_list_append(
1330 pilotFile->labelInd, GINT_TO_POINTER(ind) );
1331 node = g_list_next( node );
1339 * Load list with character strings of custom label names. Only none blank
1341 * \param pilotFile JPilot control data.
1342 * \param labelList List of label names to load.
1343 * \return List of label names loaded. Should be freed when done.
1345 GList *jpilot_load_custom_label( JPilotFile *pilotFile, GList *labelList ) {
1348 cm_return_val_if_fail( pilotFile != NULL, NULL );
1350 if( pilotFile->readMetadata ) {
1351 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1352 for( i = 0; i < NUM_CUSTOM_LABEL; i++ ) {
1353 gchar *labelName = ai->labels[i+IND_CUSTOM_LABEL];
1355 g_strchomp( labelName );
1356 g_strchug( labelName );
1357 if( *labelName != '\0' ) {
1358 if( convert_charcode ) {
1359 gchar *convertBuff = NULL;
1360 convertBuff = conv_codeset_strdup( labelName,
1361 jpilot_get_charset(),
1364 labelName = convertBuff;
1368 labelName = g_strdup( labelName );
1370 labelList = g_list_append( labelList, labelName );
1379 * Build folder in address book for each category.
1380 * \param pilotFile JPilot control data.
1382 static void jpilot_build_category_list( JPilotFile *pilotFile ) {
1383 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1384 struct CategoryAppInfo *cat = & ai->category;
1387 for( i = 0; i < JPILOT_NUM_CATEG; i++ ) {
1388 ItemFolder *folder = addritem_create_item_folder();
1390 if( convert_charcode ) {
1391 gchar *convertBuff = NULL;
1392 convertBuff = conv_codeset_strdup( cat->name[i],
1393 jpilot_get_charset(),
1396 addritem_folder_set_name( folder, convertBuff );
1397 g_free( convertBuff );
1399 addritem_folder_set_name( folder, cat->name[i] );
1403 addritem_folder_set_name( folder, cat->name[i] );
1406 addrcache_id_folder( pilotFile->addressCache, folder );
1407 addrcache_add_folder( pilotFile->addressCache, folder );
1412 * Remove empty (category) folders.
1413 * \param pilotFile JPilot control data.
1415 static void jpilot_remove_empty( JPilotFile *pilotFile ) {
1421 listFolder = addrcache_get_list_folder( pilotFile->addressCache );
1425 ItemFolder *folder = node->data;
1426 if( ADDRITEM_NAME(folder) == NULL || *ADDRITEM_NAME(folder) == '\0' ) {
1427 if( folder->listPerson ) {
1428 /* Give name to folder */
1430 sprintf( name, "? %d", i );
1431 addritem_folder_set_name( folder, name );
1434 /* Mark for removal */
1435 remList = g_list_append( remList, folder );
1438 node = g_list_next( node );
1443 ItemFolder *folder = node->data;
1444 addrcache_remove_folder( pilotFile->addressCache, folder );
1445 node = g_list_next( node );
1447 g_list_free( remList );
1451 * Read address file into address cache.
1452 * \param pilotFile JPilot control data.
1453 * \return Error/status code. <code>MGU_SUCCESS</code> if data read
1456 static gint jpilot_read_file( JPilotFile *pilotFile ) {
1458 GList *records = NULL;
1461 ItemFolder *folderInd[ JPILOT_NUM_CATEG ];
1463 /* Read list of records from JPilot files */
1464 retVal = jpilot_read_db_files( pilotFile, &records );
1465 if( retVal != MGU_SUCCESS ) {
1466 jpilot_free_addrlist( records );
1470 /* Setup labels and category folders */
1471 jpilot_setup_labels( pilotFile );
1472 jpilot_build_category_list( pilotFile );
1474 /* Build array of pointers to categories */
1476 node = addrcache_get_list_folder( pilotFile->addressCache );
1478 if( i < JPILOT_NUM_CATEG ) {
1479 folderInd[i] = node->data;
1481 node = g_list_next( node );
1485 /* Load all addresses, free up old stuff as we go */
1489 if( ( br->rt != DELETED_PC_REC ) &&
1490 ( br->rt != DELETED_PALM_REC ) &&
1491 ( br->rt != MODIFIED_PALM_REC ) &&
1492 ( br->rt != DELETED_DELETED_PALM_REC ) ) {
1493 jpilot_load_address( pilotFile, br, folderInd );
1498 node = g_list_next( node );
1502 g_list_free( records );
1504 /* Remove empty category folders */
1505 jpilot_remove_empty( pilotFile );
1506 jpilot_mark_files( pilotFile );
1512 * Read file into list. Main entry point
1513 * \param pilotFile JPilot control data.
1514 * \return Error/status code. <code>MGU_SUCCESS</code> if data read
1517 gint jpilot_read_data( JPilotFile *pilotFile ) {
1518 const gchar *cur_locale;
1520 name_order = FAMILY_LAST;
1522 cur_locale = conv_get_current_locale();
1524 if( g_ascii_strncasecmp( cur_locale, "ja", 2 ) == 0 ) {
1525 name_order = FAMILY_FIRST;
1528 cm_return_val_if_fail( pilotFile != NULL, -1 );
1530 pilotFile->retVal = MGU_SUCCESS;
1531 pilotFile->addressCache->accessFlag = FALSE;
1532 if( jpilot_check_files( pilotFile ) ) {
1533 addrcache_clear( pilotFile->addressCache );
1534 jpilot_read_metadata( pilotFile );
1535 if( pilotFile->retVal == MGU_SUCCESS ) {
1536 pilotFile->retVal = jpilot_read_file( pilotFile );
1537 if( pilotFile->retVal == MGU_SUCCESS ) {
1538 pilotFile->addressCache->modified = FALSE;
1539 pilotFile->addressCache->dataRead = TRUE;
1543 return pilotFile->retVal;
1547 * Return linked list of persons. This is a list of references to ItemPerson
1548 * objects. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
1549 * functions... this will destroy the addressbook data!
1551 * \param pilotFile JPilot control data.
1552 * \return List of persons.
1554 GList *jpilot_get_list_person( JPilotFile *pilotFile ) {
1555 cm_return_val_if_fail( pilotFile != NULL, NULL );
1556 return addrcache_get_list_person( pilotFile->addressCache );
1560 * Return linked list of folders. This is a list of references to non-empty
1561 * category folders. Do <b>NOT</b> attempt to use the
1562 * <code>addrbook_free_xxx()</code> functions... this will destroy the
1565 * \param pilotFile JPilot control data.
1566 * \return List of ItemFolder objects. This should not be freed.
1568 GList *jpilot_get_list_folder( JPilotFile *pilotFile ) {
1569 cm_return_val_if_fail( pilotFile != NULL, NULL );
1570 return addrcache_get_list_folder( pilotFile->addressCache );
1574 * Return linked list of all persons. Note that the list contains references
1575 * to items. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
1576 * functions... this will destroy the addressbook data!
1578 * \param pilotFile JPilot control data.
1579 * \return List of items, or NULL if none.
1581 GList *jpilot_get_all_persons( JPilotFile *pilotFile ) {
1582 cm_return_val_if_fail( pilotFile != NULL, NULL );
1583 return addrcache_get_all_persons( pilotFile->addressCache );
1586 #define WORK_BUFLEN 1024
1589 * Attempt to find a valid JPilot file.
1590 * \param pilotFile JPilot control data.
1591 * \return Filename, or home directory if not found, or empty string if
1592 * no home. Filename should be <code>g_free()</code> when done.
1594 gchar *jpilot_find_pilotdb( void ) {
1595 const gchar *homedir;
1596 gchar str[ WORK_BUFLEN + 1 ];
1600 homedir = get_home_dir();
1601 if( ! homedir ) return g_strdup( "" );
1603 g_strlcpy( str, homedir , sizeof(str));
1604 len = strlen( str );
1606 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
1607 str[ len ] = G_DIR_SEPARATOR;
1608 str[ ++len ] = '\0';
1611 strncat( str, JPILOT_DBHOME_DIR, WORK_BUFLEN - strlen(str) );
1612 strncat( str, G_DIR_SEPARATOR_S, WORK_BUFLEN - strlen(str) );
1613 strncat( str, JPILOT_DBHOME_FILE, WORK_BUFLEN - strlen(str) );
1615 /* Attempt to open */
1616 if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
1620 /* Truncate filename */
1623 return g_strdup( str );
1627 * Check whether label is in list of custom labels.
1628 * \param pilotFile JPilot control data.
1629 * \param labelName to test.
1630 * \return <i>TRUE</i> if found.
1632 gboolean jpilot_test_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
1636 cm_return_val_if_fail( pilotFile != NULL, FALSE );
1640 node = pilotFile->customLabels;
1642 if( g_utf8_collate( labelName, ( gchar * ) node->data ) == 0 ) {
1646 node = g_list_next( node );
1653 * Test whether pilot link library installed.
1654 * \return <i>TRUE</i> if library available.
1656 gboolean jpilot_test_pilot_lib( void ) {
1660 #endif /* USE_JPILOT */