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

#include <RouterDispatcher.h>

Inheritance diagram for express::dispatcher::RouterDispatcher:
Collaboration diagram for express::dispatcher::RouterDispatcher:

Public Member Functions

std::list< express::Route > & getRoutes ()
std::list< std::string > getRoutes (const std::string &parentMountPath, const MountPoint &mountPoint) const
bool setStrictRouting (bool strictRouting)
bool getStrictRouting () const
bool setCaseInsensitiveRouting (bool caseInsensitiveRouting)
bool getCaseInsensitiveRouting () const
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

std::list< express::Route > routes
bool strictRouting = false
bool caseInsensitiveRouting = false
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 62 of file RouterDispatcher.h.

Member Function Documentation

◆ dispatch()

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

Implements express::Dispatcher.

Definition at line 94 of file RouterDispatcher.cpp.

94 {
95 bool dispatched = false;
96
97 if (controller.getRequest()->method == mountPoint.method || mountPoint.method == "use" || mountPoint.method == "all") {
98 const std::string absoluteMountPath = parentMountPath + mountPoint.relativeMountPath;
99
100 // Split mount & request into path + query
101 std::string_view mountPath;
102 std::string_view mountQueryString;
103 splitPathAndQuery(absoluteMountPath, mountPath, mountQueryString);
104 const std::unordered_map<std::string, std::string> requiredQueryPairs = parseQuery(mountQueryString);
105
106 std::string_view requestPath;
107 std::string_view requestQueryString;
108 splitPathAndQuery(controller.getRequest()->originalUrl, requestPath, requestQueryString);
109 const std::unordered_map<std::string, std::string> requestQueryPairs = parseQuery(requestQueryString);
110
111 // Normalize single trailing slash if not strict
112 if (!controller.getStrictRouting()) {
113 mountPath = trimOneTrailingSlash(mountPath);
114 requestPath = trimOneTrailingSlash(requestPath);
115 }
116 if (mountPath.empty()) {
117 mountPath = "/";
118 }
119
120 // Router is **prefix** with boundary (like app.use)
121 bool pathMatches = false;
122 if (absoluteMountPath.find(':') != std::string::npos) {
123 if (regex.mark_count() == 0) {
124 LOG(TRACE) << "RouterDispatcher: precompiled regex";
125 std::tie(regex, names) = compileParamRegex(mountPath,
126 /*isPrefix*/ true,
127 controller.getStrictRouting(),
128 controller.getCaseInsensitiveRouting());
129 } else {
130 LOG(TRACE) << "RouterDispatcher: using precompiled regex";
131 }
132
133 pathMatches = matchAndFillParams(regex, names, requestPath, *controller.getRequest());
134 } else {
135 pathMatches = boundaryPrefix(requestPath, mountPath, controller.getCaseInsensitiveRouting());
136 }
137 const bool queryMatches = querySupersetMatches(requestQueryPairs, requiredQueryPairs);
138
139 const bool requestMatched = (pathMatches && queryMatches);
140
141 LOG(TRACE) << controller.getResponse()->getSocketContext()->getSocketConnection()->getConnectionName()
142 << " HTTP Express: router -> " << (requestMatched ? "MATCH" : "NO MATCH");
143 LOG(TRACE) << " RequestMethod: " << controller.getRequest()->method;
144 LOG(TRACE) << " RequestUrl: " << controller.getRequest()->url;
145 LOG(TRACE) << " RequestPath: " << controller.getRequest()->path;
146 LOG(TRACE) << " Mountpoint Method: " << mountPoint.method;
147 LOG(TRACE) << " Mountpoint RelativePath: " << mountPoint.relativeMountPath;
148 LOG(TRACE) << " Mountpoint AbsolutePath: " << absoluteMountPath;
149 LOG(TRACE) << " StrictRouting: " << controller.getStrictRouting();
150 LOG(TRACE) << " CaseInsensitiveRouting: " << controller.getCaseInsensitiveRouting();
151
152 if (requestMatched) {
153 // Compute remainder and temporarily **rewrite req.path** for subtree
154 std::size_t consumedLength = 0;
155 if (absoluteMountPath.find(':') != std::string::npos) {
156 // Run (or reuse) the param regex match and take its full-match length
157 std::cmatch regexMatches;
158 auto [regex, names] = compileParamRegex(
159 mountPath, /*isPrefix*/ true, controller.getStrictRouting(), controller.getCaseInsensitiveRouting());
160 if (!std::regex_search(requestPath.begin(), requestPath.end(), regexMatches, regex)) {
161 return false; // should not happen because pathMatches was true, but be safe
162 }
163 consumedLength = static_cast<std::size_t>(regexMatches.length(0)); // <-- ACTUAL matched prefix
164 } else {
165 // Literal boundary prefix: consume exactly the base length
166 consumedLength = mountPath.size();
167 }
168
169 // Now compute remainder using 'consumedLength'
170 std::string_view remainderPath{};
171 if (requestPath.size() > consumedLength) {
172 remainderPath = requestPath.substr(consumedLength);
173 if (!remainderPath.empty() && remainderPath.front() == '/') {
174 remainderPath.remove_prefix(1);
175 }
176 }
177
178 auto& req = *controller.getRequest();
179 const std::string previousPathBackup = req.path;
180 req.path = remainderPath.empty() ? "/" : ("/" + std::string(remainderPath));
181
182 req.queries.insert(requestQueryPairs.begin(), requestQueryPairs.end());
183
184 for (Route& route : routes) {
185 const bool oldStrictRouting = controller.setStrictRouting(strictRouting);
186
187 dispatched = route.dispatch(controller, absoluteMountPath);
188
189 controller.setStrictRouting(oldStrictRouting);
190
191 if (dispatched) {
192 LOG(TRACE) << "Express: R - Dispatched";
193
194 break;
195 }
196 if (controller.nextRouterCalled()) {
197 LOG(TRACE) << "Express: R - NextRouter called - breaking dispatching";
198
199 break;
200 }
201 }
202
203 req.path = previousPathBackup;
204 }
205 }
206
207 return dispatched;
208 }
express::Controller::getRequest
const std::shared_ptr< Request > & getRequest()
Definition Controller.cpp:94
express::Controller::setStrictRouting
bool setStrictRouting(bool strictRouting)
Definition Controller.cpp:151
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::Route
friend class Route
Definition Dispatcher.h:83
express::dispatcher::RouterDispatcher::routes
std::list< express::Route > routes
Definition RouterDispatcher.h:79
express::dispatcher::matchAndFillParams
bool matchAndFillParams(const std::regex &rx, const std::vector< std::string > &names, std::string_view reqPath, RequestLike &req)
Definition regex_utils.h:108
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::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::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::Route::dispatch(), express::Controller::getCaseInsensitiveRouting(), core::socket::stream::SocketConnection::getConnectionName(), express::Controller::getRequest(), express::Controller::getResponse(), core::socket::stream::SocketContext::getSocketConnection(), express::Response::getSocketContext(), express::Controller::getStrictRouting(), express::dispatcher::matchAndFillParams(), express::MountPoint::method, express::Request::method, names, express::Controller::nextRouterCalled(), express::Request::originalUrl, express::dispatcher::parseQuery(), express::Request::path, express::Request::queries, express::dispatcher::querySupersetMatches(), express::MountPoint::relativeMountPath, routes, express::Controller::setStrictRouting(), express::dispatcher::splitPathAndQuery(), strictRouting, express::dispatcher::trimOneTrailingSlash(), and express::Request::url.

