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 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
use crate::{
after_send::{AfterSend, SendStatus},
copy,
http_config::DEFAULT_CONFIG,
liveness::{CancelOnDisconnect, LivenessFut},
received_body::ReceivedBodyState,
util::encoding,
Body, BufWriter, Buffer, ConnectionStatus, Error, HeaderName, HeaderValue, Headers, HttpConfig,
KnownHeaderName::{Connection, ContentLength, Date, Expect, Host, Server, TransferEncoding},
Method, ReceivedBody, Result, StateSet, Status, Stopper, Upgrade, Version,
};
use encoding_rs::Encoding;
use futures_lite::{
future,
io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt},
};
use httparse::{Request, EMPTY_HEADER};
use memchr::memmem::Finder;
use std::{
fmt::{self, Debug, Formatter},
future::Future,
net::IpAddr,
pin::pin,
str::FromStr,
time::{Instant, SystemTime},
};
/// Default Server header
pub const SERVER: &str = concat!("trillium/", env!("CARGO_PKG_VERSION"));
/** A http connection
Unlike in other rust http implementations, this struct represents both
the request and the response, and holds the transport over which the
response will be sent.
*/
pub struct Conn<Transport> {
pub(crate) request_headers: Headers,
pub(crate) response_headers: Headers,
pub(crate) path: String,
pub(crate) method: Method,
pub(crate) status: Option<Status>,
pub(crate) version: Version,
pub(crate) state: StateSet,
pub(crate) response_body: Option<Body>,
pub(crate) transport: Transport,
pub(crate) buffer: Buffer,
pub(crate) request_body_state: ReceivedBodyState,
pub(crate) secure: bool,
pub(crate) stopper: Stopper,
pub(crate) after_send: AfterSend,
pub(crate) start_time: Instant,
pub(crate) peer_ip: Option<IpAddr>,
pub(crate) http_config: HttpConfig,
}
impl<Transport> Debug for Conn<Transport> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct("Conn")
.field("http_config", &self.http_config)
.field("request_headers", &self.request_headers)
.field("response_headers", &self.response_headers)
.field("path", &self.path)
.field("method", &self.method)
.field("status", &self.status)
.field("version", &self.version)
.field("state", &self.state)
.field("response_body", &self.response_body)
.field("transport", &"..")
.field("buffer", &"..")
.field("request_body_state", &self.request_body_state)
.field("secure", &self.secure)
.field("stopper", &self.stopper)
.field("after_send", &"..")
.field("start_time", &self.start_time)
.field("peer_ip", &self.peer_ip)
.finish()
}
}
impl<Transport> Conn<Transport>
where
Transport: AsyncRead + AsyncWrite + Unpin + Send + Sync + 'static,
{
/// read any number of new `Conn`s from the transport and call the
/// provided handler function until either the connection is closed or
/// an upgrade is requested. A return value of Ok(None) indicates a
/// closed connection, while a return value of Ok(Some(upgrade))
/// represents an upgrade.
///
/// Provides a default [`HttpConfig`]
///
/// See the documentation for [`Conn`] for a full example.
///
/// # Errors
///
/// This will return an error variant if:
///
/// * there is an io error when reading from the underlying transport
/// * headers are too long
/// * we are unable to parse some aspect of the request
/// * the request is an unsupported http version
/// * we cannot make sense of the headers, such as if there is a
/// `content-length` header as well as a `transfer-encoding: chunked`
/// header.
pub async fn map<F, Fut>(
transport: Transport,
stopper: Stopper,
handler: F,
) -> Result<Option<Upgrade<Transport>>>
where
F: FnMut(Conn<Transport>) -> Fut,
Fut: Future<Output = Conn<Transport>> + Send,
{
Self::map_with_config(DEFAULT_CONFIG, transport, stopper, handler).await
}
/// read any number of new `Conn`s from the transport and call the
/// provided handler function until either the connection is closed or
/// an upgrade is requested. A return value of Ok(None) indicates a
/// closed connection, while a return value of Ok(Some(upgrade))
/// represents an upgrade.
///
/// See the documentation for [`Conn`] for a full example.
///
/// # Errors
///
/// This will return an error variant if:
///
/// * there is an io error when reading from the underlying transport
/// * headers are too long
/// * we are unable to parse some aspect of the request
/// * the request is an unsupported http version
/// * we cannot make sense of the headers, such as if there is a
/// `content-length` header as well as a `transfer-encoding: chunked`
/// header.
pub async fn map_with_config<F, Fut>(
http_config: HttpConfig,
transport: Transport,
stopper: Stopper,
mut handler: F,
) -> Result<Option<Upgrade<Transport>>>
where
F: FnMut(Conn<Transport>) -> Fut,
Fut: Future<Output = Conn<Transport>> + Send,
{
let mut conn = Conn::new_with_config(
http_config,
transport,
Vec::with_capacity(http_config.request_buffer_initial_len).into(),
stopper,
)
.await?;
loop {
conn = match handler(conn).await.send().await? {
ConnectionStatus::Upgrade(upgrade) => return Ok(Some(upgrade)),
ConnectionStatus::Close => return Ok(None),
ConnectionStatus::Conn(next) => next,
}
}
}
async fn send(mut self) -> Result<ConnectionStatus<Transport>> {
let mut output_buffer = Vec::with_capacity(self.http_config.response_buffer_len);
self.write_headers(&mut output_buffer)?;
let mut bufwriter = BufWriter::new_with_buffer(output_buffer, &mut self.transport);
if self.method != Method::Head
&& !matches!(self.status, Some(Status::NotModified | Status::NoContent))
{
if let Some(body) = self.response_body.take() {
copy(body, &mut bufwriter, self.http_config.copy_loops_per_yield).await?;
}
}
bufwriter.flush().await?;
self.after_send.call(true.into());
self.finish().await
}
/// returns a read-only reference to the [state
/// typemap](StateSet) for this conn
///
/// stability note: this is not unlikely to be removed at some
/// point, as this may end up being more of a trillium concern
/// than a `trillium_http` concern
pub fn state(&self) -> &StateSet {
&self.state
}
/// returns a mutable reference to the [state
/// typemap](StateSet) for this conn
///
/// stability note: this is not unlikely to be removed at some
/// point, as this may end up being more of a trillium concern
/// than a `trillium_http` concern
pub fn state_mut(&mut self) -> &mut StateSet {
&mut self.state
}
/// returns a reference to the request headers
pub fn request_headers(&self) -> &Headers {
&self.request_headers
}
/// returns a mutable reference to the response [headers](Headers)
pub fn request_headers_mut(&mut self) -> &mut Headers {
&mut self.request_headers
}
/// returns a mutable reference to the response [headers](Headers)
pub fn response_headers_mut(&mut self) -> &mut Headers {
&mut self.response_headers
}
/// returns a reference to the response [headers](Headers)
pub fn response_headers(&self) -> &Headers {
&self.response_headers
}
/** sets the http status code from any `TryInto<Status>`.
```
# use trillium_http::{Conn, Method, Status};
# let mut conn = Conn::new_synthetic(Method::Get, "/", ());
assert!(conn.status().is_none());
conn.set_status(200); // a status can be set as a u16
assert_eq!(conn.status().unwrap(), Status::Ok);
conn.set_status(Status::ImATeapot); // or as a Status
assert_eq!(conn.status().unwrap(), Status::ImATeapot);
```
*/
pub fn set_status(&mut self, status: impl TryInto<Status>) {
self.status = Some(status.try_into().unwrap_or_else(|_| {
log::error!("attempted to set an invalid status code");
Status::InternalServerError
}));
}
/// retrieves the current response status code for this conn, if
/// it has been set. See [`Conn::set_status`] for example usage.
pub fn status(&self) -> Option<Status> {
self.status
}
/**
retrieves the path part of the request url, up to and excluding any query component
```
# use trillium_http::{Conn, Method};
let mut conn = Conn::new_synthetic(Method::Get, "/some/path?and&a=query", ());
assert_eq!(conn.path(), "/some/path");
```
*/
pub fn path(&self) -> &str {
match self.path.split_once('?') {
Some((path, _)) => path,
None => &self.path,
}
}
/// retrieves the combined path and any query
pub fn path_and_query(&self) -> &str {
&self.path
}
/**
retrieves the query component of the path
```
# use trillium_http::{Conn, Method};
let mut conn = Conn::new_synthetic(Method::Get, "/some/path?and&a=query", ());
assert_eq!(conn.querystring(), "and&a=query");
let mut conn = Conn::new_synthetic(Method::Get, "/some/path", ());
assert_eq!(conn.querystring(), "");
```
*/
pub fn querystring(&self) -> &str {
match self.path.split_once('?') {
Some((_, query)) => query,
None => "",
}
}
/// get the host for this conn, if it exists
pub fn host(&self) -> Option<&str> {
self.request_headers.get_str(Host)
}
/// set the host for this conn
pub fn set_host(&mut self, host: String) {
self.request_headers.insert(Host, host);
}
// pub fn url(&self) -> Result<Url> {
// let path = self.path();
// let host = self.host().unwrap_or_else(|| String::from("_"));
// let method = self.method();
// if path.starts_with("http://") || path.starts_with("https://") {
// Ok(Url::parse(path)?)
// } else if path.starts_with('/') {
// Ok(Url::parse(&format!("http://{}{}", host, path))?)
// } else if method == &Method::Connect {
// Ok(Url::parse(&format!("http://{}/", path))?)
// } else {
// Err(Error::UnexpectedUriFormat)
// }
// }
/**
Sets the response body to anything that is [`impl Into<Body>`][Body].
```
# use trillium_http::{Conn, Method, Body};
# let mut conn = Conn::new_synthetic(Method::Get, "/some/path?and&a=query", ());
conn.set_response_body("hello");
conn.set_response_body(String::from("hello"));
conn.set_response_body(vec![99, 97, 116]);
```
*/
pub fn set_response_body(&mut self, body: impl Into<Body>) {
self.response_body = Some(body.into());
}
/// returns a reference to the current response body, if it has been set
pub fn response_body(&self) -> Option<&Body> {
self.response_body.as_ref()
}
/**
remove the response body from this conn and return it
```
# use trillium_http::{Conn, Method};
# let mut conn = Conn::new_synthetic(Method::Get, "/some/path?and&a=query", ());
assert!(conn.response_body().is_none());
conn.set_response_body("hello");
assert!(conn.response_body().is_some());
let body = conn.take_response_body();
assert!(body.is_some());
assert!(conn.response_body().is_none());
```
*/
pub fn take_response_body(&mut self) -> Option<Body> {
self.response_body.take()
}
/**
returns the http method for this conn's request.
```
# use trillium_http::{Conn, Method};
let mut conn = Conn::new_synthetic(Method::Get, "/some/path?and&a=query", ());
assert_eq!(conn.method(), Method::Get);
```
*/
pub fn method(&self) -> Method {
self.method
}
/**
overrides the http method for this conn
*/
pub fn set_method(&mut self, method: Method) {
self.method = method;
}
/**
returns the http version for this conn.
*/
pub fn http_version(&self) -> Version {
self.version
}
/// Cancels and drops the future if reading from the transport results in an error or empty read
///
/// The use of this method is not advised if your connected http client employs pipelining
/// (rarely seen in the wild), as it will buffer an unbounded number of requests one byte at a
/// time
///
/// If the client disconnects from the conn's transport, this function will return None. If the
/// future completes without disconnection, this future will return Some containing the output
/// of the future.
///
/// The use of this method is not advised if your connected http client employs pipelining
/// (rarely seen in the wild), as it will buffer an unbounded number of requests
///
/// Note that the inner future cannot borrow conn, so you will need to clone or take any
/// information needed to execute the future prior to executing this method.
///
/// # Example
///
/// ```rust
/// # use futures_lite::{AsyncRead, AsyncWrite};
/// # use trillium_http::{Conn, Method};
/// async fn something_slow_and_cancel_safe() -> String { String::from("this was not actually slow") }
/// async fn handler<T>(mut conn: Conn<T>) -> Conn<T>
/// where
/// T: AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static
/// {
/// let Some(returned_body) = conn.cancel_on_disconnect(async {
/// something_slow_and_cancel_safe().await
/// }).await else { return conn; };
/// conn.set_response_body(returned_body);
/// conn.set_status(200);
/// conn
/// }
/// ```
pub async fn cancel_on_disconnect<'a, Fut>(&'a mut self, fut: Fut) -> Option<Fut::Output>
where
Fut: Future + Send + 'a,
{
CancelOnDisconnect(self, pin!(fut)).await
}
/// Check if the transport is connected by attempting to read from the transport
///
/// # Example
///
/// This is best to use at appropriate points in a long-running handler, like:
///
/// ```rust
/// # use futures_lite::{AsyncRead, AsyncWrite};
/// # use trillium_http::{Conn, Method};
/// # async fn something_slow_but_not_cancel_safe() {}
/// async fn handler<T>(mut conn: Conn<T>) -> Conn<T>
/// where
/// T: AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static
/// {
/// for _ in 0..100 {
/// if conn.is_disconnected().await {
/// return conn;
/// }
/// something_slow_but_not_cancel_safe().await;
/// }
/// conn.set_status(200);
/// conn
/// }
/// ```
pub async fn is_disconnected(&mut self) -> bool {
future::poll_once(LivenessFut::new(self)).await.is_some()
}
fn needs_100_continue(&self) -> bool {
self.request_body_state == ReceivedBodyState::Start
&& self.version != Version::Http1_0
&& self
.request_headers
.eq_ignore_ascii_case(Expect, "100-continue")
}
#[allow(clippy::needless_borrow, clippy::needless_borrows_for_generic_args)]
fn build_request_body(&mut self) -> ReceivedBody<'_, Transport> {
ReceivedBody::new_with_config(
self.request_content_length().ok().flatten(),
&mut self.buffer,
&mut self.transport,
&mut self.request_body_state,
None,
encoding(&self.request_headers),
&self.http_config,
)
}
/**
returns the [`encoding_rs::Encoding`] for this request, as
determined from the mime-type charset, if available
```
# use trillium_http::{Conn, Method};
let mut conn = Conn::new_synthetic(Method::Get, "/", ());
assert_eq!(conn.request_encoding(), encoding_rs::WINDOWS_1252); // the default
conn.request_headers_mut().insert("content-type", "text/plain;charset=utf-16");
assert_eq!(conn.request_encoding(), encoding_rs::UTF_16LE);
```
*/
pub fn request_encoding(&self) -> &'static Encoding {
encoding(&self.request_headers)
}
/**
returns the [`encoding_rs::Encoding`] for this response, as
determined from the mime-type charset, if available
```
# use trillium_http::{Conn, Method};
let mut conn = Conn::new_synthetic(Method::Get, "/", ());
assert_eq!(conn.response_encoding(), encoding_rs::WINDOWS_1252); // the default
conn.response_headers_mut().insert("content-type", "text/plain;charset=utf-16");
assert_eq!(conn.response_encoding(), encoding_rs::UTF_16LE);
```
*/
pub fn response_encoding(&self) -> &'static Encoding {
encoding(&self.response_headers)
}
/**
returns a [`ReceivedBody`] that references this conn. the conn
retains all data and holds the singular transport, but the
`ReceivedBody` provides an interface to read body content
```
# async_io::block_on(async {
# use trillium_http::{Conn, Method};
let mut conn = Conn::new_synthetic(Method::Get, "/", "hello");
let request_body = conn.request_body().await;
assert_eq!(request_body.content_length(), Some(5));
assert_eq!(request_body.read_string().await.unwrap(), "hello");
# });
```
*/
pub async fn request_body(&mut self) -> ReceivedBody<'_, Transport> {
if self.needs_100_continue() {
self.send_100_continue().await.ok();
}
self.build_request_body()
}
/// returns a clone of the [`stopper::Stopper`] for this Conn. use
/// this to gracefully stop long-running futures and streams
/// inside of handler functions
pub fn stopper(&self) -> Stopper {
self.stopper.clone()
}
fn validate_headers(request_headers: &Headers) -> Result<()> {
let content_length = request_headers.has_header(ContentLength);
let transfer_encoding_chunked =
request_headers.eq_ignore_ascii_case(TransferEncoding, "chunked");
if content_length && transfer_encoding_chunked {
Err(Error::UnexpectedHeader("content-length"))
} else {
Ok(())
}
}
/// # Create a new `Conn`
///
/// This function creates a new conn from the provided
/// [`Transport`][crate::transport::Transport], as well as any
/// bytes that have already been read from the transport, and a
/// [`Stopper`] instance that will be used to signal graceful
/// shutdown.
///
/// # Errors
///
/// This will return an error variant if:
///
/// * there is an io error when reading from the underlying transport
/// * headers are too long
/// * we are unable to parse some aspect of the request
/// * the request is an unsupported http version
/// * we cannot make sense of the headers, such as if there is a
/// `content-length` header as well as a `transfer-encoding: chunked`
/// header.
pub async fn new(transport: Transport, bytes: Vec<u8>, stopper: Stopper) -> Result<Self> {
Self::new_with_config(DEFAULT_CONFIG, transport, bytes.into(), stopper).await
}
/// # Create a new `Conn`
///
/// This function creates a new conn from the provided
/// [`Transport`][crate::transport::Transport], as well as any
/// bytes that have already been read from the transport, and a
/// [`Stopper`] instance that will be used to signal graceful
/// shutdown.
///
/// # Errors
///
/// This will return an error variant if:
///
/// * there is an io error when reading from the underlying transport
/// * headers are too long
/// * we are unable to parse some aspect of the request
/// * the request is an unsupported http version
/// * we cannot make sense of the headers, such as if there is a
/// `content-length` header as well as a `transfer-encoding: chunked`
/// header.
async fn new_with_config(
http_config: HttpConfig,
mut transport: Transport,
mut buffer: Buffer,
stopper: Stopper,
) -> Result<Self> {
let (head_size, start_time) =
Self::head(&mut transport, &mut buffer, &stopper, &http_config).await?;
let mut headers = vec![EMPTY_HEADER; http_config.max_headers];
let mut httparse_req = Request::new(&mut headers);
let status = httparse_req.parse(&buffer[..])?;
if status.is_partial() {
return Err(Error::PartialHead);
}
let method = match httparse_req.method {
Some(method) => match method.parse() {
Ok(method) => method,
Err(_) => return Err(Error::UnrecognizedMethod(method.to_string())),
},
None => return Err(Error::MissingMethod),
};
let version = match httparse_req.version {
Some(0) => Version::Http1_0,
Some(1) => Version::Http1_1,
Some(version) => return Err(Error::UnsupportedVersion(version)),
None => return Err(Error::MissingVersion),
};
let mut request_headers = Headers::with_capacity(httparse_req.headers.len());
for header in httparse_req.headers {
let header_name = HeaderName::from_str(header.name)?;
let header_value = HeaderValue::from(header.value.to_owned());
request_headers.append(header_name, header_value);
}
Self::validate_headers(&request_headers)?;
let path = httparse_req
.path
.ok_or(Error::RequestPathMissing)?
.to_owned();
log::trace!("received:\n{method} {path} {version}\n{request_headers}");
let mut response_headers =
Headers::with_capacity(http_config.response_header_initial_capacity);
response_headers.insert(Server, SERVER);
buffer.ignore_front(head_size);
Ok(Self {
transport,
request_headers,
method,
version,
path,
buffer,
response_headers,
status: None,
state: StateSet::new(),
response_body: None,
request_body_state: ReceivedBodyState::Start,
secure: false,
stopper,
after_send: AfterSend::default(),
start_time,
peer_ip: None,
http_config,
})
}
/// predicate function to indicate whether the connection is
/// secure. note that this does not necessarily indicate that the
/// transport itself is secure, as it may indicate that
/// `trillium_http` is behind a trusted reverse proxy that has
/// terminated tls and provided appropriate headers to indicate
/// this.
pub fn is_secure(&self) -> bool {
self.secure
}
/// set whether the connection should be considered secure. note
/// that this does not necessarily indicate that the transport
/// itself is secure, as it may indicate that `trillium_http` is
/// behind a trusted reverse proxy that has terminated tls and
/// provided appropriate headers to indicate this.
pub fn set_secure(&mut self, secure: bool) {
self.secure = secure;
}
/**
calculates any auto-generated headers for this conn prior to sending it
*/
pub fn finalize_headers(&mut self) {
if self.status == Some(Status::SwitchingProtocols) {
return;
}
self.response_headers
.try_insert_with(Date, || httpdate::fmt_http_date(SystemTime::now()));
if !matches!(self.status, Some(Status::NotModified | Status::NoContent)) {
if let Some(len) = self.body_len() {
self.response_headers
.try_insert(ContentLength, len.to_string());
}
if self.version == Version::Http1_1 && !self.response_headers.has_header(ContentLength)
{
self.response_headers.insert(TransferEncoding, "chunked");
} else {
self.response_headers.remove(TransferEncoding);
}
}
if self.stopper.is_stopped() {
self.response_headers.insert(Connection, "close");
}
}
/**
Registers a function to call after the http response has been
completely transferred. Please note that this is a sync function
and should be computationally lightweight. If your _application_
needs additional async processing, use your runtime's task spawn
within this hook. If your _library_ needs additional async
processing in an `after_send` hook, please open an issue. This hook
is currently designed for simple instrumentation and logging, and
should be thought of as equivalent to a Drop hook.
*/
pub fn after_send<F>(&mut self, after_send: F)
where
F: FnOnce(SendStatus) + Send + Sync + 'static,
{
self.after_send.append(after_send);
}
/// The [`Instant`] that the first header bytes for this conn were
/// received, before any processing or parsing has been performed.
pub fn start_time(&self) -> Instant {
self.start_time
}
async fn send_100_continue(&mut self) -> Result<()> {
log::trace!("sending 100-continue");
Ok(self
.transport
.write_all(b"HTTP/1.1 100 Continue\r\n\r\n")
.await?)
}
async fn head(
transport: &mut Transport,
buf: &mut Buffer,
stopper: &Stopper,
http_config: &HttpConfig,
) -> Result<(usize, Instant)> {
let mut len = 0;
let mut start_with_read = buf.is_empty();
let mut instant = None;
let finder = Finder::new(b"\r\n\r\n");
loop {
if len >= http_config.head_max_len {
return Err(Error::HeadersTooLong);
}
let bytes = if start_with_read {
buf.expand();
if len == 0 {
stopper
.stop_future(transport.read(buf))
.await
.ok_or(Error::Closed)??
} else {
transport.read(&mut buf[len..]).await?
}
} else {
start_with_read = true;
buf.len()
};
if instant.is_none() {
instant = Some(Instant::now());
}
let search_start = len.max(3) - 3;
let search = finder.find(&buf[search_start..]);
if let Some(index) = search {
buf.truncate(len + bytes);
return Ok((search_start + index + 4, instant.unwrap()));
}
len += bytes;
if bytes == 0 {
return if len == 0 {
Err(Error::Closed)
} else {
Err(Error::PartialHead)
};
}
}
}
async fn next(mut self) -> Result<Self> {
if !self.needs_100_continue() || self.request_body_state != ReceivedBodyState::Start {
self.build_request_body().drain().await?;
}
Conn::new_with_config(self.http_config, self.transport, self.buffer, self.stopper).await
}
fn should_close(&self) -> bool {
let request_connection = self.request_headers.get_lower(Connection);
let response_connection = self.response_headers.get_lower(Connection);
match (
request_connection.as_deref(),
response_connection.as_deref(),
) {
(Some("keep-alive"), Some("keep-alive")) => false,
(Some("close"), _) | (_, Some("close")) => true,
_ => self.version == Version::Http1_0,
}
}
fn should_upgrade(&self) -> bool {
(self.method() == Method::Connect && self.status == Some(Status::Ok))
|| self.status == Some(Status::SwitchingProtocols)
}
async fn finish(self) -> Result<ConnectionStatus<Transport>> {
if self.should_close() {
Ok(ConnectionStatus::Close)
} else if self.should_upgrade() {
Ok(ConnectionStatus::Upgrade(self.into()))
} else {
match self.next().await {
Err(Error::Closed) => {
log::trace!("connection closed by client");
Ok(ConnectionStatus::Close)
}
Err(e) => Err(e),
Ok(conn) => Ok(ConnectionStatus::Conn(conn)),
}
}
}
fn request_content_length(&self) -> Result<Option<u64>> {
if self
.request_headers
.eq_ignore_ascii_case(TransferEncoding, "chunked")
{
Ok(None)
} else if let Some(cl) = self.request_headers.get_str(ContentLength) {
cl.parse()
.map(Some)
.map_err(|_| Error::MalformedHeader("content-length".into()))
} else {
Ok(Some(0))
}
}
fn body_len(&self) -> Option<u64> {
match self.response_body {
Some(ref body) => body.len(),
None => Some(0),
}
}
fn write_headers(&mut self, output_buffer: &mut Vec<u8>) -> Result<()> {
use std::io::Write;
let status = self.status().unwrap_or(Status::NotFound);
write!(
output_buffer,
"{} {} {}\r\n",
self.version,
status as u16,
status.canonical_reason()
)?;
self.finalize_headers();
log::trace!(
"sending:\n{} {}\n{}",
self.version,
status,
&self.response_headers
);
for (name, values) in &self.response_headers {
if name.is_valid() {
for value in values {
if value.is_valid() {
write!(output_buffer, "{name}: ")?;
output_buffer.extend_from_slice(value.as_ref());
write!(output_buffer, "\r\n")?;
} else {
log::error!("skipping invalid header value {value:?} for header {name}");
}
}
} else {
log::error!("skipping invalid header with name {name:?}");
}
}
write!(output_buffer, "\r\n")?;
Ok(())
}
/// applies a mapping function from one transport to another. This
/// is particularly useful for boxing the transport. unless you're
/// sure this is what you're looking for, you probably don't want
/// to be using this
pub fn map_transport<T: AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static>(
self,
f: impl Fn(Transport) -> T,
) -> Conn<T> {
let Conn {
request_headers,
response_headers,
path,
status,
version,
state,
transport,
buffer,
request_body_state,
secure,
method,
response_body,
stopper,
after_send,
start_time,
peer_ip,
http_config,
} = self;
Conn {
request_headers,
response_headers,
method,
response_body,
path,
status,
version,
state,
transport: f(transport),
buffer,
request_body_state,
secure,
stopper,
after_send,
start_time,
peer_ip,
http_config,
}
}
/// Get a reference to the transport.
pub fn transport(&self) -> &Transport {
&self.transport
}
/// Get a mutable reference to the transport.
///
/// This should only be used to call your own custom methods on the transport that do not read
/// or write any data. Calling any method that reads from or writes to the transport will
/// disrupt the HTTP protocol. If you're looking to transition from HTTP to another protocol,
/// use an HTTP upgrade.
pub fn transport_mut(&mut self) -> &mut Transport {
&mut self.transport
}
/// sets the remote ip address for this conn, if available.
pub fn set_peer_ip(&mut self, peer_ip: Option<IpAddr>) {
self.peer_ip = peer_ip;
}
/// retrieves the remote ip address for this conn, if available.
pub fn peer_ip(&self) -> Option<IpAddr> {
self.peer_ip
}
}