1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-12-18 09:53:11 +01:00
actix-web/actix-files/src/lib.rs

1013 lines
34 KiB
Rust
Raw Normal View History

2020-10-06 23:08:33 +02:00
//! Static file serving for Actix Web.
2020-09-21 00:18:25 +02:00
//!
//! Provides a non-blocking service for serving static files from disk.
//!
2022-01-21 17:56:33 +01:00
//! # Examples
//! ```
2020-09-21 00:18:25 +02:00
//! use actix_web::App;
//! use actix_files::Files;
//!
//! let app = App::new()
//! .service(Files::new("/static", ".").prefer_utf8(true));
2020-09-21 00:18:25 +02:00
//! ```
2020-09-10 15:46:35 +02:00
2021-12-08 07:09:56 +01:00
#![deny(rust_2018_idioms, nonstandard_style)]
#![warn(future_incompatible, missing_docs, missing_debug_implementations)]
2020-09-21 00:18:25 +02:00
use actix_service::boxed::{BoxService, BoxServiceFactory};
use actix_web::{
dev::{RequestHead, ServiceRequest, ServiceResponse},
error::Error,
2020-09-21 00:18:25 +02:00
http::header::DispositionType,
2019-04-01 03:19:18 +02:00
};
use mime_guess::from_ext;
use std::path::Path;
2020-09-21 00:18:25 +02:00
mod chunked;
mod directory;
mod encoding;
mod error;
2020-09-21 00:18:25 +02:00
mod files;
mod named;
2020-09-21 00:18:25 +02:00
mod path_buf;
mod range;
2020-09-21 00:18:25 +02:00
mod service;
pub use self::chunked::ChunkedReadFile;
pub use self::directory::Directory;
pub use self::files::Files;
pub use self::named::NamedFile;
pub use self::range::HttpRange;
pub use self::service::FilesService;
2020-09-21 00:18:25 +02:00
use self::directory::{directory_listing, DirectoryRenderer};
use self::error::FilesError;
use self::path_buf::PathBufWrap;
2019-11-26 06:25:50 +01:00
type HttpService = BoxService<ServiceRequest, ServiceResponse, Error>;
type HttpNewService = BoxServiceFactory<(), ServiceRequest, ServiceResponse, Error, ()>;
/// Return the MIME type associated with a filename extension (case-insensitive).
/// If `ext` is empty or no associated type for the extension was found, returns
/// the type `application/octet-stream`.
#[inline]
pub fn file_extension_to_mime(ext: &str) -> mime::Mime {
from_ext(ext).first_or_octet_stream()
}
2020-09-10 15:46:35 +02:00
type MimeOverride = dyn Fn(&mime::Name<'_>) -> DispositionType;
type PathFilter = dyn Fn(&Path, &RequestHead) -> bool;
#[cfg(test)]
mod tests {
2020-09-21 00:18:25 +02:00
use std::{
fs::{self},
2020-09-21 00:18:25 +02:00
ops::Add,
time::{Duration, SystemTime},
};
2020-09-21 00:18:25 +02:00
use actix_web::{
2022-01-12 18:53:36 +01:00
dev::ServiceFactory,
2020-09-21 00:18:25 +02:00
guard,
http::{
header::{self, ContentDisposition, DispositionParam, DispositionType},
Method, StatusCode,
},
middleware::Compress,
test::{self, TestRequest},
web::{self, Bytes},
App, HttpResponse, Responder,
2019-04-01 19:26:09 +02:00
};
2020-09-21 00:18:25 +02:00
use super::*;
use crate::named::File;
2021-10-19 18:30:32 +02:00
#[actix_web::test]
2019-11-26 06:25:50 +01:00
async fn test_file_extension_to_mime() {
let m = file_extension_to_mime("");
assert_eq!(m, mime::APPLICATION_OCTET_STREAM);
let m = file_extension_to_mime("jpg");
assert_eq!(m, mime::IMAGE_JPEG);
let m = file_extension_to_mime("invalid extension!!");
assert_eq!(m, mime::APPLICATION_OCTET_STREAM);
let m = file_extension_to_mime("");
assert_eq!(m, mime::APPLICATION_OCTET_STREAM);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_if_modified_since_without_if_none_match() {
let file = NamedFile::open_async("Cargo.toml").await.unwrap();
2021-02-12 00:03:17 +01:00
let since = header::HttpDate::from(SystemTime::now().add(Duration::from_secs(60)));
2019-11-26 06:25:50 +01:00
let req = TestRequest::default()
2021-01-15 03:11:10 +01:00
.insert_header((header::IF_MODIFIED_SINCE, since))
2019-11-26 06:25:50 +01:00
.to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::NOT_MODIFIED);
}
#[actix_rt::test]
async fn test_if_modified_since_without_if_none_match_same() {
let file = NamedFile::open_async("Cargo.toml").await.unwrap();
let since = file.last_modified().unwrap();
let req = TestRequest::default()
2021-01-15 03:11:10 +01:00
.insert_header((header::IF_MODIFIED_SINCE, since))
.to_http_request();
let resp = file.respond_to(&req);
assert_eq!(resp.status(), StatusCode::NOT_MODIFIED);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_if_modified_since_with_if_none_match() {
let file = NamedFile::open_async("Cargo.toml").await.unwrap();
2021-02-12 00:03:17 +01:00
let since = header::HttpDate::from(SystemTime::now().add(Duration::from_secs(60)));
2019-11-26 06:25:50 +01:00
let req = TestRequest::default()
2021-01-15 03:11:10 +01:00
.insert_header((header::IF_NONE_MATCH, "miss_etag"))
.insert_header((header::IF_MODIFIED_SINCE, since))
2019-11-26 06:25:50 +01:00
.to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_ne!(resp.status(), StatusCode::NOT_MODIFIED);
}
#[actix_rt::test]
async fn test_if_unmodified_since() {
let file = NamedFile::open_async("Cargo.toml").await.unwrap();
let since = file.last_modified().unwrap();
let req = TestRequest::default()
2021-01-15 03:11:10 +01:00
.insert_header((header::IF_UNMODIFIED_SINCE, since))
.to_http_request();
let resp = file.respond_to(&req);
assert_eq!(resp.status(), StatusCode::OK);
}
#[actix_rt::test]
async fn test_if_unmodified_since_failed() {
let file = NamedFile::open_async("Cargo.toml").await.unwrap();
let since = header::HttpDate::from(SystemTime::UNIX_EPOCH);
let req = TestRequest::default()
2021-01-15 03:11:10 +01:00
.insert_header((header::IF_UNMODIFIED_SINCE, since))
.to_http_request();
let resp = file.respond_to(&req);
assert_eq!(resp.status(), StatusCode::PRECONDITION_FAILED);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_text() {
assert!(NamedFile::open_async("test--").await.is_err());
let mut file = NamedFile::open_async("Cargo.toml").await.unwrap();
2019-11-26 06:25:50 +01:00
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/x-toml"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"Cargo.toml\""
);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_content_disposition() {
assert!(NamedFile::open_async("test--").await.is_err());
let mut file = NamedFile::open_async("Cargo.toml").await.unwrap();
2019-11-26 06:25:50 +01:00
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"Cargo.toml\""
);
let file = NamedFile::open_async("Cargo.toml")
.await
2019-11-26 06:25:50 +01:00
.unwrap()
.disable_content_disposition();
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert!(resp.headers().get(header::CONTENT_DISPOSITION).is_none());
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_non_ascii_file_name() {
let file = {
#[cfg(feature = "experimental-io-uring")]
{
crate::named::File::open("Cargo.toml").await.unwrap()
}
#[cfg(not(feature = "experimental-io-uring"))]
{
crate::named::File::open("Cargo.toml").unwrap()
}
};
let mut file = NamedFile::from_file(file, "貨物.toml").unwrap();
2019-11-26 06:25:50 +01:00
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/x-toml"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"貨物.toml\"; filename*=UTF-8''%E8%B2%A8%E7%89%A9.toml"
);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_set_content_type() {
let mut file = NamedFile::open_async("Cargo.toml")
.await
2019-11-26 06:25:50 +01:00
.unwrap()
.set_content_type(mime::TEXT_XML);
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/xml"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"Cargo.toml\""
);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_image() {
let mut file = NamedFile::open_async("tests/test.png").await.unwrap();
2019-11-26 06:25:50 +01:00
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"image/png"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"test.png\""
);
}
#[actix_rt::test]
async fn test_named_file_javascript() {
let file = NamedFile::open_async("tests/test.js").await.unwrap();
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
2022-01-12 18:53:36 +01:00
"application/javascript; charset=utf-8"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"test.js\""
);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_image_attachment() {
let cd = ContentDisposition {
disposition: DispositionType::Attachment,
parameters: vec![DispositionParam::Filename(String::from("test.png"))],
};
let mut file = NamedFile::open_async("tests/test.png")
.await
2019-11-26 06:25:50 +01:00
.unwrap()
.set_content_disposition(cd);
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"image/png"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"attachment; filename=\"test.png\""
);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_binary() {
let mut file = NamedFile::open_async("tests/test.binary").await.unwrap();
2019-11-26 06:25:50 +01:00
{
file.file();
let _f: &File = &file;
}
{
let _f: &mut File = &mut file;
}
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"application/octet-stream"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"attachment; filename=\"test.binary\""
);
}
2022-03-10 03:54:06 +01:00
#[allow(deprecated)]
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
2022-03-10 03:54:06 +01:00
async fn status_code_customize_same_output() {
let file1 = NamedFile::open_async("Cargo.toml")
.await
2019-11-26 06:25:50 +01:00
.unwrap()
.set_status_code(StatusCode::NOT_FOUND);
2022-03-10 03:54:06 +01:00
let file2 = NamedFile::open_async("Cargo.toml")
.await
.unwrap()
.customize()
.with_status(StatusCode::NOT_FOUND);
let req = TestRequest::default().to_http_request();
let res1 = file1.respond_to(&req);
let res2 = file2.respond_to(&req);
assert_eq!(res1.status(), StatusCode::NOT_FOUND);
assert_eq!(res2.status(), StatusCode::NOT_FOUND);
}
#[actix_rt::test]
async fn test_named_file_status_code_text() {
let mut file = NamedFile::open_async("Cargo.toml").await.unwrap();
2019-11-26 06:25:50 +01:00
{
file.file();
let _f: &File = &file;
}
2022-03-10 03:54:06 +01:00
2019-11-26 06:25:50 +01:00
{
let _f: &mut File = &mut file;
}
2022-03-10 03:54:06 +01:00
let file = file.customize().with_status(StatusCode::NOT_FOUND);
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_http_request();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/x-toml"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"Cargo.toml\""
);
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_mime_override() {
2020-09-10 15:46:35 +02:00
fn all_attachment(_: &mime::Name<'_>) -> DispositionType {
2019-11-26 06:25:50 +01:00
DispositionType::Attachment
}
let srv = test::init_service(
2019-11-26 06:25:50 +01:00
App::new().service(
Files::new("/", ".")
.mime_override(all_attachment)
.index_file("Cargo.toml"),
),
)
.await;
let request = TestRequest::get().uri("/").to_request();
let response = test::call_service(&srv, request).await;
2019-11-26 06:25:50 +01:00
assert_eq!(response.status(), StatusCode::OK);
let content_disposition = response
.headers()
.get(header::CONTENT_DISPOSITION)
.expect("To have CONTENT_DISPOSITION");
let content_disposition = content_disposition
.to_str()
.expect("Convert CONTENT_DISPOSITION to str");
assert_eq!(content_disposition, "attachment; filename=\"Cargo.toml\"");
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_ranges_status_code() {
let srv = test::init_service(
2019-11-26 06:25:50 +01:00
App::new().service(Files::new("/test", ".").index_file("Cargo.toml")),
)
.await;
// Valid range header
let request = TestRequest::get()
.uri("/t%65st/Cargo.toml")
2021-01-15 03:11:10 +01:00
.insert_header((header::RANGE, "bytes=10-20"))
2019-11-26 06:25:50 +01:00
.to_request();
let response = test::call_service(&srv, request).await;
2019-11-26 06:25:50 +01:00
assert_eq!(response.status(), StatusCode::PARTIAL_CONTENT);
// Invalid range header
let request = TestRequest::get()
.uri("/t%65st/Cargo.toml")
2021-01-15 03:11:10 +01:00
.insert_header((header::RANGE, "bytes=1-0"))
2019-11-26 06:25:50 +01:00
.to_request();
let response = test::call_service(&srv, request).await;
2019-11-26 06:25:50 +01:00
assert_eq!(response.status(), StatusCode::RANGE_NOT_SATISFIABLE);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_content_range_headers() {
let srv = actix_test::start(|| App::new().service(Files::new("/", ".")));
2019-11-26 06:25:50 +01:00
// Valid range header
let response = srv
.get("/tests/test.binary")
2021-01-15 03:11:10 +01:00
.insert_header((header::RANGE, "bytes=10-20"))
.send()
.await
2019-11-26 06:25:50 +01:00
.unwrap();
let content_range = response.headers().get(header::CONTENT_RANGE).unwrap();
assert_eq!(content_range.to_str().unwrap(), "bytes 10-20/100");
2019-11-26 06:25:50 +01:00
// Invalid range header
let response = srv
.get("/tests/test.binary")
2021-01-15 03:11:10 +01:00
.insert_header((header::RANGE, "bytes=10-5"))
.send()
.await
2019-11-26 06:25:50 +01:00
.unwrap();
let content_range = response.headers().get(header::CONTENT_RANGE).unwrap();
assert_eq!(content_range.to_str().unwrap(), "bytes */100");
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_content_length_headers() {
let srv = actix_test::start(|| App::new().service(Files::new("/", ".")));
2019-11-26 06:25:50 +01:00
// Valid range header
let response = srv
.get("/tests/test.binary")
2021-01-15 03:11:10 +01:00
.insert_header((header::RANGE, "bytes=10-20"))
.send()
.await
.unwrap();
let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();
assert_eq!(content_length.to_str().unwrap(), "11");
// Valid range header, starting from 0
let response = srv
.get("/tests/test.binary")
2021-01-15 03:11:10 +01:00
.insert_header((header::RANGE, "bytes=0-20"))
.send()
.await
.unwrap();
let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();
assert_eq!(content_length.to_str().unwrap(), "21");
2019-11-26 06:25:50 +01:00
// Without range header
let mut response = srv.get("/tests/test.binary").send().await.unwrap();
let content_length = response.headers().get(header::CONTENT_LENGTH).unwrap();
assert_eq!(content_length.to_str().unwrap(), "100");
2019-11-26 06:25:50 +01:00
// Should be no transfer-encoding
let transfer_encoding = response.headers().get(header::TRANSFER_ENCODING);
assert!(transfer_encoding.is_none());
2019-11-26 06:25:50 +01:00
// Check file contents
let bytes = response.body().await.unwrap();
2020-09-21 00:18:25 +02:00
let data = web::Bytes::from(fs::read("tests/test.binary").unwrap());
2019-11-26 06:25:50 +01:00
assert_eq!(bytes, data);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_head_content_length_headers() {
let srv = actix_test::start(|| App::new().service(Files::new("/", ".")));
let response = srv.head("/tests/test.binary").send().await.unwrap();
2019-11-26 06:25:50 +01:00
let content_length = response
.headers()
.get(header::CONTENT_LENGTH)
.unwrap()
.to_str()
.unwrap();
assert_eq!(content_length, "100");
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_static_files_with_spaces() {
let srv = test::init_service(
2019-11-26 06:25:50 +01:00
App::new().service(Files::new("/", ".").index_file("Cargo.toml")),
)
.await;
let request = TestRequest::get()
.uri("/tests/test%20space.binary")
.to_request();
let response = test::call_service(&srv, request).await;
2019-11-26 06:25:50 +01:00
assert_eq!(response.status(), StatusCode::OK);
let bytes = test::read_body(response).await;
2020-09-21 00:18:25 +02:00
let data = web::Bytes::from(fs::read("tests/test space.binary").unwrap());
2019-11-26 06:25:50 +01:00
assert_eq!(bytes, data);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_files_not_allowed() {
let srv = test::init_service(App::new().service(Files::new("/", "."))).await;
2019-11-26 06:25:50 +01:00
let req = TestRequest::default()
.uri("/Cargo.toml")
.method(Method::POST)
.to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
let srv = test::init_service(App::new().service(Files::new("/", "."))).await;
2019-11-26 06:25:50 +01:00
let req = TestRequest::default()
.method(Method::PUT)
.uri("/Cargo.toml")
.to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_files_guards() {
let srv = test::init_service(
App::new().service(Files::new("/", ".").method_guard(guard::Post())),
2019-11-26 06:25:50 +01:00
)
.await;
let req = TestRequest::default()
.uri("/Cargo.toml")
.method(Method::POST)
.to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::OK);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_content_encoding() {
let srv = test::init_service(App::new().wrap(Compress::default()).service(
web::resource("/").to(|| async {
NamedFile::open_async("Cargo.toml")
.await
.unwrap()
.set_content_encoding(header::ContentEncoding::Identity)
2019-11-26 06:25:50 +01:00
}),
))
.await;
let request = TestRequest::get()
.uri("/")
2021-01-15 03:11:10 +01:00
.insert_header((header::ACCEPT_ENCODING, "gzip"))
2019-11-26 06:25:50 +01:00
.to_request();
let res = test::call_service(&srv, request).await;
2019-11-26 06:25:50 +01:00
assert_eq!(res.status(), StatusCode::OK);
2022-01-03 19:46:04 +01:00
assert!(res.headers().contains_key(header::CONTENT_ENCODING));
assert!(!test::read_body(res).await.is_empty());
2019-04-04 23:00:56 +02:00
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_content_encoding_gzip() {
let srv = test::init_service(App::new().wrap(Compress::default()).service(
web::resource("/").to(|| async {
NamedFile::open_async("Cargo.toml")
.await
.unwrap()
.set_content_encoding(header::ContentEncoding::Gzip)
2019-11-26 06:25:50 +01:00
}),
))
.await;
let request = TestRequest::get()
.uri("/")
2021-01-15 03:11:10 +01:00
.insert_header((header::ACCEPT_ENCODING, "gzip"))
2019-11-26 06:25:50 +01:00
.to_request();
let res = test::call_service(&srv, request).await;
2019-11-26 06:25:50 +01:00
assert_eq!(res.status(), StatusCode::OK);
assert_eq!(
res.headers()
.get(header::CONTENT_ENCODING)
.unwrap()
.to_str()
.unwrap(),
"gzip"
);
2019-04-01 03:19:18 +02:00
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_named_file_allowed_method() {
let req = TestRequest::default().method(Method::GET).to_http_request();
let file = NamedFile::open_async("Cargo.toml").await.unwrap();
let resp = file.respond_to(&req);
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::OK);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_static_files() {
2021-02-12 00:03:17 +01:00
let srv =
test::init_service(App::new().service(Files::new("/", ".").show_files_listing()))
.await;
2019-11-26 06:25:50 +01:00
let req = TestRequest::with_uri("/missing").to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
let srv = test::init_service(App::new().service(Files::new("/", "."))).await;
2019-11-26 06:25:50 +01:00
let req = TestRequest::default().to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
2021-02-12 00:03:17 +01:00
let srv =
test::init_service(App::new().service(Files::new("/", ".").show_files_listing()))
.await;
2019-11-26 06:25:50 +01:00
let req = TestRequest::with_uri("/tests").to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/html; charset=utf-8"
);
2019-11-21 06:31:31 +01:00
2019-11-26 06:25:50 +01:00
let bytes = test::read_body(resp).await;
assert!(format!("{:?}", bytes).contains("/tests/test.png"));
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_redirect_to_slash_directory() {
// should not redirect if no index and files listing is disabled
let srv = test::init_service(
2019-11-26 06:25:50 +01:00
App::new().service(Files::new("/", ".").redirect_to_slash_directory()),
)
.await;
let req = TestRequest::with_uri("/tests").to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
// should redirect if index present
let srv = test::init_service(
2019-11-26 06:25:50 +01:00
App::new().service(
Files::new("/", ".")
.index_file("test.png")
.redirect_to_slash_directory(),
),
)
.await;
let req = TestRequest::with_uri("/tests").to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::FOUND);
// should redirect if files listing is enabled
let srv = test::init_service(
App::new().service(
Files::new("/", ".")
.show_files_listing()
.redirect_to_slash_directory(),
),
)
.await;
let req = TestRequest::with_uri("/tests").to_request();
let resp = test::call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::FOUND);
2019-11-26 06:25:50 +01:00
// should not redirect if the path is wrong
let req = TestRequest::with_uri("/not_existing").to_request();
let resp = test::call_service(&srv, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_static_files_bad_directory() {
let service = Files::new("/", "./missing").new_service(()).await.unwrap();
let req = TestRequest::with_uri("/").to_srv_request();
let resp = test::call_service(&service, req).await;
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
2019-11-26 06:25:50 +01:00
#[actix_rt::test]
async fn test_default_handler_file_missing() {
let st = Files::new("/", ".")
.default_handler(|req: ServiceRequest| async {
Ok(req.into_response(HttpResponse::Ok().body("default content")))
2019-11-26 06:25:50 +01:00
})
2019-12-02 16:37:13 +01:00
.new_service(())
2019-11-26 06:25:50 +01:00
.await
.unwrap();
let req = TestRequest::with_uri("/missing").to_srv_request();
let resp = test::call_service(&st, req).await;
2019-11-26 06:25:50 +01:00
assert_eq!(resp.status(), StatusCode::OK);
let bytes = test::read_body(resp).await;
2020-09-21 00:18:25 +02:00
assert_eq!(bytes, web::Bytes::from_static(b"default content"));
2019-04-01 03:19:18 +02:00
}
#[actix_rt::test]
async fn test_serve_index_nested() {
let service = Files::new(".", ".")
.index_file("lib.rs")
.new_service(())
.await
.unwrap();
let req = TestRequest::default().uri("/src").to_srv_request();
let resp = test::call_service(&service, req).await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/x-rust"
);
assert_eq!(
resp.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"lib.rs\""
);
}
#[actix_rt::test]
async fn integration_serve_index() {
let srv = test::init_service(
App::new().service(Files::new("test", ".").index_file("Cargo.toml")),
)
.await;
let req = TestRequest::get().uri("/test").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
let bytes = test::read_body(res).await;
let data = Bytes::from(fs::read("Cargo.toml").unwrap());
assert_eq!(bytes, data);
let req = TestRequest::get().uri("/test/").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
let bytes = test::read_body(res).await;
let data = Bytes::from(fs::read("Cargo.toml").unwrap());
assert_eq!(bytes, data);
// nonexistent index file
let req = TestRequest::get().uri("/test/unknown").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);
let req = TestRequest::get().uri("/test/unknown/").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);
}
#[actix_rt::test]
async fn integration_percent_encoded() {
let srv = test::init_service(
App::new().service(Files::new("test", ".").index_file("Cargo.toml")),
)
.await;
let req = TestRequest::get().uri("/test/%43argo.toml").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
// `%2F` == `/`
let req = TestRequest::get().uri("/test%2Ftest.binary").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);
let req = TestRequest::get().uri("/test/Cargo.toml%00").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);
}
#[actix_rt::test]
async fn test_percent_encoding_2() {
let tmpdir = tempfile::tempdir().unwrap();
let filename = match cfg!(unix) {
true => "ض:?#[]{}<>()@!$&'`|*+,;= %20.test",
false => "ض#[]{}()@!$&'`+,;= %20.test",
};
let filename_encoded = filename
.as_bytes()
.iter()
.map(|c| format!("%{:02X}", c))
.collect::<String>();
std::fs::File::create(tmpdir.path().join(filename)).unwrap();
let srv = test::init_service(App::new().service(Files::new("", tmpdir.path()))).await;
let req = TestRequest::get()
.uri(&format!("/{}", filename_encoded))
.to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
}
2021-04-19 00:34:51 +02:00
#[actix_rt::test]
async fn test_serve_named_file() {
let factory = NamedFile::open_async("Cargo.toml").await.unwrap();
let srv = test::init_service(App::new().service(factory)).await;
2021-04-19 00:34:51 +02:00
let req = TestRequest::get().uri("/Cargo.toml").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
let bytes = test::read_body(res).await;
let data = Bytes::from(fs::read("Cargo.toml").unwrap());
assert_eq!(bytes, data);
let req = TestRequest::get().uri("/test/unknown").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);
}
#[actix_rt::test]
async fn test_serve_named_file_prefix() {
let factory = NamedFile::open_async("Cargo.toml").await.unwrap();
let srv =
test::init_service(App::new().service(web::scope("/test").service(factory))).await;
2021-04-19 00:34:51 +02:00
let req = TestRequest::get().uri("/test/Cargo.toml").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
let bytes = test::read_body(res).await;
let data = Bytes::from(fs::read("Cargo.toml").unwrap());
assert_eq!(bytes, data);
let req = TestRequest::get().uri("/Cargo.toml").to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);
}
#[actix_rt::test]
async fn test_named_file_default_service() {
let factory = NamedFile::open_async("Cargo.toml").await.unwrap();
let srv = test::init_service(App::new().default_service(factory)).await;
2021-04-19 00:34:51 +02:00
for route in ["/foobar", "/baz", "/"].iter() {
let req = TestRequest::get().uri(route).to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
let bytes = test::read_body(res).await;
let data = Bytes::from(fs::read("Cargo.toml").unwrap());
assert_eq!(bytes, data);
}
}
#[actix_rt::test]
async fn test_default_handler_named_file() {
let factory = NamedFile::open_async("Cargo.toml").await.unwrap();
2021-04-19 00:34:51 +02:00
let st = Files::new("/", ".")
.default_handler(factory)
2021-04-19 00:34:51 +02:00
.new_service(())
.await
.unwrap();
let req = TestRequest::with_uri("/missing").to_srv_request();
let resp = test::call_service(&st, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let bytes = test::read_body(resp).await;
let data = Bytes::from(fs::read("Cargo.toml").unwrap());
assert_eq!(bytes, data);
}
#[actix_rt::test]
async fn test_symlinks() {
let srv = test::init_service(App::new().service(Files::new("test", "."))).await;
let req = TestRequest::get()
.uri("/test/tests/symlink-test.png")
.to_request();
let res = test::call_service(&srv, req).await;
assert_eq!(res.status(), StatusCode::OK);
assert_eq!(
res.headers().get(header::CONTENT_DISPOSITION).unwrap(),
"inline; filename=\"symlink-test.png\""
);
}
#[actix_rt::test]
async fn test_index_with_show_files_listing() {
let service = Files::new(".", ".")
.index_file("lib.rs")
.show_files_listing()
.new_service(())
.await
.unwrap();
// Serve the index if exists
let req = TestRequest::default().uri("/src").to_srv_request();
let resp = test::call_service(&service, req).await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/x-rust"
);
// Show files listing, otherwise.
let req = TestRequest::default().uri("/tests").to_srv_request();
let resp = test::call_service(&service, req).await;
assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(),
"text/html; charset=utf-8"
);
let bytes = test::read_body(resp).await;
assert!(format!("{:?}", bytes).contains("/tests/test.png"));
}
#[actix_rt::test]
async fn test_path_filter() {
// prevent searching subdirectories
let st = Files::new("/", ".")
.path_filter(|path, _| path.components().count() == 1)
.new_service(())
.await
.unwrap();
let req = TestRequest::with_uri("/Cargo.toml").to_srv_request();
let resp = test::call_service(&st, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/src/lib.rs").to_srv_request();
let resp = test::call_service(&st, req).await;
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
#[actix_rt::test]
async fn test_default_handler_filter() {
let st = Files::new("/", ".")
.default_handler(|req: ServiceRequest| async {
Ok(req.into_response(HttpResponse::Ok().body("default content")))
})
.path_filter(|path, _| path.extension() == Some("png".as_ref()))
.new_service(())
.await
.unwrap();
let req = TestRequest::with_uri("/Cargo.toml").to_srv_request();
let resp = test::call_service(&st, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let bytes = test::read_body(resp).await;
assert_eq!(bytes, web::Bytes::from_static(b"default content"));
}
}