mft2bodyfile 0.8.1

parses an $MFT file to bodyfile (stdout)
Documentation
mod intern;
use std::thread;
use buf_stream_reader::BufStreamReader;
use flate2::read::GzDecoder;
use usnjrnl::*;
pub use intern::*;
use mft::MftParser;
use std::path::PathBuf;
use anyhow::{Result, anyhow};
use indicatif::{ProgressBar, ProgressStyle, MultiProgress};
use std::io::{Write, ErrorKind, Read, BufReader};
use std::fs::File;
use std::convert::TryInto;

enum ProgressBarType {
    Spinner,
    Bytes,
    Count(u64)
}

pub enum BodyfileSink {
    Stdout,
    File(File)
}

pub struct Mft2BodyfileTask {
    mft_file: PathBuf,
    usnjrnl: Option<PathBuf>,
    usnjrnl_longflags: bool,
    with_progressbar: bool,
    output: BodyfileSink
}

impl Default for Mft2BodyfileTask {
    fn default() -> Self {
        Self {
            mft_file: PathBuf::new(),
            usnjrnl: None,
            usnjrnl_longflags: false,
            with_progressbar: false,
            output: BodyfileSink::Stdout,
        }
    }
}

impl Mft2BodyfileTask {
    pub fn with_mft_file(mut self, mft_file: PathBuf) -> Self {
        self.mft_file = mft_file;
        self
    }

    pub fn with_usnjrnl(mut self, usnjrnl: Option<PathBuf>) -> Self {
        self.usnjrnl = usnjrnl;
        self
    }

    pub fn with_usnjrnl_longflags(mut self, usnjrnl_longflags: bool) -> Self {
        self.usnjrnl_longflags = usnjrnl_longflags;
        self
    }

    pub fn with_progressbar(mut self, with_progressbar: bool) -> Self {
        self.with_progressbar = with_progressbar;
        self
    }

    pub fn with_output(mut self, output: BodyfileSink) -> Self {
        self.output = output;
        self
    }

    pub fn fill_preprocessed_mft<T>(mut parser: MftParser<T>, bar: Option<ProgressBar>) -> PreprocessedMft where T: std::io::Read + std::io::Seek{
        let mut pp = PreprocessedMft::default();
        for mft_entry in parser.iter_entries().filter_map(Result::ok) {
            if let Some(b) = bar.as_ref() {
                b.inc(1);
            }
            
            if (12..24).contains(&mft_entry.header.record_number) {
                //
                // ignore contents of $MFT extension entries
                //
                continue;
            } else if mft_entry.header.used_entry_size == 0 {  
                //
                // ignore unallocated entries without content
                //
                if mft_entry.is_allocated() {
                    log::info!("found allocated entry with zero entry size: {}", mft_entry.header.record_number);
                }
            } else {
                //
                // handle all other entries
                //
                pp.add_entry(mft_entry);
            }
        }
        if let Some(b) = bar.as_ref() {
            b.finish();
        }
        pp
    }

    fn read_usnjrnl(usnjrnl_path: &Option<PathBuf>, bar: ProgressBar) -> UsnJrnl {
        match usnjrnl_path {
            Some(jrnl_path) => UsnJrnl::from(UsnJrnlReader::from(jrnl_path).unwrap(), bar),
            None => UsnJrnl::default()
        }
    }

