2 This file is part of GNUnet.
3 Copyright (C) 2013 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 regex/gnunet-service-regex.c
23 * @brief service to advertise capabilities described as regex and to
24 * lookup capabilities by regex
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "regex_internal_lib.h"
30 #include "regex_ipc.h"
34 * Information about one of our clients.
42 struct ClientEntry *next;
47 struct ClientEntry *prev;
50 * Handle identifying the client.
52 struct GNUNET_SERVER_Client *client;
55 * Search handle (if this client is searching).
57 struct REGEX_INTERNAL_Search *sh;
60 * Announcement handle (if this client is announcing).
62 struct REGEX_INTERNAL_Announcement *ah;
65 * Refresh frequency for announcements.
67 struct GNUNET_TIME_Relative frequency;
70 * Task for re-announcing.
72 struct GNUNET_SCHEDULER_Task * refresh_task;
78 * Connection to the DHT.
80 static struct GNUNET_DHT_Handle *dht;
83 * Handle for doing statistics.
85 static struct GNUNET_STATISTICS_Handle *stats;
88 * Head of list of clients.
90 static struct ClientEntry *client_head;
93 * End of list of clients.
95 static struct ClientEntry *client_tail;
98 * Our notification context, used to send back results to the client.
100 static struct GNUNET_SERVER_NotificationContext *nc;
103 * Private key for this peer.
105 static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
109 * A client disconnected. Remove all of its data structure entries.
111 * @param cls closure, NULL
112 * @param client identification of the client
115 handle_client_disconnect (void *cls,
116 struct GNUNET_SERVER_Client *client)
118 struct ClientEntry *ce;
119 struct ClientEntry *nx;
122 for (ce = nx; NULL != ce; ce = nx)
125 if (ce->client == client)
127 if (NULL != ce->refresh_task)
129 GNUNET_SCHEDULER_cancel (ce->refresh_task);
130 ce->refresh_task = NULL;
134 REGEX_INTERNAL_announce_cancel (ce->ah);
139 REGEX_INTERNAL_search_cancel (ce->sh);
142 GNUNET_CONTAINER_DLL_remove (client_head,
152 * Task run during shutdown.
157 cleanup_task (void *cls)
159 struct ClientEntry *ce;
161 while (NULL != (ce = client_head))
162 handle_client_disconnect (NULL,
164 GNUNET_DHT_disconnect (dht);
166 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
168 GNUNET_SERVER_notification_context_destroy (nc);
170 GNUNET_free (my_private_key);
171 my_private_key = NULL;
176 * Periodic task to refresh our announcement of the regex.
178 * @param cls the `struct ClientEntry *` of the client that triggered the
182 reannounce (void *cls)
184 struct ClientEntry *ce = cls;
186 REGEX_INTERNAL_reannounce (ce->ah);
187 ce->refresh_task = GNUNET_SCHEDULER_add_delayed (ce->frequency,
194 * Handle ANNOUNCE message.
197 * @param client identification of the client
198 * @param message the actual message
201 handle_announce (void *cls,
202 struct GNUNET_SERVER_Client *client,
203 const struct GNUNET_MessageHeader *message)
205 const struct AnnounceMessage *am;
207 struct ClientEntry *ce;
210 size = ntohs (message->size);
211 am = (const struct AnnounceMessage *) message;
212 regex = (const char *) &am[1];
213 if ( (size <= sizeof (struct AnnounceMessage)) ||
214 ('\0' != regex[size - sizeof (struct AnnounceMessage) - 1]) )
217 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
221 ce = GNUNET_new (struct ClientEntry);
223 ce->frequency = GNUNET_TIME_relative_ntoh (am->refresh_delay);
224 ce->refresh_task = GNUNET_SCHEDULER_add_delayed (ce->frequency,
227 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
228 "Starting to announce regex `%s' every %s\n",
230 GNUNET_STRINGS_relative_time_to_string (ce->frequency,
232 ce->ah = REGEX_INTERNAL_announce (dht,
235 ntohs (am->compression),
240 GNUNET_SCHEDULER_cancel (ce->refresh_task);
242 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
245 GNUNET_CONTAINER_DLL_insert (client_head,
248 GNUNET_SERVER_receive_done (client, GNUNET_OK);
253 * Handle result, pass it back to the client.
255 * @param cls the struct ClientEntry of the client searching
256 * @param id Peer providing a regex that matches the string.
257 * @param get_path Path of the get request.
258 * @param get_path_length Lenght of @a get_path.
259 * @param put_path Path of the put request.
260 * @param put_path_length Length of the @a put_path.
263 handle_search_result (void *cls,
264 const struct GNUNET_PeerIdentity *id,
265 const struct GNUNET_PeerIdentity *get_path,
266 unsigned int get_path_length,
267 const struct GNUNET_PeerIdentity *put_path,
268 unsigned int put_path_length)
270 struct ClientEntry *ce = cls;
271 struct ResultMessage *result;
272 struct GNUNET_PeerIdentity *gp;
275 if ( (get_path_length >= 65536) ||
276 (put_path_length >= 65536) ||
277 ( (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity))
278 + sizeof (struct ResultMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
283 size = (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity) + sizeof (struct ResultMessage);
284 result = GNUNET_malloc (size);
285 result->header.size = htons (size);
286 result->header.type = htons (GNUNET_MESSAGE_TYPE_REGEX_RESULT);
287 result->get_path_length = htons ((uint16_t) get_path_length);
288 result->put_path_length = htons ((uint16_t) put_path_length);
291 GNUNET_memcpy (&gp[1],
293 get_path_length * sizeof (struct GNUNET_PeerIdentity));
294 GNUNET_memcpy (&gp[1 + get_path_length],
296 put_path_length * sizeof (struct GNUNET_PeerIdentity));
297 GNUNET_SERVER_notification_context_unicast (nc,
299 &result->header, GNUNET_NO);
300 GNUNET_free (result);
305 * Handle SEARCH message.
308 * @param client identification of the client
309 * @param message the actual message
312 handle_search (void *cls,
313 struct GNUNET_SERVER_Client *client,
314 const struct GNUNET_MessageHeader *message)
316 const struct RegexSearchMessage *sm;
318 struct ClientEntry *ce;
321 size = ntohs (message->size);
322 sm = (const struct RegexSearchMessage *) message;
323 string = (const char *) &sm[1];
324 if ( (size <= sizeof (struct RegexSearchMessage)) ||
325 ('\0' != string[size - sizeof (struct RegexSearchMessage) - 1]) )
328 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
331 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
332 "Starting to search for `%s'\n",
334 ce = GNUNET_new (struct ClientEntry);
336 ce->sh = REGEX_INTERNAL_search (dht,
338 &handle_search_result,
345 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
348 GNUNET_CONTAINER_DLL_insert (client_head,
351 GNUNET_SERVER_notification_context_add (nc, client);
352 GNUNET_SERVER_receive_done (client, GNUNET_OK);
357 * Process regex requests.
360 * @param server the initialized server
361 * @param cfg configuration to use
364 run (void *cls, struct GNUNET_SERVER_Handle *server,
365 const struct GNUNET_CONFIGURATION_Handle *cfg)
367 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
368 {&handle_announce, NULL, GNUNET_MESSAGE_TYPE_REGEX_ANNOUNCE, 0},
369 {&handle_search, NULL, GNUNET_MESSAGE_TYPE_REGEX_SEARCH, 0},
373 my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_configuration (cfg);
374 if (NULL == my_private_key)
376 GNUNET_SCHEDULER_shutdown ();
379 dht = GNUNET_DHT_connect (cfg, 1024);
382 GNUNET_free (my_private_key);
383 my_private_key = NULL;
384 GNUNET_SCHEDULER_shutdown ();
387 GNUNET_SCHEDULER_add_shutdown (&cleanup_task,
389 nc = GNUNET_SERVER_notification_context_create (server, 1);
390 stats = GNUNET_STATISTICS_create ("regex", cfg);
391 GNUNET_SERVER_add_handlers (server, handlers);
392 GNUNET_SERVER_disconnect_notify (server,
393 &handle_client_disconnect,
399 * The main function for the regex service.
401 * @param argc number of arguments from the command line
402 * @param argv command line arguments
403 * @return 0 ok, 1 on error
406 main (int argc, char *const *argv)
409 GNUNET_SERVICE_run (argc, argv, "regex",
410 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
413 /* end of gnunet-service-regex.c */