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->firstName = NULL;
221 person->lastName = NULL;
222 person->nickName = NULL;
223 person->listEMail = NULL;
224 person->listAttrib = NULL;
225 person->externalID = NULL;
226 person->isOpened = FALSE;
227 person->status = NONE;
232 * Create a shallow copy of address book person object.
233 * \param item Person to copy.
234 * \return Copy of person, or <i>NULL</i> if null argument supplied.
236 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
241 itemNew = addritem_create_item_person();
242 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
243 itemNew->firstName = g_strdup( item->firstName );
244 itemNew->lastName = g_strdup( item->lastName );
245 itemNew->nickName = g_strdup( item->nickName );
246 itemNew->externalID = g_strdup( item->externalID );
247 itemNew->status = item->status;
253 * Specify first name for person object.
254 * \param person Person object.
257 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
258 if (!value || g_utf8_validate(value, -1, NULL))
259 person->firstName = mgu_replace_string( person->firstName, value );
261 gchar *out = conv_codeset_strdup(value,
262 conv_get_locale_charset_str_no_utf8(),
265 person->firstName = mgu_replace_string( person->firstName, out );
271 * Specify last name for person object.
272 * \param person Person object.
275 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
276 if (!value || g_utf8_validate(value, -1, NULL))
277 person->lastName = mgu_replace_string( person->lastName, value );
279 gchar *out = conv_codeset_strdup(value,
280 conv_get_locale_charset_str_no_utf8(),
283 person->lastName = mgu_replace_string( person->lastName, out );
289 * Specify nick name for person object.
290 * \param person Person object.
293 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
294 if (!value || g_utf8_validate(value, -1, NULL))
295 person->nickName = mgu_replace_string( person->nickName, value );
297 gchar *out = conv_codeset_strdup(value,
298 conv_get_locale_charset_str_no_utf8(),
301 person->nickName = mgu_replace_string( person->nickName, out );
307 * Specify common name for person object.
308 * \param person Person object.
311 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
312 if (!value || g_utf8_validate(value, -1, NULL))
313 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
315 gchar *out = conv_codeset_strdup(value,
316 conv_get_locale_charset_str_no_utf8(),
319 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
325 * Specify external ID for person object.
326 * \param person Person object.
329 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
330 person->externalID = mgu_replace_string( person->externalID, value );
334 * Specify value of open indicator for person object. This is typically used to
335 * simplify open/close folders in the address book GUI.
336 * \param person Person object.
337 * \param value Value for indicator. Set to <i>TRUE</i> if opened.
339 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
340 person->isOpened = value;
344 * Free linked list of item addresses; both addresses and the list are freed.
345 * It is assumed that addresses are *NOT* contained within some other
347 * \param list List of addresses to be freed.
349 void addritem_free_list_email( GList *list ) {
352 ItemEMail *email = node->data;
354 addritem_free_item_email( email );
356 node = g_list_next( node );
363 * Free linked list of attributes; both attributes and the list are freed.
364 * It is assumed that attributes are *NOT* contained within some other
366 * \param list List of attributes to be freed.
368 void addritem_free_list_attribute( GList *list ) {
371 addritem_free_attribute( node->data );
373 node = g_list_next( node );
379 * Free address person object.
380 * \param person Person object to free.
382 void addritem_free_item_person( ItemPerson *person ) {
383 g_return_if_fail( person != NULL );
385 /* Free internal stuff */
386 g_free( ADDRITEM_ID(person) );
387 g_free( ADDRITEM_NAME(person) );
388 g_free( person->firstName );
389 g_free( person->lastName );
390 g_free( person->nickName );
391 g_free( person->externalID );
392 g_list_free( person->listEMail );
393 addritem_free_list_attribute( person->listAttrib );
395 ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
396 ADDRITEM_ID(person) = NULL;
397 ADDRITEM_NAME(person) = NULL;
398 ADDRITEM_PARENT(person) = NULL;
399 ADDRITEM_SUBTYPE(person) = 0;
400 person->firstName = NULL;
401 person->lastName = NULL;
402 person->nickName = NULL;
403 person->externalID = NULL;
404 person->listEMail = NULL;
405 person->listAttrib = NULL;
411 * Print E-Mail address object for debug.
412 * \param item Item to print.
413 * \param stream Output stream.
415 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
416 g_return_if_fail( item != NULL );
417 fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
418 fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
419 fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
420 fprintf( stream, "\t\taddr: '%s'\n", item->address );
421 fprintf( stream, "\t\trems: '%s'\n", item->remarks );
422 fprintf( stream, "\t\t---\n" );
426 * Print user attribute object for debug.
427 * \param item Attribute to print.
428 * \param stream Output stream.
430 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
431 g_return_if_fail( item != NULL );
432 fprintf( stream, "\t\tuid : '%s'\n", item->uid );
433 fprintf( stream, "\t\tname : '%s'\n", item->name );
434 fprintf( stream, "\t\tvalue: '%s'\n", item->value );
435 fprintf( stream, "\t\t---\n" );
439 * Print person item for debug.
440 * \param person Person to print.
441 * \param stream Output stream.
443 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
445 g_return_if_fail( person != NULL );
446 fprintf( stream, "Person:\n" );
447 fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
448 fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
449 fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
450 fprintf( stream, "\tfirst: '%s'\n", person->firstName );
451 fprintf( stream, "\tlast : '%s'\n", person->lastName );
452 fprintf( stream, "\tnick : '%s'\n", person->nickName );
453 fprintf( stream, "\textID: '%s'\n", person->externalID );
454 fprintf( stream, "\teMail:\n" );
455 fprintf( stream, "\t---\n" );
456 node = person->listEMail;
458 addritem_print_item_email( node->data, stream );
459 node = g_list_next( node );
461 fprintf( stream, "\tuAttr:\n" );
462 fprintf( stream, "\t---\n" );
463 node = person->listAttrib;
465 addritem_print_attribute( node->data, stream );
466 node = g_list_next( node );
468 gchar *current_status;
469 switch (person->status) {
470 case NONE: current_status = g_strdup("Unchanged"); break;
471 case ADD_ENTRY: current_status = g_strdup("New"); break;
472 case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
473 case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
474 default: current_status = g_strdup("Unknown");
476 fprintf( stream, "\t\tStatus: %s\n", current_status );
477 if ( current_status )
478 g_free(current_status);
479 fprintf( stream, "\t===\n" );
483 * Add E-Mail address object to person.
484 * \param person Person.
485 * \param email E-Mail object to add.
486 * \return <i>TRUE</i> if E-Mail added.
488 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
491 g_return_val_if_fail( person != NULL, FALSE );
492 g_return_val_if_fail( email != NULL, FALSE );
494 node = person->listEMail;
496 if( node->data == email ) return FALSE;
497 node = g_list_next( node );
499 person->listEMail = g_list_append( person->listEMail, email );
500 ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
505 * Remove email address for specified person.
506 * \param person Person.
507 * \param email EMail to remove.
508 * \return EMail object, or <i>NULL</i> if not found. Note that object should
509 * still be freed after calling this method.
511 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
512 gboolean found = FALSE;
515 g_return_val_if_fail( person != NULL, NULL );
516 if( email == NULL ) return NULL;
519 node = person->listEMail;
521 if( node-> data == email ) {
525 node = g_list_next( node );
529 /* Remove email from person's address list */
530 if( person->listEMail ) {
531 person->listEMail = g_list_remove( person->listEMail, email );
533 /* Unlink reference to person. */
534 ADDRITEM_PARENT(email) = NULL;
541 * Add user attribute to specified person.
542 * \param person Person.
543 * \param attrib Attribute to add.
544 * \return <i>TRUE</i> if item added.
546 void addritem_person_add_attribute(
547 ItemPerson *person, UserAttribute *attrib )
549 g_return_if_fail( person != NULL );
550 person->listAttrib = g_list_append( person->listAttrib, attrib );
554 * Remove user attribute from specified person.
555 * \param person Person.
556 * \param attrib Attribute to remove.
558 void addritem_person_remove_attribute( ItemPerson *person, const gchar *attrib ) {
559 g_return_if_fail( person != NULL || attrib != NULL );
562 attrib_list = person->listAttrib;
563 while (attrib_list) {
564 UserAttribute *user_attrib = attrib_list->data;
565 if (strcmp(user_attrib->name, attrib) == 0) {
566 person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
569 attrib_list = g_list_next(attrib_list);
574 * find out if a user attribute already exists in the specified person.
575 * \param person Person.
576 * \param attrib Attribute to remove.
577 * \return <i>TRUE</i> if attribute exists
579 gboolean addritem_person_has_attribute( ItemPerson *person, const gchar *attrib ) {
580 g_return_val_if_fail( person != NULL || attrib != NULL, FALSE );
581 GList *attrib_list = NULL;
583 attrib_list = person->listAttrib;
584 while (attrib_list) {
585 UserAttribute *user_attrib = attrib_list->data;
586 if (strcmp(user_attrib->name, attrib) == 0) {
589 attrib_list = g_list_next(attrib_list);
595 * Create new address book group object.
596 * \return Initialized group object.
598 ItemGroup *addritem_create_item_group( void ) {
601 group = g_new0( ItemGroup, 1 );
602 ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
603 ADDRITEM_ID(group) = NULL;
604 ADDRITEM_NAME(group) = NULL;
605 ADDRITEM_PARENT(group) = NULL;
606 ADDRITEM_SUBTYPE(group) = 0;
607 group->remarks = NULL;
608 group->listEMail = NULL;
613 * Copy (deep copy) address book group.
614 * \param item Group to copy.
615 * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
617 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
620 itemNew = g_new0( ItemGroup, 1 );
622 itemNew = addritem_create_item_group();
623 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
624 itemNew->remarks = g_strdup( item->remarks );
630 * Specify name to be used for group.
631 * \param group Group object.
632 * \param value Name of group.
634 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
635 ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
639 * Free address group object.
640 * \param group Group to free.
642 void addritem_free_item_group( ItemGroup *group ) {
643 g_return_if_fail( group != NULL );
645 /* Free internal stuff */
646 g_free( ADDRITEM_ID(group) );
647 g_free( ADDRITEM_NAME(group) );
648 g_free( group->remarks );
649 mgu_clear_list( group->listEMail );
650 g_list_free( group->listEMail );
652 ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
653 ADDRITEM_ID(group) = NULL;
654 ADDRITEM_NAME(group) = NULL;
655 ADDRITEM_PARENT(group) = NULL;
656 ADDRITEM_SUBTYPE(group) = 0;
657 group->remarks = NULL;
658 group->listEMail = NULL;
664 * Add EMail address to group. Note that a reference to an E-Mail item is
665 * added to a group. A person object is the only container that for an
667 * \param group Group.
668 * \param email E-Mail object.
669 * \return <i>TRUE</i> if email item added.
671 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
674 g_return_val_if_fail( group != NULL, FALSE );
675 g_return_val_if_fail( email != NULL, FALSE );
677 node = group->listEMail;
679 if( node->data == email ) return FALSE;
680 node = g_list_next( node );
682 group->listEMail = g_list_append( group->listEMail, email );
687 * Remove person object for specified group.
688 * \param group Group from which to remove address.
689 * \param email EMail to remove
690 * \return EMail object, or <i>NULL if email not found in group. Note that
691 * this object is referenced (linked) to a group and should *NOT*
692 * be freed. An E-Mail object object should only be freed after
693 * removing from a person.
695 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
696 if( group && person ) {
697 GList *node = group->listPerson;
699 if( node->data == person ) {
700 group->listPerson = g_list_remove( group->listPerson, person );
703 node = g_list_next( node );
710 * Print address group item for debug.
711 * \param group Group to print.
712 * \param stream Output stream.
714 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
718 g_return_if_fail( group != NULL );
719 fprintf( stream, "Group:\n" );
720 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
721 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
722 fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
723 fprintf( stream, "\trem: '%s'\n", group->remarks );
724 fprintf( stream, "\t---\n" );
725 node = group->listEMail;
728 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
730 fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
731 fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
734 fprintf( stream, "\t\tpid : ???\n" );
735 fprintf( stream, "\t\tcomn: ???\n" );
737 addritem_print_item_email( item, stream );
738 node = g_list_next( node );
740 fprintf( stream, "\t***\n" );
744 * Create new address folder.
745 * \return Initialized address folder object.
747 ItemFolder *addritem_create_item_folder( void ) {
749 folder = g_new0( ItemFolder, 1 );
750 ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
751 ADDRITEM_ID(folder) = NULL;
752 ADDRITEM_NAME(folder) = NULL;
753 ADDRITEM_PARENT(folder) = NULL;
754 ADDRITEM_SUBTYPE(folder) = 0;
755 folder->remarks = NULL;
756 folder->isRoot = FALSE;
757 folder->listItems = NULL;
758 folder->listFolder = NULL;
759 folder->listPerson = NULL;
760 folder->listGroup = NULL;
761 folder->folderType = ADDRFOLDER_NONE;
762 folder->folderData = NULL;
763 folder->isHidden = FALSE;
768 * Copy address book folder. Note that only the folder and not its contents are
770 * \param item Folder to copy.
771 * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
773 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
776 itemNew = g_new0( ItemFolder, 1 );
778 itemNew = addritem_create_item_folder();
779 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
780 itemNew->folderType = item->folderType;
786 * Specify name to be used for folder.
787 * \param folder Folder.
790 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
791 ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
795 * Specify remarks to be used for folder.
796 * \param folder Folder.
797 * \param value Remarks.
799 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
800 folder->remarks = mgu_replace_string( folder->remarks, value );
804 * Specify visibility of folder.
805 * \param folder Folder.
806 * \param value Set to <code>TRUE</code> to hide folder.
808 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
809 folder->isHidden = value;
813 * Free address folder. Note: this does not free up the lists of children
814 * (folders, groups and person). This should be done prior to calling this
816 * \param folder Folder to free.
818 void addritem_free_item_folder( ItemFolder *folder ) {
819 g_return_if_fail( folder != NULL );
821 /* Free internal stuff */
822 g_free( ADDRITEM_ID(folder) );
823 g_free( ADDRITEM_NAME(folder) );
824 g_free( folder->remarks );
825 mgu_clear_list( folder->listItems );
826 g_list_free( folder->listItems );
828 ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
829 ADDRITEM_ID(folder) = NULL;
830 ADDRITEM_NAME(folder) = NULL;
831 ADDRITEM_PARENT(folder) = NULL;
832 ADDRITEM_SUBTYPE(folder) = 0;
833 folder->isRoot = FALSE;
834 folder->remarks = NULL;
835 folder->listItems = NULL;
836 folder->listFolder = NULL;
837 folder->listGroup = NULL;
838 folder->listPerson = NULL;
839 folder->folderType = ADDRFOLDER_NONE;
840 folder->folderData = NULL;
841 folder->isHidden = FALSE;
847 * Free up folders recursively. Note: this only frees up the lists of
848 * children and *NOT* the children objects (folders, groups and person).
849 * This should be done prior to calling this function.
850 * \param parent Parent folder object to be processed.
852 static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
853 GList *node = parent->listFolder;
856 ItemFolder *folder = node->data;
857 addritem_free_item_folder_recurse( folder );
858 node = g_list_next( node );
860 g_list_free( parent->listPerson );
861 g_list_free( parent->listGroup );
862 g_list_free( parent->listFolder );
863 parent->listPerson = NULL;
864 parent->listGroup = NULL;
865 parent->listFolder = NULL;
869 * Add person into folder.
870 * \param folder Folder.
871 * \param item Person to add.
872 * \return <i>TRUE</i> if person added.
874 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
875 g_return_val_if_fail( folder != NULL, FALSE );
876 g_return_val_if_fail( item != NULL, FALSE );
878 folder->listPerson = g_list_append( folder->listPerson, item );
879 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
884 * Add folder into folder.
885 * \param folder Folder.
886 * \param item Folder to add.
887 * \return <i>TRUE</i> if folder added.
889 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
890 g_return_val_if_fail( folder != NULL, FALSE );
891 g_return_val_if_fail( item != NULL, FALSE );
893 folder->listFolder = g_list_append( folder->listFolder, item );
894 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
899 * Add group into folder.
900 * \param folder Folder.
901 * \param item Group to add.
902 * \return <i>TRUE</i> if group added.
904 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
905 g_return_val_if_fail( folder != NULL, FALSE );
906 g_return_val_if_fail( item != NULL, FALSE );
908 folder->listGroup = g_list_append( folder->listGroup, item );
909 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
914 * Print address folder item contents for debug.
915 * \param folder Folder to process.
916 * \param stream Output stream.
918 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
920 /* ItemPerson *person; */
923 g_return_if_fail( folder != NULL );
925 fprintf( stream, "Folder:\n" );
926 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
927 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
928 fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
929 fprintf( stream, "\trem: '%s'\n", folder->remarks );
930 fprintf( stream, "\ttyp: %d\n", folder->folderType );
931 fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
932 fprintf( stream, "\t---\n" );
933 parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
935 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
938 fprintf( stream, "\tpar: NULL\n" );
940 node = folder->listFolder;
942 AddrItemObject *aio = node->data;
944 if( aio->type == ITEMTYPE_FOLDER ) {
945 ItemFolder *item = ( ItemFolder * ) aio;
946 addritem_print_item_folder( item, stream );
950 fprintf( stream, "\t\tpid : ???\n" );
953 node = g_list_next( node );
956 node = folder->listPerson;
958 AddrItemObject *aio = node->data;
960 if( aio->type == ITEMTYPE_PERSON ) {
961 ItemPerson *item = ( ItemPerson * ) aio;
962 addritem_print_item_person( item, stream );
966 fprintf( stream, "\t\tpid : ???\n" );
969 node = g_list_next( node );
972 node = folder->listGroup;
974 AddrItemObject *aio = node->data;
976 if( aio->type == ITEMTYPE_GROUP ) {
977 ItemGroup *item = ( ItemGroup * ) aio;
978 addritem_print_item_group( item, stream );
982 fprintf( stream, "\t\tpid : ???\n" );
984 node = g_list_next( node );
986 fprintf( stream, "\t###\n" );
990 * Return link list of persons for specified folder. Note that the list contains
991 * references to items and should be g_free() when done. Do *NOT* attempt to use the
992 * addritem_free_xxx() functions... this will destroy the addressbook data!
994 * \param folder Folder to process.
995 * \return List of items, or <i>NULL</i> if none.
997 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
1001 g_return_val_if_fail( folder != NULL, NULL );
1003 node = folder->listPerson;
1005 ItemPerson *person = node->data;
1006 list = g_list_append( list, person );
1007 node = g_list_next( node );
1013 * Return link list of groups for specified folder. Note that the list contains
1014 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1015 * addritem_free_xxx() functions... this will destroy the addressbook data!
1017 * \param folder Folder to process.
1018 * \return List of items, or <i>NULL</i> if none.
1020 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1024 g_return_val_if_fail( folder != NULL, NULL );
1026 node = folder->listGroup;
1028 ItemGroup *group = node->data;
1029 list = g_list_append( list, group );
1030 node = g_list_next( node );
1036 * Parse first and last names for person from common name.
1037 * \param person Person to process.
1039 void addritem_parse_first_last( ItemPerson *person ) {
1041 gchar *fName, *lName;
1045 g_return_if_fail( person != NULL );
1047 name = ADDRITEM_NAME(person);
1048 if( name == NULL ) return;
1052 p = strchr( name, ',' );
1054 len = ( size_t ) ( p - name );
1055 lName = g_strndup( name, len );
1056 fName = g_strdup( p + 1 );
1059 /* Other way around */
1062 if( name[i] == ' ' ) {
1063 fName = g_strndup( name, i );
1064 lName = g_strdup( &name[i] );
1069 if( fName == NULL ) {
1070 fName = g_strdup( name );
1074 g_free( person->firstName );
1075 person->firstName = fName;
1076 if( person->firstName )
1077 g_strstrip( person->firstName );
1079 g_free( person->lastName );
1080 person->lastName = lName;
1081 if( person->lastName )
1082 g_strstrip( person->lastName );
1086 * Build a path of all ancestor folders for specified folder.
1087 * \param folder Folder.
1088 * \param seq Path sequence, FALSE top down, TRUE bottom up.
1089 * \return List of folders from the top down.
1091 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1093 AddrItemObject *item;
1096 item = ( AddrItemObject * ) folder;
1099 list = g_list_prepend( list, item );
1100 item = ADDRITEM_PARENT( item );
1105 list = g_list_append( list, item );
1106 item = ADDRITEM_PARENT( item );
1113 * Format E-Mail address.
1114 * \param email EMail item to format.
1115 * \return Formatted string. Should be freed after use.
1117 gchar *addritem_format_email( ItemEMail *email ) {
1124 if( ADDRITEM_NAME( email ) ) {
1125 if( strlen( ADDRITEM_NAME( email ) ) ) {
1126 name = ADDRITEM_NAME( email );
1130 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1131 name = ADDRITEM_NAME( person );
1135 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1136 address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1139 address = g_strdup_printf( "%s <%s>", name, email->address );
1143 address = g_strdup_printf( "%s", email->address );