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