Skip to content

Commit

Permalink
refactor: optimize root path of static file module
Browse files Browse the repository at this point in the history
  • Loading branch information
@joseluisq
joseluisq committed Jul 9, 2021
1 parent 8128b17 commit 70a76ed
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 44 deletions.
4 changes: 2 additions & 2 deletions src/handler.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::{Error, Result};

/// It defines options for a request handler.
pub struct RequestHandlerOpts {
pub root_dir: PathBuf,
pub root_dir: Arc<PathBuf>,
pub compression: bool,
pub dir_listing: bool,
pub cors: Option<Arc<cors::Configured>>,
Expand All @@ -28,7 +28,7 @@ impl RequestHandler {
let method = req.method();
let headers = req.headers();

let root_dir = self.opts.root_dir.as_path();
let root_dir = self.opts.root_dir.as_ref();
let uri_path = req.uri().path();
let dir_listing = self.opts.dir_listing;

Expand Down
3 changes: 2 additions & 1 deletion src/server.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use hyper::server::conn::AddrIncoming;
use hyper::server::Server as HyperServer;
use listenfd::ListenFd;
use std::net::{IpAddr, SocketAddr, TcpListener};
use std::sync::Arc;
use structopt::StructOpt;

use crate::handler::{RequestHandler, RequestHandlerOpts};
Expand Down Expand Up @@ -77,7 +78,7 @@ impl Server {
}

// Check for a valid root directory
let root_dir = helpers::get_valid_dirpath(&opts.root)?;
let root_dir = Arc::new(helpers::get_valid_dirpath(&opts.root)?);

// Custom error pages content
error_page::PAGE_404
Expand Down
91 changes: 50 additions & 41 deletions src/static_files.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use std::io;
use std::ops::Bound;
use std::path::PathBuf;
use std::pin::Pin;
use std::sync::Arc;
use std::task::Poll;
use std::time::{SystemTime, UNIX_EPOCH};
use std::{cmp, path::Path};
Expand All @@ -27,12 +28,22 @@ use tokio_util::io::poll_read_buf;

use crate::Result;

/// Arc `PathBuf` reference wrapper since Arc<PathBuf> doesn't implement AsRef<Path>.
#[derive(Clone, Debug)]
pub struct ArcPath(pub Arc<PathBuf>);

impl AsRef<Path> for ArcPath {
fn as_ref(&self) -> &Path {
(*self.0).as_ref()
}
}

/// Entry point to handle incoming requests which map to specific files
/// on file system and return a file response.
pub async fn handle(
method: &Method,
headers: &HeaderMap<HeaderValue>,
base: &Path,
path: impl Into<PathBuf>,
uri_path: &str,
dir_listing: bool,
) -> Result<Response<Body>, StatusCode> {
Expand All @@ -41,13 +52,14 @@ pub async fn handle(
return Err(StatusCode::METHOD_NOT_ALLOWED);
}

let (filepath, meta, auto_index) = path_from_tail(base.to_owned(), uri_path).await?;
let base = Arc::new(path.into());
let (filepath, meta, auto_index) = path_from_tail(base, uri_path).await?;

// Directory listing
// 1. Check if "directory listing" feature is enabled,
// if current path is a valid directory and
// if it does not contain an `index.html` file
if dir_listing && auto_index && !filepath.exists() {
if dir_listing && auto_index && !filepath.as_ref().exists() {
// Redirect if current path does not end with a slash char
if !uri_path.ends_with('/') {
let uri = [uri_path, "/"].concat();
Expand All @@ -67,19 +79,19 @@ pub async fn handle(
return Ok(resp);
}

return directory_listing(method, uri_path, &filepath).await;
return directory_listing(method, uri_path, filepath.as_ref()).await;
}

file_reply(headers, (filepath, meta, auto_index)).await
file_reply(headers, (filepath, &meta, auto_index)).await
}

/// Convert an incoming uri into a valid and sanitized path then returns a tuple
// with the path as well as its file metadata and an auto index check if it's a directory.
fn path_from_tail(
base: PathBuf,
base: Arc<PathBuf>,
tail: &str,
) -> impl Future<Output = Result<(PathBuf, Metadata, bool), StatusCode>> + Send {
future::ready(sanitize_path(base, tail)).and_then(|mut buf| async {
) -> impl Future<Output = Result<(ArcPath, Metadata, bool), StatusCode>> + Send {
future::ready(sanitize_path(base.as_ref(), tail)).and_then(|mut buf| async {
match tokio::fs::metadata(&buf).await {
Ok(meta) => {
let mut auto_index = false;
Expand All @@ -89,7 +101,7 @@ fn path_from_tail(
auto_index = true;
}
tracing::trace!("dir: {:?}", buf);
Ok((buf, meta, auto_index))
Ok((ArcPath(Arc::new(buf)), meta, auto_index))
}
Err(err) => {
tracing::debug!("file not found: {:?}", err);
Expand Down Expand Up @@ -273,26 +285,30 @@ fn parse_last_modified(modified: SystemTime) -> Result<time::Tm, Box<dyn std::er
}

/// Reply with a file content.
fn file_reply(
headers: &HeaderMap<HeaderValue>,
res: (PathBuf, Metadata, bool),
) -> impl Future<Output = Result<Response<Body>, StatusCode>> + Send {
fn file_reply<'a>(
headers: &'a HeaderMap<HeaderValue>,
res: (ArcPath, &'a Metadata, bool),
) -> impl Future<Output = Result<Response<Body>, StatusCode>> + Send + 'a {
let (path, meta, auto_index) = res;
let conditionals = get_conditional_headers(headers);
TkFile::open(path.clone()).then(move |res| match res {
Ok(f) => Either::Left(file_conditional(f, path, meta, auto_index, conditionals)),
Err(err) => {
let status = match err.kind() {
io::ErrorKind::NotFound => {
tracing::debug!("file not found: {:?}", path.display());
tracing::debug!("file not found: {:?}", path.as_ref().display());
StatusCode::NOT_FOUND
}
io::ErrorKind::PermissionDenied => {
tracing::warn!("file permission denied: {:?}", path.display());
tracing::warn!("file permission denied: {:?}", path.as_ref().display());
StatusCode::FORBIDDEN
}
_ => {
tracing::error!("file open error (path={:?}): {} ", path.display(), err);
tracing::error!(
"file open error (path={:?}): {} ",
path.as_ref().display(),
err
);
StatusCode::INTERNAL_SERVER_ERROR
}
};
Expand All @@ -315,7 +331,8 @@ fn get_conditional_headers(header_list: &HeaderMap<HeaderValue>) -> Conditionals
}
}

fn sanitize_path(mut buf: PathBuf, tail: &str) -> Result<PathBuf, StatusCode> {
fn sanitize_path(base: impl AsRef<Path>, tail: &str) -> Result<PathBuf, StatusCode> {
let mut buf = PathBuf::from(base.as_ref());
let p = match percent_decode_str(tail).decode_utf8() {
Ok(p) => p,
Err(err) => {
Expand Down Expand Up @@ -400,38 +417,30 @@ impl Conditionals {
}
}

fn file_conditional(
async fn file_conditional(
f: TkFile,
path: PathBuf,
meta: Metadata,
path: ArcPath,
meta: &Metadata,
auto_index: bool,
conditionals: Conditionals,
) -> impl Future<Output = Result<Response<Body>, StatusCode>> + Send {
file_metadata(f, meta, auto_index)
.map_ok(|(file, meta)| response_body(file, &meta, path, conditionals))
}

async fn file_metadata(
f: TkFile,
meta: Metadata,
auto_index: bool,
) -> Result<(TkFile, Metadata), StatusCode> {
) -> Result<Response<Body>, StatusCode> {
if !auto_index {
return Ok((f, meta));
}
match f.metadata().await {
Ok(meta) => Ok((f, meta)),
Err(err) => {
tracing::debug!("file metadata error: {}", err);
Err(StatusCode::INTERNAL_SERVER_ERROR)
Ok(response_body(f, meta, path, conditionals))
} else {
match f.metadata().await {
Ok(meta) => Ok(response_body(f, &meta, path, conditionals)),
Err(err) => {
tracing::debug!("file metadata error: {}", err);
Err(StatusCode::INTERNAL_SERVER_ERROR)
}
}
}
}

fn response_body(
file: TkFile,
meta: &Metadata,
path: PathBuf,
path: ArcPath,
conditionals: Conditionals,
) -> Response<Body> {
let mut len = meta.len();
Expand Down Expand Up @@ -623,14 +632,14 @@ mod tests {
}

assert_eq!(
sanitize_path(base.into(), "/foo.html").unwrap(),
sanitize_path(base, "/foo.html").unwrap(),
p("/var/www/foo.html")
);

// bad paths
sanitize_path(base.into(), "/../foo.html").expect_err("dot dot");
sanitize_path(base, "/../foo.html").expect_err("dot dot");

sanitize_path(base.into(), "/C:\\/foo.html").expect_err("C:\\");
sanitize_path(base, "/C:\\/foo.html").expect_err("C:\\");
}

#[test]
Expand Down

0 comments on commit 70a76ed

Please sign in to comment.