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->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  * Remove user attribute from specified person.
 555  * \param  person Person.
 556  * \param  attrib Attribute to remove.
 557  */
 558 void addritem_person_remove_attribute(  ItemPerson *person, const gchar *attrib ) {
 559         g_return_if_fail( person != NULL || attrib != NULL );
 560         GList *attrib_list;
 561
 562         attrib_list = person->listAttrib;
 563         while (attrib_list) {
 564                 UserAttribute *user_attrib = attrib_list->data;
 565                 if (strcmp(user_attrib->name, attrib) == 0) {
 566                         person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
 567                         break;
 568                 }
 569                 attrib_list = g_list_next(attrib_list);
 570         }
 571 }
 572
 573 /**
 574  * find out if a user attribute already exists in the specified person.
 575  * \param  person Person.
 576  * \param  attrib Attribute to remove.
 577  * \return <i>TRUE</i> if attribute exists
 578  */
 579 gboolean addritem_person_has_attribute( ItemPerson *person, const gchar *attrib ) {
 580         g_return_val_if_fail( person != NULL || attrib != NULL, FALSE );
 581         GList *attrib_list = NULL;
 582
 583         attrib_list = person->listAttrib;
 584         while (attrib_list) {
 585                 UserAttribute *user_attrib = attrib_list->data;
 586                 if (strcmp(user_attrib->name, attrib) == 0) {
 587                         return TRUE;
 588                 }
 589                 attrib_list = g_list_next(attrib_list);
 590         }
 591         return FALSE;
 592 }
 593
 594 /**
 595  * Create new address book group object.
 596  * \return Initialized group object.
 597  */
 598 ItemGroup *addritem_create_item_group( void ) {
 599         ItemGroup *group;
 600
 601         group = g_new0( ItemGroup, 1 );
 602         ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
 603         ADDRITEM_ID(group) = NULL;
 604         ADDRITEM_NAME(group) = NULL;
 605         ADDRITEM_PARENT(group) = NULL;
 606         ADDRITEM_SUBTYPE(group) = 0;
 607         group->remarks = NULL;
 608         group->listEMail = NULL;
 609         return group;
 610 }
 611
 612 /**
 613  * Copy (deep copy) address book group.
 614  * \param  item Group to copy.
 615  * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
 616  */
 617 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
 618         ItemGroup *itemNew;
 619
 620         itemNew = g_new0( ItemGroup, 1 );
 621         if( item ) {
 622                 itemNew = addritem_create_item_group();
 623                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 624                 itemNew->remarks = g_strdup( item->remarks );
 625         }
 626         return itemNew;
 627 }
 628
 629 /**
 630  * Specify name to be used for group.
 631  * \param group Group object.
 632  * \param value Name of group.
 633  */
 634 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
 635         ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
 636 }
 637
 638 /**
 639  * Free address group object.
 640  * \param group Group to free.
 641  */
 642 void addritem_free_item_group( ItemGroup *group ) {
 643         g_return_if_fail( group != NULL );
 644
 645         /* Free internal stuff */
 646         g_free( ADDRITEM_ID(group) );
 647         g_free( ADDRITEM_NAME(group) );
 648         g_free( group->remarks );
 649         mgu_clear_list( group->listEMail );
 650         g_list_free( group->listEMail );
 651
 652         ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
 653         ADDRITEM_ID(group) = NULL;
 654         ADDRITEM_NAME(group) = NULL;
 655         ADDRITEM_PARENT(group) = NULL;
 656         ADDRITEM_SUBTYPE(group) = 0;
 657         group->remarks = NULL;
 658         group->listEMail = NULL;
 659
 660         g_free( group );
 661 }
 662
 663 /**
 664  * Add EMail address to group. Note that a reference to an E-Mail item is
 665  * added to a group. A person object is the only container that for an
 666  * address.
 667  * \param  group Group.
 668  * \param  email E-Mail object.
 669  * \return <i>TRUE</i> if email item added.
 670  */
 671 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
 672         GList *node;
 673
 674         g_return_val_if_fail( group != NULL, FALSE );
 675         g_return_val_if_fail( email != NULL, FALSE );
 676
 677         node = group->listEMail;
 678         while( node ) {
 679                 if( node->data == email ) return FALSE;
 680                 node = g_list_next( node );
 681         }
 682         group->listEMail = g_list_append( group->listEMail, email );
 683         return TRUE;
 684 }
 685
 686 /**
 687  * Remove person object for specified group.
 688  * \param  group Group from which to remove address.
 689  * \param  email EMail to remove
 690  * \return EMail object, or <i>NULL if email not found in group. Note that
 691  *         this object is referenced (linked) to a group and should *NOT*
 692  *         be freed. An E-Mail object object should only be freed after
 693  *         removing from a person.
 694  */
 695 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
 696         if( group && person ) {
 697                 GList *node = group->listPerson;
 698                 while( node ) {
 699                         if( node->data == person ) {
 700                                 group->listPerson = g_list_remove( group->listPerson, person );
 701                                 return person;
 702                         }
 703                         node = g_list_next( node );
 704                 }
 705         }
 706         return NULL;
 707 }
 708
 709 /**
 710  * Print address group item for debug.
 711  * \param group  Group to print.
 712  * \param stream Output stream.
 713  */
 714 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
 715         GList *node;
 716         ItemPerson *person;
 717         ItemEMail *item;
 718         g_return_if_fail( group != NULL );
 719         fprintf( stream, "Group:\n" );
 720         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
 721         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
 722         fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
 723         fprintf( stream, "\trem: '%s'\n", group->remarks );
 724         fprintf( stream, "\t---\n" );
 725         node = group->listEMail;
 726         while( node ) {
 727                 item = node->data;
 728                 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
 729                 if( person ) {
 730                         fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
 731                         fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
 732                 }
 733                 else {
 734                         fprintf( stream, "\t\tpid : ???\n" );
 735                         fprintf( stream, "\t\tcomn: ???\n" );
 736                 }
 737                 addritem_print_item_email( item, stream );
 738                 node = g_list_next( node );
 739         }
 740         fprintf( stream, "\t***\n" );
 741 }
 742
 743 /**
 744  * Create new address folder.
 745  * \return Initialized address folder object.
 746  */
 747 ItemFolder *addritem_create_item_folder( void ) {
 748         ItemFolder *folder;
 749         folder = g_new0( ItemFolder, 1 );
 750         ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
 751         ADDRITEM_ID(folder) = NULL;
 752         ADDRITEM_NAME(folder) = NULL;
 753         ADDRITEM_PARENT(folder) = NULL;
 754         ADDRITEM_SUBTYPE(folder) = 0;
 755         folder->remarks = NULL;
 756         folder->isRoot = FALSE;
 757         folder->listItems = NULL;
 758         folder->listFolder = NULL;
 759         folder->listPerson = NULL;
 760         folder->listGroup = NULL;
 761         folder->folderType = ADDRFOLDER_NONE;
 762         folder->folderData = NULL;
 763         folder->isHidden = FALSE;
 764         return folder;
 765 }
 766
 767 /**
 768  * Copy address book folder. Note that only the folder and not its contents are
 769  * copied.
 770  * \param  item Folder to copy.
 771  * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
 772  */
 773 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
 774         ItemFolder *itemNew;
 775
 776         itemNew = g_new0( ItemFolder, 1 );
 777         if( item ) {
 778                 itemNew = addritem_create_item_folder();
 779                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 780                 itemNew->folderType = item->folderType;
 781         }
 782         return itemNew;
 783 }
 784
 785 /**
 786  * Specify name to be used for folder.
 787  * \param folder Folder.
 788  * \param value  Name.
 789  */
 790 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
 791         ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
 792 }
 793
 794 /**
 795  * Specify remarks to be used for folder.
 796  * \param folder Folder.
 797  * \param value  Remarks.
 798  */
 799 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
 800         folder->remarks = mgu_replace_string( folder->remarks, value );
 801 }
 802
 803 /**
 804  * Specify visibility of folder.
 805  * \param folder Folder.
 806  * \param value  Set to <code>TRUE</code> to hide folder.
 807  */
 808 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
 809         folder->isHidden = value;
 810 }
 811
 812 /**
 813  * Free address folder. Note: this does not free up the lists of children
 814  * (folders, groups and person). This should be done prior to calling this
 815  * function.
 816  * \param folder Folder to free.
 817  */
 818 void addritem_free_item_folder( ItemFolder *folder ) {
 819         g_return_if_fail( folder != NULL );
 820
 821         /* Free internal stuff */
 822         g_free( ADDRITEM_ID(folder) );
 823         g_free( ADDRITEM_NAME(folder) );
 824         g_free( folder->remarks );
 825         mgu_clear_list( folder->listItems );
 826         g_list_free( folder->listItems );
 827
 828         ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
 829         ADDRITEM_ID(folder) = NULL;
 830         ADDRITEM_NAME(folder) = NULL;
 831         ADDRITEM_PARENT(folder) = NULL;
 832         ADDRITEM_SUBTYPE(folder) = 0;
 833         folder->isRoot = FALSE;
 834         folder->remarks = NULL;
 835         folder->listItems = NULL;
 836         folder->listFolder = NULL;
 837         folder->listGroup = NULL;
 838         folder->listPerson = NULL;
 839         folder->folderType = ADDRFOLDER_NONE;
 840         folder->folderData = NULL;
 841         folder->isHidden = FALSE;
 842
 843         g_free( folder );
 844 }
 845
 846 /**
 847  * Free up folders recursively. Note: this only frees up the lists of
 848  * children and *NOT* the children objects (folders, groups and person).
 849  * This should be done prior to calling this function.
 850  * \param parent Parent folder object to be processed.
 851  */
 852 static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
 853         GList *node = parent->listFolder;
 854
 855         while( node ) {
 856                 ItemFolder *folder = node->data;
 857                 addritem_free_item_folder_recurse( folder );
 858                 node = g_list_next( node );
 859         }
 860         g_list_free( parent->listPerson );
 861         g_list_free( parent->listGroup );
 862         g_list_free( parent->listFolder );
 863         parent->listPerson = NULL;
 864         parent->listGroup = NULL;
 865         parent->listFolder = NULL;
 866 }
 867
 868 /**
 869  * Add person into folder.
 870  * \param  folder Folder.
 871  * \param  item   Person to add.
 872  * \return <i>TRUE</i> if person added.
 873  */
 874 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
 875         g_return_val_if_fail( folder != NULL, FALSE );
 876         g_return_val_if_fail( item != NULL, FALSE );
 877
 878         folder->listPerson = g_list_append( folder->listPerson, item );
 879         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
 880         return TRUE;
 881 }
 882
 883 /**
 884  * Add folder into folder.
 885  * \param  folder Folder.
 886  * \param  item   Folder to add.
 887  * \return <i>TRUE</i> if folder added.
 888  */
 889 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
 890         g_return_val_if_fail( folder != NULL, FALSE );
 891         g_return_val_if_fail( item != NULL, FALSE );
 892
 893         folder->listFolder = g_list_append( folder->listFolder, item );
 894         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
 895         return TRUE;
 896 }
 897
 898 /**
 899  * Add group into folder.
 900  * \param  folder Folder.
 901  * \param  item   Group to add.
 902  * \return <i>TRUE</i> if group added.
 903  */
 904 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
 905         g_return_val_if_fail( folder != NULL, FALSE );
 906         g_return_val_if_fail( item != NULL, FALSE );
 907
 908         folder->listGroup = g_list_append( folder->listGroup, item );
 909         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
 910         return TRUE;
 911 }
 912
 913 /**
 914  * Print address folder item contents for debug.
 915  * \param folder Folder to process.
 916  * \param stream Output stream.
 917  */
 918 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
 919         GList *node;
 920         /* ItemPerson *person; */
 921         ItemFolder *parent;
 922
 923         g_return_if_fail( folder != NULL );
 924
 925         fprintf( stream, "Folder:\n" );
 926         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
 927         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
 928         fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
 929         fprintf( stream, "\trem: '%s'\n", folder->remarks );
 930         fprintf( stream, "\ttyp: %d\n", folder->folderType );
 931         fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
 932         fprintf( stream, "\t---\n" );
 933         parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
 934         if( parent ) {
 935                 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
 936         }
 937         else {
 938                 fprintf( stream, "\tpar: NULL\n" );
 939         }
 940         node = folder->listFolder;
 941         while( node ) {
 942                 AddrItemObject *aio = node->data;
 943                 if( aio ) {
 944                         if( aio->type == ITEMTYPE_FOLDER ) {
 945                                 ItemFolder *item = ( ItemFolder * ) aio;
 946                                 addritem_print_item_folder( item, stream );
 947                         }
 948                 }
 949                 else {
 950                         fprintf( stream, "\t\tpid : ???\n" );
 951                 }
 952
 953                 node = g_list_next( node );
 954         }
 955
 956         node = folder->listPerson;
 957         while( node ) {
 958                 AddrItemObject *aio = node->data;
 959                 if( aio ) {
 960                         if( aio->type == ITEMTYPE_PERSON ) {
 961                                 ItemPerson *item = ( ItemPerson * ) aio;
 962                                 addritem_print_item_person( item, stream );
 963                         }
 964                 }
 965                 else {
 966                         fprintf( stream, "\t\tpid : ???\n" );
 967                 }
 968
 969                 node = g_list_next( node );
 970         }
 971
 972         node = folder->listGroup;
 973         while( node ) {
 974                 AddrItemObject *aio = node->data;
 975                 if( aio ) {
 976                         if( aio->type == ITEMTYPE_GROUP ) {
 977                                 ItemGroup *item = ( ItemGroup * ) aio;
 978                                 addritem_print_item_group( item, stream );
 979                         }
 980                 }
 981                 else {
 982                         fprintf( stream, "\t\tpid : ???\n" );
 983                 }
 984                 node = g_list_next( node );
 985         }
 986         fprintf( stream, "\t###\n" );
 987 }
 988
 989 /**
 990  * Return link list of persons for specified folder. Note that the list contains
 991  * references to items and should be g_free() when done. Do *NOT* attempt to use the
 992  * addritem_free_xxx() functions... this will destroy the addressbook data!
 993  *
 994  * \param  folder Folder to process.
 995  * \return List of items, or <i>NULL</i> if none.
 996  */
 997 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
 998         GList *list = NULL;
 999         GList *node = NULL;
