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 2 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, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
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;
231 * Create a shallow copy of address book person object.
232 * \param item Person to copy.
233 * \return Copy of person, or <i>NULL</i> if null argument supplied.
235 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
240 itemNew = addritem_create_item_person();
241 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
242 itemNew->firstName = g_strdup( item->firstName );
243 itemNew->lastName = g_strdup( item->lastName );
244 itemNew->nickName = g_strdup( item->nickName );
245 itemNew->externalID = g_strdup( item->externalID );
251 * Specify first name for person object.
252 * \param person Person object.
255 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
256 if (!value || g_utf8_validate(value, -1, NULL))
257 person->firstName = mgu_replace_string( person->firstName, value );
259 gchar *out = conv_codeset_strdup(value,
260 conv_get_locale_charset_str_no_utf8(),
263 person->firstName = mgu_replace_string( person->firstName, out );
269 * Specify last name for person object.
270 * \param person Person object.
273 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
274 if (!value || g_utf8_validate(value, -1, NULL))
275 person->lastName = mgu_replace_string( person->lastName, value );
277 gchar *out = conv_codeset_strdup(value,
278 conv_get_locale_charset_str_no_utf8(),
281 person->lastName = mgu_replace_string( person->lastName, out );
287 * Specify nick name for person object.
288 * \param person Person object.
291 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
292 if (!value || g_utf8_validate(value, -1, NULL))
293 person->nickName = mgu_replace_string( person->nickName, value );
295 gchar *out = conv_codeset_strdup(value,
296 conv_get_locale_charset_str_no_utf8(),
299 person->nickName = mgu_replace_string( person->nickName, out );
305 * Specify common name for person object.
306 * \param person Person object.
309 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
310 if (!value || g_utf8_validate(value, -1, NULL))
311 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
313 gchar *out = conv_codeset_strdup(value,
314 conv_get_locale_charset_str_no_utf8(),
317 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
323 * Specify external ID for person object.
324 * \param person Person object.
327 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
328 person->externalID = mgu_replace_string( person->externalID, value );
332 * Specify value of open indicator for person object. This is typically used to
333 * simplify open/close folders in the address book GUI.
334 * \param person Person object.
335 * \param value Value for indicator. Set to <i>TRUE</i> if opened.
337 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
338 person->isOpened = value;
342 * Free linked list of item addresses; both addresses and the list are freed.
343 * It is assumed that addresses are *NOT* contained within some other
345 * \param list List of addresses to be freed.
347 void addritem_free_list_email( GList *list ) {
350 ItemEMail *email = node->data;
352 addritem_free_item_email( email );
354 node = g_list_next( node );
361 * Free linked list of attributes; both attributes and the list are freed.
362 * It is assumed that attributes are *NOT* contained within some other
364 * \param list List of attributes to be freed.
366 void addritem_free_list_attribute( GList *list ) {
369 addritem_free_attribute( node->data );
371 node = g_list_next( node );
377 * Free address person object.
378 * \param person Person object to free.
380 void addritem_free_item_person( ItemPerson *person ) {
381 g_return_if_fail( person != NULL );
383 /* Free internal stuff */
384 g_free( ADDRITEM_ID(person) );
385 g_free( ADDRITEM_NAME(person) );
386 g_free( person->firstName );
387 g_free( person->lastName );
388 g_free( person->nickName );
389 g_free( person->externalID );
390 g_list_free( person->listEMail );
391 addritem_free_list_attribute( person->listAttrib );
393 ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
394 ADDRITEM_ID(person) = NULL;
395 ADDRITEM_NAME(person) = NULL;
396 ADDRITEM_PARENT(person) = NULL;
397 ADDRITEM_SUBTYPE(person) = 0;
398 person->firstName = NULL;
399 person->lastName = NULL;
400 person->nickName = NULL;
401 person->externalID = NULL;
402 person->listEMail = NULL;
403 person->listAttrib = NULL;
409 * Print E-Mail address object for debug.
410 * \param item Item to print.
411 * \param stream Output stream.
413 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
414 g_return_if_fail( item != NULL );
415 fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
416 fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
417 fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
418 fprintf( stream, "\t\taddr: '%s'\n", item->address );
419 fprintf( stream, "\t\trems: '%s'\n", item->remarks );
420 fprintf( stream, "\t\t---\n" );
424 * Print user attribute object for debug.
425 * \param item Attribute to print.
426 * \param stream Output stream.
428 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
429 g_return_if_fail( item != NULL );
430 fprintf( stream, "\t\tuid : '%s'\n", item->uid );
431 fprintf( stream, "\t\tname : '%s'\n", item->name );
432 fprintf( stream, "\t\tvalue: '%s'\n", item->value );
433 fprintf( stream, "\t\t---\n" );
437 * Print person item for debug.
438 * \param person Person to print.
439 * \param stream Output stream.
441 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
443 g_return_if_fail( person != NULL );
444 fprintf( stream, "Person:\n" );
445 fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
446 fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
447 fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
448 fprintf( stream, "\tfirst: '%s'\n", person->firstName );
449 fprintf( stream, "\tlast : '%s'\n", person->lastName );
450 fprintf( stream, "\tnick : '%s'\n", person->nickName );
451 fprintf( stream, "\textID: '%s'\n", person->externalID );
452 fprintf( stream, "\teMail:\n" );
453 fprintf( stream, "\t---\n" );
454 node = person->listEMail;
456 addritem_print_item_email( node->data, stream );
457 node = g_list_next( node );
459 fprintf( stream, "\tuAttr:\n" );
460 fprintf( stream, "\t---\n" );
461 node = person->listAttrib;
463 addritem_print_attribute( node->data, stream );
464 node = g_list_next( node );
466 fprintf( stream, "\t===\n" );
470 * Add E-Mail address object to person.
471 * \param person Person.
472 * \param email E-Mail object to add.
473 * \return <i>TRUE</i> if E-Mail added.
475 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
478 g_return_val_if_fail( person != NULL, FALSE );
479 g_return_val_if_fail( email != NULL, FALSE );
481 node = person->listEMail;
483 if( node->data == email ) return FALSE;
484 node = g_list_next( node );
486 person->listEMail = g_list_append( person->listEMail, email );
487 ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
492 * Remove email address for specified person.
493 * \param person Person.
494 * \param email EMail to remove.
495 * \return EMail object, or <i>NULL</i> if not found. Note that object should
496 * still be freed after calling this method.
498 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
499 gboolean found = FALSE;
502 g_return_val_if_fail( person != NULL, NULL );
503 if( email == NULL ) return NULL;
506 node = person->listEMail;
508 if( node-> data == email ) {
512 node = g_list_next( node );
516 /* Remove email from person's address list */
517 if( person->listEMail ) {
518 person->listEMail = g_list_remove( person->listEMail, email );
520 /* Unlink reference to person. */
521 ADDRITEM_PARENT(email) = NULL;
528 * Add user attribute to specified person.
529 * \param person Person.
530 * \param attrib Attribute to add.
531 * \return <i>TRUE</i> if item added.
533 void addritem_person_add_attribute(
534 ItemPerson *person, UserAttribute *attrib )
536 g_return_if_fail( person != NULL );
537 person->listAttrib = g_list_append( person->listAttrib, attrib );
541 * Create new address book group object.
542 * \return Initialized group object.
544 ItemGroup *addritem_create_item_group( void ) {
547 group = g_new0( ItemGroup, 1 );
548 ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
549 ADDRITEM_ID(group) = NULL;
550 ADDRITEM_NAME(group) = NULL;
551 ADDRITEM_PARENT(group) = NULL;
552 ADDRITEM_SUBTYPE(group) = 0;
553 group->remarks = NULL;
554 group->listEMail = NULL;
559 * Copy (deep copy) address book group.
560 * \param item Group to copy.
561 * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
563 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
566 itemNew = g_new0( ItemGroup, 1 );
568 itemNew = addritem_create_item_group();
569 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
570 itemNew->remarks = g_strdup( item->remarks );
576 * Specify name to be used for group.
577 * \param group Group object.
578 * \param value Name of group.
580 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
581 ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
585 * Free address group object.
586 * \param group Group to free.
588 void addritem_free_item_group( ItemGroup *group ) {
589 g_return_if_fail( group != NULL );
591 /* Free internal stuff */
592 g_free( ADDRITEM_ID(group) );
593 g_free( ADDRITEM_NAME(group) );
594 g_free( group->remarks );
595 mgu_clear_list( group->listEMail );
596 g_list_free( group->listEMail );
598 ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
599 ADDRITEM_ID(group) = NULL;
600 ADDRITEM_NAME(group) = NULL;
601 ADDRITEM_PARENT(group) = NULL;
602 ADDRITEM_SUBTYPE(group) = 0;
603 group->remarks = NULL;
604 group->listEMail = NULL;
610 * Add EMail address to group. Note that a reference to an E-Mail item is
611 * added to a group. A person object is the only container that for an
613 * \param group Group.
614 * \param email E-Mail object.
615 * \return <i>TRUE</i> if email item added.
617 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
620 g_return_val_if_fail( group != NULL, FALSE );
621 g_return_val_if_fail( email != NULL, FALSE );
623 node = group->listEMail;
625 if( node->data == email ) return FALSE;
626 node = g_list_next( node );
628 group->listEMail = g_list_append( group->listEMail, email );
633 * Remove person object for specified group.
634 * \param group Group from which to remove address.
635 * \param email EMail to remove
636 * \return EMail object, or <i>NULL if email not found in group. Note that
637 * this object is referenced (linked) to a group and should *NOT*
638 * be freed. An E-Mail object object should only be freed after
639 * removing from a person.
641 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
642 if( group && person ) {
643 GList *node = group->listPerson;
645 if( node->data == person ) {
646 group->listPerson = g_list_remove( group->listPerson, person );
649 node = g_list_next( node );
656 * Print address group item for debug.
657 * \param group Group to print.
658 * \param stream Output stream.
660 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
664 g_return_if_fail( group != NULL );
665 fprintf( stream, "Group:\n" );
666 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
667 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
668 fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
669 fprintf( stream, "\trem: '%s'\n", group->remarks );
670 fprintf( stream, "\t---\n" );
671 node = group->listEMail;
674 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
676 fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
677 fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
680 fprintf( stream, "\t\tpid : ???\n" );
681 fprintf( stream, "\t\tcomn: ???\n" );
683 addritem_print_item_email( item, stream );
684 node = g_list_next( node );
686 fprintf( stream, "\t***\n" );
690 * Create new address folder.
691 * \return Initialized address folder object.
693 ItemFolder *addritem_create_item_folder( void ) {
695 folder = g_new0( ItemFolder, 1 );
696 ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
697 ADDRITEM_ID(folder) = NULL;
698 ADDRITEM_NAME(folder) = NULL;
699 ADDRITEM_PARENT(folder) = NULL;
700 ADDRITEM_SUBTYPE(folder) = 0;
701 folder->remarks = NULL;
702 folder->isRoot = FALSE;
703 folder->listItems = NULL;
704 folder->listFolder = NULL;
705 folder->listPerson = NULL;
706 folder->listGroup = NULL;
707 folder->folderType = ADDRFOLDER_NONE;
708 folder->folderData = NULL;
709 folder->isHidden = FALSE;
714 * Copy address book folder. Note that only the folder and not its contents are
716 * \param item Folder to copy.
717 * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
719 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
722 itemNew = g_new0( ItemFolder, 1 );
724 itemNew = addritem_create_item_folder();
725 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
726 itemNew->folderType = item->folderType;
732 * Specify name to be used for folder.
733 * \param folder Folder.
736 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
737 ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
741 * Specify remarks to be used for folder.
742 * \param folder Folder.
743 * \param value Remarks.
745 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
746 folder->remarks = mgu_replace_string( folder->remarks, value );
750 * Specify visibility of folder.
751 * \param folder Folder.
752 * \param value Set to <code>TRUE</code> to hide folder.
754 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
755 folder->isHidden = value;
759 * Free address folder. Note: this does not free up the lists of children
760 * (folders, groups and person). This should be done prior to calling this
762 * \param folder Folder to free.
764 void addritem_free_item_folder( ItemFolder *folder ) {
765 g_return_if_fail( folder != NULL );
767 /* Free internal stuff */
768 g_free( ADDRITEM_ID(folder) );
769 g_free( ADDRITEM_NAME(folder) );
770 g_free( folder->remarks );
771 mgu_clear_list( folder->listItems );
772 g_list_free( folder->listItems );
774 ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
775 ADDRITEM_ID(folder) = NULL;
776 ADDRITEM_NAME(folder) = NULL;
777 ADDRITEM_PARENT(folder) = NULL;
778 ADDRITEM_SUBTYPE(folder) = 0;
779 folder->isRoot = FALSE;
780 folder->remarks = NULL;
781 folder->listItems = NULL;
782 folder->listFolder = NULL;
783 folder->listGroup = NULL;
784 folder->listPerson = NULL;
785 folder->folderType = ADDRFOLDER_NONE;
786 folder->folderData = NULL;
787 folder->isHidden = FALSE;
793 * Free up folders recursively. Note: this only frees up the lists of
794 * children and *NOT* the children objects (folders, groups and person).
795 * This should be done prior to calling this function.
796 * \param parent Parent folder object to be processed.
798 static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
799 GList *node = parent->listFolder;
802 ItemFolder *folder = node->data;
803 addritem_free_item_folder_recurse( folder );
804 node = g_list_next( node );
806 g_list_free( parent->listPerson );
807 g_list_free( parent->listGroup );
808 g_list_free( parent->listFolder );
809 parent->listPerson = NULL;
810 parent->listGroup = NULL;
811 parent->listFolder = NULL;
815 * Add person into folder.
816 * \param folder Folder.
817 * \param item Person to add.
818 * \return <i>TRUE</i> if person added.
820 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
821 g_return_val_if_fail( folder != NULL, FALSE );
822 g_return_val_if_fail( item != NULL, FALSE );
824 folder->listPerson = g_list_append( folder->listPerson, item );
825 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
830 * Add folder into folder.
831 * \param folder Folder.
832 * \param item Folder to add.
833 * \return <i>TRUE</i> if folder added.
835 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
836 g_return_val_if_fail( folder != NULL, FALSE );
837 g_return_val_if_fail( item != NULL, FALSE );
839 folder->listFolder = g_list_append( folder->listFolder, item );
840 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
845 * Add group into folder.
846 * \param folder Folder.
847 * \param item Group to add.
848 * \return <i>TRUE</i> if group added.
850 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
851 g_return_val_if_fail( folder != NULL, FALSE );
852 g_return_val_if_fail( item != NULL, FALSE );
854 folder->listGroup = g_list_append( folder->listGroup, item );
855 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
860 * Print address folder item contents for debug.
861 * \param folder Folder to process.
862 * \param stream Output stream.
864 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
866 /* ItemPerson *person; */
869 g_return_if_fail( folder != NULL );
871 fprintf( stream, "Folder:\n" );
872 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
873 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
874 fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
875 fprintf( stream, "\trem: '%s'\n", folder->remarks );
876 fprintf( stream, "\ttyp: %d\n", folder->folderType );
877 fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
878 fprintf( stream, "\t---\n" );
879 parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
881 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
884 fprintf( stream, "\tpar: NULL\n" );
886 node = folder->listFolder;
888 AddrItemObject *aio = node->data;
890 if( aio->type == ITEMTYPE_FOLDER ) {
891 ItemFolder *item = ( ItemFolder * ) aio;
892 addritem_print_item_folder( item, stream );
896 fprintf( stream, "\t\tpid : ???\n" );
899 node = g_list_next( node );
902 node = folder->listPerson;
904 AddrItemObject *aio = node->data;
906 if( aio->type == ITEMTYPE_PERSON ) {
907 ItemPerson *item = ( ItemPerson * ) aio;
908 addritem_print_item_person( item, stream );
912 fprintf( stream, "\t\tpid : ???\n" );
915 node = g_list_next( node );
918 node = folder->listGroup;
920 AddrItemObject *aio = node->data;
922 if( aio->type == ITEMTYPE_GROUP ) {
923 ItemGroup *item = ( ItemGroup * ) aio;
924 addritem_print_item_group( item, stream );
928 fprintf( stream, "\t\tpid : ???\n" );
930 node = g_list_next( node );
932 fprintf( stream, "\t###\n" );
936 * Return link list of persons for specified folder. Note that the list contains
937 * references to items and should be g_free() when done. Do *NOT* attempt to use the
938 * addritem_free_xxx() functions... this will destroy the addressbook data!
940 * \param folder Folder to process.
941 * \return List of items, or <i>NULL</i> if none.
943 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
947 g_return_val_if_fail( folder != NULL, NULL );
949 node = folder->listPerson;
951 ItemPerson *person = node->data;
952 list = g_list_append( list, person );
953 node = g_list_next( node );
959 * Return link list of groups for specified folder. Note that the list contains
960 * references to items and should be g_free() when done. Do *NOT* attempt to use the
961 * addritem_free_xxx() functions... this will destroy the addressbook data!
963 * \param folder Folder to process.
964 * \return List of items, or <i>NULL</i> if none.
966 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
970 g_return_val_if_fail( folder != NULL, NULL );
972 node = folder->listGroup;
974 ItemGroup *group = node->data;
975 list = g_list_append( list, group );
976 node = g_list_next( node );
982 * Parse first and last names for person from common name.
983 * \param person Person to process.
985 void addritem_parse_first_last( ItemPerson *person ) {
987 gchar *fName, *lName;
991 g_return_if_fail( person != NULL );
993 name = ADDRITEM_NAME(person);
994 if( name == NULL ) return;
998 p = strchr( name, ',' );
1000 len = ( size_t ) ( p - name );
1001 lName = g_strndup( name, len );
1002 fName = g_strdup( p + 1 );
1005 /* Other way around */
1008 if( name[i] == ' ' ) {
1009 fName = g_strndup( name, i );
1010 lName = g_strdup( &name[i] );
1015 if( fName == NULL ) {
1016 fName = g_strdup( name );
1020 g_free( person->firstName );
1021 person->firstName = fName;
1022 if( person->firstName )
1023 g_strstrip( person->firstName );
1025 g_free( person->lastName );
1026 person->lastName = lName;
1027 if( person->lastName )
1028 g_strstrip( person->lastName );
1032 * Build a path of all ancestor folders for specified folder.
1033 * \param folder Folder.
1034 * \param seq Path sequence, FALSE top down, TRUE bottom up.
1035 * \return List of folders from the top down.
1037 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1039 AddrItemObject *item;
1042 item = ( AddrItemObject * ) folder;
1045 list = g_list_prepend( list, item );
1046 item = ADDRITEM_PARENT( item );
1051 list = g_list_append( list, item );
1052 item = ADDRITEM_PARENT( item );
1059 * Format E-Mail address.
1060 * \param email EMail item to format.
1061 * \return Formatted string. Should be freed after use.
1063 gchar *addritem_format_email( ItemEMail *email ) {
1070 if( ADDRITEM_NAME( email ) ) {
1071 if( strlen( ADDRITEM_NAME( email ) ) ) {
1072 name = ADDRITEM_NAME( email );
1076 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1077 name = ADDRITEM_NAME( person );
1081 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1082 address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1085 address = g_strdup_printf( "%s <%s>", name, email->address );
1089 address = g_strdup_printf( "%s", email->address );