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