Here is the call graph for this function:

◆ getCaseInsensitiveRouting()

bool express::dispatcher::RouterDispatcher::getCaseInsensitiveRouting ( ) const

Definition at line 89 of file RouterDispatcher.cpp.

89 {
90 return caseInsensitiveRouting;
91 }

References caseInsensitiveRouting.

Referenced by express::RootRoute::dispatch(), and express::RootRoute::setCaseInsensitiveRouting().

Here is the caller graph for this function:

◆ getRoutes() [1/3]

std::list< Route > & express::dispatcher::RouterDispatcher::getRoutes ( )

Definition at line 65 of file RouterDispatcher.cpp.

65 {
66 return routes;
67 }

References routes.

Referenced by express::RootRoute::routes().

Here is the caller graph for this function:

◆ getRoutes() [2/3]

std::list< std::string > express::dispatcher::RouterDispatcher::getRoutes ( const std::string & parentMountPath,
const MountPoint & mountPoint ) const

Definition at line 210 of file RouterDispatcher.cpp.

210 {
211 return getRoutes(parentMountPath, mountPoint, strictRouting);
212 }
express::dispatcher::RouterDispatcher::getRoutes
std::list< express::Route > & getRoutes()
Definition RouterDispatcher.cpp:65

References getRoutes(), and strictRouting.

