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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
use std::{
collections::{hash_map::Entry, HashMap},
sync::Arc,
};
use regex::Regex;
use crate::Context;
use super::{
handler::Handler,
middleware::MiddlewareHandler,
request::Request,
response::{IntoResponse, Response},
Method,
};
/// Used to store routes in the router.
#[derive(Clone)]
pub struct Route {
method: Method,
path: String,
host: String,
handler: Arc<Box<dyn Handler + Send + Sync>>,
middleware: Vec<MiddlewareHandler>,
}
impl Route {
/// Gets a reference to the path.
///
/// ```
/// use snx::{request::Request, router::Router, Method};
///
/// let mut request = Request::builder().path("/").build();
/// let router = Router::builder("localhost")
/// .get("/", |_| "hello world!")
/// .build()
/// .unwrap();
///
/// let matched_route = router.at(&Method::Get, "localhost", "/").unwrap();
/// let path = matched_route.route.path();
/// ```
pub fn path(&self) -> String {
self.path.clone()
}
/// Gets a reference to the handler.
///
/// ```
/// use snx::{request::Request, router::Router, Method};
///
/// let mut request = Request::builder().path("/").build();
/// let router = Router::builder("localhost")
/// .get("/", |_| "hello world!")
/// .build()
/// .unwrap();
///
/// let matched_route = router.at(&Method::Get, "localhost", "/").unwrap();
/// let handler = matched_route.route.handler();
/// ```
pub fn handler(&self) -> &Arc<Box<dyn Handler + Send + Sync>> {
&self.handler
}
/// Gets a reference to the middleware.
///
/// ```
/// use snx::{request::Request, router::Router, Method};
///
/// let router = Router::builder("localhost")
/// .get("/", |_| "hello world!")
/// .build()
/// .unwrap();
///
/// let matched_route = router.at(&Method::Get, "localhost", "/").unwrap();
/// let middleware = matched_route.route.middleware();
/// ```
pub fn middleware(&self) -> &Vec<MiddlewareHandler> {
&self.middleware
}
}
pub struct MatchedRoute<'a> {
pub route: &'a Route,
pub parameters: HashMap<String, String>,
}
/// Used to route a [Request] to the correct route.
pub struct Router {
hosts: HashMap<String, (Regex, HashMap<Method, matchit::Router<Route>>)>,
}
impl Router {
/// Creates a new builder-style object to manufacture a router.
pub fn builder(host: &str) -> Builder {
Builder {
host: host.to_string(),
..Default::default()
}
}
/// Tries to find routes matching the given criteria and returns the first one with its path
/// and host parameters.
///
/// ```
/// use snx::{router::Router, Method};
///
/// let router = Router::builder("localhost")
/// .get("/", |_| "hello, world!")
/// .build()
/// .unwrap();
/// let matched_route = router.at(&Method::Get, "localhost", "/").unwrap();
///
/// assert_eq!(&matched_route.route.path(), "/")
/// ```
pub fn at(&self, method: &Method, host: &str, path: &str) -> Result<MatchedRoute, RouterError> {
for (host_key, (pattern, methods)) in &self.hosts {
let compiled_host_regex = compile_host_pattern(host_key);
if let Some(captures) = pattern.captures(host) {
if let Some(router) = methods.get(method) {
if let Ok(route) = router.at(path) {
let mut parameters = HashMap::new();
for name in compiled_host_regex.capture_names().flatten() {
if let Some(m) = captures.name(name) {
parameters.insert(name.to_string(), m.as_str().to_string());
}
}
for (key, value) in route.params.iter() {
parameters.insert(key.to_string(), value.to_string());
}
return Ok(MatchedRoute {
route: route.value,
parameters,
});
} else {
return Err(match self.find_alternatives(path, methods) {
true => RouterError::MethodNotAllowed,
false => RouterError::NotFound,
});
}
} else {
return Err(match self.find_alternatives(path, methods) {
true => RouterError::MethodNotAllowed,
false => RouterError::NotFound,
});
}
}
}
Err(RouterError::NotFound)
}
/// Returns whether or not a route exists in the method router for the given path.
fn find_alternatives(
&self,
path: &str,
methods: &HashMap<Method, matchit::Router<Route>>,
) -> bool {
for router in methods {
if router.1.at(path).is_ok() {
return true;
}
}
false
}
}
#[derive(Debug)]
pub enum RouterError {
NotFound,
MethodNotAllowed,
}
/// Defines a method for adding routes to the Builder with the given method.
macro_rules! define_route_method {
($k:ident, $v:ident) => {
/// Adds a route to the builder.
pub fn $k(mut self, path: &'static str, handler: impl Handler + 'static) -> Self {
self.routes.push(Route {
method: Method::$v,
path: path.to_string(),
host: self.host.clone(),
handler: Arc::new(Box::new(handler) as Box<dyn Handler>),
middleware: Default::default(),
});
self
}
};
}
/// A builder-style object used to build a router.
#[derive(Default)]
pub struct Builder {
host: String,
prefix: Option<String>,
middleware: Vec<MiddlewareHandler>,
routes: Vec<Route>,
children: Vec<Builder>,
}
impl Builder {
/// Adds a new group with a prefix to the builder.
///
/// ```
/// use snx::router::Router;
///
/// let router = Router::builder("localhost")
/// .prefix("/posts", |router| {
/// router
/// .post("/", |_| "creates a post")
/// .get("/", |_| "returns a list of posts")
/// .get("/{id}", |_| "returns a single post")
/// .put("/{id}", |_| "updates a post")
/// .delete("/{id}", |_| "deletes a post")
/// })
/// .build()
/// .unwrap();
/// ```
pub fn prefix(mut self, prefix: &'static str, body: impl Fn(Builder) -> Builder) -> Self {
let mut builder = Self {
host: self.host.clone(),
prefix: Some(prefix.to_string()),
..Default::default()
};
builder = body(builder);
self.children.push(builder);
self
}
/// Adds a new group with a host to the builder.
///
/// ```
/// use snx::router::Router;
///
/// let router = Router::builder("localhost")
/// .host("{tenant}.acme.com", |router| {
/// router.get("/", |_| "tenant home page here")
/// })
/// .build()
/// .unwrap();
pub fn host(mut self, host: &'static str, body: impl Fn(Builder) -> Builder) -> Self {
let mut builder = Self {
host: host.to_string(),
..Default::default()
};
builder = body(builder);
self.children.push(builder);
self
}
/// Adds a new group with middleware to the builder.
///
/// ```
/// use snx::{router::Router, request::Request, response::{IntoResponse, Response}};
///
/// fn my_middleware(_req: Request, next: Box<dyn Fn() -> Response>) -> Box<dyn IntoResponse> {
/// println!("you accessed my route!");
///
/// Box::new(next())
/// };
///
/// let router = Router::builder("localhost")
/// .middleware(&[my_middleware], |router| {
/// router.get("/", |_| "hello world!")
/// })
/// .build()
/// .unwrap();
/// ```
pub fn middleware(
mut self,
middleware: &'static [impl Fn(Context, Request, Box<dyn Fn() -> Response>) -> Box<dyn IntoResponse>
+ Send
+ Sync],
body: impl Fn(Builder) -> Builder,
) -> Self {
let mut builder = Self {
host: self.host.clone(),
..Self::default()
};
for handler in middleware {
builder.middleware.push(Arc::new(Box::new(handler)
as Box<
dyn Fn(Context, Request, Box<dyn Fn() -> Response>) -> Box<dyn IntoResponse>
+ Send
+ Sync,
>));
}
builder = body(builder);
self.children.push(builder);
self
}
define_route_method!(get, Get);
define_route_method!(head, Head);
define_route_method!(post, Post);
define_route_method!(put, Put);
define_route_method!(delete, Delete);
define_route_method!(connect, Connect);
define_route_method!(options, Options);
define_route_method!(trace, Trace);
define_route_method!(patch, Patch);
/// Builds a router.
pub fn build(self) -> Result<Router, matchit::InsertError> {
let mut hosts = HashMap::new();
for route in self.resolve(&mut vec![], &mut vec![]) {
if let Entry::Vacant(e) = hosts.entry(route.host.clone()) {
let mut router = matchit::Router::new();
router.insert(route.path.clone(), route.clone())?;
let mut methods = HashMap::new();
methods.insert(route.method, router);
let pattern = compile_host_pattern(&route.host);
e.insert((pattern, methods));
} else {
let (_, methods) = hosts.get_mut(&route.host).unwrap();
if let Some(router) = methods.get_mut(&route.method) {
router.insert(route.path.clone(), route.clone())?;
} else {
let mut router = matchit::Router::new();
router.insert(route.path.clone(), route.clone())?;
methods.insert(route.method, router);
}
}
}
Ok(Router { hosts })
}
/// Recursively adds (compounding) prefixes and middleware to all of this builders' children,
/// combines the children's routes into its own and returns them.
fn resolve(
mut self,
prefixes: &mut Vec<String>,
middleware: &mut Vec<MiddlewareHandler>,
) -> Vec<Route> {
if let Some(prefix) = self.prefix {
prefixes.push(prefix);
}
middleware.extend(self.middleware);
for route in &mut self.routes {
if prefixes.is_empty() && route.path.len() > 1 {
route.path = route.path.trim_end_matches('/').to_string();
}
route.middleware.extend(middleware.clone());
route.path = format!("{}{}", prefixes.join("/"), route.path);
if route.path.len() > 1 {
if let Some(path) = route.path.strip_suffix('/') {
route.path = path.to_string();
}
}
route.host = self.host.clone();
}
for child in self.children {
self.routes
.extend_from_slice(&child.resolve(prefixes, middleware));
}
self.routes
}
}
/// Compiles a regular expression that captures dynamic components of a hostname.
fn compile_host_pattern(pattern: &str) -> Regex {
let mut regex_pattern = regex::escape(pattern);
regex_pattern = regex_pattern
.replace(r"\{", "(?P<")
.replace(r"\}", ">[^.]+)");
regex_pattern = regex_pattern.replace(r"\*", "[^.]+");
Regex::new(&format!("^{}$", regex_pattern)).expect("Invalid regex")
}