2012-09-19 [mones] 3.8.1cvs63
[claws.git] / src / addritem.c
index d71b281b5791b7782630da84984fa4444f136de8..ae3dc4e4e1caa1848e82b96dd1d6147b5a7e9465 100644 (file)
@@ -1,10 +1,10 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 2001-2007 Match Grun and the Claws Mail team
+ * Copyright (C) 2001-2012 Match Grun and the Claws Mail team
  *
  * 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
@@ -13,8 +13,8 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 /*
@@ -113,7 +113,7 @@ void addritem_email_set_remarks( ItemEMail *email, const gchar *value ) {
  * \param item E-Mail item to free.
  */
 void addritem_free_item_email( ItemEMail *item ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
 
        /* Free internal stuff */
        g_free( ADDRITEM_ID(item) );
@@ -166,7 +166,7 @@ UserAttribute *addritem_copy_attribute( UserAttribute *item ) {
  * \param value ID.
  */
 void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
        item->uid = mgu_replace_string( item->uid, value );
 }
 
@@ -176,7 +176,7 @@ void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
  * \param value Name.
  */
 void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
        item->name = mgu_replace_string( item->name, value );
 }
 
@@ -186,7 +186,7 @@ void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
  * \param value Value.
  */
 void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
        item->value = mgu_replace_string( item->value, value );
 }
 
