2007-01-23 [colin] 2.7.1cvs52
[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  * Free linked list of item addresses; both addresses and the list are freed.
343  * It is assumed that addresses are *NOT* contained within some other
344  * container.
345  * \param list List of addresses to be freed.
346  */
347 void addritem_free_list_email( GList *list ) {
348         GList *node = list;
349         while( node ) {
350                 ItemEMail *email = node->data;
351
352                 addritem_free_item_email( email );
353                 node->data = NULL;
354                 node = g_list_next( node );
355         }
356         g_list_free( list );
357         list = NULL;
358 }
359
360 /**
361  * Free linked list of attributes; both attributes and the list are freed.
362  * It is assumed that attributes are *NOT* contained within some other
363  * container.
364  * \param list List of attributes to be freed.
365  */
366 void addritem_free_list_attribute( GList *list ) {
367         GList *node = list;
368         while( node ) {
369                 addritem_free_attribute( node->data );
370                 node->data = NULL;
371                 node = g_list_next( node );
372         }
373         g_list_free( list );
374 }
375
376 /**
377  * Free address person object.
378  * \param person Person object to free.
379  */
380 void addritem_free_item_person( ItemPerson *person ) {
381         g_return_if_fail( person != NULL );
382
383         /* Free internal stuff */
384         g_free( ADDRITEM_ID(person) );
385         g_free( ADDRITEM_NAME(person) );
386         g_free( person->firstName );
387         g_free( person->lastName );
388         g_free( person->nickName );
389         g_free( person->externalID );
390         g_list_free( person->listEMail );
391         addritem_free_list_attribute( person->listAttrib );
392
393         ADDRITEM_OBJECT(person)->type = ITEMTYPE_NONE;
394         ADDRITEM_ID(person) = NULL;
395         ADDRITEM_NAME(person) = NULL;
396         ADDRITEM_PARENT(person) = NULL;
397         ADDRITEM_SUBTYPE(person) = 0;
398         person->firstName = NULL;
399         person->lastName = NULL;
400         person->nickName = NULL;
401         person->externalID = NULL;
402         person->listEMail = NULL;
403         person->listAttrib = NULL;
404
405         g_free( person );
406 }
407
408 /**
409  * Print E-Mail address object for debug.
410  * \param item   Item to print.
411  * \param stream Output stream.
412  */
413 void addritem_print_item_email( ItemEMail *item, FILE *stream ) {
414         g_return_if_fail( item != NULL );
415         fprintf( stream, "\t\tt/id: %d : '%s'\n", ADDRITEM_TYPE(item), ADDRITEM_ID(item) );
416         fprintf( stream, "\t\tsubty: %d\n", ADDRITEM_SUBTYPE(item) );
417         fprintf( stream, "\t\talis: '%s'\n", ADDRITEM_NAME(item) );
418         fprintf( stream, "\t\taddr: '%s'\n", item->address );
419         fprintf( stream, "\t\trems: '%s'\n", item->remarks );
420         fprintf( stream, "\t\t---\n" );
421 }
422
423 /**
424  * Print user attribute object for debug.
425  * \param item   Attribute to print.
426  * \param stream Output stream.
427  */
428 static void addritem_print_attribute( UserAttribute *item, FILE *stream ) {
429         g_return_if_fail( item != NULL );
430         fprintf( stream, "\t\tuid  : '%s'\n", item->uid );
431         fprintf( stream, "\t\tname : '%s'\n", item->name );
432         fprintf( stream, "\t\tvalue: '%s'\n", item->value );
433         fprintf( stream, "\t\t---\n" );
434 }
435
436 /**
437  * Print person item for debug.
438  * \param person Person to print.
439  * \param stream Output stream.
440  */
441 void addritem_print_item_person( ItemPerson *person, FILE *stream ) {
442         GList *node;
443         g_return_if_fail( person != NULL );
444         fprintf( stream, "Person:\n" );
445         fprintf( stream, "\tt/uid: %d : '%s'\n", ADDRITEM_TYPE(person), ADDRITEM_ID(person) );
446         fprintf( stream, "\tsubty: %d\n", ADDRITEM_SUBTYPE(person) );
447         fprintf( stream, "\tcommn: '%s'\n", ADDRITEM_NAME(person) );
448         fprintf( stream, "\tfirst: '%s'\n", person->firstName );
449         fprintf( stream, "\tlast : '%s'\n", person->lastName );
450         fprintf( stream, "\tnick : '%s'\n", person->nickName );
451         fprintf( stream, "\textID: '%s'\n", person->externalID );
452         fprintf( stream, "\teMail:\n" );
453         fprintf( stream, "\t---\n" );
454         node = person->listEMail;
455         while( node ) {
456                 addritem_print_item_email( node->data, stream );
457                 node = g_list_next( node );
458         }
459         fprintf( stream, "\tuAttr:\n" );
460         fprintf( stream, "\t---\n" );
461         node = person->listAttrib;
462         while( node ) {
463                 addritem_print_attribute( node->data, stream );
464                 node = g_list_next( node );
465         }
466         fprintf( stream, "\t===\n" );
467 }
468
469 /**
470  * Add E-Mail address object to person.
471  * \param  person Person.
472  * \param  email  E-Mail object to add.
473  * \return <i>TRUE</i> if E-Mail added.
474  */
475 gboolean addritem_person_add_email( ItemPerson *person, ItemEMail *email ) {
476         GList *node;
477
478         g_return_val_if_fail( person != NULL, FALSE );
479         g_return_val_if_fail( email != NULL, FALSE );
480
481         node = person->listEMail;
482         while( node ) {
483                 if( node->data == email ) return FALSE;
484                 node = g_list_next( node );
485         }
486         person->listEMail = g_list_append( person->listEMail, email );
487         ADDRITEM_PARENT(email) = ADDRITEM_OBJECT(person);
488         return TRUE;
489 }
490
491 /**
492  * Remove email address for specified person.
493  * \param  person Person.
494  * \param  email  EMail to remove.
495  * \return EMail object, or <i>NULL</i> if not found. Note that object should
496  *         still be freed after calling this method.
497  */
498 ItemEMail *addritem_person_remove_email( ItemPerson *person, ItemEMail *email ) {
499         gboolean found = FALSE;
500         GList *node;
501
502         g_return_val_if_fail( person != NULL, NULL );
503         if( email == NULL ) return NULL;
504
505         /* Look for email */
506         node = person->listEMail;
507         while( node ) {
508                 if( node-> data == email ) {
509                         found = TRUE;
510                         break;
511                 }
512                 node = g_list_next( node );
513         }
514
515         if( found ) {
516                 /* Remove email from person's address list */
517                 if( person->listEMail ) {
518                         person->listEMail = g_list_remove( person->listEMail, email );
519                 }
520                 /* Unlink reference to person. */
521                 ADDRITEM_PARENT(email) = NULL;
522                 return email;
523         }
524         return NULL;
525 }
526
527 /**
528  * Add user attribute to specified person.
529  * \param  person Person.
530  * \param  attrib Attribute to add.
531  * \return <i>TRUE</i> if item added.
532  */
533 void addritem_person_add_attribute(
534                         ItemPerson *person, UserAttribute *attrib )
535 {
536         g_return_if_fail( person != NULL );
537         person->listAttrib = g_list_append( person->listAttrib, attrib );
538 }
539
540 /**
541  * Create new address book group object.
542  * \return Initialized group object.
543  */
544 ItemGroup *addritem_create_item_group( void ) {
545         ItemGroup *group;
546
547         group = g_new0( ItemGroup, 1 );
548         ADDRITEM_TYPE(group) = ITEMTYPE_GROUP;
549         ADDRITEM_ID(group) = NULL;
550         ADDRITEM_NAME(group) = NULL;
551         ADDRITEM_PARENT(group) = NULL;
552         ADDRITEM_SUBTYPE(group) = 0;
553         group->remarks = NULL;
554         group->listEMail = NULL;
555         return group;
556 }
557
558 /**
559  * Copy (deep copy) address book group.
560  * \param  item Group to copy.
561  * \return Copy of the group object, or <i>NULL</i> if null argument supplied.
562  */
563 ItemGroup *addritem_copy_item_group( ItemGroup *item ) {
564         ItemGroup *itemNew;
565
566         itemNew = g_new0( ItemGroup, 1 );
567         if( item ) {
568                 itemNew = addritem_create_item_group();
569                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
570                 itemNew->remarks = g_strdup( item->remarks );
571         }
572         return itemNew;
573 }
574
575 /**
576  * Specify name to be used for group.
577  * \param group Group object.
578  * \param value Name of group.
579  */
580 void addritem_group_set_name( ItemGroup *group, const gchar *value ) {
581         ADDRITEM_NAME(group) = mgu_replace_string( ADDRITEM_NAME(group), value );
582 }
583
584 /**
585  * Free address group object.
586  * \param group Group to free.
587  */
588 void addritem_free_item_group( ItemGroup *group ) {
589         g_return_if_fail( group != NULL );
590
591         /* Free internal stuff */
592         g_free( ADDRITEM_ID(group) );
593         g_free( ADDRITEM_NAME(group) );
594         g_free( group->remarks );
595         mgu_clear_list( group->listEMail );
596         g_list_free( group->listEMail );
597
598         ADDRITEM_TYPE(group) = ITEMTYPE_NONE;
599         ADDRITEM_ID(group) = NULL;
600         ADDRITEM_NAME(group) = NULL;
601         ADDRITEM_PARENT(group) = NULL;
602         ADDRITEM_SUBTYPE(group) = 0;
603         group->remarks = NULL;
604         group->listEMail = NULL;
605
606         g_free( group );
607 }
608
609 /**
610  * Add EMail address to group. Note that a reference to an E-Mail item is
611  * added to a group. A person object is the only container that for an
612  * address.
613  * \param  group Group.
614  * \param  email E-Mail object.
615  * \return <i>TRUE</i> if email item added.
616  */
617 gboolean addritem_group_add_email( ItemGroup *group, ItemEMail *email ) {
618         GList *node;
619
620         g_return_val_if_fail( group != NULL, FALSE );
621         g_return_val_if_fail( email != NULL, FALSE );
622
623         node = group->listEMail;
624         while( node ) {
625                 if( node->data == email ) return FALSE;
626                 node = g_list_next( node );
627         }
628         group->listEMail = g_list_append( group->listEMail, email );
629         return TRUE;
630 }
631
632 /**
633  * Remove person object for specified group.
634  * \param  group Group from which to remove address.
635  * \param  email EMail to remove
636  * \return EMail object, or <i>NULL if email not found in group. Note that
637  *         this object is referenced (linked) to a group and should *NOT*
638  *         be freed. An E-Mail object object should only be freed after
639  *         removing from a person.
640  */
641 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person ) {
642         if( group && person ) {
643                 GList *node = group->listPerson;
644                 while( node ) {
645                         if( node->data == person ) {
646                                 group->listPerson = g_list_remove( group->listPerson, person );
647                                 return person;
648                         }
649                         node = g_list_next( node );
650                 }
651         }
652         return NULL;
653 }
654
655 /**
656  * Print address group item for debug.
657  * \param group  Group to print.
658  * \param stream Output stream.
659  */
660 void addritem_print_item_group( ItemGroup *group, FILE *stream ) {
661         GList *node;
662         ItemPerson *person;
663         ItemEMail *item;
664         g_return_if_fail( group != NULL );
665         fprintf( stream, "Group:\n" );
666         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(group), ADDRITEM_ID(group) );
667         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(group) );
668         fprintf( stream, "\tgrp: '%s'\n", ADDRITEM_NAME(group) );
669         fprintf( stream, "\trem: '%s'\n", group->remarks );
670         fprintf( stream, "\t---\n" );
671         node = group->listEMail;
672         while( node ) {
673                 item = node->data;
674                 person = ( ItemPerson * ) ADDRITEM_PARENT(item);
675                 if( person ) {
676                         fprintf( stream, "\t\tpid : '%s'\n", ADDRITEM_ID(person) );
677                         fprintf( stream, "\t\tcomn: '%s'\n", ADDRITEM_NAME(person) );
678                 }
679                 else {
680                         fprintf( stream, "\t\tpid : ???\n" );
681                         fprintf( stream, "\t\tcomn: ???\n" );
682                 }
683                 addritem_print_item_email( item, stream );
684                 node = g_list_next( node );
685         }
686         fprintf( stream, "\t***\n" );
687 }
688
689 /**
690  * Create new address folder.
691  * \return Initialized address folder object.
692  */
693 ItemFolder *addritem_create_item_folder( void ) {
694         ItemFolder *folder;
695         folder = g_new0( ItemFolder, 1 );
696         ADDRITEM_TYPE(folder) = ITEMTYPE_FOLDER;
697         ADDRITEM_ID(folder) = NULL;
698         ADDRITEM_NAME(folder) = NULL;
699         ADDRITEM_PARENT(folder) = NULL;
700         ADDRITEM_SUBTYPE(folder) = 0;
701         folder->remarks = NULL;
702         folder->isRoot = FALSE;
703         folder->listItems = NULL;
704         folder->listFolder = NULL;
705         folder->listPerson = NULL;
706         folder->listGroup = NULL;
707         folder->folderType = ADDRFOLDER_NONE;
708         folder->folderData = NULL;
709         folder->isHidden = FALSE;
710         return folder;
711 }
712
713 /**
714  * Copy address book folder. Note that only the folder and not its contents are
715  * copied.
716  * \param  item Folder to copy.
717  * \return A copy of the folder, or <i>NULL</i> if null argument supplied.
718  */
719 ItemFolder *addritem_copy_item_folder( ItemFolder *item ) {
720         ItemFolder *itemNew;
721
722         itemNew = g_new0( ItemFolder, 1 );
723         if( item ) {
724                 itemNew = addritem_create_item_folder();
725                 ADDRITEM_NAME(itemNew) = g_strdup( ADDRITEM_NAME(item) );
726                 itemNew->folderType = item->folderType;
727         }
728         return itemNew;
729 }
730
731 /**
732  * Specify name to be used for folder.
733  * \param folder Folder.
734  * \param value  Name.
735  */
736 void addritem_folder_set_name( ItemFolder *folder, const gchar *value ) {
737         ADDRITEM_NAME(folder) = mgu_replace_string( ADDRITEM_NAME(folder), value );
738 }
739
740 /**
741  * Specify remarks to be used for folder.
742  * \param folder Folder.
743  * \param value  Remarks.
744  */
745 void addritem_folder_set_remarks( ItemFolder *folder, const gchar *value ) {
746         folder->remarks = mgu_replace_string( folder->remarks, value );
747 }
748
749 /**
750  * Specify visibility of folder.
751  * \param folder Folder.
752  * \param value  Set to <code>TRUE</code> to hide folder.
753  */
754 void addritem_folder_set_hidden( ItemFolder *folder, const gboolean value ) {
755         folder->isHidden = value;
756 }
757
758 /**
759  * Free address folder. Note: this does not free up the lists of children
760  * (folders, groups and person). This should be done prior to calling this
761  * function.
762  * \param folder Folder to free.
763  */
764 void addritem_free_item_folder( ItemFolder *folder ) {
765         g_return_if_fail( folder != NULL );
766
767         /* Free internal stuff */
768         g_free( ADDRITEM_ID(folder) );
769         g_free( ADDRITEM_NAME(folder) );
770         g_free( folder->remarks );
771         mgu_clear_list( folder->listItems );
772         g_list_free( folder->listItems );
773
774         ADDRITEM_TYPE(folder) = ITEMTYPE_NONE;
775         ADDRITEM_ID(folder) = NULL;
776         ADDRITEM_NAME(folder) = NULL;
777         ADDRITEM_PARENT(folder) = NULL;
778         ADDRITEM_SUBTYPE(folder) = 0;
779         folder->isRoot = FALSE;
780         folder->remarks = NULL;
781         folder->listItems = NULL;
782         folder->listFolder = NULL;
783         folder->listGroup = NULL;
784         folder->listPerson = NULL;
785         folder->folderType = ADDRFOLDER_NONE;
786         folder->folderData = NULL;
787         folder->isHidden = FALSE;
788
789         g_free( folder );
790 }
791
792 /**
793  * Free up folders recursively. Note: this only frees up the lists of
794  * children and *NOT* the children objects (folders, groups and person).
795  * This should be done prior to calling this function.
796  * \param parent Parent folder object to be processed.
797  */
798 static void addritem_free_item_folder_recurse( ItemFolder *parent ) {
799         GList *node = parent->listFolder;
800
801         while( node ) {
802                 ItemFolder *folder = node->data;
803                 addritem_free_item_folder_recurse( folder );
804                 node = g_list_next( node );
805         }
806         g_list_free( parent->listPerson );
807         g_list_free( parent->listGroup );
808         g_list_free( parent->listFolder );
809         parent->listPerson = NULL;
810         parent->listGroup = NULL;
811         parent->listFolder = NULL;
812 }
813
814 /**
815  * Add person into folder.
816  * \param  folder Folder.
817  * \param  item   Person to add.
818  * \return <i>TRUE</i> if person added.
819  */
820 gboolean addritem_folder_add_person( ItemFolder *folder, ItemPerson *item ) {
821         g_return_val_if_fail( folder != NULL, FALSE );
822         g_return_val_if_fail( item != NULL, FALSE );
823
824         folder->listPerson = g_list_append( folder->listPerson, item );
825         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
826         return TRUE;
827 }
828
829 /**
830  * Add folder into folder.
831  * \param  folder Folder.
832  * \param  item   Folder to add.
833  * \return <i>TRUE</i> if folder added.
834  */
835 gboolean addritem_folder_add_folder( ItemFolder *folder, ItemFolder *item ) {
836         g_return_val_if_fail( folder != NULL, FALSE );
837         g_return_val_if_fail( item != NULL, FALSE );
838
839         folder->listFolder = g_list_append( folder->listFolder, item );
840         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
841         return TRUE;
842 }
843
844 /**
845  * Add group into folder.
846  * \param  folder Folder.
847  * \param  item   Group to add.
848  * \return <i>TRUE</i> if group added.
849  */
850 gboolean addritem_folder_add_group( ItemFolder *folder, ItemGroup *item ) {
851         g_return_val_if_fail( folder != NULL, FALSE );
852         g_return_val_if_fail( item != NULL, FALSE );
853
854         folder->listGroup = g_list_append( folder->listGroup, item );
855         ADDRITEM_PARENT(item) = ADDRITEM_OBJECT(folder);
856         return TRUE;
857 }
858
859 /**
860  * Print address folder item contents for debug.
861  * \param folder Folder to process.
862  * \param stream Output stream.
863  */
864 void addritem_print_item_folder( ItemFolder *folder, FILE *stream ) {
865         GList *node;
866         /* ItemPerson *person; */
867         ItemFolder *parent;
868
869         g_return_if_fail( folder != NULL );
870
871         fprintf( stream, "Folder:\n" );
872         fprintf( stream, "\tt/u: %d : '%s'\n", ADDRITEM_TYPE(folder), ADDRITEM_ID(folder) );
873         fprintf( stream, "\tsub: %d\n", ADDRITEM_SUBTYPE(folder) );
874         fprintf( stream, "\tnam: '%s'\n", ADDRITEM_NAME(folder) );
875         fprintf( stream, "\trem: '%s'\n", folder->remarks );
876         fprintf( stream, "\ttyp: %d\n", folder->folderType );
877         fprintf( stream, "\thid: %s\n", folder->isHidden ? "hidden" : "visible" );
878         fprintf( stream, "\t---\n" );
879         parent = ( ItemFolder * ) ADDRITEM_PARENT(folder);
880         if( parent ) {
881                 fprintf( stream, "\tpar: %s : %s\n", ADDRITEM_ID(parent), ADDRITEM_NAME(parent) );
882         }
883         else {
884                 fprintf( stream, "\tpar: NULL\n" );
885         }
886         node = folder->listFolder;
887         while( node ) {
888                 AddrItemObject *aio = node->data;
889                 if( aio ) {
890                         if( aio->type == ITEMTYPE_FOLDER ) {
891                                 ItemFolder *item = ( ItemFolder * ) aio;
892                                 addritem_print_item_folder( item, stream );
893                         }
894                 }
895                 else {
896                         fprintf( stream, "\t\tpid : ???\n" );
897                 }
898
899                 node = g_list_next( node );
900         }
901
902         node = folder->listPerson;
903         while( node ) {
904                 AddrItemObject *aio = node->data;
905                 if( aio ) {
906                         if( aio->type == ITEMTYPE_PERSON ) {
907                                 ItemPerson *item = ( ItemPerson * ) aio;
908                                 addritem_print_item_person( item, stream );
909                         }
910                 }
911                 else {
912                         fprintf( stream, "\t\tpid : ???\n" );
913                 }
914
915                 node = g_list_next( node );
916         }
917
918         node = folder->listGroup;
919         while( node ) {
920                 AddrItemObject *aio = node->data;
921                 if( aio ) {
922                         if( aio->type == ITEMTYPE_GROUP ) {
923                                 ItemGroup *item = ( ItemGroup * ) aio;
924                                 addritem_print_item_group( item, stream );
925                         }
926                 }
927                 else {
928                         fprintf( stream, "\t\tpid : ???\n" );
929                 }
930                 node = g_list_next( node );
931         }
932         fprintf( stream, "\t###\n" );
933 }
934
935 /**
936  * Return link list of persons for specified folder. Note that the list contains
937  * references to items and should be g_free() when done. Do *NOT* attempt to use the
938  * addritem_free_xxx() functions... this will destroy the addressbook data!
939  *
940  * \param  folder Folder to process.
941  * \return List of items, or <i>NULL</i> if none.
942  */
943 GList *addritem_folder_get_person_list( ItemFolder *folder ) {
944         GList *list = NULL;
945         GList *node = NULL;
946
947         g_return_val_if_fail( folder != NULL, NULL );
948
949         node = folder->listPerson;
950         while( node ) {
951                 ItemPerson *person = node->data;
952                 list = g_list_append( list, person );
953                 node = g_list_next( node );
954         }
955         return list;
956 }
957
958 /**
959  * Return link list of groups for specified folder. Note that the list contains
960  * references to items and should be g_free() when done. Do *NOT* attempt to use the
961  * addritem_free_xxx() functions... this will destroy the addressbook data!
962  *
963  * \param  folder Folder to process.
964  * \return List of items, or <i>NULL</i> if none.
965  */
966 GList *addritem_folder_get_group_list( ItemFolder *folder ) {
967         GList *list = NULL;
968         GList *node = NULL;
969
970         g_return_val_if_fail( folder != NULL, NULL );
971
972         node = folder->listGroup;
973         while( node ) {
974                 ItemGroup *group = node->data;
975                 list = g_list_append( list, group );
976                 node = g_list_next( node );
977         }
978         return list;
979 }
980
981 /**
982  * Parse first and last names for person from common name.
983  * \param person Person to process.
984  */
985 void addritem_parse_first_last( ItemPerson *person ) {
986         gchar *name;
987         gchar *fName, *lName;
988         gchar *p;
989         gint len, i;
990
991         g_return_if_fail( person != NULL );
992
993         name = ADDRITEM_NAME(person);
994         if( name == NULL ) return;
995
996         fName = NULL;
997         lName = NULL;
998         p = strchr( name, ',' );
999         if( p ) {
1000                 len = ( size_t ) ( p - name );
1001                 lName = g_strndup( name, len );
1002                 fName = g_strdup( p + 1 );
1003         }
1004         else {
1005                 /* Other way around */
1006                 i = strlen( name );
1007                 while( i >= 0 ) {
1008                         if( name[i] == ' ' ) {
1009                                 fName = g_strndup( name, i );
1010                                 lName = g_strdup( &name[i] );
1011                                 break;
1012                         }
1013                         i--;
1014                 }
1015                 if( fName == NULL ) {
1016                         fName = g_strdup( name );
1017                 }
1018         }
1019
1020         g_free( person->firstName );
1021         person->firstName = fName;
1022         if( person->firstName )
1023                 g_strstrip( person->firstName );
1024
1025         g_free( person->lastName );
1026         person->lastName = lName;
1027         if( person->lastName )
1028                 g_strstrip( person->lastName );
1029 }
1030
1031 /**
1032  * Build a path of all ancestor folders for specified folder.
1033  * \param  folder Folder.
1034  * \param  seq    Path sequence, FALSE top down, TRUE bottom up.
1035  * \return List of folders from the top down.
1036  */
1037 GList *addritem_folder_path( const ItemFolder *folder, const gboolean seq ) {
1038         GList *list;
1039         AddrItemObject *item;
1040
1041         list = NULL;
1042         item = ( AddrItemObject * ) folder;
1043         if( seq ) {
1044                 while( item ) {
1045                         list = g_list_prepend( list, item );
1046                         item = ADDRITEM_PARENT( item );
1047                 }
1048         }
1049         else {
1050                 while( item ) {
1051                         list = g_list_append( list, item );
1052                         item = ADDRITEM_PARENT( item );
1053                 }
1054         }
1055         return list;
1056 }
1057
1058 /**
1059  * Format E-Mail address.
1060  * \param email EMail item to format.
1061  * \return Formatted string. Should be freed after use.
1062  */
1063 gchar *addritem_format_email( ItemEMail *email ) {
1064         gchar *address;
1065         gchar *name;
1066         ItemPerson *person;
1067
1068         address = NULL;
1069         name = NULL;
1070         if( ADDRITEM_NAME( email ) ) {
1071                 if( strlen( ADDRITEM_NAME( email ) ) ) {
1072                         name = ADDRITEM_NAME( email );
1073                 }
1074         }
1075         if( ! name ) {
1076                 person = ( ItemPerson * ) ADDRITEM_PARENT( email );
1077                 name = ADDRITEM_NAME( person );
1078         }
1079
1080         if( name ) {
1081                 if( strchr_with_skip_quote( name, '"', ',' ) ) {
1082                         address = g_strdup_printf( "\"%s\" <%s>", name, email->address );
1083                 }
1084                 else {
1085                         address = g_strdup_printf( "%s <%s>", name, email->address );
1086                 }
1087         }
1088         else {
1089                 address = g_strdup_printf( "%s", email->address );
1090         }
1091         return address;
1092 }
1093
1094 /*
1095 * End of Source.
1096 */