- fix doxygen
[oweals/gnunet.git] / src / namestore / gnunet-service-namestore.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009 Christian Grothoff (and other contributing authors)
4
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.
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      General Public License for more details.
14
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., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file namestore/gnunet-service-namestore.c
23  * @brief namestore for the GNUnet naming system
24  * @author Matthias Wachs
25  */
26 #include "platform.h"
27 #include "gnunet_getopt_lib.h"
28 #include "gnunet_service_lib.h"
29 #include "gnunet_namestore_service.h"
30 #include "gnunet_namestore_plugin.h"
31 #include "namestore.h"
32
33
34
35 /**
36  * A namestore operation.
37  */
38 struct GNUNET_NAMESTORE_Operation
39 {
40   struct GNUNET_NAMESTORE_Operation *next;
41   struct GNUNET_NAMESTORE_Operation *prev;
42
43   uint64_t op_id;
44
45   char *data; /*stub data pointer*/
46 };
47
48
49 /**
50  * A namestore client
51  */
52 struct GNUNET_NAMESTORE_Client
53 {
54   struct GNUNET_NAMESTORE_Client *next;
55   struct GNUNET_NAMESTORE_Client *prev;
56
57   struct GNUNET_SERVER_Client * client;
58
59   struct GNUNET_NAMESTORE_Operation *op_head;
60   struct GNUNET_NAMESTORE_Operation *op_tail;
61 };
62
63
64
65 /**
66  * Configuration handle.
67  */
68 const struct GNUNET_CONFIGURATION_Handle *GSN_cfg;
69
70 static struct GNUNET_NAMESTORE_PluginFunctions *GSN_database;
71
72 /**
73  * Our notification context.
74  */
75 static struct GNUNET_SERVER_NotificationContext *snc;
76
77 static char *db_lib_name;
78
79 static struct GNUNET_NAMESTORE_Client *client_head;
80 static struct GNUNET_NAMESTORE_Client *client_tail;
81
82
83 /**
84  * Task run during shutdown.
85  *
86  * @param cls unused
87  * @param tc unused
88  */
89 static void
90 cleanup_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
91 {
92   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping namestore service\n");
93
94   struct GNUNET_NAMESTORE_Operation * no;
95   struct GNUNET_NAMESTORE_Operation * tmp;
96   struct GNUNET_NAMESTORE_Client * nc;
97   struct GNUNET_NAMESTORE_Client * next;
98
99   for (nc = client_head; nc != NULL; nc = next)
100   {
101     next = nc->next;
102     for (no = nc->op_head; no != NULL; no = tmp)
103     {
104       GNUNET_CONTAINER_DLL_remove (nc->op_head, nc->op_tail, no);
105       tmp = no->next;
106       GNUNET_free (no);
107     }
108
109     GNUNET_CONTAINER_DLL_remove (client_head, client_tail, nc);
110     GNUNET_free (nc);
111
112   }
113
114   GNUNET_SERVER_notification_context_destroy (snc);
115   snc = NULL;
116
117   GNUNET_break (NULL == GNUNET_PLUGIN_unload (db_lib_name, GSN_database));
118   GNUNET_free (db_lib_name);
119 }
120
121 static struct GNUNET_NAMESTORE_Client *
122 client_lookup (struct GNUNET_SERVER_Client *client)
123 {
124   struct GNUNET_NAMESTORE_Client * nc;
125
126   GNUNET_assert (NULL != client);
127
128   for (nc = client_head; nc != NULL; nc = nc->next)
129   {
130     if (client == nc->client)
131       break;
132   }
133   return nc;
134 }
135
136
137 /**
138  * Called whenever a client is disconnected.  Frees our
139  * resources associated with that client.
140  *
141  * @param cls closure
142  * @param client identification of the client
143  */
144 static void
145 client_disconnect_notification (void *cls, struct GNUNET_SERVER_Client *client)
146 {
147   struct GNUNET_NAMESTORE_Operation * no;
148   struct GNUNET_NAMESTORE_Client * nc;
149   if (NULL == client)
150     return;
151
152   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %p disconnected \n", client);
153
154   nc = client_lookup (client);
155
156   if ((NULL == client) || (NULL == nc))
157     return;
158
159   for (no = nc->op_head; no != NULL; no = no->next)
160   {
161     GNUNET_CONTAINER_DLL_remove (nc->op_head, nc->op_tail, no);
162     GNUNET_free (no);
163   }
164
165   GNUNET_CONTAINER_DLL_remove (client_head, client_tail, nc);
166   GNUNET_free (nc);
167 }
168
169 static void handle_start (void *cls,
170                           struct GNUNET_SERVER_Client * client,
171                           const struct GNUNET_MessageHeader * message)
172 {
173   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %p connected\n", client);
174
175   struct GNUNET_NAMESTORE_Client * nc = GNUNET_malloc (sizeof (struct GNUNET_NAMESTORE_Client));
176   nc->client = client;
177   GNUNET_SERVER_notification_context_add (snc, client);
178   GNUNET_CONTAINER_DLL_insert(client_head, client_tail, nc);
179
180   GNUNET_SERVER_receive_done (client, GNUNET_OK);
181 }
182
183 struct LookupNameContext
184 {
185   struct GNUNET_NAMESTORE_Client *nc;
186   uint32_t id;
187   uint32_t record_type;
188 };
189
190
191 static void
192 handle_lookup_name_it (void *cls,
193     const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
194     struct GNUNET_TIME_Absolute expire,
195     const char *name,
196     unsigned int rd_count,
197     const struct GNUNET_NAMESTORE_RecordData *rd,
198     const struct GNUNET_CRYPTO_RsaSignature *signature)
199 {
200   /* send response */
201   struct LookupNameContext *lnc = cls;
202   struct LookupNameResponseMessage *lnr_msg;
203
204   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key_tmp;
205   struct GNUNET_NAMESTORE_RecordData * rd_tmp;
206   char *name_tmp;
207   struct GNUNET_CRYPTO_RsaSignature *signature_tmp;
208
209   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message\n", "NAMESTORE_LOOKUP_NAME_RESPONSE");
210
211   size_t r_size = 0;
212
213   size_t name_len = 0;
214   if (NULL != name)
215     name_len = strlen(name) + 1;
216
217   int copied_elements = 0;
218   int contains_signature = 0;
219   int c;
220
221   /* count records to copy */
222   if (rd_count != 0)
223   {
224     if (lnc->record_type != 0)
225     {
226       /* special record type needed */
227       for (c = 0; c < rd_count; c ++)
228         if (rd[c].record_type == lnc->record_type)
229           copied_elements++; /* found matching record */
230     }
231     else
232       copied_elements = rd_count;
233   }
234
235   if ((copied_elements == rd_count) && (signature != NULL))
236       contains_signature = GNUNET_YES;
237
238   r_size = sizeof (struct LookupNameResponseMessage) +
239            sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
240            name_len +
241            copied_elements * sizeof (struct GNUNET_NAMESTORE_RecordData) +
242            contains_signature * sizeof (struct GNUNET_CRYPTO_RsaSignature);
243
244   lnr_msg = GNUNET_malloc (r_size);
245
246   lnr_msg->header.type = ntohs (GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE);
247   lnr_msg->header.size = ntohs (r_size);
248   lnr_msg->op_id = htonl (lnc->id);
249   lnr_msg->rc_count = htonl (copied_elements);
250   lnr_msg->name_len = htons (name_len);
251   lnr_msg->expire = GNUNET_TIME_absolute_hton(expire);
252   lnr_msg->contains_sig = htons (contains_signature);
253
254
255   zone_key_tmp =  (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *) &lnr_msg[1];
256   name_tmp = (char *) &zone_key_tmp[1];
257   rd_tmp = (struct GNUNET_NAMESTORE_RecordData *) &name_tmp[name_len];
258   signature_tmp = (struct GNUNET_CRYPTO_RsaSignature *) &rd_tmp[copied_elements];
259
260   if (zone_key != NULL)
261     memcpy (zone_key_tmp, zone_key, sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
262   else
263   {
264     struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded dummy;
265     memset (&dummy, '0', sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
266     memcpy (zone_key_tmp, &dummy, sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
267   }
268   memcpy (name_tmp, name, name_len);
269   /* copy records */
270   copied_elements = 0;
271   if (rd_count != 0)
272   {
273     if (lnc->record_type != 0)
274     {
275       /* special record type needed */
276       for (c = 0; c < rd_count; c ++)
277         if (rd[c].record_type == lnc->record_type)
278         {
279           /* found matching record */
280           memcpy (&rd_tmp[copied_elements], &rd[c], rd_count * sizeof (struct GNUNET_NAMESTORE_RecordData));
281           copied_elements++;
282         }
283     }
284     else
285       memcpy (rd_tmp, rd, rd_count * sizeof (struct GNUNET_NAMESTORE_RecordData));
286   }
287
288   if (GNUNET_YES == contains_signature)
289     memcpy (signature_tmp, signature, sizeof (struct GNUNET_CRYPTO_RsaSignature));
290   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "DONE `%s' message\n", "NAMESTORE_LOOKUP_NAME_RESPONSE");
291   GNUNET_SERVER_notification_context_unicast (snc, lnc->nc->client, (const struct GNUNET_MessageHeader *) lnr_msg, GNUNET_NO);
292
293   GNUNET_free (lnr_msg);
294 }
295
296 static void handle_lookup_name (void *cls,
297                           struct GNUNET_SERVER_Client * client,
298                           const struct GNUNET_MessageHeader * message)
299 {
300   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "NAMESTORE_LOOKUP_NAME");
301   struct LookupNameContext lnc;
302   struct GNUNET_NAMESTORE_Client *nc;
303   GNUNET_HashCode name_hash;
304   size_t name_len;
305   char * name;
306   uint32_t id = 0;
307   uint32_t type = 0;
308
309
310   if (ntohs (message->size) < sizeof (struct LookupNameMessage))
311   {
312     GNUNET_break_op (0);
313     GNUNET_SERVER_receive_done (client, GNUNET_OK);
314     return;
315   }
316
317   nc = client_lookup(client);
318   if (nc == NULL)
319   {
320     GNUNET_break_op (0);
321     GNUNET_SERVER_receive_done (client, GNUNET_OK);
322     return;
323   }
324
325   struct LookupNameMessage * ln_msg = (struct LookupNameMessage *) message;
326   id = ntohl (ln_msg->op_id);
327   name_len = ntohl (ln_msg->name_len);
328   type = ntohl (ln_msg->record_type);
329
330   if ((name_len == 0) || (name_len > 256))
331   {
332     GNUNET_break_op (0);
333     GNUNET_SERVER_receive_done (client, GNUNET_OK);
334     return;
335   }
336
337   name = GNUNET_malloc (name_len);
338   memcpy (name, &ln_msg[1], name_len);
339   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Looking up record for name `%s'\n", name);
340   GNUNET_CRYPTO_hash(name, name_len-1, &name_hash);
341   GNUNET_free (name);
342
343   /* do the actual lookup */
344   lnc.id = id;
345   lnc.nc = nc;
346   lnc.record_type = type;
347   GSN_database->iterate_records(GSN_database->cls, &ln_msg->zone, &ln_msg->zone, 0, &handle_lookup_name_it, &lnc);
348
349   GNUNET_SERVER_receive_done (client, GNUNET_OK);
350 }
351
352
353 /**
354  * Process template requests.
355  *
356  * @param cls closure
357  * @param server the initialized server
358  * @param cfg configuration to use
359  */
360 static void
361 run (void *cls, struct GNUNET_SERVER_Handle *server,
362      const struct GNUNET_CONFIGURATION_Handle *cfg)
363 {
364   char * database;
365
366   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting namestore service\n");
367
368   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
369     {&handle_start, NULL,
370      GNUNET_MESSAGE_TYPE_NAMESTORE_START, sizeof (struct StartMessage)},
371     {&handle_lookup_name, NULL,
372      GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME, 0},
373     {NULL, NULL, 0, 0}
374   };
375
376   GSN_cfg = cfg;
377
378   /* Loading database plugin */
379   if (GNUNET_OK !=
380       GNUNET_CONFIGURATION_get_value_string (cfg, "namestore", "database",
381                                              &database))
382     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "No database backend configured\n");
383
384   GNUNET_asprintf (&db_lib_name, "libgnunet_plugin_namestore_%s", database);
385   GSN_database = GNUNET_PLUGIN_load (db_lib_name, (void *) GSN_cfg);
386   if (GSN_database == NULL)
387     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not load database backend `%s'\n",
388         db_lib_name);
389   GNUNET_free (database);
390
391   /* Configuring server handles */
392   GNUNET_SERVER_add_handlers (server, handlers);
393   snc = GNUNET_SERVER_notification_context_create (server, 16);
394   GNUNET_SERVER_disconnect_notify (server,
395                                    &client_disconnect_notification,
396                                    NULL);
397
398   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &cleanup_task,
399                                 NULL);
400
401 }
402
403
404 /**
405  * The main function for the template service.
406  *
407  * @param argc number of arguments from the command line
408  * @param argv command line arguments
409  * @return 0 ok, 1 on error
410  */
411 int
412 main (int argc, char *const *argv)
413 {
414   return (GNUNET_OK ==
415           GNUNET_SERVICE_run (argc, argv, "namestore",
416                               GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
417 }
418
419 /* end of gnunet-service-namestore.c */