/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 2001-2002 Match Grun
+ * Copyright (C) 2001-2003 Match Grun
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
-#include <dlfcn.h>
#include <netinet/in.h>
#ifdef HAVE_LIBPISOCK_PI_ARGS_H
unsigned char attrib;
} PC3RecordHeader;
-/*
+/**
* Create new pilot file object.
+* \return Initialized JPilot file object.
*/
JPilotFile *jpilot_create() {
JPilotFile *pilotFile;
pilotFile = g_new0( JPilotFile, 1 );
pilotFile->type = ADBOOKTYPE_JPILOT;
pilotFile->addressCache = addrcache_create();
- pilotFile->accessFlag = FALSE;
pilotFile->retVal = MGU_SUCCESS;
pilotFile->file = NULL;
return pilotFile;
}
-/*
-* Create new pilot file object for specified file.
-*/
+/**
+ * Create new pilot file object for specified file.
+ * \param path Path to JPilot address book.
+ * \return Initialized JPilot file object.
+ */
JPilotFile *jpilot_create_path( const gchar *path ) {
JPilotFile *pilotFile;
pilotFile = jpilot_create();
}
void jpilot_set_accessed( JPilotFile *pilotFile, const gboolean value ) {
g_return_if_fail( pilotFile != NULL );
- pilotFile->accessFlag = value;
+ pilotFile->addressCache->accessFlag = value;
}
gint jpilot_get_status( JPilotFile *pilotFile ) {
}
/*
-* Test whether file was read.
-* Return: TRUE if file was read.
-*/
+ * Test whether file was read.
+ * \param pilotFile JPilot control data.
+ * \return <i>TRUE</i> if file was read.
+ */
gboolean jpilot_get_read_flag( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, FALSE );
return pilotFile->addressCache->dataRead;
}
-/*
-* Free up custom label list.
-*/
+/**
+ * Free up custom label list.
+ * \param pilotFile JPilot control data.
+ */
void jpilot_clear_custom_labels( JPilotFile *pilotFile ) {
GList *node;
addrcache_refresh( pilotFile->addressCache );
}
-/*
-* Append a custom label, representing an E-Mail address field to the
-* custom label list.
-*/
+/**
+ * Append a custom label, representing an E-Mail address field to the
+ * custom label list.
+ * \param pilotFile JPilot control data.
+ */
void jpilot_add_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
g_return_if_fail( pilotFile != NULL );
}
}
-/*
-* Get list of custom labels.
-* Return: List of labels. Must use g_free() when done.
-*/
+/**
+ * Get list of custom labels.
+ * \param pilotFile JPilot control data.
+ * \return List of labels. Must use g_free() when done.
+ */
GList *jpilot_get_custom_labels( JPilotFile *pilotFile ) {
GList *retVal = NULL;
GList *node;
return retVal;
}
-/*
-* Return filespec of PC3 file corresponding to JPilot PDB file.
-* Note: Filespec should be g_free() when done.
-*/
+/**
+ * Return filespec of PC3 file corresponding to JPilot PDB file.
+ * \param pilotFile JPilot control data.
+ * \return File specification; should be g_free() when done.
+ */
static gchar *jpilot_get_pc3_file( JPilotFile *pilotFile ) {
gchar *fileSpec, *r;
gint i, len, pos;
return NULL;
}
-/*
-* Save PC3 file time to cache.
-* return: TRUE if time marked.
-*/
+/**
+ * Save PC3 file time to cache.
+ * \param pilotFile JPilot control data.
+ * \return <i>TRUE</i> if time marked.
+ */
static gboolean jpilot_mark_files( JPilotFile *pilotFile ) {
gboolean retVal = FALSE;
struct stat filestat;
return retVal;
}
-/*
-* Check whether JPilot PDB or PC3 file has changed by comparing
-* with cached data.
-* return: TRUE if file has changed.
-*/
+/**
+ * Check whether JPilot PDB or PC3 file has changed by comparing
+ * with cached data.
+ * \param pilotFile JPilot control data.
+ * \return <i>TRUE</i> if file has changed.
+ */
static gboolean jpilot_check_files( JPilotFile *pilotFile ) {
gboolean retVal = TRUE;
struct stat filestat;
*/
gboolean jpilot_get_modified( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, FALSE );
- return jpilot_check_files( pilotFile );
+ pilotFile->addressCache->modified = jpilot_check_files( pilotFile );
+ return pilotFile->addressCache->modified;
+}
+void jpilot_set_modified( JPilotFile *pilotFile, const gboolean value ) {
+ g_return_if_fail( pilotFile != NULL );
+ pilotFile->addressCache->modified = value;
}
gboolean jpilot_get_accessed( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, FALSE );
- return pilotFile->accessFlag;
+ return pilotFile->addressCache->accessFlag;
}
-/*
-* Free up pilot file object by releasing internal memory.
-*/
+/**
+ * Free up pilot file object by releasing internal memory.
+ * \param pilotFile JPilot control data.
+ */
void jpilot_free( JPilotFile *pilotFile ) {
g_return_if_fail( pilotFile != NULL );
pilotFile->type = ADBOOKTYPE_NONE;
pilotFile->addressCache = NULL;
- pilotFile->accessFlag = FALSE;
pilotFile->retVal = MGU_SUCCESS;
/* Now release file object */
*buf_size=0;
if( pilotFile->path ) {
- in = fopen( pilotFile->path, "r" );
+ in = fopen( pilotFile->path, "rb" );
if( !in ) {
return MGU_OPEN_FILE;
}
return 1;
}
-/* Read next record from PC3 file. Based on JPilot's
- * pc_read_next_rec (libplugin.c) */
+/**
+ * Read next record from PC3 file. Based on JPilot function
+ * <code>pc_read_next_rec()</code> (libplugin.c)
+ *
+ * \param in File handle.
+ * \param br Record buffer.
+ * \return Status/error code. <code>MGU_SUCCESS</code> if data read
+ * successfully.
+ */
static gint jpilot_read_next_pc( FILE *in, buf_rec *br ) {
PC3RecordHeader header;
int rec_len, num;
char *record;
- if(feof(in)) {
+ if( feof( in ) ) {
return MGU_EOF;
}
- num = read_header(in, &header);
- if (num < 1) {
- if (ferror(in)) {
+ num = read_header( in, &header );
+ if( num < 1 ) {
+ if( ferror( in ) ) {
return MGU_ERROR_READ;
}
- if (feof(in)) {
+ if( feof( in ) ) {
return MGU_EOF;
}
}
rec_len = header.rec_len;
- record = malloc(rec_len);
- if (!record) {
+ record = malloc( rec_len );
+ if( ! record ) {
return MGU_OO_MEMORY;
}
- num = fread(record, rec_len, 1, in);
- if (num != 1) {
- if (ferror(in)) {
- free(record);
+ num = fread( record, rec_len, 1, in );
+ if( num != 1 ) {
+ if( ferror( in ) ) {
+ free( record );
return MGU_ERROR_READ;
}
}
return MGU_SUCCESS;
}
-/*
- * Read address file into a linked list. Based on JPilot's
- * jp_read_DB_files (from libplugin.c)
+/**
+ * Read address file into a linked list. Based on JPilot function
+ * <code>jp_read_DB_files()</code> (from libplugin.c)
+ *
+ * \param pilotFile JPilot control data.
+ * \param records Pointer to linked list of records read.
+ * \return Status/error code. <code>MGU_SUCCESS</code> if data read
+ * successfully.
*/
static gint jpilot_read_db_files( JPilotFile *pilotFile, GList **records ) {
FILE *in, *pc_in;
return MGU_BAD_ARGS;
}
- in = fopen( pilotFile->path, "r" );
- if (!in) {
+ in = fopen( pilotFile->path, "rb" );
+ if( ! in ) {
return MGU_OPEN_FILE;
}
/* Read the database header */
- num = fread(&rdbh, sizeof(RawDBHeader), 1, in);
- if (num != 1) {
- if (ferror(in)) {
- fclose(in);
+ num = fread( &rdbh, sizeof( RawDBHeader ), 1, in );
+ if( num != 1 ) {
+ if( ferror( in ) ) {
+ fclose( in );
return MGU_ERROR_READ;
}
- if (feof(in)) {
- fclose(in);
+ if( feof( in ) ) {
+ fclose( in );
return MGU_EOF;
}
}
- raw_header_to_header(&rdbh, &dbh);
+ raw_header_to_header( &rdbh, &dbh );
/* Read each record entry header */
num_records = dbh.number_of_records;
out_of_order = 0;
prev_offset = 0;
- for (i = 1; i < num_records + 1; i++) {
- num = fread(&rh, sizeof(record_header), 1, in);
- if (num != 1) {
- if (ferror(in)) {
+ for( i = 1; i < num_records + 1; i++ ) {
+ num = fread( &rh, sizeof( record_header ), 1, in );
+ if( num != 1 ) {
+ if( ferror( in ) ) {
break;
}
- if (feof(in)) {
- fclose(in);
+ if( feof( in ) ) {
+ fclose( in );
return MGU_EOF;
}
}
- offset = ((rh.Offset[0]*256+rh.Offset[1])*256+rh.Offset[2])*256+rh.Offset[3];
- if (offset < prev_offset) {
+ offset =
+ ( ( rh.Offset[0] * 256 + rh.Offset[1] ) * 256
+ + rh.Offset[2] ) * 256
+ + rh.Offset[3];
+ if( offset < prev_offset ) {
out_of_order = 1;
}
prev_offset = offset;
- temp_mem_rh = (mem_rec_header *)malloc(sizeof(mem_rec_header));
- if (!temp_mem_rh) {
+ temp_mem_rh = ( mem_rec_header * ) malloc( sizeof( mem_rec_header ) );
+ if( ! temp_mem_rh ) {
break;
}
temp_mem_rh->next = NULL;
temp_mem_rh->rec_num = i;
temp_mem_rh->offset = offset;
temp_mem_rh->attrib = rh.attrib;
- temp_mem_rh->unique_id = (rh.unique_ID[0]*256+rh.unique_ID[1])*256+rh.unique_ID[2];
- if (mem_rh == NULL) {
+ temp_mem_rh->unique_id =
+ ( rh.unique_ID[0] * 256 + rh.unique_ID[1] ) * 256
+ + rh.unique_ID[2];
+ if( mem_rh == NULL ) {
mem_rh = temp_mem_rh;
last_mem_rh = temp_mem_rh;
- } else {
+ }
+ else {
last_mem_rh->next = temp_mem_rh;
last_mem_rh = temp_mem_rh;
}
temp_mem_rh = mem_rh;
- if (num_records) {
- if (out_of_order) {
- find_next_offset(mem_rh, 0, &next_offset, &attrib, &unique_id);
- } else {
- if (mem_rh) {
+ if( num_records ) {
+ if( out_of_order ) {
+ find_next_offset(
+ mem_rh, 0, &next_offset, &attrib, &unique_id );
+ }
+ else {
+ if( mem_rh ) {
next_offset = mem_rh->offset;
attrib = mem_rh->attrib;
unique_id = mem_rh->unique_id;
}
}
- fseek(in, next_offset, SEEK_SET);
- while(!feof(in)) {
- fpos = ftell(in);
- if (out_of_order) {
- find_next_offset(mem_rh, fpos, &next_offset, &attrib, &unique_id);
+ fseek( in, next_offset, SEEK_SET );
+ while( ! feof( in ) ) {
+ fpos = ftell( in );
+ if( out_of_order ) {
+ find_next_offset(
+ mem_rh, fpos, &next_offset, &attrib,
+ &unique_id );
} else {
next_offset = 0xFFFFFF;
- if (temp_mem_rh) {
+ if( temp_mem_rh ) {
attrib = temp_mem_rh->attrib;
unique_id = temp_mem_rh->unique_id;
- if (temp_mem_rh->next) {
+ if ( temp_mem_rh->next ) {
temp_mem_rh = temp_mem_rh->next;
next_offset = temp_mem_rh->offset;
}
}
}
rec_size = next_offset - fpos;
- buf = malloc(rec_size);
- if (!buf) break;
- num = fread(buf, rec_size, 1, in);
- if ((num != 1)) {
- if (ferror(in)) {
- free(buf);
+ buf = malloc( rec_size );
+ if( ! buf ) break;
+ num = fread( buf, rec_size, 1, in );
+ if( ( num != 1 ) ) {
+ if( ferror( in ) ) {
+ free( buf );
break;
}
}
- temp_br = malloc(sizeof(buf_rec));
- if (!temp_br) {
+ temp_br = malloc( sizeof( buf_rec ) );
+ if( ! temp_br ) {
+ free( buf );
break;
}
temp_br->rt = PALM_REC;
temp_br->buf = buf;
temp_br->size = rec_size;
- *records = g_list_append(*records, temp_br);
+ *records = g_list_append( *records, temp_br );
recs_returned++;
}
}
- fclose(in);
- free_mem_rec_header(&mem_rh);
+ fclose( in );
+ free_mem_rec_header( &mem_rh );
/* Read the PC3 file, if present */
pcFile = jpilot_get_pc3_file( pilotFile );
if( pcFile == NULL ) return MGU_SUCCESS;
- pc_in = fopen( pcFile, "r");
+ pc_in = fopen( pcFile, "rb" );
g_free( pcFile );
if( pc_in == NULL ) {
}
while( ! feof( pc_in ) ) {
- temp_br = malloc(sizeof(buf_rec));
- if (!temp_br) {
+ gboolean linked;
+
+ temp_br = malloc( sizeof( buf_rec ) );
+ if( ! temp_br ) {
break;
}
r = jpilot_read_next_pc( pc_in, temp_br );
- if ( r != MGU_SUCCESS ) {
- free(temp_br);
+ if( r != MGU_SUCCESS ) {
+ if( (r != MGU_EOF) && (r != MGU_ERROR_READ) ) {
+ free( temp_br->buf );
+ }
+ free( temp_br );
break;
}
- if ((temp_br->rt!=DELETED_PC_REC)
- &&(temp_br->rt!=DELETED_PALM_REC)
- &&(temp_br->rt!=MODIFIED_PALM_REC)
- &&(temp_br->rt!=DELETED_DELETED_PALM_REC)) {
- *records = g_list_append(*records, temp_br);
- recs_returned++;
+
+ linked = FALSE;
+ if( ( temp_br->rt != DELETED_PC_REC )
+ && ( temp_br->rt != DELETED_PALM_REC )
+ && ( temp_br->rt != MODIFIED_PALM_REC )
+ && ( temp_br->rt != DELETED_DELETED_PALM_REC ) )
+ {
+ *records = g_list_append( *records, temp_br );
+ recs_returned++;
+ linked = TRUE;
}
- if ((temp_br->rt==DELETED_PALM_REC) || (temp_br->rt==MODIFIED_PALM_REC)) {
- temp_list=*records;
- if (*records) {
- while(temp_list->next) {
+
+ if( ( temp_br->rt == DELETED_PALM_REC )
+ || ( temp_br->rt == MODIFIED_PALM_REC ) )
+ {
+ temp_list = *records;
+ if( *records ) {
+ while( temp_list->next ) {
temp_list=temp_list->next;
}
}
- for (; temp_list; temp_list=temp_list->prev) {
- if (((buf_rec *)temp_list->data)->unique_id == temp_br->unique_id) {
- ((buf_rec *)temp_list->data)->rt = temp_br->rt;
+ for( ; temp_list; temp_list=temp_list->prev ) {
+ if( ( ( buf_rec * )temp_list->data )->unique_id ==
+ temp_br->unique_id ) {
+ ( ( buf_rec * )temp_list->data )->rt =
+ temp_br->rt;
}
}
}
+
+ if( ! linked ) {
+ free( temp_br->buf );
+ free( temp_br );
+ }
}
- fclose(pc_in);
+ fclose( pc_in );
return MGU_SUCCESS;
}
+/**
+ * Parse buffer containing multiple e-mail addresses into a linked list of
+ * addresses. Separator characters are " ,;|" and control characters. Address
+ * is only extracted if it contains an "at" (@) character.
+ *
+ * \param buf Buffer to process.
+ * \return List of strings.
+ */
+static GList *jpilot_parse_email( gchar *buf ) {
+ GList *list;
+ gchar *p, *st, *em;
+ gchar lch;
+ gint len;
+ gboolean valid, done;
+
+ valid = done = FALSE;
+ lch = ' ';
+ list = NULL;
+ p = st = buf;
+ while( ! done ) {
+ if( *p == ' ' || *p == ',' || *p == ';' || *p == '|' || *p < 32 ) {
+ if( *p == '\0' ) {
+ done = TRUE;
+ }
+ else {
+ *p = ' ';
+ }
+
+ if( *p == lch ) {
+ st++;
+ }
+ else {
+ len = p - st;
+ if( len > 0 ) {
+ if( valid ) {
+ em = g_strndup( st, len );
+ list = g_list_append( list, em );
+ }
+ st = p;
+ ++st;
+ valid = FALSE;
+ }
+ }
+ }
+ if( *p == '@' ) valid = TRUE;
+ lch = *p;
+ ++p;
+ }
+
+ return list;
+}
+
#define FULLNAME_BUFSIZE 256
#define EMAIL_BUFSIZE 256
-/*
+
+/**
+ * Process a single label entry field, parsing multiple e-mail address entries.
+ *
+ * \param pilotFile JPilot control data.
+ * \param labelEntry Label entry data.
+ * \param person Person.
+ */
+static void jpilot_parse_label( JPilotFile *pilotFile, gchar *labelEntry, ItemPerson *person ) {
+ gchar buffer[ EMAIL_BUFSIZE ];
+ ItemEMail *email;
+ GList *list, *node;
+
+ if( labelEntry ) {
+ *buffer = '\0';
+ strcpy( buffer, labelEntry );
+ node = list = jpilot_parse_email( buffer );
+ while( node ) {
+ email = addritem_create_item_email();
+ addritem_email_set_address( email, node->data );
+ addrcache_id_email( pilotFile->addressCache, email );
+ addrcache_person_add_email( pilotFile->addressCache, person, email );
+ node = g_list_next( node );
+ }
+ mgu_free_dlist( list );
+ list = NULL;
+ }
+}
+
+/**
* Unpack address, building new data inside cache.
+ * \param pilotFile JPilot control data.
+ * \param buf Record buffer.
+ * \param folderInd Array of (category) folders to load.
*/
-static void jpilot_load_address( JPilotFile *pilotFile, buf_rec *buf, ItemFolder *folderInd[] ) {
+static void jpilot_load_address(
+ JPilotFile *pilotFile, buf_rec *buf, ItemFolder *folderInd[] )
+{
struct Address addr;
gchar **addrEnt;
gint num, k;
guint unique_id;
guchar attrib;
gchar fullName[ FULLNAME_BUFSIZE ];
- gchar bufEMail[ EMAIL_BUFSIZE ];
ItemPerson *person;
- ItemEMail *email;
gint *indPhoneLbl;
gchar *labelEntry;
GList *node;
unique_id = buf->unique_id;
cat_id = attrib & 0x0F;
- *fullName = *bufEMail = '\0';
+ *fullName = '\0';
if( addrEnt[ IND_LABEL_FIRSTNAME ] ) {
strcat( fullName, addrEnt[ IND_LABEL_FIRSTNAME ] );
}
*/
if( indPhoneLbl[k] == IND_PHONE_EMAIL ) {
labelEntry = addrEnt[ OFFSET_PHONE_LABEL + k ];
- if( labelEntry ) {
- strcpy( bufEMail, labelEntry );
- g_strchug( bufEMail );
- g_strchomp( bufEMail );
-
- email = addritem_create_item_email();
- addritem_email_set_address( email, bufEMail );
- addrcache_id_email( pilotFile->addressCache, email );
- addrcache_person_add_email
- ( pilotFile->addressCache, person, email );
- }
+ jpilot_parse_label( pilotFile, labelEntry, person );
}
}
* addrEnt[ind] );
*/
labelEntry = addrEnt[ind];
- if( labelEntry ) {
- strcpy( bufEMail, labelEntry );
- g_strchug( bufEMail );
- g_strchomp( bufEMail );
-
- email = addritem_create_item_email();
- addritem_email_set_address( email, bufEMail );
- addritem_email_set_remarks( email, ai->labels[ind] );
- addrcache_id_email( pilotFile->addressCache, email );
- addrcache_person_add_email
- ( pilotFile->addressCache, person, email );
- }
+ jpilot_parse_label( pilotFile, labelEntry, person );
}
node = g_list_next( node );
if( person->listEMail ) {
if( cat_id > -1 && cat_id < JPILOT_NUM_CATEG ) {
/* Add to specified category */
- addrcache_folder_add_person
- ( pilotFile->addressCache, folderInd[cat_id], person );
- } else {
+ addrcache_folder_add_person(
+ pilotFile->addressCache,
+ folderInd[cat_id], person );
+ }
+ else {
/* Add to root folder */
- addrcache_add_person( pilotFile->addressCache, person );
+ addrcache_add_person(
+ pilotFile->addressCache, person );
}
- } else {
+ }
+ else {
addritem_free_item_person( person );
person = NULL;
}
}
+
+ /* Free up pointer allocated inside address */
+ free_Address( & addr );
}
-/*
+/**
* Free up address list.
+ * \param records List of records to free.
*/
static void jpilot_free_addrlist( GList *records ) {
GList *node;
node = records;
while( node ) {
br = node->data;
+ free( br->buf );
free( br );
node->data = NULL;
node = g_list_next( node );
g_list_free( records );
}
-/*
- * Read address file into address cache.
+/**
+ * Read metadata from file.
+ * \param pilotFile JPilot control data.
+ * \return Status/error code. <code>MGU_SUCCESS</code> if data read
+ * successfully.
*/
-static gint jpilot_read_file( JPilotFile *pilotFile ) {
- gint retVal, i;
- GList *records = NULL;
- GList *node;
- buf_rec *br;
- ItemFolder *folderInd[ JPILOT_NUM_CATEG ];
-
- retVal = jpilot_read_db_files( pilotFile, &records );
- if( retVal != MGU_SUCCESS ) {
- jpilot_free_addrlist( records );
- return retVal;
- }
-
- /* Build array of pointers to categories */
- i = 0;
- node = addrcache_get_list_folder( pilotFile->addressCache );
- while( node ) {
- if( i < JPILOT_NUM_CATEG ) {
- folderInd[i] = node->data;
- }
- node = g_list_next( node );
- i++;
- }
-
- /* Load all addresses, free up old stuff as we go */
- node = records;
- while( node ) {
- br = node->data;
- if( ( br->rt != DELETED_PC_REC ) &&
- ( br->rt != DELETED_PALM_REC ) &&
- ( br->rt != MODIFIED_PALM_REC ) &&
- ( br->rt != DELETED_DELETED_PALM_REC ) ) {
- jpilot_load_address( pilotFile, br, folderInd );
- }
- free( br );
- node->data = NULL;
- node = g_list_next( node );
- }
-
- /* Free up list */
- g_list_free( records );
-
- return retVal;
-}
-
-
-/*
-* Read metadata from file.
-*/
static gint jpilot_read_metadata( JPilotFile *pilotFile ) {
gint retVal;
unsigned int rec_size;
return pilotFile->retVal;
}
-/*
-* Setup labels and indexes from metadata.
-* Return: TRUE is setup successfully.
-*/
+/**
+ * Setup labels and indexes from metadata.
+ * \param pilotFile JPilot control data.
+ * \return <i>TRUE</i> is setup successfully.
+ */
static gboolean jpilot_setup_labels( JPilotFile *pilotFile ) {
gboolean retVal = FALSE;
struct AddressAppInfo *ai;
break;
}
}
- pilotFile->labelInd = g_list_append( pilotFile->labelInd, GINT_TO_POINTER(ind) );
+ pilotFile->labelInd = g_list_append(
+ pilotFile->labelInd, GINT_TO_POINTER(ind) );
node = g_list_next( node );
}
retVal = TRUE;
return retVal;
}
-/*
-* Load list with character strings of label names.
-*/
+/**
+ * Load list with character strings of label names.
+ * \param pilotFile JPilot control data.
+ * \param labelList List of label names to load.
+ * \return List of label names loaded.
+ */
GList *jpilot_load_label( JPilotFile *pilotFile, GList *labelList ) {
int i;
for( i = 0; i < JPILOT_NUM_LABELS; i++ ) {
gchar *labelName = ai->labels[i];
if( labelName ) {
- labelList = g_list_append( labelList, g_strdup( labelName ) );
+ labelList = g_list_append(
+ labelList, g_strdup( labelName ) );
}
else {
- labelList = g_list_append( labelList, g_strdup( "" ) );
+ labelList = g_list_append(
+ labelList, g_strdup( "" ) );
}
}
}
return labelList;
}
-/*
-* Return category name for specified category ID.
-* Enter: Category ID.
-* Return: Name, or empty string if not invalid ID. Name should be g_free() when done.
-*/
+/**
+ * Return category name for specified category ID.
+ * \param pilotFile JPilot control data.
+ * \param catID Category ID.
+ * \return Category name, or empty string if not invalid ID. Name should be
+ * <code>g_free()</code> when done.
+ */
gchar *jpilot_get_category_name( JPilotFile *pilotFile, gint catID ) {
gchar *catName = NULL;
return catName;
}
-/*
-* Load list with character strings of phone label names.
-*/
+/**
+ * Load list with character strings of phone label names.
+ * \param pilotFile JPilot control data.
+ * \param labelList List of label names to load.
+ * \return List of label names loaded.
+ */
GList *jpilot_load_phone_label( JPilotFile *pilotFile, GList *labelList ) {
gint i;
for( i = 0; i < JPILOT_NUM_PHONELABELS; i++ ) {
gchar *labelName = ai->phoneLabels[i];
if( labelName ) {
- labelList = g_list_append( labelList, g_strdup( labelName ) );
+ labelList = g_list_append(
+ labelList, g_strdup( labelName ) );
}
else {
- labelList = g_list_append( labelList, g_strdup( "" ) );
+ labelList = g_list_append(
+ labelList, g_strdup( "" ) );
}
}
}
return labelList;
}
-/*
-* Load list with character strings of label names. Only none blank names
-* are loaded.
-* Return: list of labels. Should by g_free()'d when done.
-*/
+/**
+ * Load list with character strings of custom label names. Only none blank
+ * names are loaded.
+ * \param pilotFile JPilot control data.
+ * \param labelList List of label names to load.
+ * \return List of label names loaded. Should be freed when done.
+ */
GList *jpilot_load_custom_label( JPilotFile *pilotFile, GList *labelList ) {
gint i;
g_strchomp( labelName );
g_strchug( labelName );
if( *labelName != '\0' ) {
- labelList = g_list_append( labelList, g_strdup( labelName ) );
+ labelList = g_list_append( labelList,
+ g_strdup( labelName ) );
}
}
}
return labelList;
}
-/*
-* Load list with character strings of category names.
-*/
+/**
+ * Load list with character strings of category names.
+ * \param pilotFile JPilot control data.
+ * \return List of label names loaded. Should be freed when done.
+ */
GList *jpilot_get_category_list( JPilotFile *pilotFile ) {
GList *catList = NULL;
gint i;
for( i = 0; i < JPILOT_NUM_CATEG; i++ ) {
gchar *catName = cat->name[i];
if( catName ) {
- catList = g_list_append( catList, g_strdup( catName ) );
+ catList = g_list_append(
+ catList, g_strdup( catName ) );
}
else {
- catList = g_list_append( catList, g_strdup( "" ) );
+ catList = g_list_append(
+ catList, g_strdup( "" ) );
}
}
}
return catList;
}
-/*
-* Build folder for each category.
-*/
+/**
+ * Build folder in address book for each category.
+ * \param pilotFile JPilot control data.
+ */
static void jpilot_build_category_list( JPilotFile *pilotFile ) {
struct AddressAppInfo *ai = & pilotFile->addrInfo;
struct CategoryAppInfo *cat = & ai->category;
}
}
-/*
-* Remove empty folders (categories).
-*/
+/**
+ * Remove empty (category) folders.
+ * \param pilotFile JPilot control data.
+ */
static void jpilot_remove_empty( JPilotFile *pilotFile ) {
GList *listFolder;
GList *remList;
g_list_free( remList );
}
-/*
-* ============================================================================================
-* Read file into list. Main entry point
-* Return: TRUE if file read successfully.
-* ============================================================================================
-*/
+/**
+ * Read address file into address cache.
+ * \param pilotFile JPilot control data.
+ * \return Error/status code. <code>MGU_SUCCESS</code> if data read
+ * successfully.
+ */
+static gint jpilot_read_file( JPilotFile *pilotFile ) {
+ gint retVal, i;
+ GList *records = NULL;
+ GList *node;
+ buf_rec *br;
+ ItemFolder *folderInd[ JPILOT_NUM_CATEG ];
+
+ /* Read list of records from JPilot files */
+ retVal = jpilot_read_db_files( pilotFile, &records );
+ if( retVal != MGU_SUCCESS ) {
+ jpilot_free_addrlist( records );
+ return retVal;
+ }
+
+ /* Setup labels and category folders */
+ jpilot_setup_labels( pilotFile );
+ jpilot_build_category_list( pilotFile );
+
+ /* Build array of pointers to categories */
+ i = 0;
+ node = addrcache_get_list_folder( pilotFile->addressCache );
+ while( node ) {
+ if( i < JPILOT_NUM_CATEG ) {
+ folderInd[i] = node->data;
+ }
+ node = g_list_next( node );
+ i++;
+ }
+
+ /* Load all addresses, free up old stuff as we go */
+ node = records;
+ while( node ) {
+ br = node->data;
+ if( ( br->rt != DELETED_PC_REC ) &&
+ ( br->rt != DELETED_PALM_REC ) &&
+ ( br->rt != MODIFIED_PALM_REC ) &&
+ ( br->rt != DELETED_DELETED_PALM_REC ) ) {
+ jpilot_load_address( pilotFile, br, folderInd );
+ }
+ free( br->buf );
+ free( br );
+ node->data = NULL;
+ node = g_list_next( node );
+ }
+
+ /* Free up list */
+ g_list_free( records );
+
+ /* Remove empty category folders */
+ jpilot_remove_empty( pilotFile );
+ jpilot_mark_files( pilotFile );
+
+ return retVal;
+}
+
+/**
+ * Read file into list. Main entry point
+ * \param pilotFile JPilot control data.
+ * \return Error/status code. <code>MGU_SUCCESS</code> if data read
+ * successfully.
+ */
gint jpilot_read_data( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, -1 );
pilotFile->retVal = MGU_SUCCESS;
- pilotFile->accessFlag = FALSE;
-
+ pilotFile->addressCache->accessFlag = FALSE;
if( jpilot_check_files( pilotFile ) ) {
addrcache_clear( pilotFile->addressCache );
jpilot_read_metadata( pilotFile );
if( pilotFile->retVal == MGU_SUCCESS ) {
- jpilot_setup_labels( pilotFile );
- jpilot_build_category_list( pilotFile );
pilotFile->retVal = jpilot_read_file( pilotFile );
if( pilotFile->retVal == MGU_SUCCESS ) {
- jpilot_remove_empty( pilotFile );
- jpilot_mark_files( pilotFile );
pilotFile->addressCache->modified = FALSE;
pilotFile->addressCache->dataRead = TRUE;
}
return pilotFile->retVal;
}
-/*
-* Return link list of persons.
-*/
+/**
+ * Return linked list of persons. This is a list of references to ItemPerson
+ * objects. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
+ * functions... this will destroy the addressbook data!
+ *
+ * \param pilotFile JPilot control data.
+ * \return List of persons.
+ */
GList *jpilot_get_list_person( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, NULL );
return addrcache_get_list_person( pilotFile->addressCache );
}
-/*
-* Return link list of folders. This is always NULL since there are
-* no folders in GnomeCard.
-* Return: NULL.
-*/
+/**
+ * Return linked list of folders. This is a list of references to non-empty
+ * category folders. Do <b>NOT</b> attempt to use the
+ * <code>addrbook_free_xxx()</code> functions... this will destroy the
+ * addressbook data!
+ *
+ * \param pilotFile JPilot control data.
+ * \return List of ItemFolder objects. This should not be freed.
+ */
GList *jpilot_get_list_folder( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, NULL );
return addrcache_get_list_folder( pilotFile->addressCache );
}
-/*
-* Return link list of all persons. Note that the list contains references
-* to items. Do *NOT* attempt to use the addrbook_free_xxx() functions...
-* this will destroy the addressbook data!
-* Return: List of items, or NULL if none.
-*/
+/**
+ * Return linked list of all persons. Note that the list contains references
+ * to items. Do <b>NOT</b> attempt to use the <code>addrbook_free_xxx()</code>
+ * functions... this will destroy the addressbook data!
+ *
+ * \param pilotFile JPilot control data.
+ * \return List of items, or NULL if none.
+ */
GList *jpilot_get_all_persons( JPilotFile *pilotFile ) {
g_return_val_if_fail( pilotFile != NULL, NULL );
return addrcache_get_all_persons( pilotFile->addressCache );
}
-/*
-* Check label list for specified label.
+/**
+ * Check label list for specified label name.
+ * \param ai Address info to check.
+ * \param lblCheck Label name to check.
+ * \return Index of label in address structure. <code>-1</code> if NULL/empty
+ * label name, <code>-2</code> if label not found.
*/
-gint jpilot_check_label( struct AddressAppInfo *ai, gchar *lblCheck ) {
+static gint jpilot_check_label( struct AddressAppInfo *ai, gchar *lblCheck ) {
gint i;
gchar *lblName;
return -2;
}
-/*
-* Validate that all parameters specified.
-* Return: TRUE if data is good.
-*/
+/**
+ * Validate that all parameters specified.
+ * \param pilotFile JPilot control data.
+ * \return <i>TRUE</i> if data is good.
+ */
gboolean jpilot_validate( JPilotFile *pilotFile ) {
gboolean retVal;
gchar *name;
#define WORK_BUFLEN 1024
-/*
-* Attempt to find a valid JPilot file.
-* Return: Filename, or home directory if not found, or empty string if
-* no home. Filename should be g_free() when done.
-*/
+/**
+ * Attempt to find a valid JPilot file.
+ * \param pilotFile JPilot control data.
+ * \return Filename, or home directory if not found, or empty string if
+ * no home. Filename should be <code>g_free()</code> when done.
+ */
gchar *jpilot_find_pilotdb( void ) {
- gchar *homedir;
+ const gchar *homedir;
gchar str[ WORK_BUFLEN ];
gint len;
FILE *fp;
strcat( str, JPILOT_DBHOME_FILE );
/* Attempt to open */
- if( ( fp = fopen( str, "r" ) ) != NULL ) {
+ if( ( fp = fopen( str, "rb" ) ) != NULL ) {
fclose( fp );
}
else {
return g_strdup( str );
}
-/*
-* Attempt to read file, testing for valid JPilot format.
-* Return: TRUE if file appears to be valid format.
-*/
+/**
+ * Attempt to read file, testing for valid JPilot format.
+ * \param fileSpec File specification to read.
+ * \return <i>TRUE<i> if file appears to be valid format.
+ */
gint jpilot_test_read_file( const gchar *fileSpec ) {
JPilotFile *pilotFile;
gint retVal;
return retVal;
}
-/*
-* Check whether label is in custom labels.
-* Return: TRUE if found.
-*/
+/**
+ * Check whether label is in list of custom labels.
+ * \param pilotFile JPilot control data.
+ * \param labelName to test.
+ * \return <i>TRUE</i> if found.
+ */
gboolean jpilot_test_custom_label( JPilotFile *pilotFile, const gchar *labelName ) {
gboolean retVal;
GList *node;
return retVal;
}
-/*
-* Test whether pilot link library installed.
-* Return: TRUE if library available.
-*/
+/**
+ * Test whether pilot link library installed.
+ * \return <i>TRUE</i> if library available.
+ */
gboolean jpilot_test_pilot_lib( void ) {
- void *handle, *fun;
-
- handle = dlopen( PILOT_LINK_LIB_NAME, RTLD_LAZY );
- if( ! handle ) {
- return FALSE;
- }
-
- /* Test for symbols we need */
- fun = dlsym( handle, "unpack_Address" );
- if( ! fun ) {
- dlclose( handle );
- return FALSE;
- }
-
- fun = dlsym( handle, "unpack_AddressAppInfo" );
- if( ! fun ) {
- dlclose( handle );
- return FALSE;
- }
- dlclose( handle );
return TRUE;
}
projects / claws.git / blobdiff