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
use std::fmt::Write;
use std::io::Result;
use std::path::Path;

use log;
use log::info;
use syslog;

pub enum VerboseLevel {
    Low,
    High,
}

pub fn get_levle_from_int(level: u64) -> VerboseLevel {
    if level < 2 {
        VerboseLevel::Low
    } else {
        VerboseLevel::High
    }
}

enum Kind {
    Verbose,
    Log,
}

pub struct StatusLogger {
    verbose: Option<LogBuilder>,
    logger: Option<LogBuilder>,
}

impl StatusLogger {
    pub fn new() -> Self {
        StatusLogger {
            verbose: None,
            logger: None,
        }
    }

    pub fn add_verbose(&mut self, level: VerboseLevel) {
        let tmp = LogBuilder::new(level, Kind::Verbose);
        self.verbose = Some(tmp);
    }

    pub fn add_logger(&mut self, level: VerboseLevel) {
        let tmp = LogBuilder::new(level, Kind::Log);
        self.logger = Some(tmp);
    }

    pub fn is_used(&mut self) -> bool {
        if let Some(_) = self.logger {
            true
        } else if let Some(_) = self.verbose {
            true
        } else {
            false
        }
    }

    pub fn log_file_remove<P: AsRef<Path>>(&mut self, file: P) -> Result<()> {
        if let Some(ref mut verb) = self.verbose {
            verb.log_file_remove(&file)?;
        }
        if let Some(ref mut log) = self.logger {
            log.log_file_remove(&file)?;
        }
        Ok(())
    }

    pub fn output_log(&mut self) {
        if let Some(ref mut verb) = self.verbose {
            verb.output_log();
        }
        if let Some(ref mut log) = self.logger {
            log.output_log();
        }
    }

    pub fn log_statistics(&mut self) {
        if let Some(ref mut verb) = self.verbose {
            verb.log_statistics();
            verb.output_log();
        }
        if let Some(ref mut log) = self.logger {
            log.log_statistics();
            log.output_log();
        }
    }
}

struct LogBuilder {
    total_size: u64,
    file_count: usize,
    dir_count: usize,
    curr_size: u64,
    is_dir: bool,
    cache_log: String,
    level: VerboseLevel,
    kind: Kind,
}

impl LogBuilder {
    fn new(level: VerboseLevel, kind: Kind) -> Self {
        if let Kind::Log = kind {
            LogBuilder::init_logger();
        }

        LogBuilder {
            total_size: 0,
            file_count: 0,
            dir_count: 0,

            curr_size: 0,
            is_dir: false,

            level,
            cache_log: String::new(),
            kind,
        }
    }

    fn log_file_remove<P: AsRef<Path>>(&mut self, file: P) -> Result<()> {
        self.inner_log_file_remove(file.as_ref())
    }

    fn inner_log_file_remove(&mut self, file: &Path) -> Result<()> {
        self.cache_log.clear();
        let size = self.update_stat(file)?;
        let result = match self.level {
            VerboseLevel::Low => writeln!(&mut self.cache_log, "{:?}", file),
            VerboseLevel::High => {
                if file.is_dir() {
                    writeln!(&mut self.cache_log, "Remove Directory: {:?}", file)
                } else {
                    writeln!(
                        &mut self.cache_log,
                        "Remove File: {:?} - freed {}",
                        file,
                        format_size(size)
                    )
                }
            }
        };
        result.expect("unable to format log message");
        Ok(())
    }

    fn output_log(&mut self) {
        if self.is_dir {
            self.dir_count += 1;
        } else {
            self.file_count += 1;
            self.total_size += self.curr_size;
        }

        match self.kind {
            Kind::Verbose => print!("{}", self.cache_log),
            Kind::Log => info!("{}", self.cache_log),
        }
        self.cache_log.clear();
        self.curr_size = 0;
    }