@@ -195,7 +195,7 @@ void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
  * \param item Attribute object to free.
  */
 void addritem_free_attribute( UserAttribute *item ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
        g_free( item->uid );
        g_free( item->name );
        g_free( item->value );
@@ -217,6 +217,7 @@ ItemPerson *addritem_create_item_person( void ) {
        ADDRITEM_NAME(person) = NULL;
        ADDRITEM_PARENT(person) = NULL;
        ADDRITEM_SUBTYPE(person) = 0;
+       person->picture = NULL;
        person->firstName = NULL;
        person->lastName = NULL;
        person->nickName = NULL;
@@ -224,6 +225,7 @@ ItemPerson *addritem_create_item_person( void ) {
        person->listAttrib = NULL;
        person->externalID = NULL;
        person->isOpened = FALSE;
+       person->status = NONE;
        return person;
 }
 
@@ -239,14 +241,44 @@ ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
        if( item ) {
                itemNew = addritem_create_item_person();
                ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
+               itemNew->picture = g_strdup( ADDRITEM_ID(itemNew) );
                itemNew->firstName = g_strdup( item->firstName );
                itemNew->lastName = g_strdup( item->lastName );
                itemNew->nickName = g_strdup( item->nickName );
                itemNew->externalID = g_strdup( item->externalID );
+               itemNew->status = item->status;
        }
        return itemNew;
 }
 
+/**
+ * Specify picture for person object.
+ * \param person Person object.
+ * \param value Picture.
+ */
+void addritem_person_set_picture( ItemPerson *person, const gchar *value ) {
+       if (!value || g_utf8_validate(value, -1, NULL))
+               person->picture = mgu_replace_string( person->picture, value );
+       else {
+               gchar *out = conv_codeset_strdup(value, 
+                               conv_get_locale_charset_str_no_utf8(),
+                               CS_INTERNAL);
+               if (out)
+                       person->picture = mgu_replace_string( person->picture, out );
+               g_free(out);
+       }
+}
+
+/**
+ * Get picture for person object.
+ * \param person Person object.
+ * \param value Picture.
+ */
+gchar *addritem_person_get_picture( ItemPerson *person) {
+       if (person->picture)
+               return g_strdup(person->picture);
+       return NULL;
+}
 /**
  * Specify first name for person object.
  * \param person Person object.
@@ -338,34 +370,6 @@ void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
        person->isOpened = value;
 }
 
-/**
- * Test whether person's data is empty.
- * \param  person Person to test.
- * \return <i>TRUE</i> if empty.
- */
-gboolean addritem_person_empty( ItemPerson *person ) {
-       gchar *t;
-
-       if( person == NULL ) return FALSE;
-
-       t = ADDRITEM_NAME(person);
-       if( t != NULL && strlen( t ) > 0 ) return FALSE;
-
-       t = person->firstName;
-       if( t != NULL && strlen( t ) > 0 ) return FALSE;
-
-       t = person->lastName;
-       if( t != NULL && strlen( t ) > 0 ) return FALSE;
-
-       t = person->nickName;
-       if( t != NULL && strlen( t ) > 0 ) return FALSE;
-
-       if( person->listEMail  != NULL ) return FALSE;
-       if( person->listAttrib != NULL ) return FALSE;
-
-       return TRUE;
-}
-
 /**
  * Free linked list of item addresses; both addresses and the list are freed.
  * It is assumed that addresses are *NOT* contained within some other
@@ -406,11 +410,12 @@ void addritem_free_list_attribute( GList *list ) {
  * \param person Person object to free.
  */
 void addritem_free_item_person( ItemPerson *person ) {
-       g_return_if_fail( person != NULL );
+       cm_return_if_fail( person != NULL );
 
        /* Free internal stuff */
        g_free( ADDRITEM_ID(person) );
        g_free( ADDRITEM_NAME(person) );
+       g_free( person->picture );
        g_free( person->firstName );
        g_free( person->lastName );
        g_free( person->nickName );
@@ -423,6 +428,7 @@ void addritem_free_item_person( ItemPerson *person ) {
        ADDRITEM_NAME(person) = NULL;
        ADDRITEM_PARENT(person) = NULL;
        ADDRITEM_SUBTYPE(person) = 0;
+       person->picture = NULL;
        person->firstName = NULL;
        person->lastName = NULL;
        person->nickName = NULL;
@@ -439,7 +445,7 @@ void addritem_free_item_person( ItemPerson *person ) {
  * \param stream Output stream.
  */
 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
        fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
        fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
        fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
@@ -454,7 +460,7 @@ void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
  * \param stream Output stream.
  */
 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
-       g_return_if_fail( item != NULL );
+       cm_return_if_fail( item != NULL );
        fprintf( stream, "\t\tuid  : '%s'\n", item->uid );
        fprintf( stream, "\t\tname : '%s'\n", item->name );
        fprintf( stream, "\t\tvalue: '%s'\n", item->value );
@@ -468,11 +474,12 @@ static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
  */
 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
        GList *node;
-       g_return_if_fail( person != NULL );
+       cm_return_if_fail( person != NULL );
        fprintf( stream, "Person:\n" );
        fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
        fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
        fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
+       fprintf( stream, "\tphoto: '%s'\n", person->picture );
        fprintf( stream, "\tfirst: '%s'\n", person->firstName );
        fprintf( stream, "\tlast : '%s'\n", person->lastName );
        fprintf( stream, "\tnick : '%s'\n", person->nickName );
@@ -491,6 +498,17 @@ void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
                addritem_print_attribute( node->data, stream );
                node = g_list_next( node );
        }
+       gchar *current_status;
+       switch (person->status) {
+               case NONE: current_status = g_strdup("Unchanged"); break;
+               case ADD_ENTRY: current_status = g_strdup("New"); break;
+               case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
+               case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
+               default: current_status = g_strdup("Unknown");
+       }
+       fprintf( stream, "\t\tStatus: %s\n", current_status );
+       if ( current_status )
+               g_free(current_status);
        fprintf( stream, "\t===\n" );
 }
 
@@ -503,8 +521,8 @@ void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
        GList *node;
 
-       g_return_val_if_fail( person != NULL, FALSE );
-       g_return_val_if_fail( email != NULL, FALSE );
+       cm_return_val_if_fail( person != NULL, FALSE );
+       cm_return_val_if_fail( email != NULL, FALSE );
 
        node = person->listEMail;
        while( node ) {
@@ -527,7 +545,7 @@ ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email )
        gboolean found = FALSE;
        GList *node;
 
-       g_return_val_if_fail( person != NULL, NULL );
+       cm_return_val_if_fail( person != NULL, NULL );
        if( email == NULL ) return NULL;
 
        /* Look for email */
@@ -561,81 +579,31 @@ ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email )
 void addritem_person_add_attribute(
                        ItemPerson *person, UserAttribute *attrib )
 {
-       g_return_if_fail( person != NULL );
+       cm_return_if_fail( person != NULL );
        person->listAttrib = g_list_append( person->listAttrib, attrib );
 }
 
 /**
- * Remove attribute with specified ID from person.
- * \param  person Person object.
- * \param  aid    Attribute ID to remove.
- * \return UserAttribute object, or <i>NULL</i> if not found. Note that
- *         attribute object should still be freed after calling this method.
- */
-UserAttribute *addritem_person_remove_attrib_id(
-                       ItemPerson *person, const gchar *aid )
-{
-       UserAttribute *attrib = NULL;
-       GList *node;
-
-       g_return_val_if_fail( person != NULL, NULL );
-       if( aid == NULL || *aid == '\0' ) return NULL;
-
-       /* Look for attribute */
-       node = person->listAttrib;
-       while( node ) {
-               UserAttribute *attr = node->data;
-               gchar *ida = attr->uid;
-               if( ida ) {
-                       if( strcmp( ida, aid ) == 0 ) {
-                               attrib = attr;
-                       }
-               }
-               node = g_list_next( node );
-       }
-
-       /* Remove email from person's address list */
-       if( person->listAttrib ) {
-               person->listAttrib = g_list_remove( person->listAttrib, attrib );
-       }
-       return attrib;
-}
-
-/**
- * Remove attribute from person.
+ * Remove user attribute from specified person.
  * \param  person Person.
  * \param  attrib Attribute to remove.
- * \return UserAttribute object to remove. Note that attribute object should
- *         still be freed.
  */
-UserAttribute *addritem_person_remove_attribute(
-                       ItemPerson *person, UserAttribute *attrib )
-{
-       gboolean found = FALSE;
-       GList *node;
-
-       g_return_val_if_fail( person != NULL, NULL );
-       if( attrib == NULL ) return NULL;
-
-       /* Look for attribute */
-       node = person->listAttrib;
-       while( node ) {
-               if( node-> data == attrib ) {
-                       found = TRUE;
+void addritem_person_remove_attribute( ItemPerson *person, const gchar *attrib ) {
+       cm_return_if_fail( person != NULL && attrib != NULL );
+       GList *attrib_list;
+
+       attrib_list = person->listAttrib;
+       while (attrib_list) {
+               UserAttribute *user_attrib = attrib_list->data;
+               if (strcmp(user_attrib->name, attrib) == 0) {
+                       person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
                        break;
                }
-               node = g_list_next( node );
+               attrib_list = g_list_next(attrib_list);
        }
-
-       if( found ) {
-               /* Remove attribute */
-               if( person->listAttrib ) {
-                       person->listAttrib = g_list_remove( person->listAttrib, attrib );
-               }
-       }
-       return attrib;
 }
 
+
 /**
  * Create new address book group object.
  * \return Initialized group object.
@@ -662,7 +630,7 @@ ItemGroup *addritem_create_item_group( void ) {
 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
        ItemGroup *itemNew;
 
-       itemNew = g_new0( ItemGroup, 1 );
+       itemNew = NULL;
        if( item ) {
                itemNew = addritem_create_item_group();
                ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
@@ -685,7 +653,7 @@ void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
  * \param group Group to free.
  */
 void addritem_free_item_group( ItemGroup *group ) {
-       g_return_if_fail( group != NULL );
+       cm_return_if_fail( group != NULL );
 
        /* Free internal stuff */
        g_free( ADDRITEM_ID(group) );
@@ -716,8 +684,8 @@ void addritem_free_item_group( ItemGroup *group ) {
 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
        GList *node;
 
-       g_return_val_if_fail( group != NULL, FALSE );
-       g_return_val_if_fail( email != NULL, FALSE );
+       cm_return_val_if_fail( group != NULL, FALSE );
+       cm_return_val_if_fail( email != NULL, FALSE );
 
        node = group->listEMail;
        while( node ) {
@@ -760,7 +728,7 @@ void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
        GList *node;
        ItemPerson *person;
        ItemEMail *item;
-       g_return_if_fail( group != NULL );
+       cm_return_if_fail( group != NULL );
        fprintf( stream, "Group:\n" );
        fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
        fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
@@ -861,7 +829,7 @@ void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
  * \param folder Folder to free.
  */
 void addritem_free_item_folder( ItemFolder *folder ) {
-       g_return_if_fail( folder != NULL );
+       cm_return_if_fail( folder != NULL );
 
        /* Free internal stuff */
        g_free( ADDRITEM_ID(folder) );
@@ -888,28 +856,6 @@ void addritem_free_item_folder( ItemFolder *folder ) {
        g_free( folder );
 }
 
-/**
- * Free up folders recursively. Note: this only frees up the lists of
- * children and *NOT* the children objects (folders, groups and person).
- * This should be done prior to calling this function.
- * \param parent Parent folder object to be processed.
- */
-static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
-       GList *node = parent->listFolder;
-
-       while( node ) {
-               ItemFolder *folder = node->data;
-               addritem_free_item_folder_recurse( folder );
-               node = g_list_next( node );
-       }
-       g_list_free( parent->listPerson );
-       g_list_free( parent->listGroup );
-       g_list_free( parent->listFolder );
-       parent->listPerson = NULL;
-       parent->listGroup = NULL;
-       parent->listFolder = NULL;
-}
-
 /**
  * Add person into folder.
  * \param  folder Folder.
@@ -917,8 +863,8 @@ static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
  * \return <i>TRUE</i> if person added.
  */
 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
-       g_return_val_if_fail( folder != NULL, FALSE );
-       g_return_val_if_fail( item != NULL, FALSE );
+       cm_return_val_if_fail( folder != NULL, FALSE );
+       cm_return_val_if_fail( item != NULL, FALSE );
 
        folder->listPerson = g_list_append( folder->listPerson, item );
        ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
@@ -932,8 +878,8 @@ gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
  * \return <i>TRUE</i> if folder added.
  */
 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
-       g_return_val_if_fail( folder != NULL, FALSE );
-       g_return_val_if_fail( item != NULL, FALSE );
+       cm_return_val_if_fail( folder != NULL, FALSE );
+       cm_return_val_if_fail( item != NULL, FALSE );
 
        folder->listFolder = g_list_append( folder->listFolder, item );
        ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
@@ -947,8 +893,8 @@ gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
  * \return <i>TRUE</i> if group added.
  */
 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
-       g_return_val_if_fail( folder != NULL, FALSE );
-       g_return_val_if_fail( item != NULL, FALSE );
+       cm_return_val_if_fail( folder != NULL, FALSE );
+       cm_return_val_if_fail( item != NULL, FALSE );
 
        folder->listGroup = g_list_append( folder->listGroup, item );
        ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
@@ -965,7 +911,7 @@ void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
        /* ItemPerson *person; */
        ItemFolder *parent;
 
-       g_return_if_fail( folder != NULL );
+       cm_return_if_fail( folder != NULL );
 
        fprintf( stream, "Folder:\n" );
        fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
@@ -1043,15 +989,15 @@ GList *addritem_folder_get_person_list( ItemFolder *folder ) {
        GList *list = NULL;
        GList *node = NULL;
 
-       g_return_val_if_fail( folder != NULL, NULL );
+       cm_return_val_if_fail( folder != NULL, NULL );
 
        node = folder->listPerson;
        while( node ) {
                ItemPerson *person = node->data;
-               list = g_list_append( list, person );
+               list = g_list_prepend( list, person );
                node = g_list_next( node );
        }
-       return list;
+       return g_list_reverse(list);
 }
 
 /**
@@ -1066,72 +1012,15 @@ GList *addritem_folder_get_group_list( ItemFolder *folder ) {
        GList *list = NULL;
        GList *node = NULL;
 
-       g_return_val_if_fail( folder != NULL, NULL );
+       cm_return_val_if_fail( folder != NULL, NULL );
 
        node = folder->listGroup;
        while( node ) {
                ItemGroup *group = node->data;
-               list = g_list_append( list, group );
+               list = g_list_prepend( list, group );
                node = g_list_next( node );
        }
-       return list;
-}
-
-/**
- * Move person's email item.
- * \param  person     Person.
- * \param  itemMove   Item to move.
- * \param  itemTarget Target item before which to move item.
- * \return Reference to item that was moved, or <i>NULL</i> if null arguments
- *         supplied.
- */
-
-ItemEMail *addritem_move_email_before(
-               ItemPerson *person, ItemEMail *itemMove, ItemEMail *itemTarget )
-{
-       gint posT, posM;
-
-       g_return_val_if_fail( person != NULL, NULL );
-
-       if( itemTarget == NULL ) return NULL;
-       if( itemMove == NULL ) return NULL;
-       if( itemMove == itemTarget ) return itemMove;
-
-       posT = g_list_index( person->listEMail, itemTarget );
-       if( posT < 0 ) return NULL;
-       posM = g_list_index( person->listEMail, itemMove );
-       if( posM < 0 ) return NULL;
-       person->listEMail = g_list_remove( person->listEMail, itemMove );
-       person->listEMail = g_list_insert( person->listEMail, itemMove, posT );
-       return itemMove;
-}
-
-/**
- * Move person's email item.
- * \param  person    Person.
- * \param  itemMove  Item to move.
- * \param  itemTarget Target item after which to move item.
- * \return Reference to item that was moved, or <i>NULL</i> if null arguments
- *         supplied.
- */
-ItemEMail *addritem_move_email_after(
-               ItemPerson *person, ItemEMail *itemMove, ItemEMail *itemTarget )
-{
-       gint posT, posM;
-
-       g_return_val_if_fail( person != NULL, NULL );
-
-       if( itemTarget == NULL ) return NULL;
-       if( itemMove == NULL ) return NULL;
-       if( itemMove == itemTarget ) return itemMove;
-
-       posT = g_list_index( person->listEMail, itemTarget );
-       if( posT < 0 ) return NULL;
-       posM = g_list_index( person->listEMail, itemMove );
-       if( posM < 0 ) return NULL;
-       person->listEMail = g_list_remove( person->listEMail, itemMove );
-       person->listEMail = g_list_insert( person->listEMail, itemMove, 1+posT );
-       return itemMove;
+       return g_list_reverse(list);
 }
 
 /**
@@ -1144,7 +1033,7 @@ void addritem_parse_first_last( ItemPerson *person ) {
        gchar *p;
        gint len, i;
 
-       g_return_if_fail( person != NULL );
+       cm_return_if_fail( person != NULL );
 
        name = ADDRITEM_NAME(person);
        if( name == NULL ) return;