1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-25 00:12:59 +01:00
actix-extras/src/router.rs

1240 lines
41 KiB
Rust
Raw Normal View History

use std::cell::RefCell;
2018-07-15 11:12:21 +02:00
use std::cmp::min;
2018-04-14 01:02:01 +02:00
use std::collections::HashMap;
use std::hash::{Hash, Hasher};
2017-12-07 01:26:27 +01:00
use std::rc::Rc;
2018-04-14 01:02:01 +02:00
use regex::{escape, Regex};
2018-06-25 06:58:04 +02:00
use url::Url;
use error::UrlGenerationError;
2018-07-15 11:12:21 +02:00
use handler::{AsyncResult, FromRequest, Responder, RouteHandler};
use http::{Method, StatusCode};
use httprequest::HttpRequest;
use httpresponse::HttpResponse;
2018-06-25 06:58:04 +02:00
use param::{ParamItem, Params};
2018-07-15 11:12:21 +02:00
use pred::Predicate;
use resource::{DefaultResource, Resource};
use scope::Scope;
2018-06-25 06:58:04 +02:00
use server::Request;
#[derive(Debug, Copy, Clone, PartialEq)]
2018-07-15 11:24:27 +02:00
pub(crate) enum ResourceId {
2018-07-15 11:12:21 +02:00
Default,
2018-06-25 06:58:04 +02:00
Normal(u16),
}
2017-12-07 01:26:27 +01:00
2018-07-15 11:12:21 +02:00
enum ResourcePattern<S> {
Resource(ResourceDef),
Handler(ResourceDef, Option<Vec<Box<Predicate<S>>>>),
Scope(ResourceDef, Vec<Box<Predicate<S>>>),
}
enum ResourceItem<S> {
Resource(Resource<S>),
Handler(Box<RouteHandler<S>>),
Scope(Scope<S>),
}
2017-12-07 01:26:27 +01:00
/// Interface for application router.
2018-07-15 11:12:21 +02:00
pub struct Router<S> {
2018-07-16 07:33:29 +02:00
rmap: Rc<ResourceMap>,
2018-07-15 11:12:21 +02:00
patterns: Vec<ResourcePattern<S>>,
resources: Vec<ResourceItem<S>>,
default: Option<DefaultResource<S>>,
}
2018-07-15 11:24:27 +02:00
/// Information about current resource
2018-06-25 06:58:04 +02:00
#[derive(Clone)]
2018-07-15 11:24:27 +02:00
pub struct ResourceInfo {
2018-07-16 07:33:29 +02:00
rmap: Rc<ResourceMap>,
2018-07-15 11:24:27 +02:00
resource: ResourceId,
2018-06-25 06:58:04 +02:00
params: Params,
2018-07-15 12:24:22 +02:00
prefix: u16,
2018-06-25 06:58:04 +02:00
}
2018-07-15 11:24:27 +02:00
impl ResourceInfo {
2018-07-15 11:12:21 +02:00
/// Name os the resource
#[inline]
pub fn name(&self) -> &str {
2018-07-15 11:24:27 +02:00
if let ResourceId::Normal(idx) = self.resource {
2018-07-16 07:33:29 +02:00
self.rmap.patterns[idx as usize].0.name()
2018-07-15 11:12:21 +02:00
} else {
""
}
}
2018-07-15 11:24:27 +02:00
/// This method returns reference to matched `ResourceDef` object.
2018-06-25 06:58:04 +02:00
#[inline]
2018-07-15 11:24:27 +02:00
pub fn rdef(&self) -> Option<&ResourceDef> {
if let ResourceId::Normal(idx) = self.resource {
2018-07-16 07:33:29 +02:00
Some(&self.rmap.patterns[idx as usize].0)
2018-06-25 06:58:04 +02:00
} else {
None
}
}
2018-07-15 12:24:22 +02:00
pub(crate) fn set_prefix(&mut self, prefix: u16) {
self.prefix = prefix;
}
2018-06-25 06:58:04 +02:00
/// Get a reference to the Params object.
///
/// Params is a container for url parameters.
/// A variable segment is specified in the form `{identifier}`,
/// where the identifier can be used later in a request handler to
/// access the matched value for that segment.
#[inline]
pub fn match_info(&self) -> &Params {
&self.params
}
#[inline]
2018-07-15 11:24:27 +02:00
pub(crate) fn merge(&mut self, info: &ResourceInfo) {
2018-07-15 11:12:21 +02:00
let mut p = info.params.clone();
p.set_tail(self.params.tail);
for item in &self.params.segments {
2018-06-25 06:58:04 +02:00
p.add(item.0.clone(), item.1.clone());
}
2018-07-15 12:24:22 +02:00
self.prefix = info.params.tail;
2018-07-15 11:12:21 +02:00
self.params = p;
2018-06-25 06:58:04 +02:00
}
/// Generate url for named resource
///
/// Check [`HttpRequest::url_for()`](../struct.HttpRequest.html#method.
/// url_for) for detailed information.
pub fn url_for<U, I>(
&self, req: &Request, name: &str, elements: U,
) -> Result<Url, UrlGenerationError>
where
U: IntoIterator<Item = I>,
I: AsRef<str>,
{
let mut path = String::new();
let mut elements = elements.into_iter();
if self
.rmap
.patterns_for(name, &mut path, &mut elements)?
.is_some()
{
2018-06-25 06:58:04 +02:00
if path.starts_with('/') {
let conn = req.connection_info();
Ok(Url::parse(&format!(
"{}://{}{}",
conn.scheme(),
conn.host(),
path
))?)
} else {
Ok(Url::parse(&path)?)
}
} else {
Err(UrlGenerationError::ResourceNotFound)
}
}
2018-07-16 07:33:29 +02:00
/// Check if application contains matching resource.
2018-06-25 06:58:04 +02:00
///
/// This method does not take `prefix` into account.
/// For example if prefix is `/test` and router contains route `/name`,
2018-07-16 07:33:29 +02:00
/// following path would be recognizable `/test/name` but `has_resource()` call
2018-06-25 06:58:04 +02:00
/// would return `false`.
2018-07-16 07:33:29 +02:00
pub fn has_resource(&self, path: &str) -> bool {
self.rmap.has_resource(path)
}
2018-07-16 07:33:29 +02:00
/// Check if application contains matching resource.
///
/// This method does take `prefix` into account
/// but behaves like `has_route` in case `prefix` is not set in the router.
///
/// For example if prefix is `/test` and router contains route `/name`, the
/// following path would be recognizable `/test/name` and `has_prefixed_route()` call
/// would return `true`.
/// It will not match against prefix in case it's not given. For example for `/name`
/// with a `/test` prefix would return `false`
2018-07-16 07:33:29 +02:00
pub fn has_prefixed_resource(&self, path: &str) -> bool {
2018-07-16 07:10:51 +02:00
let prefix = self.prefix as usize;
if prefix >= path.len() {
return false;
}
2018-07-16 07:33:29 +02:00
self.rmap.has_resource(&path[prefix..])
2018-06-25 06:58:04 +02:00
}
}
2018-07-16 07:33:29 +02:00
pub(crate) struct ResourceMap {
root: ResourceDef,
parent: RefCell<Option<Rc<ResourceMap>>>,
2018-07-15 11:12:21 +02:00
named: HashMap<String, ResourceDef>,
2018-07-16 07:33:29 +02:00
patterns: Vec<(ResourceDef, Option<Rc<ResourceMap>>)>,
nested: Vec<Rc<ResourceMap>>,
2018-07-16 07:33:29 +02:00
}
impl ResourceMap {
fn has_resource(&self, path: &str) -> bool {
2018-07-16 07:33:29 +02:00
let path = if path.is_empty() { "/" } else { path };
for (pattern, rmap) in &self.patterns {
if let Some(ref rmap) = rmap {
if let Some(plen) = pattern.is_prefix_match(path) {
return rmap.has_resource(&path[plen..]);
}
} else if pattern.is_match(path) {
return true;
}
}
false
}
fn patterns_for<U, I>(
&self, name: &str, path: &mut String, elements: &mut U,
) -> Result<Option<()>, UrlGenerationError>
where
U: Iterator<Item = I>,
I: AsRef<str>,
{
if self.pattern_for(name, path, elements)?.is_some() {
Ok(Some(()))
} else {
self.parent_pattern_for(name, path, elements)
}
}
fn pattern_for<U, I>(
&self, name: &str, path: &mut String, elements: &mut U,
) -> Result<Option<()>, UrlGenerationError>
where
U: Iterator<Item = I>,
I: AsRef<str>,
{
if let Some(pattern) = self.named.get(name) {
self.fill_root(path, elements)?;
pattern.resource_path(path, elements)?;
Ok(Some(()))
} else {
for rmap in &self.nested {
if rmap.pattern_for(name, path, elements)?.is_some() {
return Ok(Some(()));
}
}
Ok(None)
}
}
fn fill_root<U, I>(
&self, path: &mut String, elements: &mut U,
) -> Result<(), UrlGenerationError>
where
U: Iterator<Item = I>,
I: AsRef<str>,
{
if let Some(ref parent) = *self.parent.borrow() {
parent.fill_root(path, elements)?;
}
self.root.resource_path(path, elements)
}
fn parent_pattern_for<U, I>(
&self, name: &str, path: &mut String, elements: &mut U,
) -> Result<Option<()>, UrlGenerationError>
where
U: Iterator<Item = I>,
I: AsRef<str>,
{
if let Some(ref parent) = *self.parent.borrow() {
if let Some(pattern) = parent.named.get(name) {
self.fill_root(path, elements)?;
pattern.resource_path(path, elements)?;
Ok(Some(()))
} else {
parent.parent_pattern_for(name, path, elements)
}
} else {
Ok(None)
}
}
}
2017-12-07 01:26:27 +01:00
2018-07-15 11:12:21 +02:00
impl<S: 'static> Default for Router<S> {
fn default() -> Self {
Router::new(ResourceDef::new(""))
2018-07-15 11:12:21 +02:00
}
}
2018-07-15 11:12:21 +02:00
impl<S: 'static> Router<S> {
pub(crate) fn new(root: ResourceDef) -> Self {
2018-07-15 11:12:21 +02:00
Router {
2018-07-16 07:33:29 +02:00
rmap: Rc::new(ResourceMap {
root,
parent: RefCell::new(None),
2018-07-15 11:12:21 +02:00
named: HashMap::new(),
patterns: Vec::new(),
nested: Vec::new(),
2018-07-15 11:12:21 +02:00
}),
resources: Vec::new(),
patterns: Vec::new(),
default: None,
2017-12-07 01:26:27 +01:00
}
}
2018-07-15 11:12:21 +02:00
#[inline]
2018-07-15 11:24:27 +02:00
pub(crate) fn route_info_params(&self, idx: u16, params: Params) -> ResourceInfo {
ResourceInfo {
2018-06-25 06:58:04 +02:00
params,
2018-07-15 12:24:22 +02:00
prefix: 0,
2018-07-16 07:33:29 +02:00
rmap: self.rmap.clone(),
2018-07-15 11:24:27 +02:00
resource: ResourceId::Normal(idx),
}
2017-12-07 01:26:27 +01:00
}
2018-07-15 11:12:21 +02:00
#[cfg(test)]
2018-07-15 11:24:27 +02:00
pub(crate) fn default_route_info(&self) -> ResourceInfo {
ResourceInfo {
2018-06-25 06:58:04 +02:00
params: Params::new(),
2018-07-16 07:33:29 +02:00
rmap: self.rmap.clone(),
2018-07-15 11:24:27 +02:00
resource: ResourceId::Default,
2018-07-15 12:24:22 +02:00
prefix: 0,
}
2017-12-07 01:26:27 +01:00
}
pub(crate) fn set_prefix(&mut self, path: &str) {
Rc::get_mut(&mut self.rmap).unwrap().root = ResourceDef::new(path);
}
2018-07-15 11:12:21 +02:00
pub(crate) fn register_resource(&mut self, resource: Resource<S>) {
{
2018-07-16 07:33:29 +02:00
let rmap = Rc::get_mut(&mut self.rmap).unwrap();
2018-07-15 11:12:21 +02:00
let name = resource.get_name();
if !name.is_empty() {
2018-07-15 14:53:02 +02:00
assert!(
2018-07-16 07:33:29 +02:00
!rmap.named.contains_key(name),
2018-07-15 14:53:02 +02:00
"Named resource {:?} is registered.",
name
);
2018-07-16 07:33:29 +02:00
rmap.named.insert(name.to_owned(), resource.rdef().clone());
2018-07-15 11:12:21 +02:00
}
2018-07-16 07:33:29 +02:00
rmap.patterns.push((resource.rdef().clone(), None));
2018-06-25 06:58:04 +02:00
}
2018-07-15 11:12:21 +02:00
self.patterns
.push(ResourcePattern::Resource(resource.rdef().clone()));
self.resources.push(ResourceItem::Resource(resource));
}
pub(crate) fn register_scope(&mut self, mut scope: Scope<S>) {
2018-07-16 07:33:29 +02:00
Rc::get_mut(&mut self.rmap)
2018-07-15 11:12:21 +02:00
.unwrap()
.patterns
2018-07-16 07:33:29 +02:00
.push((scope.rdef().clone(), Some(scope.router().rmap.clone())));
Rc::get_mut(&mut self.rmap)
.unwrap()
.nested
.push(scope.router().rmap.clone());
2018-07-15 11:12:21 +02:00
let filters = scope.take_filters();
self.patterns
.push(ResourcePattern::Scope(scope.rdef().clone(), filters));
self.resources.push(ResourceItem::Scope(scope));
}
pub(crate) fn register_handler(
&mut self, path: &str, hnd: Box<RouteHandler<S>>,
filters: Option<Vec<Box<Predicate<S>>>>,
) {
let rdef = ResourceDef::prefix(path);
2018-07-16 07:33:29 +02:00
Rc::get_mut(&mut self.rmap)
2018-07-15 11:12:21 +02:00
.unwrap()
.patterns
2018-07-16 07:33:29 +02:00
.push((rdef.clone(), None));
2018-07-15 11:12:21 +02:00
self.resources.push(ResourceItem::Handler(hnd));
self.patterns.push(ResourcePattern::Handler(rdef, filters));
}
pub(crate) fn has_default_resource(&self) -> bool {
self.default.is_some()
}
pub(crate) fn register_default_resource(&mut self, resource: DefaultResource<S>) {
self.default = Some(resource);
}
pub(crate) fn finish(&mut self) {
for resource in &mut self.resources {
match resource {
ResourceItem::Resource(_) => (),
ResourceItem::Scope(scope) => {
if !scope.has_default_resource() {
if let Some(ref default) = self.default {
2018-07-15 11:12:21 +02:00
scope.default_resource(default.clone());
}
}
*scope.router().rmap.parent.borrow_mut() = Some(self.rmap.clone());
scope.finish();
}
ResourceItem::Handler(hnd) => {
if !hnd.has_default_resource() {
if let Some(ref default) = self.default {
2018-07-15 11:12:21 +02:00
hnd.default_resource(default.clone());
}
}
hnd.finish()
2018-07-15 11:12:21 +02:00
}
2018-06-25 06:58:04 +02:00
}
2017-12-07 01:26:27 +01:00
}
}
2018-07-15 11:12:21 +02:00
pub(crate) fn register_external(&mut self, name: &str, rdef: ResourceDef) {
2018-07-16 07:33:29 +02:00
let rmap = Rc::get_mut(&mut self.rmap).unwrap();
2018-07-15 14:53:02 +02:00
assert!(
2018-07-16 07:33:29 +02:00
!rmap.named.contains_key(name),
2018-07-15 14:53:02 +02:00
"Named resource {:?} is registered.",
name
);
2018-07-16 07:33:29 +02:00
rmap.named.insert(name.to_owned(), rdef);
2018-07-15 11:12:21 +02:00
}
pub(crate) fn register_route<T, F, R>(&mut self, path: &str, method: Method, f: F)
where
F: Fn(T) -> R + 'static,
R: Responder + 'static,
T: FromRequest<S> + 'static,
{
let out = {
// get resource handler
let mut iterator = self.resources.iter_mut();
loop {
if let Some(ref mut resource) = iterator.next() {
if let ResourceItem::Resource(ref mut resource) = resource {
if resource.rdef().pattern() == path {
resource.method(method).with(f);
break None;
}
}
} else {
let mut resource = Resource::new(ResourceDef::new(path));
resource.method(method).with(f);
break Some(resource);
}
}
};
if let Some(out) = out {
self.register_resource(out);
}
}
/// Handle request
pub fn handle(&self, req: &HttpRequest<S>) -> AsyncResult<HttpResponse> {
2018-07-15 11:24:27 +02:00
let resource = match req.resource().resource {
ResourceId::Normal(idx) => &self.resources[idx as usize],
ResourceId::Default => {
2018-07-15 11:12:21 +02:00
if let Some(ref default) = self.default {
if let Some(id) = default.get_route_id(req) {
return default.handle(id, req);
}
}
return AsyncResult::ok(HttpResponse::new(StatusCode::NOT_FOUND));
}
};
match resource {
ResourceItem::Resource(ref resource) => {
if let Some(id) = resource.get_route_id(req) {
return resource.handle(id, req);
}
if let Some(ref default) = self.default {
if let Some(id) = default.get_route_id(req) {
return default.handle(id, req);
}
}
}
ResourceItem::Handler(hnd) => return hnd.handle(req),
ResourceItem::Scope(hnd) => return hnd.handle(req),
}
AsyncResult::ok(HttpResponse::new(StatusCode::NOT_FOUND))
}
/// Query for matched resource
2018-07-15 11:24:27 +02:00
pub fn recognize(&self, req: &Request, state: &S, tail: usize) -> ResourceInfo {
2018-07-15 11:12:21 +02:00
if tail <= req.path().len() {
'outer: for (idx, resource) in self.patterns.iter().enumerate() {
match resource {
ResourcePattern::Resource(rdef) => {
2018-07-15 11:50:56 +02:00
if let Some(params) = rdef.match_with_params(req, tail) {
2018-07-15 11:12:21 +02:00
return self.route_info_params(idx as u16, params);
}
}
ResourcePattern::Handler(rdef, filters) => {
if let Some(params) = rdef.match_prefix_with_params(req, tail) {
if let Some(ref filters) = filters {
for filter in filters {
if !filter.check(req, state) {
continue 'outer;
}
}
}
return self.route_info_params(idx as u16, params);
}
}
ResourcePattern::Scope(rdef, filters) => {
if let Some(params) = rdef.match_prefix_with_params(req, tail) {
for filter in filters {
if !filter.check(req, state) {
continue 'outer;
}
}
return self.route_info_params(idx as u16, params);
}
}
}
}
}
2018-07-15 11:24:27 +02:00
ResourceInfo {
2018-07-15 12:24:22 +02:00
prefix: tail as u16,
2018-07-15 11:12:21 +02:00
params: Params::new(),
2018-07-16 07:33:29 +02:00
rmap: self.rmap.clone(),
2018-07-15 11:24:27 +02:00
resource: ResourceId::Default,
2018-07-15 11:12:21 +02:00
}
2017-12-07 01:26:27 +01:00
}
}
#[derive(Debug, Clone, PartialEq)]
enum PatternElement {
Str(String),
Var(String),
}
2018-02-22 14:48:18 +01:00
#[derive(Clone, Debug)]
enum PatternType {
Static(String),
Prefix(String),
Dynamic(Regex, Vec<Rc<String>>, usize),
}
#[derive(Debug, Copy, Clone, PartialEq)]
/// Resource type
pub enum ResourceType {
/// Normal resource
Normal,
2018-05-06 18:07:30 +02:00
/// Resource for application default handler
Default,
/// External resource
External,
/// Unknown resource type
Unset,
}
2018-05-06 18:07:30 +02:00
/// Resource type describes an entry in resources table
2018-06-25 06:58:04 +02:00
#[derive(Clone, Debug)]
2018-07-12 11:30:01 +02:00
pub struct ResourceDef {
tp: PatternType,
rtp: ResourceType,
name: String,
pattern: String,
elements: Vec<PatternElement>,
}
2018-07-12 11:30:01 +02:00
impl ResourceDef {
/// Parse path pattern and create new `ResourceDef` instance.
///
/// Panics if path pattern is wrong.
2018-07-15 11:12:21 +02:00
pub fn new(path: &str) -> Self {
ResourceDef::with_prefix(path, false, !path.is_empty())
}
/// Parse path pattern and create new `ResourceDef` instance.
///
/// Use `prefix` type instead of `static`.
///
/// Panics if path regex pattern is wrong.
2018-07-15 11:12:21 +02:00
pub fn prefix(path: &str) -> Self {
ResourceDef::with_prefix(path, true, !path.is_empty())
}
/// Construct external resource def
///
/// Panics if path pattern is wrong.
2018-07-15 11:12:21 +02:00
pub fn external(path: &str) -> Self {
let mut resource = ResourceDef::with_prefix(path, false, false);
resource.rtp = ResourceType::External;
resource
}
/// Parse path pattern and create new `ResourceDef` instance with custom prefix
pub fn with_prefix(path: &str, for_prefix: bool, slash: bool) -> Self {
let mut path = path.to_owned();
if slash && !path.starts_with('/') {
path.insert(0, '/');
}
let (pattern, elements, is_dynamic, len) = ResourceDef::parse(&path, for_prefix);
let tp = if is_dynamic {
let re = match Regex::new(&pattern) {
Ok(re) => re,
2018-04-14 01:02:01 +02:00
Err(err) => panic!("Wrong path pattern: \"{}\" {}", path, err),
};
2018-06-22 07:44:38 +02:00
// actix creates one router per thread
2018-05-17 21:20:20 +02:00
let names = re
.capture_names()
2018-06-25 06:58:04 +02:00
.filter_map(|name| name.map(|name| Rc::new(name.to_owned())))
.collect();
PatternType::Dynamic(re, names, len)
} else if for_prefix {
PatternType::Prefix(pattern.clone())
} else {
PatternType::Static(pattern.clone())
};
2018-07-12 11:30:01 +02:00
ResourceDef {
2018-02-26 23:33:56 +01:00
tp,
elements,
2018-07-15 11:12:21 +02:00
name: "".to_string(),
rtp: ResourceType::Normal,
pattern: path.to_owned(),
}
}
2018-07-15 11:12:21 +02:00
/// Resource type
pub fn rtype(&self) -> ResourceType {
self.rtp
}
/// Resource name
pub fn name(&self) -> &str {
&self.name
}
2018-07-15 11:12:21 +02:00
/// Resource name
pub(crate) fn set_name(&mut self, name: &str) {
self.name = name.to_owned();
}
/// Path pattern of the resource
pub fn pattern(&self) -> &str {
&self.pattern
}
/// Is this path a match against this resource?
pub fn is_match(&self, path: &str) -> bool {
match self.tp {
PatternType::Static(ref s) => s == path,
PatternType::Dynamic(ref re, _, _) => re.is_match(path),
PatternType::Prefix(ref s) => path.starts_with(s),
}
}
2018-07-16 07:33:29 +02:00
fn is_prefix_match(&self, path: &str) -> Option<usize> {
let plen = path.len();
let path = if path.is_empty() { "/" } else { path };
match self.tp {
PatternType::Static(ref s) => if s == path {
Some(plen)
} else {
None
},
PatternType::Dynamic(ref re, _, len) => {
if let Some(captures) = re.captures(path) {
let mut pos = 0;
let mut passed = false;
for capture in captures.iter() {
if let Some(ref m) = capture {
if !passed {
passed = true;
continue;
}
pos = m.end();
}
}
Some(plen + pos + len)
} else {
None
}
}
PatternType::Prefix(ref s) => {
let len = if path == s {
s.len()
} else if path.starts_with(s)
&& (s.ends_with('/') || path.split_at(s.len()).1.starts_with('/'))
{
if s.ends_with('/') {
s.len() - 1
} else {
s.len()
}
} else {
return None;
};
Some(min(plen, len))
}
}
}
/// Are the given path and parameters a match against this resource?
2018-07-15 11:50:56 +02:00
pub fn match_with_params(&self, req: &Request, plen: usize) -> Option<Params> {
2018-06-25 06:58:04 +02:00
let path = &req.path()[plen..];
2018-06-19 12:45:26 +02:00
2018-06-25 06:58:04 +02:00
match self.tp {
PatternType::Static(ref s) => if s != path {
None
} else {
Some(Params::with_url(req.url()))
},
PatternType::Dynamic(ref re, ref names, _) => {
if let Some(captures) = re.captures(path) {
let mut params = Params::with_url(req.url());
let mut idx = 0;
let mut passed = false;
for capture in captures.iter() {
if let Some(ref m) = capture {
if !passed {
passed = true;
continue;
}
params.add(
names[idx].clone(),
ParamItem::UrlSegment(
2018-06-19 12:45:26 +02:00
(plen + m.start()) as u16,
(plen + m.end()) as u16,
2018-06-25 06:58:04 +02:00
),
);
idx += 1;
}
}
2018-06-25 06:58:04 +02:00
params.set_tail(req.path().len() as u16);
Some(params)
} else {
None
}
}
2018-06-25 06:58:04 +02:00
PatternType::Prefix(ref s) => if !path.starts_with(s) {
None
} else {
Some(Params::with_url(req.url()))
},
}
}
/// Is the given path a prefix match and do the parameters match against this resource?
2018-06-25 06:58:04 +02:00
pub fn match_prefix_with_params(
&self, req: &Request, plen: usize,
) -> Option<Params> {
let path = &req.path()[plen..];
let path = if path.is_empty() { "/" } else { path };
match self.tp {
PatternType::Static(ref s) => if s == path {
2018-07-16 07:33:29 +02:00
let mut params = Params::with_url(req.url());
params.set_tail(req.path().len() as u16);
Some(params)
2018-06-25 06:58:04 +02:00
} else {
None
},
PatternType::Dynamic(ref re, ref names, len) => {
if let Some(captures) = re.captures(path) {
let mut params = Params::with_url(req.url());
let mut pos = 0;
let mut passed = false;
let mut idx = 0;
for capture in captures.iter() {
if let Some(ref m) = capture {
if !passed {
passed = true;
continue;
}
params.add(
names[idx].clone(),
ParamItem::UrlSegment(
2018-06-19 12:45:26 +02:00
(plen + m.start()) as u16,
(plen + m.end()) as u16,
2018-06-25 06:58:04 +02:00
),
);
idx += 1;
pos = m.end();
}
}
2018-06-25 06:58:04 +02:00
params.set_tail((plen + pos + len) as u16);
Some(params)
} else {
None
}
2018-06-25 06:58:04 +02:00
}
PatternType::Prefix(ref s) => {
let len = if path == s {
s.len()
} else if path.starts_with(s)
&& (s.ends_with('/') || path.split_at(s.len()).1.starts_with('/'))
{
if s.ends_with('/') {
s.len() - 1
2018-06-19 12:45:26 +02:00
} else {
2018-06-25 06:58:04 +02:00
s.len()
2018-06-19 12:45:26 +02:00
}
2018-06-25 06:58:04 +02:00
} else {
return None;
};
let mut params = Params::with_url(req.url());
2018-07-15 11:12:21 +02:00
params.set_tail(min(req.path().len(), plen + len) as u16);
2018-06-25 06:58:04 +02:00
Some(params)
2018-06-19 12:45:26 +02:00
}
}
}
2018-05-06 18:07:30 +02:00
/// Build resource path.
2018-04-14 01:02:01 +02:00
pub fn resource_path<U, I>(
&self, path: &mut String, elements: &mut U,
) -> Result<(), UrlGenerationError>
2018-04-14 01:02:01 +02:00
where
U: Iterator<Item = I>,
2018-04-14 01:02:01 +02:00
I: AsRef<str>,
{
match self.tp {
PatternType::Prefix(ref p) => path.push_str(p),
PatternType::Static(ref p) => path.push_str(p),
PatternType::Dynamic(..) => {
for el in &self.elements {
match *el {
PatternElement::Str(ref s) => path.push_str(s),
PatternElement::Var(_) => {
if let Some(val) = elements.next() {
path.push_str(val.as_ref())
} else {
return Err(UrlGenerationError::NotEnoughElements);
}
}
}
}
}
};
Ok(())
}
fn parse(
pattern: &str, for_prefix: bool,
) -> (String, Vec<PatternElement>, bool, usize) {
const DEFAULT_PATTERN: &str = "[^/]+";
let mut re1 = String::from("^");
let mut re2 = String::new();
let mut el = String::new();
let mut in_param = false;
let mut in_param_pattern = false;
let mut param_name = String::new();
let mut param_pattern = String::from(DEFAULT_PATTERN);
let mut is_dynamic = false;
let mut elems = Vec::new();
let mut len = 0;
for ch in pattern.chars() {
if in_param {
// In parameter segment: `{....}`
if ch == '}' {
elems.push(PatternElement::Var(param_name.clone()));
2018-02-22 14:48:18 +01:00
re1.push_str(&format!(r"(?P<{}>{})", &param_name, &param_pattern));
param_name.clear();
param_pattern = String::from(DEFAULT_PATTERN);
len = 0;
in_param_pattern = false;
in_param = false;
} else if ch == ':' {
// The parameter name has been determined; custom pattern land
in_param_pattern = true;
param_pattern.clear();
} else if in_param_pattern {
// Ignore leading whitespace for pattern
if !(ch == ' ' && param_pattern.is_empty()) {
param_pattern.push(ch);
}
} else {
param_name.push(ch);
}
} else if ch == '{' {
in_param = true;
is_dynamic = true;
elems.push(PatternElement::Str(el.clone()));
el.clear();
} else {
2018-02-22 14:48:18 +01:00
re1.push_str(escape(&ch.to_string()).as_str());
re2.push(ch);
el.push(ch);
len += 1;
}
}
if !el.is_empty() {
elems.push(PatternElement::Str(el.clone()));
}
2018-02-22 14:48:18 +01:00
let re = if is_dynamic {
if !for_prefix {
re1.push('$');
}
2018-02-22 14:48:18 +01:00
re1
} else {
re2
};
(re, elems, is_dynamic, len)
}
}
2018-07-12 11:30:01 +02:00
impl PartialEq for ResourceDef {
fn eq(&self, other: &ResourceDef) -> bool {
self.pattern == other.pattern
}
}
2018-07-12 11:30:01 +02:00
impl Eq for ResourceDef {}
2018-07-12 11:30:01 +02:00
impl Hash for ResourceDef {
fn hash<H: Hasher>(&self, state: &mut H) {
self.pattern.hash(state);
}
}
#[cfg(test)]
mod tests {
use super::*;
use test::TestRequest;
#[test]
fn test_recognizer10() {
let mut router = Router::<()>::default();
2018-07-15 11:12:21 +02:00
router.register_resource(Resource::new(ResourceDef::new("/name")));
router.register_resource(Resource::new(ResourceDef::new("/name/{val}")));
router.register_resource(Resource::new(ResourceDef::new(
"/name/{val}/index.html",
)));
router.register_resource(Resource::new(ResourceDef::new("/file/{file}.{ext}")));
router.register_resource(Resource::new(ResourceDef::new(
"/v{val}/{val2}/index.html",
)));
router.register_resource(Resource::new(ResourceDef::new("/v/{tail:.*}")));
router.register_resource(Resource::new(ResourceDef::new("/test2/{test}.html")));
router.register_resource(Resource::new(ResourceDef::new("/{test}/index.html")));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/name").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(0));
2018-07-15 11:12:21 +02:00
assert!(info.match_info().is_empty());
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/name/value").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(1));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("val").unwrap(), "value");
assert_eq!(&info.match_info()["val"], "value");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/name/value2/index.html").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(2));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("val").unwrap(), "value2");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/file/file.gz").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(3));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("file").unwrap(), "file");
assert_eq!(info.match_info().get("ext").unwrap(), "gz");
2018-02-19 23:57:57 +01:00
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/vtest/ttt/index.html").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(4));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("val").unwrap(), "test");
assert_eq!(info.match_info().get("val2").unwrap(), "ttt");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/v/blah-blah/index.html").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(5));
2018-04-29 18:09:08 +02:00
assert_eq!(
2018-07-15 11:12:21 +02:00
info.match_info().get("tail").unwrap(),
2018-04-29 18:09:08 +02:00
"blah-blah/index.html"
);
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test2/index.html").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(6));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("test").unwrap(), "index");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/bbb/index.html").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(7));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("test").unwrap(), "bbb");
}
2018-02-22 14:48:18 +01:00
#[test]
fn test_recognizer_2() {
let mut router = Router::<()>::default();
2018-07-15 11:12:21 +02:00
router.register_resource(Resource::new(ResourceDef::new("/index.json")));
router.register_resource(Resource::new(ResourceDef::new("/{source}.json")));
2018-02-22 14:48:18 +01:00
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/index.json").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(0));
2018-02-22 14:48:18 +01:00
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test.json").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(1));
2018-02-22 14:48:18 +01:00
}
#[test]
fn test_recognizer_with_prefix() {
let mut router = Router::<()>::default();
2018-07-15 11:12:21 +02:00
router.register_resource(Resource::new(ResourceDef::new("/name")));
router.register_resource(Resource::new(ResourceDef::new("/name/{val}")));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/name").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 5);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Default);
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test/name").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 5);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(0));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test/name/value").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 5);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(1));
2018-07-15 11:12:21 +02:00
assert_eq!(info.match_info().get("val").unwrap(), "value");
assert_eq!(&info.match_info()["val"], "value");
// same patterns
let mut router = Router::<()>::default();
2018-07-15 11:12:21 +02:00
router.register_resource(Resource::new(ResourceDef::new("/name")));
router.register_resource(Resource::new(ResourceDef::new("/name/{val}")));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/name").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 6);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Default);
2018-07-15 11:12:21 +02:00
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test2/name").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 6);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(0));
2018-07-15 11:12:21 +02:00
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test2/name-test").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 6);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Default);
2018-07-15 11:12:21 +02:00
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test2/name/ttt").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 6);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(1));
2018-07-15 11:12:21 +02:00
assert_eq!(&info.match_info()["val"], "ttt");
}
#[test]
fn test_parse_static() {
2018-07-15 11:12:21 +02:00
let re = ResourceDef::new("/");
assert!(re.is_match("/"));
assert!(!re.is_match("/a"));
2018-07-15 11:12:21 +02:00
let re = ResourceDef::new("/name");
assert!(re.is_match("/name"));
assert!(!re.is_match("/name1"));
assert!(!re.is_match("/name/"));
assert!(!re.is_match("/name~"));
2018-07-15 11:12:21 +02:00
let re = ResourceDef::new("/name/");
assert!(re.is_match("/name/"));
assert!(!re.is_match("/name"));
assert!(!re.is_match("/name/gs"));
2018-07-15 11:12:21 +02:00
let re = ResourceDef::new("/user/profile");
assert!(re.is_match("/user/profile"));
assert!(!re.is_match("/user/profile/profile"));
}
#[test]
fn test_parse_param() {
2018-07-15 11:12:21 +02:00
let re = ResourceDef::new("/user/{id}");
assert!(re.is_match("/user/profile"));
assert!(re.is_match("/user/2345"));
assert!(!re.is_match("/user/2345/"));
assert!(!re.is_match("/user/2345/sdg"));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/user/profile").finish();
2018-07-15 11:50:56 +02:00
let info = re.match_with_params(&req, 0).unwrap();
2018-06-25 06:58:04 +02:00
assert_eq!(info.get("id").unwrap(), "profile");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/user/1245125").finish();
2018-07-15 11:50:56 +02:00
let info = re.match_with_params(&req, 0).unwrap();
2018-06-25 06:58:04 +02:00
assert_eq!(info.get("id").unwrap(), "1245125");
2018-07-15 11:12:21 +02:00
let re = ResourceDef::new("/v{version}/resource/{id}");
assert!(re.is_match("/v1/resource/320120"));
assert!(!re.is_match("/v/resource/1"));
assert!(!re.is_match("/resource"));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/v151/resource/adahg32").finish();
2018-07-15 11:50:56 +02:00
let info = re.match_with_params(&req, 0).unwrap();
2018-06-25 06:58:04 +02:00
assert_eq!(info.get("version").unwrap(), "151");
assert_eq!(info.get("id").unwrap(), "adahg32");
}
#[test]
fn test_resource_prefix() {
2018-07-15 11:12:21 +02:00
let re = ResourceDef::prefix("/name");
assert!(re.is_match("/name"));
assert!(re.is_match("/name/"));
assert!(re.is_match("/name/test/test"));
assert!(re.is_match("/name1"));
assert!(re.is_match("/name~"));
2018-07-15 11:12:21 +02:00
let re = ResourceDef::prefix("/name/");
assert!(re.is_match("/name/"));
assert!(re.is_match("/name/gs"));
assert!(!re.is_match("/name"));
}
#[test]
fn test_reousrce_prefix_dynamic() {
2018-07-15 11:12:21 +02:00
let re = ResourceDef::prefix("/{name}/");
assert!(re.is_match("/name/"));
assert!(re.is_match("/name/gs"));
assert!(!re.is_match("/name"));
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test2/").finish();
2018-07-15 11:50:56 +02:00
let info = re.match_with_params(&req, 0).unwrap();
2018-06-25 06:58:04 +02:00
assert_eq!(&info["name"], "test2");
assert_eq!(&info[0], "test2");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test2/subpath1/subpath2/index.html").finish();
2018-07-15 11:50:56 +02:00
let info = re.match_with_params(&req, 0).unwrap();
2018-06-25 06:58:04 +02:00
assert_eq!(&info["name"], "test2");
assert_eq!(&info[0], "test2");
}
#[test]
fn test_request_resource() {
let mut router = Router::<()>::default();
2018-07-15 11:12:21 +02:00
let mut resource = Resource::new(ResourceDef::new("/index.json"));
resource.name("r1");
router.register_resource(resource);
let mut resource = Resource::new(ResourceDef::new("/test.json"));
resource.name("r2");
router.register_resource(resource);
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/index.json").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(0));
2018-07-15 11:12:21 +02:00
assert_eq!(info.name(), "r1");
2018-06-25 06:58:04 +02:00
let req = TestRequest::with_uri("/test.json").finish();
2018-07-15 11:12:21 +02:00
let info = router.recognize(&req, &(), 0);
2018-07-15 11:24:27 +02:00
assert_eq!(info.resource, ResourceId::Normal(1));
2018-07-15 11:12:21 +02:00
assert_eq!(info.name(), "r2");
}
2018-07-16 07:33:29 +02:00
#[test]
fn test_has_resource() {
let mut router = Router::<()>::default();
2018-07-16 07:33:29 +02:00
let scope = Scope::new("/test").resource("/name", |_| "done");
router.register_scope(scope);
{
let info = router.default_route_info();
assert!(!info.has_resource("/test"));
assert!(info.has_resource("/test/name"));
}
let scope =
Scope::new("/test2").nested("/test10", |s| s.resource("/name", |_| "done"));
router.register_scope(scope);
let info = router.default_route_info();
assert!(info.has_resource("/test2/test10/name"));
}
#[test]
fn test_url_for() {
let mut router = Router::<()>::new(ResourceDef::prefix(""));
let mut resource = Resource::new(ResourceDef::new("/tttt"));
resource.name("r0");
router.register_resource(resource);
let scope = Scope::new("/test").resource("/name", |r| {
r.name("r1");
});
router.register_scope(scope);
let scope = Scope::new("/test2")
.nested("/test10", |s| s.resource("/name", |r| r.name("r2")));
router.register_scope(scope);
router.finish();
let req = TestRequest::with_uri("/test").request();
{
let info = router.default_route_info();
let res = info
.url_for(&req, "r0", Vec::<&'static str>::new())
.unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/tttt");
let res = info
.url_for(&req, "r1", Vec::<&'static str>::new())
.unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/test/name");
let res = info
.url_for(&req, "r2", Vec::<&'static str>::new())
.unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/test2/test10/name");
}
let req = TestRequest::with_uri("/test/name").request();
let info = router.recognize(&req, &(), 0);
assert_eq!(info.resource, ResourceId::Normal(1));
let res = info
.url_for(&req, "r0", Vec::<&'static str>::new())
.unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/tttt");
let res = info
.url_for(&req, "r1", Vec::<&'static str>::new())
.unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/test/name");
let res = info
.url_for(&req, "r2", Vec::<&'static str>::new())
.unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/test2/test10/name");
}
#[test]
fn test_url_for_dynamic() {
let mut router = Router::<()>::new(ResourceDef::prefix(""));
let mut resource = Resource::new(ResourceDef::new("/{name}/test/index.{ext}"));
resource.name("r0");
router.register_resource(resource);
let scope = Scope::new("/{name1}").nested("/{name2}", |s| {
s.resource("/{name3}/test/index.{ext}", |r| r.name("r2"))
});
router.register_scope(scope);
router.finish();
let req = TestRequest::with_uri("/test").request();
{
let info = router.default_route_info();
let res = info.url_for(&req, "r0", vec!["sec1", "html"]).unwrap();
assert_eq!(res.as_str(), "http://localhost:8080/sec1/test/index.html");
let res = info
.url_for(&req, "r2", vec!["sec1", "sec2", "sec3", "html"])
.unwrap();
assert_eq!(
res.as_str(),
"http://localhost:8080/sec1/sec2/sec3/test/index.html"
);
}
}
}