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

static_web_server/
handler.rs
