src/addrcache.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001-2002 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 #include "addrcindex.h"
  32
  33 /* Address cache */
  34 typedef struct _AddressCache AddressCache;
  35
  36 struct _AddressCache {
  37         gint       nextID;
  38         gboolean   dataRead;
  39         gboolean   modified;
  40         time_t     modifyTime;
  41         GHashTable *itemHash;
  42         GList      *tempList;
  43         ItemFolder *rootFolder;
  44         gchar      *cacheID;
  45         gboolean   dirtyFlag;
  46         gboolean   accessFlag;
  47         gchar      *name;
  48         AddrCacheIndex *searchIndex;
  49 };
  50
  51 /* Function prototypes */
  52 AddressCache *addrcache_create();
  53 ItemFolder *addrcache_get_root_folder   ( AddressCache *cache );
  54 GList *addrcache_get_list_folder        ( AddressCache *cache );
  55 GList *addrcache_get_list_person        ( AddressCache *cache );
  56 gboolean addrcache_get_dirty            ( AddressCache *cache );
  57 void addrcache_set_dirty                ( AddressCache *cache,
  58                                           const gboolean value );
  59 gboolean addrcache_get_modified         ( AddressCache *cache );
  60 void addrcache_set_modified             ( AddressCache *cache,
  61                                           const gboolean value );
  62 gboolean addrcache_get_read_flag        ( AddressCache *cache );
  63 void addrcache_set_read_flag            ( AddressCache *cache,
  64                                           const gboolean value );
  65 gboolean addrcache_get_accessed         ( AddressCache *cache );
  66 void addrcache_set_accessed             ( AddressCache *cache,
  67                                           const gboolean value );
  68 gchar *addrcache_get_name               ( AddressCache *cache );
  69 void addrcache_set_name                 ( AddressCache *cache,
  70                                           const gchar *value );
  71
  72 void addrcache_refresh                  ( AddressCache *cache );
  73 void addrcache_clear                    ( AddressCache *cache );
  74 void addrcache_free                     ( AddressCache *cache );
  75 gboolean addrcache_check_file           ( AddressCache *cache, gchar *path );
  76 gboolean addrcache_mark_file            ( AddressCache *cache, gchar *path );
  77
  78 void addrcache_print_item_list          ( GList *list, FILE *stream );
  79 void addrcache_print                    ( AddressCache *cache, FILE *stream );
  80 void addrcache_dump_hash                ( AddressCache *cache, FILE *stream );
  81
  82 void addrcache_id_person                ( AddressCache *cache, ItemPerson *person );
  83 void addrcache_id_group                 ( AddressCache *cache, ItemGroup *group );
  84 void addrcache_id_folder                ( AddressCache *cache, ItemFolder *folder );
  85 void addrcache_id_email                 ( AddressCache *cache, ItemEMail *email );
  86 void addrcache_id_attribute             ( AddressCache *cache, UserAttribute *attrib );
  87
  88 gboolean addrcache_hash_add_person      ( AddressCache *cache, ItemPerson *person );
  89 gboolean addrcache_hash_add_group       ( AddressCache *cache, ItemGroup *group );
  90 gboolean addrcache_hash_add_folder      ( AddressCache *cache, ItemFolder *folder );
  91
  92 gboolean addrcache_folder_add_person    ( AddressCache *cache,
  93                                           ItemFolder *folder,
  94                                           ItemPerson *item );
  95 gboolean addrcache_folder_add_folder    ( AddressCache *cache,
  96                                           ItemFolder *folder,
  97                                           ItemFolder *item );
  98 gboolean addrcache_folder_add_group     ( AddressCache *cache,
  99                                           ItemFolder *folder,
 100                                           ItemGroup *item );
 101
 102 gboolean addrcache_add_person           ( AddressCache *cache,
 103                                           ItemPerson *person );
 104 gboolean addrcache_add_group            ( AddressCache *cache,
 105                                           ItemGroup *group );
 106 gboolean addrcache_person_add_email     ( AddressCache *cache,
 107                                           ItemPerson *person,
 108                                           ItemEMail *email );
 109 gboolean addrcache_group_add_email      ( AddressCache *cache,
 110                                           ItemGroup *group,
 111                                           ItemEMail *email );
 112 gboolean addrcache_add_folder           ( AddressCache *cache,
 113                                           ItemFolder *folder );
 114
 115 void addrcache_folder_move_person       ( AddressCache *cache,
 116                                           ItemPerson *person,
 117                                           ItemFolder *target );
 118 void addrcache_folder_move_group        ( AddressCache *cache,
 119                                           ItemGroup *group,
 120                                           ItemFolder *target );
 121 void addrcache_folder_move_folder       ( AddressCache *cache,
 122                                           ItemFolder *folder,
 123                                           ItemFolder *target );
 124
 125 AddrItemObject *addrcache_get_object    ( AddressCache *cache, const gchar *uid );
 126 ItemPerson *addrcache_get_person        ( AddressCache *cache, const gchar *uid );
 127 ItemGroup *addrcache_get_group          ( AddressCache *cache, const gchar *uid );
 128 ItemEMail *addrcache_get_email          ( AddressCache *cache, const gchar *eid );
 129
 130 UserAttribute *addrcache_person_remove_attrib_id( AddressCache *cache,
 131                                                   const gchar *uid,
 132                                                   const gchar *aid );
 133 UserAttribute *addrcache_person_remove_attribute( AddressCache *cache,
 134                                                   ItemPerson *person,
 135                                                   UserAttribute *attrib );
 136
 137 ItemGroup *addrcache_remove_group       ( AddressCache *cache, ItemGroup *group );
 138 ItemPerson *addrcache_remove_person     ( AddressCache *cache, ItemPerson *person );
 139 ItemEMail *addrcache_remove_email       ( AddressCache *cache, ItemEMail *email );
 140
 141 ItemEMail *addrcache_person_remove_email( AddressCache *cache,
 142                                           ItemPerson *person,
 143                                           ItemEMail *email );
 144 void addrcache_person_move_email        ( AddressCache *cache,
 145                                           ItemEMail *email,
 146                                           ItemPerson *target );
 147
 148 GList *addrcache_folder_get_address_list( AddressCache *cache, ItemFolder *folder );
 149 GList *addrcache_folder_get_person_list ( AddressCache *cache, ItemFolder *folder );
 150 GList *addrcache_folder_get_group_list  ( AddressCache *cache, ItemFolder *folder );
 151 GList *addrcache_folder_get_folder_list ( AddressCache *cache, ItemFolder *folder );
 152
 153 GList *addrcache_get_address_list       ( AddressCache *cache );
 154 GList *addrcache_get_person_list        ( AddressCache *cache );
 155 GList *addrcache_get_group_list         ( AddressCache *cache );
 156 GList *addrcache_get_folder_list        ( AddressCache *cache );
 157
 158 GList *addrcache_get_group_for_person   ( AddressCache *cache, ItemPerson *person );
 159
 160 ItemFolder *addrcache_find_root_folder  ( ItemFolder *folder );
 161 GList *addrcache_get_all_persons        ( AddressCache *cache );
 162 GList *addrcache_get_all_groups         ( AddressCache *cache );
 163
 164 ItemFolder *addrcache_remove_folder             ( AddressCache *cache,
 165                                                   ItemFolder *folder );
 166 ItemFolder *addrcache_remove_folder_delete      ( AddressCache *cache,
 167                                                   ItemFolder *folder );
 168
 169 ItemPerson *addrcache_add_contact       ( AddressCache *cache,
 170                                           ItemFolder *folder,
 171                                           const gchar *name,
 172                                           const gchar *address,
 173                                           const gchar *remarks );
 174
 175 void addrcache_clear_index      ( AddressCache *cache );
 176 void addrcache_create_index     ( AddressCache *cache,
 177                                   gboolean value );
 178 void addrcache_build_index      ( AddressCache *cache );
 179 void addrcache_invalidate       ( AddressCache *cache );
 180
 181 #endif /* __ADDRCACHE_H__ */