2 * This file is part of GNUnet
3 * Copyright (C) 2009-2015 GNUnet e.V.
5 * GNUnet is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published
7 * by the Free Software Foundation; either version 3, or (at your
8 * option) any later version.
10 * GNUnet is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with GNUnet; see the file COPYING. If not, write to the
17 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
22 * @file namecache/plugin_namecache_flat.c
23 * @brief flat file-based namecache backend
24 * @author Martin Schanzenbach
28 #include "gnunet_namecache_plugin.h"
29 #include "gnunet_namecache_service.h"
30 #include "gnunet_gnsrecord_lib.h"
31 #include "namecache.h"
34 * Context for all functions in this plugin.
39 const struct GNUNET_CONFIGURATION_Handle *cfg;
49 struct GNUNET_CONTAINER_MultiHashMap *hm;
58 struct GNUNET_GNSRECORD_Block *block;
63 struct GNUNET_HashCode query;
68 * Initialize the database connections and associated
69 * data structures (create tables and indices
72 * @param plugin the plugin context (state for this module)
73 * @return #GNUNET_OK on success
76 database_setup (struct Plugin *plugin)
85 struct FlatFileEntry *entry;
86 struct GNUNET_DISK_FileHandle *fh;
89 GNUNET_CONFIGURATION_get_value_filename (plugin->cfg, "namecache-flat",
92 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
93 "namecache-flat", "FILENAME");
96 if (GNUNET_OK != GNUNET_DISK_file_test (afsdir))
98 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
101 GNUNET_free (afsdir);
102 return GNUNET_SYSERR;
105 /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
108 /* Load data from file into hashmap */
109 plugin->hm = GNUNET_CONTAINER_multihashmap_create (10,
111 fh = GNUNET_DISK_file_open (afsdir,
112 GNUNET_DISK_OPEN_CREATE |
113 GNUNET_DISK_OPEN_READWRITE,
114 GNUNET_DISK_PERM_USER_WRITE |
115 GNUNET_DISK_PERM_USER_READ);
118 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
119 _("Unable to initialize file: %s.\n"),
121 return GNUNET_SYSERR;
124 if (GNUNET_SYSERR == GNUNET_DISK_file_size (afsdir,
129 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
130 _("Unable to get filesize: %s.\n"),
132 return GNUNET_SYSERR;
138 buffer = GNUNET_malloc (size);
140 if (GNUNET_SYSERR == GNUNET_DISK_file_read (fh,
144 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
145 _("Unable to read file: %s.\n"),
147 return GNUNET_SYSERR;
150 GNUNET_DISK_file_close (fh);
152 line = strtok (buffer, "\n");
153 while (line != NULL) {
154 query = strtok (line, ",");
157 block = strtok (NULL, ",");
160 line = strtok (NULL, "\n");
161 entry = GNUNET_malloc (sizeof (struct FlatFileEntry));
162 GNUNET_CRYPTO_hash_from_string (query,
164 GNUNET_STRINGS_base64_decode (block,
167 entry->block = (struct GNUNET_GNSRECORD_Block *) block_buffer;
169 GNUNET_CONTAINER_multihashmap_put (plugin->hm,
172 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
179 GNUNET_free (buffer);
184 * Store values in hashmap in file and free data
186 * @param plugin the plugin context
189 store_and_free_entries (void *cls,
190 const struct GNUNET_HashCode *key,
193 struct GNUNET_DISK_FileHandle *fh = cls;
194 struct FlatFileEntry *entry = value;
198 struct GNUNET_CRYPTO_HashAsciiEncoded query;
201 block_size = ntohl (entry->block->purpose.size) +
202 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) +
203 sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
205 GNUNET_STRINGS_base64_encode ((char*)entry->block,
208 GNUNET_CRYPTO_hash_to_enc (&entry->query,
210 GNUNET_asprintf (&line,
215 GNUNET_free (block_b64);
217 GNUNET_DISK_file_write (fh,
221 GNUNET_free (entry->block);
227 * Shutdown database connection and associate data
229 * @param plugin the plugin context (state for this module)
232 database_shutdown (struct Plugin *plugin)
234 struct GNUNET_DISK_FileHandle *fh;
235 fh = GNUNET_DISK_file_open (plugin->fn,
236 GNUNET_DISK_OPEN_CREATE |
237 GNUNET_DISK_OPEN_TRUNCATE |
238 GNUNET_DISK_OPEN_READWRITE,
239 GNUNET_DISK_PERM_USER_WRITE |
240 GNUNET_DISK_PERM_USER_READ);
243 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
244 _("Unable to initialize file: %s.\n"),
249 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
250 &store_and_free_entries,
252 GNUNET_CONTAINER_multihashmap_destroy (plugin->hm);
253 GNUNET_DISK_file_close (fh);
258 expire_blocks (void *cls,
259 const struct GNUNET_HashCode *key,
262 struct Plugin *plugin = cls;
263 struct FlatFileEntry *entry = value;
264 struct GNUNET_TIME_Absolute now;
265 struct GNUNET_TIME_Absolute expiration;
267 now = GNUNET_TIME_absolute_get ();
268 expiration = GNUNET_TIME_absolute_ntoh (entry->block->expiration_time);
270 if (0 == GNUNET_TIME_absolute_get_difference (now,
271 expiration).rel_value_us)
273 GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm, key);
281 * Removes any expired block.
283 * @param plugin the plugin
286 namecache_expire_blocks (struct Plugin *plugin)
288 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
295 * Cache a block in the datastore.
297 * @param cls closure (internal context for the plugin)
298 * @param block block to cache
299 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
302 namecache_cache_block (void *cls,
303 const struct GNUNET_GNSRECORD_Block *block)
305 struct Plugin *plugin = cls;
306 struct GNUNET_HashCode query;
307 struct FlatFileEntry *entry;
310 namecache_expire_blocks (plugin);
311 GNUNET_CRYPTO_hash (&block->derived_key,
312 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey),
314 block_size = ntohl (block->purpose.size) +
315 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) +
316 sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
317 if (block_size > 64 * 65536)
320 return GNUNET_SYSERR;
322 entry = GNUNET_malloc (sizeof (struct FlatFileEntry));
323 entry->block = GNUNET_malloc (block_size);
324 memcpy (entry->block, block, block_size);
325 GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm, &query);
327 GNUNET_CONTAINER_multihashmap_put (plugin->hm,
330 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
334 return GNUNET_SYSERR;
336 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
337 "Caching block under derived key `%s'\n",
338 GNUNET_h2s_full (&query));
344 * Get the block for a particular zone and label in the
345 * datastore. Will return at most one result to the iterator.
347 * @param cls closure (internal context for the plugin)
348 * @param query hash of public key derived from the zone and the label
349 * @param iter function to call with the result
350 * @param iter_cls closure for @a iter
351 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
354 namecache_lookup_block (void *cls,
355 const struct GNUNET_HashCode *query,
356 GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls)
358 struct Plugin *plugin = cls;
359 const struct GNUNET_GNSRECORD_Block *block;
361 block = GNUNET_CONTAINER_multihashmap_get (plugin->hm, query);
364 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
365 "Found block under derived key `%s'\n",
366 GNUNET_h2s_full (query));
367 iter (iter_cls, block);
373 * Entry point for the plugin.
375 * @param cls the "struct GNUNET_NAMECACHE_PluginEnvironment*"
376 * @return NULL on error, otherwise the plugin context
379 libgnunet_plugin_namecache_flat_init (void *cls)
381 static struct Plugin plugin;
382 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
383 struct GNUNET_NAMECACHE_PluginFunctions *api;
385 if (NULL != plugin.cfg)
386 return NULL; /* can only initialize once! */
387 memset (&plugin, 0, sizeof (struct Plugin));
389 if (GNUNET_OK != database_setup (&plugin))
391 database_shutdown (&plugin);
394 api = GNUNET_new (struct GNUNET_NAMECACHE_PluginFunctions);
396 api->cache_block = &namecache_cache_block;
397 api->lookup_block = &namecache_lookup_block;
398 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
399 _("flat plugin running\n"));
405 * Exit point from the plugin.
407 * @param cls the plugin context (as returned by "init")
408 * @return always NULL
411 libgnunet_plugin_namecache_flat_done (void *cls)
413 struct GNUNET_NAMECACHE_PluginFunctions *api = cls;
414 struct Plugin *plugin = api->cls;
416 database_shutdown (plugin);
419 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
420 "flat plugin is finished\n");
424 /* end of plugin_namecache_sqlite.c */