src/addritem.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001-2017 Match Grun and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 /*
  20  * General primitive address item objects.
  21  */
  22
  23 #include "config.h"
  24
  25 #include <glib.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28
  29 #include "defs.h"
  30 #include "file-utils.h"
  31 #include "utils.h"
  32 #include "addritem.h"
  33 #include "mgutils.h"
  34 #include "codeconv.h"
  35
  36 /**
  37  * Create new email address item.
  38  * \return Initialized email item.
  39  */
  40 ItemEMail *addritem_create_item_email( void ) {
  41         ItemEMail *item;
  42         item = g_new0( ItemEMail, 1 );
  43         ADDRITEM_TYPE(item) = ITEMTYPE_EMAIL;
  44         ADDRITEM_ID(item) = NULL;
  45         ADDRITEM_NAME(item) = NULL;
  46         ADDRITEM_PARENT(item) = NULL;
  47         ADDRITEM_SUBTYPE(item) = 0;
  48         item->address = NULL;
  49         item->remarks = NULL;
  50         return item;
  51 }
  52
  53 /**
  54  * Create a shallow copy of specified email address item.
  55  * \param  item E-Mail to copy.
  56  * \return Copy of email, or <i>NULL</i> if null argument supplied.
  57  */
  58 ItemEMail *addritem_copy_item_email( ItemEMail *item ) {
  59         ItemEMail *itemNew = NULL;
  60         if( item ) {
  61                 itemNew = addritem_create_item_email();
  62                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
  63                 itemNew->address = g_strdup( item->address );
  64                 itemNew->remarks = g_strdup( item->remarks );
  65         }
  66         return itemNew;
  67 }
  68
  69 /**
  70  * Create a full copy (deep copy) of specified email address item.
  71  * \param  item E-Mail to copy.
  72  * \return Copy of email.
  73  */
  74 ItemEMail *addritem_copyfull_item_email( ItemEMail *item ) {
  75         ItemEMail *itemNew = NULL;
  76         if( item ) {
  77                 itemNew = addritem_create_item_email();
  78                 ADDRITEM_ID(itemNew) = g_strdup( ADDRITEM_ID(item) );
  79                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
  80                 ADDRITEM_PARENT(itemNew) = ADDRITEM_PARENT(item);
  81                 itemNew->address = g_strdup( item->address );
  82                 itemNew->remarks = g_strdup( item->remarks );
  83         }
  84         return itemNew;
  85 }
  86
  87 /**
  88  * Specify alias for email.
  89  * \param email E-Mail item.
  90  * \param value Alias.
  91  */
  92 void addritem_email_set_alias( ItemEMail *email, const gchar *value ) {
  93         ADDRITEM_NAME(email) = mgu_replace_string( ADDRITEM_NAME(email), value );
  94 }
  95
  96 /**
  97  * Specify address for email.
  98  * \param email E-Mail item.
  99  * \param value Address.
 100  */
 101 void addritem_email_set_address( ItemEMail *email, const gchar *value ) {
 102         email->address = mgu_replace_string( email->address, value );
 103 }
 104
 105 /**
 106  * Specify remarks for email.
 107  * \param email E-Mail item.
 108  * \param value Remarks.
 109  */
 110 void addritem_email_set_remarks( ItemEMail *email, const gchar *value ) {
 111         email->remarks = mgu_replace_string( email->remarks, value );
 112 }
 113
 114 /**
 115  * Free address item email object.
 116  * \param item E-Mail item to free.
 117  */
 118 void addritem_free_item_email( ItemEMail *item ) {
 119         cm_return_if_fail( item != NULL );
 120
 121         /* Free internal stuff */
 122         g_free( ADDRITEM_ID(item) );
 123         g_free( ADDRITEM_NAME(item) );
 124         g_free( item->address );
 125         g_free( item->remarks );
 126
 127         ADDRITEM_OBJECT(item)->type = ITEMTYPE_NONE;
 128         ADDRITEM_ID(item) = NULL;
 129         ADDRITEM_NAME(item) = NULL;
 130         ADDRITEM_PARENT(item) = NULL;
 131         ADDRITEM_SUBTYPE(item) = 0;
 132         item->address = NULL;
 133         item->remarks = NULL;
 134         g_free( item );
 135 }
 136
 137 /**
 138  * Create new attribute object.
 139  * \return Initialized attribute object.
 140  */
 141 UserAttribute *addritem_create_attribute( void ) {
 142         UserAttribute *item;
 143         item = g_new0( UserAttribute, 1 );
 144         item->uid = NULL;
 145         item->name = NULL;
 146         item->value = NULL;
 147         return item;
 148 }
 149
 150 /**
 151  * Create copy (deep copy) of specified attribute.
 152  * \param  item Attribute to copy.
 153  * \return Copy of attribute, or <i>NULL</i> if null argument supplied.
 154  */
 155 UserAttribute *addritem_copy_attribute( UserAttribute *item ) {
 156         UserAttribute *itemNew = NULL;
 157         if( item ) {
 158                 itemNew = addritem_create_attribute();
 159                 itemNew->uid = g_strdup( item->uid );
 160                 itemNew->name = g_strdup( item->name );
 161                 itemNew->value = g_strdup( item->value );
 162         }
 163         return itemNew;
 164 }
 165
 166 /**
 167  * Specify ID for attribute.
 168  * \param item Attribute object.
 169  * \param value ID.
 170  */
 171 void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
 172         cm_return_if_fail( item != NULL );
 173         item->uid = mgu_replace_string( item->uid, value );
 174 }
 175
 176 /**
 177  * Specify name for attribute.
 178  * \param item Attribute object.
 179  * \param value Name.
 180  */
 181 void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
 182         cm_return_if_fail( item != NULL );
 183         item->name = mgu_replace_string( item->name, value );
 184 }
 185
 186 /**
 187  * Specify value for attribute.
 188  * \param item Attribute object.
 189  * \param value Value.
 190  */
 191 void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
 192         cm_return_if_fail( item != NULL );
 193         item->value = mgu_replace_string( item->value, value );
 194 }
 195
 196 /**
 197  * Free user attribute.
 198  * \param item Attribute object to free.
 199  */
 200 void addritem_free_attribute( UserAttribute *item ) {
 201         cm_return_if_fail( item != NULL );
 202         g_free( item->uid );
 203         g_free( item->name );
 204         g_free( item->value );
 205         item->uid = NULL;
 206         item->name = NULL;
 207         item->value = NULL;
 208         g_free( item );
 209 }
 210
 211 /**
 212  * Create new address book person.
 213  * \return Initialized person object.
 214  */
 215 ItemPerson *addritem_create_item_person( void ) {
 216         ItemPerson *person;
 217         person = g_new0( ItemPerson, 1 );
 218         ADDRITEM_TYPE(person) = ITEMTYPE_PERSON;
 219         ADDRITEM_ID(person) = NULL;
 220         ADDRITEM_NAME(person) = NULL;
 221         ADDRITEM_PARENT(person) = NULL;
 222         ADDRITEM_SUBTYPE(person) = 0;
 223         person->picture = NULL;
 224         person->firstName = NULL;
 225         person->lastName = NULL;
 226         person->nickName = NULL;
 227         person->listEMail = NULL;
 228         person->listAttrib = NULL;
 229         person->externalID = NULL;
 230         person->isOpened = FALSE;
 231         person->status = NONE;
 232         return person;
 233 }
 234
 235 /**
 236  * Create a shallow copy of address book person object.
 237  * \param  item Person to copy.
 238  * \return Copy of person, or <i>NULL</i> if null argument supplied.
 239  */
 240 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
 241         ItemPerson *itemNew;
 242
 243         itemNew = NULL;
 244         if( item ) {
 245                 itemNew = addritem_create_item_person();
 246                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 247                 itemNew->picture = g_strdup( ADDRITEM_ID(itemNew) );
 248                 itemNew->firstName = g_strdup( item->firstName );
 249                 itemNew->lastName = g_strdup( item->lastName );
 250                 itemNew->nickName = g_strdup( item->nickName );
 251                 itemNew->externalID = g_strdup( item->externalID );
 252                 itemNew->status = item->status;
 253         }
 254         return itemNew;
 255 }
 256
 257 /**
 258  * Specify picture for person object.
 259  * \param person Person object.
 260  * \param value Picture.
 261  */
 262 void addritem_person_set_picture( ItemPerson *person, const gchar *value ) {
 263         if (!value || g_utf8_validate(value, -1, NULL))
 264                 person->picture = mgu_replace_string( person->picture, value );
 265         else {
 266                 gchar *out = conv_codeset_strdup(value,
 267                                 conv_get_locale_charset_str_no_utf8(),
 268                                 CS_INTERNAL);
 269                 if (out)
 270                         person->picture = mgu_replace_string( person->picture, out );
 271                 g_free(out);
 272         }
 273 }
 274
 275 /**
 276  * Get picture filename for person object.
 277  * \param person Person object.
 278  * \return copy of picture file path string (to be freed by caller - and there is
 279  *         no guarantee that path does exist, or NULL.
 280  */
 281 gchar *addritem_person_get_picture( ItemPerson *person) {
 282         if (person->picture)
 283                 return g_strconcat( get_rc_dir(), G_DIR_SEPARATOR_S,
 284                         ADDRBOOK_DIR, G_DIR_SEPARATOR_S, person->picture,
 285                         ".png", NULL );
 286         return NULL;
 287 }
 288
 289 /**
 290  * Delete picture for person object.
 291  * \param person Person object.
 292  */
 293 void addritem_person_remove_picture( ItemPerson *person) {
 294         if (person->picture) {
 295                 gchar *filename = g_strconcat( get_rc_dir(), G_DIR_SEPARATOR_S,
 296                         ADDRBOOK_DIR, G_DIR_SEPARATOR_S, person->picture,
 297                         ".png", NULL );
 298                 if (is_file_exist(filename)) {
 299                         debug_print("removing addressbook picture %s\n",
 300                                 filename);
 301                         if (claws_unlink(filename) < 0) {
 302                                 FILE_OP_ERROR(filename, "remove");
 303                                 g_free(filename);
 304                                 return;
 305                         }
 306                 }
 307                 g_free(person->picture);
 308                 person->picture = NULL;
 309                 g_free(filename);
 310         }
 311 }
 312
 313 /**
 314  * Specify first name for person object.
 315  * \param person Person object.
 316  * \param value Name.
 317  */
 318 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
 319         if (!value || g_utf8_validate(value, -1, NULL))
 320                 person->firstName = mgu_replace_string( person->firstName, value );
 321         else {
 322                 gchar *out = conv_codeset_strdup(value,
 323                                 conv_get_locale_charset_str_no_utf8(),
 324                                 CS_INTERNAL);
 325                 if (out)
 326                         person->firstName = mgu_replace_string( person->firstName, out );
 327                 g_free(out);
 328         }
 329 }
 330
 331 /**
 332  * Specify last name for person object.
 333  * \param person Person object.
 334  * \param value name.
 335  */
 336 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
 337         if (!value || g_utf8_validate(value, -1, NULL))
 338                 person->lastName = mgu_replace_string( person->lastName, value );
 339         else {
 340                 gchar *out = conv_codeset_strdup(value,
 341                                 conv_get_locale_charset_str_no_utf8(),
 342                                 CS_INTERNAL);
 343                 if (out)
 344                         person->lastName = mgu_replace_string( person->lastName, out );
 345                 g_free(out);
 346         }
 347 }
 348
 349 /**
 350  * Specify nick name for person object.
 351  * \param person Person object.
 352  * \param value name.
 353  */
 354 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
 355         if (!value || g_utf8_validate(value, -1, NULL))
 356                 person->nickName = mgu_replace_string( person->nickName, value );
 357         else {
 358                 gchar *out = conv_codeset_strdup(value,
 359                                 conv_get_locale_charset_str_no_utf8(),
 360                                 CS_INTERNAL);
 361                 if (out)
 362                         person->nickName = mgu_replace_string( person->nickName, out );
 363                 g_free(out);
 364         }
 365 }
 366
 367 /**
 368  * Specify common name for person object.
 369  * \param person Person object.
 370  * \param value name.
 371  */
 372 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
 373         if (!value || g_utf8_validate(value, -1, NULL))
 374                 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
 375         else {
 376                 gchar *out = conv_codeset_strdup(value,
 377                                 conv_get_locale_charset_str_no_utf8(),
 378                                 CS_INTERNAL);
 379                 if (out)
 380                         ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
 381                 g_free(out);
 382         }
 383 }
 384
 385 /**
 386  * Specify external ID for person object.
 387  * \param person Person object.
 388  * \param value ID.
 389  */
 390 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
 391         person->externalID = mgu_replace_string( person->externalID, value );
 392 }
 393
 394 /**
 395  * Specify value of open indicator for person object. This is typically used to
 396  * simplify open/close folders in the address book GUI.
 397  * \param person Person object.
 398  * \param value  Value for indicator. Set to <i>TRUE</i> if opened.
 399  */
 400 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
 401         person->isOpened = value;
 402 }
 403
 404 /**
 405  * Free linked list of item addresses; both addresses and the list are freed.
 406  * It is assumed that addresses are *NOT* contained within some other
 407  * container.
 408  * \param list List of addresses to be freed.
 409  */
 410 void addritem_free_list_email( GList *list ) {
 411         GList *node = list;
 412         while( node ) {
 413                 ItemEMail *email = node->data;
 414
 415                 addritem_free_item_email( email );
 416                 node->data = NULL;
 417                 node = g_list_next( node );
 418         }
 419         g_list_free( list );
 420         list = NULL;
 421 }
 422
 423 /**
 424  * Free linked list of attributes; both attributes and the list are freed.
 425  * It is assumed that attributes are *NOT* contained within some other
 426  * container.
 427  * \param list List of attributes to be freed.
 428  */
 429 void addritem_free_list_attribute( GList *list ) {
 430         GList *node = list;
 431         while( node ) {
 432                 addritem_free_attribute( node->data );
 433                 node->data = NULL;
 434                 node = g_list_next( node );
 435         }
 436         g_list_free( list );
 437 }
 438
 439 /**
 440  * Free address person object.
 441  * \param person Person object to free.
 442  */
 443 void addritem_free_item_person( ItemPerson *person ) {
 444         cm_return_if_fail( person != NULL );
 445
 446         /* Free internal stuff */
 447         g_free( ADDRITEM_ID(person) );
 448         g_free( ADDRITEM_NAME(person) );
 449         g_free( person->picture );
 450         g_free( person->firstName );
 451         g_free( person->lastName );
 452         g_free( person->nickName );
 453         g_free( person->externalID );
 454         g_list_free( person->listEMail );
 455         addritem_free_list_attribute( person->listAttrib );
 456
 457         ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
 458         ADDRITEM_ID(person) = NULL;
 459         ADDRITEM_NAME(person) = NULL;
 460         ADDRITEM_PARENT(person) = NULL;
 461         ADDRITEM_SUBTYPE(person) = 0;
 462         person->picture = NULL;
 463         person->firstName = NULL;
 464         person->lastName = NULL;
 465         person->nickName = NULL;
 466         person->externalID = NULL;
 467         person->listEMail = NULL;
 468         person->listAttrib = NULL;
 469
 470         g_free( person );
 471 }
 472
 473 /**
 474  * Print E-Mail address object for debug.
 475  * \param item   Item to print.
 476  * \param stream Output stream.
 477  */
 478 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
 479         cm_return_if_fail( item != NULL );
 480         fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
 481         fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
 482         fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
 483         fprintf( stream, "\t\taddr: '%s'\n", item->address );
 484         fprintf( stream, "\t\trems: '%s'\n", item->remarks );
 485         fprintf( stream, "\t\t---\n" );
 486 }
 487
 488 /**
 489  * Print user attribute object for debug.
 490  * \param item   Attribute to print.
 491  * \param stream Output stream.
 492  */
 493 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
 494         cm_return_if_fail( item != NULL );
 495         fprintf( stream, "\t\tuid  : '%s'\n", item->uid );
 496         fprintf( stream, "\t\tname : '%s'\n", item->name );
 497         fprintf( stream, "\t\tvalue: '%s'\n", item->value );
 498         fprintf( stream, "\t\t---\n" );
 499 }
 500
 501 /**
 502  * Print person item for debug.
 503  * \param person Person to print.
 504  * \param stream Output stream.
 505  */
 506 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
 507         GList *node;
 508         cm_return_if_fail( person != NULL );
 509         fprintf( stream, "Person:\n" );
 510         fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
 511         fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
 512         fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
 513         fprintf( stream, "\tphoto: '%s'\n", person->picture );
 514         fprintf( stream, "\tfirst: '%s'\n", person->firstName );
 515         fprintf( stream, "\tlast : '%s'\n", person->lastName );
 516         fprintf( stream, "\tnick : '%s'\n", person->nickName );
 517         fprintf( stream, "\textID: '%s'\n", person->externalID );
 518         fprintf( stream, "\teMail:\n" );
 519         fprintf( stream, "\t---\n" );
 520         node = person->listEMail;
 521         while( node ) {
 522                 addritem_print_item_email( node->data, stream );
 523                 node = g_list_next( node );
 524         }
 525         fprintf( stream, "\tuAttr:\n" );
 526         fprintf( stream, "\t---\n" );
 527         node = person->listAttrib;
 528         while( node ) {
 529                 addritem_print_attribute( node->data, stream );
 530                 node = g_list_next( node );
 531         }
 532         gchar *current_status;
 533         switch (person->status) {
 534                 case NONE: current_status = g_strdup("Unchanged"); break;
 535                 case ADD_ENTRY: current_status = g_strdup("New"); break;
 536                 case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
 537                 case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
 538                 default: current_status = g_strdup("Unknown");
 539         }
 540         fprintf( stream, "\t\tStatus: %s\n", current_status );
 541         if ( current_status )
 542                 g_free(current_status);
 543         fprintf( stream, "\t===\n" );
 544 }
 545
 546 /**
 547  * Add E-Mail address object to person.
 548  * \param  person Person.
 549  * \param  email  E-Mail object to add.
 550  * \return <i>TRUE</i> if E-Mail added.
 551  */
 552 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
 553         GList *node;
 554
 555         cm_return_val_if_fail( person != NULL, FALSE );
 556         cm_return_val_if_fail( email != NULL, FALSE );
 557
 558         node = person->listEMail;
 559         while( node ) {
 560                 if( node->data == email ) return FALSE;
 561                 node = g_list_next( node );
 562         }
 563         person->listEMail = g_list_append( person->listEMail, email );
 564         ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
 565         return TRUE;
 566 }
 567
 568 /**
 569  * Remove email address for specified person.
 570  * \param  person Person.
 571  * \param  email  EMail to remove.
 572  * \return EMail object, or <i>NULL</i> if not found. Note that object should
 573  *         still be freed after calling this method.
 574  */
 575 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
 576         gboolean found = FALSE;
 577         GList *node;
 578
 579         cm_return_val_if_fail( person != NULL, NULL );
 580         if( email == NULL ) return NULL;
 581
 582         /* Look for email */
 583         node = person->listEMail;
 584         while( node ) {
 585                 if( node-> data == email ) {
 586                         found = TRUE;
 587                         break;
 588                 }
 589                 node = g_list_next( node );
 590         }
 591
 592         if( found ) {
 593                 /* Remove email from person's address list */
 594                 if( person->listEMail ) {
 595                         person->listEMail = g_list_remove( person->listEMail, email );
 596                 }
 597                 /* Unlink reference to person. */
 598                 ADDRITEM_PARENT(email) = NULL;
 599                 return email;
 600         }
 601         return NULL;
 602 }
 603
 604 /**
 605  * Add user attribute to specified person.
 606  * \param  person Person.
 607  * \param  attrib Attribute to add.
 608  * \return <i>TRUE</i> if item added.
 609  */
 610 void addritem_person_add_attribute(
 611                         ItemPerson *person, UserAttribute *attrib )
 612 {
 613         cm_return_if_fail( person != NULL );
 614         person->listAttrib = g_list_append( person->listAttrib, attrib );
 615 }
 616
 617 /**
 618  * Remove user attribute from specified person.
 619  * \param  person Person.
 620  * \param  attrib Attribute to remove.
 621  */
 622 void addritem_person_remove_attribute(  ItemPerson *person, const gchar *attrib ) {
 623         cm_return_if_fail( person != NULL && attrib != NULL );
 624         GList *attrib_list;
 625
 626         attrib_list = person->listAttrib;
 627         while (attrib_list) {
 628                 UserAttribute *user_attrib = attrib_list->data;
 629                 if (strcmp(user_attrib->name, attrib) == 0) {
 630                         person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
 631                         break;
 632                 }
 633                 attrib_list = g_list_next(attrib_list);
 634         }
 635 }
 636
 637
 638 /**
 639  * Create new address book group object.
 640  * \return Initialized group object.
 641  */
 642 ItemGroup *addritem_create_item_group( void ) {
 643         ItemGroup *group;
 644
 645         group = g_new0( ItemGroup, 1 );
 646         ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
 647         ADDRITEM_ID(group) = NULL;
 648         ADDRITEM_NAME(group) = NULL;
 649         ADDRITEM_PARENT(group) = NULL;
 650         ADDRITEM_SUBTYPE(group) = 0;
 651         group->remarks = NULL;
 652         group->listEMail = NULL;
 653         return group;
 654 }
 655
 656 /**
 657  * Copy (deep copy) address book group.
 658  * \param  item Group to copy.
 659  * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
 660  */
 661 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
 662         ItemGroup *itemNew;
 663
 664         itemNew = NULL;
 665         if( item ) {
 666                 itemNew = addritem_create_item_group();
 667                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 668                 itemNew->remarks = g_strdup( item->remarks );
 669         }
 670         return itemNew;
 671 }
 672
 673 /**
 674  * Specify name to be used for group.
 675  * \param group Group object.
 676  * \param value Name of group.
 677  */
 678 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
 679         ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
 680 }
 681
 682 /**
 683  * Free address group object.
 684  * \param group Group to free.
 685  */
 686 void addritem_free_item_group( ItemGroup *group ) {
 687         cm_return_if_fail( group != NULL );
 688
 689         /* Free internal stuff */
 690         g_free( ADDRITEM_ID(group) );
 691         g_free( ADDRITEM_NAME(group) );
 692         g_free( group->remarks );
 693         g_list_free( group->listEMail );
 694
 695         ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
 696         ADDRITEM_ID(group) = NULL;
 697         ADDRITEM_NAME(group) = NULL;
 698         ADDRITEM_PARENT(group) = NULL;
 699         ADDRITEM_SUBTYPE(group) = 0;
 700         group->remarks = NULL;
 701         group->listEMail = NULL;
 702
 703         g_free( group );
 704 }
 705
 706 /**
 707  * Add EMail address to group. Note that a reference to an E-Mail item is
 708  * added to a group. A person object is the only container that for an
 709  * address.
 710  * \param  group Group.
 711  * \param  email E-Mail object.
 712  * \return <i>TRUE</i> if email item added.
 713  */
 714 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
 715         GList *node;
 716
 717         cm_return_val_if_fail( group != NULL, FALSE );
 718         cm_return_val_if_fail( email != NULL, FALSE );
 719
 720         node = group->listEMail;
 721         while( node ) {
 722                 if( node->data == email ) return FALSE;
 723                 node = g_list_next( node );
 724         }
 725         group->listEMail = g_list_append( group->listEMail, email );
 726         return TRUE;
 727 }
 728
 729 /**
 730  * Remove person object for specified group.
 731  * \param  group Group from which to remove address.
 732  * \param  email EMail to remove
 733  * \return EMail object, or <i>NULL if email not found in group. Note that
 734  *         this object is referenced (linked) to a group and should *NOT*
 735  *         be freed. An E-Mail object object should only be freed after
 736  *         removing from a person.
 737  */
 738 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
 739         if( group && person ) {
 740                 GList *node = group->listPerson;
 741                 while( node ) {
 742                         if( node->data == person ) {
 743                                 group->listPerson = g_list_remove( group->listPerson, person );
 744                                 return person;
 745                         }
 746                         node = g_list_next( node );
 747                 }
 748         }
 749         return NULL;
 750 }
 751
 752 /**
 753  * Print address group item for debug.
 754  * \param group  Group to print.
 755  * \param stream Output stream.
 756  */
 757 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
 758         GList *node;
 759         ItemPerson *person;
 760         ItemEMail *item;
 761         cm_return_if_fail( group != NULL );
 762         fprintf( stream, "Group:\n" );
 763         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
 764         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
 765         fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
 766         fprintf( stream, "\trem: '%s'\n", group->remarks );
 767         fprintf( stream, "\t---\n" );
 768         node = group->listEMail;
 769         while( node ) {
 770                 item = node->data;
 771                 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
 772                 if( person ) {
 773                         fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
 774                         fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
 775                 }
 776                 else {
 777                         fprintf( stream, "\t\tpid : ???\n" );
 778                         fprintf( stream, "\t\tcomn: ???\n" );
 779                 }
 780                 addritem_print_item_email( item, stream );
 781                 node = g_list_next( node );
 782         }
 783         fprintf( stream, "\t***\n" );
 784 }
 785
 786 /**
 787  * Create new address folder.
 788  * \return Initialized address folder object.
 789  */
 790 ItemFolder *addritem_create_item_folder( void ) {
 791         ItemFolder *folder;
 792         folder = g_new0( ItemFolder, 1 );
 793         if (!folder)
 794                 g_error("could not create new itemFolder");
 795         ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
 796         ADDRITEM_ID(folder) = NULL;
 797         ADDRITEM_NAME(folder) = NULL;
 798         ADDRITEM_PARENT(folder) = NULL;
 799         ADDRITEM_SUBTYPE(folder) = 0;
 800         folder->remarks = NULL;
 801         folder->isRoot = FALSE;
 802         folder->listItems = NULL;
 803         folder->listFolder = NULL;
 804         folder->listPerson = NULL;
 805         folder->listGroup = NULL;
 806         folder->folderType = ADDRFOLDER_NONE;
 807         folder->folderData = NULL;
 808         folder->isHidden = FALSE;
 809         return folder;
 810 }
 811
 812 /**
 813  * Copy address book folder. Note that only the folder and not its contents are
 814  * copied.
 815  * \param  item Folder to copy.
 816  * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
 817  */
 818 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
 819         ItemFolder *itemNew = NULL;
 820
 821         if( item ) {
 822                 itemNew = addritem_create_item_folder();
 823                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
 824                 itemNew->folderType = item->folderType;
 825         } else
 826                 g_error("could not create a copy of a null itemFolder");
 827         return itemNew;
 828 }
 829
 830 /**
 831  * Specify name to be used for folder.
 832  * \param folder Folder.
 833  * \param value  Name.
 834  */
 835 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
 836         ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
 837 }
 838
 839 /**
 840  * Specify remarks to be used for folder.
 841  * \param folder Folder.
 842  * \param value  Remarks.
 843  */
 844 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
 845         folder->remarks = mgu_replace_string( folder->remarks, value );
 846 }
 847
 848 /**
 849  * Specify visibility of folder.
 850  * \param folder Folder.
 851  * \param value  Set to <code>TRUE</code> to hide folder.
 852  */
 853 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
 854         folder->isHidden = value;
 855 }
 856
 857 /**
 858  * Free address folder. Note: this does not free up the lists of children
 859  * (folders, groups and person). This should be done prior to calling this
 860  * function.
 861  * \param folder Folder to free.
 862  */
 863 void addritem_free_item_folder( ItemFolder *folder ) {
 864         cm_return_if_fail( folder != NULL );
 865
 866         /* Free internal stuff */
 867         g_free( ADDRITEM_ID(folder) );
 868         g_free( ADDRITEM_NAME(folder) );
 869         g_free( folder->remarks );
 870         g_list_free( folder->listItems );
 871
 872         ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
 873         ADDRITEM_ID(folder) = NULL;
 874         ADDRITEM_NAME(folder) = NULL;
 875         ADDRITEM_PARENT(folder) = NULL;
 876         ADDRITEM_SUBTYPE(folder) = 0;
 877         folder->isRoot = FALSE;
 878         folder->remarks = NULL;
 879         folder->listItems = NULL;
 880         folder->listFolder = NULL;
 881         folder->listGroup = NULL;
 882         folder->listPerson = NULL;
 883         folder->folderType = ADDRFOLDER_NONE;
 884         folder->folderData = NULL;
 885         folder->isHidden = FALSE;
 886
 887         g_free( folder );
 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         cm_return_val_if_fail( folder != NULL, FALSE );
 898         cm_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         cm_return_val_if_fail( folder != NULL, FALSE );
 913         cm_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         cm_return_val_if_fail( folder != NULL, FALSE );
 928         cm_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         cm_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         cm_return_val_if_fail( folder != NULL, NULL );
1024
1025         node = folder->listPerson;
1026         while( node ) {
1027                 ItemPerson *person = node->data;
1028                 list = g_list_prepend( list, person );
1029                 node = g_list_next( node );
1030         }
1031         return g_list_reverse(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         cm_return_val_if_fail( folder != NULL, NULL );
1047
1048         node = folder->listGroup;
1049         while( node ) {
1050                 ItemGroup *group = node->data;
1051                 list = g_list_prepend( list, group );
1052                 node = g_list_next( node );
1053         }
1054         return g_list_reverse(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         cm_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 */