2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2017 Match Grun and the Claws Mail team
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.
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.
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/>.
20 * General primitive address item objects.
34 * Create new email address item.
35 * \return Initialized email item.
37 ItemEMail *addritem_create_item_email( void ) {
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;
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.
55 ItemEMail *addritem_copy_item_email( ItemEMail *item ) {
56 ItemEMail *itemNew = NULL;
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 );
67 * Create a full copy (deep copy) of specified email address item.
68 * \param item E-Mail to copy.
69 * \return Copy of email.
71 ItemEMail *addritem_copyfull_item_email( ItemEMail *item ) {
72 ItemEMail *itemNew = NULL;
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 );
85 * Specify alias for email.
86 * \param email E-Mail item.
89 void addritem_email_set_alias( ItemEMail *email, const gchar *value ) {
90 ADDRITEM_NAME(email) = mgu_replace_string( ADDRITEM_NAME(email), value );
94 * Specify address for email.
95 * \param email E-Mail item.
96 * \param value Address.
98 void addritem_email_set_address( ItemEMail *email, const gchar *value ) {
99 email->address = mgu_replace_string( email->address, value );
103 * Specify remarks for email.
104 * \param email E-Mail item.
105 * \param value Remarks.
107 void addritem_email_set_remarks( ItemEMail *email, const gchar *value ) {
108 email->remarks = mgu_replace_string( email->remarks, value );
112 * Free address item email object.
113 * \param item E-Mail item to free.
115 void addritem_free_item_email( ItemEMail *item ) {
116 cm_return_if_fail( item != NULL );
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 );
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;
135 * Create new attribute object.
136 * \return Initialized attribute object.
138 UserAttribute *addritem_create_attribute( void ) {
140 item = g_new0( UserAttribute, 1 );
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.
152 UserAttribute *addritem_copy_attribute( UserAttribute *item ) {
153 UserAttribute *itemNew = NULL;
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 );
164 * Specify ID for attribute.
165 * \param item Attribute object.
168 void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
169 cm_return_if_fail( item != NULL );
170 item->uid = mgu_replace_string( item->uid, value );
174 * Specify name for attribute.
175 * \param item Attribute object.
178 void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
179 cm_return_if_fail( item != NULL );
180 item->name = mgu_replace_string( item->name, value );
184 * Specify value for attribute.
185 * \param item Attribute object.
186 * \param value Value.
188 void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
189 cm_return_if_fail( item != NULL );
190 item->value = mgu_replace_string( item->value, value );
194 * Free user attribute.
195 * \param item Attribute object to free.
197 void addritem_free_attribute( UserAttribute *item ) {
198 cm_return_if_fail( item != NULL );
200 g_free( item->name );
201 g_free( item->value );
209 * Create new address book person.
210 * \return Initialized person object.
212 ItemPerson *addritem_create_item_person( void ) {
214 person = g_new0( ItemPerson, 1 );
215 ADDRITEM_TYPE(person) = ITEMTYPE_PERSON;
216 ADDRITEM_ID(person) = NULL;
217 ADDRITEM_NAME(person) = NULL;
218 ADDRITEM_PARENT(person) = NULL;
219 ADDRITEM_SUBTYPE(person) = 0;
220 person->picture = NULL;
221 person->firstName = NULL;
222 person->lastName = NULL;
223 person->nickName = NULL;
224 person->listEMail = NULL;
225 person->listAttrib = NULL;
226 person->externalID = NULL;
227 person->isOpened = FALSE;
228 person->status = NONE;
233 * Create a shallow copy of address book person object.
234 * \param item Person to copy.
235 * \return Copy of person, or <i>NULL</i> if null argument supplied.
237 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
242 itemNew = addritem_create_item_person();
243 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
244 itemNew->picture = g_strdup( ADDRITEM_ID(itemNew) );
245 itemNew->firstName = g_strdup( item->firstName );
246 itemNew->lastName = g_strdup( item->lastName );
247 itemNew->nickName = g_strdup( item->nickName );
248 itemNew->externalID = g_strdup( item->externalID );
249 itemNew->status = item->status;
255 * Specify picture for person object.
256 * \param person Person object.
257 * \param value Picture.
259 void addritem_person_set_picture( ItemPerson *person, const gchar *value ) {
260 if (!value || g_utf8_validate(value, -1, NULL))
261 person->picture = mgu_replace_string( person->picture, value );
263 gchar *out = conv_codeset_strdup(value,
264 conv_get_locale_charset_str_no_utf8(),
267 person->picture = mgu_replace_string( person->picture, out );
273 * Get picture for person object.
274 * \param person Person object.
276 gchar *addritem_person_get_picture( ItemPerson *person) {
278 return g_strdup(person->picture);
283 * Delete picture for person object.
284 * \param person Person object.
286 void addritem_person_remove_picture( ItemPerson *person) {
287 if (person->picture) {
288 gchar *filename = g_strconcat( get_rc_dir(), G_DIR_SEPARATOR_S,
289 ADDRBOOK_DIR, G_DIR_SEPARATOR_S, person->picture,
291 if (is_file_exist(filename)) {
292 debug_print("removing addressbook picture %s\n",
294 if (claws_unlink(filename) < 0) {
295 FILE_OP_ERROR(filename, "remove");
300 g_free(person->picture);
301 person->picture = NULL;
307 * Specify first name for person object.
308 * \param person Person object.
311 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
312 if (!value || g_utf8_validate(value, -1, NULL))
313 person->firstName = mgu_replace_string( person->firstName, value );
315 gchar *out = conv_codeset_strdup(value,
316 conv_get_locale_charset_str_no_utf8(),
319 person->firstName = mgu_replace_string( person->firstName, out );
325 * Specify last name for person object.
326 * \param person Person object.
329 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
330 if (!value || g_utf8_validate(value, -1, NULL))
331 person->lastName = mgu_replace_string( person->lastName, value );
333 gchar *out = conv_codeset_strdup(value,
334 conv_get_locale_charset_str_no_utf8(),
337 person->lastName = mgu_replace_string( person->lastName, out );
343 * Specify nick name for person object.
344 * \param person Person object.
347 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
348 if (!value || g_utf8_validate(value, -1, NULL))
349 person->nickName = mgu_replace_string( person->nickName, value );
351 gchar *out = conv_codeset_strdup(value,
352 conv_get_locale_charset_str_no_utf8(),
355 person->nickName = mgu_replace_string( person->nickName, out );
361 * Specify common name for person object.
362 * \param person Person object.
365 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
366 if (!value || g_utf8_validate(value, -1, NULL))
367 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
369 gchar *out = conv_codeset_strdup(value,
370 conv_get_locale_charset_str_no_utf8(),
373 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
379 * Specify external ID for person object.
380 * \param person Person object.
383 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
384 person->externalID = mgu_replace_string( person->externalID, value );
388 * Specify value of open indicator for person object. This is typically used to
389 * simplify open/close folders in the address book GUI.
390 * \param person Person object.
391 * \param value Value for indicator. Set to <i>TRUE</i> if opened.
393 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
394 person->isOpened = value;
398 * Free linked list of item addresses; both addresses and the list are freed.
399 * It is assumed that addresses are *NOT* contained within some other
401 * \param list List of addresses to be freed.
403 void addritem_free_list_email( GList *list ) {
406 ItemEMail *email = node->data;
408 addritem_free_item_email( email );
410 node = g_list_next( node );
417 * Free linked list of attributes; both attributes and the list are freed.
418 * It is assumed that attributes are *NOT* contained within some other
420 * \param list List of attributes to be freed.
422 void addritem_free_list_attribute( GList *list ) {
425 addritem_free_attribute( node->data );
427 node = g_list_next( node );
433 * Free address person object.
434 * \param person Person object to free.
436 void addritem_free_item_person( ItemPerson *person ) {
437 cm_return_if_fail( person != NULL );
439 /* Free internal stuff */
440 g_free( ADDRITEM_ID(person) );
441 g_free( ADDRITEM_NAME(person) );
442 g_free( person->picture );
443 g_free( person->firstName );
444 g_free( person->lastName );
445 g_free( person->nickName );
446 g_free( person->externalID );
447 g_list_free( person->listEMail );
448 addritem_free_list_attribute( person->listAttrib );
450 ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
451 ADDRITEM_ID(person) = NULL;
452 ADDRITEM_NAME(person) = NULL;
453 ADDRITEM_PARENT(person) = NULL;
454 ADDRITEM_SUBTYPE(person) = 0;
455 person->picture = NULL;
456 person->firstName = NULL;
457 person->lastName = NULL;
458 person->nickName = NULL;
459 person->externalID = NULL;
460 person->listEMail = NULL;
461 person->listAttrib = NULL;
467 * Print E-Mail address object for debug.
468 * \param item Item to print.
469 * \param stream Output stream.
471 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
472 cm_return_if_fail( item != NULL );
473 fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
474 fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
475 fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
476 fprintf( stream, "\t\taddr: '%s'\n", item->address );
477 fprintf( stream, "\t\trems: '%s'\n", item->remarks );
478 fprintf( stream, "\t\t---\n" );
482 * Print user attribute object for debug.
483 * \param item Attribute to print.
484 * \param stream Output stream.
486 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
487 cm_return_if_fail( item != NULL );
488 fprintf( stream, "\t\tuid : '%s'\n", item->uid );
489 fprintf( stream, "\t\tname : '%s'\n", item->name );
490 fprintf( stream, "\t\tvalue: '%s'\n", item->value );
491 fprintf( stream, "\t\t---\n" );
495 * Print person item for debug.
496 * \param person Person to print.
497 * \param stream Output stream.
499 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
501 cm_return_if_fail( person != NULL );
502 fprintf( stream, "Person:\n" );
503 fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
504 fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
505 fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
506 fprintf( stream, "\tphoto: '%s'\n", person->picture );
507 fprintf( stream, "\tfirst: '%s'\n", person->firstName );
508 fprintf( stream, "\tlast : '%s'\n", person->lastName );
509 fprintf( stream, "\tnick : '%s'\n", person->nickName );
510 fprintf( stream, "\textID: '%s'\n", person->externalID );
511 fprintf( stream, "\teMail:\n" );
512 fprintf( stream, "\t---\n" );
513 node = person->listEMail;
515 addritem_print_item_email( node->data, stream );
516 node = g_list_next( node );
518 fprintf( stream, "\tuAttr:\n" );
519 fprintf( stream, "\t---\n" );
520 node = person->listAttrib;
522 addritem_print_attribute( node->data, stream );
523 node = g_list_next( node );
525 gchar *current_status;
526 switch (person->status) {
527 case NONE: current_status = g_strdup("Unchanged"); break;
528 case ADD_ENTRY: current_status = g_strdup("New"); break;
529 case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
530 case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
531 default: current_status = g_strdup("Unknown");
533 fprintf( stream, "\t\tStatus: %s\n", current_status );
534 if ( current_status )
535 g_free(current_status);
536 fprintf( stream, "\t===\n" );
540 * Add E-Mail address object to person.
541 * \param person Person.
542 * \param email E-Mail object to add.
543 * \return <i>TRUE</i> if E-Mail added.
545 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
548 cm_return_val_if_fail( person != NULL, FALSE );
549 cm_return_val_if_fail( email != NULL, FALSE );
551 node = person->listEMail;
553 if( node->data == email ) return FALSE;
554 node = g_list_next( node );
556 person->listEMail = g_list_append( person->listEMail, email );
557 ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
562 * Remove email address for specified person.
563 * \param person Person.
564 * \param email EMail to remove.
565 * \return EMail object, or <i>NULL</i> if not found. Note that object should
566 * still be freed after calling this method.
568 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
569 gboolean found = FALSE;
572 cm_return_val_if_fail( person != NULL, NULL );
573 if( email == NULL ) return NULL;
576 node = person->listEMail;
578 if( node-> data == email ) {
582 node = g_list_next( node );
586 /* Remove email from person's address list */
587 if( person->listEMail ) {
588 person->listEMail = g_list_remove( person->listEMail, email );
590 /* Unlink reference to person. */
591 ADDRITEM_PARENT(email) = NULL;
598 * Add user attribute to specified person.
599 * \param person Person.
600 * \param attrib Attribute to add.
601 * \return <i>TRUE</i> if item added.
603 void addritem_person_add_attribute(
604 ItemPerson *person, UserAttribute *attrib )
606 cm_return_if_fail( person != NULL );
607 person->listAttrib = g_list_append( person->listAttrib, attrib );
611 * Remove user attribute from specified person.
612 * \param person Person.
613 * \param attrib Attribute to remove.
615 void addritem_person_remove_attribute( ItemPerson *person, const gchar *attrib ) {
616 cm_return_if_fail( person != NULL && attrib != NULL );
619 attrib_list = person->listAttrib;
620 while (attrib_list) {
621 UserAttribute *user_attrib = attrib_list->data;
622 if (strcmp(user_attrib->name, attrib) == 0) {
623 person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
626 attrib_list = g_list_next(attrib_list);
632 * Create new address book group object.
633 * \return Initialized group object.
635 ItemGroup *addritem_create_item_group( void ) {
638 group = g_new0( ItemGroup, 1 );
639 ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
640 ADDRITEM_ID(group) = NULL;
641 ADDRITEM_NAME(group) = NULL;
642 ADDRITEM_PARENT(group) = NULL;
643 ADDRITEM_SUBTYPE(group) = 0;
644 group->remarks = NULL;
645 group->listEMail = NULL;
650 * Copy (deep copy) address book group.
651 * \param item Group to copy.
652 * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
654 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
659 itemNew = addritem_create_item_group();
660 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
661 itemNew->remarks = g_strdup( item->remarks );
667 * Specify name to be used for group.
668 * \param group Group object.
669 * \param value Name of group.
671 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
672 ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
676 * Free address group object.
677 * \param group Group to free.
679 void addritem_free_item_group( ItemGroup *group ) {
680 cm_return_if_fail( group != NULL );
682 /* Free internal stuff */
683 g_free( ADDRITEM_ID(group) );
684 g_free( ADDRITEM_NAME(group) );
685 g_free( group->remarks );
686 mgu_clear_list( group->listEMail );
687 g_list_free( group->listEMail );
689 ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
690 ADDRITEM_ID(group) = NULL;
691 ADDRITEM_NAME(group) = NULL;
692 ADDRITEM_PARENT(group) = NULL;
693 ADDRITEM_SUBTYPE(group) = 0;
694 group->remarks = NULL;
695 group->listEMail = NULL;
701 * Add EMail address to group. Note that a reference to an E-Mail item is
702 * added to a group. A person object is the only container that for an
704 * \param group Group.
705 * \param email E-Mail object.
706 * \return <i>TRUE</i> if email item added.
708 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
711 cm_return_val_if_fail( group != NULL, FALSE );
712 cm_return_val_if_fail( email != NULL, FALSE );
714 node = group->listEMail;
716 if( node->data == email ) return FALSE;
717 node = g_list_next( node );
719 group->listEMail = g_list_append( group->listEMail, email );
724 * Remove person object for specified group.
725 * \param group Group from which to remove address.
726 * \param email EMail to remove
727 * \return EMail object, or <i>NULL if email not found in group. Note that
728 * this object is referenced (linked) to a group and should *NOT*
729 * be freed. An E-Mail object object should only be freed after
730 * removing from a person.
732 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
733 if( group && person ) {
734 GList *node = group->listPerson;
736 if( node->data == person ) {
737 group->listPerson = g_list_remove( group->listPerson, person );
740 node = g_list_next( node );
747 * Print address group item for debug.
748 * \param group Group to print.
749 * \param stream Output stream.
751 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
755 cm_return_if_fail( group != NULL );
756 fprintf( stream, "Group:\n" );
757 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
758 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
759 fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
760 fprintf( stream, "\trem: '%s'\n", group->remarks );
761 fprintf( stream, "\t---\n" );
762 node = group->listEMail;
765 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
767 fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
768 fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
771 fprintf( stream, "\t\tpid : ???\n" );
772 fprintf( stream, "\t\tcomn: ???\n" );
774 addritem_print_item_email( item, stream );
775 node = g_list_next( node );
777 fprintf( stream, "\t***\n" );
781 * Create new address folder.
782 * \return Initialized address folder object.
784 ItemFolder *addritem_create_item_folder( void ) {
786 folder = g_new0( ItemFolder, 1 );
787 ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
788 ADDRITEM_ID(folder) = NULL;
789 ADDRITEM_NAME(folder) = NULL;
790 ADDRITEM_PARENT(folder) = NULL;
791 ADDRITEM_SUBTYPE(folder) = 0;
792 folder->remarks = NULL;
793 folder->isRoot = FALSE;
794 folder->listItems = NULL;
795 folder->listFolder = NULL;
796 folder->listPerson = NULL;
797 folder->listGroup = NULL;
798 folder->folderType = ADDRFOLDER_NONE;
799 folder->folderData = NULL;
800 folder->isHidden = FALSE;
805 * Copy address book folder. Note that only the folder and not its contents are
807 * \param item Folder to copy.
808 * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
810 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
813 itemNew = g_new0( ItemFolder, 1 );
815 itemNew = addritem_create_item_folder();
816 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
817 itemNew->folderType = item->folderType;
823 * Specify name to be used for folder.
824 * \param folder Folder.
827 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
828 ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
832 * Specify remarks to be used for folder.
833 * \param folder Folder.
834 * \param value Remarks.
836 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
837 folder->remarks = mgu_replace_string( folder->remarks, value );
841 * Specify visibility of folder.
842 * \param folder Folder.
843 * \param value Set to <code>TRUE</code> to hide folder.
845 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
846 folder->isHidden = value;
850 * Free address folder. Note: this does not free up the lists of children
851 * (folders, groups and person). This should be done prior to calling this
853 * \param folder Folder to free.
855 void addritem_free_item_folder( ItemFolder *folder ) {
856 cm_return_if_fail( folder != NULL );
858 /* Free internal stuff */
859 g_free( ADDRITEM_ID(folder) );
860 g_free( ADDRITEM_NAME(folder) );
861 g_free( folder->remarks );
862 mgu_clear_list( folder->listItems );
863 g_list_free( folder->listItems );
865 ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
866 ADDRITEM_ID(folder) = NULL;
867 ADDRITEM_NAME(folder) = NULL;
868 ADDRITEM_PARENT(folder) = NULL;
869 ADDRITEM_SUBTYPE(folder) = 0;
870 folder->isRoot = FALSE;
871 folder->remarks = NULL;
872 folder->listItems = NULL;
873 folder->listFolder = NULL;
874 folder->listGroup = NULL;
875 folder->listPerson = NULL;
876 folder->folderType = ADDRFOLDER_NONE;
877 folder->folderData = NULL;
878 folder->isHidden = FALSE;
884 * Add person into folder.
885 * \param folder Folder.
886 * \param item Person to add.
887 * \return <i>TRUE</i> if person added.
889 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
890 cm_return_val_if_fail( folder != NULL, FALSE );
891 cm_return_val_if_fail( item != NULL, FALSE );
893 folder->listPerson = g_list_append( folder->listPerson, item );
894 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
899 * Add folder into folder.
900 * \param folder Folder.
901 * \param item Folder to add.
902 * \return <i>TRUE</i> if folder added.
904 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
905 cm_return_val_if_fail( folder != NULL, FALSE );
906 cm_return_val_if_fail( item != NULL, FALSE );
908 folder->listFolder = g_list_append( folder->listFolder, item );
909 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
914 * Add group into folder.
915 * \param folder Folder.
916 * \param item Group to add.
917 * \return <i>TRUE</i> if group added.
919 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
920 cm_return_val_if_fail( folder != NULL, FALSE );
921 cm_return_val_if_fail( item != NULL, FALSE );
923 folder->listGroup = g_list_append( folder->listGroup, item );
924 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
929 * Print address folder item contents for debug.
930 * \param folder Folder to process.
931 * \param stream Output stream.
933 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
935 /* ItemPerson *person; */
938 cm_return_if_fail( folder != NULL );
940 fprintf( stream, "Folder:\n" );
941 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
942 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
943 fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
944 fprintf( stream, "\trem: '%s'\n", folder->remarks );
945 fprintf( stream, "\ttyp: %d\n", folder->folderType );
946 fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
947 fprintf( stream, "\t---\n" );
948 parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
950 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
953 fprintf( stream, "\tpar: NULL\n" );
955 node = folder->listFolder;
957 AddrItemObject *aio = node->data;
959 if( aio->type == ITEMTYPE_FOLDER ) {
960 ItemFolder *item = ( ItemFolder * ) aio;
961 addritem_print_item_folder( item, stream );
965 fprintf( stream, "\t\tpid : ???\n" );
968 node = g_list_next( node );
971 node = folder->listPerson;
973 AddrItemObject *aio = node->data;
975 if( aio->type == ITEMTYPE_PERSON ) {
976 ItemPerson *item = ( ItemPerson * ) aio;
977 addritem_print_item_person( item, stream );
981 fprintf( stream, "\t\tpid : ???\n" );
984 node = g_list_next( node );
987 node = folder->listGroup;
989 AddrItemObject *aio = node->data;
991 if( aio->type == ITEMTYPE_GROUP ) {
992 ItemGroup *item = ( ItemGroup * ) aio;
993 addritem_print_item_group( item, stream );
997 fprintf( stream, "\t\tpid : ???\n" );
999 node = g_list_next( node );
1001 fprintf( stream, "\t###\n" );
1005 * Return link list of persons for specified folder. Note that the list contains
1006 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1007 * addritem_free_xxx() functions... this will destroy the addressbook data!
1009 * \param folder Folder to process.
1010 * \return List of items, or <i>NULL</i> if none.
1012 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
1016 cm_return_val_if_fail( folder != NULL, NULL );
1018 node = folder->listPerson;
1020 ItemPerson *person = node->data;
1021 list = g_list_prepend( list, person );
1022 node = g_list_next( node );
1024 return g_list_reverse(list);
1028 * Return link list of groups for specified folder. Note that the list contains
1029 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1030 * addritem_free_xxx() functions... this will destroy the addressbook data!
1032 * \param folder Folder to process.
1033 * \return List of items, or <i>NULL</i> if none.
1035 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1039 cm_return_val_if_fail( folder != NULL, NULL );
1041 node = folder->listGroup;
1043 ItemGroup *group = node->data;
1044 list = g_list_prepend( list, group );
1045 node = g_list_next( node );
1047 return g_list_reverse(list);
1051 * Parse first and last names for person from common name.
1052 * \param person Person to process.
1054 void addritem_parse_first_last( ItemPerson *person ) {
1056 gchar *fName, *lName;
1060 cm_return_if_fail( person != NULL );
1062 name = ADDRITEM_NAME(person);
1063 if( name == NULL ) return;
1067 p = strchr( name, ',' );
1069 len = ( size_t ) ( p - name );
1070 lName = g_strndup( name, len );
1071 fName = g_strdup( p + 1 );
1074 /* Other way around */
1077 if( name[i] == ' ' ) {
1078 fName = g_strndup( name, i );
1079 lName = g_strdup( &name[i] );
1084 if( fName == NULL ) {
1085 fName = g_strdup( name );
1089 g_free( person->firstName );
1090 person->firstName = fName;
1091 if( person->firstName )
1092 g_strstrip( person->firstName );
1094 g_free( person->lastName );
1095 person->lastName = lName;
1096 if( person->lastName )
1097 g_strstrip( person->lastName );
1101 * Build a path of all ancestor folders for specified folder.
1102 * \param folder Folder.
1103 * \param seq Path sequence, FALSE top down, TRUE bottom up.
1104 * \return List of folders from the top down.
1106 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1108 AddrItemObject *item;
1111 item = ( AddrItemObject * ) folder;
1114 list = g_list_prepend( list, item );
1115 item = ADDRITEM_PARENT( item );
1120 list = g_list_append( list, item );
1121 item = ADDRITEM_PARENT( item );
1128 * Format E-Mail address.
1129 * \param email EMail item to format.
1130 * \return Formatted string. Should be freed after use.
1132 gchar *addritem_format_email( ItemEMail *email ) {
1139 if( ADDRITEM_NAME( email ) ) {
1140 if( strlen( ADDRITEM_NAME( email ) ) ) {
1141 name = ADDRITEM_NAME( email );
1145 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1146 name = ADDRITEM_NAME( person );
1150 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1151 address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1154 address = g_strdup_printf( "%s <%s>", name, email->address );
1158 address = g_strdup_printf( "%s", email->address );