Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(windows): disable shortcut mode for WGC #3344

Closed

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Oct 30, 2024

Description

This PR slightly improves WGC experience by doing the following:

  • Disables "shortcut" mode when WGC is enabled (either from CLI args or from the config option).
  • Add a WGC specific start menu shortcut. This works if running as "Admin", but fails otherwise due to permissions accessing the config directory. I'm not sure how to make the shortcut have "run as administrator" mode, which I know is possible in Windows, but I don't know if it's possible from NSIS.

Additional ideas I have, but not really sure the best way to handle are:

  • Auto toggle the service on or off when changing capture mode.

This PR also fixes one small typo from #3343.

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Copy link

codecov bot commented Oct 30, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 11.15%. Comparing base (ec0cdcf) to head (d6edd9b).
Report is 94 commits behind head on master.

Files with missing lines Patch % Lines
src/config.cpp 0.00% 4 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           master    #3344    +/-   ##
========================================
  Coverage   11.14%   11.15%            
========================================
  Files          99       99            
  Lines       17186    17190     +4     
  Branches     8009     8011     +2     
========================================
+ Hits         1916     1917     +1     
+ Misses      12724    12586   -138     
- Partials     2546     2687   +141     
Flag Coverage Δ
Linux 8.45% <ø> (ø)
Windows 5.22% <0.00%> (-0.01%) ⬇️
macOS-13 13.63% <ø> (-0.02%) ⬇️
macOS-14 12.64% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/config.cpp 5.65% <0.00%> (-0.04%) ⬇️

... and 22 files with indirect coverage changes

@ReenigneArcher ReenigneArcher force-pushed the fix/windows/disable-shortcut-mode-for-WGC branch from 7c397b4 to d6edd9b Compare October 30, 2024 23:07
@ReenigneArcher ReenigneArcher marked this pull request as ready for review October 30, 2024 23:13
Copy link

if (config::video.capture == "wgc" && (shortcut_launch || service_admin_launch)) {
BOOST_LOG(info) << "Disabling service launch because WGC capture mode is enabled"sv;
shortcut_launch = false;
service_admin_launch = false;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will mean we launch as non-admin right? I don't think we'll have access to our config files in that case.

Copy link
Member Author

@ReenigneArcher ReenigneArcher Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did have to run the new shortcut as admin, but as far as I understand with that variable enabled, it will try to start the service which currently does not work with WGC.

Sunshine/src/config.cpp

Lines 1289 to 1295 in ec0cdcf

if (service_admin_launch) {
// This is a relaunch as admin to start the service
service_ctrl::start_service();
// Always return 1 to ensure Sunshine doesn't start normally
return 1;
}

Perhaps instead of disabling "shortcut_launch", it would be better to add a new shortcut_launch_wgc variable?

Copy link
Collaborator

@cgutman cgutman Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little hesistant to add another shortcut, especially one that activates a Beta option and requires the user to know to run it as admin. I remember the bad old days when we were telling users not to use our shortcuts because they would run Sunshine in a confusing configuration (non-admin, possible concurrently with the service-based Sunshine instance).

I feel like this is stepping back into that usability mess again. I know that the experience for WGC isn't great today with the current shortcut behavior, but that's a beta feature that probably less than 1% of people use. I don't want to confuse the other 99% (who probably don't even know what "WGC" means) to try to make the experience slightly better for those few WGC users.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little hesistant to add another shortcut, especially one that activates a Beta option and requires the user to know to run it as admin.

My wording was probably confusing. I mean using the variable shortcut_launch_wgc, and then have a similar conditional check to

Sunshine/src/config.cpp

Lines 1296 to 1328 in ec0cdcf

else if (shortcut_launch) {
if (!service_ctrl::is_service_running()) {
// If the service isn't running, relaunch ourselves as admin to start it
WCHAR executable[MAX_PATH];
GetModuleFileNameW(NULL, executable, ARRAYSIZE(executable));
SHELLEXECUTEINFOW shell_exec_info {};
shell_exec_info.cbSize = sizeof(shell_exec_info);
shell_exec_info.fMask = SEE_MASK_NOASYNC | SEE_MASK_NO_CONSOLE | SEE_MASK_NOCLOSEPROCESS;
shell_exec_info.lpVerb = L"runas";
shell_exec_info.lpFile = executable;
shell_exec_info.lpParameters = L"--shortcut-admin";
shell_exec_info.nShow = SW_NORMAL;
if (!ShellExecuteExW(&shell_exec_info)) {
auto winerr = GetLastError();
std::cout << "Error: ShellExecuteEx() failed:"sv << winerr << std::endl;
return 1;
}
// Wait for the elevated process to finish starting the service
WaitForSingleObject(shell_exec_info.hProcess, INFINITE);
CloseHandle(shell_exec_info.hProcess);
// Wait for the UI to be ready for connections
service_ctrl::wait_for_ui_ready();
}
// Launch the web UI
launch_ui();
// Always return 1 to ensure Sunshine doesn't start normally
return 1;
}
that would launch it automatically as admin. Looking at that code it seems possible to relaunch as admin, without requiring the user to do "runas" manually. If this could work, no new start menu shortcut would be required and then it would just rely on the user changing their config (I think).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could avoid the service launch if we detect WGC is enabled and just launch as admin, but there is still the concern with coexistence with any running service-based Sunshine process. I'm not really sure how to nicely solve that without creating a scenario where the user could fairly trivially break it by toggling the capture method.

@ReenigneArcher ReenigneArcher marked this pull request as draft October 31, 2024 23:48
@ReenigneArcher ReenigneArcher deleted the fix/windows/disable-shortcut-mode-for-WGC branch November 1, 2024 00:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants