/*
This file is part of TALER
Copyright (C) 2014-2017 GNUnet e.V.
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
TALER is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with
TALER; see the file COPYING. If not, see
*/
/**
* @file taler-merchant-httpd_responses.h
* @brief API for generating the various replies of the exchange; these
* functions are called TMH_RESPONSE_reply_ and they generate
* and queue MHD response objects for a given connection.
* @author Florian Dold
* @author Benedikt Mueller
* @author Christian Grothoff
*/
#ifndef TALER_EXCHANGE_HTTPD_RESPONSES_H
#define TALER_EXCHANGE_HTTPD_RESPONSES_H
#include
#include
#include
#include
/* just need some structs, not the actual API */
#include
#include "taler_merchant_service.h"
/**
* Make JSON response object.
*
* @param json the json object
* @return MHD response object
*/
struct MHD_Response *
TMH_RESPONSE_make_json (const json_t *json);
/**
* Send JSON object as response.
*
* @param connection the MHD connection
* @param json the json object
* @param response_code the http response code
* @return MHD result code
*/
int
TMH_RESPONSE_reply_json (struct MHD_Connection *connection,
const json_t *json,
unsigned int response_code);
/**
* Make JSON response object.
*
* @param fmt format string for pack
* @param ... varargs
* @return MHD response object
*/
struct MHD_Response *
TMH_RESPONSE_make_json_pack (const char *fmt,
...);
/**
* Function to call to handle the request by building a JSON
* reply from a format string and varargs.
*
* @param connection the MHD connection to handle
* @param response_code HTTP response code to use
* @param fmt format string for pack
* @param ... varargs
* @return MHD result code
*/
int
TMH_RESPONSE_reply_json_pack (struct MHD_Connection *connection,
unsigned int response_code,
const char *fmt,
...);
/**
* Send a response indicating that the JSON was malformed.
*
* @param connection the MHD connection to use
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_invalid_json (struct MHD_Connection *connection);
/**
* Send a response indicating that we did not find the @a object
* needed for the reply.
*
* @param connection the MHD connection to use
* @param response_code response code to use
* @param ec error code to return
* @param msg human-readable diagnostic
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_rc (struct MHD_Connection *connection,
unsigned int response_code,
enum TALER_ErrorCode ec,
const char *msg);
/**
* Send a response indicating that we did not find the @a object
* needed for the reply.
*
* @param connection the MHD connection to use
* @param ec error code to return
* @param object name of the object we did not find
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_not_found (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *object);
/**
* Send a response indicating that the request was malformed.
*
* @param connection the MHD connection to use
* @param ec error code to return
* @param issue description of what was wrong with the request
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_bad_request (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *issue);
/**
* Send a response indicating an internal error.
*
* @param connection the MHD connection to use
* @param ec error code to return
* @param hint hint about the internal error's nature
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_internal_error (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *hint);
/**
* Create a response indicating an internal error.
*
* @param ec error code to return
* @param hint hint about the internal error's nature
* @return a MHD response object
*/
struct MHD_Response *
TMH_RESPONSE_make_internal_error (enum TALER_ErrorCode ec,
const char *hint);
/**
* Send a response indicating an external error.
*
* @param connection the MHD connection to use
* @param ec error code to return
* @param hint hint about the error's nature
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_external_error (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *hint);
/**
* Create a response indicating an external error.
*
* @param ec error code to return
* @param hint hint about the internal error's nature
* @return a MHD response object
*/
struct MHD_Response *
TMH_RESPONSE_make_external_error (enum TALER_ErrorCode ec,
const char *hint);
/**
* Send a response indicating that the request was too big.
*
* @param connection the MHD connection to use
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_request_too_large (struct MHD_Connection *connection);
/**
* Add headers we want to return in every response.
* Useful for testing, like if we want to always close
* connections.
*
* @param response response to modify
*/
void
TMH_RESPONSE_add_global_headers (struct MHD_Response *response);
/**
* Send a response indicating a missing argument.
*
* @param connection the MHD connection to use
* @param ec error code to return
* @param param_name the parameter that is missing
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_arg_missing (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *param_name);
/**
* Send a response indicating an invalid argument.
*
* @param connection the MHD connection to use
* @param ec error code to return
* @param param_name the parameter that is invalid
* @return a MHD result code
*/
int
TMH_RESPONSE_reply_arg_invalid (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *param_name);
#endif