summaryrefslogtreecommitdiff
path: root/plugins/bntl_utils/src/diff.rs
blob: f55e8446f02f56ae60c921b1d6afcba637e724f8 (plain)
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
use crate::dump::TILDump;
use crate::helper::path_to_type_libraries;
use binaryninja::rc::Ref;
use binaryninja::types::TypeLibrary;
use similar::{Algorithm, TextDiff};
use std::path::{Path, PathBuf};
use std::time::Duration;
use thiserror::Error;

#[derive(Error, Debug)]
pub enum TILDiffError {
    #[error("Could not determine parent directory for path: {0}")]
    InvalidPath(PathBuf),

    #[error("Failed to dump type library: {0}")]
    DumpError(String),
}

pub struct DiffResult {
    pub ratio: f32,
    pub diff: String,
}

pub struct TILDiff {
    timeout: Duration,
}

impl TILDiff {
    pub fn new() -> Self {
        Self {
            timeout: Duration::from_secs(180),
        }
    }

    pub fn with_timeout(mut self, timeout: Duration) -> Self {
        self.timeout = timeout;
        self
    }

    pub fn diff(
        &self,
        (a_path, a_type_lib): (&Path, &TypeLibrary),
        (b_path, b_type_lib): (&Path, &TypeLibrary),
    ) -> Result<DiffResult, TILDiffError> {
        let a_parent = a_path
            .parent()
            .ok_or_else(|| TILDiffError::InvalidPath(a_path.to_path_buf()))?;
        let b_parent = b_path
            .parent()
            .ok_or_else(|| TILDiffError::InvalidPath(b_path.to_path_buf()))?;

        self.diff_with_dependencies(
            (&a_type_lib, path_to_type_libraries(a_parent)),
            (&b_type_lib, path_to_type_libraries(b_parent)),
        )
    }

    pub fn diff_with_dependencies(
        &self,
        (a_type_lib, a_dependencies): (&TypeLibrary, Vec<Ref<TypeLibrary>>),
        (b_type_lib, b_dependencies): (&TypeLibrary, Vec<Ref<TypeLibrary>>),
    ) -> Result<DiffResult, TILDiffError> {
        let dumped_a = TILDump::new()
            .with_type_libs(a_dependencies)
            .dump(a_type_lib)
            .map_err(|e| TILDiffError::DumpError(e.to_string()))?;

        let dumped_b = TILDump::new()
            .with_type_libs(b_dependencies)
            .dump(b_type_lib)
            .map_err(|e| TILDiffError::DumpError(e.to_string()))?;

        let diff = TextDiff::configure()
            .algorithm(Algorithm::Patience)
            .timeout(self.timeout)
            .diff_lines(&dumped_a, &dumped_b);

        let diff_content = diff
            .unified_diff()
            .context_radius(3)
            .header(
                &format!("A/{}", a_type_lib.name()),
                &format!("B/{}", b_type_lib.name()),
            )
            .to_string();

        Ok(DiffResult {
            ratio: diff.ratio(),
            diff: diff_content,
        })
    }
}