1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
|
// Copyright Maarten L. Hekkelman, Radboud University 2008-2013.
// Copyright Maarten L. Hekkelman, 2014-2022
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
#pragma once
/// \file
/// definition of the zeep::rest_controller class.
/// Instances of this class take care of mapping member functions to
/// REST calls automatically converting in- and output data
#include <zeep/config.hpp>
#include <filesystem>
#include <fstream>
#include <utility>
#include <tuple>
#include <zeep/http/controller.hpp>
#include <zeep/json/parser.hpp>
namespace zeep::http
{
/// \brief class that helps with handling REST requests
///
/// This controller will handle REST requests. (See https://restfulapi.net/ for more info on REST)
///
/// To use this, create a subclass and add some methods that should be exposed.
/// Then _map_ these methods on a path that optionally contains parameter values.
///
/// See the chapter on REST controllers in the documention for more information.
class rest_controller : public controller
{
public:
/// \brief constructor
///
/// \param prefix_path This is the leading part of the request URI for each mount point
/// \param auth Optionally protect these REST calls with a authentication validator.
/// This validator should also be added to the web_app that will contain
/// this controller.
rest_controller(const std::string& prefix_path)
: controller(prefix_path) {}
~rest_controller();
/// \brief will do the hard work
virtual bool handle_request(request& req, reply& rep);
protected:
using param = header;
/// \brief helper class for pulling parameter values out of the request
struct parameter_pack
{
parameter_pack(const request& req) : m_req(req) {}
std::string get_parameter(const char* name) const
{
auto p = std::find_if(m_path_parameters.begin(), m_path_parameters.end(),
[name](auto& pp) { return pp.name == name; });
if (p != m_path_parameters.end())
return p->value;
else
return m_req.get_parameter(name);
}
std::tuple<std::string,bool> get_parameter_ex(const char* name) const
{
auto p = std::find_if(m_path_parameters.begin(), m_path_parameters.end(),
[name](auto& pp) { return pp.name == name; });
if (p != m_path_parameters.end())
return { p->value, true };
else
return m_req.get_parameter_ex(name);
}
std::vector<std::string> get_parameters(const char* name) const
{
auto p = std::find_if(m_path_parameters.begin(), m_path_parameters.end(),
[name](auto& pp) { return pp.name == name; });
if (p != m_path_parameters.end())
return { p->value };
else
{
std::vector<std::string> result;
for (const auto& [p_name, p_value]: m_req.get_parameters())
{
if (p_name != name)
continue;
result.push_back(p_value);
}
return result;
}
}
file_param get_file_parameter(const char* name) const
{
return m_req.get_file_parameter(name);
}
std::vector<file_param> get_file_parameters(const char* name) const
{
return m_req.get_file_parameters(name);
}
const request& m_req;
std::vector<param> m_path_parameters;
};
/// \brief abstract base class for mount points
struct mount_point_base
{
mount_point_base(const char* path, const std::string& method)
: m_path(path), m_method(method) {}
virtual ~mount_point_base() {}
virtual void call(const parameter_pack& params, reply& reply) = 0;
std::string m_path;
std::string m_method;
std::regex m_rx;
std::vector<std::string> m_path_params;
};
template<typename Callback, typename...>
struct mount_point {};
template<typename ControllerType, typename Result, typename... Args>
struct mount_point<Result(ControllerType::*)(Args...)> : mount_point_base
{
using Sig = Result(ControllerType::*)(Args...);
using ArgsTuple = std::tuple<typename std::remove_const_t<typename std::remove_reference_t<Args>>...>;
using ResultType = typename std::remove_const_t<typename std::remove_reference_t<Result>>;
using Callback = std::function<ResultType(Args...)>;
static constexpr size_t N = sizeof...(Args);
template<typename... Names>
mount_point(const char* path, const std::string& method, rest_controller* owner, Sig sig, Names... names)
: mount_point_base(path, method)
{
static_assert(sizeof...(Names) == sizeof...(Args), "Number of names should be equal to number of arguments of callback function");
ControllerType* controller = dynamic_cast<ControllerType*>(owner);
if (controller == nullptr)
throw std::runtime_error("Invalid controller for callback");
m_callback = [controller, sig](Args... args) {
return (controller->*sig)(args...);
};
if constexpr (sizeof...(Names) > 0)
{
// for (auto name: {...names })
size_t ix = 0;
for (auto name: {names...})
m_names[ix++] = name;
// construct a regex for matching paths
namespace fs = std::filesystem;
fs::path p = path;
std::string ps;
for (auto pp: p)
{
if (pp.empty())
continue;
if (not ps.empty())
ps += '/';
if (pp.string().front() == '{' and pp.string().back() == '}')
{
auto param = pp.string().substr(1, pp.string().length() - 2);
auto i = std::find(m_names.begin(), m_names.end(), param);
if (i == m_names.end())
{
assert(false);
throw std::runtime_error("Invalid path for mount point, a parameter was not found in the list of parameter names");
}
size_t ni = i - m_names.begin();
m_path_params.emplace_back(m_names[ni]);
ps += "([^/]+)";
}
else
ps += pp.string();
}
m_rx.assign(ps);
}
}
virtual void call(const parameter_pack& params, reply& reply)
{
try
{
json::element message("ok");
reply.set_content(message);
reply.set_status(ok);
ArgsTuple args = collect_arguments(params, std::make_index_sequence<N>());
invoke<Result>(std::move(args), reply);
}
catch (const std::exception& e)
{
json::element message;
message["error"] = e.what();
reply.set_content(message);
reply.set_status(internal_server_error);
}
}
template<typename ResultType, typename ArgsTuple, std::enable_if_t<std::is_void_v<ResultType>, int> = 0>
void invoke(ArgsTuple&& args, reply& /*reply*/)
{
std::apply(m_callback, std::forward<ArgsTuple>(args));
}
template<typename ResultType, typename ArgsTuple, std::enable_if_t<not (std::is_void_v<ResultType> or std::is_same_v<ResultType, reply>), int> = 0>
void invoke(ArgsTuple&& args, reply& reply)
{
set_reply(reply, std::apply(m_callback, std::forward<ArgsTuple>(args)));
}
template<typename ResultType, typename ArgsTuple, std::enable_if_t<std::is_same_v<ResultType, reply>, int> = 0>
void invoke(ArgsTuple&& args, reply& reply)
{
reply = std::apply(m_callback, std::forward<ArgsTuple>(args));
}
void set_reply(reply& rep, std::filesystem::path v)
{
rep.set_content(new std::ifstream(v, std::ios::binary), "application/octet-stream");
}
void set_reply(reply& rep, zeep::json::element&& v)
{
rep.set_content(std::move(v));
}
template<typename T>
void set_reply(reply& rep, T&& v)
{
json::element e;
to_element(e, v);
rep.set_content(e);
}
template<std::size_t... I>
ArgsTuple collect_arguments(const parameter_pack& params, std::index_sequence<I...>)
{
// return std::make_tuple(params.get_parameter(m_names[I])...);
return std::make_tuple(get_parameter(params, m_names[I], typename std::tuple_element_t<I, ArgsTuple>{})...);
}
bool get_parameter(const parameter_pack& params, const char* name, bool result)
{
try
{
auto v = params.get_parameter(name);
result = v == "true" or v == "1" or v == "on";
}
catch (const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
std::string get_parameter(const parameter_pack& params, const char* name, std::string result)
{
try
{
result = params.get_parameter(name);
}
catch (const std::exception&)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
file_param get_parameter(const parameter_pack& params, const char* name, file_param result)
{
try
{
result = params.get_file_parameter(name);
}
catch (const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
std::vector<file_param> get_parameter(const parameter_pack& params, const char* name, std::vector<file_param> result)
{
try
{
result = params.get_file_parameters(name);
}
catch (const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
json::element get_parameter(const parameter_pack& params, const char* name, json::element result)
{
try
{
json::parse_json(params.get_parameter(name), result);
}
catch (const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
template<typename T>
std::optional<T> get_parameter(const parameter_pack& params, const char* name, std::optional<T> result)
{
try
{
const auto& [s, available] = params.get_parameter_ex(name);
if (available)
result = boost::lexical_cast<T>(s);
}
catch (const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
std::optional<std::string> get_parameter(const parameter_pack& params, const char* name, std::optional<std::string> result)
{
try
{
const auto& [s, available] = params.get_parameter_ex(name);
if (available)
result = s;
}
catch (const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
template<typename T, std::enable_if_t<not (
zeep::has_serialize_v<T, zeep::json::deserializer<json::element>> or std::is_enum_v<T> or
zeep::is_serializable_array_type_v<T, zeep::json::deserializer<json::element>>), int> = 0>
T get_parameter(const parameter_pack& params, const char* name, T result)
{
try
{
auto p = params.get_parameter(name);
if (not p.empty())
result = boost::lexical_cast<T>(p);
}
catch(const std::exception& e)
{
using namespace std::literals::string_literals;
throw std::runtime_error("Invalid value passed for parameter "s + name);
}
return result;
}
template<typename T, std::enable_if_t<zeep::json::detail::has_from_element_v<T> and std::is_enum_v<T>, int> = 0>
T get_parameter(const parameter_pack& params, const char* name, T result)
{
json::element v = params.get_parameter(name);
from_element(v, result);
return result;
}
template<typename T, std::enable_if_t<zeep::has_serialize_v<T, zeep::json::deserializer<json::element>> or
zeep::is_serializable_array_type_v<T, zeep::json::deserializer<json::element>>, int> = 0>
T get_parameter(const parameter_pack& params, const char* name, T result)
{
json::element v;
if (params.m_req.get_header("content-type") == "application/json")
zeep::json::parse_json(params.m_req.get_payload(), v);
else
zeep::json::parse_json(params.get_parameter(name), v);
from_element(v, result);
return result;
}
Callback m_callback;
std::array<const char*, N> m_names;
};
/// The \a mountPoint parameter is the local part of the mount point.
/// It can contain parameters enclosed in curly brackets.
///
/// For example, say we need a REST call to get the status of shoppingcart
/// where the browser will send:
///
/// `GET /ajax/cart/1234/status`
///
/// Our callback will look like this, for a class my_ajax_handler constructed
/// with prefixPath `/ajax`:
/// \code{.cpp}
/// CartStatus my_ajax_handler::handle_get_status(int id);
/// \endcode
/// Then we mount this callback like this:
/// \code{.cpp}
/// map_get_request("/cart/{id}/status", &my_ajax_handler::handle_get_status, "id");
/// \endcode
///
/// The number of \a names of the paramers specified should be equal to the number of
/// actual arguments for the callback, otherwise the compiler will complain.
///
/// Arguments not found in the path will be fetched from the payload in case of a POST
/// or from the URI parameters otherwise.
/// \brief map \a mountPoint in URI space to \a callback and map the arguments in this callback to parameters passed with \a names
template<typename Callback, typename... ArgNames>
void map_request(const char* mountPoint, const std::string& method, Callback callback, ArgNames... names)
{
m_mountpoints.emplace_back(new mount_point<Callback>(mountPoint, method, this, callback, names...));
}
/// \brief map a POST to \a mountPoint in URI space to \a callback and map the arguments in this callback to parameters passed with \a names
template<typename Callback, typename... ArgNames>
void map_post_request(const char* mountPoint, Callback callback, ArgNames... names)
{
map_request(mountPoint, "POST", callback, names...);
}
/// \brief map a PUT to \a mountPoint in URI space to \a callback and map the arguments in this callback to parameters passed with \a names
template<typename Sig, typename... ArgNames>
void map_put_request(const char* mountPoint, Sig callback, ArgNames... names)
{
map_request(mountPoint, "PUT", callback, names...);
}
/// \brief map a GET to \a mountPoint in URI space to \a callback and map the arguments in this callback to parameters passed with \a names
template<typename Sig, typename... ArgNames>
void map_get_request(const char* mountPoint, Sig callback, ArgNames... names)
{
map_request(mountPoint, "GET", callback, names...);
}
/// \brief map a DELETE to \a mountPoint in URI space to \a callback and map the arguments in this callback to parameters passed with \a names
template<typename Sig, typename... ArgNames>
void map_delete_request(const char* mountPoint, Sig callback, ArgNames... names)
{
map_request(mountPoint, "DELETE", callback, names...);
}
private:
std::list<mount_point_base*> m_mountpoints;
};
} // namespace zeep::http
|