lib/silcapputil/silcidcache.c

   1 /*
   2
   3   silcidcache.c
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2000 - 2006 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19 /* $Id$ */
  20
  21 #include "silc.h"
  22 #include "silcidcache.h"
  23
  24 /************************** Types and definitions ***************************/
  25
  26 /* ID Cache context */
  27 struct SilcIDCacheStruct {
  28   SilcHashTable id_table;            /* ID hash table */
  29   SilcHashTable name_table;          /* Name hash table */
  30   SilcHashTable context_table;       /* Context hash table */
  31   SilcIDCacheDestructor destructor;  /* Entry destructor */
  32   void *context;                     /* Destructor context */
  33   SilcIdType id_type;                /* Type of ID cache */
  34 };
  35
  36
  37 /************************ Static utility functions **************************/
  38
  39 /* Callback that is called by the hash table routine when traversing
  40    entries in the hash table. */
  41
  42 static void silc_idcache_get_all_foreach(void *key, void *context,
  43                                          void *user_context)
  44 {
  45   SilcList *list = user_context;
  46   if (!context)
  47     return;
  48   silc_list_add(*list, context);
  49 }
  50
  51 /* Cache entry destructor */
  52
  53 static void silc_idcache_destructor(SilcIDCache cache,
  54                                     SilcIDCacheEntry entry,
  55                                     void *app_context)
  56 {
  57   if (cache->destructor)
  58     cache->destructor(cache, entry, cache->destructor, app_context);
  59
  60   memset(entry, 'F', sizeof(*entry));
  61   silc_free(entry);
  62 }
  63
  64
  65 /****************************** Public API **********************************/
  66
  67 /* Allocates new ID cache object. */
  68
  69 SilcIDCache silc_idcache_alloc(SilcUInt32 count, SilcIdType id_type,
  70                                SilcIDCacheDestructor destructor,
  71                                void *destructor_context)
  72 {
  73   SilcIDCache cache;
  74
  75   SILC_LOG_DEBUG(("Allocating new cache"));
  76
  77   cache = silc_calloc(1, sizeof(*cache));
  78   if (!cache)
  79     return NULL;
  80
  81   cache->id_table = silc_hash_table_alloc(count, silc_hash_id,
  82                                           SILC_32_TO_PTR(id_type),
  83                                           silc_hash_id_compare,
  84                                           SILC_32_TO_PTR(id_type),
  85                                           NULL, NULL, TRUE);
  86   cache->name_table = silc_hash_table_alloc(count, silc_hash_utf8_string, NULL,
  87                                             silc_hash_utf8_compare, NULL,
  88                                             NULL, NULL, TRUE);
  89   cache->context_table = silc_hash_table_alloc(count, silc_hash_ptr, NULL,
  90                                                NULL, NULL, NULL, NULL, TRUE);
  91   cache->destructor = destructor;
  92   cache->context = destructor_context;
  93   cache->id_type = id_type;
  94
  95   if (!cache->id_table || !cache->name_table || !cache->context_table) {
  96     if (cache->id_table)
  97       silc_hash_table_free(cache->id_table);
  98     if (cache->name_table)
  99       silc_hash_table_free(cache->name_table);
 100     if (cache->context_table)
 101       silc_hash_table_free(cache->context_table);
 102     silc_free(cache);
 103     return NULL;
 104   }
 105
 106   return cache;
 107 }
 108
 109 /* Frees ID cache object and cache entries */
 110
 111 void silc_idcache_free(SilcIDCache cache)
 112 {
 113   silc_hash_table_free(cache->id_table);
 114   silc_hash_table_free(cache->name_table);
 115   silc_hash_table_free(cache->context_table);
 116   silc_free(cache);
 117 }
 118
 119 /* Add new entry to cache */
 120
 121 SilcIDCacheEntry
 122 silc_idcache_add(SilcIDCache cache, char *name, void *id, void *context)
 123 {
 124   SilcIDCacheEntry c;
 125
 126   if (!id)
 127     return NULL;
 128
 129   /* Allocate new cache entry */
 130   c = silc_calloc(1, sizeof(*c));
 131   if (!c)
 132     return NULL;
 133
 134   c->id = id;
 135   c->name = name;
 136   c->context = context;
 137
 138   SILC_LOG_DEBUG(("Adding cache entry %p", c));
 139
 140   /* Add the new entry to the hash tables */
 141
 142   if (id) {
 143     if (silc_idcache_find_by_id_one(cache, id, NULL)) {
 144       SILC_LOG_ERROR(("Attempted to add same ID twice to ID Cache, id %s",
 145                      silc_id_render(id, cache->id_type)));
 146       SILC_ASSERT(FALSE);
 147       goto err;
 148     }
 149     if (!silc_hash_table_add(cache->id_table, id, c))
 150       goto err;
 151   }
 152   if (name)
 153     if (!silc_hash_table_add(cache->name_table, name, c))
 154       goto err;
 155   if (context)
 156     if (!silc_hash_table_add(cache->context_table, context, c))
 157       goto err;
 158
 159   return c;
 160
 161  err:
 162   if (c->name)
 163     silc_hash_table_del_by_context(cache->name_table, c->name, c);
 164   if (c->context)
 165     silc_hash_table_del_by_context(cache->context_table, c->context, c);
 166   if (c->id)
 167     silc_hash_table_del_by_context(cache->id_table, c->id, c);
 168   silc_free(c);
 169
 170   return NULL;
 171 }
 172
 173 /* Delete cache entry from cache. */
 174
 175 SilcBool silc_idcache_del(SilcIDCache cache, SilcIDCacheEntry entry,
 176                           void *app_context)
 177 {
 178   SilcBool ret = FALSE;
 179
 180   SILC_LOG_DEBUG(("Deleting cache entry %p", entry));
 181
 182   if (entry->name)
 183     ret = silc_hash_table_del_by_context(cache->name_table, entry->name,
 184                                          entry);
 185   if (entry->context)
 186     ret = silc_hash_table_del_by_context(cache->context_table, entry->context,
 187                                          entry);
 188   if (entry->id)
 189     ret = silc_hash_table_del_by_context(cache->id_table, entry->id,
 190                                          entry);
 191
 192   if (ret)
 193     silc_idcache_destructor(cache, entry, app_context);
 194
 195   return ret;
 196 }
 197
 198 /* Deletes ID cache entry by ID. */
 199
 200 SilcBool silc_idcache_del_by_id(SilcIDCache cache, void *id,
 201                                 void *app_context)
 202 {
 203   SilcIDCacheEntry c;
 204
 205   if (!silc_hash_table_find(cache->id_table, id, NULL, (void **)&c))
 206     return FALSE;
 207
 208   return silc_idcache_del(cache, c, app_context);
 209 }
 210
 211 /* Deletes ID cache entry by context. */
 212
 213 SilcBool silc_idcache_del_by_context(SilcIDCache cache, void *context,
 214                                      void *app_context)
 215 {
 216   SilcIDCacheEntry c;
 217
 218   if (!silc_hash_table_find(cache->context_table, context, NULL, (void **)&c))
 219     return FALSE;
 220
 221   return silc_idcache_del(cache, c, app_context);
 222 }
 223
 224 /* Update entry */
 225
 226 SilcBool silc_idcache_update(SilcIDCache cache, SilcIDCacheEntry entry,
 227                              void *new_id, char *new_name,
 228                              SilcBool free_old_name)
 229 {
 230   if (new_id) {
 231     if (!silc_hash_table_del_by_context(cache->id_table, entry->id, entry))
 232       return FALSE;
 233
 234     if (cache->id_type == SILC_ID_CLIENT)
 235       *(SilcClientID *)entry->id = *(SilcClientID *)new_id;
 236     if (cache->id_type == SILC_ID_SERVER)
 237       *(SilcServerID *)entry->id = *(SilcServerID *)new_id;
 238     if (cache->id_type == SILC_ID_CHANNEL)
 239       *(SilcChannelID *)entry->id = *(SilcChannelID *)new_id;
 240
 241     if (!silc_hash_table_add(cache->id_table, entry->id, entry))
 242       return FALSE;
 243   }
 244
 245   if (new_name) {
 246     if (!silc_hash_table_del_by_context(cache->name_table, entry->name, entry))
 247       return FALSE;
 248
 249     if (free_old_name)
 250       silc_free(entry->name);
 251     entry->name = new_name;
 252
 253     if (!silc_hash_table_add(cache->name_table, entry->name, entry))
 254       return FALSE;
 255   }
 256
 257   return TRUE;
 258 }
 259
 260 /* Update entry by context */
 261
 262 SilcBool silc_idcache_update_by_context(SilcIDCache cache, void *context,
 263                                         void *new_id, char *new_name,
 264                                         SilcBool free_old_name)
 265 {
 266   SilcIDCacheEntry c;
 267
 268   if (!silc_hash_table_find(cache->context_table, context, NULL, (void **)&c))
 269     return FALSE;
 270
 271   return silc_idcache_update(cache, c, new_id, new_name, free_old_name);
 272 }
 273
 274 /* Returns all cache entrys from the ID cache to the `ret' ID Cache List. */
 275
 276 SilcBool silc_idcache_get_all(SilcIDCache cache, SilcList *ret_list)
 277 {
 278   if (!ret_list)
 279     return FALSE;
 280
 281   if (!silc_hash_table_count(cache->id_table))
 282     return FALSE;
 283
 284   silc_hash_table_foreach(cache->id_table, silc_idcache_get_all_foreach,
 285                           ret_list);
 286
 287   if (!silc_list_count(*ret_list))
 288     return FALSE;
 289
 290   return TRUE;
 291 }
 292
 293 /* Find ID Cache entry by ID. May return multiple entries. */
 294
 295 SilcBool silc_idcache_find_by_id(SilcIDCache cache, void *id,
 296                                  SilcList *ret_list)
 297 {
 298   if (!ret_list)
 299     return FALSE;
 300
 301   if (!silc_hash_table_count(cache->id_table))
 302     return FALSE;
 303
 304   silc_hash_table_find_foreach(cache->id_table, id,
 305                                silc_idcache_get_all_foreach, ret_list);
 306
 307   if (!silc_list_count(*ret_list))
 308     return FALSE;
 309
 310   return TRUE;
 311 }
 312
 313 /* Find one specific ID entry.  Compare full IDs */
 314
 315 SilcBool silc_idcache_find_by_id_one(SilcIDCache cache, void *id,
 316                                      SilcIDCacheEntry *ret)
 317 {
 318   return silc_hash_table_find_ext(cache->id_table, id, NULL, (void *)ret,
 319                                   NULL, NULL,
 320                                   silc_hash_id_compare_full,
 321                                   SILC_32_TO_PTR(cache->id_type));
 322 }
 323
 324 /* Finds cache entry by context. */
 325
 326 SilcBool silc_idcache_find_by_context(SilcIDCache cache, void *context,
 327                                       SilcIDCacheEntry *ret)
 328 {
 329   return silc_hash_table_find(cache->context_table, context, NULL,
 330                               (void *)ret);
 331 }
 332
 333 /* Find ID Cache entry by name. Returns list of cache entries. */
 334
 335 SilcBool silc_idcache_find_by_name(SilcIDCache cache, char *name,
 336                                    SilcList *ret_list)
 337 {
 338   if (!ret_list)
 339     return FALSE;
 340
 341   if (!silc_hash_table_count(cache->name_table))
 342     return FALSE;
 343
 344   silc_hash_table_find_foreach(cache->name_table, name,
 345                                silc_idcache_get_all_foreach, ret_list);
 346
 347   if (!silc_list_count(*ret_list))
 348     return FALSE;
 349
 350   return TRUE;
 351 }
 352
 353 /* Find ID Cache entry by name. Returns one cache entry. */
 354
 355 SilcBool silc_idcache_find_by_name_one(SilcIDCache cache, char *name,
 356                                        SilcIDCacheEntry *ret)
 357 {
 358   return silc_hash_table_find(cache->name_table, name, NULL, (void *)ret);
 359 }