TheLanc3/rustdesk
1
0
Fork 0
mirror of https://github.com/rustdesk/rustdesk.git synced 2026-09-08 13:31:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix(windows): prevent ghost and duplicate tray icons (#15689) (#15690)

Browse Source 
* docs(agents): require minimally invasive, additive-first patches

Codify the review feedback from the tray ghost-icon fix: fixes should
add self-contained code around existing lines instead of restructuring
them, keep platform-specific logic in src/platform/ with fn-local
imports, and leave only thin one-line hooks in shared files.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(windows): stop duplicate tray icons from piling up (#15689)

`check_process("--tray", ..)` is used to decide whether a tray process
needs to be spawned, but it can miss one that is already running: it
cannot read the command line of an elevated process from a non-elevated
one (the installer spawns the tray elevated), and wmic, used by 32-bit
builds since #11638, is gone from newer Windows 11. `connection.rs` runs
that check once per incoming connection, so every miss added another tray
icon and they kept piling up, which is the same blind spot behind #6692.

Hold a named mutex in the session namespace as the authoritative single
instance guard, so a redundant tray process exits before creating an
icon. `ERROR_ACCESS_DENIED` also counts as "already running", since it
means the mutex belongs to a tray we may not touch.

Also remove the icon before the tray menu's "Stop service" calls
uninstall_service(): on success it ends the process with
std::process::exit, which skips the destructor that would call
Shell_NotifyIcon(NIM_DELETE), so every click left a ghost icon behind.
The icon is shown again if stopping the service failed or was cancelled.

Ghost icons from the taskkill in the install/update/service flows are
left alone here.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs(windows): note that update_me's pid lookup can silently find nothing

The pids are matched by command line, which comes back empty for a 32-bit
build reading 64-bit processes (hence the `wmic` fallback of #11638, and
`wmic` is no longer installed by default since Windows 11 24H2) and for a
non-elevated process reading an elevated one. `taskkill` matches by image
name and still works, but the session lists are then empty, so the restore
guard silently restores nothing and the update leaves the user without a
tray icon and main window.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs(windows): record the confirmed cause of the duplicate tray icons

Process Explorer output in #15689 pinned it down: run_after_run_cmds()
spawns the tray in the caller's own context, so installing or toggling
the service from a RustDesk that was itself started elevated leaves a
high integrity tray behind, which a medium integrity main window cannot
inspect afterwards. Record where the detection fails exactly, so the next
reader doesn't have to rediscover that the executable path, not the
command line, is what comes back empty.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
RustDesk
2026-07-29 12:18:57 +08:00
committed by GitHub
parent d412d19872
commit 85a5fefab8
3 changed files with 102 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
src/platform/windows.rs
View File

@@ -3162,6 +3162,64 @@ impl Drop for WakeLock {
}
}
// `check_process("--tray", ..)` can miss a tray process that is already running,
// and every miss spawns one more tray icon.
//
// The case confirmed in #15689: `run_after_run_cmds()` spawns the tray in the
// caller's own context, so installing or toggling the service from a RustDesk
// that was itself started elevated leaves a high integrity tray behind. A main
// window started normally afterwards runs at medium integrity and cannot open
// that process with `PROCESS_QUERY_INFORMATION | PROCESS_VM_READ`. sysinfo then
// falls back to `PROCESS_QUERY_LIMITED_INFORMATION`, which is not enough for
// `GetModuleFileNameExW`, so the executable path comes back empty and the tray
// is skipped before its command line is ever looked at.
//
// A second blind spot: 32-bit builds read the command line through `wmic`
// (#11638), which is no longer installed by default since Windows 11 24H2.
//
// Both are cases of one process failing to inspect another, and patching the
// inspection has regressed twice already (#6692), so use a named mutex instead:
// the kernel answers without us needing any access to the other process.
//
// Returns `false` if another tray process is already running in this session.
pub fn try_lock_tray_single_instance() -> bool {
use winapi::um::{
errhandlingapi::{GetLastError, SetLastError},
synchapi::CreateMutexW,
};
// `Local\` is the per session namespace, so the name is scoped to this
// session already and cannot be squatted by another user.
let name = wide_string(&format!("Local\\{}_tray", crate::get_app_name()));
unsafe {
// A successful `CreateMutexW` doesn't clear the last error, clear it to
// reliably detect `ERROR_ALREADY_EXISTS`.
SetLastError(0);
// The handle is deliberately kept open for the lifetime of the process.
let handle = CreateMutexW(null_mut(), FALSE, name.as_ptr());
let last_error = GetLastError();
if !handle.is_null() {
if last_error == ERROR_ALREADY_EXISTS {
CloseHandle(handle);
return false;
}
return true;
}
if last_error == ERROR_ACCESS_DENIED {
// The mutex exists but was created by a tray running at a higher
// integrity level, which is exactly the elevated tray described
// above. Defer to it instead of adding a second icon.
return false;
}
// Unexpected: show the tray icon anyway, a duplicated icon is better
// than never showing the tray icon at all.
log::warn!(
"Failed to create the tray single instance mutex: {}",
io::Error::from_raw_os_error(last_error as _)
);
true
}
}
pub fn uninstall_service(show_new_window: bool, _: bool) -> bool {
log::info!("Uninstalling service...");
let filter = format!(" /FI \"PID ne {}\"", get_current_pid());
@@ -3268,6 +3326,18 @@ pub fn update_me(debug: bool) -> ResultType<()> {
}
let app_exe_name = &format!("{}.exe", &app_name);
// NOTE: The pids below are matched by command line, which can silently come
// back empty even while the processes are running:
// - a 32-bit build cannot read the command line of a 64-bit process, so it
// shells out to `wmic` instead (#11638), and `wmic` is no longer installed
// by default since Windows 11 24H2;
// - a non-elevated process cannot read the command line of an elevated one.
// The `taskkill` in the commands below matches by image name and is not
// affected, but `*_sessions` are then empty, so `_restore_session_guard`
// silently restores nothing and the update leaves the user without a tray
// icon and main window until the app is launched again. Reading the command
// line through `NtQueryInformationProcess` instead would fix the queries for
// every caller.
let main_window_pids =
crate::platform::get_pids_of_process_with_args::<_, &str>(&app_exe_name, &[]);
let main_window_sessions = main_window_pids

26
src/tray.rs
View File

@@ -30,6 +30,15 @@ fn make_tray() -> hbb_common::ResultType<()> {
menu::{Menu, MenuEvent, MenuItem},
TrayIcon, TrayIconBuilder, TrayIconEvent as TrayEvent,
};
// Duplicated tray icons kept piling up through the blind spots of
// `check_process("--tray", ..)`. https://github.com/rustdesk/rustdesk/issues/15689
#[cfg(windows)]
if !crate::platform::windows::try_lock_tray_single_instance() {
log::info!("Another tray process is already running in this session, exit");
return Ok(());
}
let icon;
#[cfg(target_os = "macos")]
{
@@ -185,9 +194,26 @@ fn make_tray() -> hbb_common::ResultType<()> {
return;
}
*/
// Remove the icon first: on success `uninstall_service()` ends
// this process with `std::process::exit`, which skips the
// destructor that would remove it, leaving a ghost icon behind.
#[cfg(windows)]
let _ = _tray_icon
.lock()
.unwrap()
.as_mut()
.map(|t| t.set_visible(false));
if !crate::platform::uninstall_service(false, false) {
*control_flow = ControlFlow::Exit;
}
// Still alive, so stopping the service failed or was cancelled
// in the UAC prompt. Show the icon again.
#[cfg(windows)]
let _ = _tray_icon
.lock()
.unwrap()
.as_mut()
.map(|t| t.set_visible(true));
} else if event.id == open_i.id() {
open_func();
}