teamy-mft 0.5.1

TeamDman's Master File Table CLI and library for NTFS.
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

use crate::cli::command::sync::IfExistsOutputBehaviour;
use crate::cli::command::sync::drive_sync_info::DriveSyncInfo;
use crate::mft::mft_physical_read::PhysicalMftReadResult;
use crate::mft::mft_physical_read::read_physical_mft;
use arbitrary::Arbitrary;
use async_stream::try_stream;
use eyre::Context;
use eyre::bail;
use facet::Facet;
use futures::StreamExt as _;
use futures::stream;
use itertools::Itertools;
use teamy_windows::elevation::enable_backup_privileges;
use teamy_windows::elevation::ensure_elevated;
use tokio_stream::Stream;
use tracing::debug;
use tracing::info;
use tracing::info_span;

#[derive(Facet, PartialEq, Debug, Arbitrary, Default, Clone)]
pub struct SyncMftArgs;

impl SyncMftArgs {
    /// Validate the sync can proceed before any MFT reads begin.
    ///
    /// # Errors
    ///
    /// Returns an error if `if_exists` is `Abort` and any MFT output already exists.
    pub fn invoke_preflight(
        drive_infos: Vec<DriveSyncInfo>,
        if_exists: &IfExistsOutputBehaviour,
    ) -> eyre::Result<Vec<DriveSyncInfo>> {
        let mut rtn = Vec::with_capacity(drive_infos.len());
        for info in drive_infos {
            let mft_exists = info.mft_output_path.exists();
            match (mft_exists, if_exists) {
                (false, _) | (true, IfExistsOutputBehaviour::Overwrite) => {
                    rtn.push(info);
                }
                (true, IfExistsOutputBehaviour::Skip) => {
                    debug!(
                        drive = %info.drive_letter,
                        path = %info.mft_output_path.display(),
                        "Skipping existing MFT output"
                    );
                }
                (true, IfExistsOutputBehaviour::Abort) => {
                    bail!(
                        "Aborting sync: {} already exists",
                        info.mft_output_path.display()
                    );
                }
            }
        }
        Ok(rtn)
    }

    /// Sync MFT data from drives.
    ///
    /// Does not call the preflight check.
    ///
    /// # Errors
    ///
    /// Returns an error if the sync directory cannot be retrieved, elevation fails,
    /// or if reading/writing MFT data fails.
    pub fn invoke(
        drive_infos: Vec<DriveSyncInfo>,
    ) -> eyre::Result<impl Stream<Item = eyre::Result<(DriveSyncInfo, PhysicalMftReadResult)>>>
    {
        ensure_elevated()?;
        enable_backup_privileges().wrap_err("Failed to enable backup privileges")?;

        info!(
            "Found {} drives to sync MFT files for: {}",
            drive_infos.len(),
            drive_infos.iter().map(|info| info.drive_letter).join(", ")
        );

        Ok(try_stream! {
            let _span = info_span!("sync MFTs from disks to files").entered();
            let physical_mft_stream = read_physical_mft_stream_with_info(drive_infos);
            tokio::pin!(physical_mft_stream);
            while let Some(mft) = physical_mft_stream.next().await {
                let (drive_info, mft_result) = mft?;
                {
                    let _span = info_span!(
                        "write_mft_snapshot_for_drive",
                        drive = %drive_info.drive_letter,
                        output_path = %drive_info.mft_output_path.display(),
                    )
                    .entered();
                    mft_result.write_to_path(&drive_info.mft_output_path).wrap_err_with(|| {
                        format!(
                            "Failed writing MFT snapshot for drive {} to {}",
                            drive_info.drive_letter,
                            drive_info.mft_output_path.display()
                        )
                    })?;
                }
                yield (drive_info, mft_result);
            }
        })
    }
}

pub fn read_physical_mft_stream_with_info(
    drive_infos: impl IntoIterator<Item = DriveSyncInfo>,
) -> impl Stream<Item = eyre::Result<(DriveSyncInfo, PhysicalMftReadResult)>> {
    let drive_infos = drive_infos.into_iter().collect::<Vec<_>>();
    let concurrency = drive_infos.len().max(1);

    stream::iter(drive_infos)
        .map(|drive_info| async move {
            tokio::task::spawn_blocking(
                move || -> eyre::Result<(DriveSyncInfo, PhysicalMftReadResult)> {
                    let _span = info_span!(
                        "read_physical_mft_for_drive",
                        drive = %drive_info.drive_letter,
                    )
                    .entered();
                    let physical_mft_read_result = read_physical_mft(drive_info.drive_letter)
                        .wrap_err_with(|| {
                            format!(
                                "Failed reading MFT data for drive {}",
                                drive_info.drive_letter
                            )
                        })?;
                    eyre::Ok((drive_info, physical_mft_read_result))
                },
            )
            .await
            .map_err(|error| eyre::eyre!("Failed joining MFT read task: {error}"))?
        })
        .buffer_unordered(concurrency)
}