src/jpilot.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001-2012 Match Grun and the Claws Mail team
   4  *
   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.
   9  *
  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.
  14  *
  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/>.
  17  *
  18  */
  19
  20 /*
  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.
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 #  include "config.h"
  28 #include "claws-features.h"
  29 #endif
  30
  31 #ifdef USE_JPILOT
  32
  33 #include <glib.h>
  34 #include <time.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <sys/stat.h>
  39 #include <netinet/in.h>
  40
  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>
  46 #else
  47 #  include <pi-args.h>
  48 #  include <pi-appinfo.h>
  49 #  include <pi-address.h>
  50 #  include <pi-version.h>
  51 #endif
  52
  53 #include "mgutils.h"
  54 #include "addritem.h"
  55 #include "addrcache.h"
  56 #include "jpilot.h"
  57 #include "codeconv.h"
  58 #include "adbookbase.h"
  59 #include "utils.h"
  60
  61 #define JPILOT_DBHOME_DIR   ".jpilot"
  62 #define JPILOT_DBHOME_FILE  "AddressDB.pdb"
  63 #define PILOT_LINK_LIB_NAME "libpisock.so"
  64
  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 */
  71
  72 /* Shamelessly copied from JPilot (libplugin.h) */
  73 typedef struct {
  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];
  88 } RawDBHeader;
  89
  90 /* Shamelessly copied from JPilot (libplugin.h) */
  91 typedef struct {
  92         char db_name[32];
  93         unsigned int flags;
  94         unsigned int version;
  95         time_t creation_time;
  96         time_t modification_time;
  97         time_t backup_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;
 106 } DBHeader;
 107
 108 /* Shamelessly copied from JPilot (libplugin.h) */
 109 typedef struct {
 110         unsigned char Offset[4];  /*4 bytes offset from BOF to record */
 111         unsigned char attrib;
 112         unsigned char unique_ID[3];
 113 } record_header;
 114
 115 /* Shamelessly copied from JPilot (libplugin.h) */
 116 typedef struct mem_rec_header_s {
 117         unsigned int rec_num;
 118         unsigned int offset;
 119         unsigned int unique_id;
 120         unsigned char attrib;
 121         struct mem_rec_header_s *next;
 122 } mem_rec_header;
 123
 124 /* Shamelessly copied from JPilot (libplugin.h) */
 125 #define SPENT_PC_RECORD_BIT     256
 126
 127 typedef enum {
 128         PALM_REC = 100L,
 129         MODIFIED_PALM_REC = 101L,
 130         DELETED_PALM_REC = 102L,
 131         NEW_PC_REC = 103L,
 132         DELETED_PC_REC = SPENT_PC_RECORD_BIT + 104L,
 133         DELETED_DELETED_PALM_REC = SPENT_PC_RECORD_BIT + 105L
 134 } PCRecType;
 135
 136 /* Shamelessly copied from JPilot (libplugin.h) */
 137 typedef struct {
 138         PCRecType rt;
 139         unsigned int unique_id;
 140         unsigned char attrib;
 141         void *buf;
 142         int size;
 143 } buf_rec;
 144
 145 /* Shamelessly copied from JPilot (libplugin.h) */
 146 typedef struct {
 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;
 153 } PC3RecordHeader;
 154
 155 enum {
 156         FAMILY_LAST = 0,
 157         FAMILY_FIRST = 1
 158 } name_order;
 159
 160 gboolean convert_charcode = TRUE;
 161
 162 static const gchar *jpilot_get_charset(void)
 163 {
 164         static const gchar *charset = NULL;
 165
 166         if (charset == NULL)
 167                 charset = getenv("PILOT_CHARSET");
 168
 169         if (charset == NULL)
 170                 charset = CS_CP1252;
 171
 172         return charset;
 173 }
 174
 175 /*
 176 * Create new pilot file object.
 177 * \return Initialized JPilot file object.
 178 */
 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;
 185
 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;
 193         return pilotFile;
 194 }
 195
 196 /**
 197  * Create new pilot file object for specified file.
 198  * \param path Path to JPilot address book.
 199  * \return Initialized JPilot file object.
 200  */
 201 JPilotFile *jpilot_create_path( const gchar *path ) {
 202         JPilotFile *pilotFile;
 203         pilotFile = jpilot_create();
 204         jpilot_set_file( pilotFile, path );
 205         return pilotFile;
 206 }
 207
 208 /*
 209 * Properties...
 210 */
 211 void jpilot_set_name( JPilotFile* pilotFile, const gchar *value ) {
 212         cm_return_if_fail( pilotFile != NULL );
 213         addrcache_set_name( pilotFile->addressCache, value );
 214 }
 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 );
 220 }
 221 void jpilot_set_accessed( JPilotFile *pilotFile, const gboolean value ) {
 222         cm_return_if_fail( pilotFile != NULL );
 223         pilotFile->addressCache->accessFlag = value;
 224 }
 225
 226 gint jpilot_get_status( JPilotFile *pilotFile ) {
 227         cm_return_val_if_fail( pilotFile != NULL, -1 );
 228         return pilotFile->retVal;
 229 }
 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 );
 233 }
 234 gchar *jpilot_get_name( JPilotFile *pilotFile ) {
 235         cm_return_val_if_fail( pilotFile != NULL, NULL );
 236         return addrcache_get_name( pilotFile->addressCache );
 237 }
 238
 239 /*
 240  * Test whether file was read.
 241  * \param pilotFile  JPilot control data.
 242  * \return <i>TRUE</i> if file was read.
 243  */
 244 gboolean jpilot_get_read_flag( JPilotFile *pilotFile ) {
 245         cm_return_val_if_fail( pilotFile != NULL, FALSE );
 246         return pilotFile->addressCache->dataRead;
 247 }
 248
 249 /**
 250  * Free up custom label list.
 251  * \param pilotFile  JPilot control data.
 252  */
 253 void jpilot_clear_custom_labels( JPilotFile *pilotFile ) {
 254         GList *node;
 255
 256         cm_return_if_fail( pilotFile != NULL );
 257
 258         /* Release custom labels */
 259         mgu_free_dlist( pilotFile->customLabels );
 260         pilotFile->customLabels = NULL;
 261
 262         /* Release indexes */
 263         node = pilotFile->labelInd;
 264         while( node ) {
 265                 node->data = NULL;
 266                 node = g_list_next( node );
 267         }
 268         g_list_free( pilotFile->labelInd );
 269         pilotFile->labelInd = NULL;
 270
 271         /* Force a fresh read */
 272         addrcache_refresh( pilotFile->addressCache );
 273 }
 274
 275 /**
 276  * Append a custom label, representing an E-Mail address field to the
 277  * custom label list.
 278  * \param pilotFile  JPilot control data.
 279  */
 280 void jpilot_add_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
 281         cm_return_if_fail( pilotFile != NULL );
 282
 283         if( labelName ) {
 284                 gchar *labelCopy = g_strdup( labelName );
 285                 g_strstrip( labelCopy );
 286                 if( *labelCopy == '\0' ) {
 287                         g_free( labelCopy );
 288                 }
 289                 else {
 290                         pilotFile->customLabels = g_list_append( pilotFile->customLabels, labelCopy );
 291                         /* Force a fresh read */
 292                         addrcache_refresh( pilotFile->addressCache );
 293                 }
 294         }
 295 }
 296
 297 /**
 298  * Get list of custom labels.
 299  * \param pilotFile  JPilot control data.
 300  * \return List of labels. Must use g_free() when done.
 301  */
 302 GList *jpilot_get_custom_labels( JPilotFile *pilotFile ) {
 303         GList *retVal = NULL;
 304         GList *node;
 305
 306         cm_return_val_if_fail( pilotFile != NULL, NULL );
 307
 308         node = pilotFile->customLabels;
 309         while( node ) {
 310                 retVal = g_list_append( retVal, g_strdup( node->data ) );
 311                 node = g_list_next( node );
 312         }
 313         return retVal;
 314 }
 315
 316 /**
 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.
 320  */
 321 static gchar *jpilot_get_pc3_file( JPilotFile *pilotFile ) {
 322         gchar *fileSpec, *r;
 323         gint i, len, pos;
 324
 325         if( pilotFile == NULL ) return NULL;
 326         if( pilotFile->path == NULL ) return NULL;
 327
 328         fileSpec = g_strdup( pilotFile->path );
 329         len = strlen( fileSpec );
 330         pos = -1;
 331         r = NULL;
 332         for( i = len; i > 0; i-- ) {
 333                 if( *(fileSpec + i) == '.' ) {
 334                         pos = i + 1;
 335                         r = fileSpec + pos;
 336                         break;
 337                 }
 338         }
 339         if( r ) {
 340                 if( len - pos == 3 ) {
 341                         *r++ = 'p'; *r++ = 'c'; *r = '3';
 342                         return fileSpec;
 343                 }
 344         }
 345         g_free( fileSpec );
 346         return NULL;
 347 }
 348
 349 /**
 350  * Save PC3 file time to cache.
 351  * \param pilotFile  JPilot control data.
 352  * \return <i>TRUE</i> if time marked.
 353  */
 354 static gboolean jpilot_mark_files( JPilotFile *pilotFile ) {
 355         gboolean retVal = FALSE;
 356         struct stat filestat;
 357         gchar *pcFile;
 358
 359         /* Mark PDB file cache */
 360         retVal = addrcache_mark_file( pilotFile->addressCache, pilotFile->path );
 361
 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;
 370                 retVal = TRUE;
 371         }
 372         g_free( pcFile );
 373         return retVal;
 374 }
 375
 376 /**
 377  * Check whether JPilot PDB or PC3 file has changed by comparing
 378  * with cached data.
 379  * \param pilotFile  JPilot control data.
 380  * \return <i>TRUE</i> if file has changed.
 381  */
 382 static gboolean jpilot_check_files( JPilotFile *pilotFile ) {
 383         gboolean retVal = TRUE;
 384         struct stat filestat;
 385         gchar *pcFile;
 386
 387         /* Check main file */
 388         if( addrcache_check_file( pilotFile->addressCache, pilotFile->path ) )
 389                 return TRUE;
 390
 391         /* Test PC3 file */
 392         if( ! pilotFile->havePC3 ) return FALSE;
 393         pcFile = jpilot_get_pc3_file( pilotFile );
 394         if( pcFile == NULL ) return FALSE;
 395
 396         if( 0 == g_stat( pcFile, &filestat ) ) {
 397                 if( filestat.st_mtime == pilotFile->pc3ModifyTime ) retVal = FALSE;
 398         }
 399         g_free( pcFile );
 400         return retVal;
 401 }
 402
 403 /*
 404 * Test whether file was modified since last access.
 405 * Return: TRUE if file was modified.
 406 */
 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;
 411 }
 412 gboolean jpilot_get_accessed( JPilotFile *pilotFile ) {
 413         cm_return_val_if_fail( pilotFile != NULL, FALSE );
 414         return pilotFile->addressCache->accessFlag;
 415 }
 416
 417 /**
 418  * Free up pilot file object by releasing internal memory.
 419  * \param pilotFile  JPilot control data.
 420  */
 421 void jpilot_free( JPilotFile *pilotFile ) {
 422         cm_return_if_fail( pilotFile != NULL );
 423
 424         /* Release custom labels */
 425         jpilot_clear_custom_labels( pilotFile );
 426
 427         /* Clear cache */
 428         addrcache_clear( pilotFile->addressCache );
 429         addrcache_free( pilotFile->addressCache );
 430
 431         /* Free internal stuff */
 432         g_free( pilotFile->path );
 433
 434         pilotFile->file = NULL;
 435         pilotFile->path = NULL;
 436         pilotFile->readMetadata = FALSE;
 437         pilotFile->havePC3 = FALSE;
 438         pilotFile->pc3ModifyTime = 0;
 439
 440         pilotFile->type = ADBOOKTYPE_NONE;
 441         pilotFile->addressCache = NULL;
 442         pilotFile->retVal = MGU_SUCCESS;
 443
 444         /* Now release file object */
 445         g_free( pilotFile );
 446 }
 447
 448 /* Shamelessly copied from JPilot (libplugin.c) */
 449 static unsigned int bytes_to_bin(unsigned char *bytes, unsigned int num_bytes) {
 450 unsigned int i, n;
 451         n=0;
 452         for (i=0;i<num_bytes;i++) {
 453                 n = n*256+bytes[i];
 454         }
 455         return n;
 456 }
 457
 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)
 462
 463 static time_t pilot_time_to_unix_time ( unsigned long raw_time ) {
 464    return (time_t)(raw_time - PILOT_TIME_DELTA);
 465 }
 466
 467 /* Shamelessly copied from JPilot (libplugin.c) */
 468 static int raw_header_to_header(RawDBHeader *rdbh, DBHeader *dbh) {
 469         unsigned long temp;
 470
 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);
 485         dbh->type[4] = '\0';
 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);
 492         return 0;
 493 }
 494
 495 /* Shamelessly copied from JPilot (libplugin.c) */
 496 /* returns 1 if found */
 497 /*         0 if eof */
 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 )
 500 {
 501         mem_rec_header *temp_mem_rh;
 502         unsigned char found = 0;
 503         unsigned long found_at;
 504
 505         found_at=0xFFFFFF;
 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; */
 511                 }
 512                 if ((temp_mem_rh->offset == fpos)) {
 513                         found = 1;
 514                         *attrib = temp_mem_rh->attrib;
 515                         *unique_id = temp_mem_rh->unique_id;
 516                 }
 517         }
 518         *next_offset = found_at;
 519         return found;
 520 }
 521
 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) {
 526                 next_h=h->next;
 527                 free(h);
 528         }
 529         *mem_rh = NULL;
 530 }
 531
 532 /* Shamelessly copied from JPilot (libplugin.c) */
 533 /* Read file size */
 534 static int jpilot_get_info_size( FILE *in, int *size ) {
 535         RawDBHeader rdbh;
 536         DBHeader dbh;
 537         unsigned int offset;
 538         record_header rh;
 539         int r;
 540
 541         fseek(in, 0, SEEK_SET);
 542         r = fread(&rdbh, sizeof(RawDBHeader), 1, in);
 543         if (feof(in)) {
 544                 return MGU_EOF;
 545         }
 546
 547         raw_header_to_header(&rdbh, &dbh);
 548         if (dbh.app_info_offset==0) {
 549                 *size=0;
 550                 return MGU_SUCCESS;
 551         }
 552         if (dbh.sort_info_offset!=0) {
 553                 *size = dbh.sort_info_offset - dbh.app_info_offset;
 554                 return MGU_SUCCESS;
 555         }
 556         if (dbh.number_of_records==0) {
 557                 fseek(in, 0, SEEK_END);
 558                 *size=ftell(in) - dbh.app_info_offset;
 559                 return MGU_SUCCESS;
 560         }
 561
 562         r = fread(&rh, sizeof(record_header), 1, in);
 563         if (r < 1)
 564                 return MGU_ERROR_READ;
 565
 566         offset = ((rh.Offset[0]*256+rh.Offset[1])*256+rh.Offset[2])*256+rh.Offset[3];
 567         *size=offset - dbh.app_info_offset;
 568
 569         return MGU_SUCCESS;
 570 }
 571
 572 /*
 573  * Read address file into address list. Based on JPilot's
 574  * libplugin.c (jp_get_app_info)
 575  */
 576 static gint jpilot_get_file_info( JPilotFile *pilotFile, unsigned char **buf, int *buf_size ) {
 577         FILE *in;
 578         int num;
 579         unsigned int rec_size;
 580         RawDBHeader rdbh;
 581         DBHeader dbh;
 582
 583         if( ( !buf_size ) || ( ! buf ) ) {
 584                 return MGU_BAD_ARGS;
 585         }
 586
 587         *buf = NULL;
 588         *buf_size=0;
 589
 590         if( pilotFile->path ) {
 591                 in = g_fopen( pilotFile->path, "rb" );
 592                 if( !in ) {
 593                         return MGU_OPEN_FILE;
 594                 }
 595         }
 596         else {
 597                 return MGU_NO_FILE;
 598         }
 599
 600         num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
 601         if( num != 1 ) {
 602                 if( ferror(in) ) {
 603                         fclose(in);
 604                         return MGU_ERROR_READ;
 605                 }
 606         }
 607         if (feof(in)) {
 608                 fclose(in);
 609                 return MGU_EOF;
 610         }
 611
 612         /* Convert header into something recognizable */
 613         raw_header_to_header(&rdbh, &dbh);
 614
 615         num = jpilot_get_info_size(in, &rec_size);
 616         if (num) {
 617                 fclose(in);
 618                 return MGU_ERROR_READ;
 619         }
 620
 621         fseek(in, dbh.app_info_offset, SEEK_SET);
 622         *buf = ( char * ) malloc(rec_size);
 623         if (!(*buf)) {
 624                 fclose(in);
 625                 return MGU_OO_MEMORY;
 626         }
 627         num = fread(*buf, rec_size, 1, in);
 628         if (num != 1) {
 629                 if (ferror(in)) {
 630                         fclose(in);
 631                         free(*buf);
 632                         return MGU_ERROR_READ;
 633                 }
 634         }
 635         fclose(in);
 636
 637         *buf_size = rec_size;
 638
 639         return MGU_SUCCESS;
 640 }
 641
 642 /* Shamelessly copied from JPilot (libplugin.c) */
 643 static int unpack_header(PC3RecordHeader *header, unsigned char *packed_header) {
 644         unsigned char *p;
 645         guint32 l;
 646
 647         p = packed_header;
 648
 649         memcpy(&l, p, sizeof(l));
 650         header->header_len=ntohl(l);
 651         p+=sizeof(l);
 652
 653         memcpy(&l, p, sizeof(l));
 654         header->header_version=ntohl(l);
 655         p+=sizeof(l);
 656
 657         memcpy(&l, p, sizeof(l));
 658         header->rec_len=ntohl(l);
 659         p+=sizeof(l);
 660
 661         memcpy(&l, p, sizeof(l));
 662         header->unique_id=ntohl(l);
 663         p+=sizeof(l);
 664
 665         memcpy(&l, p, sizeof(l));
 666         header->rt=ntohl(l);
 667         p+=sizeof(l);
 668
 669         memcpy(&(header->attrib), p, sizeof(unsigned char));
 670         p+=sizeof(unsigned char);
 671
 672         return 0;
 673 }
 674
 675 /* Shamelessly copied from JPilot (libplugin.c) */
 676 static int read_header(FILE *pc_in, PC3RecordHeader *header) {
 677         guint32 l;
 678         unsigned long len;
 679         unsigned char packed_header[256];
 680         int num;
 681
 682         memset(header, 0, sizeof(PC3RecordHeader));
 683
 684         num = fread(&l, sizeof(l), 1, pc_in);
 685         if (feof(pc_in)) {
 686                 return -1;
 687         }
 688         if (num!=1) {
 689                 return num;
 690         }
 691         memcpy(packed_header, &l, sizeof(l));
 692         len=ntohl(l);
 693         if (len > 255) {
 694                 return -1;
 695         }
 696         num = fread(packed_header+sizeof(l), len-sizeof(l), 1, pc_in);
 697         if (feof(pc_in)) {
 698                 return -1;
 699         }
 700         if (num!=1) {
 701                 return num;
 702         }
 703         unpack_header(header, packed_header);
 704         return 1;
 705 }
 706
 707 /**
 708  * Read next record from PC3 file. Based on JPilot function
 709  * <code>pc_read_next_rec()</code> (libplugin.c)
 710  *
 711  * \param in File handle.
 712  * \param br Record buffer.
 713  * \return Status/error code. <code>MGU_SUCCESS</code> if data read
 714  *         successfully.
 715  */
 716 static gint jpilot_read_next_pc( FILE *in, buf_rec *br ) {
 717         PC3RecordHeader header;
 718         int rec_len, num;
 719         char *record;
 720
 721         if( feof( in ) ) {
 722                 return MGU_EOF;
 723         }
 724         num = read_header( in, &header );
 725         if( num < 1 ) {
 726                 if( ferror( in ) )
 727                         return MGU_ERROR_READ;
 728                 else if( feof( in ) )
 729                         return MGU_EOF;
 730                 else
 731                         return -1;
 732         }
 733         rec_len = header.rec_len;
 734         record = malloc( rec_len );
 735         if( ! record ) {
 736                 return MGU_OO_MEMORY;
 737         }
 738         num = fread( record, rec_len, 1, in );
 739         if( num != 1 ) {
 740                 if( ferror( in ) ) {
 741                         free( record );
 742                         return MGU_ERROR_READ;
 743                 }
 744         }
 745         br->rt = header.rt;
 746         br->unique_id = header.unique_id;
 747         br->attrib = header.attrib;
 748         br->buf = record;
 749         br->size = rec_len;
 750
 751         return MGU_SUCCESS;
 752 }
 753
 754 /**
 755  * Read address file into a linked list. Based on JPilot function
 756  * <code>jp_read_DB_files()</code> (from libplugin.c)
 757  *
 758  * \param pilotFile  JPilot control data.
 759  * \param records Pointer to linked list of records read.
 760  * \return Status/error code. <code>MGU_SUCCESS</code> if data read
 761  *         successfully.
 762  */
 763 static gint jpilot_read_db_files( JPilotFile *pilotFile, GList **records ) {
 764         FILE *in, *pc_in;
 765         char *buf;
 766         GList *temp_list;
 767         int num_records, recs_returned, i, num, r;
 768         unsigned int offset, prev_offset, next_offset = 0, rec_size;
 769         int out_of_order;
 770         long fpos;  /*file position indicator */
 771         unsigned char attrib = '\0';
 772         unsigned int unique_id = 0;
 773         mem_rec_header *mem_rh, *temp_mem_rh, *last_mem_rh;
 774         record_header rh;
 775         RawDBHeader rdbh;
 776         DBHeader dbh;
 777         buf_rec *temp_br;
 778         gchar *pcFile;
 779
 780         mem_rh = last_mem_rh = NULL;
 781         *records = NULL;
 782         recs_returned = 0;
 783
 784         if( pilotFile->path == NULL ) {
 785                 return MGU_BAD_ARGS;
 786         }
 787
 788         in = g_fopen( pilotFile->path, "rb" );
 789         if (!in) {
 790                 return MGU_OPEN_FILE;
 791         }
 792
 793         /* Read the database header */
 794         num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
 795         if( num != 1 ) {
 796                 if( ferror( in ) ) {
 797                         fclose( in );
 798                         return MGU_ERROR_READ;
 799                 }
 800                 if( feof( in ) ) {
 801                         fclose( in );
 802                         return MGU_EOF;
 803                 }
 804         }
 805         raw_header_to_header( &rdbh, &dbh );
 806
 807         /* Read each record entry header */
 808         num_records = dbh.number_of_records;
 809         out_of_order = 0;
 810         prev_offset = 0;
 811
 812         for( i = 1; i < num_records + 1; i++ ) {
 813                 num = fread( &rh, sizeof( record_header ), 1, in );
 814                 if( num != 1 ) {
 815                         if( ferror( in ) ) {
 816                                 break;
 817                         }
 818                         if( feof( in ) ) {
 819                                 fclose( in );
 820                                 return MGU_EOF;
 821                         }
 822                 }
 823
 824                 offset =
 825                         ( ( rh.Offset[0] * 256 + rh.Offset[1] ) * 256
 826                         + rh.Offset[2] ) * 256
 827                         + rh.Offset[3];
 828                 if( offset < prev_offset ) {
 829                         out_of_order = 1;
 830                 }
 831                 prev_offset = offset;
 832                 temp_mem_rh = ( mem_rec_header * ) malloc( sizeof( mem_rec_header ) );
 833                 if( ! temp_mem_rh ) {
 834                         break;
 835                 }
 836                 temp_mem_rh->next = NULL;
 837                 temp_mem_rh->rec_num = i;
 838                 temp_mem_rh->offset = offset;
 839                 temp_mem_rh->attrib = rh.attrib;
 840                 temp_mem_rh->unique_id =
 841                         ( rh.unique_ID[0] * 256 + rh.unique_ID[1] ) * 256
 842                         + rh.unique_ID[2];
 843                 if( mem_rh == NULL ) {
 844                         mem_rh = temp_mem_rh;
 845                         last_mem_rh = temp_mem_rh;
 846                 }
 847                 else {
 848                         last_mem_rh->next = temp_mem_rh;
 849                         last_mem_rh = temp_mem_rh;
 850                 }
 851         }
 852
 853         temp_mem_rh = mem_rh;
 854
 855         if( num_records ) {
 856                 if( out_of_order ) {
 857                         find_next_offset(
 858                                 mem_rh, 0, &next_offset, &attrib, &unique_id );
 859                 }
 860                 else {
 861                         if( mem_rh ) {
 862                                 next_offset = mem_rh->offset;
 863                                 attrib = mem_rh->attrib;
 864                                 unique_id = mem_rh->unique_id;
 865                         }
 866                 }
 867                 fseek( in, next_offset, SEEK_SET );
 868                 while( ! feof( in ) ) {
 869                         fpos = ftell( in );
 870                         if( out_of_order ) {
 871                                 find_next_offset(
 872                                         mem_rh, fpos, &next_offset, &attrib,
 873                                         &unique_id );
 874                         } else {
 875                                 next_offset = 0xFFFFFF;
 876                                 if( temp_mem_rh ) {
 877                                         attrib = temp_mem_rh->attrib;
 878                                         unique_id = temp_mem_rh->unique_id;
 879                                         if ( temp_mem_rh->next ) {
 880                                                 temp_mem_rh = temp_mem_rh->next;
 881                                                 next_offset = temp_mem_rh->offset;
 882                                         }
 883                                 }
 884                         }
 885                         rec_size = next_offset - fpos;
 886                         buf = malloc( rec_size );
 887                         if( ! buf ) break;
 888                         num = fread( buf, rec_size, 1, in );
 889                         if( ( num != 1 ) ) {
 890                                 if( ferror( in ) ) {
 891                                         free( buf );
 892                                         break;
 893                                 }
 894                         }
 895
 896                         temp_br = malloc( sizeof( buf_rec ) );
 897                         if( ! temp_br ) {
 898                                 free( buf );
 899                                 break;
 900                         }
 901                         temp_br->rt = PALM_REC;
 902                         temp_br->unique_id = unique_id;
 903                         temp_br->attrib = attrib;
 904                         temp_br->buf = buf;
 905                         temp_br->size = rec_size;
 906
 907                         *records = g_list_append( *records, temp_br );
 908
 909                         recs_returned++;
 910                 }
 911         }
 912         fclose( in );
 913         free_mem_rec_header( &mem_rh );
 914
 915         /* Read the PC3 file, if present */
 916         pcFile = jpilot_get_pc3_file( pilotFile );
 917         if( pcFile == NULL ) return MGU_SUCCESS;
 918         pc_in = g_fopen( pcFile, "rb");
 919         g_free( pcFile );
 920
 921         if( pc_in == NULL ) {
 922                 return MGU_SUCCESS;
 923         }
 924
 925         while( ! feof( pc_in ) ) {
 926                 gboolean linked;
 927
 928                 temp_br = malloc( sizeof( buf_rec ) );
 929                 if( ! temp_br ) {
 930                         break;
 931                 }
 932                 r = jpilot_read_next_pc( pc_in, temp_br );
 933                 if( r != MGU_SUCCESS ) {
 934                         if( (r != MGU_EOF) && (r != MGU_ERROR_READ) ) {
 935                                 free( temp_br->buf );
 936                         }
 937                         free( temp_br );
 938                         break;
 939                 }
 940
 941                 linked = FALSE;
 942                 if( ( temp_br->rt != DELETED_PC_REC )
 943                  && ( temp_br->rt != DELETED_PALM_REC )
 944                  && ( temp_br->rt != MODIFIED_PALM_REC )
 945                  && ( temp_br->rt != DELETED_DELETED_PALM_REC ) )
 946                 {
 947                         *records = g_list_append( *records, temp_br );
 948                         recs_returned++;
 949                         linked = TRUE;
 950                 }
 951
 952                 if( ( temp_br->rt == DELETED_PALM_REC )
 953                  || ( temp_br->rt == MODIFIED_PALM_REC ) )
 954                 {
 955                         temp_list = *records;
 956                         if( *records ) {
 957                                 while( temp_list->next ) {
 958                                         temp_list=temp_list->next;
 959                                 }
 960                         }
 961                         for( ; temp_list; temp_list=temp_list->prev ) {
 962                                 if( ( ( buf_rec * )temp_list->data )->unique_id ==
 963                                     temp_br->unique_id ) {
 964                                         ( ( buf_rec * )temp_list->data )->rt =
 965                                                 temp_br->rt;
 966                                 }
 967                         }
 968                 }
 969
 970                 if( ! linked ) {
 971                         free( temp_br->buf );
 972                         free( temp_br );
 973                 }
 974         }
 975         fclose( pc_in );
 976
 977         return MGU_SUCCESS;
 978 }
 979
 980 /**
 981  * Parse buffer containing multiple e-mail addresses into a linked list of
 982  * addresses. Separator characters are " ,;|" and control characters. Address
 983  * is only extracted if it contains an "at" (@) character.
 984  *
 985  * \param buf Buffer to process.
 986  * \return List of strings.
 987  */
 988 static GList *jpilot_parse_email( gchar *buf ) {
 989         GList *list;
 990         gchar *p, *st, *em;
 991         gchar lch;
 992         gint len;
 993         gboolean valid, done;
 994
 995         valid = done = FALSE;
 996         lch = ' ';
 997         list = NULL;
 998         p = st = buf;
 999         while( ! done ) {
1000                 if( *p == ' ' || *p == ',' || *p == ';' || *p == '|' || *p < 32 ) {
1001                         if( *p == '\0' ) {
1002                                 done = TRUE;
1003                         }
1004                         else {
1005                                 *p = ' ';
1006                         }
1007
1008                         if( *p == lch ) {
1009                                 st++;
1010                         }
1011                         else {
1012                                 len = p - st;
1013                                 if( len > 0 ) {
1014                                         if( valid ) {
1015                                                 em = g_strndup( st, len );
1016                                                 list = g_list_append( list, em );
1017                                         }
1018                                         st = p;
1019                                         ++st;
1020                                         valid = FALSE;
1021                                 }
1022                         }
1023                 }
1024                 if( *p == '@' ) valid = TRUE;
1025                 lch = *p;
1026                 ++p;
1027         }
1028
1029         return list;
1030 }
1031
1032 #define FULLNAME_BUFSIZE        256
1033 #define EMAIL_BUFSIZE           256
1034
1035 /**
1036  * Process a single label entry field, parsing multiple e-mail address entries.
1037  *
1038  * \param pilotFile  JPilot control data.
1039  * \param labelEntry Label entry data.
1040  * \param person     Person.
1041  */
1042 static void jpilot_parse_label( JPilotFile *pilotFile, gchar *labelEntry, ItemPerson *person ) {
1043         gchar buffer[ EMAIL_BUFSIZE ];
1044         ItemEMail *email;
1045         GList *list, *node;
1046
1047         if( labelEntry ) {
1048                 *buffer = '\0';
1049                 strcpy( buffer, labelEntry );
1050                 node = list = jpilot_parse_email( buffer );
1051                 while( node ) {
1052                         email = addritem_create_item_email();
1053                         addritem_email_set_address( email, node->data );
1054                         if (convert_charcode) {
1055                                 gchar *convertBuff = NULL;
1056                                 convertBuff = conv_codeset_strdup( labelEntry,
1057                                                 jpilot_get_charset(),
1058                                                 CS_INTERNAL );
1059                                 if (convertBuff)
1060                                         addritem_email_set_remarks( email, convertBuff );
1061                                 g_free( convertBuff );
1062                         }
1063                         else {
1064                                 addritem_email_set_remarks(email, buffer);
1065                         }
1066
1067                         addrcache_id_email( pilotFile->addressCache, email );
1068                         addrcache_person_add_email( pilotFile->addressCache, person, email );
1069                         node = g_list_next( node );
1070                 }
1071                 mgu_free_dlist( list );
1072                 list = NULL;
1073         }
1074 }
1075
1076 /**
1077  * Unpack address, building new data inside cache.
1078  * \param pilotFile  JPilot control data.
1079  * \param buf        Record buffer.
1080  * \param folderInd  Array of (category) folders to load.
1081  */
1082 static void jpilot_load_address(
1083                 JPilotFile *pilotFile, buf_rec *buf, ItemFolder *folderInd[] )
1084 {
1085         struct Address addr;
1086         gchar **addrEnt;
1087         gint k;
1088         gint cat_id = 0;
1089         guint unique_id;
1090         guchar attrib;
1091         gchar fullName[ FULLNAME_BUFSIZE ];
1092         ItemPerson *person;
1093         gint *indPhoneLbl;
1094         gchar *labelEntry;
1095         GList *node;
1096         gchar* extID;
1097         gchar **firstName = NULL;
1098         gchar **lastName = NULL;
1099 #if (PILOT_LINK_MAJOR > 11)
1100         pi_buffer_t *RecordBuffer;
1101         RecordBuffer = pi_buffer_new(buf->size);
1102
1103         memcpy(RecordBuffer->data, buf->buf, buf->size);
1104         RecordBuffer->used = buf->size;
1105         if (unpack_Address(&addr, RecordBuffer, address_v1) == -1) {
1106                 pi_buffer_free(RecordBuffer);
1107                 return;
1108         }
1109         pi_buffer_free(RecordBuffer);
1110 #else
1111         gint num;
1112
1113         num = unpack_Address(&addr, buf->buf, buf->size);
1114         if (num <= 0) {
1115                 return;
1116         }
1117 #endif /* PILOT_LINK_0_12 */
1118
1119         addrEnt = addr.entry;
1120         attrib = buf->attrib;
1121         unique_id = buf->unique_id;
1122         cat_id = attrib & 0x0F;
1123
1124         *fullName = '\0';
1125         if( addrEnt[ IND_LABEL_FIRSTNAME ] ) {
1126                 firstName = g_strsplit( addrEnt[ IND_LABEL_FIRSTNAME ], "\01", 2 );
1127         }
1128
1129         if( addrEnt[ IND_LABEL_LASTNAME ] ) {
1130                 lastName = g_strsplit( addrEnt[ IND_LABEL_LASTNAME ], "\01", 2 );
1131         }
1132
1133         if( name_order == FAMILY_LAST ) {
1134                 g_snprintf( fullName, FULLNAME_BUFSIZE, "%s %s",
1135                             firstName ? firstName[0] : "",
1136                             lastName ? lastName[0] : "" );
1137         }
1138         else {
1139                 g_snprintf( fullName, FULLNAME_BUFSIZE, "%s %s",
1140                             lastName ? lastName[0] : "",
1141                             firstName ? firstName[0] : "" );
1142         }
1143
1144         if( firstName ) {
1145                 g_strfreev( firstName );
1146         }
1147         if( lastName ) {
1148                 g_strfreev( lastName );
1149         }
1150
1151         g_strstrip( fullName );
1152
1153         if( convert_charcode ) {
1154                 gchar *nameConv = NULL;
1155                 nameConv = conv_codeset_strdup( fullName,
1156                                 jpilot_get_charset(),
1157                                 CS_INTERNAL );
1158                 if (nameConv)
1159                         strncpy2( fullName, nameConv, FULLNAME_BUFSIZE );
1160                 g_free( nameConv );
1161         }
1162
1163         person = addritem_create_item_person();
1164         addritem_person_set_common_name( person, fullName );
1165         addritem_person_set_first_name( person, addrEnt[ IND_LABEL_FIRSTNAME ] );
1166         addritem_person_set_last_name( person, addrEnt[ IND_LABEL_LASTNAME ] );
1167         addrcache_id_person( pilotFile->addressCache, person );
1168
1169         extID = g_strdup_printf( "%d", unique_id );
1170         addritem_person_set_external_id( person, extID );
1171         g_free( extID );
1172         extID = NULL;
1173
1174         /* Add entry for each email address listed under phone labels. */
1175         indPhoneLbl = addr.phoneLabel;
1176         for( k = 0; k < JPILOT_NUM_ADDR_PHONE; k++ ) {
1177                 if( indPhoneLbl[k] == IND_PHONE_EMAIL ) {
1178                         labelEntry = addrEnt[ OFFSET_PHONE_LABEL + k ];
1179                         jpilot_parse_label( pilotFile, labelEntry, person );
1180                 }
1181         }
1182
1183         /* Add entry for each custom label */
1184         node = pilotFile->labelInd;
1185         while( node ) {
1186                 gint ind;
1187
1188                 ind = GPOINTER_TO_INT( node->data );
1189                 if( ind > -1 ) {
1190                         /*
1191                         * g_print( "%d : %20s : %s\n", ind, ai->labels[ind],
1192                         * addrEnt[ind] );
1193                         */
1194                         labelEntry = addrEnt[ind];
1195                         jpilot_parse_label( pilotFile, labelEntry, person );
1196                 }
1197
1198                 node = g_list_next( node );
1199         }
1200
1201         if( person->listEMail ) {
1202                 if( cat_id > -1 && cat_id < JPILOT_NUM_CATEG ) {
1203                         /* Add to specified category */
1204                         addrcache_folder_add_person(
1205                                 pilotFile->addressCache,
1206                                 folderInd[cat_id], person );
1207                 }
1208                 else {
1209                         /* Add to root folder */
1210                         addrcache_add_person(
1211                                 pilotFile->addressCache, person );
1212                 }
1213         }
1214         else {
1215                 addritem_free_item_person( person );
1216                 person = NULL;
1217         }
1218         /* Free up pointer allocated inside address */
1219         free_Address( & addr );
1220 }
1221
1222 /**
1223  * Free up address list.
1224  * \param records List of records to free.
1225  */
1226 static void jpilot_free_addrlist( GList *records ) {
1227         GList *node;
1228         buf_rec *br;
1229
1230         node = records;
1231         while( node ) {
1232                 br = node->data;
1233                 free( br->buf );
1234                 free( br );
1235                 node->data = NULL;
1236                 node = g_list_next( node );
1237         }
1238
1239         /* Free up list */
1240         g_list_free( records );
1241 }
1242
1243 /**
1244  * Read metadata from file.
1245  * \param pilotFile  JPilot control data.
1246  * \return Status/error code. <code>MGU_SUCCESS</code> if data read
1247  *         successfully.
1248  */
1249 static gint jpilot_read_metadata( JPilotFile *pilotFile ) {
1250         gint retVal;
1251         unsigned int rec_size;
1252         unsigned char *buf;
1253         int num;
1254
1255         cm_return_val_if_fail( pilotFile != NULL, -1 );
1256
1257         pilotFile->readMetadata = FALSE;
1258         addrcache_clear( pilotFile->addressCache );
1259
1260         /* Read file info */
1261         retVal = jpilot_get_file_info( pilotFile, &buf, &rec_size);
1262         if( retVal != MGU_SUCCESS ) {
1263                 pilotFile->retVal = retVal;
1264                 return pilotFile->retVal;
1265         }
1266
1267         num = unpack_AddressAppInfo( &pilotFile->addrInfo, buf, rec_size );
1268         if( buf ) {
1269                 free(buf);
1270         }
1271         if( num <= 0 ) {
1272                 pilotFile->retVal = MGU_ERROR_READ;
1273                 return pilotFile->retVal;
1274         }
1275
1276         pilotFile->readMetadata = TRUE;
1277         pilotFile->retVal = MGU_SUCCESS;
1278         return pilotFile->retVal;
1279 }
1280
1281 /**
1282  * Setup labels and indexes from metadata.
1283  * \param pilotFile  JPilot control data.
1284  * \return <i>TRUE</i> is setup successfully.
1285  */
1286 static gboolean jpilot_setup_labels( JPilotFile *pilotFile ) {
1287         gboolean retVal = FALSE;
1288         struct AddressAppInfo *ai;
1289         GList *node;
1290
1291         cm_return_val_if_fail( pilotFile != NULL, -1 );
1292
1293         /* Release indexes */
1294         node = pilotFile->labelInd;
1295         while( node ) {
1296                 node->data = NULL;
1297                 node = g_list_next( node );
1298         }
1299         pilotFile->labelInd = NULL;
1300
1301         if( pilotFile->readMetadata ) {
1302                 ai = & pilotFile->addrInfo;
1303                 node = pilotFile->customLabels;
1304                 while( node ) {
1305                         gchar *lbl = node->data;
1306                         gint ind = -1;
1307                         gint i;
1308                         for( i = 0; i < JPILOT_NUM_LABELS; i++ ) {
1309                                 gchar *labelName = ai->labels[i];
1310
1311                                 if( convert_charcode ) {
1312                                         gchar *convertBuff = NULL;
1313                                         convertBuff = conv_codeset_strdup( labelName,
1314                                                         jpilot_get_charset(),
1315                                                         CS_INTERNAL );
1316                                         if (convertBuff) {
1317                                                 labelName = convertBuff;
1318                                         }
1319                                 }
1320
1321                                 if( g_utf8_collate( labelName, lbl ) == 0 ) {
1322                                         ind = i;
1323                                         break;
1324                                 }
1325                         }
1326                         pilotFile->labelInd = g_list_append(
1327                                 pilotFile->labelInd, GINT_TO_POINTER(ind) );
1328                         node = g_list_next( node );
1329                 }
1330                 retVal = TRUE;
1331         }
1332         return retVal;
1333 }
1334
1335 /**
1336  * Load list with character strings of custom label names. Only none blank
1337  * names are loaded.
1338  * \param pilotFile  JPilot control data.
1339  * \param labelList List of label names to load.
1340  * \return List of label names loaded. Should be freed when done.
1341  */
1342 GList *jpilot_load_custom_label( JPilotFile *pilotFile, GList *labelList ) {
1343         gint i;
1344
1345         cm_return_val_if_fail( pilotFile != NULL, NULL );
1346
1347         if( pilotFile->readMetadata ) {
1348                 struct AddressAppInfo *ai = & pilotFile->addrInfo;
1349                 for( i = 0; i < NUM_CUSTOM_LABEL; i++ ) {
1350                         gchar *labelName = ai->labels[i+IND_CUSTOM_LABEL];
1351                         if( labelName ) {
1352                                 g_strchomp( labelName );
1353                                 g_strchug( labelName );
1354                                 if( *labelName != '\0' ) {
1355                                         if( convert_charcode ) {
1356                                                 gchar *convertBuff = NULL;
1357                                                 convertBuff = conv_codeset_strdup( labelName,
1358                                                                 jpilot_get_charset(),
1359                                                                 CS_INTERNAL );
1360                                                 if (convertBuff) {
1361                                                         labelName = convertBuff;
1362                                                 }
1363                                         }
1364                                         else {
1365                                                 labelName = g_strdup( labelName );
1366                                         }
1367                                         labelList = g_list_append( labelList, labelName );
1368                                 }
1369                         }
1370                 }
1371         }
1372         return labelList;
1373 }
1374
1375 /**
1376  * Build folder in address book for each category.
1377  * \param pilotFile  JPilot control data.
1378  */
1379 static void jpilot_build_category_list( JPilotFile *pilotFile ) {
1380         struct AddressAppInfo *ai = & pilotFile->addrInfo;
1381         struct CategoryAppInfo *cat = & ai->category;
1382         gint i;
1383
1384         for( i = 0; i < JPILOT_NUM_CATEG; i++ ) {
1385                 ItemFolder *folder = addritem_create_item_folder();
1386
1387                 if( convert_charcode ) {
1388                         gchar *convertBuff = NULL;
1389                         convertBuff = conv_codeset_strdup( cat->name[i],
1390                                         jpilot_get_charset(),
1391                                         CS_INTERNAL );
1392                         if (convertBuff) {
1393                                 addritem_folder_set_name( folder, convertBuff );
1394                                 g_free( convertBuff );
1395                         } else {
1396                                 addritem_folder_set_name( folder, cat->name[i] );
1397                         }
1398                 }
1399                 else {
1400                         addritem_folder_set_name( folder, cat->name[i] );
1401                 }
1402
1403                 addrcache_id_folder( pilotFile->addressCache, folder );
1404                 addrcache_add_folder( pilotFile->addressCache, folder );
1405         }
1406 }
1407
1408 /**
1409  * Remove empty (category) folders.
1410  * \param pilotFile  JPilot control data.
1411  */
1412 static void jpilot_remove_empty( JPilotFile *pilotFile ) {
1413         GList *listFolder;
1414         GList *remList;
1415         GList *node;
1416         gint i = 0;
1417
1418         listFolder = addrcache_get_list_folder( pilotFile->addressCache );
1419         node = listFolder;
1420         remList = NULL;
1421         while( node ) {
1422                 ItemFolder *folder = node->data;
1423                 if( ADDRITEM_NAME(folder) == NULL || *ADDRITEM_NAME(folder) == '\0' ) {
1424                         if( folder->listPerson ) {
1425                                 /* Give name to folder */
1426                                 gchar name[20];
1427                                 sprintf( name, "? %d", i );
1428                                 addritem_folder_set_name( folder, name );
1429                         }
1430                         else {
1431                                 /* Mark for removal */
1432                                 remList = g_list_append( remList, folder );
1433                         }
1434                 }
1435                 node = g_list_next( node );
1436                 i++;
1437         }
1438         node = remList;
1439         while( node ) {
1440                 ItemFolder *folder = node->data;
1441                 addrcache_remove_folder( pilotFile->addressCache, folder );
1442                 node = g_list_next( node );
1443         }
1444         g_list_free( remList );
1445 }
1446
1447 /**
1448  * Read address file into address cache.
1449  * \param pilotFile  JPilot control data.
1450  * \return Error/status code. <code>MGU_SUCCESS</code> if data read
1451  *         successfully.
1452  */
1453 static gint jpilot_read_file( JPilotFile *pilotFile ) {
1454         gint retVal, i;
1455         GList *records = NULL;
1456         GList *node;
1457         buf_rec *br;
1458         ItemFolder *folderInd[ JPILOT_NUM_CATEG ];
1459
1460         /* Read list of records from JPilot files */
1461         retVal = jpilot_read_db_files( pilotFile, &records );
1462         if( retVal != MGU_SUCCESS ) {
1463                 jpilot_free_addrlist( records );
1464                 return retVal;
1465         }
1466
1467         /* Setup labels and category folders */
1468         jpilot_setup_labels( pilotFile );
1469         jpilot_build_category_list( pilotFile );
1470
1471         /* Build array of pointers to categories */
1472         i = 0;
1473         node = addrcache_get_list_folder( pilotFile->addressCache );
1474         while( node ) {
1475                 if( i < JPILOT_NUM_CATEG ) {
1476                         folderInd[i] = node->data;
1477                 }
1478                 node = g_list_next( node );
1479                 i++;
1480         }
1481
1482         /* Load all addresses, free up old stuff as we go */
1483         node = records;
1484         while( node ) {
1485                 br = node->data;
1486                 if( ( br->rt != DELETED_PC_REC ) &&
1487                     ( br->rt != DELETED_PALM_REC ) &&
1488                     ( br->rt != MODIFIED_PALM_REC ) &&
1489                     ( br->rt != DELETED_DELETED_PALM_REC ) ) {
1490                         jpilot_load_address( pilotFile, br, folderInd );
1491                 }
1492                 free( br->buf );
1493                 free( br );
1494                 node->data = NULL;
1495                 node = g_list_next( node );
1496         }
1497
1498         /* Free up list */
1499         g_list_free( records );
1500
1501         /* Remove empty category folders */
1502         jpilot_remove_empty( pilotFile );
1503         jpilot_mark_files( pilotFile );
1504
1505         return retVal;
1506 }
1507
1508 /**
1509  * Read file into list. Main entry point
1510  * \param pilotFile  JPilot control data.
1511  * \return Error/status code. <code>MGU_SUCCESS</code> if data read
1512  *         successfully.
1513  */
1514 gint jpilot_read_data( JPilotFile *pilotFile ) {
1515         const gchar *cur_locale;
1516
1517         name_order = FAMILY_LAST;
1518
1519         cur_locale = conv_get_current_locale();
1520
1521         if( g_ascii_strncasecmp( cur_locale, "ja", 2 ) == 0 ) {
1522                 name_order = FAMILY_FIRST;
1523         }
1524
1525         cm_return_val_if_fail( pilotFile != NULL, -1 );
1526
1527         pilotFile->retVal = MGU_SUCCESS;
1528         pilotFile->addressCache->accessFlag = FALSE;
1529         if( jpilot_check_files( pilotFile ) ) {
1530                 addrcache_clear( pilotFile->addressCache );
1531                 jpilot_read_metadata( pilotFile );
1532                 if( pilotFile->retVal == MGU_SUCCESS ) {
1533                         pilotFile->retVal = jpilot_read_file( pilotFile );
1534                         if( pilotFile->retVal == MGU_SUCCESS ) {
1535                                 pilotFile->addressCache->modified = FALSE;
1536                                 pilotFile->addressCache->dataRead = TRUE;
1537                         }
1538                 }
1539         }
1540         return pilotFile->retVal;
1541 }
1542
1543 /**
1544  * Return linked list of persons. This is a list of references to ItemPerson
1545  * objects. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
1546  * functions... this will destroy the addressbook data!
1547  *
1548  * \param  pilotFile  JPilot control data.
1549  * \return List of persons.
1550  */
1551 GList *jpilot_get_list_person( JPilotFile *pilotFile ) {
1552         cm_return_val_if_fail( pilotFile != NULL, NULL );
1553         return addrcache_get_list_person( pilotFile->addressCache );
1554 }
1555
1556 /**
1557  * Return linked list of folders. This is a list of references to non-empty
1558  * category folders. Do <b>NOT</b> attempt to use the
1559  * <code>addrbook_free_xxx()</code> functions... this will destroy the
1560  * addressbook data!
1561  *
1562  * \param  pilotFile  JPilot control data.
1563  * \return List of ItemFolder objects. This should not be freed.
1564  */
1565 GList *jpilot_get_list_folder( JPilotFile *pilotFile ) {
1566         cm_return_val_if_fail( pilotFile != NULL, NULL );
1567         return addrcache_get_list_folder( pilotFile->addressCache );
1568 }
1569
1570 /**
1571  * Return linked list of all persons. Note that the list contains references
1572  * to items. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
1573  * functions... this will destroy the addressbook data!
1574  *
1575  * \param pilotFile  JPilot control data.
1576  * \return List of items, or NULL if none.
1577  */
1578 GList *jpilot_get_all_persons( JPilotFile *pilotFile ) {
1579         cm_return_val_if_fail( pilotFile != NULL, NULL );
1580         return addrcache_get_all_persons( pilotFile->addressCache );
1581 }
1582
1583 #define WORK_BUFLEN 1024
1584
1585 /**
1586  * Attempt to find a valid JPilot file.
1587  * \param pilotFile  JPilot control data.
1588  * \return Filename, or home directory if not found, or empty string if
1589  *         no home. Filename should be <code>g_free()</code> when done.
1590  */
1591 gchar *jpilot_find_pilotdb( void ) {
1592         const gchar *homedir;
1593         gchar str[ WORK_BUFLEN + 1 ];
1594         gint len;
1595         FILE *fp;
1596
1597         homedir = get_home_dir();
1598         if( ! homedir ) return g_strdup( "" );
1599
1600         strcpy( str, homedir );
1601         len = strlen( str );
1602         if( len > 0 ) {
1603                 if( str[ len-1 ] != G_DIR_SEPARATOR ) {
1604                         str[ len ] = G_DIR_SEPARATOR;
1605                         str[ ++len ] = '\0';
1606                 }
1607         }
1608         strncat( str, JPILOT_DBHOME_DIR, WORK_BUFLEN - strlen(str) );
1609         strncat( str, G_DIR_SEPARATOR_S, WORK_BUFLEN - strlen(str) );
1610         strncat( str, JPILOT_DBHOME_FILE, WORK_BUFLEN - strlen(str) );
1611
1612         /* Attempt to open */
1613         if( ( fp = g_fopen( str, "rb" ) ) != NULL ) {
1614                 fclose( fp );
1615         }
1616         else {
1617                 /* Truncate filename */
1618                 str[ len ] = '\0';
1619         }
1620         return g_strdup( str );
1621 }
1622
1623 /**
1624  * Check whether label is in list of custom labels.
1625  * \param pilotFile JPilot control data.
1626  * \param labelName to test.
1627  * \return <i>TRUE</i> if found.
1628  */
1629 gboolean jpilot_test_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
1630         gboolean retVal;
1631         GList *node;
1632
1633         cm_return_val_if_fail( pilotFile != NULL, FALSE );
1634
1635         retVal = FALSE;
1636         if( labelName ) {
1637                 node = pilotFile->customLabels;
1638                 while( node ) {
1639                         if( g_utf8_collate( labelName, ( gchar * ) node->data ) == 0 ) {
1640                                 retVal = TRUE;
1641                                 break;
1642                         }
1643                         node = g_list_next( node );
1644                 }
1645         }
1646         return retVal;
1647 }
1648
1649 /**
1650  * Test whether pilot link library installed.
1651  * \return <i>TRUE</i> if library available.
1652  */
1653 gboolean jpilot_test_pilot_lib( void ) {
1654         return TRUE;
1655 }
1656
1657 #endif  /* USE_JPILOT */
1658
1659 /*
1660 * End of Source.
1661 */