// Copyright 2019-2023 Tauri Programme within The Commons Conservancy // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT #[cfg(feature = "semver")] use crate::semver_compat::semver_compat_string; use crate::SingleInstanceCallback; use std::ffi::CStr; use tauri::{ plugin::{self, TauriPlugin}, AppHandle, Manager, RunEvent, Runtime, }; use windows_sys::Win32::{ Foundation::{CloseHandle, GetLastError, ERROR_ALREADY_EXISTS, HWND, LPARAM, LRESULT, WPARAM}, System::{ DataExchange::COPYDATASTRUCT, LibraryLoader::GetModuleHandleW, Threading::{CreateMutexW, ReleaseMutex}, }, UI::WindowsAndMessaging::{ self as w32wm, CreateWindowExW, DefWindowProcW, DestroyWindow, FindWindowW, RegisterClassExW, SendMessageW, CREATESTRUCTW, GWLP_USERDATA, GWL_STYLE, WINDOW_LONG_PTR_INDEX, WM_COPYDATA, WM_CREATE, WM_DESTROY, WNDCLASSEXW, WS_EX_LAYERED, WS_EX_NOACTIVATE, WS_EX_TOOLWINDOW, WS_EX_TRANSPARENT, WS_OVERLAPPED, WS_POPUP, WS_VISIBLE, }, }; const WMCOPYDATA_SINGLE_INSTANCE_DATA: usize = 1542; struct MutexHandle(isize); struct TargetWindowHandle(isize); struct UserData { app: AppHandle, callback: Box>, } impl UserData { unsafe fn from_hwnd_raw(hwnd: HWND) -> *mut Self { GetWindowLongPtrW(hwnd, GWLP_USERDATA) as *mut Self } unsafe fn from_hwnd<'a>(hwnd: HWND) -> &'a mut Self { &mut *Self::from_hwnd_raw(hwnd) } fn run_callback(&mut self, args: Vec, cwd: String) { (self.callback)(&self.app, args, cwd) } } pub fn init(callback: Box>) -> TauriPlugin { plugin::Builder::new("single-instance") .setup(|app, _api| { #[allow(unused_mut)] let mut id = app.config().identifier.clone(); #[cfg(feature = "semver")] { id.push('_'); id.push_str(semver_compat_string(app.package_info().version.clone()).as_str()); } let class_name = encode_wide(format!("{id}-sic")); let window_name = encode_wide(format!("{id}-siw")); let mutex_name = encode_wide(format!("{id}-sim")); let hmutex = unsafe { CreateMutexW(std::ptr::null(), true.into(), mutex_name.as_ptr()) }; if unsafe { GetLastError() } == ERROR_ALREADY_EXISTS { unsafe { let hwnd = FindWindowW(class_name.as_ptr(), window_name.as_ptr()); if !hwnd.is_null() { let cwd = std::env::current_dir().unwrap_or_default(); let cwd = cwd.to_str().unwrap_or_default(); let args = std::env::args().collect::>().join("|"); let data = format!("{cwd}|{args}\0",); let bytes = data.as_bytes(); let cds = COPYDATASTRUCT { dwData: WMCOPYDATA_SINGLE_INSTANCE_DATA, cbData: bytes.len() as _, lpData: bytes.as_ptr() as _, }; SendMessageW(hwnd, WM_COPYDATA, 0, &cds as *const _ as _); app.cleanup_before_exit(); std::process::exit(0); } } } else { app.manage(MutexHandle(hmutex as _)); let userdata = UserData { app: app.clone(), callback, }; let userdata = Box::into_raw(Box::new(userdata)); let hwnd = create_event_target_window::(&class_name, &window_name, userdata); app.manage(TargetWindowHandle(hwnd as _)); } Ok(()) }) .on_event(|app, event| { if let RunEvent::Exit = event { destroy(app); } }) .build() } pub fn destroy>(manager: &M) { if let Some(hmutex) = manager.try_state::() { unsafe { ReleaseMutex(hmutex.0 as _); CloseHandle(hmutex.0 as _); } } if let Some(hwnd) = manager.try_state::() { unsafe { DestroyWindow(hwnd.0 as _) }; } } unsafe extern "system" fn single_instance_window_proc( hwnd: HWND, msg: u32, wparam: WPARAM, lparam: LPARAM, ) -> LRESULT { match msg { WM_CREATE => { let create_struct = &*(lparam as *const CREATESTRUCTW); let userdata = create_struct.lpCreateParams as *const UserData; SetWindowLongPtrW(hwnd, GWLP_USERDATA, userdata as _); 0 } WM_COPYDATA => { let cds_ptr = lparam as *const COPYDATASTRUCT; if (*cds_ptr).dwData == WMCOPYDATA_SINGLE_INSTANCE_DATA { let userdata = UserData::::from_hwnd(hwnd); let data = CStr::from_ptr((*cds_ptr).lpData as _).to_string_lossy(); let mut s = data.split('|'); let cwd = s.next().unwrap(); let args = s.map(|s| s.to_string()).collect(); userdata.run_callback(args, cwd.to_string()); } 1 } WM_DESTROY => { let userdata = UserData::::from_hwnd_raw(hwnd); drop(Box::from_raw(userdata)); 0 } _ => DefWindowProcW(hwnd, msg, wparam, lparam), } } fn create_event_target_window( class_name: &[u16], window_name: &[u16], userdata: *const UserData, ) -> HWND { unsafe { let class = WNDCLASSEXW { cbSize: std::mem::size_of::() as u32, style: 0, lpfnWndProc: Some(single_instance_window_proc::), cbClsExtra: 0, cbWndExtra: 0, hInstance: GetModuleHandleW(std::ptr::null()), hIcon: std::ptr::null_mut(), hCursor: std::ptr::null_mut(), hbrBackground: std::ptr::null_mut(), lpszMenuName: std::ptr::null(), lpszClassName: class_name.as_ptr(), hIconSm: std::ptr::null_mut(), }; RegisterClassExW(&class); let hwnd = CreateWindowExW( WS_EX_NOACTIVATE | WS_EX_TRANSPARENT | WS_EX_LAYERED // WS_EX_TOOLWINDOW prevents this window from ever showing up in the taskbar, which // we want to avoid. If you remove this style, this window won't show up in the // taskbar *initially*, but it can show up at some later point. This can sometimes // happen on its own after several hours have passed, although this has proven // difficult to reproduce. Alternatively, it can be manually triggered by killing // `explorer.exe` and then starting the process back up. // It is unclear why the bug is triggered by waiting for several hours. | WS_EX_TOOLWINDOW, class_name.as_ptr(), window_name.as_ptr(), WS_OVERLAPPED, 0, 0, 0, 0, std::ptr::null_mut(), std::ptr::null_mut(), GetModuleHandleW(std::ptr::null()), userdata as _, ); SetWindowLongPtrW( hwnd, GWL_STYLE, // The window technically has to be visible to receive WM_PAINT messages (which are used // for delivering events during resizes), but it isn't displayed to the user because of // the LAYERED style. (WS_VISIBLE | WS_POPUP) as isize, ); hwnd } } pub fn encode_wide(string: impl AsRef) -> Vec { std::os::windows::prelude::OsStrExt::encode_wide(string.as_ref()) .chain(std::iter::once(0)) .collect() } #[cfg(target_pointer_width = "32")] #[allow(non_snake_case)] unsafe fn SetWindowLongPtrW(hwnd: HWND, index: WINDOW_LONG_PTR_INDEX, value: isize) -> isize { w32wm::SetWindowLongW(hwnd, index, value as _) as _ } #[cfg(target_pointer_width = "64")] #[allow(non_snake_case)] unsafe fn SetWindowLongPtrW(hwnd: HWND, index: WINDOW_LONG_PTR_INDEX, value: isize) -> isize { w32wm::SetWindowLongPtrW(hwnd, index, value) } #[cfg(target_pointer_width = "32")] #[allow(non_snake_case)] unsafe fn GetWindowLongPtrW(hwnd: HWND, index: WINDOW_LONG_PTR_INDEX) -> isize { w32wm::GetWindowLongW(hwnd, index) as _ } #[cfg(target_pointer_width = "64")] #[allow(non_snake_case)] unsafe fn GetWindowLongPtrW(hwnd: HWND, index: WINDOW_LONG_PTR_INDEX) -> isize { w32wm::GetWindowLongPtrW(hwnd, index) }