src/addrcache.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001 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  * Definitions for address cache.
  22  */
  23
  24 #ifndef __ADDRCACHE_H__
  25 #define __ADDRCACHE_H__
  26
  27 #include <time.h>
  28 #include <stdio.h>
  29 #include <glib.h>
  30 #include "addritem.h"
  31
  32 // Address book file.
  33 typedef struct _AddressCache AddressCache;
  34 struct _AddressCache {
  35         gint       nextID;
  36         gboolean   dataRead;
  37         gboolean   modified;
  38         time_t     modifyTime;
  39         GHashTable *itemHash;
  40         GList      *tempList;
  41         ItemFolder *rootFolder;
  42 };
  43
  44 // Function prototypes
  45 AddressCache *addrcache_create();
  46 ItemFolder *addrcache_get_root_folder   ( AddressCache *cache );
  47 GList *addrcache_get_list_folder        ( AddressCache *cache );
  48 GList *addrcache_get_list_person        ( AddressCache *cache );
  49
  50 void addrcache_refresh                  ( AddressCache *cache );
  51 void addrcache_empty                    ( AddressCache *cache );
  52 void addrcache_free                     ( AddressCache *cache );
  53 gboolean addrcache_check_file           ( AddressCache *cache, gchar *path );
  54 gboolean addrcache_mark_file            ( AddressCache *cache, gchar *path );
  55
  56 void addrcache_print_item_list          ( GList *list, FILE *stream );
  57 void addrcache_print                    ( AddressCache *cache, FILE *stream );
  58 void addrcache_dump_hash                ( AddressCache *cache, FILE *stream );
  59
  60 void addrcache_id_person                ( AddressCache *cache, ItemPerson *person );
  61 void addrcache_id_group                 ( AddressCache *cache, ItemGroup *group );
  62 void addrcache_id_folder                ( AddressCache *cache, ItemFolder *folder );
  63 void addrcache_id_email                 ( AddressCache *cache, ItemEMail *email );
  64 void addrcache_id_attribute             ( AddressCache *cache, UserAttribute *attrib );
  65
  66 gboolean addrcache_hash_add_person      ( AddressCache *cache, ItemPerson *person );
  67 gboolean addrcache_hash_add_group       ( AddressCache *cache, ItemGroup *group );
  68 gboolean addrcache_hash_add_folder      ( AddressCache *cache, ItemFolder *folder );
  69
  70 gboolean addrcache_folder_add_person    ( AddressCache *cache, ItemFolder *folder, ItemPerson *item );
  71 gboolean addrcache_folder_add_folder    ( AddressCache *cache, ItemFolder *folder, ItemFolder *item );
  72 gboolean addrcache_folder_add_group     ( AddressCache *cache, ItemFolder *folder, ItemGroup *item );
  73
  74 gboolean addrcache_add_person           ( AddressCache *cache, ItemPerson *person );
  75 gboolean addrcache_add_group            ( AddressCache *cache, ItemGroup *group );
  76 gboolean addrcache_person_add_email     ( AddressCache *cache, ItemPerson *person, ItemEMail *email );
  77 gboolean addrcache_group_add_email      ( AddressCache *cache, ItemGroup *group, ItemEMail *email );
  78 gboolean addrcache_add_folder           ( AddressCache *cache, ItemFolder *folder );
  79
  80 AddrItemObject *addrcache_get_object    ( AddressCache *cache, const gchar *uid );
  81 ItemPerson *addrcache_get_person        ( AddressCache *cache, const gchar *uid );
  82 ItemGroup *addrcache_get_group          ( AddressCache *cache, const gchar *uid );
  83 ItemEMail *addrcache_get_email          ( AddressCache *cache, const gchar *uid, const gchar *eid );
  84
  85 UserAttribute *addrcache_person_remove_attrib_id        ( AddressCache *cache, const gchar *uid,
  86                                                           const gchar *aid );
  87 UserAttribute *addrcache_person_remove_attribute        ( AddressCache *cache, ItemPerson *person,
  88                                                           UserAttribute *attrib );
  89
  90 ItemGroup *addrcache_remove_group_id            ( AddressCache *cache, const gchar *uid );
  91 ItemGroup *addrcache_remove_group               ( AddressCache *cache, ItemGroup *group );
  92
  93 ItemPerson *addrcache_remove_person_id          ( AddressCache *cache, const gchar *uid );
  94 ItemPerson *addrcache_remove_person             ( AddressCache *cache, ItemPerson *person );
  95 ItemEMail *addrcache_person_remove_email_id     ( AddressCache *cache, const gchar *uid, const gchar *eid );
  96 ItemEMail *addrcache_person_remove_email        ( AddressCache *cache, ItemPerson *person, ItemEMail *email );
  97
  98 GList *addrcache_folder_get_address_list        ( AddressCache *cache, ItemFolder *folder );
  99 GList *addrcache_folder_get_person_list         ( AddressCache *cache, ItemFolder *folder );
 100 GList *addrcache_folder_get_group_list          ( AddressCache *cache, ItemFolder *folder );
 101 GList *addrcache_folder_get_folder_list         ( AddressCache *cache, ItemFolder *folder );
 102
 103 GList *addrcache_get_address_list               ( AddressCache *cache );
 104 GList *addrcache_get_person_list                ( AddressCache *cache );
 105 GList *addrcache_get_group_list                 ( AddressCache *cache );
 106 GList *addrcache_get_folder_list                ( AddressCache *cache );
 107
 108 GList *addrcache_get_group_for_person           ( AddressCache *cache, ItemPerson *person );
 109
 110 ItemFolder *addrcache_find_root_folder          ( ItemFolder *folder );
 111 GList *addrcache_get_all_persons                ( AddressCache *cache );
 112
 113 ItemFolder *addrcache_remove_folder             ( AddressCache *cache, ItemFolder *folder );
 114 ItemFolder *addrcache_remove_folder_delete      ( AddressCache *cache, ItemFolder *folder );
 115
 116 ItemPerson *addrcache_add_contact               ( AddressCache *cache, ItemFolder *folder,
 117                                                   const gchar *name, const gchar *address,
 118                                                   const gchar *remarks );
 119
 120 #endif /* __ADDRCACHE_H__ */
 121
 122 /*
 123 * End of Source.
 124 */
 125