SNode.C
Loading...
Searching...
No Matches
AttributeInjector.h
Go to the documentation of this file.
1/*
2 * SNode.C - A Slim Toolkit for Network Communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025, 2026
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef ATTRIBUTEINJECTOR_H
43#define ATTRIBUTEINJECTOR_H
44
45#ifndef DOXYGEN_SHOULD_SKIP_THIS
46
47#include <algorithm>
48#include <functional>
49#include <map>
50#include <memory>
51
52#endif /* DOXYGEN_SHOULD_SKIP_THIS */
53
54namespace utils {
55
56 template <unsigned N>
57 struct fixed_string {
58 char buf[N + 1]{};
59 constexpr fixed_string(char const* s) { // cppcheck-suppress noExplicitConstructor
60 for (unsigned i = 0; i != N; ++i) {
61 buf[i] = s[i];
62 }
63 }
64
65 constexpr operator char const*() const {
66 return buf;
67 }
68
69 auto operator<=>(const fixed_string&) const = default;
70 };
71 template <unsigned N>
72 fixed_string(char const (&)[N]) -> fixed_string<N - 1>;
73
74 template <typename Attribute>
75 concept InjectableAttribute = std::copy_constructible<Attribute> and std::default_initializable<Attribute> and std::copyable<Attribute>;
76
77 template <InjectableAttribute Attribute>
79 public:
80 constexpr explicit AttributeProxy(const Attribute& attribute)
81 : attribute(attribute) { // copy constructor neccessary
82 }
83
84 constexpr Attribute& operator*() {
85 return attribute;
86 }
87
88 private:
89 Attribute attribute;
90 };
91
93 public:
94 template <InjectableAttribute Attribute>
95 constexpr bool setAttribute(const Attribute& attribute, bool overwrite = false) {
96 bool inserted = false;
97
98 if (!this->attribute || overwrite) {
99 attributeType = typeid(Attribute).name();
100 this->attribute = std::shared_ptr<void>(new AttributeProxy<Attribute>(attribute));
101 inserted = true;
102 }
103
104 return inserted;
105 }
106
107 template <InjectableAttribute Attribute>
108 constexpr bool setAttribute(const Attribute&& attribute, bool overwrite = false) {
109 bool inserted = false;
110
111 if (!this->attribute || overwrite) {
112 attributeType = typeid(Attribute).name();
113 this->attribute = std::shared_ptr<void>(new AttributeProxy<Attribute>(attribute));
114 inserted = true;
115 }
116
117 return inserted;
118 }
119
120 template <InjectableAttribute Attribute>
121 constexpr bool getAttribute(const std::function<void(Attribute&)>& onFound) const {
122 const bool found = false;
123
124 if (attribute != nullptr && attributeType == typeid(Attribute).name()) {
125 onFound(**std::static_pointer_cast<AttributeProxy<Attribute>>(attribute));
126 }
127
128 return found;
129 }
130
131 template <InjectableAttribute Attribute>
132 constexpr void getAttribute(const std::function<void(Attribute&)>& onFound,
133 const std::function<void(const std::string&)>& onNotFound) const {
134 if (attribute != nullptr && attributeType == typeid(Attribute).name()) {
135 onFound(**std::static_pointer_cast<AttributeProxy<Attribute>>(attribute));
136 } else {
137 onNotFound(std::string(typeid(Attribute).name()));
138 }
139 }
140
141 private:
142 std::shared_ptr<void> attribute{nullptr};
143 std::string attributeType;
144 };
145
147 public:
148 template <InjectableAttribute Attribute, fixed_string key = "">
149 constexpr bool setAttribute(const Attribute& attribute, const std::string& subKey = "", bool overwrite = false) {
150 bool inserted = false;
151
152 if (!attributes.contains(typeid(Attribute).name() + std::string(key) + subKey) || overwrite) {
153 attributes[typeid(Attribute).name() + std::string(key) + subKey] =
154 std::shared_ptr<void>(new AttributeProxy<Attribute>(attribute));
155 inserted = true;
156 }
157
158 return inserted;
159 }
160
161 template <InjectableAttribute Attribute, fixed_string key = "">
162 constexpr bool setAttribute(const Attribute&& attribute, const std::string& subKey = "", bool overwrite = false) {
163 bool inserted = false;
164
165 if (!attributes.contains(typeid(Attribute).name() + std::string(key) + subKey) || overwrite) {
166 attributes[typeid(Attribute).name() + std::string(key) + subKey] =
167 std::shared_ptr<void>(new AttributeProxy<Attribute>(attribute));
168 inserted = true;
169 }
170
171 return inserted;
172 }
173
174 template <InjectableAttribute Attribute, fixed_string key = "">
175 constexpr bool delAttribute(const std::string& subKey = "") {
176 bool deleted = attributes.erase(typeid(Attribute).name() + std::string(key) + subKey) > 0;
177
178 return deleted;
179 }
180
181 template <InjectableAttribute Attribute, fixed_string key = "">
182 constexpr bool hasAttribute(const std::string& subKey = "") const {
183 bool found = attributes.find(typeid(Attribute).name() + std::string(key) + subKey) != attributes.end();
184
185 return found;
186 }
187
188 template <InjectableAttribute Attribute, fixed_string key = "">
189 bool getAttribute(const std::function<void(Attribute&)>& onFound, const std::string& subKey = "") const {
190 bool found = false;
191
192 std::map<std::string, std::shared_ptr<void>>::const_iterator it =
193 attributes.find(typeid(Attribute).name() + std::string(key) + subKey);
194
195 if (it != attributes.end()) {
196 found = true;
197
198 onFound(**std::static_pointer_cast<AttributeProxy<Attribute>>(it->second));
199 }
200
201 return found;
202 }
203
204 template <InjectableAttribute Attribute, fixed_string key = "">
205 void getAttribute(const std::function<void(Attribute&)>& onFound,
206 const std::function<void(const std::string&)>& onNotFound,
207 const std::string& subKey = "") const {
208 std::map<std::string, std::shared_ptr<void>>::const_iterator it =
209 attributes.find(typeid(Attribute).name() + std::string(key) + subKey);
210
211 if (it != attributes.end()) {
212 onFound(**std::static_pointer_cast<AttributeProxy<Attribute>>(it->second));
213 } else {
214 onNotFound(std::string(typeid(Attribute).name()) + std::string(key) + subKey);
215 }
216 }
217
218 void reset() {
219 attributes.clear();
220 }
221
222 private:
223 std::map<std::string, std::shared_ptr<void>> attributes;
224 };
225
226} // namespace utils
227
228#endif // ATTRIBUTEINJECTOR_H
#define LOG(level)
Definition Logger.h:148
#define VLOG(level)
Definition Logger.h:164
#define DECLARE_ROUTER_REQUESTMETHOD(METHOD)
Definition Router.h:71
#define APPLICATION(req, res)
Definition Router.h:68
#define MIDDLEWARE(req, res, next)
Definition Router.h:63
static void init(int argc, char *argv[])
Definition SNodeC.cpp:54
static int start(const utils::Timeval &timeOut={LONG_MAX, 0})
Definition SNodeC.cpp:60
static constexpr int DISABLED
Definition State.h:56
static constexpr int ERROR
Definition State.h:57
std::string what() const
Definition State.cpp:114
static constexpr int FATAL
Definition State.h:58
static constexpr int OK
Definition State.h:55
unsigned long lastTick
Definition Controller.h:97
void next(const std::string &how) const
RootRoute * rootRoute
Definition Controller.h:92
bool dispatchNext(bool strictRouting, bool caseInsensitiveRouting, bool mergeParams)
Controller(const std::shared_ptr< web::http::server::Request > &request, const std::shared_ptr< web::http::server::Response > &response)
const std::shared_ptr< Request > & getRequest() const
const std::shared_ptr< Response > & getResponse() const
std::shared_ptr< Response > response
Definition Controller.h:90
Controller(const Controller &controller)
void setCurrentRoute(Route *currentRoute)
bool nextRouterCalled() const
void setRootRoute(RootRoute *rootRoute)
std::shared_ptr< Request > request
Definition Controller.h:89
Controller & operator=(const Controller &controller) noexcept
void operator()(const std::string &how="") const
Definition Next.cpp:56
Next(Controller &controller)
Definition Next.cpp:52
Controller controller
Definition Next.h:66
Request & extend()
Definition Request.cpp:76
std::string httpVersion
Definition Request.h:99
web::http::CiStringMap< std::string > cookies
Definition Request.h:106
Request(Request &&) noexcept=delete
std::string originalUrl
Definition Request.h:77
const std::string & cookie(const std::string &key) const
Definition Request.cpp:99
std::string url
Definition Request.h:98
Request & operator=(Request &&) noexcept=delete
std::vector< char > body
Definition Request.h:107
std::map< std::string, std::string > params
Definition Request.h:81
const std::string & get(const std::string &key, int i=0) const
Definition Request.cpp:95
std::string originalPath
Definition Request.h:78
std::string method
Definition Request.h:97
Request(const std::shared_ptr< web::http::server::Request > &request) noexcept
Definition Request.cpp:56
std::shared_ptr< web::http::server::Request > requestBase
Definition Request.h:86
Request(Request &)=delete
const std::string & query(const std::string &key) const
Definition Request.cpp:109
web::http::CiStringMap< std::string > headers
Definition Request.h:104
const std::string & param(const std::string &id, const std::string &fallBack="")
Definition Request.cpp:70
std::string baseUrl
Definition Request.h:76
std::map< std::string, std::string > queries
Definition Request.h:103
web::http::CiStringMap< std::string > trailer
Definition Request.h:105
Request & operator=(Request &)=delete
std::string path
Definition Request.h:79
Request()=default
std::string file
Definition Request.h:80
std::string nullstr
Definition Request.h:110
Response & set(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:129
void send(const std::string &chunk)
Definition Response.cpp:169
Response & status(int status)
Definition Response.cpp:117
void json(const nlohmann::json &json)
Definition Response.cpp:72
Route & head(const Router &router) const
Definition Router.cpp:110
Route & all(const Router &router) const
Definition Router.cpp:101
const Router & setCaseInsensitiveRouting(bool caseInsensitiveRouting=true) const
Definition Router.cpp:84
const Router & setStrictRouting(bool strictRouting=true) const
Definition Router.cpp:78
Route & options(const Router &router) const
Definition Router.cpp:107
Route & connect(const Router &router) const
Definition Router.cpp:106
Route & post(const Router &router) const
Definition Router.cpp:104
Route & del(const Router &router) const
Definition Router.cpp:105
Router(const Router &)=default
Route & use(const Router &router) const
Definition Router.cpp:100
Route & get(const Router &router) const
Definition Router.cpp:102
Route & trace(const Router &router) const
Definition Router.cpp:108
Route & patch(const Router &router) const
Definition Router.cpp:109
const Router & setMergeParams(bool mergeParams=true) const
Definition Router.cpp:90
std::list< std::string > getRoutes() const
Definition Router.cpp:96
Route & put(const Router &router) const
Definition Router.cpp:103
std::shared_ptr< RootRoute > rootRoute
Definition Router.h:122
WebAppT(const std::string &name, const Router &router)
Definition WebAppT.h:78
typename Server::SocketConnection SocketConnection
Definition WebAppT.h:67
ServerT Server
Definition WebAppT.h:61
express::Response Response
Definition WebAppT.h:65
express::Request Request
Definition WebAppT.h:64
typename Server::SocketAddress SocketAddress
Definition WebAppT.h:68
WebAppT(const std::string &name)
Definition WebAppT.h:74
static void free()
Definition WebApp.cpp:72
static void init(int argc, char *argv[])
Definition WebApp.cpp:56
static void stop()
Definition WebApp.cpp:64
static core::TickStatus tick(const utils::Timeval &timeOut=0)
Definition WebApp.cpp:68
static core::State state()
Definition WebApp.cpp:76
static int start(const utils::Timeval &timeOut={LONG_MAX, 0})
Definition WebApp.cpp:60
WebApp(const Router &router)
Definition WebApp.cpp:52
LogMessage(Level level, int verboseLevel=-1, bool withErrno=false)
Definition Logger.cpp:280
std::string toString(bool expanded=true) const override
const Super & listen(uint16_t port, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
constexpr AttributeProxy(const Attribute &attribute)
constexpr Attribute & operator*()
constexpr bool setAttribute(const Attribute &&attribute, const std::string &subKey="", bool overwrite=false)
constexpr bool hasAttribute(const std::string &subKey="") const
constexpr bool delAttribute(const std::string &subKey="")
bool getAttribute(const std::function< void(Attribute &)> &onFound, const std::string &subKey="") const
std::map< std::string, std::shared_ptr< void > > attributes
void getAttribute(const std::function< void(Attribute &)> &onFound, const std::function< void(const std::string &)> &onNotFound, const std::string &subKey="") const
constexpr bool setAttribute(const Attribute &attribute, const std::string &subKey="", bool overwrite=false)
constexpr void getAttribute(const std::function< void(Attribute &)> &onFound, const std::function< void(const std::string &)> &onNotFound) const
constexpr bool setAttribute(const Attribute &attribute, bool overwrite=false)
constexpr bool setAttribute(const Attribute &&attribute, bool overwrite=false)
std::shared_ptr< void > attribute
constexpr bool getAttribute(const std::function< void(Attribute &)> &onFound) const
Timeval(const std::initializer_list< time_t > &initList) noexcept
Definition Timeval.cpp:59
int main(int argc, char *argv[])
std::vector< json > Trace
static void ensureTrace(const std::shared_ptr< express::Request > &req)
static void tracePush(const std::shared_ptr< express::Request > &req, const std::string &label)
static json snapshot(const std::shared_ptr< express::Request > &req, const std::string &label)
static json traceGet(const std::shared_ptr< express::Request > &req)
TickStatus
Definition TickStatus.h:51
State
Definition State.h:51
fixed_string(char const (&)[N]) -> fixed_string< N - 1 >
web::http::server::Server< net::in::stream::legacy::SocketServer > Server
Definition Server.h:54
auto operator<=>(const fixed_string &) const =default
constexpr fixed_string(char const *s)
constexpr operator char const *() const