use std::{ collections::HashMap, ffi::{c_char, c_void}, path::PathBuf, sync::{Arc, RwLock}, }; use super::{desc::Desc, errno::*, *}; use crate::{flutter, ui_interface::get_id}; use hbb_common::{ bail, dlopen::symbor::Library, lazy_static, libc, log, message_proto::{Message, Misc, PluginResponse}, ResultType, }; const METHOD_HANDLE_UI: &[u8; 10] = b"handle_ui\0"; const METHOD_HANDLE_PEER: &[u8; 12] = b"handle_peer\0"; lazy_static::lazy_static! { static ref PLUGIN_INFO: Arc>> = Default::default(); pub static ref PLUGINS: Arc>> = Default::default(); pub static ref LOCAL_PEER_ID: Arc> = Default::default(); } struct PluginInfo { path: String, desc: Desc, } /// Initialize the plugins. /// /// Return null ptr if success. /// Return the error message if failed. `i32-String` without dash, i32 is a signed little-endian number, the String is utf8 string. /// The plugin allocate memory with `libc::malloc` and return the pointer. pub type PluginFuncInit = fn() -> *const c_void; /// Reset the plugin. /// /// Return null ptr if success. /// Return the error message if failed. `i32-String` without dash, i32 is a signed little-endian number, the String is utf8 string. /// The plugin allocate memory with `libc::malloc` and return the pointer. pub type PluginFuncReset = fn() -> *const c_void; /// Clear the plugin. /// /// Return null ptr if success. /// Return the error message if failed. `i32-String` without dash, i32 is a signed little-endian number, the String is utf8 string. /// The plugin allocate memory with `libc::malloc` and return the pointer. pub type PluginFuncClear = fn() -> *const c_void; /// Get the description of the plugin. /// Return the description. The plugin allocate memory with `libc::malloc` and return the pointer. pub type PluginFuncDesc = fn() -> *const c_char; /// Callback to send message to peer or ui. /// peer, target, id are utf8 strings(null terminated). /// /// peer: The peer id. /// target: "peer" or "ui". /// id: The id of this plugin. /// content: The content. /// len: The length of the content. type PluginFuncCallbackMsg = fn( peer: *const c_char, target: *const c_char, id: *const c_char, content: *const c_void, len: usize, ); pub type PluginFuncSetCallbackMsg = fn(PluginFuncCallbackMsg); /// Callback to get the id of local peer id. /// The returned string is utf8 string(null terminated). /// Don't free the returned ptr. type GetIdFuncCallback = fn() -> *const c_char; pub type PluginFuncGetIdCallback = fn(GetIdFuncCallback); /// The main function of the plugin. /// method: The method. "handle_ui" or "handle_peer" /// peer: The peer id. /// args: The arguments. /// /// Return null ptr if success. /// Return the error message if failed. `i32-String` without dash, i32 is a signed little-endian number, the String is utf8 string. /// The plugin allocate memory with `libc::malloc` and return the pointer. pub type PluginFuncCall = fn( method: *const c_char, peer: *const c_char, args: *const c_void, len: usize, ) -> *const c_void; macro_rules! make_plugin { ($($field:ident : $tp:ty),+) => { pub struct Plugin { _lib: Library, $($field: $tp),+ } impl Plugin { fn new(path: &str) -> ResultType { let lib = match Library::open(path) { Ok(lib) => lib, Err(e) => { bail!("Failed to load library {}, {}", path, e); } }; $(let $field = match unsafe { lib.symbol::<$tp>(stringify!($field)) } { Ok(m) => { log::info!("method found {}", stringify!($field)); *m }, Err(e) => { bail!("Failed to load {} func {}, {}", path, stringify!($field), e); } } ;)+ Ok(Self { _lib: lib, $( $field ),+ }) } } } } make_plugin!( init: PluginFuncInit, reset: PluginFuncReset, clear: PluginFuncClear, desc: PluginFuncDesc, call: PluginFuncCall, set_cb_msg: PluginFuncSetCallbackMsg, set_cb_get_id: PluginFuncGetIdCallback ); pub fn load_plugins() -> ResultType<()> { let exe = std::env::current_exe()?.to_string_lossy().to_string(); match PathBuf::from(&exe).parent() { Some(dir) => { for entry in std::fs::read_dir(dir)? { match entry { Ok(entry) => { let path = entry.path(); if path.is_file() { let path = path.to_str().unwrap_or(""); if path.ends_with(".so") { if let Err(e) = load_plugin(Some(path), None) { log::error!("{e}"); } } } } Err(e) => { log::error!("Failed to read dir entry, {}", e); } } } Ok(()) } None => { bail!("Failed to get parent dir of {}", exe); } } } pub fn unload_plugins() { let mut plugins = PLUGINS.write().unwrap(); for (id, plugin) in plugins.iter() { let _ret = (plugin.clear)(); log::info!("Plugin {} unloaded", id); } plugins.clear(); } pub fn unload_plugin(id: &str) { if let Some(plugin) = PLUGINS.write().unwrap().remove(id) { let _ret = (plugin.clear)(); } } pub fn reload_plugin(id: &str) -> ResultType<()> { let path = match PLUGIN_INFO.read().unwrap().get(id) { Some(plugin) => plugin.path.clone(), None => bail!("Plugin {} not found", id), }; unload_plugin(id); load_plugin(Some(&path), Some(id)) } #[no_mangle] fn get_local_peer_id() -> *const c_char { let mut id = (*LOCAL_PEER_ID.read().unwrap()).clone(); if id.is_empty() { let mut lock = LOCAL_PEER_ID.write().unwrap(); id = (*lock).clone(); if id.is_empty() { id = get_id(); id.push('\0'); *lock = id.clone(); } } id.as_ptr() as _ } fn load_plugin_path(path: &str) -> ResultType<()> { let plugin = Plugin::new(path)?; let desc = (plugin.desc)(); let desc_res = Desc::from_cstr(desc); unsafe { libc::free(desc as _); } let desc = desc_res?; let id = desc.id().to_string(); // to-do validate plugin // to-do check the plugin id (make sure it does not use another plugin's id) (plugin.set_cb_msg)(callback_msg::callback_msg); (plugin.set_cb_get_id)(get_local_peer_id as _); update_ui_plugin_desc(&desc); update_config(&desc); reload_ui(&desc); let plugin_info = PluginInfo { path: path.to_string(), desc, }; PLUGIN_INFO.write().unwrap().insert(id.clone(), plugin_info); PLUGINS.write().unwrap().insert(id, plugin); Ok(()) } pub fn load_plugin(path: Option<&str>, id: Option<&str>) -> ResultType<()> { match (path, id) { (Some(path), _) => load_plugin_path(path), (None, Some(id)) => match PLUGIN_INFO.read().unwrap().get(id) { Some(plugin) => load_plugin_path(&plugin.path), None => bail!("Plugin {} not found", id), }, (None, None) => { bail!("path and id are both None"); } } } fn handle_event(method: &[u8], id: &str, peer: &str, event: &[u8]) -> ResultType<()> { let mut peer: String = peer.to_owned(); peer.push('\0'); match PLUGINS.read().unwrap().get(id) { Some(plugin) => { let ret = (plugin.call)( method.as_ptr() as _, peer.as_ptr() as _, event.as_ptr() as _, event.len(), ); if ret.is_null() { Ok(()) } else { let (code, msg) = get_code_msg_from_ret(ret); unsafe { libc::free(ret as _); } bail!( "Failed to handle plugin event, id: {}, method: {}, code: {}, msg: {}", id, std::string::String::from_utf8(method.to_vec()).unwrap_or_default(), code, msg ); } } None => bail!("Plugin {} not found", id), } } #[inline] pub fn handle_ui_event(id: &str, peer: &str, event: &[u8]) -> ResultType<()> { handle_event(METHOD_HANDLE_UI, id, peer, event) } #[inline] pub fn handle_server_event(id: &str, peer: &str, event: &[u8]) -> ResultType<()> { handle_event(METHOD_HANDLE_PEER, id, peer, event) } #[inline] pub fn handle_client_event(id: &str, peer: &str, event: &[u8]) -> Option { let mut peer: String = peer.to_owned(); peer.push('\0'); match PLUGINS.read().unwrap().get(id) { Some(plugin) => { let ret = (plugin.call)( METHOD_HANDLE_PEER.as_ptr() as _, peer.as_ptr() as _, event.as_ptr() as _, event.len(), ); if ret.is_null() { None } else { let (code, msg) = get_code_msg_from_ret(ret); unsafe { libc::free(ret as _); } if code > ERR_RUSTDESK_HANDLE_BASE && code < ERR_PLUGIN_HANDLE_BASE { let name = match PLUGIN_INFO.read().unwrap().get(id) { Some(plugin) => plugin.desc.name(), None => "???", } .to_owned(); match code { ERR_CALL_NOT_SUPPORTED_METHOD => Some(make_plugin_response( id, &name, "plugin method is not supported", )), ERR_CALL_INVALID_ARGS => Some(make_plugin_response( id, &name, "plugin arguments is invalid", )), _ => Some(make_plugin_response(id, &name, &msg)), } } else { log::error!( "Failed to handle client event, code: {}, msg: {}", code, msg ); None } } } None => Some(make_plugin_response(id, "", "plugin not found")), } } fn make_plugin_response(id: &str, name: &str, msg: &str) -> Message { let mut misc = Misc::new(); misc.set_plugin_response(PluginResponse { id: id.to_owned(), name: name.to_owned(), msg: msg.to_owned(), ..Default::default() }); let mut msg_out = Message::new(); msg_out.set_misc(misc); msg_out } fn update_config(desc: &Desc) { super::config::set_local_items(desc.id(), &desc.config().local); super::config::set_peer_items(desc.id(), &desc.config().peer); } fn reload_ui(desc: &Desc) { for (location, ui) in desc.location().ui.iter() { let v: Vec<&str> = location.split('|').collect(); // The first element is the "client" or "host". // The second element is the "main", "remote", "cm", "file transfer", "port forward". if v.len() >= 2 { let available_channels = vec![ flutter::APP_TYPE_MAIN, flutter::APP_TYPE_DESKTOP_REMOTE, flutter::APP_TYPE_CM, flutter::APP_TYPE_DESKTOP_FILE_TRANSFER, flutter::APP_TYPE_DESKTOP_PORT_FORWARD, ]; if available_channels.contains(&v[1]) { if let Ok(ui) = serde_json::to_string(&ui) { let mut m = HashMap::new(); m.insert("name", MSG_TO_UI_TYPE_PLUGIN_RELOAD); m.insert("id", desc.id()); m.insert("location", &location); m.insert("ui", &ui); flutter::push_global_event(v[1], serde_json::to_string(&m).unwrap()); } } } } } fn update_ui_plugin_desc(desc: &Desc) { // This function is rarely used. There's no need to care about serialization efficiency here. if let Ok(desc_str) = serde_json::to_string(desc) { let mut m = HashMap::new(); m.insert("name", MSG_TO_UI_TYPE_PLUGIN_DESC); m.insert("desc", &desc_str); flutter::push_global_event(flutter::APP_TYPE_MAIN, serde_json::to_string(&m).unwrap()); flutter::push_global_event( flutter::APP_TYPE_DESKTOP_REMOTE, serde_json::to_string(&m).unwrap(), ); flutter::push_global_event(flutter::APP_TYPE_CM, serde_json::to_string(&m).unwrap()); } }