GNUnet  0.11.x
Data Structures | Macros | Functions | Variables
plugin_rest_config.c File Reference
#include "platform.h"
#include "gnunet_rest_plugin.h"
#include <gnunet_rest_lib.h>
#include <gnunet_util_lib.h>
#include <jansson.h>
Include dependency graph for plugin_rest_config.c:

Go to the source code of this file.

Data Structures

struct  Plugin
 Handle for a plugin. More...
 
struct  RequestHandle
 The request handle. More...
 

Macros

#define GNUNET_REST_API_NS_CONFIG   "/config"
 

Functions

static void cleanup_handle (struct RequestHandle *handle)
 Cleanup request handle. More...
 
static void do_error (void *cls)
 Task run on shutdown. More...
 
static void add_sections (void *cls, const char *section, const char *option, const char *value)
 
static void add_section_contents (void *cls, const char *section, const char *option, const char *value)
 
static void get_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
 Handle rest request. More...
 
struct GNUNET_CONFIGURATION_Handleset_value (struct GNUNET_CONFIGURATION_Handle *config, const char *section, const char *option, json_t *value)
 
static void set_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
 Handle REST POST request. More...
 
static void options_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
 Handle rest request. More...
 
static void rest_config_process_request (struct GNUNET_REST_RequestHandle *conndata_handle, GNUNET_REST_ResultProcessor proc, void *proc_cls)
 Function processing the REST call. More...
 
void * libgnunet_plugin_rest_config_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_rest_config_done (void *cls)
 Exit point from the plugin. More...
 

Variables

const struct GNUNET_CONFIGURATION_Handlecfg
 Handle to our configuration. More...
 

Macro Definition Documentation

◆ GNUNET_REST_API_NS_CONFIG

#define GNUNET_REST_API_NS_CONFIG   "/config"

Function Documentation

◆ cleanup_handle()

static void cleanup_handle ( struct RequestHandle handle)
static

Cleanup request handle.

Parameters
handleHandle to clean up

Definition at line 80 of file plugin_rest_config.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, and RequestHandle::url.

Referenced by do_error(), get_cont(), options_cont(), and set_cont().

81 {
82  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up\n");
83  if (NULL != handle->url)
84  GNUNET_free (handle->url);
85  GNUNET_free (handle);
86 }
#define GNUNET_log(kind,...)
#define GNUNET_free(ptr)
Wrapper around free.
char * url
The url.
Here is the caller graph for this function:

◆ do_error()

static void do_error ( void *  cls)
static

Task run on shutdown.

Cleans up everything.

Parameters
clsunused
tcscheduler context

Definition at line 96 of file plugin_rest_config.c.

References cleanup_handle(), GNUNET_REST_create_response(), handle, RequestHandle::proc, RequestHandle::proc_cls, and RequestHandle::response_code.

Referenced by get_cont(), rest_config_process_request(), and set_cont().

97 {
98  struct RequestHandle *handle = cls;
99  struct MHD_Response *resp;
100 
101  resp = GNUNET_REST_create_response (NULL);
102  handle->proc (handle->proc_cls, resp, handle->response_code);
103  cleanup_handle (handle);
104 }
GNUNET_REST_ResultProcessor proc
The plugin result processor.
void * proc_cls
The closure of the result processor.
The request handle.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
int response_code
Response code.
struct MHD_Response * GNUNET_REST_create_response(const char *data)
Create REST MHD response.
Definition: rest.c:57
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_sections()

static void add_sections ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

Definition at line 108 of file plugin_rest_config.c.

Referenced by get_cont().

112 {
113  json_t *sections_obj = cls;
114  json_t *sec_obj;
115 
116  sec_obj = json_object_get (sections_obj, section);
117  if (NULL != sec_obj)
118  {
119  json_object_set_new (sec_obj, option, json_string (value));
120  return;
121  }
122  sec_obj = json_object ();
123  json_object_set_new (sec_obj, option, json_string (value));
124  json_object_set_new (sections_obj, section, sec_obj);
125 }
static char * section
Name of the section.
Definition: gnunet-config.c:33
static char * value
Value of the record to add/remove.
static char * option
Name of the option.
Definition: gnunet-config.c:38
Here is the caller graph for this function:

