GNUnet  0.11.x
plugin_namecache_flat.c
Go to the documentation of this file.
1 /*
2  * This file is part of GNUnet
3  * Copyright (C) 2009-2015 GNUnet e.V.
4  *
5  * GNUnet is free software: you can redistribute it and/or modify it
6  * under the terms of the GNU Affero General Public License as published
7  * by the Free Software Foundation, either version 3 of the License,
8  * or (at your option) any later version.
9  *
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  * Affero General Public License for more details.
14  *
15  * You should have received a copy of the GNU Affero General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
27 #include "platform.h"
30 #include "gnunet_gnsrecord_lib.h"
31 #include "namecache.h"
32 
36 struct Plugin
37 {
38  const struct GNUNET_CONFIGURATION_Handle *cfg;
39 
43  char *fn;
44 
49 };
50 
52 {
57 
61  struct GNUNET_HashCode query;
62 };
63 
72 static int
74 {
75  char *afsdir;
76  char*block_buffer;
77  char*buffer;
78  char*line;
79  char*query;
80  char*block;
81  uint64_t size;
82  struct FlatFileEntry *entry;
83  struct GNUNET_DISK_FileHandle *fh;
84 
85  if (GNUNET_OK !=
87  "namecache-flat",
88  "FILENAME",
89  &afsdir))
90  {
92  "namecache-flat", "FILENAME");
93  return GNUNET_SYSERR;
94  }
95  if (GNUNET_OK != GNUNET_DISK_file_test (afsdir))
96  {
98  {
99  GNUNET_break (0);
100  GNUNET_free (afsdir);
101  return GNUNET_SYSERR;
102  }
103  }
104  /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
105  plugin->fn = afsdir;
106 
107  /* Load data from file into hashmap */
109  GNUNET_NO);
110  fh = GNUNET_DISK_file_open (afsdir,
115  if (NULL == fh)
116  {
118  _ ("Unable to initialize file: %s.\n"),
119  afsdir);
120  return GNUNET_SYSERR;
121  }
122 
123  if (GNUNET_SYSERR == GNUNET_DISK_file_size (afsdir,
124  &size,
125  GNUNET_YES,
126  GNUNET_YES))
127  {
129  _ ("Unable to get filesize: %s.\n"),
130  afsdir);
132  return GNUNET_SYSERR;
133  }
134 
135  if (0 == size)
136  {
138  return GNUNET_OK;
139  }
140 
141  buffer = GNUNET_malloc (size + 1);
142 
144  buffer,
145  size))
146  {
148  _ ("Unable to read file: %s.\n"),
149  afsdir);
150  GNUNET_free (buffer);
152  return GNUNET_SYSERR;
153  }
154  buffer[size] = '\0';
155 
157  if (0 < size)
158  {
159  line = strtok (buffer, "\n");
160  while (line != NULL)
161  {
162  query = strtok (line, ",");
163  if (NULL == query)
164  break;
165  block = strtok (NULL, ",");
166  if (NULL == block)
167  break;
168  line = strtok (NULL, "\n");
169  entry = GNUNET_malloc (sizeof(struct FlatFileEntry));
171  &entry->query));
173  strlen (block),
174  (void **) &block_buffer);
175  entry->block = (struct GNUNET_GNSRECORD_Block *) block_buffer;
176  if (GNUNET_OK !=
178  &entry->query,
179  entry,
181  {
182  GNUNET_free (entry);
183  GNUNET_break (0);
184  }
185  }
186  }
187  GNUNET_free (buffer);
188  return GNUNET_OK;
189 }
190 
191 
197 static int
199  const struct GNUNET_HashCode *key,
200  void *value)
201 {
202  struct GNUNET_DISK_FileHandle *fh = cls;
203  struct FlatFileEntry *entry = value;
204 
205  char *line;
206  char *block_b64;
207  struct GNUNET_CRYPTO_HashAsciiEncoded query;
208  size_t block_size;
209 
210  block_size = GNUNET_GNSRECORD_block_get_size (entry->block);
211  GNUNET_STRINGS_base64_encode ((char *) entry->block,
212  block_size,
213  &block_b64);
215  &query);
216  GNUNET_asprintf (&line,
217  "%s,%s\n",
218  (char *) &query,
219  block_b64);
220 
221  GNUNET_free (block_b64);
222 
224  line,
225  strlen (line));
226 
227  GNUNET_free (entry->block);
228  GNUNET_free (entry);
229  GNUNET_free (line);
230  return GNUNET_YES;
231 }
232 
233 
239 static void
241 {
242  struct GNUNET_DISK_FileHandle *fh;
243 
244  fh = GNUNET_DISK_file_open (plugin->fn,
250  if (NULL == fh)
251  {
253  _ ("Unable to initialize file: %s.\n"),
254  plugin->fn);
255  return;
256  }
257 
260  fh);
263 }
264 
265 
266 static int
267 expire_blocks (void *cls,
268  const struct GNUNET_HashCode *key,
269  void *value)
270 {
271  struct Plugin *plugin = cls;
272  struct FlatFileEntry *entry = value;
273  struct GNUNET_TIME_Absolute now;
274  struct GNUNET_TIME_Absolute expiration;
275 
276  now = GNUNET_TIME_absolute_get ();
277  expiration = GNUNET_GNSRECORD_block_get_expiration (entry->block);
278 
280  expiration).rel_value_us)
281  {
283  }
284  return GNUNET_YES;
285 }
286 
287 
293 static void
295 {
297  &expire_blocks,
298  plugin);
299 }
300 
301 
309 static int
311  const struct GNUNET_GNSRECORD_Block *block)
312 {
313  struct Plugin *plugin = cls;
314  struct GNUNET_HashCode query;
315  struct FlatFileEntry *entry;
316  size_t block_size;
317 
318  namecache_expire_blocks (plugin);
320  &query);
321  block_size = GNUNET_GNSRECORD_block_get_size (block);
322  if (block_size > 64 * 65536)
323  {
324  GNUNET_break (0);
325  return GNUNET_SYSERR;
326  }
327  entry = GNUNET_malloc (sizeof(struct FlatFileEntry));
328  entry->block = GNUNET_malloc (block_size);
329  GNUNET_memcpy (entry->block, block, block_size);
331  if (GNUNET_OK !=
333  &query,
334  entry,
336  {
337  GNUNET_free (entry);
338  GNUNET_break (0);
339  return GNUNET_SYSERR;
340  }
342  "Caching block under derived key `%s'\n",
343  GNUNET_h2s_full (&query));
344  return GNUNET_OK;
345 }
346 
347 
358 static int
360  const struct GNUNET_HashCode *query,
362 {
363  struct Plugin *plugin = cls;
364  const struct GNUNET_GNSRECORD_Block *block;
365 
366  block = GNUNET_CONTAINER_multihashmap_get (plugin->hm, query);
367  if (NULL == block)
368  return GNUNET_NO;
370  "Found block under derived key `%s'\n",
371  GNUNET_h2s_full (query));
372  iter (iter_cls, block);
373  return GNUNET_YES;
374 }
375 
376 
383 void *
385 {
386  static struct Plugin plugin;
387  const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
389 
390  if (NULL != plugin.cfg)
391  return NULL; /* can only initialize once! */
392  memset (&plugin, 0, sizeof(struct Plugin));
393  plugin.cfg = cfg;
394  if (GNUNET_OK != database_setup (&plugin))
395  {
396  database_shutdown (&plugin);
397  return NULL;
398  }
400  api->cls = &plugin;
404  _ ("flat plugin running\n"));
405  return api;
406 }
407 
408 
415 void *
417 {
419  struct Plugin *plugin = api->cls;
420 
421  database_shutdown (plugin);
422  plugin->cfg = NULL;
423  GNUNET_free (api);
425  "flat plugin is finished\n");
426  return NULL;
427 }
428 
429 
430 /* end of plugin_namecache_sqlite.c */
void(* GNUNET_NAMECACHE_BlockCallback)(void *cls, const struct GNUNET_GNSRECORD_Block *block)
Function called for matching blocks.
Create file if it doesn&#39;t exist.
void * cls
Closure to pass to all plugin functions.
struct GNUNET_GNSRECORD_Block * block
Block.
ssize_t GNUNET_DISK_file_read(const struct GNUNET_DISK_FileHandle *h, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:622
static int namecache_cache_block(void *cls, const struct GNUNET_GNSRECORD_Block *block)
Cache a block in the datastore.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
enum GNUNET_GenericReturnValue GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1305
struct GNUNET_BLOCK_PluginFunctions * api
Plugin API.
Definition: block.c:47
struct GNUNET_HashCode query
query
char * key
TLS key.
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
int GNUNET_CONTAINER_multihashmap_remove_all(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Remove all entries for the given key from the map.
sqlite3_stmt * expire_blocks
Precompiled SQL for removing expired blocks.
Internal representation of the hash map.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void * libgnunet_plugin_namecache_flat_init(void *cls)
Entry point for the plugin.
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.
#define _(String)
GNU gettext support macro.
Definition: platform.h:178
int(* cache_block)(void *cls, const struct GNUNET_GNSRECORD_Block *block)
Cache a block in the datastore.
static char * line
Desired phone line (string to be converted to a hash).
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
static char * value
Value of the record to add/remove.
size_t GNUNET_GNSRECORD_block_get_size(const struct GNUNET_GNSRECORD_Block *block)
Returns the length of this block in bytes.
int(* lookup_block)(void *cls, const struct GNUNET_HashCode *query, GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls)
Get the block for a particular zone and label in the datastore.
Truncate file if it exists.
ssize_t GNUNET_DISK_file_write(const struct GNUNET_DISK_FileHandle *h, const void *buffer, size_t n)
Write a buffer to a file.
Definition: disk.c:686
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
static int fh
Handle to the unique file.
static void namecache_expire_blocks(struct Plugin *plugin)
Removes any expired block.
static int store_and_free_entries(void *cls, const struct GNUNET_HashCode *key, void *value)
Store values in hashmap in file and free data.
A 512-bit hashcode.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:86
size_t GNUNET_STRINGS_base64_decode(const char *data, size_t len, void **output)
Decode from Base64.
Definition: strings.c:1682
size_t GNUNET_STRINGS_base64_encode(const void *in, size_t len, char **output)
Encode into Base64.
Definition: strings.c:1594
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
There must only be one value per key; storing a value should fail if a value under the same key alrea...
void GNUNET_CRYPTO_hash_to_enc(const struct GNUNET_HashCode *block, struct GNUNET_CRYPTO_HashAsciiEncoded *result)
Convert hash to ASCII encoding.
Definition: crypto_hash.c:55
struct GNUNET_CONTAINER_MultiHashMap * hm
HashMap.
void * iter_cls
Iterator cls.
const char * GNUNET_h2s_full(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
int GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
struct returned by the initialization function of the plugin
0-terminated ASCII encoding of a struct GNUNET_HashCode.
char * fn
Filename used for the DB.
enum GNUNET_GenericReturnValue GNUNET_DISK_file_size(const char *filename, uint64_t *size, int include_symbolic_links, int single_file_mode)
Get the size of the file (or directory) of the given file (in bytes).
Definition: disk.c:222
static void database_shutdown(struct Plugin *plugin)
Shutdown database connection and associate data structures.
unsigned long long size
Size of all values we&#39;re storing.
configuration data
Handle for a plugin.
Definition: block.c:37
#define GNUNET_log(kind,...)
Open the file for both reading and writing.
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
struct Plugin * plugin
enum GNUNET_GenericReturnValue GNUNET_GNSRECORD_query_from_block(const struct GNUNET_GNSRECORD_Block *block, struct GNUNET_HashCode *query)
Builds the query hash from a block.
static int namecache_lookup_block(void *cls, const struct GNUNET_HashCode *query, GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls)
Get the block for a particular zone and label in the datastore.
Time for absolute times used by GNUnet, in microseconds.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_difference(struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Absolute end)
Compute the time difference between the given start and end times.
Definition: time.c:248
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:582
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
struct GNUNET_TIME_Absolute GNUNET_GNSRECORD_block_get_expiration(const struct GNUNET_GNSRECORD_Block *block)
Returns the expiration of a block.
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1234
GNUNET_PEERSTORE_Processor iter
Iterator.
#define GNUNET_CRYPTO_hash_from_string(enc, result)
Convert ASCII encoding back to struct GNUNET_HashCode
common internal definitions for namecache service
static int database_setup(struct Plugin *plugin)
Initialize the database connections and associated data structures (create tables and indices as need...
Handle used to access files (and pipes).
void * libgnunet_plugin_namecache_flat_done(void *cls)
Exit point from the plugin.
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:482
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.