functions to parse HTTP uploads with MHD More...

#include "gnunet_util_lib.h"
#include <microhttpd.h>
#include <jansson.h>

Include dependency graph for gnunet_mhd_lib.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	GNUNET_MHD_PostResult { GNUNET_MHD_PR_SUCCESS , GNUNET_MHD_PR_CONTINUE , GNUNET_MHD_PR_OUT_OF_MEMORY , GNUNET_MHD_PR_REQUEST_TOO_LARGE , GNUNET_MHD_PR_JSON_INVALID }
	Return codes from GNUNET_MHD_post_parser(). More...

Functions
enum GNUNET_MHD_PostResult	GNUNET_MHD_post_parser (size_t buffer_max, struct MHD_Connection connection, void con_cls, const char upload_data, size_t upload_data_size, json_t *json)
	Process a POST request containing a JSON object. More...

void	GNUNET_MHD_post_parser_cleanup (void *con_cls)
	Function called whenever we are done with a request to clean up our state. More...

Detailed Description

functions to parse HTTP uploads with MHD

Author: Christian Grothoff

Definition in file gnunet_mhd_lib.h.

Enumeration Type Documentation

◆ GNUNET_MHD_PostResult

enum GNUNET_MHD_PostResult

Return codes from GNUNET_MHD_post_parser().

Enumerator
GNUNET_MHD_PR_SUCCESS	Parsing successful, JSON result is in `*json`.
GNUNET_MHD_PR_CONTINUE	Parsing continues, call again soon!
GNUNET_MHD_PR_OUT_OF_MEMORY	Sorry, memory allocation (malloc()) failed.
GNUNET_MHD_PR_REQUEST_TOO_LARGE	Request size exceeded `buffer_max` argument.
GNUNET_MHD_PR_JSON_INVALID	JSON parsing failed. This was not a JSON upload.

Definition at line 36 of file gnunet_mhd_lib.h.

{
  GNUNET_MHD_PR_SUCCESS,
 
  GNUNET_MHD_PR_CONTINUE,
 
  GNUNET_MHD_PR_OUT_OF_MEMORY,
 
  GNUNET_MHD_PR_REQUEST_TOO_LARGE,
 
  GNUNET_MHD_PR_JSON_INVALID
};

Function Documentation

◆ GNUNET_MHD_post_parser()

enum GNUNET_MHD_PostResult GNUNET_MHD_post_parser	(	size_t	buffer_max,
		struct MHD_Connection *	connection,
		void **	con_cls,
		const char *	upload_data,
		size_t *	upload_data_size,
		json_t **	json
	)

Process a POST request containing a JSON object.

This function realizes an MHD POST processor that will (incrementally) process JSON data uploaded to the HTTP server. It will store the required state in the con_cls, which must be cleaned up using #GNUNET_MHD_post_parser_callback().

Parameters

buffer_max	maximum allowed size for the buffer
connection	MHD connection handle (for meta data about the upload)
con_cls	the closure (will point to a `struct Buffer *`)
upload_data	the POST data
upload_data_size	number of bytes in upload_data
json	the JSON object for a completed request

Returns: result code indicating the status of the operation

Definition at line 266 of file mhd_upload.c.

{
  struct Buffer *r = *con_cls;
  const char *ce;
  int ret;
 
  *json = NULL;
  if (NULL == *con_cls)
  {
    /* We are seeing a fresh POST request. */
    r = GNUNET_new (struct Buffer);
    if (GNUNET_OK != buffer_init (r,
                                  upload_data,
                                  *upload_data_size,
                                  REQUEST_BUFFER_INITIAL,
                                  buffer_max))
    {
      *con_cls = NULL;
      buffer_deinit (r);
      GNUNET_free (r);
      return GNUNET_MHD_PR_OUT_OF_MEMORY;
    }
    /* everything OK, wait for more POST data */
    *upload_data_size = 0;
    *con_cls = r;
    return GNUNET_MHD_PR_CONTINUE;
  }
  if (0 != *upload_data_size)
  {
    /* We are seeing an old request with more data available. */
 
    if (GNUNET_OK !=
        buffer_append (r, upload_data, *upload_data_size, buffer_max))
    {
      /* Request too long */
      *con_cls = NULL;
      buffer_deinit (r);
      GNUNET_free (r);
      return GNUNET_MHD_PR_REQUEST_TOO_LARGE;
    }
    /* everything OK, wait for more POST data */
    *upload_data_size = 0;
    return GNUNET_MHD_PR_CONTINUE;
  }
 
  /* We have seen the whole request. */
  ce = MHD_lookup_connection_value (connection,
                                    MHD_HEADER_KIND,
                                    MHD_HTTP_HEADER_CONTENT_ENCODING);
  if ((NULL != ce) && (0 == strcasecmp ("deflate", ce)))
  {
    ret = inflate_data (r);
    if (GNUNET_MHD_PR_SUCCESS != ret)
    {
      buffer_deinit (r);
      GNUNET_free (r);
      *con_cls = NULL;
      return ret;
    }
  }
 
  {
    json_error_t err;
 
    *json = json_loadb (r->data,
                        r->fill,
                        0,
                        &err);
    if (NULL == *json)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  "Failed to parse JSON request body of %u byte at offset %d: %s\n",
                  (unsigned int) r->fill,
                  err.position,
                  err.text);
      buffer_deinit (r);
      GNUNET_free (r);
      *con_cls = NULL;
      return GNUNET_MHD_PR_JSON_INVALID;
    }
  }
  buffer_deinit (r);
  GNUNET_free (r);
  *con_cls = NULL;
 
  return GNUNET_MHD_PR_SUCCESS;
}

References buffer_append(), buffer_deinit(), buffer_init(), Buffer::data, Buffer::fill, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_MHD_PR_CONTINUE, GNUNET_MHD_PR_JSON_INVALID, GNUNET_MHD_PR_OUT_OF_MEMORY, GNUNET_MHD_PR_REQUEST_TOO_LARGE, GNUNET_MHD_PR_SUCCESS, GNUNET_new, GNUNET_OK, inflate_data(), REQUEST_BUFFER_INITIAL, and ret.

Here is the call graph for this function:

◆ GNUNET_MHD_post_parser_cleanup()

void GNUNET_MHD_post_parser_cleanup ( void * con_cls )

Function called whenever we are done with a request to clean up our state.

Parameters

con_cls value as it was left by GNUNET_MHD_post_parser(), to be cleaned up

Definition at line 368 of file mhd_upload.c.

{
  struct Buffer *r = con_cls;
 
  if (NULL != r)
  {
    buffer_deinit (r);
    GNUNET_free (r);
  }
}

References buffer_deinit(), and GNUNET_free.