src/addritem.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001-2017 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  * General primitive address item objects.
  21  */
  22
  23 #include <glib.h>
  24 #include <stdio.h>
  25 #include <string.h>
  26
  27 #include "defs.h"
  28 #include "utils.h"
  29 #include "addritem.h"
  30 #include "mgutils.h"
  31 #include "codeconv.h"
  32
  33 /**
  34  * Create new email address item.
  35  * \return Initialized email item.
  36  */
  37 ItemEMail *addritem_create_item_email( void ) {
  38         ItemEMail *item;
  39         item = g_new0( ItemEMail, 1 );
  40         ADDRITEM_TYPE(item) = ITEMTYPE_EMAIL;
  41         ADDRITEM_ID(item) = NULL;
  42         ADDRITEM_NAME(item) = NULL;
  43         ADDRITEM_PARENT(item) = NULL;
  44         ADDRITEM_SUBTYPE(item) = 0;
  45         item->address = NULL;
  46         item->remarks = NULL;
  47         return item;
  48 }
  49
  50 /**
  51  * Create a shallow copy of specified email address item.
  52  * \param  item E-Mail to copy.
  53  * \return Copy of email, or <i>NULL</i> if null argument supplied.
  54  */
  55 ItemEMail *addritem_copy_item_email( ItemEMail *item ) {
  56         ItemEMail *itemNew = NULL;
  57         if( item ) {
  58                 itemNew = addritem_create_item_email();
  59                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
  60                 itemNew->address = g_strdup( item->address );
  61                 itemNew->remarks = g_strdup( item->remarks );
  62         }
  63         return itemNew;
  64 }
  65
  66 /**
  67  * Create a full copy (deep copy) of specified email address item.
  68  * \param  item E-Mail to copy.
  69  * \return Copy of email.
  70  */
  71 ItemEMail *addritem_copyfull_item_email( ItemEMail *item ) {
  72         ItemEMail *itemNew = NULL;
  73         if( item ) {
  74                 itemNew = addritem_create_item_email();
  75                 ADDRITEM_ID(itemNew) = g_strdup( ADDRITEM_ID(item) );
  76                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
  77                 ADDRITEM_PARENT(itemNew) = ADDRITEM_PARENT(item);
  78                 itemNew->address = g_strdup( item->address );
  79                 itemNew->remarks = g_strdup( item->remarks );
  80         }
  81         return itemNew;
  82 }
  83
  84 /**
  85  * Specify alias for email.
  86  * \param email E-Mail item.
  87  * \param value Alias.
  88  */
  89 void addritem_email_set_alias( ItemEMail *email, const gchar *value ) {
  90         ADDRITEM_NAME(email) = mgu_replace_string( ADDRITEM_NAME(email), value );
  91 }
  92
  93 /**
  94  * Specify address for email.
  95  * \param email E-Mail item.
  96  * \param value Address.
  97  */
  98 void addritem_email_set_address( ItemEMail *email, const gchar *value ) {
  99         email->address = mgu_replace_string( email->address, value );
 100 }
 101
 102 /**
 103  * Specify remarks for email.
 104  * \param email E-Mail item.
 105  * \param value Remarks.
 106  */
 107 void addritem_email_set_remarks( ItemEMail *email, const gchar *value ) {
 108         email->remarks = mgu_replace_string( email->remarks, value );
 109 }
 110
 111 /**
 112  * Free address item email object.
 113  * \param item E-Mail item to free.
 114  */
 115 void addritem_free_item_email( ItemEMail *item ) {
 116         cm_return_if_fail( item != NULL );
 117
 118         /* Free internal stuff */
 119         g_free( ADDRITEM_ID(item) );
 120         g_free( ADDRITEM_NAME(item) );
 121         g_free( item->address );
 122         g_free( item->remarks );
 123
 124         ADDRITEM_OBJECT(item)->type = ITEMTYPE_NONE;
 125         ADDRITEM_ID(item) = NULL;
 126         ADDRITEM_NAME(item) = NULL;
 127         ADDRITEM_PARENT(item) = NULL;
 128         ADDRITEM_SUBTYPE(item) = 0;
 129         item->address = NULL;
 130         item->remarks = NULL;
 131         g_free( item );
 132 }
 133
 134 /**
 135  * Create new attribute object.
 136  * \return Initialized attribute object.
 137  */
 138 UserAttribute *addritem_create_attribute( void ) {
 139         UserAttribute *item;
 140         item = g_new0( UserAttribute, 1 );
 141         item->uid = NULL;
 142         item->name = NULL;
 143         item->value = NULL;
 144         return item;
 145 }
 146
 147 /**
 148  * Create copy (deep copy) of specified attribute.
 149  * \param  item Attribute to copy.
 150  * \return Copy of attribute, or <i>NULL</i> if null argument supplied.
 151  */
 152 UserAttribute *addritem_copy_attribute( UserAttribute *item ) {
 153         UserAttribute *itemNew = NULL;
 154         if( item ) {
 155                 itemNew = addritem_create_attribute();
 156                 itemNew->uid = g_strdup( item->uid );
 157                 itemNew->name = g_strdup( item->name );
 158                 itemNew->value = g_strdup( item->value );
 159         }
 160         return itemNew;
 161 }
 162
 163 /**
 164  * Specify ID for attribute.
 165  * \param item Attribute object.
 166  * \param value ID.
 167  */
 168 void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
 169         cm_return_if_fail( item != NULL );
 170         item->uid = mgu_replace_string( item->uid, value );
 171 }
 172
 173 /**
 174  * Specify name for attribute.
 175  * \param item Attribute object.
 176  * \param value Name.
 177  */
 178 void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
 179         cm_return_if_fail( item != NULL );
 180         item->name = mgu_replace_string( item->name, value );
 181 }
 182
 183 /**
 184  * Specify value for attribute.
 185  * \param item Attribute object.
 186  * \param value Value.
 187  */
 188 void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
 189         cm_return_if_fail( item != NULL );
 190         item->value = mgu_replace_string( item->value, value );
 191 }
 192
 193 /**
 194  * Free user attribute.
 195  * \param item Attribute object to free.
 196  */
 197 void addritem_free_attribute( UserAttribute *item ) {
 198         cm_return_if_fail( item != NULL );
 199         g_free( item->uid );
 200         g_free( item->name );
 201         g_free( item->value );
 202         item->uid = NULL;
 203         item->name = NULL;
 204         item->value = NULL;
 205         g_free( item );
 206 }
 207
 208 /**
 209  * Create new address book person.
 210  * \return Initialized person object.
 211  */
 212 ItemPerson *addritem_create_item_person( void ) {
 213         ItemPerson *person;
 214         person = g_new0( ItemPerson, 1 );
 215         ADDRITEM_TYPE(person) = ITEMTYPE_PERSON;
 216         ADDRITEM_ID(person) = NULL;
 217         ADDRITEM_NAME(person) = NULL;
 218         ADDRITEM_PARENT(person) = NULL;
 219         ADDRITEM_SUBTYPE(person) = 0;
 220         person->picture = NULL;
 221         person->firstName = NULL;
 222         person->lastName = NULL;
 223         person->nickName = NULL;
 224         person->listEMail = NULL;
 225         person->listAttrib = NULL;
 226         person->externalID = NULL;
 227         person->isOpened = FALSE;
 228         person->status = NONE;
 229         return person;
 230 }
 231
 232 /**
 233  * Create a shallow copy of address book person object.
 234  * \param  item Person to copy.
 235  * \return Copy of person, or <i>NULL</i> if null argument supplied.
 236  */
 237 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
 238         ItemPerson *itemNew;
 239
 240         itemNew = NULL;
 241         if( item ) {
 242                 itemNew = addritem_create_item_person();
 243                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 244                 itemNew->picture = g_strdup( ADDRITEM_ID(itemNew) );
 245                 itemNew->firstName = g_strdup( item->firstName );
 246                 itemNew->lastName = g_strdup( item->lastName );
 247                 itemNew->nickName = g_strdup( item->nickName );
 248                 itemNew->externalID = g_strdup( item->externalID );
 249                 itemNew->status = item->status;
 250         }
 251         return itemNew;
 252 }
 253
 254 /**
 255  * Specify picture for person object.
 256  * \param person Person object.
 257  * \param value Picture.
 258  */
 259 void addritem_person_set_picture( ItemPerson *person, const gchar *value ) {
 260         if (!value || g_utf8_validate(value, -1, NULL))
 261                 person->picture = mgu_replace_string( person->picture, value );
 262         else {
 263                 gchar *out = conv_codeset_strdup(value,
 264                                 conv_get_locale_charset_str_no_utf8(),
 265                                 CS_INTERNAL);
 266                 if (out)
 267                         person->picture = mgu_replace_string( person->picture, out );
 268                 g_free(out);
 269         }
 270 }
 271
 272 /**
 273  * Get picture for person object.
 274  * \param person Person object.
 275  */
 276 gchar *addritem_person_get_picture( ItemPerson *person) {
 277         if (person->picture)
 278                 return g_strdup(person->picture);
 279         return NULL;
 280 }
 281
 282 /**
 283  * Delete picture for person object.
 284  * \param person Person object.
 285  */
 286 void addritem_person_remove_picture( ItemPerson *person) {
 287         if (person->picture) {
 288                 gchar *filename = g_strconcat( get_rc_dir(), G_DIR_SEPARATOR_S,
 289                         ADDRBOOK_DIR, G_DIR_SEPARATOR_S, person->picture,
 290                         ".png", NULL );
 291                 if (is_file_exist(filename)) {
 292                         debug_print("removing addressbook picture %s\n",
 293                                 filename);
 294                         if (claws_unlink(filename) < 0) {
 295                                 FILE_OP_ERROR(filename, "remove");
 296                                 g_free(filename);
 297                                 return;
 298                         }
 299                 }
 300                 g_free(person->picture);
 301                 person->picture = NULL;
 302                 g_free(filename);
 303         }
 304 }
 305
 306 /**
 307  * Specify first name for person object.
 308  * \param person Person object.
 309  * \param value Name.
 310  */
 311 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
 312         if (!value || g_utf8_validate(value, -1, NULL))
 313                 person->firstName = mgu_replace_string( person->firstName, value );
 314         else {
 315                 gchar *out = conv_codeset_strdup(value,
 316                                 conv_get_locale_charset_str_no_utf8(),
 317                                 CS_INTERNAL);
 318                 if (out)
 319                         person->firstName = mgu_replace_string( person->firstName, out );
 320                 g_free(out);
 321         }
 322 }
 323
 324 /**
 325  * Specify last name for person object.
 326  * \param person Person object.
 327  * \param value name.
 328  */
 329 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
 330         if (!value || g_utf8_validate(value, -1, NULL))
 331                 person->lastName = mgu_replace_string( person->lastName, value );
 332         else {
 333                 gchar *out = conv_codeset_strdup(value,
 334                                 conv_get_locale_charset_str_no_utf8(),
 335                                 CS_INTERNAL);
 336                 if (out)
 337                         person->lastName = mgu_replace_string( person->lastName, out );
 338                 g_free(out);
 339         }
 340 }
 341
 342 /**
 343  * Specify nick name for person object.
 344  * \param person Person object.
 345  * \param value name.
 346  */
 347 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
 348         if (!value || g_utf8_validate(value, -1, NULL))
 349                 person->nickName = mgu_replace_string( person->nickName, value );
 350         else {
 351                 gchar *out = conv_codeset_strdup(value,
 352                                 conv_get_locale_charset_str_no_utf8(),
 353                                 CS_INTERNAL);
 354                 if (out)
 355                         person->nickName = mgu_replace_string( person->nickName, out );
 356                 g_free(out);
 357         }
 358 }
 359
 360 /**
 361  * Specify common name for person object.
 362  * \param person Person object.
 363  * \param value name.
 364  */
 365 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
 366         if (!value || g_utf8_validate(value, -1, NULL))
 367                 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
 368         else {
 369                 gchar *out = conv_codeset_strdup(value,
 370                                 conv_get_locale_charset_str_no_utf8(),
 371                                 CS_INTERNAL);
 372                 if (out)
 373                         ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
 374                 g_free(out);
 375         }
 376 }
 377
 378 /**
 379  * Specify external ID for person object.
 380  * \param person Person object.
 381  * \param value ID.
 382  */
 383 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
 384         person->externalID = mgu_replace_string( person->externalID, value );
 385 }
 386
 387 /**
 388  * Specify value of open indicator for person object. This is typically used to
 389  * simplify open/close folders in the address book GUI.
 390  * \param person Person object.
 391  * \param value  Value for indicator. Set to <i>TRUE</i> if opened.
 392  */
 393 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
 394         person->isOpened = value;
 395 }
 396
 397 /**
 398  * Free linked list of item addresses; both addresses and the list are freed.
 399  * It is assumed that addresses are *NOT* contained within some other
 400  * container.
 401  * \param list List of addresses to be freed.
 402  */
 403 void addritem_free_list_email( GList *list ) {
 404         GList *node = list;
 405         while( node ) {
 406                 ItemEMail *email = node->data;
 407
 408                 addritem_free_item_email( email );
 409                 node->data = NULL;
 410                 node = g_list_next( node );
 411         }
 412         g_list_free( list );
 413         list = NULL;
 414 }
 415
 416 /**
 417  * Free linked list of attributes; both attributes and the list are freed.
 418  * It is assumed that attributes are *NOT* contained within some other
 419  * container.
 420  * \param list List of attributes to be freed.
 421  */
 422 void addritem_free_list_attribute( GList *list ) {
 423         GList *node = list;
 424         while( node ) {
 425                 addritem_free_attribute( node->data );
 426                 node->data = NULL;
 427                 node = g_list_next( node );
 428         }
 429         g_list_free( list );
 430 }
 431
 432 /**
 433  * Free address person object.
 434  * \param person Person object to free.
 435  */
 436 void addritem_free_item_person( ItemPerson *person ) {
 437         cm_return_if_fail( person != NULL );
 438
 439         /* Free internal stuff */
 440         g_free( ADDRITEM_ID(person) );
 441         g_free( ADDRITEM_NAME(person) );
 442         g_free( person->picture );
 443         g_free( person->firstName );
 444         g_free( person->lastName );
 445         g_free( person->nickName );
 446         g_free( person->externalID );
 447         g_list_free( person->listEMail );
 448         addritem_free_list_attribute( person->listAttrib );
 449
 450         ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
 451         ADDRITEM_ID(person) = NULL;
 452         ADDRITEM_NAME(person) = NULL;
 453         ADDRITEM_PARENT(person) = NULL;
 454         ADDRITEM_SUBTYPE(person) = 0;
 455         person->picture = NULL;
 456         person->firstName = NULL;
 457         person->lastName = NULL;
 458         person->nickName = NULL;
 459         person->externalID = NULL;
 460         person->listEMail = NULL;
 461         person->listAttrib = NULL;
 462
 463         g_free( person );
 464 }
 465
 466 /**
 467  * Print E-Mail address object for debug.
 468  * \param item   Item to print.
 469  * \param stream Output stream.
 470  */
 471 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
 472         cm_return_if_fail( item != NULL );
 473         fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
 474         fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
 475         fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
 476         fprintf( stream, "\t\taddr: '%s'\n", item->address );
 477         fprintf( stream, "\t\trems: '%s'\n", item->remarks );
 478         fprintf( stream, "\t\t---\n" );
 479 }
 480
 481 /**
 482  * Print user attribute object for debug.
 483  * \param item   Attribute to print.
 484  * \param stream Output stream.
 485  */
 486 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
 487         cm_return_if_fail( item != NULL );
 488         fprintf( stream, "\t\tuid  : '%s'\n", item->uid );
 489         fprintf( stream, "\t\tname : '%s'\n", item->name );
 490         fprintf( stream, "\t\tvalue: '%s'\n", item->value );
 491         fprintf( stream, "\t\t---\n" );
 492 }
 493
 494 /**
 495  * Print person item for debug.
 496  * \param person Person to print.
 497  * \param stream Output stream.
 498  */
 499 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
 500         GList *node;
 501         cm_return_if_fail( person != NULL );
 502         fprintf( stream, "Person:\n" );
 503         fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
 504         fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
 505         fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
 506         fprintf( stream, "\tphoto: '%s'\n", person->picture );
 507         fprintf( stream, "\tfirst: '%s'\n", person->firstName );
 508         fprintf( stream, "\tlast : '%s'\n", person->lastName );
 509         fprintf( stream, "\tnick : '%s'\n", person->nickName );
 510         fprintf( stream, "\textID: '%s'\n", person->externalID );
 511         fprintf( stream, "\teMail:\n" );
 512         fprintf( stream, "\t---\n" );
 513         node = person->listEMail;
 514         while( node ) {
 515                 addritem_print_item_email( node->data, stream );
 516                 node = g_list_next( node );
 517         }
 518         fprintf( stream, "\tuAttr:\n" );
 519         fprintf( stream, "\t---\n" );
 520         node = person->listAttrib;
 521         while( node ) {
 522                 addritem_print_attribute( node->data, stream );
 523                 node = g_list_next( node );
 524         }
 525         gchar *current_status;
 526         switch (person->status) {
 527                 case NONE: current_status = g_strdup("Unchanged"); break;
 528                 case ADD_ENTRY: current_status = g_strdup("New"); break;
 529                 case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
 530                 case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
 531                 default: current_status = g_strdup("Unknown");
 532         }
 533         fprintf( stream, "\t\tStatus: %s\n", current_status );
 534         if ( current_status )
 535                 g_free(current_status);
 536         fprintf( stream, "\t===\n" );
 537 }
 538
 539 /**
 540  * Add E-Mail address object to person.
 541  * \param  person Person.
 542  * \param  email  E-Mail object to add.
 543  * \return <i>TRUE</i> if E-Mail added.
 544  */
 545 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
 546         GList *node;
 547
 548         cm_return_val_if_fail( person != NULL, FALSE );
 549         cm_return_val_if_fail( email != NULL, FALSE );
 550
 551         node = person->listEMail;
 552         while( node ) {
 553                 if( node->data == email ) return FALSE;
 554                 node = g_list_next( node );
 555         }
 556         person->listEMail = g_list_append( person->listEMail, email );
 557         ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
 558         return TRUE;
 559 }
 560
 561 /**
 562  * Remove email address for specified person.
 563  * \param  person Person.
 564  * \param  email  EMail to remove.
 565  * \return EMail object, or <i>NULL</i> if not found. Note that object should
 566  *         still be freed after calling this method.
 567  */
 568 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
 569         gboolean found = FALSE;
 570         GList *node;
 571
 572         cm_return_val_if_fail( person != NULL, NULL );
 573         if( email == NULL ) return NULL;
 574
 575         /* Look for email */
 576         node = person->listEMail;
 577         while( node ) {
 578                 if( node-> data == email ) {
 579                         found = TRUE;
 580                         break;
 581                 }
 582                 node = g_list_next( node );
 583         }
 584
 585         if( found ) {
 586                 /* Remove email from person's address list */
 587                 if( person->listEMail ) {
 588                         person->listEMail = g_list_remove( person->listEMail, email );
 589                 }
 590                 /* Unlink reference to person. */
 591                 ADDRITEM_PARENT(email) = NULL;
 592                 return email;
 593         }
 594         return NULL;
 595 }
 596
 597 /**
 598  * Add user attribute to specified person.
 599  * \param  person Person.
 600  * \param  attrib Attribute to add.
 601  * \return <i>TRUE</i> if item added.
 602  */
 603 void addritem_person_add_attribute(
 604                         ItemPerson *person, UserAttribute *attrib )
 605 {
 606         cm_return_if_fail( person != NULL );
 607         person->listAttrib = g_list_append( person->listAttrib, attrib );
 608 }
 609
 610 /**
 611  * Remove user attribute from specified person.
 612  * \param  person Person.
 613  * \param  attrib Attribute to remove.
 614  */
 615 void addritem_person_remove_attribute(  ItemPerson *person, const gchar *attrib ) {
 616         cm_return_if_fail( person != NULL && attrib != NULL );
 617         GList *attrib_list;
 618
 619         attrib_list = person->listAttrib;
 620         while (attrib_list) {
 621                 UserAttribute *user_attrib = attrib_list->data;
 622                 if (strcmp(user_attrib->name, attrib) == 0) {
 623                         person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
 624                         break;
 625                 }
 626                 attrib_list = g_list_next(attrib_list);
 627         }
 628 }
 629
 630
 631 /**
 632  * Create new address book group object.
 633  * \return Initialized group object.
 634  */
 635 ItemGroup *addritem_create_item_group( void ) {
 636         ItemGroup *group;
 637
 638         group = g_new0( ItemGroup, 1 );
 639         ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
 640         ADDRITEM_ID(group) = NULL;
 641         ADDRITEM_NAME(group) = NULL;
 642         ADDRITEM_PARENT(group) = NULL;
 643         ADDRITEM_SUBTYPE(group) = 0;
 644         group->remarks = NULL;
 645         group->listEMail = NULL;
 646         return group;
 647 }
 648
 649 /**
 650  * Copy (deep copy) address book group.
 651  * \param  item Group to copy.
 652  * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
 653  */
 654 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
 655         ItemGroup *itemNew;
 656
 657         itemNew = NULL;
 658         if( item ) {
 659                 itemNew = addritem_create_item_group();
 660                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 661                 itemNew->remarks = g_strdup( item->remarks );
 662         }
 663         return itemNew;
 664 }
 665
 666 /**
 667  * Specify name to be used for group.
 668  * \param group Group object.
 669  * \param value Name of group.
 670  */
 671 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
 672         ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
 673 }
 674
 675 /**
 676  * Free address group object.
 677  * \param group Group to free.
 678  */
 679 void addritem_free_item_group( ItemGroup *group ) {
 680         cm_return_if_fail( group != NULL );
 681
 682         /* Free internal stuff */
 683         g_free( ADDRITEM_ID(group) );
 684         g_free( ADDRITEM_NAME(group) );
 685         g_free( group->remarks );
 686         mgu_clear_list( group->listEMail );
 687         g_list_free( group->listEMail );
 688
 689         ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
 690         ADDRITEM_ID(group) = NULL;
 691         ADDRITEM_NAME(group) = NULL;
 692         ADDRITEM_PARENT(group) = NULL;
 693         ADDRITEM_SUBTYPE(group) = 0;
 694         group->remarks = NULL;
 695         group->listEMail = NULL;
 696
 697         g_free( group );
 698 }
 699
 700 /**
 701  * Add EMail address to group. Note that a reference to an E-Mail item is
 702  * added to a group. A person object is the only container that for an
 703  * address.
 704  * \param  group Group.
 705  * \param  email E-Mail object.
 706  * \return <i>TRUE</i> if email item added.
 707  */
 708 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
 709         GList *node;
 710
 711         cm_return_val_if_fail( group != NULL, FALSE );
 712         cm_return_val_if_fail( email != NULL, FALSE );
 713
 714         node = group->listEMail;
 715         while( node ) {
 716                 if( node->data == email ) return FALSE;
 717                 node = g_list_next( node );
 718         }
 719         group->listEMail = g_list_append( group->listEMail, email );
 720         return TRUE;
 721 }
 722
 723 /**
 724  * Remove person object for specified group.
 725  * \param  group Group from which to remove address.
 726  * \param  email EMail to remove
 727  * \return EMail object, or <i>NULL if email not found in group. Note that
 728  *         this object is referenced (linked) to a group and should *NOT*
 729  *         be freed. An E-Mail object object should only be freed after
 730  *         removing from a person.
 731  */
 732 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
 733         if( group && person ) {
 734                 GList *node = group->listPerson;
 735                 while( node ) {
 736                         if( node->data == person ) {
 737                                 group->listPerson = g_list_remove( group->listPerson, person );
 738                                 return person;
 739                         }
 740                         node = g_list_next( node );
 741                 }
 742         }
 743         return NULL;
 744 }
 745
 746 /**
 747  * Print address group item for debug.
 748  * \param group  Group to print.
 749  * \param stream Output stream.
 750  */
 751 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
 752         GList *node;
 753         ItemPerson *person;
 754         ItemEMail *item;
 755         cm_return_if_fail( group != NULL );
 756         fprintf( stream, "Group:\n" );
 757         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
 758         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
 759         fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
 760         fprintf( stream, "\trem: '%s'\n", group->remarks );
 761         fprintf( stream, "\t---\n" );
 762         node = group->listEMail;
 763         while( node ) {
 764                 item = node->data;
 765                 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
 766                 if( person ) {
 767                         fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
 768                         fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
 769                 }
 770                 else {
 771                         fprintf( stream, "\t\tpid : ???\n" );
 772                         fprintf( stream, "\t\tcomn: ???\n" );
 773                 }
 774                 addritem_print_item_email( item, stream );
 775                 node = g_list_next( node );
 776         }
 777         fprintf( stream, "\t***\n" );
 778 }
 779
 780 /**
 781  * Create new address folder.
 782  * \return Initialized address folder object.
 783  */
 784 ItemFolder *addritem_create_item_folder( void ) {
 785         ItemFolder *folder;
 786         folder = g_new0( ItemFolder, 1 );
 787         ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
 788         ADDRITEM_ID(folder) = NULL;
 789         ADDRITEM_NAME(folder) = NULL;
 790         ADDRITEM_PARENT(folder) = NULL;
 791         ADDRITEM_SUBTYPE(folder) = 0;
 792         folder->remarks = NULL;
 793         folder->isRoot = FALSE;
 794         folder->listItems = NULL;
 795         folder->listFolder = NULL;
 796         folder->listPerson = NULL;
 797         folder->listGroup = NULL;
 798         folder->folderType = ADDRFOLDER_NONE;
 799         folder->folderData = NULL;
 800         folder->isHidden = FALSE;
 801         return folder;
 802 }
 803
 804 /**
 805  * Copy address book folder. Note that only the folder and not its contents are
 806  * copied.
 807  * \param  item Folder to copy.
 808  * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
 809  */
 810 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
 811         ItemFolder *itemNew;
 812
 813         itemNew = g_new0( ItemFolder, 1 );
 814         if( item ) {
 815                 itemNew = addritem_create_item_folder();
 816                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 817                 itemNew->folderType = item->folderType;
 818         }
 819         return itemNew;
 820 }
 821
 822 /**
 823  * Specify name to be used for folder.
 824  * \param folder Folder.
 825  * \param value  Name.
 826  */
 827 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
 828         ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
 829 }
 830
 831 /**
 832  * Specify remarks to be used for folder.
 833  * \param folder Folder.
 834  * \param value  Remarks.
 835  */
 836 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
 837         folder->remarks = mgu_replace_string( folder->remarks, value );
 838 }
 839
 840 /**
 841  * Specify visibility of folder.
 842  * \param folder Folder.
 843  * \param value  Set to <code>TRUE</code> to hide folder.
 844  */
 845 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
 846         folder->isHidden = value;
 847 }
 848
 849 /**
 850  * Free address folder. Note: this does not free up the lists of children
 851  * (folders, groups and person). This should be done prior to calling this
 852  * function.
 853  * \param folder Folder to free.
 854  */
 855 void addritem_free_item_folder( ItemFolder *folder ) {
 856         cm_return_if_fail( folder != NULL );
 857
 858         /* Free internal stuff */
 859         g_free( ADDRITEM_ID(folder) );
 860         g_free( ADDRITEM_NAME(folder) );
 861         g_free( folder->remarks );
 862         mgu_clear_list( folder->listItems );
 863         g_list_free( folder->listItems );
 864
 865         ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
 866         ADDRITEM_ID(folder) = NULL;
 867         ADDRITEM_NAME(folder) = NULL;
 868         ADDRITEM_PARENT(folder) = NULL;
 869         ADDRITEM_SUBTYPE(folder) = 0;
 870         folder->isRoot = FALSE;
 871         folder->remarks = NULL;
 872         folder->listItems = NULL;
 873         folder->listFolder = NULL;
 874         folder->listGroup = NULL;
 875         folder->listPerson = NULL;
 876         folder->folderType = ADDRFOLDER_NONE;
 877         folder->folderData = NULL;
 878         folder->isHidden = FALSE;
 879
 880         g_free( folder );
 881 }
 882
 883 /**
 884  * Add person into folder.
 885  * \param  folder Folder.
 886  * \param  item   Person to add.
 887  * \return <i>TRUE</i> if person added.
 888  */
 889 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
 890         cm_return_val_if_fail( folder != NULL, FALSE );
 891         cm_return_val_if_fail( item != NULL, FALSE );
 892
 893         folder->listPerson = g_list_append( folder->listPerson, item );
 894         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
 895         return TRUE;
 896 }
 897
 898 /**
 899  * Add folder into folder.
 900  * \param  folder Folder.
 901  * \param  item   Folder to add.
 902  * \return <i>TRUE</i> if folder added.
 903  */
 904 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
 905         cm_return_val_if_fail( folder != NULL, FALSE );
 906         cm_return_val_if_fail( item != NULL, FALSE );
 907
 908         folder->listFolder = g_list_append( folder->listFolder, item );
 909         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
 910         return TRUE;
 911 }
 912
 913 /**
 914  * Add group into folder.
 915  * \param  folder Folder.
 916  * \param  item   Group to add.
 917  * \return <i>TRUE</i> if group added.
 918  */
 919 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
 920         cm_return_val_if_fail( folder != NULL, FALSE );
 921         cm_return_val_if_fail( item != NULL, FALSE );
 922
 923         folder->listGroup = g_list_append( folder->listGroup, item );
 924         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
 925         return TRUE;
 926 }
 927
 928 /**
 929  * Print address folder item contents for debug.
 930  * \param folder Folder to process.
 931  * \param stream Output stream.
 932  */
 933 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
 934         GList *node;
 935         /* ItemPerson *person; */
 936         ItemFolder *parent;
 937
 938         cm_return_if_fail( folder != NULL );
 939
 940         fprintf( stream, "Folder:\n" );
 941         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
 942         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
 943         fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
 944         fprintf( stream, "\trem: '%s'\n", folder->remarks );
 945         fprintf( stream, "\ttyp: %d\n", folder->folderType );
 946         fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
 947         fprintf( stream, "\t---\n" );
 948         parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
 949         if( parent ) {
 950                 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
 951         }
 952         else {
 953                 fprintf( stream, "\tpar: NULL\n" );
 954         }
 955         node = folder->listFolder;
 956         while( node ) {
 957                 AddrItemObject *aio = node->data;
 958                 if( aio ) {
 959                         if( aio->type == ITEMTYPE_FOLDER ) {
 960                                 ItemFolder *item = ( ItemFolder * ) aio;
 961                                 addritem_print_item_folder( item, stream );
 962                         }
 963                 }
 964                 else {
 965                         fprintf( stream, "\t\tpid : ???\n" );
 966                 }
 967
 968                 node = g_list_next( node );
 969         }
 970
 971         node = folder->listPerson;
 972         while( node ) {
 973                 AddrItemObject *aio = node->data;
 974                 if( aio ) {
 975                         if( aio->type == ITEMTYPE_PERSON ) {
 976                                 ItemPerson *item = ( ItemPerson * ) aio;
 977                                 addritem_print_item_person( item, stream );
 978                         }
 979                 }
 980                 else {
 981                         fprintf( stream, "\t\tpid : ???\n" );
 982                 }
 983
 984                 node = g_list_next( node );
 985         }
 986
 987         node = folder->listGroup;
 988         while( node ) {
 989                 AddrItemObject *aio = node->data;
 990                 if( aio ) {
 991                         if( aio->type == ITEMTYPE_GROUP ) {
 992                                 ItemGroup *item = ( ItemGroup * ) aio;
 993                                 addritem_print_item_group( item, stream );
 994                         }
 995                 }
 996                 else {
 997                         fprintf( stream, "\t\tpid : ???\n" );
 998                 }
 999                 node = g_list_next( node );
1000         }
1001         fprintf( stream, "\t###\n" );
1002 }
1003
1004 /**
1005  * Return link list of persons for specified folder. Note that the list contains
1006  * references to items and should be g_free() when done. Do *NOT* attempt to use the
1007  * addritem_free_xxx() functions... this will destroy the addressbook data!
1008  *
1009  * \param  folder Folder to process.
1010  * \return List of items, or <i>NULL</i> if none.
1011  */
1012 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
1013         GList *list = NULL;
1014         GList *node = NULL;
1015
1016         cm_return_val_if_fail( folder != NULL, NULL );
1017
1018         node = folder->listPerson;
1019         while( node ) {
1020                 ItemPerson *person = node->data;
1021                 list = g_list_prepend( list, person );
1022                 node = g_list_next( node );
1023         }
1024         return g_list_reverse(list);
1025 }
1026
1027 /**
1028  * Return link list of groups for specified folder. Note that the list contains
1029  * references to items and should be g_free() when done. Do *NOT* attempt to use the
1030  * addritem_free_xxx() functions... this will destroy the addressbook data!
1031  *
1032  * \param  folder Folder to process.
1033  * \return List of items, or <i>NULL</i> if none.
1034  */
1035 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1036         GList *list = NULL;
1037         GList *node = NULL;
1038
1039         cm_return_val_if_fail( folder != NULL, NULL );
1040
1041         node = folder->listGroup;
1042         while( node ) {
1043                 ItemGroup *group = node->data;
1044                 list = g_list_prepend( list, group );
1045                 node = g_list_next( node );
1046         }
1047         return g_list_reverse(list);
1048 }
1049
1050 /**
1051  * Parse first and last names for person from common name.
1052  * \param person Person to process.
1053  */
1054 void addritem_parse_first_last( ItemPerson *person ) {
1055         gchar *name;
1056         gchar *fName, *lName;
1057         gchar *p;
1058         gint len, i;
1059
1060         cm_return_if_fail( person != NULL );
1061
1062         name = ADDRITEM_NAME(person);
1063         if( name == NULL ) return;
1064
1065         fName = NULL;
1066         lName = NULL;
1067         p = strchr( name, ',' );
1068         if( p ) {
1069                 len = ( size_t ) ( p - name );
1070                 lName = g_strndup( name, len );
1071                 fName = g_strdup( p + 1 );
1072         }
1073         else {
1074                 /* Other way around */
1075                 i = strlen( name );
1076                 while( i >= 0 ) {
1077                         if( name[i] == ' ' ) {
1078                                 fName = g_strndup( name, i );
1079                                 lName = g_strdup( &name[i] );
1080                                 break;
1081                         }
1082                         i--;
1083                 }
1084                 if( fName == NULL ) {
1085                         fName = g_strdup( name );
1086                 }
1087         }
1088
1089         g_free( person->firstName );
1090         person->firstName = fName;
1091         if( person->firstName )
1092                 g_strstrip( person->firstName );
1093
1094         g_free( person->lastName );
1095         person->lastName = lName;
1096         if( person->lastName )
1097                 g_strstrip( person->lastName );
1098 }
1099
1100 /**
1101  * Build a path of all ancestor folders for specified folder.
1102  * \param  folder Folder.
1103  * \param  seq    Path sequence, FALSE top down, TRUE bottom up.
1104  * \return List of folders from the top down.
1105  */
1106 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1107         GList *list;
1108         AddrItemObject *item;
1109
1110         list = NULL;
1111         item = ( AddrItemObject * ) folder;
1112         if( seq ) {
1113                 while( item ) {
1114                         list = g_list_prepend( list, item );
1115                         item = ADDRITEM_PARENT( item );
1116                 }
1117         }
1118         else {
1119                 while( item ) {
1120                         list = g_list_append( list, item );
1121                         item = ADDRITEM_PARENT( item );
1122                 }
1123         }
1124         return list;
1125 }
1126
1127 /**
1128  * Format E-Mail address.
1129  * \param email EMail item to format.
1130  * \return Formatted string. Should be freed after use.
1131  */
1132 gchar *addritem_format_email( ItemEMail *email ) {
1133         gchar *address;
1134         gchar *name;
1135         ItemPerson *person;
1136
1137         address = NULL;
1138         name = NULL;
1139         if( ADDRITEM_NAME( email ) ) {
1140                 if( strlen( ADDRITEM_NAME( email ) ) ) {
1141                         name = ADDRITEM_NAME( email );
1142                 }
1143         }
1144         if( ! name ) {
1145                 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1146                 name = ADDRITEM_NAME( person );
1147         }
1148
1149         if( name ) {
1150                 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1151                         address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1152                 }
1153                 else {
1154                         address = g_strdup_printf( "%s <%s>", name, email->address );
1155                 }
1156         }
1157         else {
1158                 address = g_strdup_printf( "%s", email->address );
1159         }
1160         return address;
1161 }
1162
1163 /*
1164 * End of Source.
1165 */