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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
//! HTTP headers.
use std::{
fmt::{self, Display},
ops::{Deref, DerefMut},
};
use crate::error::{ParseError, Result};
/// Http header.
/// Has a name and a value.
#[derive(Debug, Hash, Clone, PartialEq, Eq)]
pub struct Header {
/// Name of the Header
pub name: HeaderType,
/// Value of the Header
pub value: String,
}
/// Parameters for a header.
/// For example, the `charset` parameter in `Content-Type: text/html; charset=utf-8`.
/// ## Example
/// ```rust
/// # use afire::{Method, Server, Response, HeaderType};
/// # fn test(server: &mut Server) {
/// server.route(Method::GET, "/", |req| {
/// let header = req.headers.get_header(HeaderType::ContentType).unwrap();
/// let params = header.params();
/// let charset = params.get("charset").unwrap();
/// Response::new().text(format!("Charset: {}", charset))
/// });
/// # }
/// ```
pub struct HeaderParams<'a> {
/// The value of the header.
pub value: &'a str,
/// The parameters of the header.
params: Vec<[&'a str; 2]>,
}
/// Collection of headers.
/// Used within [`Request`](crate::Request) and [`Response`](crate::Response).
#[derive(Debug, Hash, Clone, PartialEq, Eq, Default)]
pub struct Headers(pub(crate) Vec<Header>);
impl Header {
/// Make a new header from a name and a value.
/// The name must implement `Into<HeaderType>`, so it can be a string or a [`HeaderType`].
/// The value can be anything that implements `AsRef<str>`, including a String, or &str.
/// ## Example
/// ```rust
/// # use afire::Header;
/// let header1 = Header::new("Content-Type", "text/html");
/// let header2 = Header::new("Access-Control-Allow-Origin", "*");
/// ```
pub fn new(name: impl Into<HeaderType>, value: impl AsRef<str>) -> Header {
Header {
name: name.into(),
value: value.as_ref().to_owned(),
}
}
/// Convert a string to a header.
/// String must be in the format `name: value`, or an error will be returned.
/// ## Example
/// ```rust
/// # use afire::{Header, HeaderType};
/// let header1 = Header::new(HeaderType::ContentType, "text/html");
/// let header2 = Header::from_string("Content-Type: text/html").unwrap();
///
/// assert_eq!(header1, header2);
/// ```
pub fn from_string(header: impl AsRef<str>) -> Result<Header> {
let header = header.as_ref();
let mut split_header = header.splitn(2, ':');
if split_header.clone().count() != 2 {
return Err(ParseError::InvalidHeader.into());
}
let name = split_header
.next()
.ok_or(ParseError::InvalidHeader)?
.trim()
.into();
let value = split_header
.next()
.ok_or(ParseError::InvalidHeader)?
.trim()
.into();
Ok(Header { name, value })
}
/// Get the parameters of the header.
pub fn params(&self) -> HeaderParams {
HeaderParams::new(self.value.as_str())
}
}
impl<'a> HeaderParams<'a> {
fn new(value: &'a str) -> Self {
let mut params = Vec::new();
let mut parts = value.split(';');
let value = parts.next().unwrap_or_default();
for i in parts {
let split = i.splitn(2, '=').collect::<Vec<_>>();
if split.len() != 2 {
break;
}
let key = match split.first() {
Some(key) => key.trim(),
None => break,
};
let value = match split.get(1) {
Some(value) => value.trim(),
None => break,
};
params.push([key, value]);
}
Self { value, params }
}
/// Checks if the header has the specified parameter.
pub fn has(&self, name: impl AsRef<str>) -> bool {
let name = name.as_ref();
self.params.iter().any(|[key, _]| key == &name)
}
/// Gets the value of the specified parameter, returning `None` if it is not present.
/// A parameter is a key-value pair that is separated by a semicolon and a space.
pub fn get(&self, name: impl AsRef<str>) -> Option<&str> {
let name = name.as_ref();
self.params
.iter()
.find(|[key, _]| key == &name)
.map(|[_, value]| *value)
}
}
impl Deref for Headers {
type Target = Vec<Header>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for Headers {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl<'a> Deref for HeaderParams<'a> {
type Target = Vec<[&'a str; 2]>;
fn deref(&self) -> &Self::Target {
self.params.as_ref()
}
}
impl<'a> DerefMut for HeaderParams<'a> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.params.as_mut()
}
}
impl Headers {
/// Checks if the request / response contains the specified header.
/// ## Example
/// ```rust
/// # use afire::header::{Headers, HeaderType, Header};
/// # fn test(headers: Headers) {
/// if headers.has(HeaderType::UserAgent) {
/// println!("User-Agent header is present");
/// }
/// # }
/// ```
pub fn has(&self, name: impl Into<HeaderType>) -> bool {
let name = name.into();
self.iter().any(|x| x.name == name)
}
/// Adds a header to the collection, using the specified name and value.
/// See [`Headers::add_header`] for a version that takes a [`Header`] directly.
/// ## Example
/// ```rust
/// # use afire::header::{Headers, HeaderType, Header};
/// # fn test(headers: &mut Headers) {
/// headers.add(HeaderType::ContentType, "text/html");
/// # }
pub fn add(&mut self, name: impl Into<HeaderType>, value: impl AsRef<str>) {
self.0.push(Header::new(name, value));
}
/// Gets the value of the specified header.
/// If the header is not present, `None` is returned.
/// ## Example
/// ```rust
/// # use afire::header::{Headers, HeaderType, Header};
/// # fn test(headers: Headers) {
/// if let Some(user_agent) = headers.get(HeaderType::UserAgent) {
/// println!("User-Agent: {}", user_agent);
/// }
/// # }
/// ```
pub fn get(&self, name: impl Into<HeaderType>) -> Option<&str> {
let name = name.into();
self.iter()
.find(|x| x.name == name)
.map(|x| x.value.as_str())
}
/// Gets the value of the specified header as a mutable reference.
/// If the header is not present, `None` is returned.
/// See [`Headers::get`] for a non-mutable version.
pub fn get_mut(&mut self, name: impl Into<HeaderType>) -> Option<&mut String> {
let name = name.into();
self.iter_mut()
.find(|x| x.name == name)
.map(|x| &mut x.value)
}
/// Adds a header to the collection.
/// See [`Headers::add`] for a version that takes a name and value.
/// ## Example
/// ```rust
/// # use afire::header::{Headers, HeaderType, Header};
/// # fn test(headers: &mut Headers) {
/// headers.add(HeaderType::ContentType, "text/html");
/// # }
pub fn add_header(&mut self, header: Header) {
self.0.push(header);
}
/// Gets the specified header.
/// If the header is not present, `None` is returned.
pub fn get_header(&self, name: impl Into<HeaderType>) -> Option<&Header> {
let name = name.into();
self.iter().find(|x| x.name == name)
}
/// Gets the specified header as a mutable reference.
/// If the header is not present, `None` is returned.
/// See [`Headers::get_header`] for a non-mutable version.
pub fn get_header_mut(&mut self, name: impl Into<HeaderType>) -> Option<&mut Header> {
let name = name.into();
self.iter_mut().find(|x| x.name == name)
}
}
impl fmt::Display for Header {
/// Convert a header to a string
/// In format: `name: value`.
/// ## Example
/// ```rust
/// # use afire::{Header, HeaderType};
/// let header1 = Header::new(HeaderType::ContentType, "text/html");
/// assert_eq!(header1.to_string(), "Content-Type: text/html");
/// ```
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}: {}", self.name, self.value)
}
}
/// Stringify a Vec of headers.
/// Each header is in the format `name: value` amd separated by a carriage return and newline (`\r\n`).
pub(crate) fn headers_to_string(headers: &[Header]) -> String {
let out = headers
.iter()
.map(Header::to_string)
.fold(String::new(), |acc, i| acc + &i + "\r\n");
out[..out.len() - 2].to_owned()
}
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
/// Common HTTP headers.
/// Just the 'common' ones, which are ones that I use semi-frequently, or that are used internally.
#[derive(Debug, Hash, Clone, PartialEq, Eq)]
pub enum HeaderType {
/// Indicates what content types (MIME types) are acceptable for the client.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept))
Accept,
/// Indicates what character sets are acceptable for the client.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset))
AcceptCharset,
/// Indicates what content encodings (usually compression algorithms) are acceptable for the client.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding))
AcceptEncoding,
/// Indicates what languages are acceptable for the client.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language))
AcceptLanguage,
/// Allows re-using a socket for multiple requests with `keep-alive`, or closing the sockets with `close`.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Connection))
Connection,
/// Lists the encodings that have been applied to the entity body.
/// See [`HeaderType::AcceptEncoding`]
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding))
ContentEncoding,
/// An integer indicating the size of the entity body in bytes.
/// This is only required when the body is not chunked.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length))
ContentLength,
/// Indicates the media type of the entity body.
/// This can be set on a response with the [`crate::Response::content`] method.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type))
ContentType,
/// Contains cookies from the client.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie))
Cookie,
/// The date and time at which the message was originated.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date))
Date,
/// Sent with requests to indicate the host and port of the server to which the request is being sent.
/// This allows for reverse proxies to forward requests to the correct server.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Host))
Host,
/// Used with redirection status codes (301, 302, 303, 307, 308) to indicate the URL to redirect to.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location))
Location,
/// Contains the address of the webpage that linked to the resource being requested.
/// Note the misspelling of referrer as 'referer' in the HTTP spec.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer))
Referer,
/// An identifier for a specific name / version of the web server software.
/// This is set to `afire/VERSION` by default.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server))
Server,
/// Used to send cookies from the server to the client.
/// Its recommended to use the [`crate::SetCookie`] builder instead of this directly.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie))
SetCookie,
/// Specifies the transfer encoding of the message body.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Transfer-Encoding))
TransferEncoding,
/// Used to switch from HTTP to a different protocol on the same socket, often used for websockets.
/// Note that afire *currently* does not have built-in support for websockets.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Upgrade))
Upgrade,
/// Contains information about the client application, operating system, vendor, etc. that is making the request.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent))
UserAgent,
/// A header added by proxies to track message forewords, avoid request loops, and identifying protocol capabilities.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Via))
Via,
/// A header often added by reverse proxies to allow web servers to know from which IP a request is originating.
/// This is not an official HTTP header, but is still widely used.
/// ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For))
XForwardedFor,
/// Any other header that is not in this enum.
Custom(String),
}
impl From<&HeaderType> for HeaderType {
fn from(s: &HeaderType) -> Self {
s.to_owned()
}
}
impl<T: AsRef<str>> From<T> for HeaderType {
fn from(s: T) -> Self {
HeaderType::from_str(s.as_ref())
}
}
impl HeaderType {
#[rustfmt::skip]
fn from_str(s: &str) -> Self {
match s.to_ascii_lowercase().as_str() {
"accept" => HeaderType::Accept,
"accept-charset" => HeaderType::AcceptCharset,
"accept-encoding" => HeaderType::AcceptEncoding,
"accept-language" => HeaderType::AcceptLanguage,
"connection" => HeaderType::Connection,
"content-encoding" => HeaderType::ContentEncoding,
"content-length" => HeaderType::ContentLength,
"content-type" => HeaderType::ContentType,
"cookie" => HeaderType::Cookie,
"date" => HeaderType::Date,
"host" => HeaderType::Host,
"location" => HeaderType::Location,
"referer" => HeaderType::Referer,
"server" => HeaderType::Server,
"set-cookie" => HeaderType::SetCookie,
"transfer-encoding" => HeaderType::TransferEncoding,
"upgrade" => HeaderType::Upgrade,
"user-agent" => HeaderType::UserAgent,
"via" => HeaderType::Via,
"x-forwarded-for" => HeaderType::XForwardedFor,
_ => HeaderType::Custom(s.to_string()),
}
}
}
impl Display for HeaderType {
#[rustfmt::skip]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"{}",
match self {
HeaderType::Accept => "Accept",
HeaderType::AcceptCharset => "Accept-Charset",
HeaderType::AcceptEncoding => "Accept-Encoding",
HeaderType::AcceptLanguage => "Accept-Language",
HeaderType::Connection => "Connection",
HeaderType::ContentEncoding => "Content-Encoding",
HeaderType::ContentLength => "Content-Length",
HeaderType::ContentType => "Content-Type",
HeaderType::Cookie => "Cookie",
HeaderType::Date => "Date",
HeaderType::Host => "Host",
HeaderType::Location => "Location",
HeaderType::Referer => "Referer",
HeaderType::Server => "Server",
HeaderType::SetCookie => "Set-Cookie",
HeaderType::TransferEncoding => "Transfer-Encoding",
HeaderType::Upgrade => "Upgrade",
HeaderType::UserAgent => "User-Agent",
HeaderType::Via => "Via",
HeaderType::XForwardedFor => "X-Forwarded-For",
HeaderType::Custom(s) => s,
}
)
}
}