2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2007 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/>.
21 * 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 g_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 g_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 g_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 g_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 g_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( item->picture );
245 itemNew->firstName = g_strdup( item->firstName );
246 itemNew->lastName = g_strdup( item->lastName );
247 itemNew->nickName = g_strdup( item->nickName );
248 itemNew->externalID = g_strdup( item->externalID );
249 itemNew->status = item->status;
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.
275 * \param value Picture.
277 gchar *addritem_person_get_picture( ItemPerson *person) {
279 return g_strdup(person->picture);
283 * Specify first name for person object.
284 * \param person Person object.
287 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
288 if (!value || g_utf8_validate(value, -1, NULL))
289 person->firstName = mgu_replace_string( person->firstName, value );
291 gchar *out = conv_codeset_strdup(value,
292 conv_get_locale_charset_str_no_utf8(),
295 person->firstName = mgu_replace_string( person->firstName, out );
301 * Specify last name for person object.
302 * \param person Person object.
305 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
306 if (!value || g_utf8_validate(value, -1, NULL))
307 person->lastName = mgu_replace_string( person->lastName, value );
309 gchar *out = conv_codeset_strdup(value,
310 conv_get_locale_charset_str_no_utf8(),
313 person->lastName = mgu_replace_string( person->lastName, out );
319 * Specify nick name for person object.
320 * \param person Person object.
323 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
324 if (!value || g_utf8_validate(value, -1, NULL))
325 person->nickName = mgu_replace_string( person->nickName, value );
327 gchar *out = conv_codeset_strdup(value,
328 conv_get_locale_charset_str_no_utf8(),
331 person->nickName = mgu_replace_string( person->nickName, out );
337 * Specify common name for person object.
338 * \param person Person object.
341 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
342 if (!value || g_utf8_validate(value, -1, NULL))
343 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
345 gchar *out = conv_codeset_strdup(value,
346 conv_get_locale_charset_str_no_utf8(),
349 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
355 * Specify external ID for person object.
356 * \param person Person object.
359 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
360 person->externalID = mgu_replace_string( person->externalID, value );
364 * Specify value of open indicator for person object. This is typically used to
365 * simplify open/close folders in the address book GUI.
366 * \param person Person object.
367 * \param value Value for indicator. Set to <i>TRUE</i> if opened.
369 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
370 person->isOpened = value;
374 * Free linked list of item addresses; both addresses and the list are freed.
375 * It is assumed that addresses are *NOT* contained within some other
377 * \param list List of addresses to be freed.
379 void addritem_free_list_email( GList *list ) {
382 ItemEMail *email = node->data;
384 addritem_free_item_email( email );
386 node = g_list_next( node );
393 * Free linked list of attributes; both attributes and the list are freed.
394 * It is assumed that attributes are *NOT* contained within some other
396 * \param list List of attributes to be freed.
398 void addritem_free_list_attribute( GList *list ) {
401 addritem_free_attribute( node->data );
403 node = g_list_next( node );
409 * Free address person object.
410 * \param person Person object to free.
412 void addritem_free_item_person( ItemPerson *person ) {
413 g_return_if_fail( person != NULL );
415 /* Free internal stuff */
416 g_free( ADDRITEM_ID(person) );
417 g_free( ADDRITEM_NAME(person) );
418 g_free( person->picture );
419 g_free( person->firstName );
420 g_free( person->lastName );
421 g_free( person->nickName );
422 g_free( person->externalID );
423 g_list_free( person->listEMail );
424 addritem_free_list_attribute( person->listAttrib );
426 ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
427 ADDRITEM_ID(person) = NULL;
428 ADDRITEM_NAME(person) = NULL;
429 ADDRITEM_PARENT(person) = NULL;
430 ADDRITEM_SUBTYPE(person) = 0;
431 person->picture = NULL;
432 person->firstName = NULL;
433 person->lastName = NULL;
434 person->nickName = NULL;
435 person->externalID = NULL;
436 person->listEMail = NULL;
437 person->listAttrib = NULL;
443 * Print E-Mail address object for debug.
444 * \param item Item to print.
445 * \param stream Output stream.
447 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
448 g_return_if_fail( item != NULL );
449 fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
450 fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
451 fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
452 fprintf( stream, "\t\taddr: '%s'\n", item->address );
453 fprintf( stream, "\t\trems: '%s'\n", item->remarks );
454 fprintf( stream, "\t\t---\n" );
458 * Print user attribute object for debug.
459 * \param item Attribute to print.
460 * \param stream Output stream.
462 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
463 g_return_if_fail( item != NULL );
464 fprintf( stream, "\t\tuid : '%s'\n", item->uid );
465 fprintf( stream, "\t\tname : '%s'\n", item->name );
466 fprintf( stream, "\t\tvalue: '%s'\n", item->value );
467 fprintf( stream, "\t\t---\n" );
471 * Print person item for debug.
472 * \param person Person to print.
473 * \param stream Output stream.
475 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
477 g_return_if_fail( person != NULL );
478 fprintf( stream, "Person:\n" );
479 fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
480 fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
481 fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
482 fprintf( stream, "\tphoto: '%s'\n", person->picture );
483 fprintf( stream, "\tfirst: '%s'\n", person->firstName );
484 fprintf( stream, "\tlast : '%s'\n", person->lastName );
485 fprintf( stream, "\tnick : '%s'\n", person->nickName );
486 fprintf( stream, "\textID: '%s'\n", person->externalID );
487 fprintf( stream, "\teMail:\n" );
488 fprintf( stream, "\t---\n" );
489 node = person->listEMail;
491 addritem_print_item_email( node->data, stream );
492 node = g_list_next( node );
494 fprintf( stream, "\tuAttr:\n" );
495 fprintf( stream, "\t---\n" );
496 node = person->listAttrib;
498 addritem_print_attribute( node->data, stream );
499 node = g_list_next( node );
501 gchar *current_status;
502 switch (person->status) {
503 case NONE: current_status = g_strdup("Unchanged"); break;
504 case ADD_ENTRY: current_status = g_strdup("New"); break;
505 case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
506 case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
507 default: current_status = g_strdup("Unknown");
509 fprintf( stream, "\t\tStatus: %s\n", current_status );
510 if ( current_status )
511 g_free(current_status);
512 fprintf( stream, "\t===\n" );
516 * Add E-Mail address object to person.
517 * \param person Person.
518 * \param email E-Mail object to add.
519 * \return <i>TRUE</i> if E-Mail added.
521 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
524 g_return_val_if_fail( person != NULL, FALSE );
525 g_return_val_if_fail( email != NULL, FALSE );
527 node = person->listEMail;
529 if( node->data == email ) return FALSE;
530 node = g_list_next( node );
532 person->listEMail = g_list_append( person->listEMail, email );
533 ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
538 * Remove email address for specified person.
539 * \param person Person.
540 * \param email EMail to remove.
541 * \return EMail object, or <i>NULL</i> if not found. Note that object should
542 * still be freed after calling this method.
544 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
545 gboolean found = FALSE;
548 g_return_val_if_fail( person != NULL, NULL );
549 if( email == NULL ) return NULL;
552 node = person->listEMail;
554 if( node-> data == email ) {
558 node = g_list_next( node );
562 /* Remove email from person's address list */
563 if( person->listEMail ) {
564 person->listEMail = g_list_remove( person->listEMail, email );
566 /* Unlink reference to person. */
567 ADDRITEM_PARENT(email) = NULL;
574 * Add user attribute to specified person.
575 * \param person Person.
576 * \param attrib Attribute to add.
577 * \return <i>TRUE</i> if item added.
579 void addritem_person_add_attribute(
580 ItemPerson *person, UserAttribute *attrib )
582 g_return_if_fail( person != NULL );
583 person->listAttrib = g_list_append( person->listAttrib, attrib );
587 * Remove user attribute from specified person.
588 * \param person Person.
589 * \param attrib Attribute to remove.
591 void addritem_person_remove_attribute( ItemPerson *person, const gchar *attrib ) {
592 g_return_if_fail( person != NULL || attrib != NULL );
595 attrib_list = person->listAttrib;
596 while (attrib_list) {
597 UserAttribute *user_attrib = attrib_list->data;
598 if (strcmp(user_attrib->name, attrib) == 0) {
599 person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
602 attrib_list = g_list_next(attrib_list);
607 * find out if a user attribute already exists in the specified person.
608 * \param person Person.
609 * \param attrib Attribute to remove.
610 * \return <i>TRUE</i> if attribute exists
612 gboolean addritem_person_has_attribute( ItemPerson *person, const gchar *attrib ) {
613 g_return_val_if_fail( person != NULL || attrib != NULL, FALSE );
614 GList *attrib_list = NULL;
616 attrib_list = person->listAttrib;
617 while (attrib_list) {
618 UserAttribute *user_attrib = attrib_list->data;
619 if (strcmp(user_attrib->name, attrib) == 0) {
622 attrib_list = g_list_next(attrib_list);
628 * Create new address book group object.
629 * \return Initialized group object.
631 ItemGroup *addritem_create_item_group( void ) {
634 group = g_new0( ItemGroup, 1 );
635 ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
636 ADDRITEM_ID(group) = NULL;
637 ADDRITEM_NAME(group) = NULL;
638 ADDRITEM_PARENT(group) = NULL;
639 ADDRITEM_SUBTYPE(group) = 0;
640 group->remarks = NULL;
641 group->listEMail = NULL;
646 * Copy (deep copy) address book group.
647 * \param item Group to copy.
648 * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
650 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
653 itemNew = g_new0( ItemGroup, 1 );
655 itemNew = addritem_create_item_group();
656 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
657 itemNew->remarks = g_strdup( item->remarks );
663 * Specify name to be used for group.
664 * \param group Group object.
665 * \param value Name of group.
667 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
668 ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
672 * Free address group object.
673 * \param group Group to free.
675 void addritem_free_item_group( ItemGroup *group ) {
676 g_return_if_fail( group != NULL );
678 /* Free internal stuff */
679 g_free( ADDRITEM_ID(group) );
680 g_free( ADDRITEM_NAME(group) );
681 g_free( group->remarks );
682 mgu_clear_list( group->listEMail );
683 g_list_free( group->listEMail );
685 ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
686 ADDRITEM_ID(group) = NULL;
687 ADDRITEM_NAME(group) = NULL;
688 ADDRITEM_PARENT(group) = NULL;
689 ADDRITEM_SUBTYPE(group) = 0;
690 group->remarks = NULL;
691 group->listEMail = NULL;
697 * Add EMail address to group. Note that a reference to an E-Mail item is
698 * added to a group. A person object is the only container that for an
700 * \param group Group.
701 * \param email E-Mail object.
702 * \return <i>TRUE</i> if email item added.
704 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
707 g_return_val_if_fail( group != NULL, FALSE );
708 g_return_val_if_fail( email != NULL, FALSE );
710 node = group->listEMail;
712 if( node->data == email ) return FALSE;
713 node = g_list_next( node );
715 group->listEMail = g_list_append( group->listEMail, email );
720 * Remove person object for specified group.
721 * \param group Group from which to remove address.
722 * \param email EMail to remove
723 * \return EMail object, or <i>NULL if email not found in group. Note that
724 * this object is referenced (linked) to a group and should *NOT*
725 * be freed. An E-Mail object object should only be freed after
726 * removing from a person.
728 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
729 if( group && person ) {
730 GList *node = group->listPerson;
732 if( node->data == person ) {
733 group->listPerson = g_list_remove( group->listPerson, person );
736 node = g_list_next( node );
743 * Print address group item for debug.
744 * \param group Group to print.
745 * \param stream Output stream.
747 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
751 g_return_if_fail( group != NULL );
752 fprintf( stream, "Group:\n" );
753 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
754 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
755 fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
756 fprintf( stream, "\trem: '%s'\n", group->remarks );
757 fprintf( stream, "\t---\n" );
758 node = group->listEMail;
761 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
763 fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
764 fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
767 fprintf( stream, "\t\tpid : ???\n" );
768 fprintf( stream, "\t\tcomn: ???\n" );
770 addritem_print_item_email( item, stream );
771 node = g_list_next( node );
773 fprintf( stream, "\t***\n" );
777 * Create new address folder.
778 * \return Initialized address folder object.
780 ItemFolder *addritem_create_item_folder( void ) {
782 folder = g_new0( ItemFolder, 1 );
783 ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
784 ADDRITEM_ID(folder) = NULL;
785 ADDRITEM_NAME(folder) = NULL;
786 ADDRITEM_PARENT(folder) = NULL;
787 ADDRITEM_SUBTYPE(folder) = 0;
788 folder->remarks = NULL;
789 folder->isRoot = FALSE;
790 folder->listItems = NULL;
791 folder->listFolder = NULL;
792 folder->listPerson = NULL;
793 folder->listGroup = NULL;
794 folder->folderType = ADDRFOLDER_NONE;
795 folder->folderData = NULL;
796 folder->isHidden = FALSE;
801 * Copy address book folder. Note that only the folder and not its contents are
803 * \param item Folder to copy.
804 * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
806 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
809 itemNew = g_new0( ItemFolder, 1 );
811 itemNew = addritem_create_item_folder();
812 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
813 itemNew->folderType = item->folderType;
819 * Specify name to be used for folder.
820 * \param folder Folder.
823 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
824 ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
828 * Specify remarks to be used for folder.
829 * \param folder Folder.
830 * \param value Remarks.
832 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
833 folder->remarks = mgu_replace_string( folder->remarks, value );
837 * Specify visibility of folder.
838 * \param folder Folder.
839 * \param value Set to <code>TRUE</code> to hide folder.
841 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
842 folder->isHidden = value;
846 * Free address folder. Note: this does not free up the lists of children
847 * (folders, groups and person). This should be done prior to calling this
849 * \param folder Folder to free.
851 void addritem_free_item_folder( ItemFolder *folder ) {
852 g_return_if_fail( folder != NULL );
854 /* Free internal stuff */
855 g_free( ADDRITEM_ID(folder) );
856 g_free( ADDRITEM_NAME(folder) );
857 g_free( folder->remarks );
858 mgu_clear_list( folder->listItems );
859 g_list_free( folder->listItems );
861 ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
862 ADDRITEM_ID(folder) = NULL;
863 ADDRITEM_NAME(folder) = NULL;
864 ADDRITEM_PARENT(folder) = NULL;
865 ADDRITEM_SUBTYPE(folder) = 0;
866 folder->isRoot = FALSE;
867 folder->remarks = NULL;
868 folder->listItems = NULL;
869 folder->listFolder = NULL;
870 folder->listGroup = NULL;
871 folder->listPerson = NULL;
872 folder->folderType = ADDRFOLDER_NONE;
873 folder->folderData = NULL;
874 folder->isHidden = FALSE;
880 * Free up folders recursively. Note: this only frees up the lists of
881 * children and *NOT* the children objects (folders, groups and person).
882 * This should be done prior to calling this function.
883 * \param parent Parent folder object to be processed.
885 static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
886 GList *node = parent->listFolder;
889 ItemFolder *folder = node->data;
890 addritem_free_item_folder_recurse( folder );
891 node = g_list_next( node );
893 g_list_free( parent->listPerson );
894 g_list_free( parent->listGroup );
895 g_list_free( parent->listFolder );
896 parent->listPerson = NULL;
897 parent->listGroup = NULL;
898 parent->listFolder = NULL;
902 * Add person into folder.
903 * \param folder Folder.
904 * \param item Person to add.
905 * \return <i>TRUE</i> if person added.
907 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
908 g_return_val_if_fail( folder != NULL, FALSE );
909 g_return_val_if_fail( item != NULL, FALSE );
911 folder->listPerson = g_list_append( folder->listPerson, item );
912 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
917 * Add folder into folder.
918 * \param folder Folder.
919 * \param item Folder to add.
920 * \return <i>TRUE</i> if folder added.
922 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
923 g_return_val_if_fail( folder != NULL, FALSE );
924 g_return_val_if_fail( item != NULL, FALSE );
926 folder->listFolder = g_list_append( folder->listFolder, item );
927 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
932 * Add group into folder.
933 * \param folder Folder.
934 * \param item Group to add.
935 * \return <i>TRUE</i> if group added.
937 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
938 g_return_val_if_fail( folder != NULL, FALSE );
939 g_return_val_if_fail( item != NULL, FALSE );
941 folder->listGroup = g_list_append( folder->listGroup, item );
942 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
947 * Print address folder item contents for debug.
948 * \param folder Folder to process.
949 * \param stream Output stream.
951 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
953 /* ItemPerson *person; */
956 g_return_if_fail( folder != NULL );
958 fprintf( stream, "Folder:\n" );
959 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
960 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
961 fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
962 fprintf( stream, "\trem: '%s'\n", folder->remarks );
963 fprintf( stream, "\ttyp: %d\n", folder->folderType );
964 fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
965 fprintf( stream, "\t---\n" );
966 parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
968 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
971 fprintf( stream, "\tpar: NULL\n" );
973 node = folder->listFolder;
975 AddrItemObject *aio = node->data;
977 if( aio->type == ITEMTYPE_FOLDER ) {
978 ItemFolder *item = ( ItemFolder * ) aio;
979 addritem_print_item_folder( item, stream );
983 fprintf( stream, "\t\tpid : ???\n" );
986 node = g_list_next( node );
989 node = folder->listPerson;
991 AddrItemObject *aio = node->data;
993 if( aio->type == ITEMTYPE_PERSON ) {
994 ItemPerson *item = ( ItemPerson * ) aio;
995 addritem_print_item_person( item, stream );
999 fprintf( stream, "\t\tpid : ???\n" );
1002 node = g_list_next( node );
1005 node = folder->listGroup;
1007 AddrItemObject *aio = node->data;
1009 if( aio->type == ITEMTYPE_GROUP ) {
1010 ItemGroup *item = ( ItemGroup * ) aio;
1011 addritem_print_item_group( item, stream );
1015 fprintf( stream, "\t\tpid : ???\n" );
1017 node = g_list_next( node );
1019 fprintf( stream, "\t###\n" );
1023 * Return link list of persons for specified folder. Note that the list contains
1024 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1025 * addritem_free_xxx() functions... this will destroy the addressbook data!
1027 * \param folder Folder to process.
1028 * \return List of items, or <i>NULL</i> if none.
1030 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
1034 g_return_val_if_fail( folder != NULL, NULL );
1036 node = folder->listPerson;
1038 ItemPerson *person = node->data;
1039 list = g_list_prepend( list, person );
1040 node = g_list_next( node );
1042 return g_list_reverse(list);
1046 * Return link list of groups for specified folder. Note that the list contains
1047 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1048 * addritem_free_xxx() functions... this will destroy the addressbook data!
1050 * \param folder Folder to process.
1051 * \return List of items, or <i>NULL</i> if none.
1053 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1057 g_return_val_if_fail( folder != NULL, NULL );
1059 node = folder->listGroup;
1061 ItemGroup *group = node->data;
1062 list = g_list_prepend( list, group );
1063 node = g_list_next( node );
1065 return g_list_reverse(list);
1069 * Parse first and last names for person from common name.
1070 * \param person Person to process.
1072 void addritem_parse_first_last( ItemPerson *person ) {
1074 gchar *fName, *lName;
1078 g_return_if_fail( person != NULL );
1080 name = ADDRITEM_NAME(person);
1081 if( name == NULL ) return;
1085 p = strchr( name, ',' );
1087 len = ( size_t ) ( p - name );
1088 lName = g_strndup( name, len );
1089 fName = g_strdup( p + 1 );
1092 /* Other way around */
1095 if( name[i] == ' ' ) {
1096 fName = g_strndup( name, i );
1097 lName = g_strdup( &name[i] );
1102 if( fName == NULL ) {
1103 fName = g_strdup( name );
1107 g_free( person->firstName );
1108 person->firstName = fName;
1109 if( person->firstName )
1110 g_strstrip( person->firstName );
1112 g_free( person->lastName );
1113 person->lastName = lName;
1114 if( person->lastName )
1115 g_strstrip( person->lastName );
1119 * Build a path of all ancestor folders for specified folder.
1120 * \param folder Folder.
1121 * \param seq Path sequence, FALSE top down, TRUE bottom up.
1122 * \return List of folders from the top down.
1124 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1126 AddrItemObject *item;
1129 item = ( AddrItemObject * ) folder;
1132 list = g_list_prepend( list, item );
1133 item = ADDRITEM_PARENT( item );
1138 list = g_list_append( list, item );
1139 item = ADDRITEM_PARENT( item );
1146 * Format E-Mail address.
1147 * \param email EMail item to format.
1148 * \return Formatted string. Should be freed after use.
1150 gchar *addritem_format_email( ItemEMail *email ) {
1157 if( ADDRITEM_NAME( email ) ) {
1158 if( strlen( ADDRITEM_NAME( email ) ) ) {
1159 name = ADDRITEM_NAME( email );
1163 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1164 name = ADDRITEM_NAME( person );
1168 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1169 address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1172 address = g_strdup_printf( "%s <%s>", name, email->address );
1176 address = g_strdup_printf( "%s", email->address );