◆ add_section_contents()

static void add_section_contents ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

Definition at line 129 of file plugin_rest_config.c.

Referenced by get_cont().

133 {
134  json_t *section_obj = cls;
135 
136  json_object_set_new (section_obj, option, json_string (value));
137 }
static char * value
Value of the record to add/remove.
static char * option
Name of the option.
Definition: gnunet-config.c:38
Here is the caller graph for this function:

◆ get_cont()

static void get_cont ( struct GNUNET_REST_RequestHandle con_handle,
const char *  url,
void *  cls 
)
static

Handle rest request.

Parameters
handlethe lookup handle

Definition at line 146 of file plugin_rest_config.c.

References add_section_contents(), add_sections(), cleanup_handle(), do_error(), GNUNET_CONFIGURATION_iterate(), GNUNET_CONFIGURATION_iterate_section_values(), GNUNET_free, GNUNET_REST_API_NS_CONFIG, GNUNET_REST_create_response(), GNUNET_SCHEDULER_add_now(), handle, RequestHandle::proc, RequestHandle::proc_cls, response, RequestHandle::response_code, result, section, and RequestHandle::url.

Referenced by rest_config_process_request().

149 {
150  struct MHD_Response *resp;
151  struct RequestHandle *handle = cls;
152  const char *section;
153  char *response;
154  json_t *result;
155 
156  if (strlen (GNUNET_REST_API_NS_CONFIG) > strlen (handle->url))
157  {
158  handle->response_code = MHD_HTTP_BAD_REQUEST;
160  return;
161  }
162  if (strlen (GNUNET_REST_API_NS_CONFIG) == strlen (handle->url))
163  {
164  result = json_object ();
166  }
167  else
168  {
169  result = json_object ();
170  section = &handle->url[strlen (GNUNET_REST_API_NS_CONFIG) + 1];
172  section,
174  result);
175  }
176  response = json_dumps (result, 0);
177  resp = GNUNET_REST_create_response (response);
178  handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
179  cleanup_handle (handle);
180  GNUNET_free (response);
181  json_decref (result);
182 }
#define GNUNET_REST_API_NS_CONFIG
void GNUNET_CONFIGURATION_iterate_section_values(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over values of a section in the configuration.
void GNUNET_CONFIGURATION_iterate(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over all options in the configuration.
const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to our configuration.
GNUNET_REST_ResultProcessor proc
The plugin result processor.
void * proc_cls
The closure of the result processor.
The request handle.
static char * section
Name of the section.
Definition: gnunet-config.c:33
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
static void do_error(void *cls)
Task run on shutdown.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
static int result
Global testing status.
static void add_section_contents(void *cls, const char *section, const char *option, const char *value)
int response_code
Response code.
struct MHD_Response * GNUNET_REST_create_response(const char *data)
Create REST MHD response.
Definition: rest.c:57
static struct MHD_Response * response
Our canonical response.
static void add_sections(void *cls, const char *section, const char *option, const char *value)
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
#define GNUNET_free(ptr)
Wrapper around free.
char * url
The url.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_value()

struct GNUNET_CONFIGURATION_Handle* set_value ( struct GNUNET_CONFIGURATION_Handle config,
const char *  section,
const char *  option,
json_t *  value 
)

Definition at line 186 of file plugin_rest_config.c.

References config, GNUNET_CONFIGURATION_set_value_number(), and GNUNET_CONFIGURATION_set_value_string().

Referenced by set_cont().

190 {
191  if (json_is_string (value))
193  json_string_value (value));
194  else if (json_is_number (value))
196  json_integer_value (value));
197  else if (json_is_null (value))
199  else if (json_is_true (value))
201  else if (json_is_false (value))
203  else
204  return NULL;
205  return config; // for error handling (0 -> success, 1 -> error)
206 }
void GNUNET_CONFIGURATION_set_value_number(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long number)
Set a configuration value that should be a number.
static char * section
Name of the section.
Definition: gnunet-config.c:33
static char * value
Value of the record to add/remove.
static char * option
Name of the option.
Definition: gnunet-config.c:38
static const struct GNUNET_CONFIGURATION_Handle * config
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_cont()

