rust_web_server/log/
mod.rs

1use std::net::SocketAddr;
2use std::thread;
3use file_ext::FileExt;
4use crate::entry_point::command_line_args::CommandLineArgument;
5use crate::request::Request;
6use crate::response::Response;
7
8#[cfg(test)]
9mod tests;
10
11/// Logging helpers for access logs and server info.
12///
13/// [`Log::combined`] produces standard Combined Log Format lines compatible with
14/// GoAccess, AWStats, and similar tools. All three server code paths (HTTP/1.1,
15/// HTTP/2, HTTP/3) use it.
16pub struct Log;
17
18impl Log {
19    pub fn request_response(request: &Request, response: &Response, peer_addr: &SocketAddr) -> String {
20        let mut request_headers = "".to_string();
21        for header in &request.headers {
22            if &header.name.chars().count() > &0 {
23                request_headers = [
24                    request_headers,
25                    "\n  ".to_string(),
26                    header.name.to_string(),
27                    ": ".to_string(),
28                    header.value.to_string()
29                ].join("");
30            }
31        }
32
33        let mut response_headers = "".to_string();
34        for header in &response.headers {
35            if &header.name.chars().count() > &0 {
36                response_headers = [
37                    response_headers,
38                    "\n  ".to_string(),
39                    header.name.to_string(),
40                    ": ".to_string(),
41                    header.value.to_string()
42                ].join("");
43            }
44        }
45
46        let mut response_body_length = 0;
47        let mut response_body_parts_number = 0;
48        for content_range in &response.content_range_list {
49            let boxed_parse = content_range.size.parse::<i32>();
50            if boxed_parse.is_ok() {
51                response_body_length += boxed_parse.unwrap();
52                response_body_parts_number += 1;
53            }
54        }
55
56        let current_thread = thread::current();
57        let thread_id = current_thread.name().unwrap();
58
59        let log_request_response = format!("\n\nRequest (thread id: {} peer address is {}):\n  {} {} {}  {}\n  Body: {} byte(s) total (including default initialization vector)\nEnd of Request\nResponse:\n  {} {} {}\n\n  Body: {} part(s), {} byte(s) total\nEnd of Response",
60                                           thread_id,
61                                           peer_addr,
62                                           &request.http_version,
63                                           &request.method,
64                                           &request.request_uri,
65                                           request_headers,
66                                           request.body.len(),
67
68                                           &response.status_code,
69                                           &response.reason_phrase,
70                                           response_headers,
71                                           response_body_parts_number,
72                                           response_body_length);
73
74        log_request_response
75    }
76
77    pub fn usage_information() -> String {
78        let mut log = "Usage:\n\n".to_string();
79        let command_line_arg_list = CommandLineArgument::get_command_line_arg_list();
80        for arg in command_line_arg_list {
81            let flags = if arg.short_form.is_empty() {
82                format!("--{}", arg.long_form)
83            } else {
84                format!("-{} or --{}", arg.short_form, arg.long_form)
85            };
86            let argument_info = format!("  {} environment variable\n  {} as command line line argument\n  {}\n\n", arg.environment_variable, flags, arg._hint.unwrap());
87            log = [log, argument_info].join("");
88        }
89        log = [log, "End of usage section\n\n".to_string()].join("");
90        log
91    }
92
93    pub fn info(name: &str) -> String {
94        let mut log = format!("{}\n", name).to_string();
95        const VERSION: &str = env!("CARGO_PKG_VERSION");
96        const AUTHORS: &str = env!("CARGO_PKG_AUTHORS");
97        const REPOSITORY: &str = env!("CARGO_PKG_REPOSITORY");
98        const DESCRIPTION: &str = env!("CARGO_PKG_DESCRIPTION");
99        const RUST_VERSION: &str = env!("CARGO_PKG_RUST_VERSION");
100        const LICENSE: &str = env!("CARGO_PKG_LICENSE");
101        let boxed_user = FileExt::get_current_user();
102        if boxed_user.is_err() {
103            let message = boxed_user.as_ref().err().unwrap();
104            eprintln!("{}", message)
105        }
106        let user: String = boxed_user.unwrap();
107
108        let boxed_working_directory = FileExt::get_static_filepath("");
109        if boxed_working_directory.is_err() {
110            let message = boxed_working_directory.as_ref().err().unwrap();
111            eprintln!("{}", message)
112        }
113
114        let working_directory: String = boxed_working_directory.unwrap();
115
116        let version = format!("Version:           {}\n", VERSION);
117        log = [log, version].join("");
118
119        let authors = format!("Authors:           {}\n", AUTHORS);
120        log = [log, authors].join("");
121
122        let repository = format!("Repository:        {}\n", REPOSITORY);
123        log = [log, repository].join("");
124
125        let description = format!("Description:       {}\n", DESCRIPTION);
126        log = [log, description].join("");
127
128        let rust_version = format!("Rust Version:      {}\n", RUST_VERSION);
129        log = [log, rust_version].join("");
130
131        let license = format!("License:           {}\n", LICENSE);
132        log = [log, license].join("");
133
134        let license = format!("User:              {}\n", user);
135        log = [log, license].join("");
136
137        let license = format!("Working Directory: {}\n", working_directory);
138        log = [log, license].join("");
139
140        log
141    }
142
143    /// Returns a structured JSON log line for one request/response pair.
144    ///
145    /// Enable with `RWS_CONFIG_LOG_FORMAT=json`. Useful for log aggregators
146    /// (Loki, Fluentd, Datadog) that ingest JSON from pod stdout.
147    pub fn json(request: &Request, response: &Response, peer_addr: &SocketAddr) -> String {
148        use std::time::{SystemTime, UNIX_EPOCH};
149
150        let body_size: usize = response.content_range_list.iter()
151            .map(|cr| cr.body.len())
152            .sum();
153
154        let secs = SystemTime::now()
155            .duration_since(UNIX_EPOCH)
156            .unwrap_or_default()
157            .as_secs();
158
159        let timestamp = Log::format_iso8601(secs);
160
161        fn escape(s: &str) -> String {
162            s.replace('\\', "\\\\")
163             .replace('"', "\\\"")
164             .replace('\n', "\\n")
165             .replace('\r', "\\r")
166        }
167
168        format!(
169            "{{\"time\":\"{}\",\"remote_addr\":\"{}\",\"method\":\"{}\",\"path\":\"{}\",\"protocol\":\"{}\",\"status\":{},\"bytes\":{}}}",
170            timestamp,
171            peer_addr.ip(),
172            escape(&request.method),
173            escape(&request.request_uri),
174            escape(&request.http_version),
175            response.status_code,
176            body_size,
177        )
178    }
179
180    /// Writes one access log line to stdout using the format configured by
181    /// `RWS_CONFIG_LOG_FORMAT` (`"combined"` or `"json"`). Call this instead of
182    /// `Log::combined` so that format selection is centralised.
183    pub fn log_access(request: &Request, response: &Response, peer_addr: &SocketAddr) {
184        let format = std::env::var(crate::entry_point::Config::RWS_CONFIG_LOG_FORMAT)
185            .unwrap_or_default();
186        let line = if format == "json" {
187            Log::json(request, response, peer_addr)
188        } else {
189            Log::combined(request, response, peer_addr)
190        };
191        println!("{}", line);
192    }
193
194    fn format_iso8601(secs: u64) -> String {
195        let sec = secs % 60;
196        let min = (secs / 60) % 60;
197        let hour = (secs / 3600) % 24;
198        let days = secs / 86400;
199        let (year, month, day) = Log::days_to_ymd(days);
200        format!("{:04}-{:02}-{:02}T{:02}:{:02}:{:02}Z", year, month, day, hour, min, sec)
201    }
202
203    /// Returns a Combined Log Format (CLF) line for one request/response pair:
204    /// `IP - - [DD/Mon/YYYY:HH:MM:SS +0000] "METHOD URI VERSION" STATUS SIZE`
205    pub fn combined(request: &Request, response: &Response, peer_addr: &SocketAddr) -> String {
206        use std::time::{SystemTime, UNIX_EPOCH};
207
208        let body_size: usize = response.content_range_list.iter()
209            .map(|cr| cr.body.len())
210            .sum();
211
212        let secs = SystemTime::now()
213            .duration_since(UNIX_EPOCH)
214            .unwrap_or_default()
215            .as_secs();
216
217        let timestamp = Log::format_clf_timestamp(secs);
218
219        let body_str = if body_size > 0 { body_size.to_string() } else { "-".to_string() };
220
221        format!("{} - - [{}] \"{} {} {}\" {} {}",
222            peer_addr.ip(),
223            timestamp,
224            request.method,
225            request.request_uri,
226            request.http_version,
227            response.status_code,
228            body_str,
229        )
230    }
231
232    fn format_clf_timestamp(secs: u64) -> String {
233        let sec = secs % 60;
234        let min = (secs / 60) % 60;
235        let hour = (secs / 3600) % 24;
236        let days = secs / 86400;
237        let (year, month, day) = Log::days_to_ymd(days);
238        const MONTHS: [&str; 12] = ["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"];
239        format!("{:02}/{}/{:04}:{:02}:{:02}:{:02} +0000",
240            day, MONTHS[(month - 1) as usize], year, hour, min, sec)
241    }
242
243    fn days_to_ymd(days: u64) -> (u64, u64, u64) {
244        let z = days + 719468;
245        let era = z / 146097;
246        let doe = z % 146097;
247        let yoe = (doe - doe / 1460 + doe / 36524 - doe / 146096) / 365;
248        let y = yoe + era * 400;
249        let doy = doe - (365 * yoe + yoe / 4 - yoe / 100);
250        let mp = (5 * doy + 2) / 153;
251        let d = doy - (153 * mp + 2) / 5 + 1;
252        let m = if mp < 10 { mp + 3 } else { mp - 9 };
253        let y = if m <= 2 { y + 1 } else { y };
254        (y, m, d)
255    }
256
257    pub fn server_url_thread_count(protocol: &str, bind_addr: &String, thread_count: i32) -> String {
258        let url = format!("Server is up and running at: {}://{}\n", protocol, &bind_addr);
259        let thread_count = format!("Spawned {} thread(s) to handle incoming requests\n", thread_count);
260        [url, thread_count].join("")
261    }
262}
rust_web_server/log/mod.rs

rust_web_server/log/
mod.rs