    pub fn run(self) -> Result<()> {

        /* not to be mixed with MultiCar ;-) */
        let multi_bar = MultiProgress::new();

        let pp_thread = 
        if cfg!(feature="gzip") {
            match self.mft_file.file_name() {
                Some(filename) => {
                    if filename.to_string_lossy().ends_with(".gz") {
                        let file = File::open(&self.mft_file)?;
                        let mut reader = BufReader::new(GzDecoder::new(file));
                        let mut size = 0;
                        let mut buffer = vec![0; 4096*4096];

                        /* calculate the size of the uncompressed data */
                        let bar = self.new_progress_bar("obtaining size of uncompressed data", ProgressBarType::Bytes);
                        loop {
                            match reader.read(&mut buffer) {
                                Ok(bytes) => {
                                    if bytes == 0 { break }
                                    else { size += bytes; bar.inc(bytes.try_into().unwrap());}
                                }
                                Err(why) => if why.kind() == ErrorKind::UnexpectedEof {
                                    break;
                                }
                            }
                        }
                        bar.finish_and_clear();

                        let file = File::open(&self.mft_file)?;
                        let reader = BufStreamReader::new(GzDecoder::new(file), 4096);
                        let parser = MftParser::from_read_seek(reader, Some(size.try_into().unwrap()))?;
                        let parser_bar = multi_bar.add(self.new_progress_bar("parsing $MFT entries", ProgressBarType::Spinner));
                        thread::spawn(move|| Self::fill_preprocessed_mft(parser, Some(parser_bar)))
                    } else {
                        let file = File::open(&self.mft_file)?;
                        let parser = MftParser::from_read_seek(file, None).unwrap();
                        let parser_bar = multi_bar.add(self.new_progress_bar("parsing $MFT entries", ProgressBarType::Count(parser.get_entry_count())));
                        thread::spawn(move|| Self::fill_preprocessed_mft(parser, Some(parser_bar)))
                    }
                }
                None => {
                    return Err(anyhow!(std::io::Error::new(ErrorKind::InvalidInput, "missing filename")))
                }
            }
        } else {
            let parser = MftParser::from_path(&self.mft_file).unwrap();
            let parser_bar = multi_bar.add(self.new_progress_bar("parsing $MFT entries", ProgressBarType::Count(parser.get_entry_count())));
            thread::spawn(move|| Self::fill_preprocessed_mft(parser, Some(parser_bar)))
        };

        let usnjrnl_bar = multi_bar.add(self.new_progress_bar("parsing $UsnJrnl:$J entries", ProgressBarType::Spinner));
        let usnjrnl_path = self.usnjrnl.clone();
        let usnjrnl_thread = thread::spawn(move||
            Self::read_usnjrnl(&usnjrnl_path, usnjrnl_bar)
        );
 
        let mut pp = pp_thread.join().unwrap();
        let usnjrnl = usnjrnl_thread.join().unwrap();

        if ! usnjrnl.is_empty() {
            let bar = self.new_progress_bar("merging $UsnJrnl entries", ProgressBarType::Count(usnjrnl.len() as u64));
            for (reference, records) in usnjrnl.into_iter() {
                pp.add_usnjrnl_records(reference, records);
                bar.inc(1);
            }
            bar.finish();
        }

        let bar = &self.new_progress_bar("exporting bodyfile lines", ProgressBarType::Count(pp.bodyfile_lines_count() as u64));
        let stdout = std::io::stdout();
        let mut stdout_lock: Box<dyn Write> = match self.output {
            BodyfileSink::Stdout     => Box::new(stdout.lock()),
            BodyfileSink::File(file) => Box::new(file)
        };
        for entry in pp.iter_entries(self.usnjrnl_longflags) {
            stdout_lock.write_all(entry.as_bytes())?;
            stdout_lock.write_all("\n".as_bytes())?;
            bar.inc(1);
        }
        stdout_lock.flush()?;
        bar.finish();
        Ok(())
    }

    fn new_progress_bar(&self, message: &'static str, bar_type: ProgressBarType) -> ProgressBar {
        let bar = match bar_type {
            ProgressBarType::Count(count) => ProgressBar::new(count).with_message(message),
            ProgressBarType::Bytes => ProgressBar::new_spinner().with_message(message),
            ProgressBarType::Spinner => ProgressBar::new_spinner().with_message(message)
        };
        let style = match bar_type {
            ProgressBarType::Count(_count) => ProgressStyle::default_bar()
                .template("[{elapsed_precise}] {bar:40.cyan/blue} {pos:>9}/{len:9}({percent}%) {msg}").unwrap()
                .progress_chars("##-"),
            ProgressBarType::Bytes => ProgressStyle::default_spinner()
                .template("[{elapsed_precise}] {spinner:40} {bytes:>9} {msg}").unwrap()
                .tick_chars("|/-\\"),
            ProgressBarType::Spinner => ProgressStyle::default_spinner()
                .template("[{elapsed_precise}] {spinner:40} {pos:>9} {msg}").unwrap()
                .tick_chars("|/-\\"),
        };
        bar.set_style(style);
        bar
    }
}