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(feature = "metrics")]
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    text_charset, 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    /// Default `charset=utf-8` parameter applied to certain `text` responses without one.
129    pub text_charset: bool,
130    /// Health endpoint feature.
131    pub health: bool,
132    /// Metrics endpoint feature.
133    #[cfg(feature = "metrics")]
134    pub metrics_enabled: bool,
135    /// Maintenance mode feature.
136    pub maintenance_mode: bool,
137    /// Custom HTTP status for when entering into maintenance mode.
138    pub maintenance_mode_status: StatusCode,
139    /// Custom maintenance mode HTML file.
140    pub maintenance_mode_file: PathBuf,
141
142    /// Advanced options from the config file.
143    pub advanced_opts: Option<Advanced>,
144}
145
146impl Default for RequestHandlerOpts {
147    fn default() -> Self {
148        Self {
149            root_dir: PathBuf::from("./public"),
150            compression: true,
151            compression_static: false,
152            #[cfg(any(
153                feature = "compression",
154                feature = "compression-gzip",
155                feature = "compression-brotli",
156                feature = "compression-zstd",
157                feature = "compression-deflate"
158            ))]
159            compression_level: crate::settings::CompressionLevel::Default,
160            #[cfg(feature = "directory-listing")]
161            dir_listing: false,
162            #[cfg(feature = "directory-listing")]
163            dir_listing_order: 6, // unordered
164            #[cfg(feature = "directory-listing")]
165            dir_listing_format: DirListFmt::Html,
166            #[cfg(feature = "directory-listing-download")]
167            dir_listing_download: Vec::new(),
168            cors: None,
169            #[cfg(feature = "experimental")]
170            memory_cache: None,
171            security_headers: false,
172            cache_control_headers: true,
173            page404: PathBuf::from("./404.html"),
174            page50x: PathBuf::from("./50x.html"),
175            #[cfg(feature = "fallback-page")]
176            page_fallback: Vec::new(),
177            #[cfg(feature = "basic-auth")]
178            basic_auth: String::new(),
179            index_files: vec!["index.html".into()],
180            log_remote_address: false,
181            log_x_real_ip: false,
182            log_forwarded_for: false,
183            trusted_proxies: Vec::new(),
184            redirect_trailing_slash: true,
185            ignore_hidden_files: false,
186            disable_symlinks: false,
187            accept_markdown: false,
188            text_charset: true,
189            health: false,
190            #[cfg(feature = "metrics")]
191            metrics_enabled: false,
192            maintenance_mode: false,
193            maintenance_mode_status: StatusCode::SERVICE_UNAVAILABLE,
194            maintenance_mode_file: PathBuf::new(),
195            advanced_opts: None,
196        }
197    }
198}
199
200/// It defines the main request handler used by the Hyper service request.
201pub struct RequestHandler {
202    /// Request handler options.
203    pub opts: Arc<RequestHandlerOpts>,
204}
205
206impl RequestHandler {
207    /// Main entry point for incoming requests.
208    pub fn handle<'a>(
209        &'a self,
210        req: &'a mut Request<Body>,
211        remote_addr: Option<SocketAddr>,
212    ) -> impl Future<Output = Result<Response<Body>, Error>> + Send + 'a {
213        let mut base_path = &self.opts.root_dir;
214        #[cfg(feature = "directory-listing")]
215        let dir_listing = self.opts.dir_listing;
216        #[cfg(feature = "directory-listing")]
217        let dir_listing_order = self.opts.dir_listing_order;
218        #[cfg(feature = "directory-listing")]
219        let dir_listing_format = &self.opts.dir_listing_format;
220        #[cfg(feature = "directory-listing-download")]
221        let dir_listing_download = &self.opts.dir_listing_download;
222        let redirect_trailing_slash = self.opts.redirect_trailing_slash;
223        let compression_static = self.opts.compression_static;
224        let ignore_hidden_files = self.opts.ignore_hidden_files;
225        let disable_symlinks = self.opts.disable_symlinks;
226        let index_files: Vec<&str> = self.opts.index_files.iter().map(|s| s.as_str()).collect();
227        #[cfg(feature = "experimental")]
228        let memory_cache = self.opts.memory_cache.as_ref();
229
230        log_addr::pre_process(&self.opts, req, remote_addr);
231
232        async move {
233            #[cfg(feature = "metrics")]
234            let req_start = std::time::Instant::now();
235            #[cfg(feature = "metrics")]
236            let metrics_enabled = self.opts.metrics_enabled;
237
238            #[cfg(feature = "metrics")]
239            if metrics_enabled {
240                metrics::inc_requests_inflight();
241            }
242
243            let result: Result<Response<Body>, Error> = async {
244                // Reject if the HTTP request method is not allowed
245                if !req.method().is_allowed() {
246                    return error_page::error_response(
247                        req.uri(),
248                        req.method(),
249                        &StatusCode::METHOD_NOT_ALLOWED,
250                        &self.opts.page404,
251                        &self.opts.page50x,
252                    );
253                }
254
255                // Health endpoint check
256                if let Some(result) = health::pre_process(&self.opts, req) {
257                    return result;
258                }
259
260                // Metrics endpoint check
261                #[cfg(feature = "metrics")]
262                if let Some(result) = metrics::pre_process(&self.opts, req) {
263                    return result;
264                }
265
266                // CORS
267                if let Some(result) = cors::pre_process(&self.opts, req) {
268                    return result;
269                }
270
271                // `Basic` HTTP Authorization Schema
272                #[cfg(feature = "basic-auth")]
273                if let Some(response) = basic_auth::pre_process(&self.opts, req) {
274                    return response;
275                }
276
277                // Maintenance Mode
278                if let Some(response) = maintenance_mode::pre_process(&self.opts, req) {
279                    return response;
280                }
281
282                // Redirects
283                if let Some(result) = redirects::pre_process(&self.opts, req) {
284                    return result;
285                }
286
287                // Rewrites
288                if let Some(result) = rewrites::pre_process(&self.opts, req) {
289                    return result;
290                }
291
292                // Advanced options
293                if let Some(advanced) = &self.opts.advanced_opts {
294                    // If the "Host" header matches any virtual_host, change the root directory
295                    if let Some(root) =
296                        virtual_hosts::get_real_root(req, advanced.virtual_hosts.as_deref())
297                    {
298                        base_path = root;
299                    }
300                }
301
302                let index_files = index_files.as_ref();
303
304                // Check for markdown content negotiation (only if enabled)
305                let uri_path_md = if self.opts.accept_markdown {
306                    crate::markdown::pre_process(req, base_path, req.uri().path())
307                } else {
308                    None
309                };
310                let uri_path = uri_path_md.as_deref().unwrap_or(req.uri().path());
311
312                // Static files
313                let (resp, file_path) = match static_files::handle(&HandleOpts {
314                    method: req.method(),
315                    headers: req.headers(),
316                    #[cfg(feature = "experimental")]
317                    memory_cache,
318                    base_path,
319                    uri_path,
320                    uri_query: req.uri().query(),
321                    #[cfg(feature = "directory-listing")]
322                    dir_listing,
323                    #[cfg(feature = "directory-listing")]
324                    dir_listing_order,
325                    #[cfg(feature = "directory-listing")]
326                    dir_listing_format,
327                    #[cfg(feature = "directory-listing-download")]
328                    dir_listing_download,
329                    redirect_trailing_slash,
330                    compression_static,
331                    ignore_hidden_files,
332                    index_files,
333                    disable_symlinks,
334                })
335                .await
336                {
337                    Ok(result) => (result.resp, Some(result.file_path)),
338                    Err(status) => (
339                        error_page::error_response(
340                            req.uri(),
341                            req.method(),
342                            &status,
343                            &self.opts.page404,
344                            &self.opts.page50x,
345                        )?,
346                        None,
347                    ),
348                };
349
350                // Check for a fallback response
351                #[cfg(feature = "fallback-page")]
352                let resp = fallback_page::post_process(&self.opts, req, resp)?;
353
354                // Append CORS headers if they are present
355                let resp = cors::post_process(&self.opts, req, resp)?;
356
357                // Set Content-Type for markdown files
358                let resp = crate::markdown::post_process(uri_path_md.is_some(), &self.opts, resp)?;
359
360                // Declare a default charset for `text/*` responses
361                let resp = text_charset::post_process(&self.opts, resp)?;
362
363                // Add a `Vary` header if static compression is used
364                let resp = compression_static::post_process(&self.opts, req, resp)?;
365
366                // Auto compression based on the `Accept-Encoding` header
367                #[cfg(any(
368                    feature = "compression",
369                    feature = "compression-gzip",
370                    feature = "compression-brotli",
371                    feature = "compression-zstd",
372                    feature = "compression-deflate"
373                ))]
374                let resp = compression::post_process(&self.opts, req, resp)?;
375
376                // Append `Cache-Control` headers for web assets
377                let resp = control_headers::post_process(&self.opts, req, resp)?;
378
379                // Append security headers
380                let resp = security_headers::post_process(&self.opts, req, resp)?;
381
382                // Add/update custom headers
383                let resp = custom_headers::post_process(&self.opts, req, resp, file_path.as_ref())?;
384
385                Ok(resp)
386            }
387            .await;
388
389            #[cfg(feature = "metrics")]
390            if metrics_enabled {
391                metrics::dec_requests_inflight();
392                if let Ok(ref resp) = result {
393                    let bytes = resp
394                        .headers()
395                        .get(hyper::header::CONTENT_LENGTH)
396                        .and_then(|v| v.to_str().ok())
397                        .and_then(|v| v.parse::<u64>().ok())
398                        .unwrap_or(0);
399                    metrics::record_request(
400                        req,
401                        resp.status(),
402                        bytes,
403                        req_start.elapsed().as_secs_f64(),
404                    );
405                }
406            }
407
408            result
409        }
410    }
411}
static_web_server/handler.rs

static_web_server/
handler.rs