Referenced by express::RootRoute::getRoutes().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRoutes() [3/3]

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

Implements express::Dispatcher.

Definition at line 215 of file RouterDispatcher.cpp.

215 {
216 std::list<std::string> collectedRoutes;
217
218 for (const Route& route : routes) {
219 collectedRoutes.splice(
220 collectedRoutes.end(),
221 route.getRoute(parentMountPath + "$" + mountPoint.relativeMountPath + "$", this->strictRouting ? true : strictRouting));
222 }
223
224 return collectedRoutes;
225 }

References express::Route::getRoute(), express::MountPoint::relativeMountPath, routes, and strictRouting.

Referenced by getRoutes().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getStrictRouting()

bool express::dispatcher::RouterDispatcher::getStrictRouting ( ) const

Definition at line 77 of file RouterDispatcher.cpp.

77 {
78 return strictRouting;
79 }

References strictRouting.

Referenced by express::RootRoute::dispatch(), and express::RootRoute::setStrictRouting().

Here is the caller graph for this function:

◆ setCaseInsensitiveRouting()

bool express::dispatcher::RouterDispatcher::setCaseInsensitiveRouting ( bool caseInsensitiveRouting)

Definition at line 81 of file RouterDispatcher.cpp.

81 {
82 const bool oldCaseInsensitiveRouting = this->caseInsensitiveRouting;
83
84 this->caseInsensitiveRouting = caseInsensitiveRouting;
85
86 return oldCaseInsensitiveRouting;
87 }

References caseInsensitiveRouting.

Referenced by express::RootRoute::setCaseInsensitiveRouting().

Here is the caller graph for this function:

◆ setStrictRouting()

bool express::dispatcher::RouterDispatcher::setStrictRouting ( bool strictRouting)

Definition at line 69 of file RouterDispatcher.cpp.

69 {
70 const bool oldStrictRouting = this->strictRouting;
71
72 this->strictRouting = strictRouting;
73
74 return oldStrictRouting;
75 }

References strictRouting.

Referenced by express::RootRoute::setStrictRouting().

Here is the caller graph for this function:

Member Data Documentation

◆ caseInsensitiveRouting

bool express::dispatcher::RouterDispatcher::caseInsensitiveRouting = false
private

Definition at line 82 of file RouterDispatcher.h.

Referenced by getCaseInsensitiveRouting(), and setCaseInsensitiveRouting().

◆ names

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

Definition at line 85 of file RouterDispatcher.h.

Referenced by dispatch().

◆ regex

std::regex express::dispatcher::RouterDispatcher::regex
private

Definition at line 84 of file RouterDispatcher.h.

◆ routes

std::list<express::Route> express::dispatcher::RouterDispatcher::routes
private

Definition at line 79 of file RouterDispatcher.h.

Referenced by dispatch(), getRoutes(), and getRoutes().

◆ strictRouting

bool express::dispatcher::RouterDispatcher::strictRouting = false
private

Definition at line 81 of file RouterDispatcher.h.

Referenced by dispatch(), getRoutes(), getRoutes(), getStrictRouting(), and setStrictRouting().

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