-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.rs
419 lines (376 loc) · 14.9 KB
/
config.rs
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use core::fmt::Debug;
use core::fmt::Formatter;
use log::LevelFilter;
use log::Record;
use std::sync::Arc;
use termcolor::{Color, ColorSpec};
pub use time::format_description::FormatItem;
pub use time::macros::format_description;
pub use time::UtcOffset;
const LEVEL_NUMBER: usize = 6;
#[derive(Debug, Clone, Copy)]
pub enum TimeFormat {
Rfc2822,
Rfc3339,
Custom(&'static [FormatItem<'static>]),
}
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum Token {
Text(&'static str),
Time,
Level,
ColorStart,
ColorEnd,
ThreadId,
ThreadName,
ProcessId,
Module,
FileName,
File,
Line,
Message,
}
type FilterFunction = dyn Fn(&Record) -> bool + Send + Sync;
#[derive(Clone)]
pub struct Config {
pub(crate) level: LevelFilter,
pub(crate) time_offset: UtcOffset,
pub(crate) write_once: bool,
pub(crate) time_format: [TimeFormat; LEVEL_NUMBER],
pub(crate) format_text: [&'static str; LEVEL_NUMBER],
pub(crate) tokens: [Vec<Token>; LEVEL_NUMBER],
// Colors
pub(crate) colored_text_color: [Option<Color>; LEVEL_NUMBER],
pub(crate) background_color: [Option<Color>; LEVEL_NUMBER],
pub(crate) compiled_colors: [ColorSpec; LEVEL_NUMBER],
pub(crate) enabled_colors: bool,
pub(crate) message_filtering: Option<Arc<FilterFunction>>,
}
const DEFAULT_FORMAT_TEXT: &str = "[_time] [_color_start][[_level]][_color_end] [_module]: [_msg]";
const CONF_FULL_FORMAT_TEST: &str = "[_time] [_color_start][[_level]][_color_end] [[_module]] [_file_name]:[_line] - [_msg]";
impl Config {
/// Internal function to calculate all required data from user input
/// this is done only once to avoid unnecessary computations
pub(crate) fn calculate_data(&mut self) {
self.calculate_tokens();
self.calculate_colors();
}
/// Creating `ColorSpec` from user colors
fn calculate_colors(&mut self) {
for (idx, color_spec) in self.compiled_colors.iter_mut().enumerate() {
*color_spec = ColorSpec::new().set_bg(self.background_color[idx]).set_fg(self.colored_text_color[idx]).clone();
}
}
/// Calculate tokens from format text
fn calculate_tokens(&mut self) {
let allowed_tokens = [
("[_time]", Token::Time),
("[_level]", Token::Level),
("[_color_start]", Token::ColorStart),
("[_color_end]", Token::ColorEnd),
("[_thread_id]", Token::ThreadId),
("[_thread_name]", Token::ThreadName),
("[_process_id]", Token::ProcessId),
("[_module]", Token::Module),
("[_file]", Token::File),
("[_file_name]", Token::FileName),
("[_line]", Token::Line),
("[_msg]", Token::Message),
];
for (idx, format_text) in self.format_text.into_iter().enumerate() {
let mut collected_tokens = Vec::new();
let mut current_index = 0;
loop {
let mut minimum_index = usize::MAX;
let mut choose_token_text = None;
for (token_txt, token) in &allowed_tokens {
if let Some(find_idx) = format_text[current_index..].find(token_txt) {
if minimum_index > find_idx + current_index {
minimum_index = find_idx + current_index;
choose_token_text = Some((token_txt, token));
}
}
}
// No more tokens
if let Some((token_txt, token)) = choose_token_text {
if minimum_index > current_index {
let text = &format_text[current_index..minimum_index];
collected_tokens.push(Token::Text(text));
}
collected_tokens.push(token.clone());
current_index = minimum_index + token_txt.len() - 1;
} else {
if current_index != format_text.len() {
let text = &format_text[current_index..];
collected_tokens.push(Token::Text(text));
}
break; // No more to check
}
current_index += 1;
}
self.tokens[idx] = collected_tokens;
}
}
}
#[derive(Debug, Clone)]
pub struct ConfigBuilder(Config);
impl ConfigBuilder {
#[must_use]
pub fn new() -> ConfigBuilder {
ConfigBuilder(Config::default())
}
/// Preset for saving bigger amount of information than default preset
#[must_use]
pub fn new_preset_config_full() -> ConfigBuilder {
let mut builder = ConfigBuilder::default();
builder.set_time_format(
TimeFormat::Custom(format_description!(
"[year]-[month]-[day] [hour]:[minute]:[second].[subsecond digits:3] [offset_hour sign:mandatory]"
)),
None,
);
builder.set_format_text(CONF_FULL_FORMAT_TEST, None);
builder
}
/// Sets format of logged message
/// E.g. "\[_time\] \[\[_level\]\] \[_module\] \"\[_msg\]\""
/// depending on other settings, may print something like:
/// 14:21:15 \[INFO\] main: "Hello world!"
/// If level is none, it will set all levels
pub fn set_format_text(&mut self, format_text: &'static str, level: Option<LevelFilter>) -> &mut ConfigBuilder {
if let Some(level) = level {
self.0.format_text[level as usize] = format_text;
} else {
self.0.format_text = [format_text; LEVEL_NUMBER];
}
self
}
/// Sets background color
/// If color is none, background will not be colored
/// If level is none, it will set all levels
/// If level is some, it will set only that level
/// Background color is used only if `enabled_colors` is true
pub fn set_background_color(&mut self, background_color: Option<Color>, level: Option<LevelFilter>) -> &mut ConfigBuilder {
if let Some(level) = level {
self.0.background_color[level as usize] = background_color;
} else {
self.0.background_color = [background_color; LEVEL_NUMBER];
}
self
}
/// Sets text color
/// If color is none, text will be invisible
/// If level is none, it will set all levels
/// If level is some, it will set only that level
/// Background color is used only if `enabled_colors` is true
pub fn set_colored_text_color(&mut self, colored_text_color: Option<Color>, level: Option<LevelFilter>) -> &mut ConfigBuilder {
if let Some(level) = level {
self.0.colored_text_color[level as usize] = colored_text_color;
} else {
self.0.colored_text_color = [colored_text_color; LEVEL_NUMBER];
}
self
}
/// Enables colouring of text - only works with `TermLogger`
pub fn set_enabled_colours(&mut self, enabled_colours: bool) -> &mut ConfigBuilder {
self.0.enabled_colors = enabled_colours;
self
}
/// Sets the level of the logger.
/// E.g. using `LevelFilter::Info` will print all logs with level `Info`, `Warn`, `Error`,
/// but not `Debug` or `Trace`.
pub fn set_level(&mut self, level: LevelFilter) -> &mut ConfigBuilder {
self.0.level = level;
self
}
/// Instead of writing multiple times to target, creates a buffer, writes to memory and
/// at the end writes only once to target
/// This is useful when saving to file, because allows to not split one log into multiple
/// files if rotating is used.
/// Works only with `WriteLogger`
pub fn set_write_once(&mut self, write_once: bool) -> &mut ConfigBuilder {
self.0.write_once = write_once;
self
}
/// Set time format used in logger
/// If level is none, it will set all levels
/// Time format can be predefined(Rfc2822 or Rfc3339) or custom
pub fn set_time_format(&mut self, time_format: TimeFormat, level: Option<LevelFilter>) -> &mut ConfigBuilder {
if let Some(level) = level {
self.0.time_format[level as usize] = time_format;
} else {
self.0.time_format = [time_format; LEVEL_NUMBER];
}
self
}
/// Manually sets the offset used for the time.
pub fn set_time_offset(&mut self, offset: UtcOffset) -> &mut ConfigBuilder {
self.0.time_offset = offset;
self
}
/// Sets the offset used to the current local time offset
/// (overriding values previously set by [`ConfigBuilder::set_time_offset`]).
///
/// This function may fail if the offset cannot be determined soundly.
/// This may be the case, when the program is multi-threaded by the time of calling this function.
/// One can opt-out of this behavior by setting `RUSTFLAGS="--cfg unsound_local_offset"`.
/// Doing so is not recommended, completely untested and may cause unexpected segfaults.
#[cfg(feature = "time-local-offset")]
pub fn set_time_offset_to_local(&mut self) -> Result<&mut ConfigBuilder, &mut ConfigBuilder> {
match UtcOffset::current_local_offset() {
Ok(offset) => {
self.0.time_offset = offset;
Ok(self)
}
Err(_) => Err(self),
}
}
/// Sets the offset used to the current local time offset
/// It is quite unsound so may cause crashes
#[cfg(feature = "chrono-local-offset")]
pub fn set_chrono_local_time_offset(&mut self) -> Result<&mut ConfigBuilder, &mut ConfigBuilder> {
match UtcOffset::from_whole_seconds(chrono::offset::Local::now().offset().local_minus_utc()) {
Ok(offset) => {
self.0.time_offset = offset;
Ok(self)
}
Err(_) => Err(self),
}
}
/// Sets function that will be used to filter messages
/// If function returns true, message will be logged, otherwise it will be ignored
/// Function takes as argument function that will be filtered allowed results
/// If `message_filtering` is none, all messages will be logged
/// ```
/// use log::{info, Record};
/// use handsome_logger::{Config, ConfigBuilder};
///
/// fn filtering_messages(record: &Record) -> bool {
/// if let Some(arg) = record.args().as_str() {
/// !arg.contains("E")
/// } else {
/// true
/// }
/// }
///
/// let logger = ConfigBuilder::new().set_message_filtering(Some(filtering_messages)).build();
/// info!("Got BED"); // This will be ignored
/// info!("Got ANANAS"); // This will be printed
/// ```
pub fn set_message_filtering<F>(&mut self, message_filtering: Option<F>) -> &mut ConfigBuilder
where
F: Fn(&Record) -> bool + Send + Sync + 'static,
{
if let Some(message_filtering) = message_filtering {
self.0.message_filtering = Some(Arc::new(message_filtering));
} else {
self.0.message_filtering = None;
}
self
}
/// Builds the config
pub fn build(&mut self) -> Config {
self.0.clone()
}
}
impl Default for ConfigBuilder {
fn default() -> Self {
ConfigBuilder::new()
}
}
impl Default for Config {
fn default() -> Config {
Config {
level: LevelFilter::Info,
write_once: false,
time_format: [TimeFormat::Custom(format_description!("[hour]:[minute]:[second]")); LEVEL_NUMBER],
time_offset: UtcOffset::UTC,
tokens: [vec![], vec![], vec![], vec![], vec![], vec![]],
colored_text_color: [
None,
Some(Color::Red), // Error
Some(Color::Yellow), // Warn
Some(Color::Blue), // Info
Some(Color::Cyan), // Debug
Some(Color::White), // Trace
],
background_color: [None, None, None, None, None, None],
enabled_colors: true,
format_text: [DEFAULT_FORMAT_TEXT; LEVEL_NUMBER],
compiled_colors: [ColorSpec::new(), ColorSpec::new(), ColorSpec::new(), ColorSpec::new(), ColorSpec::new(), ColorSpec::new()],
message_filtering: None,
}
}
}
impl Debug for Config {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Config")
.field("level", &self.level)
.field("write_once", &self.write_once)
.field("time_format", &self.time_format)
.field("time_offset", &self.time_offset)
.field("tokens", &self.tokens)
.field("colored_text_color", &self.colored_text_color)
.field("background_color", &self.background_color)
.field("enabled_colors", &self.enabled_colors)
.field("format_text", &self.format_text)
.field("compiled_colors", &self.compiled_colors)
.finish()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test() {
let text = "[_time] [_level] [_thread_id] [_thread_name] [_process_id] [_module] [_file][_file_name] [_line] [_color_start][_msg][_color_end] [RAR]";
let mut config = ConfigBuilder::new().set_format_text(text, None).build();
config.calculate_data();
assert_eq!(
config.tokens[0],
vec![
Token::Time,
Token::Text(" "),
Token::Level,
Token::Text(" "),
Token::ThreadId,
Token::Text(" "),
Token::ThreadName,
Token::Text(" "),
Token::ProcessId,
Token::Text(" "),
Token::Module,
Token::Text(" "),
Token::File,
Token::FileName,
Token::Text(" "),
Token::Line,
Token::Text(" "),
Token::ColorStart,
Token::Message,
Token::ColorEnd,
Token::Text(" [RAR]"),
]
);
let text = "]]][[";
let mut config = ConfigBuilder::new().set_format_text(text, None).build();
config.calculate_data();
assert_eq!(config.tokens[0], vec![Token::Text("]]][[")]);
let text = " [_time]";
let mut config = ConfigBuilder::new().set_format_text(text, None).build();
config.calculate_data();
assert_eq!(config.tokens[0], vec![Token::Text(" "), Token::Time]);
let text = "[_time]";
let mut config = ConfigBuilder::new().set_format_text(text, None).build();
config.calculate_data();
assert_eq!(config.tokens[0], vec![Token::Time]);
let text = "[_time] ";
let mut config = ConfigBuilder::new().set_format_text(text, None).build();
config.calculate_data();
assert_eq!(config.tokens[0], vec![Token::Time, Token::Text(" ")]);
let text = "";
let mut config = ConfigBuilder::new().set_format_text(text, None).build();
config.calculate_data();
assert_eq!(config.tokens[0], vec![]);
}
}