use std::mem; use std::rc::Rc; use std::hash::{Hash, Hasher}; use std::collections::HashMap; use regex::{Regex, RegexSet, escape}; use error::UrlGenerationError; use resource::Resource; use httprequest::HttpRequest; use server::ServerSettings; /// Interface for application router. pub struct Router(Rc); struct Inner { prefix: String, prefix_len: usize, regset: RegexSet, named: HashMap, patterns: Vec, srv: ServerSettings, hasroutes: bool, } impl Router { /// Create new router pub fn new(prefix: &str, settings: ServerSettings, map: HashMap>>) -> (Router, Vec>) { let prefix = prefix.trim().trim_right_matches('/').to_owned(); let mut named = HashMap::new(); let mut patterns = Vec::new(); let mut resources = Vec::new(); let mut paths = Vec::new(); for (pattern, resource) in map { if !pattern.name().is_empty() { let name = pattern.name().into(); named.insert(name, (pattern.clone(), resource.is_none())); } if let Some(resource) = resource { paths.push(pattern.pattern().to_owned()); patterns.push(pattern); resources.push(resource); } } let len = prefix.len(); (Router(Rc::new( Inner{ prefix: prefix, prefix_len: len, regset: RegexSet::new(&paths).unwrap(), named: named, patterns: patterns, hasroutes: !paths.is_empty(), srv: settings })), resources) } /// Router prefix #[inline] pub fn prefix(&self) -> &str { &self.0.prefix } /// Server settings #[inline] pub fn server_settings(&self) -> &ServerSettings { &self.0.srv } /// Query for matched resource pub fn recognize(&self, req: &mut HttpRequest) -> Option { if !self.0.hasroutes { return None } let mut idx = None; { if self.0.prefix_len > req.path().len() { return None } let path = &req.path()[self.0.prefix_len..]; if path.is_empty() { if let Some(i) = self.0.regset.matches("/").into_iter().next() { idx = Some(i); } } else if let Some(i) = self.0.regset.matches(path).into_iter().next() { idx = Some(i); } } if let Some(idx) = idx { self.0.patterns[idx].update_match_info(req, self.0.prefix_len); return Some(idx) } else { None } } /// Check if application contains matching route. /// /// This method does not take `prefix` into account. /// For example if prefix is `/test` and router contains route `/name`, /// following path would be recognizable `/test/name` but `has_route()` call /// would return `false`. pub fn has_route(&self, path: &str) -> bool { if path.is_empty() { if self.0.regset.matches("/").into_iter().next().is_some() { return true } } else if self.0.regset.matches(path).into_iter().next().is_some() { return true } false } /// Build named resource path. /// /// Check [`HttpRequest::url_for()`](../struct.HttpRequest.html#method.url_for) /// for detailed information. pub fn resource_path(&self, name: &str, elements: U) -> Result where U: IntoIterator, I: AsRef, { if let Some(pattern) = self.0.named.get(name) { if pattern.1 { pattern.0.path(None, elements) } else { pattern.0.path(Some(&self.0.prefix), elements) } } else { Err(UrlGenerationError::ResourceNotFound) } } } impl Clone for Router { fn clone(&self) -> Router { Router(Rc::clone(&self.0)) } } #[derive(Debug, Clone, PartialEq)] enum PatternElement { Str(String), Var(String), } #[derive(Clone)] pub struct Pattern { re: Regex, name: String, pattern: String, names: Vec, elements: Vec, } impl Pattern { /// Parse path pattern and create new `Pattern` instance. /// /// Panics if path pattern is wrong. pub fn new(name: &str, path: &str, starts: &str) -> Self { let (pattern, elements) = Pattern::parse(path, starts); let re = match Regex::new(&pattern) { Ok(re) => re, Err(err) => panic!("Wrong path pattern: \"{}\" {}", path, err) }; let names = re.capture_names() .filter_map(|name| name.map(|name| name.to_owned())) .collect(); Pattern { re: re, name: name.into(), pattern: pattern, names: names, elements: elements, } } /// Returns name of the pattern pub fn name(&self) -> &str { &self.name } /// Returns path of the pattern pub fn pattern(&self) -> &str { &self.pattern } /// Extract pattern parameters from the text // This method unsafe internally, assumption that Pattern instance lives // longer than `req` pub fn update_match_info(&self, req: &mut HttpRequest, prefix: usize) { if !self.names.is_empty() { let text: &str = unsafe{ mem::transmute(&req.path()[prefix..]) }; if let Some(captures) = self.re.captures(text) { let mut idx = 0; for capture in captures.iter() { if let Some(ref m) = capture { if idx != 0 { req.match_info_mut().add( self.names[idx-1].as_str(), m.as_str()); } idx += 1; } } }; } } /// Extract pattern parameters from the text pub fn get_match_info<'a>(&self, text: &'a str) -> HashMap<&str, &'a str> { let mut info = HashMap::new(); if !self.names.is_empty() { if let Some(captures) = self.re.captures(text) { let mut idx = 0; for capture in captures.iter() { if let Some(ref m) = capture { if idx != 0 { info.insert(self.names[idx-1].as_str(), m.as_str()); } idx += 1; } } }; } info } /// Build pattern path. pub fn path(&self, prefix: Option<&str>, elements: U) -> Result where U: IntoIterator, I: AsRef, { let mut iter = elements.into_iter(); let mut path = if let Some(prefix) = prefix { format!("{}/", prefix) } else { String::new() }; for el in &self.elements { match *el { PatternElement::Str(ref s) => path.push_str(s), PatternElement::Var(_) => { if let Some(val) = iter.next() { path.push_str(val.as_ref()) } else { return Err(UrlGenerationError::NotEnoughElements) } } } } Ok(path) } fn parse(pattern: &str, starts: &str) -> (String, Vec) { const DEFAULT_PATTERN: &str = "[^/]+"; let mut re = String::from(starts); 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 elems = Vec::new(); for (index, ch) in pattern.chars().enumerate() { // All routes must have a leading slash so its optional to have one if index == 0 && ch == '/' { continue; } if in_param { // In parameter segment: `{....}` if ch == '}' { elems.push(PatternElement::Var(param_name.clone())); re.push_str(&format!(r"(?P<{}>{})", ¶m_name, ¶m_pattern)); param_name.clear(); param_pattern = String::from(DEFAULT_PATTERN); 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; elems.push(PatternElement::Str(el.clone())); el.clear(); } else { re.push_str(escape(&ch.to_string()).as_str()); el.push(ch); } } re.push('$'); (re, elems) } } impl PartialEq for Pattern { fn eq(&self, other: &Pattern) -> bool { self.pattern == other.pattern } } impl Eq for Pattern {} impl Hash for Pattern { fn hash(&self, state: &mut H) { self.pattern.hash(state); } } #[cfg(test)] mod tests { use super::*; use regex::Regex; use test::TestRequest; #[test] fn test_recognizer() { let mut routes = HashMap::new(); routes.insert(Pattern::new("", "/name", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/name/{val}", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/name/{val}/index.html", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/file/{file}.{ext}", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/v{val}/{val2}/index.html", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/v/{tail:.*}", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "{test}/index.html", "^/"), Some(Resource::default())); let (rec, _) = Router::new::<()>("", ServerSettings::default(), routes); let mut req = TestRequest::with_uri("/name").finish(); assert!(rec.recognize(&mut req).is_some()); assert!(req.match_info().is_empty()); let mut req = TestRequest::with_uri("/name/value").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("val").unwrap(), "value"); assert_eq!(&req.match_info()["val"], "value"); let mut req = TestRequest::with_uri("/name/value2/index.html").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("val").unwrap(), "value2"); let mut req = TestRequest::with_uri("/file/file.gz").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("file").unwrap(), "file"); assert_eq!(req.match_info().get("ext").unwrap(), "gz"); let mut req = TestRequest::with_uri("/vtest/ttt/index.html").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("val").unwrap(), "test"); assert_eq!(req.match_info().get("val2").unwrap(), "ttt"); let mut req = TestRequest::with_uri("/v/blah-blah/index.html").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("tail").unwrap(), "blah-blah/index.html"); let mut req = TestRequest::with_uri("/bbb/index.html").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("test").unwrap(), "bbb"); } #[test] fn test_recognizer_with_prefix() { let mut routes = HashMap::new(); routes.insert(Pattern::new("", "/name", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/name/{val}", "^/"), Some(Resource::default())); let (rec, _) = Router::new::<()>("/test", ServerSettings::default(), routes); let mut req = TestRequest::with_uri("/name").finish(); assert!(rec.recognize(&mut req).is_none()); let mut req = TestRequest::with_uri("/test/name").finish(); assert!(rec.recognize(&mut req).is_some()); let mut req = TestRequest::with_uri("/test/name/value").finish(); assert!(rec.recognize(&mut req).is_some()); assert_eq!(req.match_info().get("val").unwrap(), "value"); assert_eq!(&req.match_info()["val"], "value"); // same patterns let mut routes = HashMap::new(); routes.insert(Pattern::new("", "/name", "^/"), Some(Resource::default())); routes.insert(Pattern::new("", "/name/{val}", "^/"), Some(Resource::default())); let (rec, _) = Router::new::<()>("/test2", ServerSettings::default(), routes); let mut req = TestRequest::with_uri("/name").finish(); assert!(rec.recognize(&mut req).is_none()); let mut req = TestRequest::with_uri("/test2/name").finish(); assert!(rec.recognize(&mut req).is_some()); } fn assert_parse(pattern: &str, expected_re: &str) -> Regex { let (re_str, _) = Pattern::parse(pattern, "^/"); assert_eq!(&*re_str, expected_re); Regex::new(&re_str).unwrap() } #[test] fn test_parse_static() { let re = assert_parse("/", r"^/$"); assert!(re.is_match("/")); assert!(!re.is_match("/a")); let re = assert_parse("/name", r"^/name$"); assert!(re.is_match("/name")); assert!(!re.is_match("/name1")); assert!(!re.is_match("/name/")); assert!(!re.is_match("/name~")); let re = assert_parse("/name/", r"^/name/$"); assert!(re.is_match("/name/")); assert!(!re.is_match("/name")); assert!(!re.is_match("/name/gs")); let re = assert_parse("/user/profile", r"^/user/profile$"); assert!(re.is_match("/user/profile")); assert!(!re.is_match("/user/profile/profile")); } #[test] fn test_parse_param() { let re = assert_parse("/user/{id}", r"^/user/(?P[^/]+)$"); 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")); let captures = re.captures("/user/profile").unwrap(); assert_eq!(captures.get(1).unwrap().as_str(), "profile"); assert_eq!(captures.name("id").unwrap().as_str(), "profile"); let captures = re.captures("/user/1245125").unwrap(); assert_eq!(captures.get(1).unwrap().as_str(), "1245125"); assert_eq!(captures.name("id").unwrap().as_str(), "1245125"); let re = assert_parse( "/v{version}/resource/{id}", r"^/v(?P[^/]+)/resource/(?P[^/]+)$", ); assert!(re.is_match("/v1/resource/320120")); assert!(!re.is_match("/v/resource/1")); assert!(!re.is_match("/resource")); let captures = re.captures("/v151/resource/adahg32").unwrap(); assert_eq!(captures.get(1).unwrap().as_str(), "151"); assert_eq!(captures.name("version").unwrap().as_str(), "151"); assert_eq!(captures.name("id").unwrap().as_str(), "adahg32"); } }