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
use std::fmt::{self, Display};
use std::convert::From;
use std::borrow::Cow;
use std::str::Utf8Error;
use std::convert::TryFrom;
use ext::IntoOwned;
use parse::Indexed;
use uri::{Origin, Authority, Absolute, Error};
use uri::encoding::{percent_encode, DEFAULT_ENCODE_SET};
/// An `enum` encapsulating any of the possible URI variants.
///
/// # Usage
///
/// In Rocket, this type will rarely be used directly. Instead, you will
/// typically encounter URIs via the [`Origin`] type. This is because all
/// incoming requests contain origin-type URIs.
///
/// Nevertheless, the `Uri` type is typically enountered as a conversion target.
/// In particular, you will likely see generic bounds of the form: `T:
/// TryInto<Uri>` (for instance, in [`Redirect`](::rocket::response::Redirect)
/// methods). This means that you can provide any type `T` that implements
/// `TryInto<Uri>`, or, equivalently, any type `U` for which `Uri` implements
/// `TryFrom<U>` or `From<U>`. These include `&str` and `String`, [`Origin`],
/// [`Authority`], and [`Absolute`].
///
/// ## Parsing
///
/// The `Uri` type implements a full, zero-allocation, zero-copy [RFC 7230]
/// compliant parser. To parse an `&str` into a `Uri`, use the [`Uri::parse()`]
/// method. Alternatively, you may also use the `TryFrom<&str>` and
/// `TryFrom<String>` trait implementation. To inspect the parsed type, match on
/// the resulting `enum` and use the methods of the internal structure.
///
/// [RFC 7230]: https://tools.ietf.org/html/rfc7230
///
/// ## Percent Encoding/Decoding
///
/// This type also provides the following percent encoding/decoding helper
/// methods: [`Uri::percent_encode()`], [`Uri::percent_decode()`], and
/// [`Uri::percent_decode_lossy()`].
///
/// [`Origin`]: uri::Origin
/// [`Authority`]: uri::Authority
/// [`Absolute`]: uri::Absolute
/// [`Uri::parse()`]: uri::Uri::parse()
/// [`Uri::percent_encode()`]: uri::Uri::percent_encode()
/// [`Uri::percent_decode()`]: uri::Uri::percent_decode()
/// [`Uri::percent_decode_lossy()`]: uri::Uri::percent_decode_lossy()
#[derive(Debug, PartialEq, Clone)]
pub enum Uri<'a> {
/// An origin URI.
Origin(Origin<'a>),
/// An authority URI.
Authority(Authority<'a>),
/// An absolute URI.
Absolute(Absolute<'a>),
/// An asterisk: exactly `*`.
Asterisk,
}
impl<'a> Uri<'a> {
#[inline]
crate unsafe fn raw_absolute(
source: Cow<'a, [u8]>,
scheme: Indexed<'a, [u8]>,
path: Indexed<'a, [u8]>,
query: Option<Indexed<'a, [u8]>>,
) -> Uri<'a> {
let origin = Origin::raw(source.clone(), path, query);
Uri::Absolute(Absolute::raw(source.clone(), scheme, None, Some(origin)))
}
/// Parses the string `string` into a `Uri`. Parsing will never allocate.
/// Returns an `Error` if `string` is not a valid URI.
///
/// # Example
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// // Parse a valid origin URI (note: in practice, use `Origin::parse()`).
/// let uri = Uri::parse("/a/b/c?query").expect("valid URI");
/// let origin = uri.origin().expect("origin URI");
/// assert_eq!(origin.path(), "/a/b/c");
/// assert_eq!(origin.query(), Some("query"));
///
/// // Invalid URIs fail to parse.
/// Uri::parse("foo bar").expect_err("invalid URI");
/// ```
pub fn parse(string: &'a str) -> Result<Uri<'a>, Error> {
::parse::uri::from_str(string)
}
/// Returns the internal instance of `Origin` if `self` is a `Uri::Origin`.
/// Otherwise, returns `None`.
///
/// # Example
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// let uri = Uri::parse("/a/b/c?query").expect("valid URI");
/// assert!(uri.origin().is_some());
///
/// let uri = Uri::parse("http://google.com").expect("valid URI");
/// assert!(uri.origin().is_none());
/// ```
pub fn origin(&self) -> Option<&Origin<'a>> {
match self {
Uri::Origin(ref inner) => Some(inner),
_ => None
}
}
/// Returns the internal instance of `Authority` if `self` is a
/// `Uri::Authority`. Otherwise, returns `None`.
///
/// # Example
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// let uri = Uri::parse("user:pass@domain.com").expect("valid URI");
/// assert!(uri.authority().is_some());
///
/// let uri = Uri::parse("http://google.com").expect("valid URI");
/// assert!(uri.authority().is_none());
/// ```
pub fn authority(&self) -> Option<&Authority<'a>> {
match self {
Uri::Authority(ref inner) => Some(inner),
_ => None
}
}
/// Returns the internal instance of `Absolute` if `self` is a
/// `Uri::Absolute`. Otherwise, returns `None`.
///
/// # Example
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// let uri = Uri::parse("http://google.com").expect("valid URI");
/// assert!(uri.absolute().is_some());
///
/// let uri = Uri::parse("/path").expect("valid URI");
/// assert!(uri.absolute().is_none());
/// ```
pub fn absolute(&self) -> Option<&Absolute<'a>> {
match self {
Uri::Absolute(ref inner) => Some(inner),
_ => None
}
}
/// Returns a URL-encoded version of the string. Any reserved characters are
/// percent-encoded.
///
/// # Examples
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// let encoded = Uri::percent_encode("hello?a=<b>hi</b>");
/// assert_eq!(encoded, "hello%3Fa%3D%3Cb%3Ehi%3C%2Fb%3E");
/// ```
pub fn percent_encode(string: &str) -> Cow<str> {
percent_encode::<DEFAULT_ENCODE_SET>(string)
}
/// Returns a URL-decoded version of the string. If the percent encoded
/// values are not valid UTF-8, an `Err` is returned.
///
/// # Examples
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// let decoded = Uri::percent_decode("/Hello%2C%20world%21".as_bytes());
/// assert_eq!(decoded.unwrap(), "/Hello, world!");
/// ```
pub fn percent_decode(string: &[u8]) -> Result<Cow<str>, Utf8Error> {
let decoder = ::percent_encoding::percent_decode(string);
decoder.decode_utf8()
}
/// Returns a URL-decoded version of the path. Any invalid UTF-8
/// percent-encoded byte sequences will be replaced � U+FFFD, the
/// replacement character.
///
/// # Examples
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::uri::Uri;
///
/// let decoded = Uri::percent_decode_lossy("/Hello%2C%20world%21".as_bytes());
/// assert_eq!(decoded, "/Hello, world!");
/// ```
pub fn percent_decode_lossy(string: &[u8]) -> Cow<str> {
let decoder = ::percent_encoding::percent_decode(string);
decoder.decode_utf8_lossy()
}
}
crate unsafe fn as_utf8_unchecked(input: Cow<[u8]>) -> Cow<str> {
match input {
Cow::Borrowed(bytes) => Cow::Borrowed(::std::str::from_utf8_unchecked(bytes)),
Cow::Owned(bytes) => Cow::Owned(String::from_utf8_unchecked(bytes))
}
}
impl<'a> TryFrom<&'a str> for Uri<'a> {
type Error = Error<'a>;
#[inline]
fn try_from(string: &'a str) -> Result<Uri<'a>, Self::Error> {
Uri::parse(string)
}
}
impl TryFrom<String> for Uri<'static> {
type Error = Error<'static>;
#[inline]
fn try_from(string: String) -> Result<Uri<'static>, Self::Error> {
// TODO: Potentially optimize this like `Origin::parse_owned`.
Uri::parse(&string)
.map(|u| u.into_owned())
.map_err(|e| e.into_owned())
}
}
impl<'a> IntoOwned for Uri<'a> {
type Owned = Uri<'static>;
fn into_owned(self) -> Uri<'static> {
match self {
Uri::Origin(origin) => Uri::Origin(origin.into_owned()),
Uri::Authority(authority) => Uri::Authority(authority.into_owned()),
Uri::Absolute(absolute) => Uri::Absolute(absolute.into_owned()),
Uri::Asterisk => Uri::Asterisk
}
}
}
impl<'a> Display for Uri<'a> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
Uri::Origin(ref origin) => write!(f, "{}", origin),
Uri::Authority(ref authority) => write!(f, "{}", authority),
Uri::Absolute(ref absolute) => write!(f, "{}", absolute),
Uri::Asterisk => write!(f, "*")
}
}
}
macro_rules! impl_uri_from {
($type:ident) => (
impl<'a> From<$type<'a>> for Uri<'a> {
fn from(other: $type<'a>) -> Uri<'a> {
Uri::$type(other)
}
}
)
}
impl_uri_from!(Origin);
impl_uri_from!(Authority);
impl_uri_from!(Absolute);