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