Require main_search_bar permission when entrypoint type 'inline-view'…

… is used
project-gauntlet · Sep 14, 2024 · ea9c795 · ea9c795
1 parent 1fe349d
commit ea9c795
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 5 deletions.
diff --git a/bundled_plugins/calculator/gauntlet.toml b/bundled_plugins/calculator/gauntlet.toml
@@ -9,3 +9,5 @@ path = 'src/default.tsx'
 type = 'inline-view'
 description = ''
 
+[permissions]
+main_search_bar = ["read"]
diff --git a/dev_plugin/gauntlet.toml b/dev_plugin/gauntlet.toml
@@ -148,4 +148,5 @@ os = 'windows'
 environment = ["RUST_LOG"]
 system = ["systemMemoryInfo"]
 network = ["upload.wikimedia.org", "api.github.com"]
-clipboard = ["read", "write", "clear"]
+clipboard = ["read", "write", "clear"]
+main_search_bar = ["read"]
diff --git a/rust/server/src/plugins/data_db_repository.rs b/rust/server/src/plugins/data_db_repository.rs
@@ -132,6 +132,8 @@ pub struct DbPluginPermissions {
     pub system: Vec<String>,
     #[serde(default)]
     pub clipboard: Vec<DbPluginClipboardPermissions>,
+    #[serde(default)]
+    pub main_search_bar: Vec<DbPluginMainSearchBarPermissions>,
 }
 
 #[derive(Debug, Deserialize, Serialize)]
@@ -144,6 +146,12 @@ pub enum DbPluginClipboardPermissions {
     Clear
 }
 
