X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_json_lib.h;h=9e5f9e28486fe19dce48d77bb75905ca337ff268;hb=e933b0a58ab7b0f21faef0267c2cb835cabd5a03;hp=15e85c41160a4eec6ef008b37fdaea40b6f5ffa4;hpb=1733de7305720882b8745e82b51b6ff47c10099e;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_json_lib.h b/src/include/gnunet_json_lib.h index 15e85c411..9e5f9e284 100644 --- a/src/include/gnunet_json_lib.h +++ b/src/include/gnunet_json_lib.h @@ -311,6 +311,16 @@ GNUNET_JSON_from_data (const void *data, size_t size); +/** + * Convert binary data to a JSON string with the base32crockford + * encoding. + * + * @param ptr binary data, sizeof (*ptr) must yield correct size + * @return json string that encodes @a data + */ +#define GNUNET_JSON_from_data_auto(ptr) GNUNET_JSON_from_data(ptr, sizeof (*ptr)) + + /** * Convert absolute timestamp to a json string. * @@ -351,6 +361,72 @@ json_t * GNUNET_JSON_from_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *sig); +/* ******************* Helpers for MHD upload handling ******************* */ + +/** + * Return codes from #GNUNET_JSON_post_parser(). + */ +enum GNUNET_JSON_PostResult { + /** + * Parsing successful, JSON result is in `*json`. + */ + GNUNET_JSON_PR_SUCCESS, + + /** + * Parsing continues, call again soon! + */ + GNUNET_JSON_PR_CONTINUE, + + /** + * Sorry, memory allocation (malloc()) failed. + */ + GNUNET_JSON_PR_OUT_OF_MEMORY, + + /** + * Request size exceeded `buffer_max` argument. + */ + GNUNET_JSON_PR_REQUEST_TOO_LARGE, + + /** + * JSON parsing failed. This was not a JSON upload. + */ + GNUNET_JSON_PR_JSON_INVALID +}; + + +/** + * 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 @a con_cls, which must be cleaned up using + * #GNUNET_JSON_post_parser_callback(). + * + * @param buffer_max maximum allowed size for the buffer + * @param con_cls the closure (will point to a `struct Buffer *`) + * @param upload_data the POST data + * @param upload_data_size number of bytes in @a upload_data + * @param json the JSON object for a completed request + * @return result code indicating the status of the operation + */ +enum GNUNET_JSON_PostResult +GNUNET_JSON_post_parser (size_t buffer_max, + void **con_cls, + const char *upload_data, + size_t *upload_data_size, + json_t **json); + + +/** + * Function called whenever we are done with a request + * to clean up our state. + * + * @param con_cls value as it was left by + * #GNUNET_JSON_post_parser(), to be cleaned up + */ +void +GNUNET_JSON_post_parser_cleanup (void *con_cls); + + #endif /* end of gnunet_json_lib.h */