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
|
// Copyright Maarten L. Hekkelman, Radboud University 2008-2013.
// Copyright Maarten L. Hekkelman, 2014-2026
// 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::soap_controller class.
/// Instances of this class take care of mapping member functions to
/// SOAP calls automatically converting in- and output data
#include "zeep/config.hpp"
#include "zeep/http/controller.hpp"
#include <zeem.hpp>
namespace zeep::http
{
/// soap_envelope is a wrapper around a SOAP envelope. Use it for
/// input and output of correctly formatted SOAP messages.
class soap_envelope
{
public:
soap_envelope(const soap_envelope &) = delete;
soap_envelope &operator=(const soap_envelope &) = delete;
/// \brief Create an empty envelope
soap_envelope();
/// \brief Parse a SOAP message from the payload received from a client,
/// throws an exception if the envelope is empty or invalid.
soap_envelope(std::string &payload);
// /// \brief Parse a SOAP message received from a client,
// /// throws an exception if the envelope is empty or invalid.
// envelope(zeem::document& data);
/// \brief The request element as contained in the original SOAP message
zeem::element &request() { return *m_request; }
private:
zeem::document m_payload;
zeem::element *m_request;
};
// --------------------------------------------------------------------
/// Wrap data into a SOAP envelope
///
/// \param data The zeem::element object to wrap into the envelope
/// \return A new zeem::element object containing the envelope.
zeem::element make_envelope(zeem::element &&data);
// zeem::element make_envelope(const zeem::element& data);
/// Create a standard SOAP Fault message for the string parameter
///
/// \param message The string object containing a descriptive error message.
/// \return A new zeem::element object containing the fault envelope.
zeem::element make_fault(std::string message);
/// Create a standard SOAP Fault message for the exception object
///
/// \param ex The exception object that was catched.
/// \return A new zeem::element object containing the fault envelope.
zeem::element make_fault(const std::exception &ex);
// --------------------------------------------------------------------
/// \brief class that helps with handling SOAP requests
///
/// This controller will handle SOAP requests automatically handing the packing
/// and unpacking of XML envelopes.
///
/// 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 SOAP controllers in the documention for more information.
class soap_controller : public controller
{
public:
/// \brief constructor
///
/// \param prefix_path This is the leading part of the request URI for each mount point
/// \param service The name of the service
/// \param ns This is the XML Namespace for our SOAP calls
soap_controller(std::string prefix_path, std::string service, std::string ns)
: controller(std::move(prefix_path))
, m_ns(std::move(ns))
, m_service(std::move(service))
{
// while (m_prefix_path.front() == '/')
// m_prefix_path.erase(0, 1);
m_location = m_prefix_path.string();
}
~soap_controller()
{
for (auto mp : m_mountpoints)
delete mp;
}
/// \brief Set the external address at which this service is visible
void set_location(std::string location)
{
m_location = std::move(location);
}
/// \brief Set the service name
void set_service(std::string service)
{
m_service = std::move(service);
}
/// \brief map a SOAP action to \a callback using \a names for mapping the arguments
///
/// The method in \a callback should be a method of the derived class having as many
/// arguments as the number of specified \a names.
template <typename Callback, typename... ArgNames>
void map_action(const char *actionName, Callback callback, ArgNames... names)
{
m_mountpoints.emplace_back(new mount_point<Callback>(actionName, this, callback, names...));
}
/// \brief Create a WSDL based on the registered actions
zeem::element make_wsdl();
/// \brief Handle the SOAP request
virtual bool handle_request(request &req, reply &reply_);
protected:
/// @cond
using type_map = std::map<std::string, zeem::element>;
using message_map = std::map<std::string, zeem::element>;
struct mount_point_base
{
mount_point_base(const char *action)
: m_action(action)
{
}
virtual ~mount_point_base() {}
virtual void call(const zeem::element &request, reply &reply_, std::string_view ns) = 0;
virtual void describe(type_map &types, message_map &messages, zeem::element &portType, zeem::element &binding) = 0;
std::string m_action;
};
template <typename Callback, typename...>
struct mount_point
{
};
/// \brief templated abstract base class for mount points
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 Callback = std::function<Result(Args...)>;
static constexpr size_t N = sizeof...(Args);
mount_point(const char *action, soap_controller *owner, Sig sig)
: mount_point_base(action)
{
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...);
};
}
template <typename... Names>
mount_point(const char *action, soap_controller *owner, Sig sig, Names... names)
: mount_point(action, owner, sig)
{
static_assert(sizeof...(Names) == sizeof...(Args), "Number of names should be equal to number of arguments of callback function");
// for (auto name: {...names })
size_t i = 0;
for (auto name : { names... })
m_names[i++] = name;
}
virtual void call(const zeem::element &request, reply &rep, std::string_view ns)
{
rep.set_status(ok);
ArgsTuple args = collect_arguments(request, std::make_index_sequence<N>());
invoke<Result>(std::move(args), rep, ns);
}
template <typename ResultType, typename ArgsTuple, std::enable_if_t<std::is_void_v<ResultType>, int> = 0>
void invoke(ArgsTuple &&args, reply &rep, std::string_view ns)
{
std::apply(m_callback, std::forward<ArgsTuple>(args));
zeem::element response(m_action + "Response");
response.move_to_name_space("m", ns, false, false);
rep.set_content(make_envelope(std::move(response)));
}
template <typename ResultType, typename ArgsTuple, std::enable_if_t<not std::is_void_v<ResultType>, int> = 0>
void invoke(ArgsTuple &&args, reply &rep, std::string_view ns)
{
auto result = std::apply(m_callback, std::forward<ArgsTuple>(args));
// and serialize the result back into XML
zeem::element response(m_action + "Response");
zeem::serializer sr(response);
sr.serialize_element(result);
response.move_to_name_space("m", ns, true, true);
auto envelope = make_envelope(std::move(response));
rep.set_content(std::move(envelope));
}
template <std::size_t... I>
ArgsTuple collect_arguments(const zeem::element &request, std::index_sequence<I...>)
{
zeem::deserializer ds(request);
return std::make_tuple(get_parameter<typename std::tuple_element_t<I, ArgsTuple>>(ds, m_names[I])...);
}
template <typename T>
T get_parameter(zeem::deserializer &ds, const char *name)
{
T v = {};
ds.deserialize_element(name, v);
return v;
}
virtual void collect_types(type_map &types, zeem::element &seq, std::string_view ns)
{
if constexpr (sizeof...(Args) > 0)
collect_types(types, seq, ns, std::make_index_sequence<N>());
}
template <std::size_t... I>
void collect_types(type_map &types, zeem::element &seq, std::string_view ns, std::index_sequence<I...> /*ix*/)
{
(collect_type<I>(types, seq, ns), ...);
}
template <std::size_t I>
void collect_type(type_map &types, zeem::element &seq, std::string_view /*ns*/)
{
using type = typename std::tuple_element_t<I, ArgsTuple>;
zeem::schema_creator sc(types, seq);
sc.add_element(m_names[I], type{});
}
virtual void describe(type_map &types, message_map &messages,
zeem::element &portType, zeem::element &binding)
{
// the request type
zeem::element requestType("xsd:element", { { "name", m_action } });
auto complexType = requestType.emplace_back("xsd:complexType");
collect_types(types, complexType.emplace_back("xsd:sequence"), "ns");
types[m_action + "Request"] = requestType;
// and the response type
zeem::element responseType("xsd:element", { { "name", m_action + "Response" } });
if constexpr (not std::is_void_v<Result>)
{
auto complexType2 = responseType.emplace_back("xsd:complexType");
auto sequence = complexType2->emplace_back("xsd:sequence");
zeem::schema_creator sc(types, sequence);
sc.add_element("Response", Result{});
}
types[m_action + "Response"] = responseType;
// now the wsdl operations
zeem::element message("wsdl:message", {{ "name", m_action + "RequestMessage"}});
message.emplace_back("wsdl:part", { {"name", "parameters"}, { "element", "ns:" + m_action }});
messages[m_action + "RequestMessage"] = message;
message = zeem::element("wsdl:message", {{ "name", m_action + "Message" }});
message.emplace_back("wsdl:part", {{ "name", "parameters"}, {"element", "ns:" + m_action }});
messages[m_action + "Message"] = message;
// port type
zeem::element operation("wsdl:operation", { { "name", m_action } });
operation.emplace_back("wsdl:input", { { "message", "ns:" + m_action + "RequestMessage" } });
operation.emplace_back("wsdl:output", { { "message", "ns:" + m_action + "Message" } });
portType.emplace_back(std::move(operation));
// and the soap operations
operation = { "wsdl:operation", { { "name", m_action } } };
operation.emplace_back("soap:operation", { { "soapAction", "" }, { "style", "document" } });
zeem::element body("soap:body");
body.set_attribute("use", "literal");
zeem::element input("wsdl:input");
input.push_back(body);
operation.emplace_back(std::move(input));
zeem::element output("wsdl:output");
output.emplace_back(std::move(body));
operation.emplace_back(std::move(output));
binding.emplace_back(std::move(operation));
}
Callback m_callback;
std::array<const char *, N> m_names;
};
std::list<mount_point_base *> m_mountpoints;
std::string m_ns, m_location, m_service;
/// @endcond
};
} // namespace zeep::http
|