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.
28 #include "file-utils.h"
35 * Create new email address item.
36 * \return Initialized email item.
38 ItemEMail *addritem_create_item_email( void ) {
40 item = g_new0( ItemEMail, 1 );
41 ADDRITEM_TYPE(item) = ITEMTYPE_EMAIL;
42 ADDRITEM_ID(item) = NULL;
43 ADDRITEM_NAME(item) = NULL;
44 ADDRITEM_PARENT(item) = NULL;
45 ADDRITEM_SUBTYPE(item) = 0;
52 * Create a shallow copy of specified email address item.
53 * \param item E-Mail to copy.
54 * \return Copy of email, or <i>NULL</i> if null argument supplied.
56 ItemEMail *addritem_copy_item_email( ItemEMail *item ) {
57 ItemEMail *itemNew = NULL;
59 itemNew = addritem_create_item_email();
60 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
61 itemNew->address = g_strdup( item->address );
62 itemNew->remarks = g_strdup( item->remarks );
68 * Create a full copy (deep copy) of specified email address item.
69 * \param item E-Mail to copy.
70 * \return Copy of email.
72 ItemEMail *addritem_copyfull_item_email( ItemEMail *item ) {
73 ItemEMail *itemNew = NULL;
75 itemNew = addritem_create_item_email();
76 ADDRITEM_ID(itemNew) = g_strdup( ADDRITEM_ID(item) );
77 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
78 ADDRITEM_PARENT(itemNew) = ADDRITEM_PARENT(item);
79 itemNew->address = g_strdup( item->address );
80 itemNew->remarks = g_strdup( item->remarks );
86 * Specify alias for email.
87 * \param email E-Mail item.
90 void addritem_email_set_alias( ItemEMail *email, const gchar *value ) {
91 ADDRITEM_NAME(email) = mgu_replace_string( ADDRITEM_NAME(email), value );
95 * Specify address for email.
96 * \param email E-Mail item.
97 * \param value Address.
99 void addritem_email_set_address( ItemEMail *email, const gchar *value ) {
100 email->address = mgu_replace_string( email->address, value );
104 * Specify remarks for email.
105 * \param email E-Mail item.
106 * \param value Remarks.
108 void addritem_email_set_remarks( ItemEMail *email, const gchar *value ) {
109 email->remarks = mgu_replace_string( email->remarks, value );
113 * Free address item email object.
114 * \param item E-Mail item to free.
116 void addritem_free_item_email( ItemEMail *item ) {
117 cm_return_if_fail( item != NULL );
119 /* Free internal stuff */
120 g_free( ADDRITEM_ID(item) );
121 g_free( ADDRITEM_NAME(item) );
122 g_free( item->address );
123 g_free( item->remarks );
125 ADDRITEM_OBJECT(item)->type = ITEMTYPE_NONE;
126 ADDRITEM_ID(item) = NULL;
127 ADDRITEM_NAME(item) = NULL;
128 ADDRITEM_PARENT(item) = NULL;
129 ADDRITEM_SUBTYPE(item) = 0;
130 item->address = NULL;
131 item->remarks = NULL;
136 * Create new attribute object.
137 * \return Initialized attribute object.
139 UserAttribute *addritem_create_attribute( void ) {
141 item = g_new0( UserAttribute, 1 );
149 * Create copy (deep copy) of specified attribute.
150 * \param item Attribute to copy.
151 * \return Copy of attribute, or <i>NULL</i> if null argument supplied.
153 UserAttribute *addritem_copy_attribute( UserAttribute *item ) {
154 UserAttribute *itemNew = NULL;
156 itemNew = addritem_create_attribute();
157 itemNew->uid = g_strdup( item->uid );
158 itemNew->name = g_strdup( item->name );
159 itemNew->value = g_strdup( item->value );
165 * Specify ID for attribute.
166 * \param item Attribute object.
169 void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
170 cm_return_if_fail( item != NULL );
171 item->uid = mgu_replace_string( item->uid, value );
175 * Specify name for attribute.
176 * \param item Attribute object.
179 void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
180 cm_return_if_fail( item != NULL );
181 item->name = mgu_replace_string( item->name, value );
185 * Specify value for attribute.
186 * \param item Attribute object.
187 * \param value Value.
189 void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
190 cm_return_if_fail( item != NULL );
191 item->value = mgu_replace_string( item->value, value );
195 * Free user attribute.
196 * \param item Attribute object to free.
198 void addritem_free_attribute( UserAttribute *item ) {
199 cm_return_if_fail( item != NULL );
201 g_free( item->name );
202 g_free( item->value );
210 * Create new address book person.
211 * \return Initialized person object.
213 ItemPerson *addritem_create_item_person( void ) {
215 person = g_new0( ItemPerson, 1 );
216 ADDRITEM_TYPE(person) = ITEMTYPE_PERSON;
217 ADDRITEM_ID(person) = NULL;
218 ADDRITEM_NAME(person) = NULL;
219 ADDRITEM_PARENT(person) = NULL;
220 ADDRITEM_SUBTYPE(person) = 0;
221 person->picture = NULL;
222 person->firstName = NULL;
223 person->lastName = NULL;
224 person->nickName = NULL;
225 person->listEMail = NULL;
226 person->listAttrib = NULL;
227 person->externalID = NULL;
228 person->isOpened = FALSE;
229 person->status = NONE;
234 * Create a shallow copy of address book person object.
235 * \param item Person to copy.
236 * \return Copy of person, or <i>NULL</i> if null argument supplied.
238 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
243 itemNew = addritem_create_item_person();
244 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
245 itemNew->picture = g_strdup( ADDRITEM_ID(itemNew) );
246 itemNew->firstName = g_strdup( item->firstName );
247 itemNew->lastName = g_strdup( item->lastName );
248 itemNew->nickName = g_strdup( item->nickName );
249 itemNew->externalID = g_strdup( item->externalID );
250 itemNew->status = item->status;
256 * Specify picture for person object.
257 * \param person Person object.
258 * \param value Picture.
260 void addritem_person_set_picture( ItemPerson *person, const gchar *value ) {
261 if (!value || g_utf8_validate(value, -1, NULL))
262 person->picture = mgu_replace_string( person->picture, value );
264 gchar *out = conv_codeset_strdup(value,
265 conv_get_locale_charset_str_no_utf8(),
268 person->picture = mgu_replace_string( person->picture, out );
274 * Get picture filename for person object.
275 * \param person Person object.
276 * \return copy of picture file path string (to be freed by caller - and there is
277 * no guarantee that path does exist, or NULL.
279 gchar *addritem_person_get_picture( ItemPerson *person) {
281 return g_strconcat( get_rc_dir(), G_DIR_SEPARATOR_S,
282 ADDRBOOK_DIR, G_DIR_SEPARATOR_S, person->picture,
288 * Delete picture for person object.
289 * \param person Person object.
291 void addritem_person_remove_picture( ItemPerson *person) {
292 if (person->picture) {
293 gchar *filename = g_strconcat( get_rc_dir(), G_DIR_SEPARATOR_S,
294 ADDRBOOK_DIR, G_DIR_SEPARATOR_S, person->picture,
296 if (is_file_exist(filename)) {
297 debug_print("removing addressbook picture %s\n",
299 if (claws_unlink(filename) < 0) {
300 FILE_OP_ERROR(filename, "remove");
305 g_free(person->picture);
306 person->picture = NULL;
312 * Specify first name for person object.
313 * \param person Person object.
316 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
317 if (!value || g_utf8_validate(value, -1, NULL))
318 person->firstName = mgu_replace_string( person->firstName, value );
320 gchar *out = conv_codeset_strdup(value,
321 conv_get_locale_charset_str_no_utf8(),
324 person->firstName = mgu_replace_string( person->firstName, out );
330 * Specify last name for person object.
331 * \param person Person object.
334 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
335 if (!value || g_utf8_validate(value, -1, NULL))
336 person->lastName = mgu_replace_string( person->lastName, value );
338 gchar *out = conv_codeset_strdup(value,
339 conv_get_locale_charset_str_no_utf8(),
342 person->lastName = mgu_replace_string( person->lastName, out );
348 * Specify nick name for person object.
349 * \param person Person object.
352 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
353 if (!value || g_utf8_validate(value, -1, NULL))
354 person->nickName = mgu_replace_string( person->nickName, value );
356 gchar *out = conv_codeset_strdup(value,
357 conv_get_locale_charset_str_no_utf8(),
360 person->nickName = mgu_replace_string( person->nickName, out );
366 * Specify common name for person object.
367 * \param person Person object.
370 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
371 if (!value || g_utf8_validate(value, -1, NULL))
372 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
374 gchar *out = conv_codeset_strdup(value,
375 conv_get_locale_charset_str_no_utf8(),
378 ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), out );
384 * Specify external ID for person object.
385 * \param person Person object.
388 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
389 person->externalID = mgu_replace_string( person->externalID, value );
393 * Specify value of open indicator for person object. This is typically used to
394 * simplify open/close folders in the address book GUI.
395 * \param person Person object.
396 * \param value Value for indicator. Set to <i>TRUE</i> if opened.
398 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
399 person->isOpened = value;
403 * Free linked list of item addresses; both addresses and the list are freed.
404 * It is assumed that addresses are *NOT* contained within some other
406 * \param list List of addresses to be freed.
408 void addritem_free_list_email( GList *list ) {
411 ItemEMail *email = node->data;
413 addritem_free_item_email( email );
415 node = g_list_next( node );
422 * Free linked list of attributes; both attributes and the list are freed.
423 * It is assumed that attributes are *NOT* contained within some other
425 * \param list List of attributes to be freed.
427 void addritem_free_list_attribute( GList *list ) {
430 addritem_free_attribute( node->data );
432 node = g_list_next( node );
438 * Free address person object.
439 * \param person Person object to free.
441 void addritem_free_item_person( ItemPerson *person ) {
442 cm_return_if_fail( person != NULL );
444 /* Free internal stuff */
445 g_free( ADDRITEM_ID(person) );
446 g_free( ADDRITEM_NAME(person) );
447 g_free( person->picture );
448 g_free( person->firstName );
449 g_free( person->lastName );
450 g_free( person->nickName );
451 g_free( person->externalID );
452 g_list_free( person->listEMail );
453 addritem_free_list_attribute( person->listAttrib );
455 ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
456 ADDRITEM_ID(person) = NULL;
457 ADDRITEM_NAME(person) = NULL;
458 ADDRITEM_PARENT(person) = NULL;
459 ADDRITEM_SUBTYPE(person) = 0;
460 person->picture = NULL;
461 person->firstName = NULL;
462 person->lastName = NULL;
463 person->nickName = NULL;
464 person->externalID = NULL;
465 person->listEMail = NULL;
466 person->listAttrib = NULL;
472 * Print E-Mail address object for debug.
473 * \param item Item to print.
474 * \param stream Output stream.
476 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
477 cm_return_if_fail( item != NULL );
478 fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
479 fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
480 fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
481 fprintf( stream, "\t\taddr: '%s'\n", item->address );
482 fprintf( stream, "\t\trems: '%s'\n", item->remarks );
483 fprintf( stream, "\t\t---\n" );
487 * Print user attribute object for debug.
488 * \param item Attribute to print.
489 * \param stream Output stream.
491 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
492 cm_return_if_fail( item != NULL );
493 fprintf( stream, "\t\tuid : '%s'\n", item->uid );
494 fprintf( stream, "\t\tname : '%s'\n", item->name );
495 fprintf( stream, "\t\tvalue: '%s'\n", item->value );
496 fprintf( stream, "\t\t---\n" );
500 * Print person item for debug.
501 * \param person Person to print.
502 * \param stream Output stream.
504 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
506 cm_return_if_fail( person != NULL );
507 fprintf( stream, "Person:\n" );
508 fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
509 fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
510 fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
511 fprintf( stream, "\tphoto: '%s'\n", person->picture );
512 fprintf( stream, "\tfirst: '%s'\n", person->firstName );
513 fprintf( stream, "\tlast : '%s'\n", person->lastName );
514 fprintf( stream, "\tnick : '%s'\n", person->nickName );
515 fprintf( stream, "\textID: '%s'\n", person->externalID );
516 fprintf( stream, "\teMail:\n" );
517 fprintf( stream, "\t---\n" );
518 node = person->listEMail;
520 addritem_print_item_email( node->data, stream );
521 node = g_list_next( node );
523 fprintf( stream, "\tuAttr:\n" );
524 fprintf( stream, "\t---\n" );
525 node = person->listAttrib;
527 addritem_print_attribute( node->data, stream );
528 node = g_list_next( node );
530 gchar *current_status;
531 switch (person->status) {
532 case NONE: current_status = g_strdup("Unchanged"); break;
533 case ADD_ENTRY: current_status = g_strdup("New"); break;
534 case UPDATE_ENTRY: current_status = g_strdup("Updated"); break;
535 case DELETE_ENTRY: current_status = g_strdup("Deleted"); break;
536 default: current_status = g_strdup("Unknown");
538 fprintf( stream, "\t\tStatus: %s\n", current_status );
539 if ( current_status )
540 g_free(current_status);
541 fprintf( stream, "\t===\n" );
545 * Add E-Mail address object to person.
546 * \param person Person.
547 * \param email E-Mail object to add.
548 * \return <i>TRUE</i> if E-Mail added.
550 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
553 cm_return_val_if_fail( person != NULL, FALSE );
554 cm_return_val_if_fail( email != NULL, FALSE );
556 node = person->listEMail;
558 if( node->data == email ) return FALSE;
559 node = g_list_next( node );
561 person->listEMail = g_list_append( person->listEMail, email );
562 ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
567 * Remove email address for specified person.
568 * \param person Person.
569 * \param email EMail to remove.
570 * \return EMail object, or <i>NULL</i> if not found. Note that object should
571 * still be freed after calling this method.
573 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
574 gboolean found = FALSE;
577 cm_return_val_if_fail( person != NULL, NULL );
578 if( email == NULL ) return NULL;
581 node = person->listEMail;
583 if( node-> data == email ) {
587 node = g_list_next( node );
591 /* Remove email from person's address list */
592 if( person->listEMail ) {
593 person->listEMail = g_list_remove( person->listEMail, email );
595 /* Unlink reference to person. */
596 ADDRITEM_PARENT(email) = NULL;
603 * Add user attribute to specified person.
604 * \param person Person.
605 * \param attrib Attribute to add.
606 * \return <i>TRUE</i> if item added.
608 void addritem_person_add_attribute(
609 ItemPerson *person, UserAttribute *attrib )
611 cm_return_if_fail( person != NULL );
612 person->listAttrib = g_list_append( person->listAttrib, attrib );
616 * Remove user attribute from specified person.
617 * \param person Person.
618 * \param attrib Attribute to remove.
620 void addritem_person_remove_attribute( ItemPerson *person, const gchar *attrib ) {
621 cm_return_if_fail( person != NULL && attrib != NULL );
624 attrib_list = person->listAttrib;
625 while (attrib_list) {
626 UserAttribute *user_attrib = attrib_list->data;
627 if (strcmp(user_attrib->name, attrib) == 0) {
628 person->listAttrib = g_list_remove(person->listAttrib, (gconstpointer) user_attrib);
631 attrib_list = g_list_next(attrib_list);
637 * Create new address book group object.
638 * \return Initialized group object.
640 ItemGroup *addritem_create_item_group( void ) {
643 group = g_new0( ItemGroup, 1 );
644 ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
645 ADDRITEM_ID(group) = NULL;
646 ADDRITEM_NAME(group) = NULL;
647 ADDRITEM_PARENT(group) = NULL;
648 ADDRITEM_SUBTYPE(group) = 0;
649 group->remarks = NULL;
650 group->listEMail = NULL;
655 * Copy (deep copy) address book group.
656 * \param item Group to copy.
657 * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
659 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
664 itemNew = addritem_create_item_group();
665 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
666 itemNew->remarks = g_strdup( item->remarks );
672 * Specify name to be used for group.
673 * \param group Group object.
674 * \param value Name of group.
676 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
677 ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
681 * Free address group object.
682 * \param group Group to free.
684 void addritem_free_item_group( ItemGroup *group ) {
685 cm_return_if_fail( group != NULL );
687 /* Free internal stuff */
688 g_free( ADDRITEM_ID(group) );
689 g_free( ADDRITEM_NAME(group) );
690 g_free( group->remarks );
691 mgu_clear_list( group->listEMail );
692 g_list_free( group->listEMail );
694 ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
695 ADDRITEM_ID(group) = NULL;
696 ADDRITEM_NAME(group) = NULL;
697 ADDRITEM_PARENT(group) = NULL;
698 ADDRITEM_SUBTYPE(group) = 0;
699 group->remarks = NULL;
700 group->listEMail = NULL;
706 * Add EMail address to group. Note that a reference to an E-Mail item is
707 * added to a group. A person object is the only container that for an
709 * \param group Group.
710 * \param email E-Mail object.
711 * \return <i>TRUE</i> if email item added.
713 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
716 cm_return_val_if_fail( group != NULL, FALSE );
717 cm_return_val_if_fail( email != NULL, FALSE );
719 node = group->listEMail;
721 if( node->data == email ) return FALSE;
722 node = g_list_next( node );
724 group->listEMail = g_list_append( group->listEMail, email );
729 * Remove person object for specified group.
730 * \param group Group from which to remove address.
731 * \param email EMail to remove
732 * \return EMail object, or <i>NULL if email not found in group. Note that
733 * this object is referenced (linked) to a group and should *NOT*
734 * be freed. An E-Mail object object should only be freed after
735 * removing from a person.
737 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
738 if( group && person ) {
739 GList *node = group->listPerson;
741 if( node->data == person ) {
742 group->listPerson = g_list_remove( group->listPerson, person );
745 node = g_list_next( node );
752 * Print address group item for debug.
753 * \param group Group to print.
754 * \param stream Output stream.
756 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
760 cm_return_if_fail( group != NULL );
761 fprintf( stream, "Group:\n" );
762 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
763 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
764 fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
765 fprintf( stream, "\trem: '%s'\n", group->remarks );
766 fprintf( stream, "\t---\n" );
767 node = group->listEMail;
770 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
772 fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
773 fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
776 fprintf( stream, "\t\tpid : ???\n" );
777 fprintf( stream, "\t\tcomn: ???\n" );
779 addritem_print_item_email( item, stream );
780 node = g_list_next( node );
782 fprintf( stream, "\t***\n" );
786 * Create new address folder.
787 * \return Initialized address folder object.
789 ItemFolder *addritem_create_item_folder( void ) {
791 folder = g_new0( ItemFolder, 1 );
792 ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
793 ADDRITEM_ID(folder) = NULL;
794 ADDRITEM_NAME(folder) = NULL;
795 ADDRITEM_PARENT(folder) = NULL;
796 ADDRITEM_SUBTYPE(folder) = 0;
797 folder->remarks = NULL;
798 folder->isRoot = FALSE;
799 folder->listItems = NULL;
800 folder->listFolder = NULL;
801 folder->listPerson = NULL;
802 folder->listGroup = NULL;
803 folder->folderType = ADDRFOLDER_NONE;
804 folder->folderData = NULL;
805 folder->isHidden = FALSE;
810 * Copy address book folder. Note that only the folder and not its contents are
812 * \param item Folder to copy.
813 * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
815 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
818 itemNew = g_new0( ItemFolder, 1 );
820 itemNew = addritem_create_item_folder();
821 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
822 itemNew->folderType = item->folderType;
828 * Specify name to be used for folder.
829 * \param folder Folder.
832 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
833 ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
837 * Specify remarks to be used for folder.
838 * \param folder Folder.
839 * \param value Remarks.
841 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
842 folder->remarks = mgu_replace_string( folder->remarks, value );
846 * Specify visibility of folder.
847 * \param folder Folder.
848 * \param value Set to <code>TRUE</code> to hide folder.
850 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
851 folder->isHidden = value;
855 * Free address folder. Note: this does not free up the lists of children
856 * (folders, groups and person). This should be done prior to calling this
858 * \param folder Folder to free.
860 void addritem_free_item_folder( ItemFolder *folder ) {
861 cm_return_if_fail( folder != NULL );
863 /* Free internal stuff */
864 g_free( ADDRITEM_ID(folder) );
865 g_free( ADDRITEM_NAME(folder) );
866 g_free( folder->remarks );
867 mgu_clear_list( folder->listItems );
868 g_list_free( folder->listItems );
870 ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
871 ADDRITEM_ID(folder) = NULL;
872 ADDRITEM_NAME(folder) = NULL;
873 ADDRITEM_PARENT(folder) = NULL;
874 ADDRITEM_SUBTYPE(folder) = 0;
875 folder->isRoot = FALSE;
876 folder->remarks = NULL;
877 folder->listItems = NULL;
878 folder->listFolder = NULL;
879 folder->listGroup = NULL;
880 folder->listPerson = NULL;
881 folder->folderType = ADDRFOLDER_NONE;
882 folder->folderData = NULL;
883 folder->isHidden = FALSE;
889 * Add person into folder.
890 * \param folder Folder.
891 * \param item Person to add.
892 * \return <i>TRUE</i> if person added.
894 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
895 cm_return_val_if_fail( folder != NULL, FALSE );
896 cm_return_val_if_fail( item != NULL, FALSE );
898 folder->listPerson = g_list_append( folder->listPerson, item );
899 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
904 * Add folder into folder.
905 * \param folder Folder.
906 * \param item Folder to add.
907 * \return <i>TRUE</i> if folder added.
909 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
910 cm_return_val_if_fail( folder != NULL, FALSE );
911 cm_return_val_if_fail( item != NULL, FALSE );
913 folder->listFolder = g_list_append( folder->listFolder, item );
914 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
919 * Add group into folder.
920 * \param folder Folder.
921 * \param item Group to add.
922 * \return <i>TRUE</i> if group added.
924 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
925 cm_return_val_if_fail( folder != NULL, FALSE );
926 cm_return_val_if_fail( item != NULL, FALSE );
928 folder->listGroup = g_list_append( folder->listGroup, item );
929 ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
934 * Print address folder item contents for debug.
935 * \param folder Folder to process.
936 * \param stream Output stream.
938 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
940 /* ItemPerson *person; */
943 cm_return_if_fail( folder != NULL );
945 fprintf( stream, "Folder:\n" );
946 fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
947 fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
948 fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
949 fprintf( stream, "\trem: '%s'\n", folder->remarks );
950 fprintf( stream, "\ttyp: %d\n", folder->folderType );
951 fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
952 fprintf( stream, "\t---\n" );
953 parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
955 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
958 fprintf( stream, "\tpar: NULL\n" );
960 node = folder->listFolder;
962 AddrItemObject *aio = node->data;
964 if( aio->type == ITEMTYPE_FOLDER ) {
965 ItemFolder *item = ( ItemFolder * ) aio;
966 addritem_print_item_folder( item, stream );
970 fprintf( stream, "\t\tpid : ???\n" );
973 node = g_list_next( node );
976 node = folder->listPerson;
978 AddrItemObject *aio = node->data;
980 if( aio->type == ITEMTYPE_PERSON ) {
981 ItemPerson *item = ( ItemPerson * ) aio;
982 addritem_print_item_person( item, stream );
986 fprintf( stream, "\t\tpid : ???\n" );
989 node = g_list_next( node );
992 node = folder->listGroup;
994 AddrItemObject *aio = node->data;
996 if( aio->type == ITEMTYPE_GROUP ) {
997 ItemGroup *item = ( ItemGroup * ) aio;
998 addritem_print_item_group( item, stream );
1002 fprintf( stream, "\t\tpid : ???\n" );
1004 node = g_list_next( node );
1006 fprintf( stream, "\t###\n" );
1010 * Return link list of persons for specified folder. Note that the list contains
1011 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1012 * addritem_free_xxx() functions... this will destroy the addressbook data!
1014 * \param folder Folder to process.
1015 * \return List of items, or <i>NULL</i> if none.
1017 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
1021 cm_return_val_if_fail( folder != NULL, NULL );
1023 node = folder->listPerson;
1025 ItemPerson *person = node->data;
1026 list = g_list_prepend( list, person );
1027 node = g_list_next( node );
1029 return g_list_reverse(list);
1033 * Return link list of groups for specified folder. Note that the list contains
1034 * references to items and should be g_free() when done. Do *NOT* attempt to use the
1035 * addritem_free_xxx() functions... this will destroy the addressbook data!
1037 * \param folder Folder to process.
1038 * \return List of items, or <i>NULL</i> if none.
1040 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1044 cm_return_val_if_fail( folder != NULL, NULL );
1046 node = folder->listGroup;
1048 ItemGroup *group = node->data;
1049 list = g_list_prepend( list, group );
1050 node = g_list_next( node );
1052 return g_list_reverse(list);
1056 * Parse first and last names for person from common name.
1057 * \param person Person to process.
1059 void addritem_parse_first_last( ItemPerson *person ) {
1061 gchar *fName, *lName;
1065 cm_return_if_fail( person != NULL );
1067 name = ADDRITEM_NAME(person);
1068 if( name == NULL ) return;
1072 p = strchr( name, ',' );
1074 len = ( size_t ) ( p - name );
1075 lName = g_strndup( name, len );
1076 fName = g_strdup( p + 1 );
1079 /* Other way around */
1082 if( name[i] == ' ' ) {
1083 fName = g_strndup( name, i );
1084 lName = g_strdup( &name[i] );
1089 if( fName == NULL ) {
1090 fName = g_strdup( name );
1094 g_free( person->firstName );
1095 person->firstName = fName;
1096 if( person->firstName )
1097 g_strstrip( person->firstName );
1099 g_free( person->lastName );
1100 person->lastName = lName;
1101 if( person->lastName )
1102 g_strstrip( person->lastName );
1106 * Build a path of all ancestor folders for specified folder.
1107 * \param folder Folder.
1108 * \param seq Path sequence, FALSE top down, TRUE bottom up.
1109 * \return List of folders from the top down.
1111 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1113 AddrItemObject *item;
1116 item = ( AddrItemObject * ) folder;
1119 list = g_list_prepend( list, item );
1120 item = ADDRITEM_PARENT( item );
1125 list = g_list_append( list, item );
1126 item = ADDRITEM_PARENT( item );
1133 * Format E-Mail address.
1134 * \param email EMail item to format.
1135 * \return Formatted string. Should be freed after use.
1137 gchar *addritem_format_email( ItemEMail *email ) {
1144 if( ADDRITEM_NAME( email ) ) {
1145 if( strlen( ADDRITEM_NAME( email ) ) ) {
1146 name = ADDRITEM_NAME( email );
1150 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1151 name = ADDRITEM_NAME( person );
1155 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1156 address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1159 address = g_strdup_printf( "%s <%s>", name, email->address );
1163 address = g_strdup_printf( "%s", email->address );