GNUnet  0.11.x
Data Structures | Macros | Functions | Variables
plugin_rest_copying.c File Reference
#include "platform.h"
#include "gnunet_rest_plugin.h"
#include <gnunet_rest_lib.h>
Include dependency graph for plugin_rest_copying.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_COPYING   "/copying"
 
#define GNUNET_REST_COPYING_TEXT   "GNU Affero General Public License version 3 or later. See also: <http://www.gnu.org/licenses/>"
 

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 get_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
 Handle rest request. More...
 
static void options_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
 Handle rest request. More...
 
static void rest_copying_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_copying_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_rest_copying_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_COPYING

#define GNUNET_REST_API_NS_COPYING   "/copying"

◆ GNUNET_REST_COPYING_TEXT

#define GNUNET_REST_COPYING_TEXT   "GNU Affero General Public License version 3 or later. See also: <http://www.gnu.org/licenses/>"

Definition at line 33 of file plugin_rest_copying.c.

Referenced by get_cont().

Function Documentation

◆ cleanup_handle()

static void cleanup_handle ( struct RequestHandle handle)
static

Cleanup request handle.

Parameters
handleHandle to clean up

Definition at line 76 of file plugin_rest_copying.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, and GNUNET_log.

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

77 {
79  "Cleaning up\n");
80  GNUNET_free (handle);
81 }
#define GNUNET_log(kind,...)
#define GNUNET_free(ptr)
Wrapper around free.
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 91 of file plugin_rest_copying.c.

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

Referenced by rest_copying_process_request().

92 {
93  struct RequestHandle *handle = cls;
94  struct MHD_Response *resp;
95 
96  resp = GNUNET_REST_create_response (NULL);
97  handle->proc (handle->proc_cls, resp, handle->response_code);
98  cleanup_handle (handle);
99 }
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
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
Here is the call graph for this function:
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 108 of file plugin_rest_copying.c.

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

Referenced by rest_copying_process_request().

111 {
112  struct MHD_Response *resp;
113  struct RequestHandle *handle = cls;
114 
116  handle->proc (handle->proc_cls,
117  resp,
118  MHD_HTTP_OK);
119  cleanup_handle (handle);
120 }
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
GNUNET_REST_ResultProcessor proc
The plugin result processor.
void * proc_cls
The closure of the result processor.
The request handle.
#define GNUNET_REST_COPYING_TEXT
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
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 129 of file plugin_rest_copying.c.

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

Referenced by rest_copying_process_request().

132 {
133  struct MHD_Response *resp;
134  struct RequestHandle *handle = cls;
135 
136  resp = GNUNET_REST_create_response (NULL);
137  MHD_add_response_header (resp,
138  "Access-Control-Allow-Methods",
139  MHD_HTTP_METHOD_GET);
140  handle->proc (handle->proc_cls,
141  resp,
142  MHD_HTTP_OK);
143  cleanup_handle (handle);
144 }
static void cleanup_handle(struct RequestHandle *handle)
Cleanup request handle.
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
Here is the call graph for this function:
Here is the caller graph for this function:

◆ rest_copying_process_request()

static void rest_copying_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 159 of file plugin_rest_copying.c.

References do_error(), GNUNET_REST_RequestHandlerError::error_code, get_cont(), GNUNET_new, GNUNET_NO, GNUNET_REST_API_NS_COPYING, GNUNET_REST_handle_request(), GNUNET_REST_HANDLER_END, GNUNET_SCHEDULER_add_now(), handle, options_cont(), RequestHandle::proc, RequestHandle::proc_cls, RequestHandle::response_code, and RequestHandle::rest_handle.

Referenced by libgnunet_plugin_rest_copying_init().

162 {
163  static const struct GNUNET_REST_RequestHandler handlers[] = {
164  { MHD_HTTP_METHOD_GET, GNUNET_REST_API_NS_COPYING, &get_cont },
165  { MHD_HTTP_METHOD_OPTIONS, GNUNET_REST_API_NS_COPYING, &options_cont },
167  };
168  struct RequestHandle *handle = GNUNET_new (struct RequestHandle);
170 
171  handle->proc_cls = proc_cls;
172  handle->proc = proc;
173  handle->rest_handle = conndata_handle;
174 
175  if (GNUNET_NO == GNUNET_REST_handle_request (conndata_handle,
176  handlers,
177  &err,
178  handle))
179  {
180  handle->response_code = err.error_code;
182  }
183 }
#define GNUNET_REST_API_NS_COPYING
GNUNET_REST_ResultProcessor proc
The plugin result processor.
#define GNUNET_NO
Definition: gnunet_common.h:78
static void do_error(void *cls)
Task run on shutdown.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
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.
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 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 options_cont(struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
Handle rest request.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ libgnunet_plugin_rest_copying_init()

void* libgnunet_plugin_rest_copying_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 193 of file plugin_rest_copying.c.

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

194 {
195  static struct Plugin plugin;
196 
197  cfg = cls;
198  struct GNUNET_REST_Plugin *api;
199 
200  if (NULL != plugin.cfg)
201  return NULL; /* can only initialize once! */
202  memset (&plugin, 0, sizeof(struct Plugin));
203  plugin.cfg = cfg;
204  api = GNUNET_new (struct GNUNET_REST_Plugin);
205  api->cls = &plugin;
209  _ ("COPYING REST API initialized\n"));
210  return api;
211 }
const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to our configuration.
#define GNUNET_REST_API_NS_COPYING
void * cls
The closure of the plugin.
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_copying_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_copying_done()

void* libgnunet_plugin_rest_copying_done ( void *  cls)

Exit point from the plugin.

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

Definition at line 221 of file plugin_rest_copying.c.

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

222 {
223  struct GNUNET_REST_Plugin *api = cls;
224  struct Plugin *plugin = api->cls;
225 
226  plugin->cfg = NULL;
227  GNUNET_free (api);
229  "COPYING REST plugin is finished\n");
230  return NULL;
231 }
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 44 of file plugin_rest_copying.c.