static-web-server 2.42.0

A cross-platform, high-performance and asynchronous web server for static files-serving.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

// SPDX-License-Identifier: MIT OR Apache-2.0
// This file is part of Static Web Server.
// See https://static-web-server.net/ for more information
// Copyright (C) 2019-present Jose Quintana <joseluisq.net>

//! Compression static module to serve compressed files directly from the file system.
//!

use headers::{HeaderMap, HeaderMapExt, HeaderValue};
use hyper::{Body, Request, Response};
use std::ffi::OsStr;
use std::fs::Metadata;
use std::path::{Path, PathBuf};

use crate::Error;
use crate::fs::meta::try_metadata;
use crate::handler::RequestHandlerOpts;
use crate::headers_ext::{AcceptEncoding, ContentCoding};

/// It defines the pre-compressed file variant metadata of a particular file path.
pub struct CompressedFileVariant {
    /// Current file path.
    pub file_path: PathBuf,
    /// The metadata of the current file.
    pub metadata: Metadata,
    /// The content encoding based on the file extension.
    pub encoding: ContentCoding,
}

/// Initializes static compression.
pub fn init(enabled: bool, handler_opts: &mut RequestHandlerOpts) {
    handler_opts.compression_static = enabled;
    tracing::info!("compression static: enabled={enabled}");
}

/// Post-processing to add Vary header if necessary.
pub(crate) fn post_process<T>(
    opts: &RequestHandlerOpts,
    _req: &Request<T>,
    mut resp: Response<Body>,
) -> Result<Response<Body>, Error> {
    if !opts.compression_static {
        return Ok(resp);
    }

    // Compression content encoding varies so use a `Vary` header
    let value = resp.headers().get(hyper::header::VARY).map_or(
        HeaderValue::from_name(hyper::header::ACCEPT_ENCODING),
        |h| {
            let mut s = h.to_str().unwrap_or_default().to_owned();
            s.push(',');
            s.push_str(hyper::header::ACCEPT_ENCODING.as_str());
            HeaderValue::from_str(s.as_str()).unwrap()
        },
    );
    resp.headers_mut().insert(hyper::header::VARY, value);

    Ok(resp)
}

/// Search for the pre-compressed variant of the given file path.
pub fn precompressed_variant(
    file_path: &Path,
    headers: &HeaderMap<HeaderValue>,
) -> Option<CompressedFileVariant> {
    tracing::trace!(
        "preparing pre-compressed file variant path of {}",
        file_path.display()
    );
    if let Some(ref accept_encoding) = headers.typed_get::<AcceptEncoding>() {
        for encoding in accept_encoding.sorted_encodings() {
            // Determine preferred-encoding extension if available
            let comp_ext = match encoding {
                // https://zlib.net/zlib_faq.html#faq39
                ContentCoding::GZIP | ContentCoding::DEFLATE => "gz",
                // https://peazip.github.io/brotli-compressed-file-format.html
                ContentCoding::BROTLI => "br",
                // https://datatracker.ietf.org/doc/html/rfc8878
                ContentCoding::ZSTD => "zst",
                _ => {
                    tracing::trace!(
                        "preferred encoding based on the file extension was not determined, skipping"
                    );
                    continue;
                }
            };

            let Some(comp_name) = file_path.file_name().and_then(OsStr::to_str) else {
                tracing::trace!("file name was not determined for the current path, skipping");
                continue;
            };

            let file_path = file_path.with_file_name([comp_name, ".", comp_ext].concat());
            tracing::trace!(
                "trying to get the pre-compressed file variant metadata for {}",
                file_path.display()
            );

            let (metadata, is_dir) = match try_metadata(&file_path) {
                Ok(v) => v,
                Err(e) => {
                    tracing::trace!("pre-compressed file variant error: {:?}", e);
                    continue;
                }
            };

            if is_dir {
                tracing::trace!("pre-compressed file variant found but it's a directory, skipping");
                continue;
            }

            tracing::trace!("pre-compressed file variant found, serving it directly");

            return Some(CompressedFileVariant {
                file_path,
                metadata,
                encoding,
            });
        }
    }

    None
}