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.

Sign up for GitHub

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

CtInfo: Add Button to Mark Compat Tool as Global #336

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

CtInfo: Add Button to Mark Compat Tool as Global #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
83537b1
CtInfo: Add button to make compat tool global default
sonic2kk Dec 16, 2023
6e8cbdf
CtInfo: Only show Mark Global button for Steam launcher
sonic2kk Dec 16, 2023
5236d50
CtInfo: Only show Mark Global for CTType.CUSTOM
sonic2kk Dec 16, 2023
98dc0ec
CtInfo: Initial implementation of set_global_compat_tool
sonic2kk Dec 16, 2023
cbd2318
CtInfo: Don't show Mark Global button for Global Tool
sonic2kk Dec 17, 2023
03cd5c3
CtInfo: Remove print
sonic2kk Jan 30, 2024
b2ded73
steamutil: Enable writing to config.vdf
sonic2kk Jan 30, 2024
5aad7b8
Merge branch 'main' into global-compat-tool-button
DavidoTek Mar 24, 2024
618083e
steamutil: `return 1` when adding shortcut fails
sonic2kk Apr 20, 2024
5b0793a
CtInfo: Break out is_mark_global_available out into a util function
sonic2kk Apr 20, 2024
6fd4d26
CtInfo: Correctly bind btn_mark_global_clicked to btnMarkGlobal
sonic2kk Apr 25, 2024
9f7c1c2
Refactor to use generic set_launcher_global_tool util function
sonic2kk Jun 2, 2024
02fd807
Set correct tab focus order
sonic2kk Jun 2, 2024
24061ce
remove unnecessary property from CtInfo designer file
sonic2kk Jun 2, 2024
05fb631
Toggle Mark Global button visibility after pressing
sonic2kk Jun 16, 2024
08849b7
Use return value of `set_steam_global_compat_tool` in `set_launcher_g…
sonic2kk Jun 16, 2024
922f9cf
Don't allow marking already global compat tools as global
sonic2kk Jul 6, 2024
c1fa092
steamutil: Simplify set_steam_global_compat_tool
sonic2kk Jul 6, 2024
6394f9b
Move self.is_mark_global_available assignment to update_game_list_ui
sonic2kk Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions pupgui2/pupgui2ctinfodialog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from pupgui2.lutrisutil import get_lutris_game_list, is_lutris_game_using_wine
from pupgui2.pupgui2ctbatchupdatedialog import PupguiCtBatchUpdateDialog
from pupgui2.steamutil import get_steam_game_list
from pupgui2.util import open_webbrowser_thread, get_random_game_name
from pupgui2.util import open_webbrowser_thread, get_random_game_name, is_mark_global_available, set_launcher_global_tool
from pupgui2.heroicutil import get_heroic_game_list, is_heroic_launcher

from PySide6.QtCore import QObject, Signal, QDataStream, QByteArray
Expand All @@ -29,6 +29,7 @@ def __init__(self, parent=None, ctool: BasicCompatTool = None, install_loc=None)
self.games: List[Union[SteamApp, LutrisGame, HeroicGame]] = []
self.install_loc = install_loc
self.is_batch_update_available = False
self.is_mark_global_available = False

self.load_ui()
self.setup_ui()
Expand All @@ -41,13 +42,14 @@ def load_ui(self):
self.ui = loader.load(ui_file.device())

def setup_ui(self):
self.update_game_list()

self.ui.txtToolName.setText(self.ctool.displayname)
self.ui.txtLauncherName.setText(self.install_loc.get('display_name'))
self.ui.txtInstallDirectory.setText(self.ctool.get_install_dir())
self.ui.btnBatchUpdate.setVisible(False)
self.ui.searchBox.setVisible(False)

self.update_game_list()
self.ui.btnMarkGlobal.setVisible(self.is_mark_global_available) # Gets updated in update_game_list

self.ui.btnSearch.clicked.connect(self.btn_search_clicked)
self.ui.btnRefreshGames.clicked.connect(self.btn_refresh_games_clicked)
Expand Down Expand Up @@ -118,6 +120,8 @@ def setup_game_list(self, row_count: int, header_labels: List[str]):
self.ui.txtNumGamesUsingTool.setText(str(row_count))

def update_game_list_ui(self):
self.is_mark_global_available = is_mark_global_available(self.install_loc, self.ctool)

# switch between showing the QTableWidget (listGames) or the QLabel (lblGamesList)
self.ui.stackTableOrText.setCurrentIndex(0 if len(self.games) > 0 and not self.ctool.is_global else 1)
self.ui.btnBatchUpdate.setEnabled(len(self.games) > 0 and not self.ctool.is_global)
Expand All @@ -126,6 +130,10 @@ def update_game_list_ui(self):
if self.ctool.is_global:
self.ui.lblGamesList.setText(self.tr('Tool is Global'))

self.ui.btnMarkGlobal.setVisible(self.is_mark_global_available)
if self.is_mark_global_available:
self.ui.btnMarkGlobal.clicked.connect(self.btn_mark_global_clicked)

if len(self.games) < 0 or self.ctool.is_global:
self.ui.btnClose.setFocus()

Expand Down Expand Up @@ -161,3 +169,7 @@ def search_ctinfo_games(self, text):
for row in range(self.ui.listGames.rowCount()):
should_hide: bool = not text.lower() in self.ui.listGames.item(row, 1).text().lower()
self.ui.listGames.setRowHidden(row, should_hide)

def btn_mark_global_clicked(self):
Copy link
Owner

Choose a reason for hiding this comment

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

I wonder if we should disable the button after clicking because there currently is no visual feedback of the event.

That could be as simple as self.btnMarkGlobal.setEnabled(false). We would need to add another check in the constructor so that the user won't click the button if it is already global.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh that's a good idea!

There's no reason to click this button again after marking a tool as global, at least not in the context of the currently open dialog.

An edge case could be opening two ctinfo dialogs at once, say GE-Proton9-7 and Luxtorpeda (just to have distinct examples). This is extremely unlikely to ever happen and could be alleviated with other behaviour, it's not a reason against implementing this button disabling but an outline of a potential problem scenario (although again, I really don't think anyone would do this if they weren't trying to break something)

  1. User opens both dialogs at once.
  2. User marks GE-Proton9-7 as Global.
  3. With this suggestion, the button is disabled.
  4. User then marks Luxtorpeda as Global without closing the prior dialog.
  5. Perhaps a user did this in error and now they want GE-Proton9-7 to be the global tool again.
  6. But since the global button is disabled on the GE-Proton9-7 dialog, they cannot.
  7. Re-opening the dialog would fix this but it may not be very visually obvious.

A big way to alleviate this being a problem is the confirmation dialog noted earlier, because it would vastly reduce the likelihood of accidentally setting a tool as global.

There's also the possibility of closing the dialog which could be seen as expected since it's on the bottom row of the dialog buttons, but perhaps also not.

Disabling the button makes sense to me, I'll add it when I get home. I'm not sure if we want to close dialogs after a tool is marked as global, it might be a little jarring.

I also had a thought, I don't remember what happens if a tool is marked as global and then the game list is refreshed. If we get the "tool is global" text like if the user closed and re-opened the dialog, maybe the button also gets hidden, which I think is good too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, actually it seems like we don't hide the Mark Global button when the games list is refreshed.

We check if we should display the Mark Global button when loading the ctinfo dialog with self.ui.btnMarkGlobal.setVisible(self.is_mark_global_available), perhaps we should also call this in update_game_list_ui?

I'm thinking we should rework the logic like this:

  1. Remove the initial btnMarkGlobal.setVisible call from setup_ui.
  2. setup_ui calls update_game_list (updates launcher-specific UI elements) which in turn calls update_game_list_ui (handles generic non-launcher-specific UI elements)
  3. In update_game_list_ui we can call check if the Mark Global button should be displayed using self.ui.btnMarkGlobal.setVisible(self.is_mark_global_available) (since we may want to display this for other launchers, and is_mark_global_available will handle checking if Mark Global is available for the current launcher anyway)
    a. Right now the logic is only set if the current launcher is Steam, but with the recent refactor, we can call this generically and call this regardless of our current launcher, because is_mark_global_available is responsible for checking if the current launcher supports this action
  4. We also move the self.ui.btnMarkGlobal.clicked.connect action to connect the button logic from update_game_list to update_game_list_ui
    a. Similar to above, this is also nested in a Steam-specific launcher check, but calling it from update_game_list_ui means we can connect this action regardless of launcher. Then the only thing we need to care about is if is_mark_global_available is True or False, and we don't need to care about knowing whether or not the launcher should support it, that's taken care of by the call to is_mark_global_available.
  5. Update set_launcher_global_tool to return a success boolean
  6. Change the call to set_launcher_global_tool to actually update is_mark_global_available, like this: self.is_mark_global_available = set_launcher_global_tool(self.install_loc, self.ctool). We could I guess hardcode self.is_mark_global_available = False but that would assume set_launcher_global_tool will always succeed. If set_launcher_global_tool fails, this approach means we will update the value correctly.
    a. We could simply leave set_launcher_global_tool unchanged and instead make another call like this: self.is_mark_global_available = is_mark_global_available(self.install_loc, self.ctool) to achieve the same thing. The approach here is more stylistic preference, although I think personally making set_launcher_global_tool return a success boolean is a bit cleaner.
  7. This would mean we wouldn't need to disable the button. Instead, we will update is_mark_global_available and our existing call to btn_refresh_games_clicked will handle running all the checks again for whether or not the Mark Global button should be displayed, using the same refactored logic described above that we would use when the dialog opens.

Basically we move the logic to set whether the button is visible or not into update_game_list_ui, meaning we will update it regardless of launcher, because is_mark_global_available performs a launcher check for us. Then when we mark a tool as global, we update the value of self.is_mark_global_available. Finally our existing call to refresh the game list elements means we will pick up any changes to is_mark_global_available and show/hide the button.

The reason showing and hiding may be better is because we show/hide the button when the dialog opens.

self.is_mark_global_available = not set_launcher_global_tool(self.install_loc, self.ctool)
self.btn_refresh_games_clicked()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The reference to self.ctool is updated when the refresh button is clicked. This means self.ctool.is_global is still False. So when the tool is marked as global, or when the refresh button is generally clicked (i.e. if the global Steam compat tool was updated externally while the CtInfo dialog was open, and the refresh button was pressed after that) the dialog does not updated to reflect that the tool is global.

So if GE-Proton9-7's CtInfo dialog is open, and the global compat tool in config.vdf is updated to be GE-Proton9-7, pressing the refresh button will not show/hide the Mark Global button, and it will not update the game list to display "Tool is Global".

However, it does update the compat tool list on the Main Menu to display (global) because the compat tool name!

And re-opening the dialog of course works as expected.

I'm not sure how to fix this one, it is a bit of an edge-case and at worst something we can update in a later PR.

42 changes: 24 additions & 18 deletions pupgui2/resources/ui/pupgui2_ctinfodialog.ui
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@
<string>About compatibility tool</string>
</property>
<property name="windowIcon">
<iconset theme="pupgui2">
<normaloff>.</normaloff>.</iconset>
<iconset theme="pupgui2"/>
</property>
<layout class="QVBoxLayout" name="verticalLayout">
<item>
Expand All @@ -33,7 +32,7 @@
<string/>
</property>
<property name="textInteractionFlags">
<set>Qt::LinksAccessibleByMouse|Qt::TextSelectableByMouse</set>
<set>Qt::TextInteractionFlag::LinksAccessibleByMouse|Qt::TextInteractionFlag::TextSelectableByMouse</set>
</property>
</widget>
</item>
Expand All @@ -50,7 +49,7 @@
<string/>
</property>
<property name="textInteractionFlags">
<set>Qt::LinksAccessibleByMouse|Qt::TextSelectableByMouse</set>
<set>Qt::TextInteractionFlag::LinksAccessibleByMouse|Qt::TextInteractionFlag::TextSelectableByMouse</set>
</property>
</widget>
</item>
Expand All @@ -67,7 +66,7 @@
<string/>
</property>
<property name="textInteractionFlags">
<set>Qt::LinksAccessibleByMouse|Qt::TextSelectableByMouse</set>
<set>Qt::TextInteractionFlag::LinksAccessibleByMouse|Qt::TextInteractionFlag::TextSelectableByMouse</set>
</property>
</widget>
</item>
Expand All @@ -76,7 +75,7 @@
<item>
<widget class="Line" name="line">
<property name="orientation">
<enum>Qt::Horizontal</enum>
<enum>Qt::Orientation::Horizontal</enum>
</property>
</widget>
</item>
Expand All @@ -99,7 +98,7 @@
<item>
<spacer name="horizontalSpacer_2">
<property name="orientation">
<enum>Qt::Horizontal</enum>
<enum>Qt::Orientation::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
Expand All @@ -118,8 +117,7 @@
<string/>
</property>
<property name="icon">
<iconset theme="view-refresh">
<normaloff>.</normaloff>.</iconset>
<iconset theme="view-refresh"/>
</property>
</widget>
</item>
Expand All @@ -132,8 +130,7 @@
<string/>
</property>
<property name="icon">
<iconset theme="search">
<normaloff>.</normaloff>.</iconset>
<iconset theme="search"/>
</property>
</widget>
</item>
Expand Down Expand Up @@ -170,13 +167,13 @@
</sizepolicy>
</property>
<property name="focusPolicy">
<enum>Qt::ClickFocus</enum>
<enum>Qt::FocusPolicy::ClickFocus</enum>
</property>
<property name="editTriggers">
<set>QAbstractItemView::NoEditTriggers</set>
<set>QAbstractItemView::EditTrigger::NoEditTriggers</set>
</property>
<property name="selectionBehavior">
<enum>QAbstractItemView::SelectRows</enum>
<enum>QAbstractItemView::SelectionBehavior::SelectRows</enum>
</property>
<property name="sortingEnabled">
<bool>true</bool>
Expand Down Expand Up @@ -248,7 +245,7 @@
<string>No games</string>
</property>
<property name="alignment">
<set>Qt::AlignCenter</set>
<set>Qt::AlignmentFlag::AlignCenter</set>
</property>
</widget>
</item>
Expand All @@ -275,10 +272,17 @@
</property>
</widget>
</item>
<item>
<widget class="QPushButton" name="btnMarkGlobal">
<property name="text">
<string>Set as Global</string>
</property>
</widget>
</item>
<item>
<spacer name="horizontalSpacer">
<property name="orientation">
<enum>Qt::Horizontal</enum>
<enum>Qt::Orientation::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
Expand All @@ -291,7 +295,7 @@
<item>
<widget class="QPushButton" name="btnClose">
<property name="focusPolicy">
<enum>Qt::StrongFocus</enum>
<enum>Qt::FocusPolicy::StrongFocus</enum>
</property>
<property name="text">
<string>Close</string>
Expand All @@ -304,10 +308,12 @@
</widget>
<tabstops>
<tabstop>btnClose</tabstop>
<tabstop>btnMarkGlobal</tabstop>
<tabstop>searchBox</tabstop>
<tabstop>btnBatchUpdate</tabstop>
<tabstop>btnSearch</tabstop>
<tabstop>searchBox</tabstop>
<tabstop>btnRefreshGames</tabstop>
<tabstop>lblGamesUsingTool</tabstop>
</tabstops>
<resources/>
<connections/>
Expand Down
31 changes: 31 additions & 0 deletions pupgui2/steamutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,8 @@ def install_steam_library_shortcut(steam_config_folder: str, remove_shortcut=Fal
except Exception as e:
print(f'Error: Could not add {APP_NAME} as Steam shortcut:', e)

return 1

return 0


Expand Down Expand Up @@ -794,6 +796,35 @@ def determine_most_recent_steam_user(steam_users: List[SteamUser]) -> SteamUser:
return None


def set_steam_global_compat_tool(steam_config_folder: str, ctool: BasicCompatTool):
""" Update the global compatibility tool to the ctool parameter defined in config.vdf CompatToolMapping (AppID '0') """

if ctool.ct_type != CTType.CUSTOM:
return False

config_vdf_file = os.path.join(os.path.expanduser(steam_config_folder), 'config.vdf')
if not os.path.exists(config_vdf_file):
return False

try:
d = vdf.load(open(config_vdf_file))
c = get_steam_vdf_compat_tool_mapping(d)

# Create or update the '0' CompatToolMapping entry
if not c.get('0', {}):
c['0'] = { 'name': ctool.get_internal_name(), 'config': '', 'priority': '75' }
else:
c['0']['name'] = ctool.get_internal_name()

vdf.dump(d, open(config_vdf_file, 'w'), pretty=True)
except Exception as e:
print(f'Error, could not update Global Steam compatibility tool to {ctool.displayname}: {e}, vdf: {config_vdf_file}')
return False

return True



def is_valid_steam_install(steam_path) -> bool:

"""
Expand Down
61 changes: 60 additions & 1 deletion pupgui2/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
from pupgui2.constants import AWACY_GAME_LIST_URL, LOCAL_AWACY_GAME_LIST
from pupgui2.constants import GITHUB_API, GITLAB_API, GITLAB_API_RATELIMIT_TEXT
from pupgui2.datastructures import BasicCompatTool, CTType, Launcher, SteamApp, LutrisGame, HeroicGame
from pupgui2.steamutil import remove_steamtinkerlaunch, is_valid_steam_install
from pupgui2.steamutil import remove_steamtinkerlaunch, is_valid_steam_install, set_steam_global_compat_tool


def create_msgbox(
Expand Down Expand Up @@ -892,3 +892,62 @@ def get_random_game_name(games: List[Union[SteamApp, LutrisGame, HeroicGame]]) -
tooltip_game_name = random_game.title

return tooltip_game_name


def is_mark_global_available(install_loc, ctool: BasicCompatTool) -> bool:

"""
Check if marking a tool is "global" is supported by the current launcher,
and if the given ctool can be marked as global for this launcher.

For example, runtimes are not valid to be marked as Global.

Return Type: bool
"""

allowed_launchers = [ 'steam', 'lutris' ] # Only allow marking global for these launchers

# Only allow marking global for compatibility tools and not runtimes etc
if ctool.ct_type != CTType.CUSTOM:
return False

# Don't allow marking global compat tools as global
if ctool.is_global:
return False

# Exit early if launcher is not on our list of compatible/allowed launchers
if install_loc.get('launcher') not in allowed_launchers:
return False

# Only allow marking global for Steam if we have the VDF directory path
if install_loc.get('launcher') == 'steam' and 'vdf_dir' not in install_loc:
return False

# Could put other conditions for other launchers in an elif here, i.e. check for Lutris and ensure a specific path exists
# Nothing here yet...

return True # All other checks passed so default to true


def set_launcher_global_tool(install_loc, compat_tool: BasicCompatTool) -> bool:

"""
Set a given compat_tool as global for a given launcher by calling the
relevant util function for that launcher.
"""

launcher = install_loc.get('launcher', '').lower()

# Skip empty launcher
if not launcher:
return False

if not is_mark_global_available(install_loc, compat_tool):
return False

if launcher == 'steam':
steam_config_folder = install_loc.get('vdf_dir', '')

return set_steam_global_compat_tool(steam_config_folder, compat_tool)

return False