mirror of
https://github.com/fafhrd91/actix-web
synced 2025-02-17 10:13:30 +01:00
split up files lib (#1685)
This commit is contained in:
parent
f9e3f78e45
commit
f7bcad9567
@ -18,7 +18,6 @@ path = "src/lib.rs"
|
|||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
actix-web = { version = "3.0.0", default-features = false }
|
actix-web = { version = "3.0.0", default-features = false }
|
||||||
actix-http = "2.0.0"
|
|
||||||
actix-service = "1.0.6"
|
actix-service = "1.0.6"
|
||||||
bitflags = "1"
|
bitflags = "1"
|
||||||
bytes = "0.5.3"
|
bytes = "0.5.3"
|
||||||
|
94
actix-files/src/chunked.rs
Normal file
94
actix-files/src/chunked.rs
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
use std::{
|
||||||
|
cmp, fmt,
|
||||||
|
fs::File,
|
||||||
|
future::Future,
|
||||||
|
io::{self, Read, Seek},
|
||||||
|
pin::Pin,
|
||||||
|
task::{Context, Poll},
|
||||||
|
};
|
||||||
|
|
||||||
|
use actix_web::{
|
||||||
|
error::{BlockingError, Error},
|
||||||
|
web,
|
||||||
|
};
|
||||||
|
use bytes::Bytes;
|
||||||
|
use futures_core::{ready, Stream};
|
||||||
|
use futures_util::future::{FutureExt, LocalBoxFuture};
|
||||||
|
|
||||||
|
use crate::handle_error;
|
||||||
|
|
||||||
|
type ChunkedBoxFuture =
|
||||||
|
LocalBoxFuture<'static, Result<(File, Bytes), BlockingError<io::Error>>>;
|
||||||
|
|
||||||
|
#[doc(hidden)]
|
||||||
|
/// A helper created from a `std::fs::File` which reads the file
|
||||||
|
/// chunk-by-chunk on a `ThreadPool`.
|
||||||
|
pub struct ChunkedReadFile {
|
||||||
|
pub(crate) size: u64,
|
||||||
|
pub(crate) offset: u64,
|
||||||
|
pub(crate) file: Option<File>,
|
||||||
|
pub(crate) fut: Option<ChunkedBoxFuture>,
|
||||||
|
pub(crate) counter: u64,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Debug for ChunkedReadFile {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
f.write_str("ChunkedReadFile")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Stream for ChunkedReadFile {
|
||||||
|
type Item = Result<Bytes, Error>;
|
||||||
|
|
||||||
|
fn poll_next(
|
||||||
|
mut self: Pin<&mut Self>,
|
||||||
|
cx: &mut Context<'_>,
|
||||||
|
) -> Poll<Option<Self::Item>> {
|
||||||
|
if let Some(ref mut fut) = self.fut {
|
||||||
|
return match ready!(Pin::new(fut).poll(cx)) {
|
||||||
|
Ok((file, bytes)) => {
|
||||||
|
self.fut.take();
|
||||||
|
self.file = Some(file);
|
||||||
|
|
||||||
|
self.offset += bytes.len() as u64;
|
||||||
|
self.counter += bytes.len() as u64;
|
||||||
|
|
||||||
|
Poll::Ready(Some(Ok(bytes)))
|
||||||
|
}
|
||||||
|
Err(e) => Poll::Ready(Some(Err(handle_error(e)))),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
let size = self.size;
|
||||||
|
let offset = self.offset;
|
||||||
|
let counter = self.counter;
|
||||||
|
|
||||||
|
if size == counter {
|
||||||
|
Poll::Ready(None)
|
||||||
|
} else {
|
||||||
|
let mut file = self.file.take().expect("Use after completion");
|
||||||
|
|
||||||
|
self.fut = Some(
|
||||||
|
web::block(move || {
|
||||||
|
let max_bytes =
|
||||||
|
cmp::min(size.saturating_sub(counter), 65_536) as usize;
|
||||||
|
|
||||||
|
let mut buf = Vec::with_capacity(max_bytes);
|
||||||
|
file.seek(io::SeekFrom::Start(offset))?;
|
||||||
|
|
||||||
|
let n_bytes =
|
||||||
|
file.by_ref().take(max_bytes as u64).read_to_end(&mut buf)?;
|
||||||
|
|
||||||
|
if n_bytes == 0 {
|
||||||
|
return Err(io::ErrorKind::UnexpectedEof.into());
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok((file, Bytes::from(buf)))
|
||||||
|
})
|
||||||
|
.boxed_local(),
|
||||||
|
);
|
||||||
|
|
||||||
|
self.poll_next(cx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
114
actix-files/src/directory.rs
Normal file
114
actix-files/src/directory.rs
Normal file
@ -0,0 +1,114 @@
|
|||||||
|
use std::{fmt::Write, fs::DirEntry, io, path::Path, path::PathBuf};
|
||||||
|
|
||||||
|
use actix_web::{dev::ServiceResponse, HttpRequest, HttpResponse};
|
||||||
|
use percent_encoding::{utf8_percent_encode, CONTROLS};
|
||||||
|
use v_htmlescape::escape as escape_html_entity;
|
||||||
|
|
||||||
|
/// A directory; responds with the generated directory listing.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct Directory {
|
||||||
|
/// Base directory.
|
||||||
|
pub base: PathBuf,
|
||||||
|
|
||||||
|
/// Path of subdirectory to generate listing for.
|
||||||
|
pub path: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Directory {
|
||||||
|
/// Create a new directory
|
||||||
|
pub fn new(base: PathBuf, path: PathBuf) -> Directory {
|
||||||
|
Directory { base, path }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Is this entry visible from this directory?
|
||||||
|
pub fn is_visible(&self, entry: &io::Result<DirEntry>) -> bool {
|
||||||
|
if let Ok(ref entry) = *entry {
|
||||||
|
if let Some(name) = entry.file_name().to_str() {
|
||||||
|
if name.starts_with('.') {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if let Ok(ref md) = entry.metadata() {
|
||||||
|
let ft = md.file_type();
|
||||||
|
return ft.is_dir() || ft.is_file() || ft.is_symlink();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) type DirectoryRenderer =
|
||||||
|
dyn Fn(&Directory, &HttpRequest) -> Result<ServiceResponse, io::Error>;
|
||||||
|
|
||||||
|
// show file url as relative to static path
|
||||||
|
macro_rules! encode_file_url {
|
||||||
|
($path:ident) => {
|
||||||
|
utf8_percent_encode(&$path, CONTROLS)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// " -- " & -- & ' -- ' < -- < > -- > / -- /
|
||||||
|
macro_rules! encode_file_name {
|
||||||
|
($entry:ident) => {
|
||||||
|
escape_html_entity(&$entry.file_name().to_string_lossy())
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn directory_listing(
|
||||||
|
dir: &Directory,
|
||||||
|
req: &HttpRequest,
|
||||||
|
) -> Result<ServiceResponse, io::Error> {
|
||||||
|
let index_of = format!("Index of {}", req.path());
|
||||||
|
let mut body = String::new();
|
||||||
|
let base = Path::new(req.path());
|
||||||
|
|
||||||
|
for entry in dir.path.read_dir()? {
|
||||||
|
if dir.is_visible(&entry) {
|
||||||
|
let entry = entry.unwrap();
|
||||||
|
let p = match entry.path().strip_prefix(&dir.path) {
|
||||||
|
Ok(p) if cfg!(windows) => {
|
||||||
|
base.join(p).to_string_lossy().replace("\\", "/")
|
||||||
|
}
|
||||||
|
Ok(p) => base.join(p).to_string_lossy().into_owned(),
|
||||||
|
Err(_) => continue,
|
||||||
|
};
|
||||||
|
|
||||||
|
// if file is a directory, add '/' to the end of the name
|
||||||
|
if let Ok(metadata) = entry.metadata() {
|
||||||
|
if metadata.is_dir() {
|
||||||
|
let _ = write!(
|
||||||
|
body,
|
||||||
|
"<li><a href=\"{}\">{}/</a></li>",
|
||||||
|
encode_file_url!(p),
|
||||||
|
encode_file_name!(entry),
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
let _ = write!(
|
||||||
|
body,
|
||||||
|
"<li><a href=\"{}\">{}</a></li>",
|
||||||
|
encode_file_url!(p),
|
||||||
|
encode_file_name!(entry),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let html = format!(
|
||||||
|
"<html>\
|
||||||
|
<head><title>{}</title></head>\
|
||||||
|
<body><h1>{}</h1>\
|
||||||
|
<ul>\
|
||||||
|
{}\
|
||||||
|
</ul></body>\n</html>",
|
||||||
|
index_of, index_of, body
|
||||||
|
);
|
||||||
|
Ok(ServiceResponse::new(
|
||||||
|
req.clone(),
|
||||||
|
HttpResponse::Ok()
|
||||||
|
.content_type("text/html; charset=utf-8")
|
||||||
|
.body(html),
|
||||||
|
))
|
||||||
|
}
|
250
actix-files/src/files.rs
Normal file
250
actix-files/src/files.rs
Normal file
@ -0,0 +1,250 @@
|
|||||||
|
use std::{cell::RefCell, fmt, io, path::PathBuf, rc::Rc};
|
||||||
|
|
||||||
|
use actix_service::{boxed, IntoServiceFactory, ServiceFactory};
|
||||||
|
use actix_web::{
|
||||||
|
dev::{
|
||||||
|
AppService, HttpServiceFactory, ResourceDef, ServiceRequest, ServiceResponse,
|
||||||
|
},
|
||||||
|
error::Error,
|
||||||
|
guard::Guard,
|
||||||
|
http::header::DispositionType,
|
||||||
|
HttpRequest,
|
||||||
|
};
|
||||||
|
use futures_util::future::{ok, FutureExt, LocalBoxFuture};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
directory_listing, named, Directory, DirectoryRenderer, FilesService,
|
||||||
|
HttpNewService, MimeOverride,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Static files handling service.
|
||||||
|
///
|
||||||
|
/// `Files` service must be registered with `App::service()` method.
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// use actix_web::App;
|
||||||
|
/// use actix_files::Files;
|
||||||
|
///
|
||||||
|
/// let app = App::new()
|
||||||
|
/// .service(Files::new("/static", "."));
|
||||||
|
/// ```
|
||||||
|
pub struct Files {
|
||||||
|
path: String,
|
||||||
|
directory: PathBuf,
|
||||||
|
index: Option<String>,
|
||||||
|
show_index: bool,
|
||||||
|
redirect_to_slash: bool,
|
||||||
|
default: Rc<RefCell<Option<Rc<HttpNewService>>>>,
|
||||||
|
renderer: Rc<DirectoryRenderer>,
|
||||||
|
mime_override: Option<Rc<MimeOverride>>,
|
||||||
|
file_flags: named::Flags,
|
||||||
|
guards: Option<Rc<dyn Guard>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Debug for Files {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
f.write_str("Files")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Clone for Files {
|
||||||
|
fn clone(&self) -> Self {
|
||||||
|
Self {
|
||||||
|
directory: self.directory.clone(),
|
||||||
|
index: self.index.clone(),
|
||||||
|
show_index: self.show_index,
|
||||||
|
redirect_to_slash: self.redirect_to_slash,
|
||||||
|
default: self.default.clone(),
|
||||||
|
renderer: self.renderer.clone(),
|
||||||
|
file_flags: self.file_flags,
|
||||||
|
path: self.path.clone(),
|
||||||
|
mime_override: self.mime_override.clone(),
|
||||||
|
guards: self.guards.clone(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Files {
|
||||||
|
/// Create new `Files` instance for specified base directory.
|
||||||
|
///
|
||||||
|
/// `File` uses `ThreadPool` for blocking filesystem operations.
|
||||||
|
/// By default pool with 5x threads of available cpus is used.
|
||||||
|
/// Pool size can be changed by setting ACTIX_THREADPOOL environment variable.
|
||||||
|
pub fn new<T: Into<PathBuf>>(path: &str, dir: T) -> Files {
|
||||||
|
let orig_dir = dir.into();
|
||||||
|
let dir = match orig_dir.canonicalize() {
|
||||||
|
Ok(canon_dir) => canon_dir,
|
||||||
|
Err(_) => {
|
||||||
|
log::error!("Specified path is not a directory: {:?}", orig_dir);
|
||||||
|
PathBuf::new()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
Files {
|
||||||
|
path: path.to_string(),
|
||||||
|
directory: dir,
|
||||||
|
index: None,
|
||||||
|
show_index: false,
|
||||||
|
redirect_to_slash: false,
|
||||||
|
default: Rc::new(RefCell::new(None)),
|
||||||
|
renderer: Rc::new(directory_listing),
|
||||||
|
mime_override: None,
|
||||||
|
file_flags: named::Flags::default(),
|
||||||
|
guards: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Show files listing for directories.
|
||||||
|
///
|
||||||
|
/// By default show files listing is disabled.
|
||||||
|
pub fn show_files_listing(mut self) -> Self {
|
||||||
|
self.show_index = true;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Redirects to a slash-ended path when browsing a directory.
|
||||||
|
///
|
||||||
|
/// By default never redirect.
|
||||||
|
pub fn redirect_to_slash_directory(mut self) -> Self {
|
||||||
|
self.redirect_to_slash = true;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Set custom directory renderer
|
||||||
|
pub fn files_listing_renderer<F>(mut self, f: F) -> Self
|
||||||
|
where
|
||||||
|
for<'r, 's> F: Fn(&'r Directory, &'s HttpRequest) -> Result<ServiceResponse, io::Error>
|
||||||
|
+ 'static,
|
||||||
|
{
|
||||||
|
self.renderer = Rc::new(f);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Specifies mime override callback
|
||||||
|
pub fn mime_override<F>(mut self, f: F) -> Self
|
||||||
|
where
|
||||||
|
F: Fn(&mime::Name<'_>) -> DispositionType + 'static,
|
||||||
|
{
|
||||||
|
self.mime_override = Some(Rc::new(f));
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Set index file
|
||||||
|
///
|
||||||
|
/// Shows specific index file for directory "/" instead of
|
||||||
|
/// showing files listing.
|
||||||
|
pub fn index_file<T: Into<String>>(mut self, index: T) -> Self {
|
||||||
|
self.index = Some(index.into());
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
/// Specifies whether to use ETag or not.
|
||||||
|
///
|
||||||
|
/// Default is true.
|
||||||
|
pub fn use_etag(mut self, value: bool) -> Self {
|
||||||
|
self.file_flags.set(named::Flags::ETAG, value);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
/// Specifies whether to use Last-Modified or not.
|
||||||
|
///
|
||||||
|
/// Default is true.
|
||||||
|
pub fn use_last_modified(mut self, value: bool) -> Self {
|
||||||
|
self.file_flags.set(named::Flags::LAST_MD, value);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Specifies custom guards to use for directory listings and files.
|
||||||
|
///
|
||||||
|
/// Default behaviour allows GET and HEAD.
|
||||||
|
#[inline]
|
||||||
|
pub fn use_guards<G: Guard + 'static>(mut self, guards: G) -> Self {
|
||||||
|
self.guards = Some(Rc::new(guards));
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Disable `Content-Disposition` header.
|
||||||
|
///
|
||||||
|
/// By default Content-Disposition` header is enabled.
|
||||||
|
#[inline]
|
||||||
|
pub fn disable_content_disposition(mut self) -> Self {
|
||||||
|
self.file_flags.remove(named::Flags::CONTENT_DISPOSITION);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Sets default handler which is used when no matched file could be found.
|
||||||
|
pub fn default_handler<F, U>(mut self, f: F) -> Self
|
||||||
|
where
|
||||||
|
F: IntoServiceFactory<U>,
|
||||||
|
U: ServiceFactory<
|
||||||
|
Config = (),
|
||||||
|
Request = ServiceRequest,
|
||||||
|
Response = ServiceResponse,
|
||||||
|
Error = Error,
|
||||||
|
> + 'static,
|
||||||
|
{
|
||||||
|
// create and configure default resource
|
||||||
|
self.default = Rc::new(RefCell::new(Some(Rc::new(boxed::factory(
|
||||||
|
f.into_factory().map_init_err(|_| ()),
|
||||||
|
)))));
|
||||||
|
|
||||||
|
self
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HttpServiceFactory for Files {
|
||||||
|
fn register(self, config: &mut AppService) {
|
||||||
|
if self.default.borrow().is_none() {
|
||||||
|
*self.default.borrow_mut() = Some(config.default_service());
|
||||||
|
}
|
||||||
|
|
||||||
|
let rdef = if config.is_root() {
|
||||||
|
ResourceDef::root_prefix(&self.path)
|
||||||
|
} else {
|
||||||
|
ResourceDef::prefix(&self.path)
|
||||||
|
};
|
||||||
|
|
||||||
|
config.register_service(rdef, None, self, None)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ServiceFactory for Files {
|
||||||
|
type Request = ServiceRequest;
|
||||||
|
type Response = ServiceResponse;
|
||||||
|
type Error = Error;
|
||||||
|
type Config = ();
|
||||||
|
type Service = FilesService;
|
||||||
|
type InitError = ();
|
||||||
|
type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>;
|
||||||
|
|
||||||
|
fn new_service(&self, _: ()) -> Self::Future {
|
||||||
|
let mut srv = FilesService {
|
||||||
|
directory: self.directory.clone(),
|
||||||
|
index: self.index.clone(),
|
||||||
|
show_index: self.show_index,
|
||||||
|
redirect_to_slash: self.redirect_to_slash,
|
||||||
|
default: None,
|
||||||
|
renderer: self.renderer.clone(),
|
||||||
|
mime_override: self.mime_override.clone(),
|
||||||
|
file_flags: self.file_flags,
|
||||||
|
guards: self.guards.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
if let Some(ref default) = *self.default.borrow() {
|
||||||
|
default
|
||||||
|
.new_service(())
|
||||||
|
.map(move |result| match result {
|
||||||
|
Ok(default) => {
|
||||||
|
srv.default = Some(default);
|
||||||
|
Ok(srv)
|
||||||
|
}
|
||||||
|
Err(_) => Err(()),
|
||||||
|
})
|
||||||
|
.boxed_local()
|
||||||
|
} else {
|
||||||
|
ok(srv).boxed_local()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -1,44 +1,52 @@
|
|||||||
//! Static files support
|
//! Static files support for Actix Web.
|
||||||
|
//!
|
||||||
|
//! Provides a non-blocking service for serving static files from disk.
|
||||||
|
//!
|
||||||
|
//! # Example
|
||||||
|
//! ```rust
|
||||||
|
//! use actix_web::App;
|
||||||
|
//! use actix_files::Files;
|
||||||
|
//!
|
||||||
|
//! let app = App::new()
|
||||||
|
//! .service(Files::new("/static", "."));
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! # Implementation Quirks
|
||||||
|
//! - If a filename contains non-ascii characters, that file will be served with the `charset=utf-8`
|
||||||
|
//! extension on the Content-Type header.
|
||||||
|
|
||||||
#![deny(rust_2018_idioms)]
|
#![deny(rust_2018_idioms)]
|
||||||
#![allow(clippy::borrow_interior_mutable_const)]
|
#![warn(missing_docs, missing_debug_implementations)]
|
||||||
|
|
||||||
use std::cell::RefCell;
|
use std::io;
|
||||||
use std::fmt::Write;
|
|
||||||
use std::fs::{DirEntry, File};
|
|
||||||
use std::future::Future;
|
|
||||||
use std::io::{Read, Seek};
|
|
||||||
use std::path::{Path, PathBuf};
|
|
||||||
use std::pin::Pin;
|
|
||||||
use std::rc::Rc;
|
|
||||||
use std::task::{Context, Poll};
|
|
||||||
use std::{cmp, io};
|
|
||||||
|
|
||||||
use actix_service::boxed::{self, BoxService, BoxServiceFactory};
|
use actix_service::boxed::{BoxService, BoxServiceFactory};
|
||||||
use actix_service::{IntoServiceFactory, Service, ServiceFactory};
|
use actix_web::{
|
||||||
use actix_web::dev::{
|
dev::{ServiceRequest, ServiceResponse},
|
||||||
AppService, HttpServiceFactory, Payload, ResourceDef, ServiceRequest,
|
error::{BlockingError, Error, ErrorInternalServerError},
|
||||||
ServiceResponse,
|
http::header::DispositionType,
|
||||||
};
|
};
|
||||||
use actix_web::error::{BlockingError, Error, ErrorInternalServerError};
|
|
||||||
use actix_web::guard::Guard;
|
|
||||||
use actix_web::http::header::{self, DispositionType};
|
|
||||||
use actix_web::http::Method;
|
|
||||||
use actix_web::{web, FromRequest, HttpRequest, HttpResponse};
|
|
||||||
use bytes::Bytes;
|
|
||||||
use futures_core::Stream;
|
|
||||||
use futures_util::future::{ok, ready, Either, FutureExt, LocalBoxFuture, Ready};
|
|
||||||
use mime_guess::from_ext;
|
use mime_guess::from_ext;
|
||||||
use percent_encoding::{utf8_percent_encode, CONTROLS};
|
|
||||||
use v_htmlescape::escape as escape_html_entity;
|
|
||||||
|
|
||||||
|
mod chunked;
|
||||||
|
mod directory;
|
||||||
mod error;
|
mod error;
|
||||||
|
mod files;
|
||||||
mod named;
|
mod named;
|
||||||
|
mod path_buf;
|
||||||
mod range;
|
mod range;
|
||||||
|
mod service;
|
||||||
|
|
||||||
use self::error::{FilesError, UriSegmentError};
|
pub use crate::chunked::ChunkedReadFile;
|
||||||
|
pub use crate::directory::Directory;
|
||||||
|
pub use crate::files::Files;
|
||||||
pub use crate::named::NamedFile;
|
pub use crate::named::NamedFile;
|
||||||
pub use crate::range::HttpRange;
|
pub use crate::range::HttpRange;
|
||||||
|
pub use crate::service::FilesService;
|
||||||
|
|
||||||
|
use self::directory::{directory_listing, DirectoryRenderer};
|
||||||
|
use self::error::FilesError;
|
||||||
|
use self::path_buf::PathBufWrap;
|
||||||
|
|
||||||
type HttpService = BoxService<ServiceRequest, ServiceResponse, Error>;
|
type HttpService = BoxService<ServiceRequest, ServiceResponse, Error>;
|
||||||
type HttpNewService = BoxServiceFactory<(), ServiceRequest, ServiceResponse, Error, ()>;
|
type HttpNewService = BoxServiceFactory<(), ServiceRequest, ServiceResponse, Error, ()>;
|
||||||
@ -51,612 +59,37 @@ pub fn file_extension_to_mime(ext: &str) -> mime::Mime {
|
|||||||
from_ext(ext).first_or_octet_stream()
|
from_ext(ext).first_or_octet_stream()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn handle_error(err: BlockingError<io::Error>) -> Error {
|
pub(crate) fn handle_error(err: BlockingError<io::Error>) -> Error {
|
||||||
match err {
|
match err {
|
||||||
BlockingError::Error(err) => err.into(),
|
BlockingError::Error(err) => err.into(),
|
||||||
BlockingError::Canceled => ErrorInternalServerError("Unexpected error"),
|
BlockingError::Canceled => ErrorInternalServerError("Unexpected error"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
#[doc(hidden)]
|
|
||||||
/// A helper created from a `std::fs::File` which reads the file
|
|
||||||
/// chunk-by-chunk on a `ThreadPool`.
|
|
||||||
pub struct ChunkedReadFile {
|
|
||||||
size: u64,
|
|
||||||
offset: u64,
|
|
||||||
file: Option<File>,
|
|
||||||
#[allow(clippy::type_complexity)]
|
|
||||||
fut:
|
|
||||||
Option<LocalBoxFuture<'static, Result<(File, Bytes), BlockingError<io::Error>>>>,
|
|
||||||
counter: u64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Stream for ChunkedReadFile {
|
|
||||||
type Item = Result<Bytes, Error>;
|
|
||||||
|
|
||||||
fn poll_next(
|
|
||||||
mut self: Pin<&mut Self>,
|
|
||||||
cx: &mut Context<'_>,
|
|
||||||
) -> Poll<Option<Self::Item>> {
|
|
||||||
if let Some(ref mut fut) = self.fut {
|
|
||||||
return match Pin::new(fut).poll(cx) {
|
|
||||||
Poll::Ready(Ok((file, bytes))) => {
|
|
||||||
self.fut.take();
|
|
||||||
self.file = Some(file);
|
|
||||||
self.offset += bytes.len() as u64;
|
|
||||||
self.counter += bytes.len() as u64;
|
|
||||||
Poll::Ready(Some(Ok(bytes)))
|
|
||||||
}
|
|
||||||
Poll::Ready(Err(e)) => Poll::Ready(Some(Err(handle_error(e)))),
|
|
||||||
Poll::Pending => Poll::Pending,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
let size = self.size;
|
|
||||||
let offset = self.offset;
|
|
||||||
let counter = self.counter;
|
|
||||||
|
|
||||||
if size == counter {
|
|
||||||
Poll::Ready(None)
|
|
||||||
} else {
|
|
||||||
let mut file = self.file.take().expect("Use after completion");
|
|
||||||
self.fut = Some(
|
|
||||||
web::block(move || {
|
|
||||||
let max_bytes: usize;
|
|
||||||
max_bytes = cmp::min(size.saturating_sub(counter), 65_536) as usize;
|
|
||||||
let mut buf = Vec::with_capacity(max_bytes);
|
|
||||||
file.seek(io::SeekFrom::Start(offset))?;
|
|
||||||
let nbytes =
|
|
||||||
file.by_ref().take(max_bytes as u64).read_to_end(&mut buf)?;
|
|
||||||
if nbytes == 0 {
|
|
||||||
return Err(io::ErrorKind::UnexpectedEof.into());
|
|
||||||
}
|
|
||||||
Ok((file, Bytes::from(buf)))
|
|
||||||
})
|
|
||||||
.boxed_local(),
|
|
||||||
);
|
|
||||||
self.poll_next(cx)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type DirectoryRenderer =
|
|
||||||
dyn Fn(&Directory, &HttpRequest) -> Result<ServiceResponse, io::Error>;
|
|
||||||
|
|
||||||
/// A directory; responds with the generated directory listing.
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub struct Directory {
|
|
||||||
/// Base directory
|
|
||||||
pub base: PathBuf,
|
|
||||||
/// Path of subdirectory to generate listing for
|
|
||||||
pub path: PathBuf,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Directory {
|
|
||||||
/// Create a new directory
|
|
||||||
pub fn new(base: PathBuf, path: PathBuf) -> Directory {
|
|
||||||
Directory { base, path }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Is this entry visible from this directory?
|
|
||||||
pub fn is_visible(&self, entry: &io::Result<DirEntry>) -> bool {
|
|
||||||
if let Ok(ref entry) = *entry {
|
|
||||||
if let Some(name) = entry.file_name().to_str() {
|
|
||||||
if name.starts_with('.') {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if let Ok(ref md) = entry.metadata() {
|
|
||||||
let ft = md.file_type();
|
|
||||||
return ft.is_dir() || ft.is_file() || ft.is_symlink();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// show file url as relative to static path
|
|
||||||
macro_rules! encode_file_url {
|
|
||||||
($path:ident) => {
|
|
||||||
utf8_percent_encode(&$path, CONTROLS)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// " -- " & -- & ' -- ' < -- < > -- > / -- /
|
|
||||||
macro_rules! encode_file_name {
|
|
||||||
($entry:ident) => {
|
|
||||||
escape_html_entity(&$entry.file_name().to_string_lossy())
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
fn directory_listing(
|
|
||||||
dir: &Directory,
|
|
||||||
req: &HttpRequest,
|
|
||||||
) -> Result<ServiceResponse, io::Error> {
|
|
||||||
let index_of = format!("Index of {}", req.path());
|
|
||||||
let mut body = String::new();
|
|
||||||
let base = Path::new(req.path());
|
|
||||||
|
|
||||||
for entry in dir.path.read_dir()? {
|
|
||||||
if dir.is_visible(&entry) {
|
|
||||||
let entry = entry.unwrap();
|
|
||||||
let p = match entry.path().strip_prefix(&dir.path) {
|
|
||||||
Ok(p) if cfg!(windows) => {
|
|
||||||
base.join(p).to_string_lossy().replace("\\", "/")
|
|
||||||
}
|
|
||||||
Ok(p) => base.join(p).to_string_lossy().into_owned(),
|
|
||||||
Err(_) => continue,
|
|
||||||
};
|
|
||||||
|
|
||||||
// if file is a directory, add '/' to the end of the name
|
|
||||||
if let Ok(metadata) = entry.metadata() {
|
|
||||||
if metadata.is_dir() {
|
|
||||||
let _ = write!(
|
|
||||||
body,
|
|
||||||
"<li><a href=\"{}\">{}/</a></li>",
|
|
||||||
encode_file_url!(p),
|
|
||||||
encode_file_name!(entry),
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
let _ = write!(
|
|
||||||
body,
|
|
||||||
"<li><a href=\"{}\">{}</a></li>",
|
|
||||||
encode_file_url!(p),
|
|
||||||
encode_file_name!(entry),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let html = format!(
|
|
||||||
"<html>\
|
|
||||||
<head><title>{}</title></head>\
|
|
||||||
<body><h1>{}</h1>\
|
|
||||||
<ul>\
|
|
||||||
{}\
|
|
||||||
</ul></body>\n</html>",
|
|
||||||
index_of, index_of, body
|
|
||||||
);
|
|
||||||
Ok(ServiceResponse::new(
|
|
||||||
req.clone(),
|
|
||||||
HttpResponse::Ok()
|
|
||||||
.content_type("text/html; charset=utf-8")
|
|
||||||
.body(html),
|
|
||||||
))
|
|
||||||
}
|
|
||||||
|
|
||||||
type MimeOverride = dyn Fn(&mime::Name<'_>) -> DispositionType;
|
type MimeOverride = dyn Fn(&mime::Name<'_>) -> DispositionType;
|
||||||
|
|
||||||
/// Static files handling
|
|
||||||
///
|
|
||||||
/// `Files` service must be registered with `App::service()` method.
|
|
||||||
///
|
|
||||||
/// ```rust
|
|
||||||
/// use actix_web::App;
|
|
||||||
/// use actix_files::Files;
|
|
||||||
///
|
|
||||||
/// let app = App::new()
|
|
||||||
/// .service(Files::new("/static", "."));
|
|
||||||
/// ```
|
|
||||||
pub struct Files {
|
|
||||||
path: String,
|
|
||||||
directory: PathBuf,
|
|
||||||
index: Option<String>,
|
|
||||||
show_index: bool,
|
|
||||||
redirect_to_slash: bool,
|
|
||||||
default: Rc<RefCell<Option<Rc<HttpNewService>>>>,
|
|
||||||
renderer: Rc<DirectoryRenderer>,
|
|
||||||
mime_override: Option<Rc<MimeOverride>>,
|
|
||||||
file_flags: named::Flags,
|
|
||||||
// FIXME: Should re-visit later.
|
|
||||||
#[allow(clippy::redundant_allocation)]
|
|
||||||
guards: Option<Rc<Box<dyn Guard>>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Clone for Files {
|
|
||||||
fn clone(&self) -> Self {
|
|
||||||
Self {
|
|
||||||
directory: self.directory.clone(),
|
|
||||||
index: self.index.clone(),
|
|
||||||
show_index: self.show_index,
|
|
||||||
redirect_to_slash: self.redirect_to_slash,
|
|
||||||
default: self.default.clone(),
|
|
||||||
renderer: self.renderer.clone(),
|
|
||||||
file_flags: self.file_flags,
|
|
||||||
path: self.path.clone(),
|
|
||||||
mime_override: self.mime_override.clone(),
|
|
||||||
guards: self.guards.clone(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Files {
|
|
||||||
/// Create new `Files` instance for specified base directory.
|
|
||||||
///
|
|
||||||
/// `File` uses `ThreadPool` for blocking filesystem operations.
|
|
||||||
/// By default pool with 5x threads of available cpus is used.
|
|
||||||
/// Pool size can be changed by setting ACTIX_THREADPOOL environment variable.
|
|
||||||
pub fn new<T: Into<PathBuf>>(path: &str, dir: T) -> Files {
|
|
||||||
let orig_dir = dir.into();
|
|
||||||
let dir = match orig_dir.canonicalize() {
|
|
||||||
Ok(canon_dir) => canon_dir,
|
|
||||||
Err(_) => {
|
|
||||||
log::error!("Specified path is not a directory: {:?}", orig_dir);
|
|
||||||
PathBuf::new()
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
Files {
|
|
||||||
path: path.to_string(),
|
|
||||||
directory: dir,
|
|
||||||
index: None,
|
|
||||||
show_index: false,
|
|
||||||
redirect_to_slash: false,
|
|
||||||
default: Rc::new(RefCell::new(None)),
|
|
||||||
renderer: Rc::new(directory_listing),
|
|
||||||
mime_override: None,
|
|
||||||
file_flags: named::Flags::default(),
|
|
||||||
guards: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Show files listing for directories.
|
|
||||||
///
|
|
||||||
/// By default show files listing is disabled.
|
|
||||||
pub fn show_files_listing(mut self) -> Self {
|
|
||||||
self.show_index = true;
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Redirects to a slash-ended path when browsing a directory.
|
|
||||||
///
|
|
||||||
/// By default never redirect.
|
|
||||||
pub fn redirect_to_slash_directory(mut self) -> Self {
|
|
||||||
self.redirect_to_slash = true;
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Set custom directory renderer
|
|
||||||
pub fn files_listing_renderer<F>(mut self, f: F) -> Self
|
|
||||||
where
|
|
||||||
for<'r, 's> F: Fn(&'r Directory, &'s HttpRequest) -> Result<ServiceResponse, io::Error>
|
|
||||||
+ 'static,
|
|
||||||
{
|
|
||||||
self.renderer = Rc::new(f);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Specifies mime override callback
|
|
||||||
pub fn mime_override<F>(mut self, f: F) -> Self
|
|
||||||
where
|
|
||||||
F: Fn(&mime::Name<'_>) -> DispositionType + 'static,
|
|
||||||
{
|
|
||||||
self.mime_override = Some(Rc::new(f));
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Set index file
|
|
||||||
///
|
|
||||||
/// Shows specific index file for directory "/" instead of
|
|
||||||
/// showing files listing.
|
|
||||||
pub fn index_file<T: Into<String>>(mut self, index: T) -> Self {
|
|
||||||
self.index = Some(index.into());
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
/// Specifies whether to use ETag or not.
|
|
||||||
///
|
|
||||||
/// Default is true.
|
|
||||||
pub fn use_etag(mut self, value: bool) -> Self {
|
|
||||||
self.file_flags.set(named::Flags::ETAG, value);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
/// Specifies whether to use Last-Modified or not.
|
|
||||||
///
|
|
||||||
/// Default is true.
|
|
||||||
pub fn use_last_modified(mut self, value: bool) -> Self {
|
|
||||||
self.file_flags.set(named::Flags::LAST_MD, value);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Specifies custom guards to use for directory listings and files.
|
|
||||||
///
|
|
||||||
/// Default behaviour allows GET and HEAD.
|
|
||||||
#[inline]
|
|
||||||
pub fn use_guards<G: Guard + 'static>(mut self, guards: G) -> Self {
|
|
||||||
self.guards = Some(Rc::new(Box::new(guards)));
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Disable `Content-Disposition` header.
|
|
||||||
///
|
|
||||||
/// By default Content-Disposition` header is enabled.
|
|
||||||
#[inline]
|
|
||||||
pub fn disable_content_disposition(mut self) -> Self {
|
|
||||||
self.file_flags.remove(named::Flags::CONTENT_DISPOSITION);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Sets default handler which is used when no matched file could be found.
|
|
||||||
pub fn default_handler<F, U>(mut self, f: F) -> Self
|
|
||||||
where
|
|
||||||
F: IntoServiceFactory<U>,
|
|
||||||
U: ServiceFactory<
|
|
||||||
Config = (),
|
|
||||||
Request = ServiceRequest,
|
|
||||||
Response = ServiceResponse,
|
|
||||||
Error = Error,
|
|
||||||
> + 'static,
|
|
||||||
{
|
|
||||||
// create and configure default resource
|
|
||||||
self.default = Rc::new(RefCell::new(Some(Rc::new(boxed::factory(
|
|
||||||
f.into_factory().map_init_err(|_| ()),
|
|
||||||
)))));
|
|
||||||
|
|
||||||
self
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl HttpServiceFactory for Files {
|
|
||||||
fn register(self, config: &mut AppService) {
|
|
||||||
if self.default.borrow().is_none() {
|
|
||||||
*self.default.borrow_mut() = Some(config.default_service());
|
|
||||||
}
|
|
||||||
let rdef = if config.is_root() {
|
|
||||||
ResourceDef::root_prefix(&self.path)
|
|
||||||
} else {
|
|
||||||
ResourceDef::prefix(&self.path)
|
|
||||||
};
|
|
||||||
config.register_service(rdef, None, self, None)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ServiceFactory for Files {
|
|
||||||
type Request = ServiceRequest;
|
|
||||||
type Response = ServiceResponse;
|
|
||||||
type Error = Error;
|
|
||||||
type Config = ();
|
|
||||||
type Service = FilesService;
|
|
||||||
type InitError = ();
|
|
||||||
type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>;
|
|
||||||
|
|
||||||
fn new_service(&self, _: ()) -> Self::Future {
|
|
||||||
let mut srv = FilesService {
|
|
||||||
directory: self.directory.clone(),
|
|
||||||
index: self.index.clone(),
|
|
||||||
show_index: self.show_index,
|
|
||||||
redirect_to_slash: self.redirect_to_slash,
|
|
||||||
default: None,
|
|
||||||
renderer: self.renderer.clone(),
|
|
||||||
mime_override: self.mime_override.clone(),
|
|
||||||
file_flags: self.file_flags,
|
|
||||||
guards: self.guards.clone(),
|
|
||||||
};
|
|
||||||
|
|
||||||
if let Some(ref default) = *self.default.borrow() {
|
|
||||||
default
|
|
||||||
.new_service(())
|
|
||||||
.map(move |result| match result {
|
|
||||||
Ok(default) => {
|
|
||||||
srv.default = Some(default);
|
|
||||||
Ok(srv)
|
|
||||||
}
|
|
||||||
Err(_) => Err(()),
|
|
||||||
})
|
|
||||||
.boxed_local()
|
|
||||||
} else {
|
|
||||||
ok(srv).boxed_local()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct FilesService {
|
|
||||||
directory: PathBuf,
|
|
||||||
index: Option<String>,
|
|
||||||
show_index: bool,
|
|
||||||
redirect_to_slash: bool,
|
|
||||||
default: Option<HttpService>,
|
|
||||||
renderer: Rc<DirectoryRenderer>,
|
|
||||||
mime_override: Option<Rc<MimeOverride>>,
|
|
||||||
file_flags: named::Flags,
|
|
||||||
// FIXME: Should re-visit later.
|
|
||||||
#[allow(clippy::redundant_allocation)]
|
|
||||||
guards: Option<Rc<Box<dyn Guard>>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FilesService {
|
|
||||||
#[allow(clippy::type_complexity)]
|
|
||||||
fn handle_err(
|
|
||||||
&mut self,
|
|
||||||
e: io::Error,
|
|
||||||
req: ServiceRequest,
|
|
||||||
) -> Either<
|
|
||||||
Ready<Result<ServiceResponse, Error>>,
|
|
||||||
LocalBoxFuture<'static, Result<ServiceResponse, Error>>,
|
|
||||||
> {
|
|
||||||
log::debug!("Files: Failed to handle {}: {}", req.path(), e);
|
|
||||||
if let Some(ref mut default) = self.default {
|
|
||||||
Either::Right(default.call(req))
|
|
||||||
} else {
|
|
||||||
Either::Left(ok(req.error_response(e)))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Service for FilesService {
|
|
||||||
type Request = ServiceRequest;
|
|
||||||
type Response = ServiceResponse;
|
|
||||||
type Error = Error;
|
|
||||||
#[allow(clippy::type_complexity)]
|
|
||||||
type Future = Either<
|
|
||||||
Ready<Result<Self::Response, Self::Error>>,
|
|
||||||
LocalBoxFuture<'static, Result<Self::Response, Self::Error>>,
|
|
||||||
>;
|
|
||||||
|
|
||||||
fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
|
||||||
Poll::Ready(Ok(()))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn call(&mut self, req: ServiceRequest) -> Self::Future {
|
|
||||||
let is_method_valid = if let Some(guard) = &self.guards {
|
|
||||||
// execute user defined guards
|
|
||||||
(**guard).check(req.head())
|
|
||||||
} else {
|
|
||||||
// default behavior
|
|
||||||
matches!(*req.method(), Method::HEAD | Method::GET)
|
|
||||||
};
|
|
||||||
|
|
||||||
if !is_method_valid {
|
|
||||||
return Either::Left(ok(req.into_response(
|
|
||||||
actix_web::HttpResponse::MethodNotAllowed()
|
|
||||||
.header(header::CONTENT_TYPE, "text/plain")
|
|
||||||
.body("Request did not meet this resource's requirements."),
|
|
||||||
)));
|
|
||||||
}
|
|
||||||
|
|
||||||
let real_path = match PathBufWrp::get_pathbuf(req.match_info().path()) {
|
|
||||||
Ok(item) => item,
|
|
||||||
Err(e) => return Either::Left(ok(req.error_response(e))),
|
|
||||||
};
|
|
||||||
|
|
||||||
// full file path
|
|
||||||
let path = match self.directory.join(&real_path.0).canonicalize() {
|
|
||||||
Ok(path) => path,
|
|
||||||
Err(e) => return self.handle_err(e, req),
|
|
||||||
};
|
|
||||||
|
|
||||||
if path.is_dir() {
|
|
||||||
if let Some(ref redir_index) = self.index {
|
|
||||||
if self.redirect_to_slash && !req.path().ends_with('/') {
|
|
||||||
let redirect_to = format!("{}/", req.path());
|
|
||||||
return Either::Left(ok(req.into_response(
|
|
||||||
HttpResponse::Found()
|
|
||||||
.header(header::LOCATION, redirect_to)
|
|
||||||
.body("")
|
|
||||||
.into_body(),
|
|
||||||
)));
|
|
||||||
}
|
|
||||||
|
|
||||||
let path = path.join(redir_index);
|
|
||||||
|
|
||||||
match NamedFile::open(path) {
|
|
||||||
Ok(mut named_file) => {
|
|
||||||
if let Some(ref mime_override) = self.mime_override {
|
|
||||||
let new_disposition =
|
|
||||||
mime_override(&named_file.content_type.type_());
|
|
||||||
named_file.content_disposition.disposition = new_disposition;
|
|
||||||
}
|
|
||||||
|
|
||||||
named_file.flags = self.file_flags;
|
|
||||||
let (req, _) = req.into_parts();
|
|
||||||
Either::Left(ok(match named_file.into_response(&req) {
|
|
||||||
Ok(item) => ServiceResponse::new(req, item),
|
|
||||||
Err(e) => ServiceResponse::from_err(e, req),
|
|
||||||
}))
|
|
||||||
}
|
|
||||||
Err(e) => self.handle_err(e, req),
|
|
||||||
}
|
|
||||||
} else if self.show_index {
|
|
||||||
let dir = Directory::new(self.directory.clone(), path);
|
|
||||||
let (req, _) = req.into_parts();
|
|
||||||
let x = (self.renderer)(&dir, &req);
|
|
||||||
match x {
|
|
||||||
Ok(resp) => Either::Left(ok(resp)),
|
|
||||||
Err(e) => Either::Left(ok(ServiceResponse::from_err(e, req))),
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
Either::Left(ok(ServiceResponse::from_err(
|
|
||||||
FilesError::IsDirectory,
|
|
||||||
req.into_parts().0,
|
|
||||||
)))
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
match NamedFile::open(path) {
|
|
||||||
Ok(mut named_file) => {
|
|
||||||
if let Some(ref mime_override) = self.mime_override {
|
|
||||||
let new_disposition =
|
|
||||||
mime_override(&named_file.content_type.type_());
|
|
||||||
named_file.content_disposition.disposition = new_disposition;
|
|
||||||
}
|
|
||||||
|
|
||||||
named_file.flags = self.file_flags;
|
|
||||||
let (req, _) = req.into_parts();
|
|
||||||
match named_file.into_response(&req) {
|
|
||||||
Ok(item) => {
|
|
||||||
Either::Left(ok(ServiceResponse::new(req.clone(), item)))
|
|
||||||
}
|
|
||||||
Err(e) => Either::Left(ok(ServiceResponse::from_err(e, req))),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Err(e) => self.handle_err(e, req),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
struct PathBufWrp(PathBuf);
|
|
||||||
|
|
||||||
impl PathBufWrp {
|
|
||||||
fn get_pathbuf(path: &str) -> Result<Self, UriSegmentError> {
|
|
||||||
let mut buf = PathBuf::new();
|
|
||||||
for segment in path.split('/') {
|
|
||||||
if segment == ".." {
|
|
||||||
buf.pop();
|
|
||||||
} else if segment.starts_with('.') {
|
|
||||||
return Err(UriSegmentError::BadStart('.'));
|
|
||||||
} else if segment.starts_with('*') {
|
|
||||||
return Err(UriSegmentError::BadStart('*'));
|
|
||||||
} else if segment.ends_with(':') {
|
|
||||||
return Err(UriSegmentError::BadEnd(':'));
|
|
||||||
} else if segment.ends_with('>') {
|
|
||||||
return Err(UriSegmentError::BadEnd('>'));
|
|
||||||
} else if segment.ends_with('<') {
|
|
||||||
return Err(UriSegmentError::BadEnd('<'));
|
|
||||||
} else if segment.is_empty() {
|
|
||||||
continue;
|
|
||||||
} else if cfg!(windows) && segment.contains('\\') {
|
|
||||||
return Err(UriSegmentError::BadChar('\\'));
|
|
||||||
} else {
|
|
||||||
buf.push(segment)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(PathBufWrp(buf))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FromRequest for PathBufWrp {
|
|
||||||
type Error = UriSegmentError;
|
|
||||||
type Future = Ready<Result<Self, Self::Error>>;
|
|
||||||
type Config = ();
|
|
||||||
|
|
||||||
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {
|
|
||||||
ready(PathBufWrp::get_pathbuf(req.match_info().path()))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use std::fs;
|
use std::{
|
||||||
use std::iter::FromIterator;
|
fs::{self, File},
|
||||||
use std::ops::Add;
|
ops::Add,
|
||||||
use std::time::{Duration, SystemTime};
|
time::{Duration, SystemTime},
|
||||||
|
};
|
||||||
|
|
||||||
|
use actix_service::ServiceFactory;
|
||||||
|
use actix_web::{
|
||||||
|
guard,
|
||||||
|
http::{
|
||||||
|
header::{self, ContentDisposition, DispositionParam, DispositionType},
|
||||||
|
Method, StatusCode,
|
||||||
|
},
|
||||||
|
middleware::Compress,
|
||||||
|
test::{self, TestRequest},
|
||||||
|
web, App, HttpResponse, Responder,
|
||||||
|
};
|
||||||
|
use futures_util::future::ok;
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
use actix_web::guard;
|
|
||||||
use actix_web::http::header::{
|
|
||||||
self, ContentDisposition, DispositionParam, DispositionType,
|
|
||||||
};
|
|
||||||
use actix_web::http::{Method, StatusCode};
|
|
||||||
use actix_web::middleware::Compress;
|
|
||||||
use actix_web::test::{self, TestRequest};
|
|
||||||
use actix_web::{App, Responder};
|
|
||||||
|
|
||||||
#[actix_rt::test]
|
#[actix_rt::test]
|
||||||
async fn test_file_extension_to_mime() {
|
async fn test_file_extension_to_mime() {
|
||||||
@ -1013,7 +446,7 @@ mod tests {
|
|||||||
|
|
||||||
// Check file contents
|
// Check file contents
|
||||||
let bytes = response.body().await.unwrap();
|
let bytes = response.body().await.unwrap();
|
||||||
let data = Bytes::from(fs::read("tests/test.binary").unwrap());
|
let data = web::Bytes::from(fs::read("tests/test.binary").unwrap());
|
||||||
assert_eq!(bytes, data);
|
assert_eq!(bytes, data);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1046,7 +479,7 @@ mod tests {
|
|||||||
assert_eq!(response.status(), StatusCode::OK);
|
assert_eq!(response.status(), StatusCode::OK);
|
||||||
|
|
||||||
let bytes = test::read_body(response).await;
|
let bytes = test::read_body(response).await;
|
||||||
let data = Bytes::from(fs::read("tests/test space.binary").unwrap());
|
let data = web::Bytes::from(fs::read("tests/test space.binary").unwrap());
|
||||||
assert_eq!(bytes, data);
|
assert_eq!(bytes, data);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1224,7 +657,7 @@ mod tests {
|
|||||||
let resp = test::call_service(&mut st, req).await;
|
let resp = test::call_service(&mut st, req).await;
|
||||||
assert_eq!(resp.status(), StatusCode::OK);
|
assert_eq!(resp.status(), StatusCode::OK);
|
||||||
let bytes = test::read_body(resp).await;
|
let bytes = test::read_body(resp).await;
|
||||||
assert_eq!(bytes, Bytes::from_static(b"default content"));
|
assert_eq!(bytes, web::Bytes::from_static(b"default content"));
|
||||||
}
|
}
|
||||||
|
|
||||||
// #[actix_rt::test]
|
// #[actix_rt::test]
|
||||||
@ -1340,36 +773,4 @@ mod tests {
|
|||||||
// let response = srv.execute(request.send()).unwrap();
|
// let response = srv.execute(request.send()).unwrap();
|
||||||
// assert_eq!(response.status(), StatusCode::OK);
|
// assert_eq!(response.status(), StatusCode::OK);
|
||||||
// }
|
// }
|
||||||
|
|
||||||
#[actix_rt::test]
|
|
||||||
async fn test_path_buf() {
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/test/.tt").map(|t| t.0),
|
|
||||||
Err(UriSegmentError::BadStart('.'))
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/test/*tt").map(|t| t.0),
|
|
||||||
Err(UriSegmentError::BadStart('*'))
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/test/tt:").map(|t| t.0),
|
|
||||||
Err(UriSegmentError::BadEnd(':'))
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/test/tt<").map(|t| t.0),
|
|
||||||
Err(UriSegmentError::BadEnd('<'))
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/test/tt>").map(|t| t.0),
|
|
||||||
Err(UriSegmentError::BadEnd('>'))
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/seg1/seg2/").unwrap().0,
|
|
||||||
PathBuf::from_iter(vec!["seg1", "seg2"])
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
PathBufWrp::get_pathbuf("/seg1/../seg2/").unwrap().0,
|
|
||||||
PathBuf::from_iter(vec!["seg2"])
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -7,17 +7,20 @@ use std::time::{SystemTime, UNIX_EPOCH};
|
|||||||
#[cfg(unix)]
|
#[cfg(unix)]
|
||||||
use std::os::unix::fs::MetadataExt;
|
use std::os::unix::fs::MetadataExt;
|
||||||
|
|
||||||
use bitflags::bitflags;
|
use actix_web::{
|
||||||
use mime_guess::from_path;
|
dev::{BodyEncoding, SizedStream},
|
||||||
|
http::{
|
||||||
use actix_http::body::SizedStream;
|
header::{
|
||||||
use actix_web::dev::BodyEncoding;
|
self, Charset, ContentDisposition, DispositionParam, DispositionType,
|
||||||
use actix_web::http::header::{
|
ExtendedValue,
|
||||||
self, Charset, ContentDisposition, DispositionParam, DispositionType, ExtendedValue,
|
},
|
||||||
|
ContentEncoding, StatusCode,
|
||||||
|
},
|
||||||
|
Error, HttpMessage, HttpRequest, HttpResponse, Responder,
|
||||||
};
|
};
|
||||||
use actix_web::http::{ContentEncoding, StatusCode};
|
use bitflags::bitflags;
|
||||||
use actix_web::{Error, HttpMessage, HttpRequest, HttpResponse, Responder};
|
|
||||||
use futures_util::future::{ready, Ready};
|
use futures_util::future::{ready, Ready};
|
||||||
|
use mime_guess::from_path;
|
||||||
|
|
||||||
use crate::range::HttpRange;
|
use crate::range::HttpRange;
|
||||||
use crate::ChunkedReadFile;
|
use crate::ChunkedReadFile;
|
||||||
@ -93,8 +96,10 @@ impl NamedFile {
|
|||||||
mime::IMAGE | mime::TEXT | mime::VIDEO => DispositionType::Inline,
|
mime::IMAGE | mime::TEXT | mime::VIDEO => DispositionType::Inline,
|
||||||
_ => DispositionType::Attachment,
|
_ => DispositionType::Attachment,
|
||||||
};
|
};
|
||||||
|
|
||||||
let mut parameters =
|
let mut parameters =
|
||||||
vec![DispositionParam::Filename(String::from(filename.as_ref()))];
|
vec![DispositionParam::Filename(String::from(filename.as_ref()))];
|
||||||
|
|
||||||
if !filename.is_ascii() {
|
if !filename.is_ascii() {
|
||||||
parameters.push(DispositionParam::FilenameExt(ExtendedValue {
|
parameters.push(DispositionParam::FilenameExt(ExtendedValue {
|
||||||
charset: Charset::Ext(String::from("UTF-8")),
|
charset: Charset::Ext(String::from("UTF-8")),
|
||||||
@ -102,16 +107,19 @@ impl NamedFile {
|
|||||||
value: filename.into_owned().into_bytes(),
|
value: filename.into_owned().into_bytes(),
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
|
|
||||||
let cd = ContentDisposition {
|
let cd = ContentDisposition {
|
||||||
disposition,
|
disposition,
|
||||||
parameters,
|
parameters,
|
||||||
};
|
};
|
||||||
|
|
||||||
(ct, cd)
|
(ct, cd)
|
||||||
};
|
};
|
||||||
|
|
||||||
let md = file.metadata()?;
|
let md = file.metadata()?;
|
||||||
let modified = md.modified().ok();
|
let modified = md.modified().ok();
|
||||||
let encoding = None;
|
let encoding = None;
|
||||||
|
|
||||||
Ok(NamedFile {
|
Ok(NamedFile {
|
||||||
path,
|
path,
|
||||||
file,
|
file,
|
||||||
@ -242,6 +250,7 @@ impl NamedFile {
|
|||||||
let dur = mtime
|
let dur = mtime
|
||||||
.duration_since(UNIX_EPOCH)
|
.duration_since(UNIX_EPOCH)
|
||||||
.expect("modification time must be after epoch");
|
.expect("modification time must be after epoch");
|
||||||
|
|
||||||
header::EntityTag::strong(format!(
|
header::EntityTag::strong(format!(
|
||||||
"{:x}:{:x}:{:x}:{:x}",
|
"{:x}:{:x}:{:x}:{:x}",
|
||||||
ino,
|
ino,
|
||||||
@ -256,9 +265,11 @@ impl NamedFile {
|
|||||||
self.modified.map(|mtime| mtime.into())
|
self.modified.map(|mtime| mtime.into())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Creates an `HttpResponse` with file as a streaming body.
|
||||||
pub fn into_response(self, req: &HttpRequest) -> Result<HttpResponse, Error> {
|
pub fn into_response(self, req: &HttpRequest) -> Result<HttpResponse, Error> {
|
||||||
if self.status_code != StatusCode::OK {
|
if self.status_code != StatusCode::OK {
|
||||||
let mut resp = HttpResponse::build(self.status_code);
|
let mut resp = HttpResponse::build(self.status_code);
|
||||||
|
|
||||||
resp.set(header::ContentType(self.content_type.clone()))
|
resp.set(header::ContentType(self.content_type.clone()))
|
||||||
.if_true(self.flags.contains(Flags::CONTENT_DISPOSITION), |res| {
|
.if_true(self.flags.contains(Flags::CONTENT_DISPOSITION), |res| {
|
||||||
res.header(
|
res.header(
|
||||||
@ -266,9 +277,11 @@ impl NamedFile {
|
|||||||
self.content_disposition.to_string(),
|
self.content_disposition.to_string(),
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
if let Some(current_encoding) = self.encoding {
|
if let Some(current_encoding) = self.encoding {
|
||||||
resp.encoding(current_encoding);
|
resp.encoding(current_encoding);
|
||||||
}
|
}
|
||||||
|
|
||||||
let reader = ChunkedReadFile {
|
let reader = ChunkedReadFile {
|
||||||
size: self.md.len(),
|
size: self.md.len(),
|
||||||
offset: 0,
|
offset: 0,
|
||||||
@ -276,6 +289,7 @@ impl NamedFile {
|
|||||||
fut: None,
|
fut: None,
|
||||||
counter: 0,
|
counter: 0,
|
||||||
};
|
};
|
||||||
|
|
||||||
return Ok(resp.streaming(reader));
|
return Ok(resp.streaming(reader));
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -284,6 +298,7 @@ impl NamedFile {
|
|||||||
} else {
|
} else {
|
||||||
None
|
None
|
||||||
};
|
};
|
||||||
|
|
||||||
let last_modified = if self.flags.contains(Flags::LAST_MD) {
|
let last_modified = if self.flags.contains(Flags::LAST_MD) {
|
||||||
self.last_modified()
|
self.last_modified()
|
||||||
} else {
|
} else {
|
||||||
@ -298,6 +313,7 @@ impl NamedFile {
|
|||||||
{
|
{
|
||||||
let t1: SystemTime = m.clone().into();
|
let t1: SystemTime = m.clone().into();
|
||||||
let t2: SystemTime = since.clone().into();
|
let t2: SystemTime = since.clone().into();
|
||||||
|
|
||||||
match (t1.duration_since(UNIX_EPOCH), t2.duration_since(UNIX_EPOCH)) {
|
match (t1.duration_since(UNIX_EPOCH), t2.duration_since(UNIX_EPOCH)) {
|
||||||
(Ok(t1), Ok(t2)) => t1 > t2,
|
(Ok(t1), Ok(t2)) => t1 > t2,
|
||||||
_ => false,
|
_ => false,
|
||||||
@ -309,13 +325,14 @@ impl NamedFile {
|
|||||||
// check last modified
|
// check last modified
|
||||||
let not_modified = if !none_match(etag.as_ref(), req) {
|
let not_modified = if !none_match(etag.as_ref(), req) {
|
||||||
true
|
true
|
||||||
} else if req.headers().contains_key(&header::IF_NONE_MATCH) {
|
} else if req.headers().contains_key(header::IF_NONE_MATCH) {
|
||||||
false
|
false
|
||||||
} else if let (Some(ref m), Some(header::IfModifiedSince(ref since))) =
|
} else if let (Some(ref m), Some(header::IfModifiedSince(ref since))) =
|
||||||
(last_modified, req.get_header())
|
(last_modified, req.get_header())
|
||||||
{
|
{
|
||||||
let t1: SystemTime = m.clone().into();
|
let t1: SystemTime = m.clone().into();
|
||||||
let t2: SystemTime = since.clone().into();
|
let t2: SystemTime = since.clone().into();
|
||||||
|
|
||||||
match (t1.duration_since(UNIX_EPOCH), t2.duration_since(UNIX_EPOCH)) {
|
match (t1.duration_since(UNIX_EPOCH), t2.duration_since(UNIX_EPOCH)) {
|
||||||
(Ok(t1), Ok(t2)) => t1 <= t2,
|
(Ok(t1), Ok(t2)) => t1 <= t2,
|
||||||
_ => false,
|
_ => false,
|
||||||
@ -332,6 +349,7 @@ impl NamedFile {
|
|||||||
self.content_disposition.to_string(),
|
self.content_disposition.to_string(),
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
// default compressing
|
// default compressing
|
||||||
if let Some(current_encoding) = self.encoding {
|
if let Some(current_encoding) = self.encoding {
|
||||||
resp.encoding(current_encoding);
|
resp.encoding(current_encoding);
|
||||||
@ -350,11 +368,12 @@ impl NamedFile {
|
|||||||
let mut offset = 0;
|
let mut offset = 0;
|
||||||
|
|
||||||
// check for range header
|
// check for range header
|
||||||
if let Some(ranges) = req.headers().get(&header::RANGE) {
|
if let Some(ranges) = req.headers().get(header::RANGE) {
|
||||||
if let Ok(rangesheader) = ranges.to_str() {
|
if let Ok(ranges_header) = ranges.to_str() {
|
||||||
if let Ok(rangesvec) = HttpRange::parse(rangesheader, length) {
|
if let Ok(ranges) = HttpRange::parse(ranges_header, length) {
|
||||||
length = rangesvec[0].length;
|
length = ranges[0].length;
|
||||||
offset = rangesvec[0].start;
|
offset = ranges[0].start;
|
||||||
|
|
||||||
resp.encoding(ContentEncoding::Identity);
|
resp.encoding(ContentEncoding::Identity);
|
||||||
resp.header(
|
resp.header(
|
||||||
header::CONTENT_RANGE,
|
header::CONTENT_RANGE,
|
||||||
@ -414,6 +433,7 @@ impl DerefMut for NamedFile {
|
|||||||
fn any_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
fn any_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
||||||
match req.get_header::<header::IfMatch>() {
|
match req.get_header::<header::IfMatch>() {
|
||||||
None | Some(header::IfMatch::Any) => true,
|
None | Some(header::IfMatch::Any) => true,
|
||||||
|
|
||||||
Some(header::IfMatch::Items(ref items)) => {
|
Some(header::IfMatch::Items(ref items)) => {
|
||||||
if let Some(some_etag) = etag {
|
if let Some(some_etag) = etag {
|
||||||
for item in items {
|
for item in items {
|
||||||
@ -422,6 +442,7 @@ fn any_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
false
|
false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -431,6 +452,7 @@ fn any_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
|||||||
fn none_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
fn none_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
||||||
match req.get_header::<header::IfNoneMatch>() {
|
match req.get_header::<header::IfNoneMatch>() {
|
||||||
Some(header::IfNoneMatch::Any) => false,
|
Some(header::IfNoneMatch::Any) => false,
|
||||||
|
|
||||||
Some(header::IfNoneMatch::Items(ref items)) => {
|
Some(header::IfNoneMatch::Items(ref items)) => {
|
||||||
if let Some(some_etag) = etag {
|
if let Some(some_etag) = etag {
|
||||||
for item in items {
|
for item in items {
|
||||||
@ -439,8 +461,10 @@ fn none_match(etag: Option<&header::EntityTag>, req: &HttpRequest) -> bool {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
None => true,
|
None => true,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
99
actix-files/src/path_buf.rs
Normal file
99
actix-files/src/path_buf.rs
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
use std::{
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
str::FromStr,
|
||||||
|
};
|
||||||
|
|
||||||
|
use actix_web::{dev::Payload, FromRequest, HttpRequest};
|
||||||
|
use futures_util::future::{ready, Ready};
|
||||||
|
|
||||||
|
use crate::error::UriSegmentError;
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub(crate) struct PathBufWrap(PathBuf);
|
||||||
|
|
||||||
|
impl FromStr for PathBufWrap {
|
||||||
|
type Err = UriSegmentError;
|
||||||
|
|
||||||
|
fn from_str(path: &str) -> Result<Self, Self::Err> {
|
||||||
|
let mut buf = PathBuf::new();
|
||||||
|
|
||||||
|
for segment in path.split('/') {
|
||||||
|
if segment == ".." {
|
||||||
|
buf.pop();
|
||||||
|
} else if segment.starts_with('.') {
|
||||||
|
return Err(UriSegmentError::BadStart('.'));
|
||||||
|
} else if segment.starts_with('*') {
|
||||||
|
return Err(UriSegmentError::BadStart('*'));
|
||||||
|
} else if segment.ends_with(':') {
|
||||||
|
return Err(UriSegmentError::BadEnd(':'));
|
||||||
|
} else if segment.ends_with('>') {
|
||||||
|
return Err(UriSegmentError::BadEnd('>'));
|
||||||
|
} else if segment.ends_with('<') {
|
||||||
|
return Err(UriSegmentError::BadEnd('<'));
|
||||||
|
} else if segment.is_empty() {
|
||||||
|
continue;
|
||||||
|
} else if cfg!(windows) && segment.contains('\\') {
|
||||||
|
return Err(UriSegmentError::BadChar('\\'));
|
||||||
|
} else {
|
||||||
|
buf.push(segment)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(PathBufWrap(buf))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AsRef<Path> for PathBufWrap {
|
||||||
|
fn as_ref(&self) -> &Path {
|
||||||
|
self.0.as_ref()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromRequest for PathBufWrap {
|
||||||
|
type Error = UriSegmentError;
|
||||||
|
type Future = Ready<Result<Self, Self::Error>>;
|
||||||
|
type Config = ();
|
||||||
|
|
||||||
|
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {
|
||||||
|
ready(req.match_info().path().parse())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use std::iter::FromIterator;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_path_buf() {
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/test/.tt").map(|t| t.0),
|
||||||
|
Err(UriSegmentError::BadStart('.'))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/test/*tt").map(|t| t.0),
|
||||||
|
Err(UriSegmentError::BadStart('*'))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/test/tt:").map(|t| t.0),
|
||||||
|
Err(UriSegmentError::BadEnd(':'))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/test/tt<").map(|t| t.0),
|
||||||
|
Err(UriSegmentError::BadEnd('<'))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/test/tt>").map(|t| t.0),
|
||||||
|
Err(UriSegmentError::BadEnd('>'))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/seg1/seg2/").unwrap().0,
|
||||||
|
PathBuf::from_iter(vec!["seg1", "seg2"])
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
PathBufWrap::from_str("/seg1/../seg2/").unwrap().0,
|
||||||
|
PathBuf::from_iter(vec!["seg2"])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
@ -1,11 +1,14 @@
|
|||||||
/// HTTP Range header representation.
|
/// HTTP Range header representation.
|
||||||
#[derive(Debug, Clone, Copy)]
|
#[derive(Debug, Clone, Copy)]
|
||||||
pub struct HttpRange {
|
pub struct HttpRange {
|
||||||
|
/// Start of range.
|
||||||
pub start: u64,
|
pub start: u64,
|
||||||
|
|
||||||
|
/// Length of range.
|
||||||
pub length: u64,
|
pub length: u64,
|
||||||
}
|
}
|
||||||
|
|
||||||
static PREFIX: &str = "bytes=";
|
const PREFIX: &str = "bytes=";
|
||||||
const PREFIX_LEN: usize = 6;
|
const PREFIX_LEN: usize = 6;
|
||||||
|
|
||||||
impl HttpRange {
|
impl HttpRange {
|
||||||
|
167
actix-files/src/service.rs
Normal file
167
actix-files/src/service.rs
Normal file
@ -0,0 +1,167 @@
|
|||||||
|
use std::{
|
||||||
|
fmt, io,
|
||||||
|
path::PathBuf,
|
||||||
|
rc::Rc,
|
||||||
|
task::{Context, Poll},
|
||||||
|
};
|
||||||
|
|
||||||
|
use actix_service::Service;
|
||||||
|
use actix_web::{
|
||||||
|
dev::{ServiceRequest, ServiceResponse},
|
||||||
|
error::Error,
|
||||||
|
guard::Guard,
|
||||||
|
http::{header, Method},
|
||||||
|
HttpResponse,
|
||||||
|
};
|
||||||
|
use futures_util::future::{ok, Either, LocalBoxFuture, Ready};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
named, Directory, DirectoryRenderer, FilesError, HttpService, MimeOverride,
|
||||||
|
NamedFile, PathBufWrap,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Assembled file serving service.
|
||||||
|
pub struct FilesService {
|
||||||
|
pub(crate) directory: PathBuf,
|
||||||
|
pub(crate) index: Option<String>,
|
||||||
|
pub(crate) show_index: bool,
|
||||||
|
pub(crate) redirect_to_slash: bool,
|
||||||
|
pub(crate) default: Option<HttpService>,
|
||||||
|
pub(crate) renderer: Rc<DirectoryRenderer>,
|
||||||
|
pub(crate) mime_override: Option<Rc<MimeOverride>>,
|
||||||
|
pub(crate) file_flags: named::Flags,
|
||||||
|
pub(crate) guards: Option<Rc<dyn Guard>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
type FilesServiceFuture = Either<
|
||||||
|
Ready<Result<ServiceResponse, Error>>,
|
||||||
|
LocalBoxFuture<'static, Result<ServiceResponse, Error>>,
|
||||||
|
>;
|
||||||
|
|
||||||
|
impl FilesService {
|
||||||
|
fn handle_err(&mut self, e: io::Error, req: ServiceRequest) -> FilesServiceFuture {
|
||||||
|
log::debug!("Failed to handle {}: {}", req.path(), e);
|
||||||
|
|
||||||
|
if let Some(ref mut default) = self.default {
|
||||||
|
Either::Right(default.call(req))
|
||||||
|
} else {
|
||||||
|
Either::Left(ok(req.error_response(e)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Debug for FilesService {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
f.write_str("FilesService")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Service for FilesService {
|
||||||
|
type Request = ServiceRequest;
|
||||||
|
type Response = ServiceResponse;
|
||||||
|
type Error = Error;
|
||||||
|
type Future = FilesServiceFuture;
|
||||||
|
|
||||||
|
fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
||||||
|
Poll::Ready(Ok(()))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn call(&mut self, req: ServiceRequest) -> Self::Future {
|
||||||
|
let is_method_valid = if let Some(guard) = &self.guards {
|
||||||
|
// execute user defined guards
|
||||||
|
(**guard).check(req.head())
|
||||||
|
} else {
|
||||||
|
// default behavior
|
||||||
|
matches!(*req.method(), Method::HEAD | Method::GET)
|
||||||
|
};
|
||||||
|
|
||||||
|
if !is_method_valid {
|
||||||
|
return Either::Left(ok(req.into_response(
|
||||||
|
actix_web::HttpResponse::MethodNotAllowed()
|
||||||
|
.header(header::CONTENT_TYPE, "text/plain")
|
||||||
|
.body("Request did not meet this resource's requirements."),
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let real_path: PathBufWrap = match req.match_info().path().parse() {
|
||||||
|
Ok(item) => item,
|
||||||
|
Err(e) => return Either::Left(ok(req.error_response(e))),
|
||||||
|
};
|
||||||
|
|
||||||
|
// full file path
|
||||||
|
let path = match self.directory.join(&real_path).canonicalize() {
|
||||||
|
Ok(path) => path,
|
||||||
|
Err(e) => return self.handle_err(e, req),
|
||||||
|
};
|
||||||
|
|
||||||
|
if path.is_dir() {
|
||||||
|
if let Some(ref redir_index) = self.index {
|
||||||
|
if self.redirect_to_slash && !req.path().ends_with('/') {
|
||||||
|
let redirect_to = format!("{}/", req.path());
|
||||||
|
|
||||||
|
return Either::Left(ok(req.into_response(
|
||||||
|
HttpResponse::Found()
|
||||||
|
.header(header::LOCATION, redirect_to)
|
||||||
|
.body("")
|
||||||
|
.into_body(),
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let path = path.join(redir_index);
|
||||||
|
|
||||||
|
match NamedFile::open(path) {
|
||||||
|
Ok(mut named_file) => {
|
||||||
|
if let Some(ref mime_override) = self.mime_override {
|
||||||
|
let new_disposition =
|
||||||
|
mime_override(&named_file.content_type.type_());
|
||||||
|
named_file.content_disposition.disposition = new_disposition;
|
||||||
|
}
|
||||||
|
named_file.flags = self.file_flags;
|
||||||
|
|
||||||
|
let (req, _) = req.into_parts();
|
||||||
|
Either::Left(ok(match named_file.into_response(&req) {
|
||||||
|
Ok(item) => ServiceResponse::new(req, item),
|
||||||
|
Err(e) => ServiceResponse::from_err(e, req),
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
Err(e) => self.handle_err(e, req),
|
||||||
|
}
|
||||||
|
} else if self.show_index {
|
||||||
|
let dir = Directory::new(self.directory.clone(), path);
|
||||||
|
|
||||||
|
let (req, _) = req.into_parts();
|
||||||
|
let x = (self.renderer)(&dir, &req);
|
||||||
|
|
||||||
|
match x {
|
||||||
|
Ok(resp) => Either::Left(ok(resp)),
|
||||||
|
Err(e) => Either::Left(ok(ServiceResponse::from_err(e, req))),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Either::Left(ok(ServiceResponse::from_err(
|
||||||
|
FilesError::IsDirectory,
|
||||||
|
req.into_parts().0,
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
match NamedFile::open(path) {
|
||||||
|
Ok(mut named_file) => {
|
||||||
|
if let Some(ref mime_override) = self.mime_override {
|
||||||
|
let new_disposition =
|
||||||
|
mime_override(&named_file.content_type.type_());
|
||||||
|
named_file.content_disposition.disposition = new_disposition;
|
||||||
|
}
|
||||||
|
named_file.flags = self.file_flags;
|
||||||
|
|
||||||
|
let (req, _) = req.into_parts();
|
||||||
|
match named_file.into_response(&req) {
|
||||||
|
Ok(item) => {
|
||||||
|
Either::Left(ok(ServiceResponse::new(req.clone(), item)))
|
||||||
|
}
|
||||||
|
Err(e) => Either::Left(ok(ServiceResponse::from_err(e, req))),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(e) => self.handle_err(e, req),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user