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