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 GNUNET_DISK_file_close (fh);
133 return GNUNET_SYSERR;
138 GNUNET_DISK_file_close (fh);
142 buffer = GNUNET_malloc (size + 1);
144 if (GNUNET_SYSERR == GNUNET_DISK_file_read (fh,
148 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
149 _("Unable to read file: %s.\n"),
151 GNUNET_free (buffer);
152 GNUNET_DISK_file_close (fh);
153 return GNUNET_SYSERR;
157 GNUNET_DISK_file_close (fh);
160 line = strtok (buffer, "\n");
161 while (line != NULL) {
162 query = strtok (line, ",");
165 block = strtok (NULL, ",");
168 line = strtok (NULL, "\n");
169 entry = GNUNET_malloc (sizeof (struct FlatFileEntry));
170 GNUNET_assert (GNUNET_OK == GNUNET_CRYPTO_hash_from_string (query,
172 GNUNET_STRINGS_base64_decode (block,
175 entry->block = (struct GNUNET_GNSRECORD_Block *) block_buffer;
177 GNUNET_CONTAINER_multihashmap_put (plugin->hm,
180 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
187 GNUNET_free (buffer);
192 * Store values in hashmap in file and free data
194 * @param plugin the plugin context
197 store_and_free_entries (void *cls,
198 const struct GNUNET_HashCode *key,
201 struct GNUNET_DISK_FileHandle *fh = cls;
202 struct FlatFileEntry *entry = value;
206 struct GNUNET_CRYPTO_HashAsciiEncoded query;
209 block_size = ntohl (entry->block->purpose.size) +
210 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) +
211 sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
213 GNUNET_STRINGS_base64_encode ((char*)entry->block,
216 GNUNET_CRYPTO_hash_to_enc (&entry->query,
218 GNUNET_asprintf (&line,
223 GNUNET_free (block_b64);
225 GNUNET_DISK_file_write (fh,
229 GNUNET_free (entry->block);
236 * Shutdown database connection and associate data
238 * @param plugin the plugin context (state for this module)
241 database_shutdown (struct Plugin *plugin)
243 struct GNUNET_DISK_FileHandle *fh;
244 fh = GNUNET_DISK_file_open (plugin->fn,
245 GNUNET_DISK_OPEN_CREATE |
246 GNUNET_DISK_OPEN_TRUNCATE |
247 GNUNET_DISK_OPEN_READWRITE,
248 GNUNET_DISK_PERM_USER_WRITE |
249 GNUNET_DISK_PERM_USER_READ);
252 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
253 _("Unable to initialize file: %s.\n"),
258 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
259 &store_and_free_entries,
261 GNUNET_CONTAINER_multihashmap_destroy (plugin->hm);
262 GNUNET_DISK_file_close (fh);
267 expire_blocks (void *cls,
268 const struct GNUNET_HashCode *key,
271 struct Plugin *plugin = cls;
272 struct FlatFileEntry *entry = value;
273 struct GNUNET_TIME_Absolute now;
274 struct GNUNET_TIME_Absolute expiration;
276 now = GNUNET_TIME_absolute_get ();
277 expiration = GNUNET_TIME_absolute_ntoh (entry->block->expiration_time);
279 if (0 == GNUNET_TIME_absolute_get_difference (now,
280 expiration).rel_value_us)
282 GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm, key);
290 * Removes any expired block.
292 * @param plugin the plugin
295 namecache_expire_blocks (struct Plugin *plugin)
297 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
304 * Cache a block in the datastore.
306 * @param cls closure (internal context for the plugin)
307 * @param block block to cache
308 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
311 namecache_cache_block (void *cls,
312 const struct GNUNET_GNSRECORD_Block *block)
314 struct Plugin *plugin = cls;
315 struct GNUNET_HashCode query;
316 struct FlatFileEntry *entry;
319 namecache_expire_blocks (plugin);
320 GNUNET_CRYPTO_hash (&block->derived_key,
321 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey),
323 block_size = ntohl (block->purpose.size) +
324 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) +
325 sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
326 if (block_size > 64 * 65536)
329 return GNUNET_SYSERR;
331 entry = GNUNET_malloc (sizeof (struct FlatFileEntry));
332 entry->block = GNUNET_malloc (block_size);
333 GNUNET_memcpy (entry->block, block, block_size);
334 GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm, &query);
336 GNUNET_CONTAINER_multihashmap_put (plugin->hm,
339 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
343 return GNUNET_SYSERR;
345 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
346 "Caching block under derived key `%s'\n",
347 GNUNET_h2s_full (&query));
353 * Get the block for a particular zone and label in the
354 * datastore. Will return at most one result to the iterator.
356 * @param cls closure (internal context for the plugin)
357 * @param query hash of public key derived from the zone and the label
358 * @param iter function to call with the result
359 * @param iter_cls closure for @a iter
360 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
363 namecache_lookup_block (void *cls,
364 const struct GNUNET_HashCode *query,
365 GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls)
367 struct Plugin *plugin = cls;
368 const struct GNUNET_GNSRECORD_Block *block;
370 block = GNUNET_CONTAINER_multihashmap_get (plugin->hm, query);
373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
374 "Found block under derived key `%s'\n",
375 GNUNET_h2s_full (query));
376 iter (iter_cls, block);
382 * Entry point for the plugin.
384 * @param cls the "struct GNUNET_NAMECACHE_PluginEnvironment*"
385 * @return NULL on error, otherwise the plugin context
388 libgnunet_plugin_namecache_flat_init (void *cls)
390 static struct Plugin plugin;
391 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
392 struct GNUNET_NAMECACHE_PluginFunctions *api;
394 if (NULL != plugin.cfg)
395 return NULL; /* can only initialize once! */
396 memset (&plugin, 0, sizeof (struct Plugin));
398 if (GNUNET_OK != database_setup (&plugin))
400 database_shutdown (&plugin);
403 api = GNUNET_new (struct GNUNET_NAMECACHE_PluginFunctions);
405 api->cache_block = &namecache_cache_block;
406 api->lookup_block = &namecache_lookup_block;
407 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
408 _("flat plugin running\n"));
414 * Exit point from the plugin.
416 * @param cls the plugin context (as returned by "init")
417 * @return always NULL
420 libgnunet_plugin_namecache_flat_done (void *cls)
422 struct GNUNET_NAMECACHE_PluginFunctions *api = cls;
423 struct Plugin *plugin = api->cls;
425 database_shutdown (plugin);
428 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
429 "flat plugin is finished\n");
433 /* end of plugin_namecache_sqlite.c */