/** * @file src/system_tray.cpp * @brief todo */ // macros #if defined SUNSHINE_TRAY && SUNSHINE_TRAY >= 1 #if defined(_WIN32) #define WIN32_LEAN_AND_MEAN #include #include #define TRAY_ICON WEB_DIR "images/sunshine.ico" #define TRAY_ICON_PLAYING WEB_DIR "images/sunshine-playing.ico" #define TRAY_ICON_PAUSING WEB_DIR "images/sunshine-pausing.ico" #define TRAY_ICON_LOCKED WEB_DIR "images/sunshine-locked.ico" #elif defined(__linux__) || defined(linux) || defined(__linux) #define TRAY_ICON "sunshine-tray" #define TRAY_ICON_PLAYING "sunshine-playing" #define TRAY_ICON_PAUSING "sunshine-pausing" #define TRAY_ICON_LOCKED "sunshine-locked" #elif defined(__APPLE__) || defined(__MACH__) #define TRAY_ICON WEB_DIR "images/logo-sunshine-16.png" #define TRAY_ICON_PLAYING WEB_DIR "images/sunshine-playing-16.png" #define TRAY_ICON_PAUSING WEB_DIR "images/sunshine-pausing-16.png" #define TRAY_ICON_LOCKED WEB_DIR "images/sunshine-locked-16.png" #include #endif // standard includes #include #include // lib includes #include "tray/tray.h" #include #include // local includes #include "confighttp.h" #include "main.h" #include "platform/common.h" #include "process.h" #include "version.h" using namespace std::literals; // system_tray namespace namespace system_tray { /** * @brief Callback for opening the UI from the system tray. * @param item The tray menu item. */ void tray_open_ui_cb(struct tray_menu *item) { BOOST_LOG(info) << "Opening UI from system tray"sv; launch_ui(); } /** * @brief Callback for opening GitHub Sponsors from the system tray. * @param item The tray menu item. */ void tray_donate_github_cb(struct tray_menu *item) { platf::open_url("https://github.com/sponsors/LizardByte"); } /** * @brief Callback for opening MEE6 donation from the system tray. * @param item The tray menu item. */ void tray_donate_mee6_cb(struct tray_menu *item) { platf::open_url("https://mee6.xyz/m/804382334370578482"); } /** * @brief Callback for opening Patreon from the system tray. * @param item The tray menu item. */ void tray_donate_patreon_cb(struct tray_menu *item) { platf::open_url("https://www.patreon.com/LizardByte"); } /** * @brief Callback for opening PayPal donation from the system tray. * @param item The tray menu item. */ void tray_donate_paypal_cb(struct tray_menu *item) { platf::open_url("https://www.paypal.com/paypalme/ReenigneArcher"); } /** * @brief Callback for restarting Sunshine from the system tray. * @param item The tray menu item. */ void tray_restart_cb(struct tray_menu *item) { BOOST_LOG(info) << "Restarting from system tray"sv; platf::restart(); } /** * @brief Callback for exiting Sunshine from the system tray. * @param item The tray menu item. */ void tray_quit_cb(struct tray_menu *item) { BOOST_LOG(info) << "Quitting from system tray"sv; #ifdef _WIN32 // If we're running in a service, return a special status to // tell it to terminate too, otherwise it will just respawn us. if (GetConsoleWindow() == NULL) { lifetime::exit_sunshine(ERROR_SHUTDOWN_IN_PROGRESS, true); return; } #endif lifetime::exit_sunshine(0, true); } // Tray menu static struct tray tray = { .icon = TRAY_ICON, .tooltip = PROJECT_NAME, .menu = (struct tray_menu[]) { // todo - use boost/locale to translate menu strings { .text = "Open Sunshine", .cb = tray_open_ui_cb }, { .text = "-" }, { .text = "Donate", .submenu = (struct tray_menu[]) { { .text = "GitHub Sponsors", .cb = tray_donate_github_cb }, { .text = "MEE6", .cb = tray_donate_mee6_cb }, { .text = "Patreon", .cb = tray_donate_patreon_cb }, { .text = "PayPal", .cb = tray_donate_paypal_cb }, { .text = nullptr } } }, { .text = "-" }, { .text = "Restart", .cb = tray_restart_cb }, { .text = "Quit", .cb = tray_quit_cb }, { .text = nullptr } }, }; /** * @brief Create the system tray. * @details This function has an endless loop, so it should be run in a separate thread. * @return 1 if the system tray failed to create, otherwise 0 once the tray has been terminated. */ int system_tray() { #ifdef _WIN32 // If we're running as SYSTEM, Explorer.exe will not have permission to open our thread handle // to monitor for thread termination. If Explorer fails to open our thread, our tray icon // will persist forever if we terminate unexpectedly. To avoid this, we will modify our thread // DACL to add an ACE that allows SYNCHRONIZE access to Everyone. { PACL old_dacl; PSECURITY_DESCRIPTOR sd; auto error = GetSecurityInfo(GetCurrentThread(), SE_KERNEL_OBJECT, DACL_SECURITY_INFORMATION, nullptr, nullptr, &old_dacl, nullptr, &sd); if (error != ERROR_SUCCESS) { BOOST_LOG(warning) << "GetSecurityInfo() failed: "sv << error; return 1; } auto free_sd = util::fail_guard([sd]() { LocalFree(sd); }); SID_IDENTIFIER_AUTHORITY sid_authority = SECURITY_WORLD_SID_AUTHORITY; PSID world_sid; if (!AllocateAndInitializeSid(&sid_authority, 1, SECURITY_WORLD_RID, 0, 0, 0, 0, 0, 0, 0, &world_sid)) { error = GetLastError(); BOOST_LOG(warning) << "AllocateAndInitializeSid() failed: "sv << error; return 1; } auto free_sid = util::fail_guard([world_sid]() { FreeSid(world_sid); }); EXPLICIT_ACCESS ea {}; ea.grfAccessPermissions = SYNCHRONIZE; ea.grfAccessMode = GRANT_ACCESS; ea.grfInheritance = NO_INHERITANCE; ea.Trustee.TrusteeForm = TRUSTEE_IS_SID; ea.Trustee.ptstrName = (LPSTR) world_sid; PACL new_dacl; error = SetEntriesInAcl(1, &ea, old_dacl, &new_dacl); if (error != ERROR_SUCCESS) { BOOST_LOG(warning) << "SetEntriesInAcl() failed: "sv << error; return 1; } auto free_new_dacl = util::fail_guard([new_dacl]() { LocalFree(new_dacl); }); error = SetSecurityInfo(GetCurrentThread(), SE_KERNEL_OBJECT, DACL_SECURITY_INFORMATION, nullptr, nullptr, new_dacl, nullptr); if (error != ERROR_SUCCESS) { BOOST_LOG(warning) << "SetSecurityInfo() failed: "sv << error; return 1; } } // Wait for the shell to be initialized before registering the tray icon. // This ensures the tray icon works reliably after a logoff/logon cycle. while (GetShellWindow() == nullptr) { Sleep(1000); } #endif if (tray_init(&tray) < 0) { BOOST_LOG(warning) << "Failed to create system tray"sv; return 1; } else { BOOST_LOG(info) << "System tray created"sv; } while (tray_loop(1) == 0) { BOOST_LOG(debug) << "System tray loop"sv; } return 0; } /** * @brief Run the system tray with platform specific options. * @note macOS requires that UI elements be created on the main thread, so the system tray is not currently implemented for macOS. */ void run_tray() { // create the system tray #if defined(__APPLE__) || defined(__MACH__) // macOS requires that UI elements be created on the main thread // creating tray using dispatch queue does not work, although the code doesn't actually throw any (visible) errors // dispatch_async(dispatch_get_main_queue(), ^{ // system_tray(); // }); BOOST_LOG(info) << "system_tray() is not yet implemented for this platform."sv; #else // Windows, Linux // create tray in separate thread std::thread tray_thread(system_tray); tray_thread.detach(); #endif } /** * @brief Exit the system tray. * @return 0 after exiting the system tray. */ int end_tray() { tray_exit(); return 0; } /** * @brief Sets the tray icon in playing mode and spawns the appropriate notification * @param app_name The started application name */ void update_tray_playing(std::string app_name) { tray.notification_title = NULL; tray.notification_text = NULL; tray.notification_cb = NULL; tray.notification_icon = NULL; tray.icon = TRAY_ICON_PLAYING; tray_update(&tray); tray.icon = TRAY_ICON_PLAYING; tray.notification_title = "Stream Started"; char msg[256]; sprintf(msg, "Streaming started for %s", app_name.c_str()); tray.notification_text = msg; tray.tooltip = msg; tray.notification_icon = TRAY_ICON_PLAYING; tray_update(&tray); } /** * @brief Sets the tray icon in pausing mode (stream stopped but app running) and spawns the appropriate notification * @param app_name The paused application name */ void update_tray_pausing(std::string app_name) { tray.notification_title = NULL; tray.notification_text = NULL; tray.notification_cb = NULL; tray.notification_icon = NULL; tray.icon = TRAY_ICON_PAUSING; tray_update(&tray); char msg[256]; sprintf(msg, "Streaming paused for %s", app_name.c_str()); tray.icon = TRAY_ICON_PAUSING; tray.notification_title = "Stream Paused"; tray.notification_text = msg; tray.tooltip = msg; tray.notification_icon = TRAY_ICON_PAUSING; tray_update(&tray); } /** * @brief Sets the tray icon in stopped mode (app and stream stopped) and spawns the appropriate notification * @param app_name The started application name */ void update_tray_stopped(std::string app_name) { tray.notification_title = NULL; tray.notification_text = NULL; tray.notification_cb = NULL; tray.notification_icon = NULL; tray.icon = TRAY_ICON; tray_update(&tray); char msg[256]; sprintf(msg, "Application %s successfully stopped", app_name.c_str()); tray.icon = TRAY_ICON; tray.notification_icon = TRAY_ICON; tray.notification_title = "Application Stopped"; tray.notification_text = msg; tray.tooltip = PROJECT_NAME; tray_update(&tray); } /** * @brief Spawns a notification for PIN Pairing. Clicking it opens the PIN Web UI Page */ void update_tray_require_pin() { tray.notification_title = NULL; tray.notification_text = NULL; tray.notification_cb = NULL; tray.notification_icon = NULL; tray.icon = TRAY_ICON; tray_update(&tray); tray.icon = TRAY_ICON; tray.notification_title = "Incoming Pairing Request"; tray.notification_text = "Click here to complete the pairing process"; tray.notification_icon = TRAY_ICON_LOCKED; tray.tooltip = PROJECT_NAME; tray.notification_cb = []() { launch_ui_with_path("/pin"); }; tray_update(&tray); } } // namespace system_tray #endif