src/addritem.c

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