2018-02-04 03:22:01 +01:00
|
|
|
// Matrix Construct
|
|
|
|
//
|
|
|
|
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
|
|
|
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
|
|
|
|
//
|
|
|
|
// Permission to use, copy, modify, and/or distribute this software for any
|
|
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
|
|
// copyright notice and this permission notice is present in all copies. The
|
|
|
|
// full license for this software is available in the LICENSE file.
|
2017-08-23 23:10:28 +02:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
#define HAVE_IRCD_M_ERROR_H
|
|
|
|
|
2017-09-07 13:10:15 +02:00
|
|
|
namespace ircd::m
|
|
|
|
{
|
|
|
|
struct error;
|
|
|
|
}
|
2017-08-23 23:10:28 +02:00
|
|
|
|
2017-11-16 02:48:25 +01:00
|
|
|
/// This hierarchy is designed to allow developers to throw an exception with
|
|
|
|
/// matrix protocol specific information which has the potential to become a
|
|
|
|
/// proper matrix JSON error object sent over HTTP to clients. Many exceptions
|
|
|
|
/// aren't intended to reach clients, but just in case, those can utilize an
|
|
|
|
/// http::INTERNAL_SERVER_ERROR. A regular IRCD_EXCEPTION won't be rooted in
|
|
|
|
/// m::error; if thrown during a client's request and not first caught it
|
|
|
|
/// may result in an internal server error sent to the client and may be
|
|
|
|
/// further rethrown.
|
|
|
|
///
|
|
|
|
/// The IRCD_M_EXCEPTION macro is provided and should be used to declare the
|
|
|
|
/// error type first rather than throwing an m::error directly if possible.
|
|
|
|
///
|
2018-03-04 18:20:24 +01:00
|
|
|
class ircd::m::error
|
|
|
|
:public http::error
|
2017-08-23 23:10:28 +02:00
|
|
|
{
|
2018-12-20 00:57:04 +01:00
|
|
|
static thread_local char fmtbuf[4_KiB];
|
2018-03-04 18:20:24 +01:00
|
|
|
|
2018-12-31 02:34:27 +01:00
|
|
|
IRCD_OVERLOAD(internal)
|
2019-07-12 02:22:16 +02:00
|
|
|
error(internal_t, const http::code &, std::string object);
|
2018-12-31 02:34:27 +01:00
|
|
|
|
|
|
|
protected:
|
|
|
|
IRCD_OVERLOAD(child)
|
|
|
|
template<class... args> error(child_t, args&&... a)
|
|
|
|
:error{std::forward<args>(a)...}
|
|
|
|
{}
|
|
|
|
|
2018-03-04 18:20:24 +01:00
|
|
|
public:
|
2019-04-26 08:35:46 +02:00
|
|
|
string_view errcode() const noexcept;
|
|
|
|
string_view errstr() const noexcept;
|
|
|
|
|
2018-12-10 22:08:35 +01:00
|
|
|
template<class... args> error(const http::code &, const string_view &errcode, const string_view &fmt, args&&...);
|
|
|
|
template<class... args> error(const string_view &errcode, const string_view &fmt, args&&...);
|
2018-01-28 18:09:58 +01:00
|
|
|
error(const http::code &, const json::object &object);
|
2017-09-14 20:30:06 +02:00
|
|
|
error(const http::code &, const json::members &);
|
2017-09-12 19:02:27 +02:00
|
|
|
error(const http::code &, const json::iov &);
|
2017-09-07 13:10:15 +02:00
|
|
|
error(const http::code &);
|
2018-03-05 10:34:03 +01:00
|
|
|
error(std::string);
|
|
|
|
error();
|
2020-02-28 21:12:51 +01:00
|
|
|
~error() noexcept;
|
2017-09-07 13:10:15 +02:00
|
|
|
};
|
|
|
|
|
2017-11-16 02:48:25 +01:00
|
|
|
/// Macro for all matrix exceptions; all errors rooted from m::error
|
|
|
|
///
|
|
|
|
/// Unfortunately we use another macro here instead of IRCD_EXCEPTION but what
|
|
|
|
/// we gain is a more suitable exception hierarchy for the matrix protocol
|
|
|
|
/// for fecundity of m::error, which is still the progeny of ircd::error. This
|
|
|
|
/// macro takes 3 arguments:
|
|
|
|
///
|
|
|
|
/// - parent: A parent exception class type similar to the rest of ircd's
|
|
|
|
/// system. For this macro, the parent can never be above m::error.
|
|
|
|
///
|
|
|
|
/// - name: The name of the exception is also what will be seen in the matrix
|
|
|
|
/// protocol JSON's errcode. The matrix protocol error codes are UPPER_CASE and
|
|
|
|
/// will appear as defined. This is also the name of this class itself too.
|
|
|
|
///
|
|
|
|
/// - httpcode: An HTTP code which will be used if this exception ever makes
|
|
|
|
/// it out to a client.
|
|
|
|
///
|
2018-01-28 18:09:58 +01:00
|
|
|
#define IRCD_M_EXCEPTION(_parent_, _name_, _httpcode_) \
|
|
|
|
struct _name_ \
|
|
|
|
: _parent_ \
|
|
|
|
{ \
|
|
|
|
_name_() \
|
|
|
|
: _parent_ \
|
|
|
|
{ \
|
|
|
|
child, _httpcode_, "M_"#_name_, "%s", http::status(_httpcode_) \
|
|
|
|
}{} \
|
|
|
|
\
|
2018-12-10 22:08:35 +01:00
|
|
|
template<class... args> _name_(const string_view &fmt, args&&... a) \
|
2018-01-28 18:09:58 +01:00
|
|
|
: _parent_ \
|
|
|
|
{ \
|
2018-03-05 10:34:03 +01:00
|
|
|
child, _httpcode_, "M_"#_name_, fmt, std::forward<args>(a)... \
|
2018-01-28 18:09:58 +01:00
|
|
|
}{} \
|
|
|
|
\
|
|
|
|
template<class... args> _name_(child_t, args&&... a) \
|
|
|
|
: _parent_ \
|
|
|
|
{ \
|
|
|
|
child, std::forward<args>(a)... \
|
|
|
|
}{} \
|
2017-08-23 23:10:28 +02:00
|
|
|
};
|
|
|
|
|
2017-11-16 02:48:25 +01:00
|
|
|
// These are some common m::error, but not all of them; other declarations
|
|
|
|
// may be dispersed throughout ircd::m.
|
2017-09-07 13:10:15 +02:00
|
|
|
namespace ircd::m
|
|
|
|
{
|
|
|
|
IRCD_M_EXCEPTION(error, UNKNOWN, http::INTERNAL_SERVER_ERROR);
|
2017-11-16 02:48:25 +01:00
|
|
|
IRCD_M_EXCEPTION(error, BAD_REQUEST, http::BAD_REQUEST);
|
2018-02-09 00:00:53 +01:00
|
|
|
IRCD_M_EXCEPTION(error, BAD_JSON, http::BAD_REQUEST);
|
|
|
|
IRCD_M_EXCEPTION(error, NOT_JSON, http::BAD_REQUEST);
|
2020-06-07 11:24:49 +02:00
|
|
|
IRCD_M_EXCEPTION(error, BAD_SIGNATURE, http::FORBIDDEN);
|
2019-07-27 04:09:28 +02:00
|
|
|
IRCD_M_EXCEPTION(error, ACCESS_DENIED, http::FORBIDDEN);
|
2018-02-09 00:00:53 +01:00
|
|
|
IRCD_M_EXCEPTION(error, FORBIDDEN, http::FORBIDDEN);
|
|
|
|
IRCD_M_EXCEPTION(error, NOT_FOUND, http::NOT_FOUND);
|
|
|
|
IRCD_M_EXCEPTION(error, UNSUPPORTED, http::NOT_IMPLEMENTED);
|
2018-02-15 06:52:19 +01:00
|
|
|
IRCD_M_EXCEPTION(error, NEED_MORE_PARAMS, http::MULTIPLE_CHOICES);
|
2018-02-23 04:31:15 +01:00
|
|
|
IRCD_M_EXCEPTION(error, UNAVAILABLE, http::SERVICE_UNAVAILABLE);
|
2018-02-24 06:17:47 +01:00
|
|
|
IRCD_M_EXCEPTION(error, BAD_PAGINATION, http::BAD_REQUEST);
|
2017-09-07 13:10:15 +02:00
|
|
|
}
|
|
|
|
|
2017-11-16 02:48:25 +01:00
|
|
|
template<class... args>
|
2020-08-06 03:48:32 +02:00
|
|
|
inline
|
2017-11-16 02:48:25 +01:00
|
|
|
ircd::m::error::error(const http::code &status,
|
|
|
|
const string_view &errcode,
|
2018-12-10 22:08:35 +01:00
|
|
|
const string_view &fmt,
|
2017-11-16 02:48:25 +01:00
|
|
|
args&&... a)
|
2018-12-31 02:34:27 +01:00
|
|
|
:error
|
2017-11-16 02:48:25 +01:00
|
|
|
{
|
2018-12-31 02:34:27 +01:00
|
|
|
internal, status, [&errcode, &fmt, &a...]() -> json::strung
|
2017-11-16 02:48:25 +01:00
|
|
|
{
|
2018-03-04 18:20:24 +01:00
|
|
|
const string_view str
|
2017-11-16 02:48:25 +01:00
|
|
|
{
|
2020-08-06 03:48:32 +02:00
|
|
|
fmt::sprintf
|
|
|
|
{
|
|
|
|
fmtbuf, fmt, std::forward<args>(a)...
|
|
|
|
}
|
2017-11-16 02:48:25 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
return json::members
|
|
|
|
{
|
2018-01-28 18:09:58 +01:00
|
|
|
{ "errcode", errcode },
|
|
|
|
{ "error", str },
|
2017-11-16 02:48:25 +01:00
|
|
|
};
|
|
|
|
}()
|
|
|
|
}{}
|
|
|
|
|
|
|
|
template<class... args>
|
2020-08-06 03:48:32 +02:00
|
|
|
inline
|
2017-11-16 02:48:25 +01:00
|
|
|
ircd::m::error::error(const string_view &errcode,
|
2018-12-10 22:08:35 +01:00
|
|
|
const string_view &fmt,
|
2017-11-16 02:48:25 +01:00
|
|
|
args&&... a)
|
|
|
|
:error
|
|
|
|
{
|
2018-03-05 10:34:03 +01:00
|
|
|
http::INTERNAL_SERVER_ERROR, errcode, fmt, std::forward<args>(a)...
|
2018-01-28 18:09:58 +01:00
|
|
|
}
|
|
|
|
{}
|