SNode.C
Loading...
Searching...
No Matches
express::dispatcher::MiddlewareDispatcher Class Reference

#include <MiddlewareDispatcher.h>

Inheritance diagram for express::dispatcher::MiddlewareDispatcher:
Collaboration diagram for express::dispatcher::MiddlewareDispatcher:

Public Member Functions

 MiddlewareDispatcher (const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &, express::Next &)> &lambda)
Public Member Functions inherited from express::Dispatcher
 Dispatcher (const Dispatcher &)=delete
Dispatcher & operator= (const Dispatcher &)=delete
 Dispatcher ()=default
virtual ~Dispatcher ()
bool dispatchNext (Controller &controller, const std::string &parentMountPath)

Private Member Functions

bool dispatch (express::Controller &controller, const std::string &parentMountPath, const express::MountPoint &mountPoint) override
std::list< std::string > getRoutes (const std::string &parentMountPath, const MountPoint &mountPoint, bool strictRouting) const override

Private Attributes

const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &, express::Next &)> lambda
std::regex regex
std::vector< std::string > names

Additional Inherited Members

Protected Attributes inherited from express::Dispatcher
std::shared_ptr< Route > nextRoute = nullptr

Detailed Description

Definition at line 65 of file MiddlewareDispatcher.h.

Constructor & Destructor Documentation

◆ MiddlewareDispatcher()

express::dispatcher::MiddlewareDispatcher::MiddlewareDispatcher ( const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &, express::Next &)> & lambda)
explicit

Definition at line 68 of file MiddlewareDispatcher.cpp.

70 : lambda(lambda) {
71 }
express::dispatcher::MiddlewareDispatcher::lambda
const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &, express::Next &)> lambda
Definition MiddlewareDispatcher.h:75

References lambda.

Member Function Documentation

◆ dispatch()

bool express::dispatcher::MiddlewareDispatcher::dispatch ( express::Controller & controller,
const std::string & parentMountPath,
const express::MountPoint & mountPoint )
overrideprivatevirtual

Implements express::Dispatcher.

Definition at line 73 of file MiddlewareDispatcher.cpp.