1000
1001         g_return_val_if_fail( folder != NULL, NULL );
1002
1003         node = folder->listPerson;
1004         while( node ) {
1005                 ItemPerson *person = node->data;
1006                 list = g_list_append( list, person );
1007                 node = g_list_next( node );
1008         }
1009         return list;
1010 }
1011
1012 /**
1013  * Return link list of groups for specified folder. Note that the list contains
1014  * references to items and should be g_free() when done. Do *NOT* attempt to use the
1015  * addritem_free_xxx() functions... this will destroy the addressbook data!
1016  *
1017  * \param  folder Folder to process.
1018  * \return List of items, or <i>NULL</i> if none.
1019  */
1020 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1021         GList *list = NULL;
1022         GList *node = NULL;
1023
1024         g_return_val_if_fail( folder != NULL, NULL );
1025
1026         node = folder->listGroup;
1027         while( node ) {
1028                 ItemGroup *group = node->data;
1029                 list = g_list_append( list, group );
1030                 node = g_list_next( node );
1031         }
1032         return list;
1033 }
1034
1035 /**
1036  * Parse first and last names for person from common name.
1037  * \param person Person to process.
1038  */
1039 void addritem_parse_first_last( ItemPerson *person ) {
1040         gchar *name;
1041         gchar *fName, *lName;
1042         gchar *p;
1043         gint len, i;
1044
1045         g_return_if_fail( person != NULL );
1046
1047         name = ADDRITEM_NAME(person);
1048         if( name == NULL ) return;
1049
1050         fName = NULL;
1051         lName = NULL;
1052         p = strchr( name, ',' );
1053         if( p ) {
1054                 len = ( size_t ) ( p - name );
1055                 lName = g_strndup( name, len );
1056                 fName = g_strdup( p + 1 );
1057         }
1058         else {
1059                 /* Other way around */
1060                 i = strlen( name );
1061                 while( i >= 0 ) {
1062                         if( name[i] == ' ' ) {
1063                                 fName = g_strndup( name, i );
1064                                 lName = g_strdup( &name[i] );
1065                                 break;
1066                         }
1067                         i--;
1068                 }
1069                 if( fName == NULL ) {
1070                         fName = g_strdup( name );
1071                 }
1072         }
1073
1074         g_free( person->firstName );
1075         person->firstName = fName;
1076         if( person->firstName )
1077                 g_strstrip( person->firstName );
1078
1079         g_free( person->lastName );
1080         person->lastName = lName;
1081         if( person->lastName )
1082                 g_strstrip( person->lastName );
1083 }
1084
1085 /**
1086  * Build a path of all ancestor folders for specified folder.
1087  * \param  folder Folder.
1088  * \param  seq    Path sequence, FALSE top down, TRUE bottom up.
1089  * \return List of folders from the top down.
1090  */
1091 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1092         GList *list;
1093         AddrItemObject *item;
1094
1095         list = NULL;
1096         item = ( AddrItemObject * ) folder;
1097         if( seq ) {
1098                 while( item ) {
1099                         list = g_list_prepend( list, item );
1100                         item = ADDRITEM_PARENT( item );
1101                 }
1102         }
1103         else {
1104                 while( item ) {
1105                         list = g_list_append( list, item );
1106                         item = ADDRITEM_PARENT( item );
1107                 }
1108         }
1109         return list;
1110 }
1111
1112 /**
1113  * Format E-Mail address.
1114  * \param email EMail item to format.
1115  * \return Formatted string. Should be freed after use.
1116  */
1117 gchar *addritem_format_email( ItemEMail *email ) {
1118         gchar *address;
1119         gchar *name;
1120         ItemPerson *person;
1121
1122         address = NULL;
1123         name = NULL;
1124         if( ADDRITEM_NAME( email ) ) {
1125                 if( strlen( ADDRITEM_NAME( email ) ) ) {
1126                         name = ADDRITEM_NAME( email );
1127                 }
1128         }
1129         if( ! name ) {
1130                 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1131                 name = ADDRITEM_NAME( person );
1132         }
1133
1134         if( name ) {
1135                 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1136                         address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1137                 }
1138                 else {
1139                         address = g_strdup_printf( "%s <%s>", name, email->address );
1140                 }
1141         }
1142         else {
1143                 address = g_strdup_printf( "%s", email->address );
1144         }
1145         return address;
1146 }
1147
1148 /*
1149 * End of Source.
1150 */