static_web_server/
handler.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2// This file is part of Static Web Server.
3// See https://static-web-server.net/ for more information
4// Copyright (C) 2019-present Jose Quintana <joseluisq.net>
5
6//! Request handler module intended to manage incoming HTTP requests.
7//!
8
9use hyper::{Body, Request, Response, StatusCode};
10use std::{
11    future::Future,
12    net::{IpAddr, SocketAddr},
13    path::PathBuf,
14    sync::Arc,
15};
16
17#[cfg(any(
18    feature = "compression",
19    feature = "compression-gzip",
20    feature = "compression-brotli",
21    feature = "compression-zstd",
22    feature = "compression-deflate"
23))]
24use crate::compression;
25
26use crate::compression_static;
27
28#[cfg(feature = "basic-auth")]
29use crate::basic_auth;
30
31#[cfg(feature = "fallback-page")]
32use crate::fallback_page;
33
34#[cfg(all(unix, feature = "experimental"))]
35use crate::metrics;
36
37#[cfg(feature = "experimental")]
38use crate::mem_cache::cache::MemCacheOpts;
39
40use crate::{
41    Error, Result, control_headers, cors, custom_headers, error_page, health,
42    http_ext::MethodExt,
43    log_addr, maintenance_mode, redirects, rewrites, security_headers,
44    settings::Advanced,
45    static_files::{self, HandleOpts},
46    virtual_hosts,
47};
48
49#[cfg(feature = "directory-listing")]
50use crate::directory_listing::DirListFmt;
51
52#[cfg(feature = "directory-listing-download")]
53use crate::directory_listing_download::DirDownloadFmt;
54
55/// It defines options for a request handler.
56pub struct RequestHandlerOpts {
57    // General options
58    /// Root directory of static files.
59    pub root_dir: PathBuf,
60    #[cfg(feature = "experimental")]
61    /// In-memory cache feature (experimental).
62    pub memory_cache: Option<MemCacheOpts>,
63    /// Compression feature.
64    pub compression: bool,
65    #[cfg(any(
66        feature = "compression",
67        feature = "compression-gzip",
68        feature = "compression-brotli",
69        feature = "compression-zstd",
70        feature = "compression-deflate"
71    ))]
72    /// Compression level.
73    pub compression_level: crate::settings::CompressionLevel,
74    /// Compression static feature.
75    pub compression_static: bool,
76    /// Directory listing feature.
77    #[cfg(feature = "directory-listing")]
78    #[cfg_attr(docsrs, doc(cfg(feature = "directory-listing")))]
79    pub dir_listing: bool,
80    /// Directory listing order feature.
81    #[cfg(feature = "directory-listing")]
82    #[cfg_attr(docsrs, doc(cfg(feature = "directory-listing")))]
83    pub dir_listing_order: u8,
84    #[cfg(feature = "directory-listing")]
85    #[cfg_attr(docsrs, doc(cfg(feature = "directory-listing")))]
86    /// Directory listing format feature.
87    pub dir_listing_format: DirListFmt,
88    /// Directory listing download feature.
89    #[cfg(feature = "directory-listing-download")]
90    #[cfg_attr(docsrs, doc(cfg(feature = "directory-listing-download")))]
91    pub dir_listing_download: Vec<DirDownloadFmt>,
92    /// CORS feature.
93    pub cors: Option<cors::Configured>,
94    /// Security headers feature.
95    pub security_headers: bool,
96    /// Cache control headers feature.
97    pub cache_control_headers: bool,
98    /// Page for 404 errors.
99    pub page404: PathBuf,
100    /// Page for 50x errors.
101    pub page50x: PathBuf,
102    /// Page fallback feature.
103    #[cfg(feature = "fallback-page")]
104    #[cfg_attr(docsrs, doc(cfg(feature = "fallback-page")))]
105    pub page_fallback: Vec<u8>,
106    /// Basic auth feature.
107    #[cfg(feature = "basic-auth")]
108    #[cfg_attr(docsrs, doc(cfg(feature = "basic-auth")))]
109    pub basic_auth: String,
110    /// Index files feature.
111    pub index_files: Vec<String>,
112    /// Log remote address feature.
113    pub log_remote_address: bool,
114    /// Log the X-Real-IP header.
115    pub log_x_real_ip: bool,
116    /// Log the X-Forwarded-For header.
117    pub log_forwarded_for: bool,
118    /// Trusted IPs for remote addresses.
119    pub trusted_proxies: Vec<IpAddr>,
120    /// Redirect trailing slash feature.
121    pub redirect_trailing_slash: bool,
122    /// Ignore hidden files feature.
123    pub ignore_hidden_files: bool,
124    /// Prevent following symlinks for files and directories.
125    pub disable_symlinks: bool,
126    /// Accept markdown content negotiation feature.
127    pub accept_markdown: bool,
128    /// Health endpoint feature.
129    pub health: bool,
130    /// Metrics endpoint feature (experimental).
131    #[cfg(all(unix, feature = "experimental"))]
132    pub experimental_metrics: bool,
133    /// Maintenance mode feature.
134    pub maintenance_mode: bool,
135    /// Custom HTTP status for when entering into maintenance mode.
136    pub maintenance_mode_status: StatusCode,
137    /// Custom maintenance mode HTML file.
138    pub maintenance_mode_file: PathBuf,
139
140    /// Advanced options from the config file.
141    pub advanced_opts: Option<Advanced>,
142}
143
144impl Default for RequestHandlerOpts {
145    fn default() -> Self {
146        Self {
147            root_dir: PathBuf::from("./public"),
148            compression: true,
149            compression_static: false,
150            #[cfg(any(
151                feature = "compression",
152                feature = "compression-gzip",
153                feature = "compression-brotli",
154                feature = "compression-zstd",
155                feature = "compression-deflate"
156            ))]
157            compression_level: crate::settings::CompressionLevel::Default,
158            #[cfg(feature = "directory-listing")]
159            dir_listing: false,
160            #[cfg(feature = "directory-listing")]
161            dir_listing_order: 6, // unordered
162            #[cfg(feature = "directory-listing")]
163            dir_listing_format: DirListFmt::Html,
164            #[cfg(feature = "directory-listing-download")]
165            dir_listing_download: Vec::new(),
166            cors: None,
167            #[cfg(feature = "experimental")]
168            memory_cache: None,
169            security_headers: false,
170            cache_control_headers: true,
171            page404: PathBuf::from("./404.html"),
172            page50x: PathBuf::from("./50x.html"),
173            #[cfg(feature = "fallback-page")]
174            page_fallback: Vec::new(),
175            #[cfg(feature = "basic-auth")]
176            basic_auth: String::new(),
177            index_files: vec!["index.html".into()],
178            log_remote_address: false,
179            log_x_real_ip: false,
180            log_forwarded_for: false,
181            trusted_proxies: Vec::new(),
182            redirect_trailing_slash: true,
183            ignore_hidden_files: false,
184            disable_symlinks: false,
185            accept_markdown: false,
186            health: false,
187            #[cfg(all(unix, feature = "experimental"))]
188            experimental_metrics: false,
189            maintenance_mode: false,
190            maintenance_mode_status: StatusCode::SERVICE_UNAVAILABLE,
191            maintenance_mode_file: PathBuf::new(),
192            advanced_opts: None,
193        }
194    }
195}
196
197/// It defines the main request handler used by the Hyper service request.
198pub struct RequestHandler {
199    /// Request handler options.
200    pub opts: Arc<RequestHandlerOpts>,
201}
202
203impl RequestHandler {
204    /// Main entry point for incoming requests.
205    pub fn handle<'a>(
206        &'a self,
207        req: &'a mut Request<Body>,
208        remote_addr: Option<SocketAddr>,
209    ) -> impl Future<Output = Result<Response<Body>, Error>> + Send + 'a {
210        let mut base_path = &self.opts.root_dir;
211        #[cfg(feature = "directory-listing")]
212        let dir_listing = self.opts.dir_listing;
213        #[cfg(feature = "directory-listing")]
214        let dir_listing_order = self.opts.dir_listing_order;
215        #[cfg(feature = "directory-listing")]
216        let dir_listing_format = &self.opts.dir_listing_format;
217        #[cfg(feature = "directory-listing-download")]
218        let dir_listing_download = &self.opts.dir_listing_download;
219        let redirect_trailing_slash = self.opts.redirect_trailing_slash;
220        let compression_static = self.opts.compression_static;
221        let ignore_hidden_files = self.opts.ignore_hidden_files;
222        let disable_symlinks = self.opts.disable_symlinks;
223        let index_files: Vec<&str> = self.opts.index_files.iter().map(|s| s.as_str()).collect();
224        #[cfg(feature = "experimental")]
225        let memory_cache = self.opts.memory_cache.as_ref();
226
227        log_addr::pre_process(&self.opts, req, remote_addr);
228
229        async move {
230            // Reject if the HTTP request method is not allowed
231            if !req.method().is_allowed() {
232                return error_page::error_response(
233                    req.uri(),
234                    req.method(),
235                    &StatusCode::METHOD_NOT_ALLOWED,
236                    &self.opts.page404,
237                    &self.opts.page50x,
238                );
239            }
240
241            // Health endpoint check
242            if let Some(result) = health::pre_process(&self.opts, req) {
243                return result;
244            }
245
246            // Metrics endpoint check
247            #[cfg(all(unix, feature = "experimental"))]
248            if let Some(result) = metrics::pre_process(&self.opts, req) {
249                return result;
250            }
251
252            // CORS
253            if let Some(result) = cors::pre_process(&self.opts, req) {
254                return result;
255            }
256
257            // `Basic` HTTP Authorization Schema
258            #[cfg(feature = "basic-auth")]
259            if let Some(response) = basic_auth::pre_process(&self.opts, req) {
260                return response;
261            }
262
263            // Maintenance Mode
264            if let Some(response) = maintenance_mode::pre_process(&self.opts, req) {
265                return response;
266            }
267
268            // Redirects
269            if let Some(result) = redirects::pre_process(&self.opts, req) {
270                return result;
271            }
272
273            // Rewrites
274            if let Some(result) = rewrites::pre_process(&self.opts, req) {
275                return result;
276            }
277
278            // Advanced options
279            if let Some(advanced) = &self.opts.advanced_opts {
280                // If the "Host" header matches any virtual_host, change the root directory
281                if let Some(root) =
282                    virtual_hosts::get_real_root(req, advanced.virtual_hosts.as_deref())
283                {
284                    base_path = root;
285                }
286            }
287
288            let index_files = index_files.as_ref();
289
290            // Check for markdown content negotiation (only if enabled)
291            let uri_path_md = if self.opts.accept_markdown {
292                crate::markdown::pre_process(req, base_path, req.uri().path())
293            } else {
294                None
295            };
296            let uri_path = uri_path_md.as_deref().unwrap_or(req.uri().path());
297
298            // Static files
299            let (resp, file_path) = match static_files::handle(&HandleOpts {
300                method: req.method(),
301                headers: req.headers(),
302                #[cfg(feature = "experimental")]
303                memory_cache,
304                base_path,
305                uri_path,
306                uri_query: req.uri().query(),
307                #[cfg(feature = "directory-listing")]
308                dir_listing,
309                #[cfg(feature = "directory-listing")]
310                dir_listing_order,
311                #[cfg(feature = "directory-listing")]
312                dir_listing_format,
313                #[cfg(feature = "directory-listing-download")]
314                dir_listing_download,
315                redirect_trailing_slash,
316                compression_static,
317                ignore_hidden_files,
318                index_files,
319                disable_symlinks,
320            })
321            .await
322            {
323                Ok(result) => (result.resp, Some(result.file_path)),
324                Err(status) => (
325                    error_page::error_response(
326                        req.uri(),
327                        req.method(),
328                        &status,
329                        &self.opts.page404,
330                        &self.opts.page50x,
331                    )?,
332                    None,
333                ),
334            };
335
336            // Check for a fallback response
337            #[cfg(feature = "fallback-page")]
338            let resp = fallback_page::post_process(&self.opts, req, resp)?;
339
340            // Append CORS headers if they are present
341            let resp = cors::post_process(&self.opts, req, resp)?;
342
343            // Set Content-Type for markdown files
344            let resp = crate::markdown::post_process(uri_path_md.is_some(), &self.opts, resp)?;
345
346            // Add a `Vary` header if static compression is used
347            let resp = compression_static::post_process(&self.opts, req, resp)?;
348
349            // Auto compression based on the `Accept-Encoding` header
350            #[cfg(any(
351                feature = "compression",
352                feature = "compression-gzip",
353                feature = "compression-brotli",
354                feature = "compression-zstd",
355                feature = "compression-deflate"
356            ))]
357            let resp = compression::post_process(&self.opts, req, resp)?;
358
359            // Append `Cache-Control` headers for web assets
360            let resp = control_headers::post_process(&self.opts, req, resp)?;
361
362            // Append security headers
363            let resp = security_headers::post_process(&self.opts, req, resp)?;
364
365            // Add/update custom headers
366            let resp = custom_headers::post_process(&self.opts, req, resp, file_path.as_ref())?;
367
368            Ok(resp)
369        }
370    }
371}
static_web_server/handler.rs

static_web_server/
handler.rs
