0c78ea5c0a2c13a2b67e64fb8cd405efe1aa6370
[claws.git] / src / addritem.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2001-2003 Match Grun
4  *
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.
9  *
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.
14  *
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * General primitive address item objects.
22  */
23
24 #include <glib.h>
25 #include <stdio.h>
26 #include <string.h>
27
28 #include "addritem.h"
29 #include "mgutils.h"
30
31 /**
32  * Create new email address item.
33  * \return Initialized email item.
34  */
35 ItemEMail *addritem_create_item_email( void ) {
36         ItemEMail *item;
37         item = g_new0( ItemEMail, 1 );
38         ADDRITEM_TYPE(item) = ITEMTYPE_EMAIL;
39         ADDRITEM_ID(item) = NULL;
40         ADDRITEM_NAME(item) = NULL;
41         ADDRITEM_PARENT(item) = NULL;
42         ADDRITEM_SUBTYPE(item) = 0;
43         item->address = NULL;
44         item->remarks = NULL;
45         return item;
46 }
47
48 /**
49  * Create a shallow copy of specified email address item.
50  * \param  item E-Mail to copy.
51  * \return Copy of email, or <i>NULL</i> if null argument supplied.
52  */
53 ItemEMail *addritem_copy_item_email( ItemEMail *item ) {
54         ItemEMail *itemNew = NULL;
55         if( item ) {
56                 itemNew = addritem_create_item_email();
57                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
58                 itemNew->address = g_strdup( item->address );
59                 itemNew->remarks = g_strdup( item->remarks );
60         }
61         return itemNew;
62 }
63
64 /**
65  * Create a full copy (deep copy) of specified email address item.
66  * \param  item E-Mail to copy.
67  * \return Copy of email.
68  */
69 ItemEMail *addritem_copyfull_item_email( ItemEMail *item ) {
70         ItemEMail *itemNew = NULL;
71         if( item ) {
72                 itemNew = addritem_create_item_email();
73                 ADDRITEM_ID(itemNew) = g_strdup( ADDRITEM_ID(item) );
74                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
75                 ADDRITEM_PARENT(itemNew) = ADDRITEM_PARENT(item);
76                 itemNew->address = g_strdup( item->address );
77                 itemNew->remarks = g_strdup( item->remarks );
78         }
79         return itemNew;
80 }
81
82 /**
83  * Specify ID for email.
84  * \param email E-Mail item.
85  * \param value ID.
86  */
87 void addritem_email_set_id( ItemEMail *email, const gchar *value ) {
88         ADDRITEM_ID(email) = mgu_replace_string( ADDRITEM_ID(email), value );
89 }
90
91 /**
92  * Specify alias for email.
93  * \param email E-Mail item.
94  * \param value Alias.
95  */
96 void addritem_email_set_alias( ItemEMail *email, const gchar *value ) {
97         ADDRITEM_NAME(email) = mgu_replace_string( ADDRITEM_NAME(email), value );
98 }
99
100 /**
101  * Specify address for email.
102  * \param email E-Mail item.
103  * \param value Address.
104  */
105 void addritem_email_set_address( ItemEMail *email, const gchar *value ) {
106         email->address = mgu_replace_string( email->address, value );
107 }
108
109 /**
110  * Specify remarks for email.
111  * \param email E-Mail item.
112  * \param value Remarks.
113  */
114 void addritem_email_set_remarks( ItemEMail *email, const gchar *value ) {
115         email->remarks = mgu_replace_string( email->remarks, value );
116 }
117
118 /**
119  * Free address item email object.
120  * \param item E-Mail item to free.
121  */
122 void addritem_free_item_email( ItemEMail *item ) {
123         g_return_if_fail( item != NULL );
124
125         /* Free internal stuff */
126         g_free( ADDRITEM_ID(item) );
127         g_free( ADDRITEM_NAME(item) );
128         g_free( item->address );
129         g_free( item->remarks );
130
131         ADDRITEM_OBJECT(item)->type = ITEMTYPE_NONE;
132         ADDRITEM_ID(item) = NULL;
133         ADDRITEM_NAME(item) = NULL;
134         ADDRITEM_PARENT(item) = NULL;
135         ADDRITEM_SUBTYPE(item) = 0;
136         item->address = NULL;
137         item->remarks = NULL;
138         g_free( item );
139 }
140
141 /**
142  * Create new attribute object.
143  * \return Initialized attribute object.
144  */
145 UserAttribute *addritem_create_attribute( void ) {
146         UserAttribute *item;
147         item = g_new0( UserAttribute, 1 );
148         item->uid = NULL;
149         item->name = NULL;
150         item->value = NULL;
151         return item;
152 }
153
154 /**
155  * Create copy (deep copy) of specified attribute.
156  * \param  item Attribute to copy.
157  * \return Copy of attribute, or <i>NULL</i> if null argument supplied.
158  */
159 UserAttribute *addritem_copy_attribute( UserAttribute *item ) {
160         UserAttribute *itemNew = NULL;
161         if( item ) {
162                 itemNew = addritem_create_attribute();
163                 itemNew->uid = g_strdup( item->uid );
164                 itemNew->name = g_strdup( item->name );
165                 itemNew->value = g_strdup( item->value );
166         }
167         return itemNew;
168 }
169
170 /**
171  * Specify ID for attribute.
172  * \param item Attribute object.
173  * \param value ID.
174  */
175 void addritem_attrib_set_id( UserAttribute *item, const gchar *value ) {
176         g_return_if_fail( item != NULL );
177         item->uid = mgu_replace_string( item->uid, value );
178 }
179
180 /**
181  * Specify name for attribute.
182  * \param item Attribute object.
183  * \param value Name.
184  */
185 void addritem_attrib_set_name( UserAttribute *item, const gchar *value ) {
186         g_return_if_fail( item != NULL );
187         item->name = mgu_replace_string( item->name, value );
188 }
189
190 /**
191  * Specify value for attribute.
192  * \param item Attribute object.
193  * \param value Value.
194  */
195 void addritem_attrib_set_value( UserAttribute *item, const gchar *value ) {
196         g_return_if_fail( item != NULL );
197         item->value = mgu_replace_string( item->value, value );
198 }
199
200 /**
201  * Free user attribute.
202  * \param item Attribute object to free.
203  */
204 void addritem_free_attribute( UserAttribute *item ) {
205         g_return_if_fail( item != NULL );
206         g_free( item->uid );
207         g_free( item->name );
208         g_free( item->value );
209         item->uid = NULL;
210         item->name = NULL;
211         item->value = NULL;
212         g_free( item );
213 }
214
215 /**
216  * Create new address book person.
217  * \return Initialized person object.
218  */
219 ItemPerson *addritem_create_item_person( void ) {
220         ItemPerson *person;
221         person = g_new0( ItemPerson, 1 );
222         ADDRITEM_TYPE(person) = ITEMTYPE_PERSON;
223         ADDRITEM_ID(person) = NULL;
224         ADDRITEM_NAME(person) = NULL;
225         ADDRITEM_PARENT(person) = NULL;
226         ADDRITEM_SUBTYPE(person) = 0;
227         person->firstName = NULL;
228         person->lastName = NULL;
229         person->nickName = NULL;
230         person->listEMail = NULL;
231         person->listAttrib = NULL;
232         person->externalID = NULL;
233         person->isOpened = FALSE;
234         return person;
235 }
236
237 /**
238  * Create a shallow copy of address book person object.
239  * \param  item Person to copy.
240  * \return Copy of person, or <i>NULL</i> if null argument supplied.
241  */
242 ItemPerson *addritem_copy_item_person( ItemPerson *item ) {
243         ItemPerson *itemNew;
244
245         itemNew = NULL;
246         if( item ) {
247                 itemNew = addritem_create_item_person();
248                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
249                 itemNew->firstName = g_strdup( item->firstName );
250                 itemNew->lastName = g_strdup( item->lastName );
251                 itemNew->nickName = g_strdup( item->nickName );
252                 itemNew->externalID = g_strdup( item->externalID );
253         }
254         return itemNew;
255 }
256
257 /**
258  * Specify ID for person object.
259  * \param person Person object.
260  * \param value ID.
261  */
262 void addritem_person_set_id( ItemPerson *person, const gchar *value ) {
263         ADDRITEM_ID(person) = mgu_replace_string( ADDRITEM_ID(person), value );
264 }
265
266 /**
267  * Specify first name for person object.
268  * \param person Person object.
269  * \param value Name.
270  */
271 void addritem_person_set_first_name( ItemPerson *person, const gchar *value ) {
272         person->firstName = mgu_replace_string( person->firstName, value );
273 }
274
275 /**
276  * Specify last name for person object.
277  * \param person Person object.
278  * \param value name.
279  */
280 void addritem_person_set_last_name( ItemPerson *person, const gchar *value ) {
281         person->lastName = mgu_replace_string( person->lastName, value );
282 }
283
284 /**
285  * Specify nick name for person object.
286  * \param person Person object.
287  * \param value name.
288  */
289 void addritem_person_set_nick_name( ItemPerson *person, const gchar *value ) {
290         person->nickName = mgu_replace_string( person->nickName, value );
291 }
292
293 /**
294  * Specify common name for person object.
295  * \param person Person object.
296  * \param value name.
297  */
298 void addritem_person_set_common_name( ItemPerson *person, const gchar *value ) {
299         ADDRITEM_NAME(person) = mgu_replace_string( ADDRITEM_NAME(person), value );
300 }
301
302 /**
303  * Specify external ID for person object.
304  * \param person Person object.
305  * \param value ID.
306  */
307 void addritem_person_set_external_id( ItemPerson *person, const gchar *value ) {
308         person->externalID = mgu_replace_string( person->externalID, value );
309 }
310
311 /**
312  * Specify value of open indicator for person object. This is typically used to
313  * simplify open/close folders in the address book GUI.
314  * \param person Person object.
315  * \param value  Value for indicator. Set to <i>TRUE</i> if opened.
316  */
317 void addritem_person_set_opened( ItemPerson *person, const gboolean value ) {
318         person->isOpened = value;
319 }
320
321 /**
322  * Test whether person's data is empty.
323  * \param  person Person to test.
324  * \return <i>TRUE</i> if empty.
325  */
326 gboolean addritem_person_empty( ItemPerson *person ) {
327         gchar *t;
328
329         if( person == NULL ) return FALSE;
330
331         t = ADDRITEM_NAME(person);
332         if( t != NULL && strlen( t ) > 0 ) return FALSE;
333
334         t = person->firstName;
335         if( t != NULL && strlen( t ) > 0 ) return FALSE;
336
337         t = person->lastName;
338         if( t != NULL && strlen( t ) > 0 ) return FALSE;
339
340         t = person->nickName;
341         if( t != NULL && strlen( t ) > 0 ) return FALSE;
342
343         if( person->listEMail  != NULL ) return FALSE;
344         if( person->listAttrib != NULL ) return FALSE;
345
346         return TRUE;
347 }
348
349 /**
350  * Free linked list of item addresses; both addresses and the list are freed.
351  * It is assumed that addresses are *NOT* contained within some other
352  * container.
353  * \param list List of addresses to be freed.
354  */
355 void addritem_free_list_email( GList *list ) {
356         GList *node = list;
357         while( node ) {
358                 ItemEMail *email = node->data;
359
360                 addritem_free_item_email( email );
361                 node->data = NULL;
362                 node = g_list_next( node );
363         }
364         g_list_free( list );
365         list = NULL;
366 }
367
368 /**
369  * Free linked list of attributes; both attributes and the list are freed.
370  * It is assumed that attributes are *NOT* contained within some other
371  * container.
372  * \param list List of attributes to be freed.
373  */
374 void addritem_free_list_attribute( GList *list ) {
375         GList *node = list;
376         while( node ) {
377                 addritem_free_attribute( node->data );
378                 node->data = NULL;
379                 node = g_list_next( node );
380         }
381         g_list_free( list );
382 }
383
384 /**
385  * Free address person object.
386  * \param person Person object to free.
387  */
388 void addritem_free_item_person( ItemPerson *person ) {
389         g_return_if_fail( person != NULL );
390
391         /* Free internal stuff */
392         g_free( ADDRITEM_ID(person) );
393         g_free( ADDRITEM_NAME(person) );
394         g_free( person->firstName );
395         g_free( person->lastName );
396         g_free( person->nickName );
397         g_free( person->externalID );
398         g_list_free( person->listEMail );
399         addritem_free_list_attribute( person->listAttrib );
400
401         ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
402         ADDRITEM_ID(person) = NULL;
403         ADDRITEM_NAME(person) = NULL;
404         ADDRITEM_PARENT(person) = NULL;
405         ADDRITEM_SUBTYPE(person) = 0;
406         person->firstName = NULL;
407         person->lastName = NULL;
408         person->nickName = NULL;
409         person->externalID = NULL;
410         person->listEMail = NULL;
411         person->listAttrib = NULL;
412
413         g_free( person );
414 }
415
416 /**
417  * Print E-Mail address object for debug.
418  * \param item   Item to print.
419  * \param stream Output stream.
420  */
421 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
422         g_return_if_fail( item != NULL );
423         fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
424         fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
425         fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
426         fprintf( stream, "\t\taddr: '%s'\n", item->address );
427         fprintf( stream, "\t\trems: '%s'\n", item->remarks );
428         fprintf( stream, "\t\t---\n" );
429 }
430
431 /**
432  * Print user attribute object for debug.
433  * \param item   Attribute to print.
434  * \param stream Output stream.
435  */
436 void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
437         g_return_if_fail( item != NULL );
438         fprintf( stream, "\t\tuid  : '%s'\n", item->uid );
439         fprintf( stream, "\t\tname : '%s'\n", item->name );
440         fprintf( stream, "\t\tvalue: '%s'\n", item->value );
441         fprintf( stream, "\t\t---\n" );
442 }
443
444 /**
445  * Print person item for debug.
446  * \param person Person to print.
447  * \param stream Output stream.
448  */
449 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
450         GList *node;
451         g_return_if_fail( person != NULL );
452         fprintf( stream, "Person:\n" );
453         fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
454         fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
455         fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
456         fprintf( stream, "\tfirst: '%s'\n", person->firstName );
457         fprintf( stream, "\tlast : '%s'\n", person->lastName );
458         fprintf( stream, "\tnick : '%s'\n", person->nickName );
459         fprintf( stream, "\textID: '%s'\n", person->externalID );
460         fprintf( stream, "\teMail:\n" );
461         fprintf( stream, "\t---\n" );
462         node = person->listEMail;
463         while( node ) {
464                 addritem_print_item_email( node->data, stream );
465                 node = g_list_next( node );
466         }
467         fprintf( stream, "\tuAttr:\n" );
468         fprintf( stream, "\t---\n" );
469         node = person->listAttrib;
470         while( node ) {
471                 addritem_print_attribute( node->data, stream );
472                 node = g_list_next( node );
473         }
474         fprintf( stream, "\t===\n" );
475 }
476
477 /**
478  * Add E-Mail address object to person.
479  * \param  person Person.
480  * \param  email  E-Mail object to add.
481  * \return <i>TRUE</i> if E-Mail added.
482  */
483 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
484         GList *node;
485
486         g_return_val_if_fail( person != NULL, FALSE );
487         g_return_val_if_fail( email != NULL, FALSE );
488
489         node = person->listEMail;
490         while( node ) {
491                 if( node->data == email ) return FALSE;
492                 node = g_list_next( node );
493         }
494         person->listEMail = g_list_append( person->listEMail, email );
495         ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
496         return TRUE;
497 }
498
499 /**
500  * Return email object with specified ID for specified person.
501  * \param  person Person object.
502  * \param  eid    EMail ID.
503  * \return EMail object, or <i>NULL</i> if not found.
504  */
505 ItemEMail *addritem_person_get_email( ItemPerson *person, const gchar *eid ) {
506         ItemEMail *email = NULL;
507         GList *node;
508
509         g_return_val_if_fail( person != NULL, NULL );
510         if( eid == NULL || *eid == '\0' ) return NULL;
511
512         /* Look for email */
513         node = person->listEMail;
514         while( node ) {
515                 AddrItemObject *objE = node->data;
516                 gchar *ide = ADDRITEM_ID(objE);
517                 if( ide ) {
518                         if( strcmp( ide, eid ) == 0 ) {
519                                 email = ( ItemEMail * ) objE;
520                         }
521                 }
522                 node = g_list_next( node );
523         }
524         return email;
525 }
526
527 /**
528  * Remove email address with specified ID for specified person.
529  * \param  person Person object.
530  * \param  eid    EMail ID.
531  * \return EMail object, or <i>NULL</i> if not found. Note that object should
532  *         still be freed after calling this function.
533  */
534 ItemEMail *addritem_person_remove_email_id( ItemPerson *person, const gchar *eid ) {
535         ItemEMail *email = NULL;
536         GList *node;
537
538         g_return_val_if_fail( person != NULL, NULL );
539         if( eid == NULL || *eid == '\0' ) return NULL;
540
541         /* Look for email */
542         node = person->listEMail;
543         while( node ) {
544                 AddrItemObject *objE = node->data;
545                 gchar *ide = ADDRITEM_ID(objE);
546                 if( ide ) {
547                         if( strcmp( ide, eid ) == 0 ) {
548                                 email = ( ItemEMail * ) objE;
549                         }
550                 }
551                 node = g_list_next( node );
552         }
553
554         if( email ) {
555                 /* Remove email from person's address list */
556                 if( person->listEMail ) {
557                         person->listEMail = g_list_remove( person->listEMail, email );
558                 }
559                 /* Unlink reference to person. */
560                 ADDRITEM_PARENT(email) = NULL;
561         }
562         return email;
563 }
564
565 /**
566  * Remove email address for specified person.
567  * \param  person Person.
568  * \param  email  EMail to remove.
569  * \return EMail object, or <i>NULL</i> if not found. Note that object should
570  *         still be freed after calling this method.
571  */
572 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
573         gboolean found = FALSE;
574         GList *node;
575
576         g_return_val_if_fail( person != NULL, NULL );
577         if( email == NULL ) return NULL;
578
579         /* Look for email */
580         node = person->listEMail;
581         while( node ) {
582                 if( node-> data == email ) {
583                         found = TRUE;
584                         break;
585                 }
586                 node = g_list_next( node );
587         }
588
589         if( found ) {
590                 /* Remove email from person's address list */
591                 if( person->listEMail ) {
592                         person->listEMail = g_list_remove( person->listEMail, email );
593                 }
594                 /* Unlink reference to person. */
595                 ADDRITEM_PARENT(email) = NULL;
596                 return email;
597         }
598         return NULL;
599 }
600
601 /**
602  * Add user attribute to specified person.
603  * \param  person Person.
604  * \param  attrib Attribute to add.
605  * \return <i>TRUE</i> if item added.
606  */
607 void addritem_person_add_attribute(
608                         ItemPerson *person, UserAttribute *attrib )
609 {
610         g_return_if_fail( person != NULL );
611         person->listAttrib = g_list_append( person->listAttrib, attrib );
612 }
613
614 /**
615  * Return attribute with specified ID for person.
616  * \param  person Person object.
617  * \param  aid    Attribute ID.
618  * \return Reference to UserAttribute object, or <i>NULL</i> if not found.
619  */
620 UserAttribute *addritem_person_get_attribute(
621                         ItemPerson *person, const gchar *aid )
622 {
623         UserAttribute *attrib = NULL;
624         GList *node;
625
626         g_return_val_if_fail( person != NULL, NULL );
627         if( aid == NULL || *aid == '\0' ) return NULL;
628
629         /* Look for attribute */
630         node = person->listAttrib;
631         while( node ) {
632                 UserAttribute *attr = node->data;
633                 gchar *ida = attr->uid;
634                 if( ida ) {
635                         if( strcmp( ida, aid ) == 0 ) {
636                                 attrib = attr;
637                         }
638                 }
639                 node = g_list_next( node );
640         }
641         return attrib;
642 }
643
644 /**
645  * Remove attribute with specified ID from person.
646  * \param  person Person object.
647  * \param  aid    Attribute ID to remove.
648  * \return UserAttribute object, or <i>NULL</i> if not found. Note that
649  *         attribute object should still be freed after calling this method.
650  */
651 UserAttribute *addritem_person_remove_attrib_id(
652                         ItemPerson *person, const gchar *aid )
653 {
654         UserAttribute *attrib = NULL;
655         GList *node;
656
657         g_return_val_if_fail( person != NULL, NULL );
658         if( aid == NULL || *aid == '\0' ) return NULL;
659
660         /* Look for attribute */
661         node = person->listAttrib;
662         while( node ) {
663                 UserAttribute *attr = node->data;
664                 gchar *ida = attr->uid;
665                 if( ida ) {
666                         if( strcmp( ida, aid ) == 0 ) {
667                                 attrib = attr;
668                         }
669                 }
670                 node = g_list_next( node );
671         }
672
673         /* Remove email from person's address list */
674         if( person->listAttrib ) {
675                 person->listAttrib = g_list_remove( person->listAttrib, attrib );
676         }
677         return attrib;
678 }
679
680 /**
681  * Remove attribute from person.
682  * \param  person Person.
683  * \param  attrib Attribute to remove.
684  * \return UserAttribute object to remove. Note that attribute object should
685  *         still be freed.
686  */
687 UserAttribute *addritem_person_remove_attribute(
688                         ItemPerson *person, UserAttribute *attrib )
689 {
690         gboolean found = FALSE;
691         GList *node;
692
693         g_return_val_if_fail( person != NULL, NULL );
694         if( attrib == NULL ) return NULL;
695
696         /* Look for attribute */
697         node = person->listAttrib;
698         while( node ) {
699                 if( node-> data == attrib ) {
700                         found = TRUE;
701                         break;
702                 }
703                 node = g_list_next( node );
704         }
705
706         if( found ) {
707                 /* Remove attribute */
708                 if( person->listAttrib ) {
709                         person->listAttrib = g_list_remove( person->listAttrib, attrib );
710                 }
711         }
712         return attrib;
713 }
714
715 /**
716  * Create new address book group object.
717  * \return Initialized group object.
718  */
719 ItemGroup *addritem_create_item_group( void ) {
720         ItemGroup *group;
721
722         group = g_new0( ItemGroup, 1 );
723         ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
724         ADDRITEM_ID(group) = NULL;
725         ADDRITEM_NAME(group) = NULL;
726         ADDRITEM_PARENT(group) = NULL;
727         ADDRITEM_SUBTYPE(group) = 0;
728         group->remarks = NULL;
729         group->listEMail = NULL;
730         return group;
731 }
732
733 /**
734  * Copy (deep copy) address book group.
735  * \param  item Group to copy.
736  * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
737  */
738 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
739         ItemGroup *itemNew;
740
741         itemNew = g_new0( ItemGroup, 1 );
742         if( item ) {
743                 itemNew = addritem_create_item_group();
744                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
745                 itemNew->remarks = g_strdup( item->remarks );
746         }
747         return itemNew;
748 }
749
750 /**
751  * Specify ID to be used for group.
752  * \param group Group object.
753  * \param value ID of group.
754  */
755 void addritem_group_set_id( ItemGroup *group, const gchar *value ) {
756         ADDRITEM_ID(group) = mgu_replace_string( ADDRITEM_ID(group), value );
757 }
758
759 /**
760  * Specify name to be used for group.
761  * \param group Group object.
762  * \param value Name of group.
763  */
764 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
765         ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
766 }
767
768 /**
769  * Specify remarks to be used for group.
770  * \param group Group object.
771  * \param value Remarks for group.
772  */
773 void addritem_group_set_remarks( ItemGroup *group, const gchar *value ) {
774         group->remarks = mgu_replace_string( group->remarks, value );
775 }
776
777 /**
778  * Free address group object.
779  * \param group Group to free.
780  */
781 void addritem_free_item_group( ItemGroup *group ) {
782         g_return_if_fail( group != NULL );
783
784         /* Free internal stuff */
785         g_free( ADDRITEM_ID(group) );
786         g_free( ADDRITEM_NAME(group) );
787         g_free( group->remarks );
788         mgu_clear_list( group->listEMail );
789         g_list_free( group->listEMail );
790
791         ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
792         ADDRITEM_ID(group) = NULL;
793         ADDRITEM_NAME(group) = NULL;
794         ADDRITEM_PARENT(group) = NULL;
795         ADDRITEM_SUBTYPE(group) = 0;
796         group->remarks = NULL;
797         group->listEMail = NULL;
798
799         g_free( group );
800 }
801
802 /**
803  * Add EMail address to group. Note that a reference to an E-Mail item is
804  * added to a group. A person object is the only container that for an
805  * address.
806  * \param  group Group.
807  * \param  email E-Mail object.
808  * \return <i>TRUE</i> if email item added.
809  */
810 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
811         GList *node;
812
813         g_return_val_if_fail( group != NULL, FALSE );
814         g_return_val_if_fail( email != NULL, FALSE );
815
816         node = group->listEMail;
817         while( node ) {
818                 if( node->data == email ) return FALSE;
819                 node = g_list_next( node );
820         }
821         group->listEMail = g_list_append( group->listEMail, email );
822         return TRUE;
823 }
824
825 /**
826  * Remove email address object for specified group.
827  * \param  group Group from which to remove address.
828  * \param  email EMail to remove
829  * \return EMail object, or <i>NULL if email not found in group. Note that
830  *         this object is referenced (linked) to a group and should *NOT*
831  *         be freed. An E-Mail object object should only be freed after
832  *         removing from a person.
833  */
834 ItemEMail *addritem_group_remove_email( ItemGroup *group, ItemEMail *email ) {
835         if( group && email ) {
836                 GList *node = group->listEMail;
837                 while( node ) {
838                         if( node->data == email ) {
839                                 group->listEMail = g_list_remove( group->listEMail, email );
840                                 return email;
841                         }
842                         node = g_list_next( node );
843                 }
844         }
845         return NULL;
846 }
847
848 /**
849  * Remove email address of specified ID for specified group.
850  * \param  group Group from which to remove address.
851  * \param  eid  EMail ID.
852  * \return EMail object, or <i>NULL</i> if email not found in group. Note that
853  *         this object is referenced (linked) to a group and should *NOT* be
854  *         freed. An E-Mail object should only be freed after removing from a
855  *         person.
856  */
857 ItemEMail *addritem_group_remove_email_id( ItemGroup *group, const gchar *eid ) {
858         if( group ) {
859                 GList *node = group->listEMail;
860                 while( node ) {
861                         ItemEMail *email = ( ItemEMail * ) node->data;
862                         if( strcmp( ADDRITEM_ID( email ), eid ) == 0 ) {
863                                 group->listEMail = g_list_remove( group->listEMail, email );
864                                 return email;
865                         }
866                         node = g_list_next( node );
867                 }
868         }
869         return NULL;
870 }
871
872 /**
873  * Print address group item for debug.
874  * \param group  Group to print.
875  * \param stream Output stream.
876  */
877 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
878         GList *node;
879         ItemPerson *person;
880         ItemEMail *item;
881         g_return_if_fail( group != NULL );
882         fprintf( stream, "Group:\n" );
883         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
884         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
885         fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
886         fprintf( stream, "\trem: '%s'\n", group->remarks );
887         fprintf( stream, "\t---\n" );
888         node = group->listEMail;
889         while( node ) {
890                 item = node->data;
891                 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
892                 if( person ) {
893                         fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
894                         fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
895                 }
896                 else {
897                         fprintf( stream, "\t\tpid : ???\n" );
898                         fprintf( stream, "\t\tcomn: ???\n" );
899                 }
900                 addritem_print_item_email( item, stream );
901                 node = g_list_next( node );
902         }
903         fprintf( stream, "\t***\n" );
904 }
905
906 /**
907  * Create new address folder.
908  * \return Initialized address folder object.
909  */
910 ItemFolder *addritem_create_item_folder( void ) {
911         ItemFolder *folder;
912         folder = g_new0( ItemFolder, 1 );
913         ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
914         ADDRITEM_ID(folder) = NULL;
915         ADDRITEM_NAME(folder) = NULL;
916         ADDRITEM_PARENT(folder) = NULL;
917         ADDRITEM_SUBTYPE(folder) = 0;
918         folder->remarks = NULL;
919         folder->isRoot = FALSE;
920         folder->listItems = NULL;
921         folder->listFolder = NULL;
922         folder->listPerson = NULL;
923         folder->listGroup = NULL;
924         folder->folderType = ADDRFOLDER_NONE;
925         folder->folderData = NULL;
926         return folder;
927 }
928
929 /**
930  * Copy address book folder. Note that only the folder and not its contents are
931  * copied.
932  * \param  item Folder to copy.
933  * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
934  */
935 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
936         ItemFolder *itemNew;
937
938         itemNew = g_new0( ItemFolder, 1 );
939         if( item ) {
940                 itemNew = addritem_create_item_folder();
941                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
942                 itemNew->folderType = item->folderType;
943         }
944         return itemNew;
945 }
946
947 /**
948  * Specify ID to be used for folder.
949  * \param folder Folder.
950  * \param value  ID.
951  */
952 void addritem_folder_set_id( ItemFolder *folder, const gchar *value ) {
953         ADDRITEM_ID(folder) = mgu_replace_string( ADDRITEM_ID(folder), value );
954 }
955
956 /**
957  * Specify name to be used for folder.
958  * \param folder Folder.
959  * \param value  Name.
960  */
961 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
962         ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
963 }
964
965 /**
966  * Specify remarks to be used for folder.
967  * \param folder Folder.
968  * \param value  Remarks.
969  */
970 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
971         folder->remarks = mgu_replace_string( folder->remarks, value );
972 }
973
974 /**
975  * Free address folder. Note: this does not free up the lists of children
976  * (folders, groups and person). This should be done prior to calling this
977  * function.
978  * \param folder Folder to free.
979  */
980 void addritem_free_item_folder( ItemFolder *folder ) {
981         g_return_if_fail( folder != NULL );
982
983         /* Free internal stuff */
984         g_free( ADDRITEM_ID(folder) );
985         g_free( ADDRITEM_NAME(folder) );
986         g_free( folder->remarks );
987         mgu_clear_list( folder->listItems );
988         g_list_free( folder->listItems );
989
990         ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
991         ADDRITEM_ID(folder) = NULL;
992         ADDRITEM_NAME(folder) = NULL;
993         ADDRITEM_PARENT(folder) = NULL;
994         ADDRITEM_SUBTYPE(folder) = 0;
995         folder->isRoot = FALSE;
996         folder->remarks = NULL;
997         folder->listItems = NULL;
998         folder->listFolder = NULL;
999         folder->listGroup = NULL;
1000         folder->listPerson = NULL;
1001         folder->folderType = ADDRFOLDER_NONE;
1002         folder->folderData = NULL;
1003
1004         g_free( folder );
1005 }
1006
1007 /**
1008  * Free up folders recursively. Note: this only frees up the lists of
1009  * children and *NOT* the children objects (folders, groups and person).
1010  * This should be done prior to calling this function.
1011  * \param parent Parent folder object to be processed.
1012  */
1013 void addritem_free_item_folder_recurse( ItemFolder *parent ) {
1014         GList *node = parent->listFolder;
1015
1016         while( node ) {
1017                 ItemFolder *folder = node->data;
1018                 addritem_free_item_folder_recurse( folder );
1019                 node = g_list_next( node );
1020         }
1021         g_list_free( parent->listPerson );
1022         g_list_free( parent->listGroup );
1023         g_list_free( parent->listFolder );
1024         parent->listPerson = NULL;
1025         parent->listGroup = NULL;
1026         parent->listFolder = NULL;
1027 }
1028
1029 /**
1030  * Free up list of person objects contained in specified folder.
1031  * \param folder Folder to process.
1032  */
1033 void addritem_folder_free_person( ItemFolder *folder ) {
1034         GList *node;
1035
1036         g_return_if_fail( folder != NULL );
1037         
1038         /* Free up folder of persons. */
1039         node = folder->listPerson;
1040         while( node ) {
1041                 ItemPerson *person = node->data;
1042                 addritem_free_item_person( person );
1043                 person = NULL;
1044                 node = g_list_next( node );
1045         }
1046 }
1047
1048 /**
1049  * Add person into folder.
1050  * \param  folder Folder.
1051  * \param  item   Person to add.
1052  * \return <i>TRUE</i> if person added.
1053  */
1054 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
1055         g_return_val_if_fail( folder != NULL, FALSE );
1056         g_return_val_if_fail( item != NULL, FALSE );
1057
1058         folder->listPerson = g_list_append( folder->listPerson, item );
1059         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
1060         return TRUE;
1061 }
1062
1063 /**
1064  * Add folder into folder.
1065  * \param  folder Folder.
1066  * \param  item   Folder to add.
1067  * \return <i>TRUE</i> if folder added.
1068  */
1069 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
1070         g_return_val_if_fail( folder != NULL, FALSE );
1071         g_return_val_if_fail( item != NULL, FALSE );
1072
1073         folder->listFolder = g_list_append( folder->listFolder, item );
1074         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
1075         return TRUE;
1076 }
1077
1078 /**
1079  * Add group into folder.
1080  * \param  folder Folder.
1081  * \param  item   Group to add.
1082  * \return <i>TRUE</i> if group added.
1083  */
1084 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
1085         g_return_val_if_fail( folder != NULL, FALSE );
1086         g_return_val_if_fail( item != NULL, FALSE );
1087
1088         folder->listGroup = g_list_append( folder->listGroup, item );
1089         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
1090         return TRUE;
1091 }
1092
1093 /**
1094  * Print address folder item contents for debug.
1095  * \param folder Folder to process.
1096  * \param stream Output stream.
1097  */
1098 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
1099         GList *node;
1100         /* ItemPerson *person; */
1101         ItemFolder *parent;
1102
1103         g_return_if_fail( folder != NULL );
1104
1105         fprintf( stream, "Folder:\n" );
1106         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
1107         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
1108         fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
1109         fprintf( stream, "\trem: '%s'\n", folder->remarks );
1110         fprintf( stream, "\ttyp: %d\n", folder->folderType );
1111         fprintf( stream, "\t---\n" );
1112         parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
1113         if( parent ) {
1114                 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
1115         }
1116         else {
1117                 fprintf( stream, "\tpar: NULL\n" );
1118         }
1119         node = folder->listFolder;
1120         while( node ) {
1121                 AddrItemObject *aio = node->data;
1122                 if( aio ) {
1123                         if( aio->type == ITEMTYPE_FOLDER ) {
1124                                 ItemFolder *item = ( ItemFolder * ) aio;
1125                                 addritem_print_item_folder( item, stream );
1126                         }
1127                 }
1128                 else {
1129                         fprintf( stream, "\t\tpid : ???\n" );
1130                 }
1131
1132                 node = g_list_next( node );
1133         }
1134
1135         node = folder->listPerson;
1136         while( node ) {
1137                 AddrItemObject *aio = node->data;
1138                 if( aio ) {
1139                         if( aio->type == ITEMTYPE_PERSON ) {
1140                                 ItemPerson *item = ( ItemPerson * ) aio;
1141                                 addritem_print_item_person( item, stream );
1142                         }
1143                 }
1144                 else {
1145                         fprintf( stream, "\t\tpid : ???\n" );
1146                 }
1147
1148                 node = g_list_next( node );
1149         }
1150
1151         node = folder->listGroup;
1152         while( node ) {
1153                 AddrItemObject *aio = node->data;
1154                 if( aio ) {
1155                         if( aio->type == ITEMTYPE_GROUP ) {
1156                                 ItemGroup *item = ( ItemGroup * ) aio;
1157                                 addritem_print_item_group( item, stream );
1158                         }
1159                 }
1160                 else {
1161                         fprintf( stream, "\t\tpid : ???\n" );
1162                 }
1163                 node = g_list_next( node );
1164         }
1165         fprintf( stream, "\t###\n" );
1166 }
1167
1168 /**
1169  * Print address item for debug.
1170  * \param aio    Address item to format.
1171  * \param stream Output stream.
1172  */
1173 void addritem_print_item( AddrItemObject *aio, FILE *stream ) {
1174         g_return_if_fail( aio != NULL );
1175
1176         if( aio->type == ITEMTYPE_PERSON ) {
1177                 ItemPerson *item = ( ItemPerson * ) aio;
1178                 addritem_print_item_person( item, stream );
1179         }
1180         else if( aio->type == ITEMTYPE_EMAIL ) {
1181                 ItemEMail *item = ( ItemEMail * ) aio;
1182                 addritem_print_item_email( item, stream );
1183         }
1184         else if( aio->type == ITEMTYPE_GROUP ) {
1185                 ItemGroup *item = ( ItemGroup * ) aio;
1186                 addritem_print_item_group( item, stream );
1187         }
1188         else if( aio->type == ITEMTYPE_FOLDER ) {
1189                 ItemFolder *item = ( ItemFolder * ) aio;
1190                 addritem_print_item_folder( item, stream );
1191         }
1192 }
1193
1194 /**
1195  * Return link list of persons for specified folder. Note that the list contains
1196  * references to items and should be g_free() when done. Do *NOT* attempt to use the
1197  * addritem_free_xxx() functions... this will destroy the addressbook data!
1198  *
1199  * \param  folder Folder to process.
1200  * \return List of items, or <i>NULL</i> if none.
1201  */
1202 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
1203         GList *list = NULL;
1204         GList *node = NULL;
1205
1206         g_return_val_if_fail( folder != NULL, NULL );
1207
1208         node = folder->listPerson;
1209         while( node ) {
1210                 ItemPerson *person = node->data;
1211                 list = g_list_append( list, person );
1212                 node = g_list_next( node );
1213         }
1214         return list;
1215 }
1216
1217 /**
1218  * Return link list of groups for specified folder. Note that the list contains
1219  * references to items and should be g_free() when done. Do *NOT* attempt to use the
1220  * addritem_free_xxx() functions... this will destroy the addressbook data!
1221  *
1222  * \param  folder Folder to process.
1223  * \return List of items, or <i>NULL</i> if none.
1224  */
1225 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
1226         GList *list = NULL;
1227         GList *node = NULL;
1228
1229         g_return_val_if_fail( folder != NULL, NULL );
1230
1231         node = folder->listGroup;
1232         while( node ) {
1233                 ItemGroup *group = node->data;
1234                 list = g_list_append( list, group );
1235                 node = g_list_next( node );
1236         }
1237         return list;
1238 }
1239
1240 /**
1241  * Move person's email item.
1242  * \param  person     Person.
1243  * \param  itemMove   Item to move.
1244  * \param  itemTarget Target item before which to move item.
1245  * \return Reference to item that was moved, or <i>NULL</i> if null arguments
1246  *         supplied.
1247  */
1248
1249 ItemEMail *addritem_move_email_before(
1250                 ItemPerson *person, ItemEMail *itemMove, ItemEMail *itemTarget )
1251 {
1252         gint posT, posM;
1253
1254         g_return_val_if_fail( person != NULL, NULL );
1255
1256         if( itemTarget == NULL ) return NULL;
1257         if( itemMove == NULL ) return NULL;
1258         if( itemMove == itemTarget ) return itemMove;
1259
1260         posT = g_list_index( person->listEMail, itemTarget );
1261         if( posT < 0 ) return NULL;
1262         posM = g_list_index( person->listEMail, itemMove );
1263         if( posM < 0 ) return NULL;
1264         person->listEMail = g_list_remove( person->listEMail, itemMove );
1265         person->listEMail = g_list_insert( person->listEMail, itemMove, posT );
1266         return itemMove;
1267 }
1268
1269 /**
1270  * Move person's email item.
1271  * \param  person    Person.
1272  * \param  itemMove  Item to move.
1273  * \param  itemTarget Target item after which to move item.
1274  * \return Reference to item that was moved, or <i>NULL</i> if null arguments
1275  *         supplied.
1276  */
1277 ItemEMail *addritem_move_email_after(
1278                 ItemPerson *person, ItemEMail *itemMove, ItemEMail *itemTarget )
1279 {
1280         gint posT, posM;
1281
1282         g_return_val_if_fail( person != NULL, NULL );
1283
1284         if( itemTarget == NULL ) return NULL;
1285         if( itemMove == NULL ) return NULL;
1286         if( itemMove == itemTarget ) return itemMove;
1287
1288         posT = g_list_index( person->listEMail, itemTarget );
1289         if( posT < 0 ) return NULL;
1290         posM = g_list_index( person->listEMail, itemMove );
1291         if( posM < 0 ) return NULL;
1292         person->listEMail = g_list_remove( person->listEMail, itemMove );
1293         person->listEMail = g_list_insert( person->listEMail, itemMove, 1+posT );
1294         return itemMove;
1295 }
1296
1297 /**
1298  * Parse first and last names for person from common name.
1299  * \param person Person to process.
1300  */
1301 void addritem_parse_first_last( ItemPerson *person ) {
1302         gchar *name;
1303         gchar *fName, *lName;
1304         gchar *p;
1305         gint len, i;
1306
1307         g_return_if_fail( person != NULL );
1308
1309         name = ADDRITEM_NAME(person);
1310         if( name == NULL ) return;
1311
1312         fName = NULL;
1313         lName = NULL;
1314         p = strchr( name, ',' );
1315         if( p ) {
1316                 len = ( size_t ) ( p - name );
1317                 lName = g_strndup( name, len );
1318                 fName = g_strdup( p + 1 );
1319         }
1320         else {
1321                 /* Other way around */
1322                 i = strlen( name );
1323                 while( i >= 0 ) {
1324                         if( name[i] == ' ' ) {
1325                                 fName = g_strndup( name, i );
1326                                 lName = g_strdup( &name[i] );
1327                                 break;
1328                         }
1329                         i--;
1330                 }
1331                 if( fName == NULL ) {
1332                         fName = g_strdup( name );
1333                 }
1334         }
1335
1336         if( person->firstName ) {
1337                 g_free( person->firstName );
1338         }
1339         person->firstName = fName;
1340         if( person->firstName )
1341                 g_strstrip( person->firstName );
1342
1343         if( person->lastName ) {
1344                 g_free( person->lastName );
1345         }
1346         person->lastName = lName;
1347         if( person->lastName )
1348                 g_strstrip( person->lastName );
1349 }
1350
1351 /**
1352  * Build a path of all ancestor folders for specified folder.
1353  * \param  folder Folder.
1354  * \param  seq    Path sequence, FALSE top down, TRUE bottom up.
1355  * \return List of folders from the top down.
1356  */
1357 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1358         GList *list;
1359         AddrItemObject *item;
1360
1361         list = NULL;
1362         item = ( AddrItemObject * ) folder;
1363         if( seq ) {
1364                 while( item ) {
1365                         list = g_list_prepend( list, item );
1366                         item = ADDRITEM_PARENT( item );
1367                 }
1368         }
1369         else {
1370                 while( item ) {
1371                         list = g_list_append( list, item );
1372                         item = ADDRITEM_PARENT( item );
1373                 }
1374         }
1375         return list;
1376 }
1377
1378 /**
1379  * Format E-Mail address.
1380  * \param email EMail item to format.
1381  * \return Formatted string. Should be freed after use.
1382  */
1383 gchar *addritem_format_email( ItemEMail *email ) {
1384         gchar *address;
1385         gchar *name;
1386         ItemPerson *person;
1387
1388         address = NULL;
1389         name = NULL;
1390         if( ADDRITEM_NAME( email ) ) {
1391                 if( strlen( ADDRITEM_NAME( email ) ) ) {
1392                         name = ADDRITEM_NAME( email );
1393                 }
1394         }
1395         if( ! name ) {
1396                 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1397                 name = ADDRITEM_NAME( person );
1398         }
1399
1400         if( name ) {
1401                 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1402                         address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1403                 }
1404                 else {
1405                         address = g_strdup_printf( "%s <%s>", name, email->address );
1406                 }
1407         }
1408         else {
1409                 address = g_strdup_printf( "%s", email->address );
1410         }
1411         return address;
1412 }
1413
1414 /*
1415 * End of Source.
1416 */