static void set_cont ( struct GNUNET_REST_RequestHandle con_handle,
const char *  url,
void *  cls 
)
static

Handle REST POST request.

Parameters
handlethe lookup handle

Definition at line 215 of file plugin_rest_config.c.

References cleanup_handle(), config_file, GNUNET_REST_RequestHandle::data, GNUNET_REST_RequestHandle::data_size, DIR_SEPARATOR_STR, do_error(), getenv(), GNUNET_asprintf(), GNUNET_CONFIGURATION_dup(), GNUNET_CONFIGURATION_write(), GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_memcpy, GNUNET_OS_project_data_get(), GNUNET_REST_API_NS_CONFIG, GNUNET_REST_create_response(), GNUNET_SCHEDULER_add_now(), GNUNET_strdup, handle, option, RequestHandle::proc, RequestHandle::proc_cls, RequestHandle::response_code, RequestHandle::rest_handle, section, set_value(), RequestHandle::url, and value.

Referenced by rest_config_process_request().

218 {
219  struct RequestHandle *handle = cls;
220  char term_data[handle->rest_handle->data_size + 1];
222 
223  json_error_t err;
224  json_t *data_json;
225  const char *section;
226  const char *option;
227  json_t *sec_obj;
228  json_t *value;
229  char *cfg_fn;
230 
231  // invalid url
232  if (strlen (GNUNET_REST_API_NS_CONFIG) > strlen (handle->url))
233  {
234  handle->response_code = MHD_HTTP_BAD_REQUEST;
236  return;
237  }
238 
239  // extract data from handle
240  term_data[handle->rest_handle->data_size] = '\0';
241  GNUNET_memcpy (term_data,
242  handle->rest_handle->data,
243  handle->rest_handle->data_size);
244  data_json = json_loads (term_data, JSON_DECODE_ANY, &err);
245 
246  if (NULL == data_json)
247  {
249  "Unable to parse JSON Object from %s\n",
250  term_data);
252  return;
253  }
254 
255  // POST /config => {<section> : {<option> : <value>}}
256  if (strlen (GNUNET_REST_API_NS_CONFIG) == strlen (handle->url)) // POST /config
257  {
258  // iterate over sections
259  json_object_foreach (data_json, section, sec_obj)
260  {
261  // iterate over options
262  json_object_foreach (sec_obj, option, value)
263  {
264  out = set_value (out, section, option, value);
265  if (NULL == out)
266  {
267  handle->response_code = MHD_HTTP_BAD_REQUEST;
269  json_decref (data_json);
270  return;
271  }
272  }
273  }
274  }
275  else // POST /config/<section> => {<option> : <value>}
276  {
277  // extract the "<section>" part from the url
278  section = &handle->url[strlen (GNUNET_REST_API_NS_CONFIG) + 1];
279  // iterate over options
280  json_object_foreach (data_json, option, value)
281  {
282  out = set_value (out, section, option, value);
283  if (NULL == out)
284  {
285  handle->response_code = MHD_HTTP_BAD_REQUEST;
287  json_decref (data_json);
288  return;
289  }
290  }
291  }
292  json_decref (data_json);
293 
294 
295  // get cfg file path
296  cfg_fn = NULL;
297  const char *xdg = getenv ("XDG_CONFIG_HOME");
298  if (NULL != xdg)
299  GNUNET_asprintf (&cfg_fn,
300  "%s%s%s",
301  xdg,
304  else
305  cfg_fn = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
306 
307  GNUNET_CONFIGURATION_write (out, cfg_fn);
308  cfg = out;
309  handle->proc (handle->proc_cls,
311  MHD_HTTP_OK);
312  cleanup_handle (handle);
313 }
#define GNUNET_REST_API_NS_CONFIG
int GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
size_t data_size
The POST data size.
const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to our configuration.
GNUNET_REST_ResultProcessor proc
The plugin result processor.
static char * config_file
Set to the name of the config file used.
Definition: gnunet-arm.c:84
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
void * proc_cls
The closure of the result processor.
The request handle.
static char * section
Name of the section.
Definition: gnunet-config.c:33
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
static char * value
Value of the record to add/remove.
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
#define DIR_SEPARATOR_STR
Definition: platform.h:168
static char * option
Name of the option.
Definition: gnunet-config.c:38
static void do_error(void *cls)
Task run on shutdown.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
struct GNUNET_REST_RequestHandle * rest_handle
Rest connection.
int response_code
Response code.
const char * data
The POST data.
char * getenv()
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
configuration data
Definition: configuration.c:85
struct MHD_Response * GNUNET_REST_create_response(const char *data)
Create REST MHD response.
Definition: rest.c:57
#define GNUNET_log(kind,...)
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
struct GNUNET_CONFIGURATION_Handle * set_value(struct GNUNET_CONFIGURATION_Handle *config, const char *section, const char *option, json_t *value)
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
char * url
The url.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ options_cont()

