2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2003 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 JPilot database files.
22 * JPilot is Copyright(c) by Judd Montgomery.
23 * Visit http://www.jpilot.org for more details.
38 #include <netinet/in.h>
40 #ifdef HAVE_LIBPISOCK_PI_ARGS_H
41 # include <libpisock/pi-args.h>
42 # include <libpisock/pi-appinfo.h>
43 # include <libpisock/pi-address.h>
46 # include <pi-appinfo.h>
47 # include <pi-address.h>
52 #include "addrcache.h"
54 #include "adbookbase.h"
56 #define JPILOT_DBHOME_DIR ".jpilot"
57 #define JPILOT_DBHOME_FILE "AddressDB.pdb"
58 #define PILOT_LINK_LIB_NAME "libpisock.so"
60 #define IND_LABEL_LASTNAME 0 /* Index of last name in address data */
61 #define IND_LABEL_FIRSTNAME 1 /* Index of first name in address data */
62 #define IND_PHONE_EMAIL 4 /* Index of E-Mail address in phone labels */
63 #define OFFSET_PHONE_LABEL 3 /* Offset to phone data in address data */
64 #define IND_CUSTOM_LABEL 14 /* Offset to custom label names */
65 #define NUM_CUSTOM_LABEL 4 /* Number of custom labels */
67 /* Shamelessly copied from JPilot (libplugin.h) */
69 unsigned char db_name[32];
70 unsigned char flags[2];
71 unsigned char version[2];
72 unsigned char creation_time[4];
73 unsigned char modification_time[4];
74 unsigned char backup_time[4];
75 unsigned char modification_number[4];
76 unsigned char app_info_offset[4];
77 unsigned char sort_info_offset[4];
78 unsigned char type[4];/*Database ID */
79 unsigned char creator_id[4];/*Application ID */
80 unsigned char unique_id_seed[4];
81 unsigned char next_record_list_id[4];
82 unsigned char number_of_records[2];
85 /* Shamelessly copied from JPilot (libplugin.h) */
91 time_t modification_time;
93 unsigned int modification_number;
94 unsigned int app_info_offset;
95 unsigned int sort_info_offset;
96 char type[5];/*Database ID */
97 char creator_id[5];/*Application ID */
98 char unique_id_seed[5];
99 unsigned int next_record_list_id;
100 unsigned int number_of_records;
103 /* Shamelessly copied from JPilot (libplugin.h) */
105 unsigned char Offset[4]; /*4 bytes offset from BOF to record */
106 unsigned char attrib;
107 unsigned char unique_ID[3];
110 /* Shamelessly copied from JPilot (libplugin.h) */
111 typedef struct mem_rec_header_s {
112 unsigned int rec_num;
114 unsigned int unique_id;
115 unsigned char attrib;
116 struct mem_rec_header_s *next;
119 /* Shamelessly copied from JPilot (libplugin.h) */
120 #define SPENT_PC_RECORD_BIT 256
124 MODIFIED_PALM_REC = 101L,
125 DELETED_PALM_REC = 102L,
127 DELETED_PC_REC = SPENT_PC_RECORD_BIT + 104L,
128 DELETED_DELETED_PALM_REC = SPENT_PC_RECORD_BIT + 105L
131 /* Shamelessly copied from JPilot (libplugin.h) */
134 unsigned int unique_id;
135 unsigned char attrib;
140 /* Shamelessly copied from JPilot (libplugin.h) */
142 unsigned long header_len;
143 unsigned long header_version;
144 unsigned long rec_len;
145 unsigned long unique_id;
146 unsigned long rt; /* Record Type */
147 unsigned char attrib;
151 * Create new pilot file object.
152 * \return Initialized JPilot file object.
154 JPilotFile *jpilot_create() {
155 JPilotFile *pilotFile;
156 pilotFile = g_new0( JPilotFile, 1 );
157 pilotFile->type = ADBOOKTYPE_JPILOT;
158 pilotFile->addressCache = addrcache_create();
159 pilotFile->retVal = MGU_SUCCESS;
161 pilotFile->file = NULL;
162 pilotFile->path = NULL;
163 pilotFile->readMetadata = FALSE;
164 pilotFile->customLabels = NULL;
165 pilotFile->labelInd = NULL;
166 pilotFile->havePC3 = FALSE;
167 pilotFile->pc3ModifyTime = 0;
172 * Create new pilot file object for specified file.
173 * \param path Path to JPilot address book.
174 * \return Initialized JPilot file object.
176 JPilotFile *jpilot_create_path( const gchar *path ) {
177 JPilotFile *pilotFile;
178 pilotFile = jpilot_create();
179 jpilot_set_file( pilotFile, path );
186 void jpilot_set_name( JPilotFile* pilotFile, const gchar *value ) {
187 g_return_if_fail( pilotFile != NULL );
188 addrcache_set_name( pilotFile->addressCache, value );
190 void jpilot_set_file( JPilotFile* pilotFile, const gchar *value ) {
191 g_return_if_fail( pilotFile != NULL );
192 addrcache_refresh( pilotFile->addressCache );
193 pilotFile->readMetadata = FALSE;
194 pilotFile->path = mgu_replace_string( pilotFile->path, value );
196 void jpilot_set_accessed( JPilotFile *pilotFile, const gboolean value ) {
197 g_return_if_fail( pilotFile != NULL );
198 pilotFile->addressCache->accessFlag = value;
201 gint jpilot_get_status( JPilotFile *pilotFile ) {
202 g_return_val_if_fail( pilotFile != NULL, -1 );
203 return pilotFile->retVal;
205 ItemFolder *jpilot_get_root_folder( JPilotFile *pilotFile ) {
206 g_return_val_if_fail( pilotFile != NULL, NULL );
207 return addrcache_get_root_folder( pilotFile->addressCache );
209 gchar *jpilot_get_name( JPilotFile *pilotFile ) {
210 g_return_val_if_fail( pilotFile != NULL, NULL );
211 return addrcache_get_name( pilotFile->addressCache );
215 * Test whether file was read.
216 * \param pilotFile JPilot control data.
217 * \return <i>TRUE</i> if file was read.
219 gboolean jpilot_get_read_flag( JPilotFile *pilotFile ) {
220 g_return_val_if_fail( pilotFile != NULL, FALSE );
221 return pilotFile->addressCache->dataRead;
225 * Free up custom label list.
226 * \param pilotFile JPilot control data.
228 void jpilot_clear_custom_labels( JPilotFile *pilotFile ) {
231 g_return_if_fail( pilotFile != NULL );
233 /* Release custom labels */
234 mgu_free_dlist( pilotFile->customLabels );
235 pilotFile->customLabels = NULL;
237 /* Release indexes */
238 node = pilotFile->labelInd;
241 node = g_list_next( node );
243 g_list_free( pilotFile->labelInd );
244 pilotFile->labelInd = NULL;
246 /* Force a fresh read */
247 addrcache_refresh( pilotFile->addressCache );
251 * Append a custom label, representing an E-Mail address field to the
253 * \param pilotFile JPilot control data.
255 void jpilot_add_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
256 g_return_if_fail( pilotFile != NULL );
259 gchar *labelCopy = g_strdup( labelName );
260 g_strstrip( labelCopy );
261 if( *labelCopy == '\0' ) {
265 pilotFile->customLabels = g_list_append( pilotFile->customLabels, labelCopy );
266 /* Force a fresh read */
267 addrcache_refresh( pilotFile->addressCache );
273 * Get list of custom labels.
274 * \param pilotFile JPilot control data.
275 * \return List of labels. Must use g_free() when done.
277 GList *jpilot_get_custom_labels( JPilotFile *pilotFile ) {
278 GList *retVal = NULL;
281 g_return_val_if_fail( pilotFile != NULL, NULL );
283 node = pilotFile->customLabels;
285 retVal = g_list_append( retVal, g_strdup( node->data ) );
286 node = g_list_next( node );
292 * Return filespec of PC3 file corresponding to JPilot PDB file.
293 * \param pilotFile JPilot control data.
294 * \return File specification; should be g_free() when done.
296 static gchar *jpilot_get_pc3_file( JPilotFile *pilotFile ) {
300 if( pilotFile == NULL ) return NULL;
301 if( pilotFile->path == NULL ) return NULL;
303 fileSpec = g_strdup( pilotFile->path );
304 len = strlen( fileSpec );
307 for( i = len; i > 0; i-- ) {
308 if( *(fileSpec + i) == '.' ) {
315 if( len - pos == 3 ) {
316 *r++ = 'p'; *r++ = 'c'; *r = '3';
325 * Save PC3 file time to cache.
326 * \param pilotFile JPilot control data.
327 * \return <i>TRUE</i> if time marked.
329 static gboolean jpilot_mark_files( JPilotFile *pilotFile ) {
330 gboolean retVal = FALSE;
331 struct stat filestat;
334 /* Mark PDB file cache */
335 retVal = addrcache_mark_file( pilotFile->addressCache, pilotFile->path );
337 /* Now mark PC3 file */
338 pilotFile->havePC3 = FALSE;
339 pilotFile->pc3ModifyTime = 0;
340 pcFile = jpilot_get_pc3_file( pilotFile );
341 if( pcFile == NULL ) return retVal;
342 if( 0 == lstat( pcFile, &filestat ) ) {
343 pilotFile->havePC3 = TRUE;
344 pilotFile->pc3ModifyTime = filestat.st_mtime;
352 * Check whether JPilot PDB or PC3 file has changed by comparing
354 * \param pilotFile JPilot control data.
355 * \return <i>TRUE</i> if file has changed.
357 static gboolean jpilot_check_files( JPilotFile *pilotFile ) {
358 gboolean retVal = TRUE;
359 struct stat filestat;
362 /* Check main file */
363 if( addrcache_check_file( pilotFile->addressCache, pilotFile->path ) )
367 if( ! pilotFile->havePC3 ) return FALSE;
368 pcFile = jpilot_get_pc3_file( pilotFile );
369 if( pcFile == NULL ) return FALSE;
371 if( 0 == lstat( pcFile, &filestat ) ) {
372 if( filestat.st_mtime == pilotFile->pc3ModifyTime ) retVal = FALSE;
379 * Test whether file was modified since last access.
380 * Return: TRUE if file was modified.
382 gboolean jpilot_get_modified( JPilotFile *pilotFile ) {
383 g_return_val_if_fail( pilotFile != NULL, FALSE );
384 pilotFile->addressCache->modified = jpilot_check_files( pilotFile );
385 return pilotFile->addressCache->modified;
387 void jpilot_set_modified( JPilotFile *pilotFile, const gboolean value ) {
388 g_return_if_fail( pilotFile != NULL );
389 pilotFile->addressCache->modified = value;
391 gboolean jpilot_get_accessed( JPilotFile *pilotFile ) {
392 g_return_val_if_fail( pilotFile != NULL, FALSE );
393 return pilotFile->addressCache->accessFlag;
397 * Free up pilot file object by releasing internal memory.
398 * \param pilotFile JPilot control data.
400 void jpilot_free( JPilotFile *pilotFile ) {
401 g_return_if_fail( pilotFile != NULL );
403 /* Release custom labels */
404 jpilot_clear_custom_labels( pilotFile );
407 addrcache_clear( pilotFile->addressCache );
408 addrcache_free( pilotFile->addressCache );
410 /* Free internal stuff */
411 g_free( pilotFile->path );
413 pilotFile->file = NULL;
414 pilotFile->path = NULL;
415 pilotFile->readMetadata = FALSE;
416 pilotFile->havePC3 = FALSE;
417 pilotFile->pc3ModifyTime = 0;
419 pilotFile->type = ADBOOKTYPE_NONE;
420 pilotFile->addressCache = NULL;
421 pilotFile->retVal = MGU_SUCCESS;
423 /* Now release file object */
428 * Refresh internal variables to force a file read.
430 void jpilot_force_refresh( JPilotFile *pilotFile ) {
431 addrcache_refresh( pilotFile->addressCache );
435 * Print object to specified stream.
437 void jpilot_print_file( JPilotFile *pilotFile, FILE *stream ) {
440 g_return_if_fail( pilotFile != NULL );
442 fprintf( stream, "JPilotFile:\n" );
443 fprintf( stream, "file spec: '%s'\n", pilotFile->path );
444 fprintf( stream, " metadata: %s\n", pilotFile->readMetadata ? "yes" : "no" );
445 fprintf( stream, " ret val: %d\n", pilotFile->retVal );
447 node = pilotFile->customLabels;
449 fprintf( stream, " c label: %s\n", (gchar *)node->data );
450 node = g_list_next( node );
453 node = pilotFile->labelInd;
455 fprintf( stream, " labelind: %d\n", GPOINTER_TO_INT(node->data) );
456 node = g_list_next( node );
459 addrcache_print( pilotFile->addressCache, stream );
460 fprintf( stream, " ret val: %d\n", pilotFile->retVal );
461 fprintf( stream, " have pc3: %s\n", pilotFile->havePC3 ? "yes" : "no" );
462 fprintf( stream, " pc3 time: %lu\n", pilotFile->pc3ModifyTime );
463 addritem_print_item_folder( pilotFile->addressCache->rootFolder, stream );
467 * Print summary of object to specified stream.
469 void jpilot_print_short( JPilotFile *pilotFile, FILE *stream ) {
471 g_return_if_fail( pilotFile != NULL );
472 fprintf( stream, "JPilotFile:\n" );
473 fprintf( stream, "file spec: '%s'\n", pilotFile->path );
474 fprintf( stream, " metadata: %s\n", pilotFile->readMetadata ? "yes" : "no" );
475 fprintf( stream, " ret val: %d\n", pilotFile->retVal );
477 node = pilotFile->customLabels;
479 fprintf( stream, " c label: %s\n", (gchar *)node->data );
480 node = g_list_next( node );
483 node = pilotFile->labelInd;
485 fprintf( stream, " labelind: %d\n", GPOINTER_TO_INT(node->data) );
486 node = g_list_next( node );
488 addrcache_print( pilotFile->addressCache, stream );
489 fprintf( stream, " have pc3: %s\n", pilotFile->havePC3 ? "yes" : "no" );
490 fprintf( stream, " pc3 time: %lu\n", pilotFile->pc3ModifyTime );
493 /* Shamelessly copied from JPilot (libplugin.c) */
494 static unsigned int bytes_to_bin(unsigned char *bytes, unsigned int num_bytes) {
497 for (i=0;i<num_bytes;i++) {
503 /* Shamelessly copied from JPilot (utils.c) */
504 /* These next 2 functions were copied from pi-file.c in the pilot-link app */
505 /* Exact value of "Jan 1, 1970 0:00:00 GMT" - "Jan 1, 1904 0:00:00 GMT" */
506 #define PILOT_TIME_DELTA (unsigned)(2082844800)
508 time_t pilot_time_to_unix_time ( unsigned long raw_time ) {
509 return (time_t)(raw_time - PILOT_TIME_DELTA);
512 /* Shamelessly copied from JPilot (libplugin.c) */
513 static int raw_header_to_header(RawDBHeader *rdbh, DBHeader *dbh) {
516 strncpy(dbh->db_name, rdbh->db_name, 31);
517 dbh->db_name[31] = '\0';
518 dbh->flags = bytes_to_bin(rdbh->flags, 2);
519 dbh->version = bytes_to_bin(rdbh->version, 2);
520 temp = bytes_to_bin(rdbh->creation_time, 4);
521 dbh->creation_time = pilot_time_to_unix_time(temp);
522 temp = bytes_to_bin(rdbh->modification_time, 4);
523 dbh->modification_time = pilot_time_to_unix_time(temp);
524 temp = bytes_to_bin(rdbh->backup_time, 4);
525 dbh->backup_time = pilot_time_to_unix_time(temp);
526 dbh->modification_number = bytes_to_bin(rdbh->modification_number, 4);
527 dbh->app_info_offset = bytes_to_bin(rdbh->app_info_offset, 4);
528 dbh->sort_info_offset = bytes_to_bin(rdbh->sort_info_offset, 4);
529 strncpy(dbh->type, rdbh->type, 4);
531 strncpy(dbh->creator_id, rdbh->creator_id, 4);
532 dbh->creator_id[4] = '\0';
533 strncpy(dbh->unique_id_seed, rdbh->unique_id_seed, 4);
534 dbh->unique_id_seed[4] = '\0';
535 dbh->next_record_list_id = bytes_to_bin(rdbh->next_record_list_id, 4);
536 dbh->number_of_records = bytes_to_bin(rdbh->number_of_records, 2);
540 /* Shamelessly copied from JPilot (libplugin.c) */
541 /* returns 1 if found */
543 static int find_next_offset( mem_rec_header *mem_rh, long fpos,
544 unsigned int *next_offset, unsigned char *attrib, unsigned int *unique_id )
546 mem_rec_header *temp_mem_rh;
547 unsigned char found = 0;
548 unsigned long found_at;
551 for (temp_mem_rh=mem_rh; temp_mem_rh; temp_mem_rh = temp_mem_rh->next) {
552 if ((temp_mem_rh->offset > fpos) && (temp_mem_rh->offset < found_at)) {
553 found_at = temp_mem_rh->offset;
554 /* *attrib = temp_mem_rh->attrib; */
555 /* *unique_id = temp_mem_rh->unique_id; */
557 if ((temp_mem_rh->offset == fpos)) {
559 *attrib = temp_mem_rh->attrib;
560 *unique_id = temp_mem_rh->unique_id;
563 *next_offset = found_at;
567 /* Shamelessly copied from JPilot (libplugin.c) */
568 static void free_mem_rec_header(mem_rec_header **mem_rh) {
569 mem_rec_header *h, *next_h;
570 for (h=*mem_rh; h; h=next_h) {
577 /* Shamelessly copied from JPilot (libplugin.c) */
579 static int jpilot_get_info_size( FILE *in, int *size ) {
585 fseek(in, 0, SEEK_SET);
586 fread(&rdbh, sizeof(RawDBHeader), 1, in);
591 raw_header_to_header(&rdbh, &dbh);
592 if (dbh.app_info_offset==0) {
596 if (dbh.sort_info_offset!=0) {
597 *size = dbh.sort_info_offset - dbh.app_info_offset;
600 if (dbh.number_of_records==0) {
601 fseek(in, 0, SEEK_END);
602 *size=ftell(in) - dbh.app_info_offset;
606 fread(&rh, sizeof(record_header), 1, in);
607 offset = ((rh.Offset[0]*256+rh.Offset[1])*256+rh.Offset[2])*256+rh.Offset[3];
608 *size=offset - dbh.app_info_offset;
614 * Read address file into address list. Based on JPilot's
615 * libplugin.c (jp_get_app_info)
617 static gint jpilot_get_file_info( JPilotFile *pilotFile, unsigned char **buf, int *buf_size ) {
620 unsigned int rec_size;
624 if( ( !buf_size ) || ( ! buf ) ) {
631 if( pilotFile->path ) {
632 in = fopen( pilotFile->path, "rb" );
634 return MGU_OPEN_FILE;
641 num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
645 return MGU_ERROR_READ;
653 /* Convert header into something recognizable */
654 raw_header_to_header(&rdbh, &dbh);
656 num = jpilot_get_info_size(in, &rec_size);
659 return MGU_ERROR_READ;
662 fseek(in, dbh.app_info_offset, SEEK_SET);
663 *buf = ( char * ) malloc(rec_size);
666 return MGU_OO_MEMORY;
668 num = fread(*buf, rec_size, 1, in);
673 return MGU_ERROR_READ;
678 *buf_size = rec_size;
683 /* Shamelessly copied from JPilot (libplugin.c) */
684 static int unpack_header(PC3RecordHeader *header, unsigned char *packed_header) {
690 memcpy(&l, p, sizeof(l));
691 header->header_len=ntohl(l);
694 memcpy(&l, p, sizeof(l));
695 header->header_version=ntohl(l);
698 memcpy(&l, p, sizeof(l));
699 header->rec_len=ntohl(l);
702 memcpy(&l, p, sizeof(l));
703 header->unique_id=ntohl(l);
706 memcpy(&l, p, sizeof(l));
710 memcpy(&(header->attrib), p, sizeof(unsigned char));
711 p+=sizeof(unsigned char);
716 /* Shamelessly copied from JPilot (libplugin.c) */
717 static int read_header(FILE *pc_in, PC3RecordHeader *header) {
718 unsigned long l, len;
719 unsigned char packed_header[256];
722 num = fread(&l, sizeof(l), 1, pc_in);
729 memcpy(packed_header, &l, sizeof(l));
734 num = fread(packed_header+sizeof(l), len-sizeof(l), 1, pc_in);
741 unpack_header(header, packed_header);
746 * Read next record from PC3 file. Based on JPilot function
747 * <code>pc_read_next_rec()</code> (libplugin.c)
749 * \param in File handle.
750 * \param br Record buffer.
751 * \return Status/error code. <code>MGU_SUCCESS</code> if data read
754 static gint jpilot_read_next_pc( FILE *in, buf_rec *br ) {
755 PC3RecordHeader header;
762 num = read_header( in, &header );
765 return MGU_ERROR_READ;
771 rec_len = header.rec_len;
772 record = malloc( rec_len );
774 return MGU_OO_MEMORY;
776 num = fread( record, rec_len, 1, in );
780 return MGU_ERROR_READ;
784 br->unique_id = header.unique_id;
785 br->attrib = header.attrib;
793 * Read address file into a linked list. Based on JPilot function
794 * <code>jp_read_DB_files()</code> (from libplugin.c)
796 * \param pilotFile JPilot control data.
797 * \param records Pointer to linked list of records read.
798 * \return Status/error code. <code>MGU_SUCCESS</code> if data read
801 static gint jpilot_read_db_files( JPilotFile *pilotFile, GList **records ) {
805 int num_records, recs_returned, i, num, r;
806 unsigned int offset, prev_offset, next_offset, rec_size;
808 long fpos; /*file position indicator */
809 unsigned char attrib;
810 unsigned int unique_id;
811 mem_rec_header *mem_rh, *temp_mem_rh, *last_mem_rh;
818 mem_rh = last_mem_rh = NULL;
822 if( pilotFile->path == NULL ) {
826 in = fopen( pilotFile->path, "rb" );
828 return MGU_OPEN_FILE;
831 /* Read the database header */
832 num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
836 return MGU_ERROR_READ;
843 raw_header_to_header( &rdbh, &dbh );
845 /* Read each record entry header */
846 num_records = dbh.number_of_records;
850 for( i = 1; i < num_records + 1; i++ ) {
851 num = fread( &rh, sizeof( record_header ), 1, in );
863 ( ( rh.Offset[0] * 256 + rh.Offset[1] ) * 256
864 + rh.Offset[2] ) * 256
866 if( offset < prev_offset ) {
869 prev_offset = offset;
870 temp_mem_rh = ( mem_rec_header * ) malloc( sizeof( mem_rec_header ) );
871 if( ! temp_mem_rh ) {
874 temp_mem_rh->next = NULL;
875 temp_mem_rh->rec_num = i;
876 temp_mem_rh->offset = offset;
877 temp_mem_rh->attrib = rh.attrib;
878 temp_mem_rh->unique_id =
879 ( rh.unique_ID[0] * 256 + rh.unique_ID[1] ) * 256
881 if( mem_rh == NULL ) {
882 mem_rh = temp_mem_rh;
883 last_mem_rh = temp_mem_rh;
886 last_mem_rh->next = temp_mem_rh;
887 last_mem_rh = temp_mem_rh;
891 temp_mem_rh = mem_rh;
896 mem_rh, 0, &next_offset, &attrib, &unique_id );
900 next_offset = mem_rh->offset;
901 attrib = mem_rh->attrib;
902 unique_id = mem_rh->unique_id;
905 fseek( in, next_offset, SEEK_SET );
906 while( ! feof( in ) ) {
910 mem_rh, fpos, &next_offset, &attrib,
913 next_offset = 0xFFFFFF;
915 attrib = temp_mem_rh->attrib;
916 unique_id = temp_mem_rh->unique_id;
917 if ( temp_mem_rh->next ) {
918 temp_mem_rh = temp_mem_rh->next;
919 next_offset = temp_mem_rh->offset;
923 rec_size = next_offset - fpos;
924 buf = malloc( rec_size );
926 num = fread( buf, rec_size, 1, in );
934 temp_br = malloc( sizeof( buf_rec ) );
939 temp_br->rt = PALM_REC;
940 temp_br->unique_id = unique_id;
941 temp_br->attrib = attrib;
943 temp_br->size = rec_size;
945 *records = g_list_append( *records, temp_br );
951 free_mem_rec_header( &mem_rh );
953 /* Read the PC3 file, if present */
954 pcFile = jpilot_get_pc3_file( pilotFile );
955 if( pcFile == NULL ) return MGU_SUCCESS;
956 pc_in = fopen( pcFile, "rb" );
959 if( pc_in == NULL ) {
963 while( ! feof( pc_in ) ) {
966 temp_br = malloc( sizeof( buf_rec ) );
970 r = jpilot_read_next_pc( pc_in, temp_br );
971 if( r != MGU_SUCCESS ) {
972 if( (r != MGU_EOF) && (r != MGU_ERROR_READ) ) {
973 free( temp_br->buf );
980 if( ( temp_br->rt != DELETED_PC_REC )
981 && ( temp_br->rt != DELETED_PALM_REC )
982 && ( temp_br->rt != MODIFIED_PALM_REC )
983 && ( temp_br->rt != DELETED_DELETED_PALM_REC ) )
985 *records = g_list_append( *records, temp_br );
990 if( ( temp_br->rt == DELETED_PALM_REC )
991 || ( temp_br->rt == MODIFIED_PALM_REC ) )
993 temp_list = *records;
995 while( temp_list->next ) {
996 temp_list=temp_list->next;
999 for( ; temp_list; temp_list=temp_list->prev ) {
1000 if( ( ( buf_rec * )temp_list->data )->unique_id ==
1001 temp_br->unique_id ) {
1002 ( ( buf_rec * )temp_list->data )->rt =
1009 free( temp_br->buf );
1019 * Parse buffer containing multiple e-mail addresses into a linked list of
1020 * addresses. Separator characters are " ,;|" and control characters. Address
1021 * is only extracted if it contains an "at" (@) character.
1023 * \param buf Buffer to process.
1024 * \return List of strings.
1026 static GList *jpilot_parse_email( gchar *buf ) {
1031 gboolean valid, done;
1033 valid = done = FALSE;
1038 if( *p == ' ' || *p == ',' || *p == ';' || *p == '|' || *p < 32 ) {
1053 em = g_strndup( st, len );
1054 list = g_list_append( list, em );
1062 if( *p == '@' ) valid = TRUE;
1070 #define FULLNAME_BUFSIZE 256
1071 #define EMAIL_BUFSIZE 256
1074 * Process a single label entry field, parsing multiple e-mail address entries.
1076 * \param pilotFile JPilot control data.
1077 * \param labelEntry Label entry data.
1078 * \param person Person.
1080 static void jpilot_parse_label( JPilotFile *pilotFile, gchar *labelEntry, ItemPerson *person ) {
1081 gchar buffer[ EMAIL_BUFSIZE ];
1087 strcpy( buffer, labelEntry );
1088 node = list = jpilot_parse_email( buffer );
1090 email = addritem_create_item_email();
1091 addritem_email_set_address( email, node->data );
1092 addrcache_id_email( pilotFile->addressCache, email );
1093 addrcache_person_add_email( pilotFile->addressCache, person, email );
1094 node = g_list_next( node );
1096 mgu_free_dlist( list );
1102 * Unpack address, building new data inside cache.
1103 * \param pilotFile JPilot control data.
1104 * \param buf Record buffer.
1105 * \param folderInd Array of (category) folders to load.
1107 static void jpilot_load_address(
1108 JPilotFile *pilotFile, buf_rec *buf, ItemFolder *folderInd[] )
1110 struct Address addr;
1116 gchar fullName[ FULLNAME_BUFSIZE ];
1122 struct AddressAppInfo *ai;
1124 /* Retrieve address */
1125 num = unpack_Address( & addr, buf->buf, buf->size );
1127 addrEnt = addr.entry;
1128 attrib = buf->attrib;
1129 unique_id = buf->unique_id;
1130 cat_id = attrib & 0x0F;
1133 if( addrEnt[ IND_LABEL_FIRSTNAME ] ) {
1134 strcat( fullName, addrEnt[ IND_LABEL_FIRSTNAME ] );
1137 if( addrEnt[ IND_LABEL_LASTNAME ] ) {
1138 strcat( fullName, " " );
1139 strcat( fullName, addrEnt[ IND_LABEL_LASTNAME ] );
1141 g_strchug( fullName );
1142 g_strchomp( fullName );
1144 person = addritem_create_item_person();
1145 addritem_person_set_common_name( person, fullName );
1146 addritem_person_set_first_name( person, addrEnt[ IND_LABEL_FIRSTNAME ] );
1147 addritem_person_set_last_name( person, addrEnt[ IND_LABEL_LASTNAME ] );
1148 addrcache_id_person( pilotFile->addressCache, person );
1150 extID = g_strdup_printf( "%d", unique_id );
1151 addritem_person_set_external_id( person, extID );
1155 /* Pointer to address metadata. */
1156 ai = & pilotFile->addrInfo;
1158 /* Add entry for each email address listed under phone labels. */
1159 indPhoneLbl = addr.phoneLabel;
1160 for( k = 0; k < JPILOT_NUM_ADDR_PHONE; k++ ) {
1162 ind = indPhoneLbl[k];
1164 * fprintf( stdout, "%d : %d : %20s : %s\n", k, ind,
1165 * ai->phoneLabels[ind], addrEnt[3+k] );
1167 if( indPhoneLbl[k] == IND_PHONE_EMAIL ) {
1168 labelEntry = addrEnt[ OFFSET_PHONE_LABEL + k ];
1169 jpilot_parse_label( pilotFile, labelEntry, person );
1173 /* Add entry for each custom label */
1174 node = pilotFile->labelInd;
1177 ind = GPOINTER_TO_INT( node->data );
1180 * fprintf( stdout, "%d : %20s : %s\n", ind, ai->labels[ind],
1183 labelEntry = addrEnt[ind];
1184 jpilot_parse_label( pilotFile, labelEntry, person );
1187 node = g_list_next( node );
1190 if( person->listEMail ) {
1191 if( cat_id > -1 && cat_id < JPILOT_NUM_CATEG ) {
1192 /* Add to specified category */
1193 addrcache_folder_add_person(
1194 pilotFile->addressCache,
1195 folderInd[cat_id], person );
1198 /* Add to root folder */
1199 addrcache_add_person(
1200 pilotFile->addressCache, person );
1204 addritem_free_item_person( person );
1209 /* Free up pointer allocated inside address */
1210 free_Address( & addr );
1214 * Free up address list.
1215 * \param records List of records to free.
1217 static void jpilot_free_addrlist( GList *records ) {
1227 node = g_list_next( node );
1231 g_list_free( records );
1235 * Read metadata from file.
1236 * \param pilotFile JPilot control data.
1237 * \return Status/error code. <code>MGU_SUCCESS</code> if data read
1240 static gint jpilot_read_metadata( JPilotFile *pilotFile ) {
1242 unsigned int rec_size;
1246 g_return_val_if_fail( pilotFile != NULL, -1 );
1248 pilotFile->readMetadata = FALSE;
1249 addrcache_clear( pilotFile->addressCache );
1251 /* Read file info */
1252 retVal = jpilot_get_file_info( pilotFile, &buf, &rec_size);
1253 if( retVal != MGU_SUCCESS ) {
1254 pilotFile->retVal = retVal;
1255 return pilotFile->retVal;
1258 num = unpack_AddressAppInfo( &pilotFile->addrInfo, buf, rec_size );
1263 pilotFile->retVal = MGU_ERROR_READ;
1264 return pilotFile->retVal;
1267 pilotFile->readMetadata = TRUE;
1268 pilotFile->retVal = MGU_SUCCESS;
1269 return pilotFile->retVal;
1273 * Setup labels and indexes from metadata.
1274 * \param pilotFile JPilot control data.
1275 * \return <i>TRUE</i> is setup successfully.
1277 static gboolean jpilot_setup_labels( JPilotFile *pilotFile ) {
1278 gboolean retVal = FALSE;
1279 struct AddressAppInfo *ai;
1282 g_return_val_if_fail( pilotFile != NULL, -1 );
1284 /* Release indexes */
1285 node = pilotFile->labelInd;
1288 node = g_list_next( node );
1290 pilotFile->labelInd = NULL;
1292 if( pilotFile->readMetadata ) {
1293 ai = & pilotFile->addrInfo;
1294 node = pilotFile->customLabels;
1296 gchar *lbl = node->data;
1299 for( i = 0; i < JPILOT_NUM_LABELS; i++ ) {
1300 gchar *labelName = ai->labels[i];
1301 if( g_strcasecmp( labelName, lbl ) == 0 ) {
1306 pilotFile->labelInd = g_list_append(
1307 pilotFile->labelInd, GINT_TO_POINTER(ind) );
1308 node = g_list_next( node );
1316 * Load list with character strings of label names.
1317 * \param pilotFile JPilot control data.
1318 * \param labelList List of label names to load.
1319 * \return List of label names loaded.
1321 GList *jpilot_load_label( JPilotFile *pilotFile, GList *labelList ) {
1324 g_return_val_if_fail( pilotFile != NULL, NULL );
1326 if( pilotFile->readMetadata ) {
1327 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1328 for( i = 0; i < JPILOT_NUM_LABELS; i++ ) {
1329 gchar *labelName = ai->labels[i];
1331 labelList = g_list_append(
1332 labelList, g_strdup( labelName ) );
1335 labelList = g_list_append(
1336 labelList, g_strdup( "" ) );
1344 * Return category name for specified category ID.
1345 * \param pilotFile JPilot control data.
1346 * \param catID Category ID.
1347 * \return Category name, or empty string if not invalid ID. Name should be
1348 * <code>g_free()</code> when done.
1350 gchar *jpilot_get_category_name( JPilotFile *pilotFile, gint catID ) {
1351 gchar *catName = NULL;
1353 g_return_val_if_fail( pilotFile != NULL, NULL );
1355 if( pilotFile->readMetadata ) {
1356 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1357 struct CategoryAppInfo *cat = & ai->category;
1358 if( catID < 0 || catID > JPILOT_NUM_CATEG ) {
1361 catName = g_strdup( cat->name[catID] );
1364 if( ! catName ) catName = g_strdup( "" );
1369 * Load list with character strings of phone label names.
1370 * \param pilotFile JPilot control data.
1371 * \param labelList List of label names to load.
1372 * \return List of label names loaded.
1374 GList *jpilot_load_phone_label( JPilotFile *pilotFile, GList *labelList ) {
1377 g_return_val_if_fail( pilotFile != NULL, NULL );
1379 if( pilotFile->readMetadata ) {
1380 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1381 for( i = 0; i < JPILOT_NUM_PHONELABELS; i++ ) {
1382 gchar *labelName = ai->phoneLabels[i];
1384 labelList = g_list_append(
1385 labelList, g_strdup( labelName ) );
1388 labelList = g_list_append(
1389 labelList, g_strdup( "" ) );
1397 * Load list with character strings of custom label names. Only none blank
1399 * \param pilotFile JPilot control data.
1400 * \param labelList List of label names to load.
1401 * \return List of label names loaded. Should be freed when done.
1403 GList *jpilot_load_custom_label( JPilotFile *pilotFile, GList *labelList ) {
1406 g_return_val_if_fail( pilotFile != NULL, NULL );
1408 if( pilotFile->readMetadata ) {
1409 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1410 for( i = 0; i < NUM_CUSTOM_LABEL; i++ ) {
1411 gchar *labelName = ai->labels[i+IND_CUSTOM_LABEL];
1413 g_strchomp( labelName );
1414 g_strchug( labelName );
1415 if( *labelName != '\0' ) {
1416 labelList = g_list_append( labelList,
1417 g_strdup( labelName ) );
1426 * Load list with character strings of category names.
1427 * \param pilotFile JPilot control data.
1428 * \return List of label names loaded. Should be freed when done.
1430 GList *jpilot_get_category_list( JPilotFile *pilotFile ) {
1431 GList *catList = NULL;
1434 g_return_val_if_fail( pilotFile != NULL, NULL );
1436 if( pilotFile->readMetadata ) {
1437 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1438 struct CategoryAppInfo *cat = & ai->category;
1439 for( i = 0; i < JPILOT_NUM_CATEG; i++ ) {
1440 gchar *catName = cat->name[i];
1442 catList = g_list_append(
1443 catList, g_strdup( catName ) );
1446 catList = g_list_append(
1447 catList, g_strdup( "" ) );
1455 * Build folder in address book for each category.
1456 * \param pilotFile JPilot control data.
1458 static void jpilot_build_category_list( JPilotFile *pilotFile ) {
1459 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1460 struct CategoryAppInfo *cat = & ai->category;
1463 for( i = 0; i < JPILOT_NUM_CATEG; i++ ) {
1464 ItemFolder *folder = addritem_create_item_folder();
1465 addritem_folder_set_name( folder, cat->name[i] );
1466 addrcache_id_folder( pilotFile->addressCache, folder );
1467 addrcache_add_folder( pilotFile->addressCache, folder );
1472 * Remove empty (category) folders.
1473 * \param pilotFile JPilot control data.
1475 static void jpilot_remove_empty( JPilotFile *pilotFile ) {
1481 listFolder = addrcache_get_list_folder( pilotFile->addressCache );
1485 ItemFolder *folder = node->data;
1486 if( ADDRITEM_NAME(folder) == NULL || *ADDRITEM_NAME(folder) == '\0' ) {
1487 if( folder->listPerson ) {
1488 /* Give name to folder */
1490 sprintf( name, "? %d", i );
1491 addritem_folder_set_name( folder, name );
1494 /* Mark for removal */
1495 remList = g_list_append( remList, folder );
1498 node = g_list_next( node );
1503 ItemFolder *folder = node->data;
1504 addrcache_remove_folder( pilotFile->addressCache, folder );
1505 node = g_list_next( node );
1507 g_list_free( remList );
1511 * Read address file into address cache.
1512 * \param pilotFile JPilot control data.
1513 * \return Error/status code. <code>MGU_SUCCESS</code> if data read
1516 static gint jpilot_read_file( JPilotFile *pilotFile ) {
1518 GList *records = NULL;
1521 ItemFolder *folderInd[ JPILOT_NUM_CATEG ];
1523 /* Read list of records from JPilot files */
1524 retVal = jpilot_read_db_files( pilotFile, &records );
1525 if( retVal != MGU_SUCCESS ) {
1526 jpilot_free_addrlist( records );
1530 /* Setup labels and category folders */
1531 jpilot_setup_labels( pilotFile );
1532 jpilot_build_category_list( pilotFile );
1534 /* Build array of pointers to categories */
1536 node = addrcache_get_list_folder( pilotFile->addressCache );
1538 if( i < JPILOT_NUM_CATEG ) {
1539 folderInd[i] = node->data;
1541 node = g_list_next( node );
1545 /* Load all addresses, free up old stuff as we go */
1549 if( ( br->rt != DELETED_PC_REC ) &&
1550 ( br->rt != DELETED_PALM_REC ) &&
1551 ( br->rt != MODIFIED_PALM_REC ) &&
1552 ( br->rt != DELETED_DELETED_PALM_REC ) ) {
1553 jpilot_load_address( pilotFile, br, folderInd );
1558 node = g_list_next( node );
1562 g_list_free( records );
1564 /* Remove empty category folders */
1565 jpilot_remove_empty( pilotFile );
1566 jpilot_mark_files( pilotFile );
1572 * Read file into list. Main entry point
1573 * \param pilotFile JPilot control data.
1574 * \return Error/status code. <code>MGU_SUCCESS</code> if data read
1577 gint jpilot_read_data( JPilotFile *pilotFile ) {
1578 g_return_val_if_fail( pilotFile != NULL, -1 );
1580 pilotFile->retVal = MGU_SUCCESS;
1581 pilotFile->addressCache->accessFlag = FALSE;
1582 if( jpilot_check_files( pilotFile ) ) {
1583 addrcache_clear( pilotFile->addressCache );
1584 jpilot_read_metadata( pilotFile );
1585 if( pilotFile->retVal == MGU_SUCCESS ) {
1586 pilotFile->retVal = jpilot_read_file( pilotFile );
1587 if( pilotFile->retVal == MGU_SUCCESS ) {
1588 pilotFile->addressCache->modified = FALSE;
1589 pilotFile->addressCache->dataRead = TRUE;
1593 return pilotFile->retVal;
1597 * Return linked list of persons. This is a list of references to ItemPerson
1598 * objects. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
1599 * functions... this will destroy the addressbook data!
1601 * \param pilotFile JPilot control data.
1602 * \return List of persons.
1604 GList *jpilot_get_list_person( JPilotFile *pilotFile ) {
1605 g_return_val_if_fail( pilotFile != NULL, NULL );
1606 return addrcache_get_list_person( pilotFile->addressCache );
1610 * Return linked list of folders. This is a list of references to non-empty
1611 * category folders. Do <b>NOT</b> attempt to use the
1612 * <code>addrbook_free_xxx()</code> functions... this will destroy the
1615 * \param pilotFile JPilot control data.
1616 * \return List of ItemFolder objects. This should not be freed.
1618 GList *jpilot_get_list_folder( JPilotFile *pilotFile ) {
1619 g_return_val_if_fail( pilotFile != NULL, NULL );
1620 return addrcache_get_list_folder( pilotFile->addressCache );
1624 * Return linked list of all persons. Note that the list contains references
1625 * to items. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
1626 * functions... this will destroy the addressbook data!
1628 * \param pilotFile JPilot control data.
1629 * \return List of items, or NULL if none.
1631 GList *jpilot_get_all_persons( JPilotFile *pilotFile ) {
1632 g_return_val_if_fail( pilotFile != NULL, NULL );
1633 return addrcache_get_all_persons( pilotFile->addressCache );
1637 * Validate that all parameters specified.
1638 * \param pilotFile JPilot control data.
1639 * \return <i>TRUE</i> if data is good.
1641 gboolean jpilot_validate( JPilotFile *pilotFile ) {
1645 g_return_val_if_fail( pilotFile != NULL, FALSE );
1648 if( pilotFile->path ) {
1649 if( strlen( pilotFile->path ) < 1 ) retVal = FALSE;
1654 name = jpilot_get_name( pilotFile );
1656 if( strlen( name ) < 1 ) retVal = FALSE;
1664 #define WORK_BUFLEN 1024
1667 * Attempt to find a valid JPilot file.
1668 * \param pilotFile JPilot control data.
1669 * \return Filename, or home directory if not found, or empty string if
1670 * no home. Filename should be <code>g_free()</code> when done.
1672 gchar *jpilot_find_pilotdb( void ) {
1674 gchar str[ WORK_BUFLEN ];
1678 homedir = g_get_home_dir();
1679 if( ! homedir ) return g_strdup( "" );
1681 strcpy( str, homedir );
1682 len = strlen( str );
1684 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
1685 str[ len ] = G_DIR_SEPARATOR;
1686 str[ ++len ] = '\0';
1689 strcat( str, JPILOT_DBHOME_DIR );
1690 strcat( str, G_DIR_SEPARATOR_S );
1691 strcat( str, JPILOT_DBHOME_FILE );
1693 /* Attempt to open */
1694 if( ( fp = fopen( str, "rb" ) ) != NULL ) {
1698 /* Truncate filename */
1701 return g_strdup( str );
1705 * Attempt to read file, testing for valid JPilot format.
1706 * \param fileSpec File specification to read.
1707 * \return <i>TRUE<i> if file appears to be valid format.
1709 gint jpilot_test_read_file( const gchar *fileSpec ) {
1710 JPilotFile *pilotFile;
1714 pilotFile = jpilot_create_path( fileSpec );
1715 retVal = jpilot_read_metadata( pilotFile );
1716 jpilot_free( pilotFile );
1720 retVal = MGU_NO_FILE;
1726 * Check whether label is in list of custom labels.
1727 * \param pilotFile JPilot control data.
1728 * \param labelName to test.
1729 * \return <i>TRUE</i> if found.
1731 gboolean jpilot_test_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
1735 g_return_val_if_fail( pilotFile != NULL, FALSE );
1739 node = pilotFile->customLabels;
1741 if( g_strcasecmp( labelName, ( gchar * ) node->data ) == 0 ) {
1745 node = g_list_next( node );
1752 * Test whether pilot link library installed.
1753 * \return <i>TRUE</i> if library available.
1755 gboolean jpilot_test_pilot_lib( void ) {
1759 #endif /* USE_JPILOT */