GNUnet  0.11.x
plugin_rest_gns.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2012-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  */
26 #include "platform.h"
27 #include "gnunet_rest_plugin.h"
28 #include "gnunet_rest_lib.h"
29 #include "gnunet_json_lib.h"
30 #include "gnunet_gnsrecord_lib.h"
31 #include "gnunet_gns_service.h"
32 #include "microhttpd.h"
33 #include <jansson.h>
34 
38 #define GNUNET_REST_API_NS_GNS "/gns"
39 
43 #define GNUNET_REST_GNS_PARAM_RECORD_TYPE "record_type"
44 
48 #define GNUNET_REST_GNS_ERROR_UNKNOWN "Unknown Error"
49 
53 #define GNUNET_REST_GNS_NOT_FOUND "Record not found"
54 
59 
63 static char *allow_methods;
64 
68 struct Plugin
69 {
71 };
72 
77 {
82 
87 
91  char *name;
92 
97 
102 
107 
112 
117 
121  void *proc_cls;
122 
126  char *url;
127 
131  char *emsg;
132 
137 };
138 
139 
144 static void
145 cleanup_handle (void *cls)
146 {
147  struct RequestHandle *handle = cls;
148 
149  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up\n");
150 
151  if (NULL != handle->gns_lookup)
152  {
154  handle->gns_lookup = NULL;
155  }
156  if (NULL != handle->gns)
157  {
158  GNUNET_GNS_disconnect (handle->gns);
159  handle->gns = NULL;
160  }
161 
162  if (NULL != handle->timeout_task)
163  {
165  handle->timeout_task = NULL;
166  }
167  if (NULL != handle->url)
168  GNUNET_free (handle->url);
169  if (NULL != handle->name)
170  GNUNET_free (handle->name);
171  if (NULL != handle->emsg)
172  GNUNET_free (handle->emsg);
173 
174  GNUNET_free (handle);
175 }
176 
177 
183 static void
184 do_error (void *cls)
185 {
186  struct RequestHandle *handle = cls;
187  struct MHD_Response *resp;
188  json_t *json_error = json_object ();
189  char *response;
190 
191  if (NULL != handle->timeout_task)
193  handle->timeout_task = NULL;
194  if (NULL == handle->emsg)
196 
197  json_object_set_new (json_error, "error", json_string (handle->emsg));
198 
199  if (0 == handle->response_code)
200  handle->response_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
201  response = json_dumps (json_error, 0);
202  resp = GNUNET_REST_create_response (response);
203  handle->proc (handle->proc_cls, resp, handle->response_code);
204  json_decref (json_error);
205  GNUNET_free (response);
207 }
208 
209 
210 static void
211 do_timeout (void *cls)
212 {
213  struct RequestHandle *handle = cls;
214 
215  handle->timeout_task = NULL;
216  handle->response_code = MHD_HTTP_REQUEST_TIMEOUT;
217  do_error (handle);
218 }
219 
220 
229 static void
231  int was_gns,
232  uint32_t rd_count,
233  const struct GNUNET_GNSRECORD_Data *rd)
234 {
235  struct RequestHandle *handle = cls;
236  struct MHD_Response *resp;
237  json_t *result_obj;
238  char *result;
239 
240  handle->gns_lookup = NULL;
241 
242  if (GNUNET_NO == was_gns)
243  {
244  handle->response_code = MHD_HTTP_NOT_FOUND;
247  return;
248  }
249 
250  result_obj = GNUNET_JSON_from_gnsrecord (handle->name, rd, rd_count);
251 
252  result = json_dumps (result_obj, 0);
253  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Result %s\n", result);
254  resp = GNUNET_REST_create_response (result);
255  handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
256  GNUNET_free (result);
257  json_decref (result_obj);
259 }
260 
261 
269 void
271  const char *url,
272  void *cls)
273 {
274  struct RequestHandle *handle = cls;
275  struct GNUNET_HashCode key;
276  char *record_type;
277  char *name;
278 
279  name = NULL;
280  handle->name = NULL;
281  if (strlen (GNUNET_REST_API_NS_GNS) < strlen (handle->url))
282  {
283  name = &handle->url[strlen (GNUNET_REST_API_NS_GNS) + 1];
284  }
285 
286  if (NULL == name)
287  {
288  handle->response_code = MHD_HTTP_NOT_FOUND;
291  return;
292  }
293  if (0 >= strlen (name))
294  {
295  handle->response_code = MHD_HTTP_NOT_FOUND;
298  return;
299  }
300  handle->name = GNUNET_strdup (name);
301 
302  handle->record_type = UINT32_MAX;
305  &key);
306  if (GNUNET_YES ==
308  {
309  record_type =
311  handle->record_type = GNUNET_GNSRECORD_typename_to_number (record_type);
312  }
313 
314  if (UINT32_MAX == handle->record_type)
315  {
317  }
318 
319  handle->gns_lookup = GNUNET_GNS_lookup_with_tld (handle->gns,
320  handle->name,
321  handle->record_type,
322  GNUNET_NO,
324  handle);
325 }
326 
327 
335 static void
337  const char *url,
338  void *cls)
339 {
340  struct MHD_Response *resp;
341  struct RequestHandle *handle = cls;
342 
343  // independent of path return all options
344  resp = GNUNET_REST_create_response (NULL);
345  MHD_add_response_header (resp, "Access-Control-Allow-Methods", allow_methods);
346  handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
348  return;
349 }
350 
351 
357 static void
359 {
361  static const struct GNUNET_REST_RequestHandler handlers[] =
362  { { MHD_HTTP_METHOD_GET, GNUNET_REST_API_NS_GNS, &get_gns_cont },
363  { MHD_HTTP_METHOD_OPTIONS, GNUNET_REST_API_NS_GNS, &options_cont },
365 
366  if (GNUNET_NO ==
367  GNUNET_REST_handle_request (handle->rest_handle, handlers, &err, handle))
368  {
369  handle->response_code = err.error_code;
371  }
372 }
373 
374 
386 static void
389  void *proc_cls)
390 {
391  struct RequestHandle *handle = GNUNET_new (struct RequestHandle);
392 
393  handle->response_code = 0;
394  handle->timeout =
396  handle->proc_cls = proc_cls;
397  handle->proc = proc;
398  handle->rest_handle = rest_handle;
399 
400  handle->url = GNUNET_strdup (rest_handle->url);
401  if (handle->url[strlen (handle->url) - 1] == '/')
402  handle->url[strlen (handle->url) - 1] = '\0';
403  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting...\n");
404  handle->gns = GNUNET_GNS_connect (cfg);
405  init_cont (handle);
406 
407  handle->timeout_task =
408  GNUNET_SCHEDULER_add_delayed (handle->timeout, &do_timeout, handle);
409 
410  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connected\n");
411 }
412 
413 
420 void *
422 {
423  static struct Plugin plugin;
424  struct GNUNET_REST_Plugin *api;
425 
426  cfg = cls;
427  if (NULL != plugin.cfg)
428  return NULL; /* can only initialize once! */
429  memset (&plugin, 0, sizeof(struct Plugin));
430  plugin.cfg = cfg;
431  api = GNUNET_new (struct GNUNET_REST_Plugin);
432  api->cls = &plugin;
436  "%s, %s, %s, %s, %s",
437  MHD_HTTP_METHOD_GET,
438  MHD_HTTP_METHOD_POST,
439  MHD_HTTP_METHOD_PUT,
440  MHD_HTTP_METHOD_DELETE,
441  MHD_HTTP_METHOD_OPTIONS);
442 
443  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _ ("Gns REST API initialized\n"));
444  return api;
445 }
446 
447 
454 void *
456 {
457  struct GNUNET_REST_Plugin *api = cls;
458  struct Plugin *plugin = api->cls;
459 
460  plugin->cfg = NULL;
461 
463  GNUNET_free (api);
464  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Gns REST plugin is finished\n");
465  return NULL;
466 }
467 
468 
469 /* end of plugin_rest_gns.c */
Connection to the GNS service.
Definition: gns_api.h:35
char * name
Plugin name.
void(* GNUNET_REST_ResultProcessor)(void *cls, struct MHD_Response *resp, int status)
Iterator called on obtained result for a REST result.
static void rest_process_request(struct GNUNET_REST_RequestHandle *rest_handle, GNUNET_REST_ResultProcessor proc, void *proc_cls)
Function processing the REST call.
int record_type
Record type to look up.
void * libgnunet_plugin_rest_gns_init(void *cls)
Entry point for the plugin.
functions to parse JSON objects into GNUnet objects
void * cls
The closure of the plugin.
void * GNUNET_GNS_lookup_with_tld_cancel(struct GNUNET_GNS_LookupWithTldRequest *ltr)
Cancel pending lookup request.
Definition: gns_tld_api.c:329
GNUNET_REST_ResultProcessor proc
The plugin result processor.
uint32_t GNUNET_GNSRECORD_typename_to_number(const char *dns_typename)
Convert a type name (i.e.
Definition: gnsrecord.c:204
#define GNUNET_GNSRECORD_TYPE_ANY
Record type indicating any record/&#39;*&#39;.
#define GNUNET_TIME_UNIT_SECONDS
One second.
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
static void handle_gns_response(void *cls, int was_gns, uint32_t rd_count, const struct GNUNET_GNSRECORD_Data *rd)
Iterator called on obtained result for a GNS lookup.
void * libgnunet_plugin_rest_gns_done(void *cls)
Exit point from the plugin.
struct GNUNET_GNS_LookupWithTldRequest * GNUNET_GNS_lookup_with_tld(struct GNUNET_GNS_Handle *handle, const char *name, uint32_t type, enum GNUNET_GNS_LocalOptions options, GNUNET_GNS_LookupResultProcessor2 proc, void *proc_cls)
Perform an asynchronous lookup operation on the GNS, determining the zone using the TLD of the given ...
Definition: gns_tld_api.c:241
struct returned by the initialization function of the plugin
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
void get_gns_cont(struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
Handle gns GET request.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void(* proc)(struct GNUNET_REST_RequestHandle *handle, const char *url, void *cls)
Namespace to handle.
int GNUNET_CONTAINER_multihashmap_contains(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Check if the map contains any value under the given key (including values that are NULL)...
void(* process_request)(struct GNUNET_REST_RequestHandle *handle, GNUNET_REST_ResultProcessor proc, void *proc_cls)
Function to process a REST call.
static void init_cont(struct RequestHandle *handle)
Handle rest request.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
void * proc_cls
The closure of the result processor.
#define GNUNET_REST_HANDLER_END
struct GNUNET_BLOCK_PluginFunctions * api
Plugin API.
Definition: block.c:47
The request handle.
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:181
#define GNUNET_REST_GNS_NOT_FOUND
Rest API GNS ERROR Record not found.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1253
char * name
Name to look up.
#define GNUNET_REST_GNS_PARAM_RECORD_TYPE
Rest API GNS Parameter record_type.
static struct GNUNET_TIME_Relative timeout
Desired timeout for the lookup (default is no timeout).
Definition: gnunet-abd.c:61
char * emsg
Error response message.
struct GNUNET_CONTAINER_MultiHashMap * url_param_map
Map of url parameters.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:48
const char * url
The url as string.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1280
char * name
Plugin name.
void GNUNET_GNS_disconnect(struct GNUNET_GNS_Handle *handle)
Shutdown connection with the GNS service.
Definition: gns_api.c:284
const struct GNUNET_CONFIGURATION_Handle * cfg
The configuration handle.
struct GNUNET_TIME_Relative timeout
Desired timeout for the lookup (default is no timeout).
unsigned int rd_count
Number of records in rd.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
static int result
Global testing status.
struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Multiply relative time by a given factor.
Definition: time.c:442
static void cleanup_handle(void *cls)
Cleanup lookup handle.
struct GNUNET_GNS_Handle * GNUNET_GNS_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Initialize the connection with the GNS service.
Definition: gns_api.c:262
json_t * GNUNET_JSON_from_gnsrecord(const char *rname, const struct GNUNET_GNSRECORD_Data *rd, unsigned int rd_count)
Convert Gns record to JSON.
int GNUNET_REST_handle_request(struct GNUNET_REST_RequestHandle *conn, const struct GNUNET_REST_RequestHandler *handlers, struct GNUNET_REST_RequestHandlerError *err, void *cls)
Definition: rest.c:77
A 512-bit hashcode.
struct GNUNET_REST_RequestHandle * rest_handle
Rest connection.
int response_code
Response code.
static char * plugin
Solver plugin name as string.
static void do_error(void *cls)
Task run on errors.
struct GNUNET_GNS_LookupWithTldRequest * gns_lookup
Active GNS lookup.
configuration data
Definition: configuration.c:85
Handle for a plugin.
Definition: block.c:37
struct GNUNET_SCHEDULER_Task * timeout_task
ID of a task associated with the resolution process.
struct MHD_Response * GNUNET_REST_create_response(const char *data)
Create REST MHD response.
Definition: rest.c:57
#define GNUNET_log(kind,...)
Entry in list of pending tasks.
Definition: scheduler.c:134
#define GNUNET_REST_GNS_ERROR_UNKNOWN
Rest API GNS ERROR Unknown Error.
static struct MHD_Response * response
Our canonical response.
struct GNUNET_GNSRECORD_Data * rd
Records to store.
#define GNUNET_YES
Definition: gnunet_common.h:77
Handle to a lookup request.
Definition: gns_tld_api.c:44
#define GNUNET_REST_API_NS_GNS
Rest API GNS Namespace.
struct GNUNET_GNS_Handle * gns
Connection to GNS.
static void do_timeout(void *cls)
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
static void options_cont(struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
Respond to OPTIONS request.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:966
char * url
The url.
static char * allow_methods
HTTP methods allows for this plugin.