static void options_cont ( struct GNUNET_REST_RequestHandle con_handle,
const char *  url,
void *  cls 
)
static

Handle rest request.

Parameters
handlethe lookup handle

Definition at line 322 of file plugin_rest_config.c.

References cleanup_handle(), GNUNET_REST_create_response(), handle, RequestHandle::proc, and RequestHandle::proc_cls.

Referenced by rest_config_process_request().

325 {
326  struct MHD_Response *resp;
327  struct RequestHandle *handle = cls;
328 
329  resp = GNUNET_REST_create_response (NULL);
330  MHD_add_response_header (resp,
331  "Access-Control-Allow-Methods",
332  MHD_HTTP_METHOD_GET);
333  handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
334  cleanup_handle (handle);
335 }
GNUNET_REST_ResultProcessor proc
The plugin result processor.
void * proc_cls
The closure of the result processor.
The request handle.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
struct MHD_Response * GNUNET_REST_create_response(const char *data)
Create REST MHD response.
Definition: rest.c:57
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ rest_config_process_request()

static void rest_config_process_request ( struct GNUNET_REST_RequestHandle conndata_handle,
GNUNET_REST_ResultProcessor  proc,
void *  proc_cls 
)
static

Function processing the REST call.

Parameters
methodHTTP method
urlURL of the HTTP request
databody of the HTTP request (optional)
data_sizelength of the body
proccallback function for the result
proc_clsclosure for proc
Returns
GNUNET_OK if request accepted

Definition at line 350 of file plugin_rest_config.c.

References do_error(), GNUNET_REST_RequestHandlerError::error_code, get_cont(), GNUNET_new, GNUNET_NO, GNUNET_REST_API_NS_CONFIG, GNUNET_REST_handle_request(), GNUNET_REST_HANDLER_END, GNUNET_SCHEDULER_add_now(), GNUNET_strdup, handle, options_cont(), RequestHandle::proc, RequestHandle::proc_cls, RequestHandle::response_code, RequestHandle::rest_handle, set_cont(), GNUNET_REST_RequestHandle::url, and RequestHandle::url.

Referenced by libgnunet_plugin_rest_config_init().