73 {
74 bool requestMatched = false;
75
76 if (controller.getRequest()->method == mountPoint.method || mountPoint.method == "use" || mountPoint.method == "all") {
77 const std::string absoluteMountPath = parentMountPath + mountPoint.relativeMountPath;
78
79 if ((controller.getFlags() & Controller::NEXT) == 0) {
80 // Split mount & request into path + query
81 std::string_view mountPath;
82 std::string_view mountQueryString;
83 splitPathAndQuery(absoluteMountPath, mountPath, mountQueryString);
84 auto requiredQueryPairs = parseQuery(mountQueryString);
85
86 std::string_view requestPath;
87 std::string_view requestQueryString;
88 splitPathAndQuery(controller.getRequest()->originalUrl, requestPath, requestQueryString);
89 auto requestQueryPairs = parseQuery(requestQueryString);
90
91 // Normalize single trailing slash if not strict
92 if (!controller.getStrictRouting()) {
93 mountPath = trimOneTrailingSlash(mountPath);
94 requestPath = trimOneTrailingSlash(requestPath);
95 }
96 if (mountPath.empty()) {
97 mountPath = "/";
98 }
99
100 // Middleware is **prefix** with boundary (Express: app.use)
101 bool pathMatches = false;
102 std::size_t consumedLength = 0;
103 if (absoluteMountPath.find(':') != std::string::npos) {
104 // Param mount: compile once, match once, fill params, and record matched prefix length
105 if (regex.mark_count() == 0) {
106 if (regex.mark_count() == 0) {
107 LOG(TRACE) << "MiddlewarDispatchere: precompiled regex";
108 std::tie(regex, names) = compileParamRegex(mountPath,
109 /*isPrefix*/ true,
110 controller.getStrictRouting(),
111 controller.getCaseInsensitiveRouting());
112 } else {
113 LOG(TRACE) << "MiddlewareDispatcher: using precompiled regex";
114 }
115 }
116 std::cmatch regexMatches;
117 pathMatches = std::regex_search(requestPath.begin(), requestPath.end(), regexMatches, regex);
118 if (pathMatches) {
119 // regexMatches[0] = full matched prefix starting at 0 (anchored by compile_param_regex)
120 consumedLength = static_cast<std::size_t>(regexMatches.length(0));
121
122 // fill named params
123 const std::size_t groups = !regexMatches.empty() ? (regexMatches.size() - 1) : 0;
124 const std::size_t n = std::min(names.size(), groups);
125 for (std::size_t i = 0; i < n; ++i) {
126 controller.getRequest()->params[names[i]] = regexMatches[i + 1].str();
127 }
128 }
129 } else {
130 // Literal boundary prefix
131 pathMatches = boundaryPrefix(requestPath, mountPath, controller.getCaseInsensitiveRouting());
132 if (pathMatches) {
133 consumedLength = mountPath.size(); // IMPORTANT: literal consumes exactly its base length
134 }
135 }
136
137 const bool queryMatches = querySupersetMatches(requestQueryPairs, requiredQueryPairs);
138 requestMatched = (pathMatches && queryMatches);
139
140 LOG(TRACE) << controller.getResponse()->getSocketContext()->getSocketConnection()->getConnectionName()
141 << " HTTP Express: middleware -> " << (requestMatched ? "MATCH" : "NO MATCH");
142 LOG(TRACE) << " RequestMethod: " << controller.getRequest()->method;
143 LOG(TRACE) << " RequestUrl: " << controller.getRequest()->url;
144 LOG(TRACE) << " RequestPath: " << controller.getRequest()->path;
145 LOG(TRACE) << " Mountpoint Method: " << mountPoint.method;
146 LOG(TRACE) << " Mountpoint RelativePath: " << mountPoint.relativeMountPath;
147 LOG(TRACE) << " Mountpoint AbsolutePath: " << absoluteMountPath;
148 LOG(TRACE) << " StrictRouting: " << controller.getStrictRouting();
149 LOG(TRACE) << " CaseInsensitiveRouting: " << controller.getCaseInsensitiveRouting();
150
151 if (requestMatched) {
152 // Compute remainder and temporarily **rewrite req.path**
153 std::string_view remainderPath{};
154 if (requestPath.size() > consumedLength) {
155 remainderPath = requestPath.substr(consumedLength);
156 if (!remainderPath.empty() && remainderPath.front() == '/') {
157 remainderPath.remove_prefix(1);
158 }
159 }
160 auto& req = *controller.getRequest();
161 const std::string previousPathBackup = req.path;
162 req.path = remainderPath.empty() ? "/" : ("/" + std::string(remainderPath));
163
164 req.queries.insert(requestQueryPairs.begin(), requestQueryPairs.end());
165
166 if (hasResult(absoluteMountPath)) {
167 setParams(absoluteMountPath, *controller.getRequest());
168 }
169
170 Next next(controller);
171 lambda(controller.getRequest(), controller.getResponse(), next);
172
173 // If next() was called synchronously continue current route-tree traversal
174 if ((next.controller.getFlags() & express::Controller::NEXT) != 0) {
175 LOG(TRACE) << "Express: M - Next called - set to NO MATCH";
176 requestMatched = false;
177 controller = next.controller;
178 }
179
180 // Restore
181 req.path = previousPathBackup;
182 }
183 } else {
184 LOG(TRACE) << controller.getResponse()->getSocketContext()->getSocketConnection()->getConnectionName()
185 << " HTTP Express: middleware -> next(...) called";
186 LOG(TRACE) << " RequestMethod: " << controller.getRequest()->method;
187 LOG(TRACE) << " RequestUrl: " << controller.getRequest()->url;
188 LOG(TRACE) << " RequestPath: " << controller.getRequest()->path;
189 LOG(TRACE) << " AbsoluteMountPath: " << absoluteMountPath;
190 }
191 }
192
193 return requestMatched;
194 }
express::Controller::getRequest
const std::shared_ptr< Request > & getRequest()
Definition Controller.cpp:94
express::Controller::getStrictRouting
bool getStrictRouting() const
Definition Controller.cpp:159
express::Controller::getCaseInsensitiveRouting
bool getCaseInsensitiveRouting() const
Definition Controller.cpp:171
express::Controller::getResponse
const std::shared_ptr< Response > & getResponse()
Definition Controller.cpp:98
express::dispatcher::querySupersetMatches
bool querySupersetMatches(const std::unordered_map< std::string, std::string > &rq, const std::unordered_map< std::string, std::string > &need)
Definition regex_utils.cpp:222
express::dispatcher::setParams
void setParams(const std::string &cpath, Request &req)
Definition regex_utils.cpp:102
express::dispatcher::splitPathAndQuery
void splitPathAndQuery(std::string_view url, std::string_view &path, std::string_view &query)
Definition regex_utils.cpp:284
express::dispatcher::boundaryPrefix
bool boundaryPrefix(std::string_view path, std::string_view base, bool caseInsensitive)
Definition regex_utils.cpp:233
express::dispatcher::compileParamRegex
std::pair< std::regex, std::vector< std::string > > compileParamRegex(std::string_view mountPath, bool isPrefix, bool strictRouting, bool caseInsensitive)
Definition regex_utils.cpp:156
express::dispatcher::parseQuery
std::unordered_map< std::string, std::string > parseQuery(std::string_view qs)
Definition regex_utils.cpp:129
express::dispatcher::hasResult
bool hasResult(const std::string &cpath)
Definition regex_utils.cpp:96
express::dispatcher::trimOneTrailingSlash
std::string_view trimOneTrailingSlash(std::string_view s)
Definition regex_utils.cpp:277
express::MountPoint::method
std::string method
Definition MountPoint.h:56
express::MountPoint::relativeMountPath
std::string relativeMountPath
Definition MountPoint.h:57