+#[derive(Debug, Deserialize, Serialize)]
+pub enum DbPluginMainSearchBarPermissions {
+    #[serde(rename = "read")]
+    Read,
+}
+
 #[derive(Debug, Deserialize, Serialize)]
 #[serde(tag = "type")]
 pub enum DbPluginPreferenceUserData {

diff --git a/rust/server/src/plugins/js/mod.rs b/rust/server/src/plugins/js/mod.rs
@@ -83,6 +83,7 @@ pub struct PluginPermissions {
     pub run_subprocess: Vec<String>,
     pub system: Vec<String>,
     pub clipboard: Vec<PluginClipboardPermissions>,
+    pub main_search_bar: Vec<PluginMainSearchBarPermissions>,
 }
 
 #[derive(Clone, Debug)]
@@ -97,6 +98,11 @@ pub enum PluginClipboardPermissions {
     Clear
 }
 
+#[derive(Clone, Debug)]
+pub enum PluginMainSearchBarPermissions {
+    Read,
+}
+
 
 #[derive(Clone, Debug)]
 pub enum PluginCommand {

diff --git a/rust/server/src/plugins/loader.rs b/rust/server/src/plugins/loader.rs
@@ -14,7 +14,7 @@ use itertools::Itertools;
 use tracing_subscriber::fmt::format;
 use common::model::{DownloadStatus, PluginId};
 use crate::model::ActionShortcutKey;
-use crate::plugins::data_db_repository::{DataDbRepository, db_entrypoint_to_str, db_plugin_type_to_str, DbCode, DbPluginAction, DbPluginActionShortcutKind, DbPluginEntrypointType, DbPluginPermissions, DbPluginPreference, DbPluginPreferenceUserData, DbPluginType, DbPreferenceEnumValue, DbWritePlugin, DbWritePluginAssetData, DbWritePluginEntrypoint, DbPluginClipboardPermissions};
+use crate::plugins::data_db_repository::{DataDbRepository, db_entrypoint_to_str, db_plugin_type_to_str, DbCode, DbPluginAction, DbPluginActionShortcutKind, DbPluginEntrypointType, DbPluginPermissions, DbPluginPreference, DbPluginPreferenceUserData, DbPluginType, DbPreferenceEnumValue, DbWritePlugin, DbWritePluginAssetData, DbWritePluginEntrypoint, DbPluginClipboardPermissions, DbPluginMainSearchBarPermissions};
 use crate::plugins::download_status::DownloadStatusHolder;
 
 pub struct PluginLoader {
@@ -242,6 +242,18 @@ impl PluginLoader {
             }
         }
 
+        let has_inline_view = plugin_manifest.entrypoint
+            .iter()
+            .find(|entrypoint| matches!(entrypoint.entrypoint_type, PluginManifestEntrypointTypes::InlineView))
+            .is_some();
+
+        if has_inline_view {
+            let main_search_bar = &permissions.main_search_bar;
+            if !main_search_bar.contains(&PluginManifestMainSearchBarPermissions::Read) {
+                return Err(anyhow!("Plugin uses entrypoint type 'inline-view' but doesn't specify main search bar 'read' permission"))
+            }
+        }
+
         let plugin_name = plugin_manifest.gauntlet.name;
         let plugin_description = plugin_manifest.gauntlet.description;
 
@@ -333,6 +345,16 @@ impl PluginLoader {
             })
             .collect();
 
+        let main_search_bar = plugin_manifest.permissions
+            .main_search_bar
+            .into_iter()
+            .map(|permission| {
+                match permission {
+                    PluginManifestMainSearchBarPermissions::Read => DbPluginMainSearchBarPermissions::Read,
+                }
+            })
+            .collect();
+
         let permissions = DbPluginPermissions {
             environment: plugin_manifest.permissions.environment,
             high_resolution_time: plugin_manifest.permissions.high_resolution_time,
@@ -343,6 +365,7 @@ impl PluginLoader {
             run_subprocess: plugin_manifest.permissions.run_subprocess,
             system: plugin_manifest.permissions.system,
             clipboard,
+            main_search_bar,
         };
 
         Ok(PluginDownloadData {
@@ -829,6 +852,8 @@ pub struct PluginManifestPermissions {
     system: Vec<String>,
     #[serde(default)]
     clipboard: Vec<PluginManifestClipboardPermissions>,
+    #[serde(default)]
+    main_search_bar: Vec<PluginManifestMainSearchBarPermissions>,
 }
 
 #[derive(Debug, Deserialize)]
@@ -840,3 +865,10 @@ pub enum PluginManifestClipboardPermissions {
     #[serde(rename = "clear")]
     Clear
 }
+
+#[derive(Debug, Deserialize, Eq, PartialEq)]
+pub enum PluginManifestMainSearchBarPermissions {
+    #[serde(rename = "read")]
+    Read,
+}
+
diff --git a/rust/server/src/plugins/mod.rs b/rust/server/src/plugins/mod.rs
@@ -17,10 +17,10 @@ use utils::channel::RequestSender;
 use common::dirs::Dirs;
 use crate::model::ActionShortcutKey;
 use crate::plugins::config_reader::ConfigReader;
-use crate::plugins::data_db_repository::{DataDbRepository, db_entrypoint_from_str, DbPluginActionShortcutKind, DbPluginEntrypointType, DbPluginPreference, DbPluginPreferenceUserData, DbReadPluginEntrypoint, DbPluginClipboardPermissions};
+use crate::plugins::data_db_repository::{DataDbRepository, db_entrypoint_from_str, DbPluginActionShortcutKind, DbPluginEntrypointType, DbPluginPreference, DbPluginPreferenceUserData, DbReadPluginEntrypoint, DbPluginClipboardPermissions, DbPluginMainSearchBarPermissions};
 use crate::plugins::global_shortcut::{convert_physical_shortcut_to_hotkey, register_listener};
 use crate::plugins::icon_cache::IconCache;
-use crate::plugins::js::{AllPluginCommandData, OnePluginCommandData, PluginCode, PluginCommand, PluginPermissions, PluginRuntimeData, start_plugin_runtime, PluginClipboardPermissions};
+use crate::plugins::js::{AllPluginCommandData, OnePluginCommandData, PluginCode, PluginCommand, PluginPermissions, PluginRuntimeData, start_plugin_runtime, PluginClipboardPermissions, PluginMainSearchBarPermissions};
 use crate::plugins::loader::PluginLoader;
 use crate::plugins::run_status::RunStatusHolder;
 use crate::search::SearchIndex;
@@ -564,6 +564,14 @@ impl ApplicationManager {
             })
             .collect();
 
+        let main_search_bar_permissions = plugin.permissions
+            .main_search_bar
+            .into_iter()
+            .map(|permission| match permission {
+                DbPluginMainSearchBarPermissions::Read => PluginMainSearchBarPermissions::Read,
+            })
+            .collect();
+
         let data = PluginRuntimeData {
             id: plugin_id,
             uuid: plugin.uuid,
@@ -579,6 +587,7 @@ impl ApplicationManager {
                 run_subprocess: plugin.permissions.run_subprocess,
                 system: plugin.permissions.system,
                 clipboard: clipboard_permissions,
+                main_search_bar: main_search_bar_permissions
             },
             command_receiver: receiver,
             db_repository: self.db_repository.clone(),

diff --git a/tools b/tools