353 {
354  static const struct GNUNET_REST_RequestHandler handlers[] = {
355  { MHD_HTTP_METHOD_GET, GNUNET_REST_API_NS_CONFIG, &get_cont },
356  { MHD_HTTP_METHOD_POST, GNUNET_REST_API_NS_CONFIG, &set_cont },
357  { MHD_HTTP_METHOD_OPTIONS, GNUNET_REST_API_NS_CONFIG, &options_cont },
359  };
360  struct RequestHandle *handle = GNUNET_new (struct RequestHandle);
362 
363  handle->proc_cls = proc_cls;
364  handle->proc = proc;
365  handle->rest_handle = conndata_handle;
366  handle->url = GNUNET_strdup (conndata_handle->url);
367  if (handle->url[strlen (handle->url) - 1] == '/')
368  handle->url[strlen (handle->url) - 1] = '\0';
369 
370  if (GNUNET_NO ==
371  GNUNET_REST_handle_request (conndata_handle, handlers, &err, handle))
372  {
373  handle->response_code = err.error_code;
375  }
376 }
#define GNUNET_REST_API_NS_CONFIG
GNUNET_REST_ResultProcessor proc
The plugin result processor.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
void * proc_cls
The closure of the result processor.
#define GNUNET_REST_HANDLER_END
The request handle.
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
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
static void do_error(void *cls)
Task run on shutdown.
static void get_cont(struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
Handle rest request.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
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
struct GNUNET_REST_RequestHandle * rest_handle
Rest connection.
int response_code
Response code.
static void set_cont(struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
Handle REST POST request.
static void options_cont(struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
Handle rest request.
char * url
The url.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ libgnunet_plugin_rest_config_init()

void* libgnunet_plugin_rest_config_init ( void *  cls)

Entry point for the plugin.

Parameters
clsthe "struct GNUNET_NAMESTORE_PluginEnvironment*"
Returns
NULL on error, otherwise the plugin context

Definition at line 386 of file plugin_rest_config.c.

References _, Plugin::api, Plugin::cfg, GNUNET_REST_Plugin::cls, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_new, GNUNET_REST_API_NS_CONFIG, GNUNET_REST_Plugin::name, plugin, GNUNET_REST_Plugin::process_request, and rest_config_process_request().

387 {
388  static struct Plugin plugin;
389 
390  cfg = cls;
391  struct GNUNET_REST_Plugin *api;
392 
393  if (NULL != plugin.cfg)
394  return NULL; /* can only initialize once! */
395  memset (&plugin, 0, sizeof(struct Plugin));
396  plugin.cfg = cfg;
397  api = GNUNET_new (struct GNUNET_REST_Plugin);
398  api->cls = &plugin;
401  GNUNET_log (GNUNET_ERROR_TYPE_INFO, _ ("CONFIG REST API initialized\n"));
402  return api;
403 }
#define GNUNET_REST_API_NS_CONFIG
void * cls
The closure of the plugin.
const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to our configuration.
struct returned by the initialization function of the plugin
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void(* process_request)(struct GNUNET_REST_RequestHandle *handle, GNUNET_REST_ResultProcessor proc, void *proc_cls)
Function to process a REST call.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static void rest_config_process_request(struct GNUNET_REST_RequestHandle *conndata_handle, GNUNET_REST_ResultProcessor proc, void *proc_cls)
Function processing the REST call.
char * name
Plugin name.
static char * plugin
Solver plugin name as string.
Handle for a plugin.
Definition: block.c:37
#define GNUNET_log(kind,...)
Here is the call graph for this function:

◆ libgnunet_plugin_rest_config_done()

void* libgnunet_plugin_rest_config_done ( void *  cls)

Exit point from the plugin.

Parameters
clsthe plugin context (as returned by "init")
Returns
always NULL

Definition at line 413 of file plugin_rest_config.c.

References Plugin::api, Plugin::cfg, GNUNET_REST_Plugin::cls, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, and plugin.

414 {
415  struct GNUNET_REST_Plugin *api = cls;
416  struct Plugin *plugin = api->cls;
417 
418  plugin->cfg = NULL;
419  GNUNET_free (api);
420  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "CONFIG REST plugin is finished\n");
421  return NULL;
422 }
void * cls
The closure of the plugin.
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
struct returned by the initialization function of the plugin
static char * plugin
Solver plugin name as string.
Handle for a plugin.
Definition: block.c:37
#define GNUNET_log(kind,...)
#define GNUNET_free(ptr)
Wrapper around free.

Variable Documentation

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg

Handle to our configuration.

Handle to our configuration.

Definition at line 43 of file plugin_rest_config.c.