    fn log_statistics(&mut self) {
        if let VerboseLevel::High = self.level {
            writeln!(&mut self.cache_log, "Final job statistics:")
                .expect("unable to format log message");
            writeln!(
                &mut self.cache_log,
                "{} director{} removed",
                self.dir_count,
                if self.dir_count < 2 { "y" } else { "ies" }
            )
            .expect("unable to format log message");
            writeln!(
                &mut self.cache_log,
                "{} file{} removed",
                self.file_count,
                if self.file_count < 2 { "" } else { "s" }
            )
            .expect("unable to format log message");
            let tmp = format_size(self.total_size);
            writeln!(&mut self.cache_log, "{} freed", tmp).expect("unable to format log message");
        }
    }

    fn update_stat(&mut self, file: &Path) -> Result<u64> {
        if file.is_dir() {
            self.curr_size = 0;
            self.is_dir = true;
        } else {
            let meta = file.metadata()?;
            let size = meta.len();
            self.curr_size = size;
            self.is_dir = false;
        }
        Ok(self.curr_size)
    }

    fn init_logger() -> bool {
        let res = syslog::init(syslog::Facility::LOG_USER, log::LevelFilter::Info, None);
        match res {
            Ok(()) => true,
            Err(_) => false,
        }
    }
}

pub fn add_file_remove_log<P: AsRef<Path>>(log: &mut Option<StatusLogger>, path: P) -> Result<()> {
    if let Some(log) = log {
        log.log_file_remove(path)
    } else {
        Ok(())
    }
}

pub fn output_file_remove_log(log: &mut Option<StatusLogger>) {
    if let Some(log) = log {
        log.output_log();
    }
}

fn format_size(size: u64) -> String {
    let sizes = ["", "k", "M", "G", "T", "P", "E", "Z"];
    let mut size: f64 = size as f64;
    let mut count = 0;
    while count < sizes.len() - 1 && size > 1000.0 {
        size /= 1000.0;
        count += 1;
    }

    format!("{:.2} {}b", size, sizes[count])
}

#[cfg(test)]
mod test {

    use super::*;
    use std::fs::create_dir;
    use std::fs::File;
    use std::io::Write;
    use tempfile::TempDir;

    #[test]
    fn test_size_conveter() {
        let total_size = 1234;
        assert_eq!(format_size(total_size), "1.23 kb");

        let total_size = 1234567;
        assert_eq!(format_size(total_size), "1.23 Mb");
    }

    #[test]
    fn test_log_formatter() {
        let base_dir = TempDir::new().unwrap();

        let dir_path = base_dir.path().join("some_dir");
        create_dir(&dir_path).unwrap();
        let file_path = base_dir.path().join("file.dat");
        let mut large_file = File::create(&file_path).unwrap();

        for _ in 0..1000 {
            large_file.write(&[1, 2, 3, 4, 5]).unwrap();
        }

        let mut log = LogBuilder::new(VerboseLevel::Low, Kind::Verbose);

        log.log_file_remove(&file_path).unwrap();
        assert_eq!(log.cache_log, format!("{:?}\n", file_path));

        log.output_log();
        assert_eq!(log.cache_log, "");

        log.log_file_remove(&dir_path).unwrap();
        assert_eq!(log.cache_log, format!("{:?}\n", dir_path));

        log.output_log();
        assert_eq!(log.cache_log, "");

        let mut log = LogBuilder::new(VerboseLevel::High, Kind::Verbose);

        log.log_file_remove(&file_path).unwrap();
        assert_eq!(
            log.cache_log,
            format!("Remove File: {:?} - freed 5.00 kb\n", file_path)
        );

        assert_eq!(log.curr_size, 5000);
        assert_eq!(log.total_size, 0);

        log.output_log();
        assert_eq!(log.cache_log, "");

        assert_eq!(log.total_size, 5000);
        assert_eq!(log.curr_size, 0);

        log.log_file_remove(&dir_path).unwrap();
        assert_eq!(log.cache_log, format!("Remove Directory: {:?}\n", dir_path));

        log.output_log();
        assert_eq!(log.cache_log, "");
    }
}