lib/silcapputil/silcidcache.c

   1 /*
   2
   3   silcidcache.c
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2000 - 2007 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   if (silc_idcache_find_by_id_one(cache, id, NULL)) {
 142     SILC_LOG_ERROR(("Attempted to add same ID twice to ID Cache, id %s",
 143                    silc_id_render(id, cache->id_type)));
 144     SILC_ASSERT(FALSE);
 145     goto err;
 146   }
 147   if (!silc_hash_table_add(cache->id_table, id, c))
 148     goto err;
 149   if (name)
 150     if (!silc_hash_table_add(cache->name_table, name, c))
 151       goto err;
 152   if (context)
 153     if (!silc_hash_table_add(cache->context_table, context, c))
 154       goto err;
 155
 156   return c;
 157
 158  err:
 159   if (c->name)
 160     silc_hash_table_del_by_context(cache->name_table, c->name, c);
 161   if (c->context)
 162     silc_hash_table_del_by_context(cache->context_table, c->context, c);
 163   if (c->id)
 164     silc_hash_table_del_by_context(cache->id_table, c->id, c);
 165   silc_free(c);
 166
 167   return NULL;
 168 }
 169
 170 /* Delete cache entry from cache. */
 171
 172 SilcBool silc_idcache_del(SilcIDCache cache, SilcIDCacheEntry entry,
 173                           void *app_context)
 174 {
 175   SilcBool ret = FALSE;
 176
 177   SILC_LOG_DEBUG(("Deleting cache entry %p", entry));
 178
 179   if (entry->name)
 180     ret = silc_hash_table_del_by_context(cache->name_table, entry->name,
 181                                          entry);
 182   if (entry->context)
 183     ret = silc_hash_table_del_by_context(cache->context_table, entry->context,
 184                                          entry);
 185   if (entry->id)
 186     ret = silc_hash_table_del_by_context(cache->id_table, entry->id,
 187                                          entry);
 188
 189   if (ret)
 190     silc_idcache_destructor(cache, entry, app_context);
 191
 192   return ret;
 193 }
 194
 195 /* Deletes ID cache entry by ID. */
 196
 197 SilcBool silc_idcache_del_by_id(SilcIDCache cache, void *id,
 198                                 void *app_context)
 199 {
 200   SilcIDCacheEntry c;
 201
 202   if (!silc_hash_table_find(cache->id_table, id, NULL, (void **)&c))
 203     return FALSE;
 204
 205   return silc_idcache_del(cache, c, app_context);
 206 }
 207
 208 /* Deletes ID cache entry by context. */
 209
 210 SilcBool silc_idcache_del_by_context(SilcIDCache cache, void *context,
 211                                      void *app_context)
 212 {
 213   SilcIDCacheEntry c;
 214
 215   if (!silc_hash_table_find(cache->context_table, context, NULL, (void **)&c))
 216     return FALSE;
 217
 218   return silc_idcache_del(cache, c, app_context);
 219 }
 220
 221 /* Update entry */
 222
 223 SilcBool silc_idcache_update(SilcIDCache cache, SilcIDCacheEntry entry,
 224                              void *new_id, char *new_name,
 225                              SilcBool free_old_name)
 226 {
 227   if (new_id) {
 228     if (!silc_hash_table_del_by_context(cache->id_table, entry->id, entry))
 229       return FALSE;
 230
 231     if (cache->id_type == SILC_ID_CLIENT)
 232       *(SilcClientID *)entry->id = *(SilcClientID *)new_id;
 233     if (cache->id_type == SILC_ID_SERVER)
 234       *(SilcServerID *)entry->id = *(SilcServerID *)new_id;
 235     if (cache->id_type == SILC_ID_CHANNEL)
 236       *(SilcChannelID *)entry->id = *(SilcChannelID *)new_id;
 237
 238     if (!silc_hash_table_add(cache->id_table, entry->id, entry))
 239       return FALSE;
 240   }
 241
 242   if (new_name) {
 243     if (entry->name)
 244       if (!silc_hash_table_del_by_context(cache->name_table, entry->name,
 245                                           entry))
 246         return FALSE;
 247
 248     if (free_old_name)
 249       silc_free(entry->name);
 250     entry->name = new_name;
 251
 252     if (!silc_hash_table_add(cache->name_table, entry->name, entry))
 253       return FALSE;
 254   }
 255
 256   return TRUE;
 257 }
 258
 259 /* Update entry by context */
 260
 261 SilcBool silc_idcache_update_by_context(SilcIDCache cache, void *context,
 262                                         void *new_id, char *new_name,
 263                                         SilcBool free_old_name)
 264 {
 265   SilcIDCacheEntry c;
 266
 267   if (!silc_hash_table_find(cache->context_table, context, NULL, (void **)&c))
 268     return FALSE;
 269
 270   return silc_idcache_update(cache, c, new_id, new_name, free_old_name);
 271 }
 272
 273 /* Returns all cache entrys from the ID cache to the `ret' ID Cache List. */
 274
 275 SilcBool silc_idcache_get_all(SilcIDCache cache, SilcList *ret_list)
 276 {
 277   if (!ret_list)
 278     return FALSE;
 279
 280   if (!silc_hash_table_count(cache->id_table))
 281     return FALSE;
 282
 283   silc_list_init(*ret_list, struct SilcIDCacheEntryStruct, next);
 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_list_init(*ret_list, struct SilcIDCacheEntryStruct, next);
 305   silc_hash_table_find_foreach(cache->id_table, id,
 306                                silc_idcache_get_all_foreach, ret_list);
 307
 308   if (!silc_list_count(*ret_list))
 309     return FALSE;
 310
 311   return TRUE;
 312 }
 313
 314 /* Find one specific ID entry.  Compare full IDs */
 315
 316 SilcBool silc_idcache_find_by_id_one(SilcIDCache cache, void *id,
 317                                      SilcIDCacheEntry *ret)
 318 {
 319   return silc_hash_table_find_ext(cache->id_table, id, NULL, (void *)ret,
 320                                   NULL, NULL,
 321                                   silc_hash_id_compare_full,
 322                                   SILC_32_TO_PTR(cache->id_type));
 323 }
 324
 325 /* Finds cache entry by context. */
 326
 327 SilcBool silc_idcache_find_by_context(SilcIDCache cache, void *context,
 328                                       SilcIDCacheEntry *ret)
 329 {
 330   return silc_hash_table_find(cache->context_table, context, NULL,
 331                               (void *)ret);
 332 }
 333
 334 /* Find ID Cache entry by name. Returns list of cache entries. */
 335
 336 SilcBool silc_idcache_find_by_name(SilcIDCache cache, char *name,
 337                                    SilcList *ret_list)
 338 {
 339   if (!ret_list)
 340     return FALSE;
 341
 342   if (!silc_hash_table_count(cache->name_table))
 343     return FALSE;
 344
 345   silc_list_init(*ret_list, struct SilcIDCacheEntryStruct, next);
 346   silc_hash_table_find_foreach(cache->name_table, name,
 347                                silc_idcache_get_all_foreach, ret_list);
 348
 349   if (!silc_list_count(*ret_list))
 350     return FALSE;
 351
 352   return TRUE;
 353 }
 354
 355 /* Find ID Cache entry by name. Returns one cache entry. */
 356
 357 SilcBool silc_idcache_find_by_name_one(SilcIDCache cache, char *name,
 358                                        SilcIDCacheEntry *ret)
 359 {
 360   return silc_hash_table_find(cache->name_table, name, NULL, (void *)ret);
 361 }