binaryninja/repository/
manager.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
use crate::rc::{Array, Ref, RefCountable};
use crate::repository::Repository;
use crate::string::IntoCStr;
use binaryninjacore_sys::{
    BNCreateRepositoryManager, BNFreeRepositoryManager, BNGetRepositoryManager,
    BNNewRepositoryManagerReference, BNRepositoryGetRepositoryByPath, BNRepositoryManager,
    BNRepositoryManagerAddRepository, BNRepositoryManagerCheckForUpdates,
    BNRepositoryManagerGetDefaultRepository, BNRepositoryManagerGetRepositories,
};
use std::fmt::Debug;
use std::path::Path;
use std::ptr::NonNull;

/// Keeps track of all the repositories and keeps the `enabled_plugins.json`
/// file coherent with the plugins that are installed/uninstalled enabled/disabled
#[repr(transparent)]
pub struct RepositoryManager {
    handle: NonNull<BNRepositoryManager>,
}

impl RepositoryManager {
    #[allow(clippy::should_implement_trait)]
    pub fn default() -> Ref<Self> {
        let result = unsafe { BNGetRepositoryManager() };
        unsafe { Self::ref_from_raw(NonNull::new(result).unwrap()) }
    }

    pub(crate) unsafe fn ref_from_raw(handle: NonNull<BNRepositoryManager>) -> Ref<Self> {
        Ref::new(Self { handle })
    }

    pub fn new(plugins_path: &str) -> Ref<Self> {
        let plugins_path = plugins_path.to_cstr();
        let result = unsafe { BNCreateRepositoryManager(plugins_path.as_ptr()) };
        unsafe { Self::ref_from_raw(NonNull::new(result).unwrap()) }
    }

    /// Check for updates for all managed [`Repository`] objects
    pub fn check_for_updates(&self) -> bool {
        unsafe { BNRepositoryManagerCheckForUpdates(self.handle.as_ptr()) }
    }

    /// List of [`Repository`] objects being managed
    pub fn repositories(&self) -> Array<Repository> {
        let mut count = 0;
        let result =
            unsafe { BNRepositoryManagerGetRepositories(self.handle.as_ptr(), &mut count) };
        assert!(!result.is_null());
        unsafe { Array::new(result, count, ()) }
    }

    /// Adds a new plugin repository for the manager to track.
    ///
    /// To remove a repository, restart Binary Ninja (and don't re-add the repository!).
    /// File artifacts will remain on disk under repositories/ file in the User Folder.
    ///
    /// Before you can query plugin metadata from a repository, you need to call [`RepositoryManager::check_for_updates`].
    ///
    /// * `url` - URL to the plugins.json containing the records for this repository
    /// * `repository_path` - path to where the repository will be stored on disk locally
    ///
    /// Returns true if the repository was successfully added, false otherwise.
    pub fn add_repository(&self, url: &str, repository_path: &Path) -> bool {
        let url = url.to_cstr();
        let repo_path = repository_path.to_cstr();
        unsafe {
            BNRepositoryManagerAddRepository(self.handle.as_ptr(), url.as_ptr(), repo_path.as_ptr())
        }
    }

    pub fn repository_by_path(&self, path: &Path) -> Option<Repository> {
        let path = path.to_cstr();
        let result =
            unsafe { BNRepositoryGetRepositoryByPath(self.handle.as_ptr(), path.as_ptr()) };
        NonNull::new(result).map(|raw| unsafe { Repository::from_raw(raw) })
    }

    /// Gets the default [`Repository`]
    pub fn default_repository(&self) -> Ref<Repository> {
        let result = unsafe { BNRepositoryManagerGetDefaultRepository(self.handle.as_ptr()) };
        assert!(!result.is_null());
        unsafe { Repository::ref_from_raw(NonNull::new(result).unwrap()) }
    }
}

impl Debug for RepositoryManager {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("RepositoryManager")
            .field("repositories", &self.repositories().to_vec())
            .finish()
    }
}

impl ToOwned for RepositoryManager {
    type Owned = Ref<Self>;

    fn to_owned(&self) -> Self::Owned {
        unsafe { RefCountable::inc_ref(self) }
    }
}

unsafe impl RefCountable for RepositoryManager {
    unsafe fn inc_ref(handle: &Self) -> Ref<Self> {
        Self::ref_from_raw(
            NonNull::new(BNNewRepositoryManagerReference(handle.handle.as_ptr())).unwrap(),
        )
    }

    unsafe fn dec_ref(handle: &Self) {
        BNFreeRepositoryManager(handle.handle.as_ptr())
    }
}