References express::dispatcher::boundaryPrefix(), express::dispatcher::compileParamRegex(), express::Next::controller, express::Controller::getCaseInsensitiveRouting(), core::socket::stream::SocketConnection::getConnectionName(), express::Controller::getFlags(), express::Controller::getRequest(), express::Controller::getResponse(), core::socket::stream::SocketContext::getSocketConnection(), express::Response::getSocketContext(), express::Controller::getStrictRouting(), express::dispatcher::hasResult(), lambda, express::MountPoint::method, express::Request::method, names, express::Controller::NEXT, express::Next::Next(), express::Controller::operator=(), express::Request::originalUrl, express::dispatcher::parseQuery(), express::Request::path, express::Request::queries, express::dispatcher::querySupersetMatches(), express::MountPoint::relativeMountPath, express::dispatcher::setParams(), express::dispatcher::splitPathAndQuery(), express::dispatcher::trimOneTrailingSlash(), and express::Request::url.

Here is the call graph for this function:

◆ getRoutes()

std::list< std::string > express::dispatcher::MiddlewareDispatcher::getRoutes ( const std::string & parentMountPath,
const MountPoint & mountPoint,
bool strictRouting ) const
overrideprivatevirtual

Implements express::Dispatcher.

Definition at line 197 of file MiddlewareDispatcher.cpp.

197 {
198 std::list<std::string> routes{"M " + parentMountPath + mountPoint.relativeMountPath + (!strictRouting ? "*" : "")};
199 routes.push_back(" " + mountPoint.method + " " + mountPoint.relativeMountPath);
200
201 if (nextRoute) {
202 routes.splice(routes.end(), nextRoute->getRoute(parentMountPath, strictRouting));
203 }
204
205 return routes;
206 }
express::Dispatcher::nextRoute
std::shared_ptr< Route > nextRoute
Definition Dispatcher.h:80

References express::Route::getRoute(), express::MountPoint::method, express::Dispatcher::nextRoute, and express::MountPoint::relativeMountPath.

Here is the call graph for this function:

Member Data Documentation

◆ lambda

const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&, express::Next&)> express::dispatcher::MiddlewareDispatcher::lambda
private

Definition at line 75 of file MiddlewareDispatcher.h.

Referenced by dispatch(), and MiddlewareDispatcher().

◆ names

std::vector<std::string> express::dispatcher::MiddlewareDispatcher::names
private

Definition at line 78 of file MiddlewareDispatcher.h.

Referenced by dispatch().

◆ regex

std::regex express::dispatcher::MiddlewareDispatcher::regex
private

Definition at line 77 of file MiddlewareDispatcher.h.

The documentation for this class was generated from the following files: