Files
cartridges/src/window.py
2023-08-30 10:47:55 +02:00

531 lines
19 KiB
Python

# window.py
#
# Copyright 2022-2023 kramo
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# SPDX-License-Identifier: GPL-3.0-or-later
from typing import Any, Optional
from gi.repository import Adw, Gio, GLib, Gtk
from src import shared
from src.game import Game
from src.game_cover import GameCover
from src.utils.relative_date import relative_date
@Gtk.Template(resource_path=shared.PREFIX + "/gtk/window.ui")
class CartridgesWindow(Adw.ApplicationWindow):
__gtype_name__ = "CartridgesWindow"
overlay_split_view = Gtk.Template.Child()
navigation_view = Gtk.Template.Child()
sidebar = Gtk.Template.Child()
all_games_row_box = Gtk.Template.Child()
all_games_no_label = Gtk.Template.Child()
added_row_box = Gtk.Template.Child()
added_games_no_label = Gtk.Template.Child()
toast_overlay = Gtk.Template.Child()
primary_menu_button = Gtk.Template.Child()
show_sidebar_button = Gtk.Template.Child()
details_view = Gtk.Template.Child()
library_page = Gtk.Template.Child()
library_view = Gtk.Template.Child()
library = Gtk.Template.Child()
scrolledwindow = Gtk.Template.Child()
library_overlay = Gtk.Template.Child()
notice_empty = Gtk.Template.Child()
notice_no_results = Gtk.Template.Child()
search_bar = Gtk.Template.Child()
search_entry = Gtk.Template.Child()
search_button = Gtk.Template.Child()
details_page = Gtk.Template.Child()
details_view_toolbar_view = Gtk.Template.Child()
details_view_cover = Gtk.Template.Child()
details_view_spinner = Gtk.Template.Child()
details_view_title = Gtk.Template.Child()
details_view_blurred_cover = Gtk.Template.Child()
details_view_play_button = Gtk.Template.Child()
details_view_developer = Gtk.Template.Child()
details_view_added = Gtk.Template.Child()
details_view_last_played = Gtk.Template.Child()
details_view_hide_button = Gtk.Template.Child()
hidden_library_page = Gtk.Template.Child()
hidden_primary_menu_button = Gtk.Template.Child()
hidden_library = Gtk.Template.Child()
hidden_library_view = Gtk.Template.Child()
hidden_scrolledwindow = Gtk.Template.Child()
hidden_library_overlay = Gtk.Template.Child()
hidden_notice_empty = Gtk.Template.Child()
hidden_notice_no_results = Gtk.Template.Child()
hidden_search_bar = Gtk.Template.Child()
hidden_search_entry = Gtk.Template.Child()
hidden_search_button = Gtk.Template.Child()
game_covers: dict = {}
toasts: dict = {}
active_game: Game
details_view_game_cover: Optional[GameCover] = None
sort_state: str = "a-z"
filter_state: str = "all"
source_rows: dict = {}
def create_source_rows(self) -> None:
def get_removed(source_id: str) -> Any:
removed = tuple(
game.removed or game.hidden or game.blacklisted
for game in shared.store.source_games[source_id].values()
)
return (
(count,) if (count := sum(removed)) != len(removed) else False
) # Return a tuple because 0 == False and 1 == True
total_games_no = 0
restored = False
selected_id = (
self.source_rows[selected_row][0]
if (selected_row := self.sidebar.get_selected_row()) in self.source_rows
else None
)
if selected_row == self.added_row_box.get_parent():
self.sidebar.select_row(self.added_row_box.get_parent())
restored = True
if added_missing := (
not shared.store.source_games.get("imported")
or not (removed := get_removed("imported"))
):
self.sidebar.select_row(self.all_games_row_box.get_parent())
else:
games_no = len(shared.store.source_games["imported"]) - removed[0]
self.added_games_no_label.set_label(str(games_no))
total_games_no += games_no
self.added_row_box.get_parent().set_visible(not added_missing)
self.sidebar.get_row_at_index(2).set_visible(False)
while row := self.sidebar.get_row_at_index(3):
self.sidebar.remove(row)
for source_id in shared.store.source_games:
if source_id == "imported":
continue
if not (removed := get_removed(source_id)):
continue
row = Gtk.Box(
margin_top=12,
margin_bottom=12,
margin_start=6,
margin_end=6,
spacing=12,
)
games_no = len(shared.store.source_games[source_id]) - removed[0]
total_games_no += games_no
row.append(
Gtk.Image.new_from_icon_name(
"user-desktop-symbolic"
if (split_id := source_id.split("_")[0]) == "desktop"
else f"{split_id}-source-symbolic"
)
)
row.append(
Gtk.Label(
label=self.get_application().get_source_name(source_id),
halign=Gtk.Align.START,
)
)
row.append(
games_no_label := Gtk.Label(
label=games_no,
hexpand=True,
halign=Gtk.Align.END,
)
)
games_no_label.add_css_class("dim-label")
# Order rows based on the number of games in them
index = 3
while source_row := self.sidebar.get_row_at_index(index):
if self.source_rows[source_row][1] < games_no:
self.sidebar.insert(row, index)
break
index += 1
if not row.get_parent():
self.sidebar.append(row)
self.source_rows[row.get_parent()] = (
source_id,
games_no,
)
if source_id == selected_id:
self.sidebar.select_row(row.get_parent())
restored = True
self.sidebar.get_row_at_index(2).set_visible(True)
self.all_games_no_label.set_label(str(total_games_no))
if not restored:
self.sidebar.select_row(self.all_games_row_box.get_parent())
def row_selected(self, _widget: Any, row: Gtk.ListBoxRow | None) -> None:
if not row:
return
match row.get_child():
case self.all_games_row_box:
value = "all"
case self.added_row_box:
value = "imported"
case _:
value = self.source_rows[row][0]
self.library_page.set_title(self.get_application().get_source_name(value))
self.filter_state = value
self.library.invalidate_filter()
if self.overlay_split_view.get_collapsed():
self.overlay_split_view.set_show_sidebar(False)
def __init__(self, **kwargs: Any) -> None:
super().__init__(**kwargs)
self.details_view.set_measure_overlay(self.details_view_toolbar_view, True)
self.details_view.set_clip_overlay(self.details_view_toolbar_view, False)
self.library.set_filter_func(self.filter_func)
self.hidden_library.set_filter_func(self.filter_func)
self.library.set_sort_func(self.sort_func)
self.hidden_library.set_sort_func(self.sort_func)
self.set_library_child()
self.notice_empty.set_icon_name(shared.APP_ID + "-symbolic")
self.overlay_split_view.set_show_sidebar(
shared.state_schema.get_boolean("show-sidebar")
)
self.sidebar.select_row(self.all_games_row_box.get_parent())
if shared.PROFILE == "development":
self.add_css_class("devel")
# Connect search entries
self.search_bar.connect_entry(self.search_entry)
self.hidden_search_bar.connect_entry(self.hidden_search_entry)
# Connect signals
self.search_entry.connect("search-changed", self.search_changed, False)
self.hidden_search_entry.connect("search-changed", self.search_changed, True)
self.search_entry.connect("activate", self.show_details_page_search)
self.hidden_search_entry.connect("activate", self.show_details_page_search)
self.navigation_view.connect("popped", self.set_show_hidden)
self.navigation_view.connect("pushed", self.set_show_hidden)
self.sidebar.connect("row-selected", self.row_selected)
style_manager = Adw.StyleManager.get_default()
style_manager.connect("notify::dark", self.set_details_view_opacity)
style_manager.connect("notify::high-contrast", self.set_details_view_opacity)
# Allow for a custom number of rows for the library
if shared.schema.get_uint("library-rows"):
shared.schema.bind(
"library-rows",
self.library,
"max-children-per-line",
Gio.SettingsBindFlags.DEFAULT,
)
shared.schema.bind(
"library-rows",
self.hidden_library,
"max-children-per-line",
Gio.SettingsBindFlags.DEFAULT,
)
def search_changed(self, _widget: Any, hidden: bool) -> None:
# Refresh search filter on keystroke in search box
(self.hidden_library if hidden else self.library).invalidate_filter()
def set_library_child(self) -> None:
child, hidden_child = self.notice_empty, self.hidden_notice_empty
for game in shared.store:
if game.removed or game.blacklisted:
continue
if game.hidden:
if game.filtered and hidden_child:
hidden_child = self.hidden_notice_no_results
continue
hidden_child = None
else:
if game.filtered and child:
child = self.notice_no_results
continue
child = None
def remove_from_overlay(widget: Gtk.Widget) -> None:
if isinstance(widget.get_parent(), Gtk.Overlay):
widget.get_parent().remove_overlay(widget)
if child:
self.library_overlay.add_overlay(child)
else:
remove_from_overlay(self.notice_empty)
remove_from_overlay(self.notice_no_results)
if hidden_child:
self.hidden_library_overlay.add_overlay(hidden_child)
else:
remove_from_overlay(self.hidden_notice_empty)
remove_from_overlay(self.hidden_notice_no_results)
def filter_func(self, child: Gtk.Widget) -> bool:
game = child.get_child()
text = (
(
self.hidden_search_entry
if self.navigation_view.get_visible_page() == self.hidden_library_page
else self.search_entry
)
.get_text()
.lower()
)
filtered = text != "" and not (
text in game.name.lower()
or (text in game.developer.lower() if game.developer else False)
)
if not filtered:
if self.filter_state == "all":
pass
elif game.base_source != self.filter_state:
filtered = True
game.filtered = filtered
self.set_library_child()
return not filtered
def set_active_game(self, _widget: Any, _pspec: Any, game: Game) -> None:
self.active_game = game
def show_details_page(self, game: Game) -> None:
self.active_game = game
self.details_view_cover.set_opacity(int(not game.loading))
self.details_view_spinner.set_spinning(game.loading)
self.details_view_developer.set_label(game.developer or "")
self.details_view_developer.set_visible(bool(game.developer))
icon, text = "view-conceal-symbolic", _("Hide")
if game.hidden:
icon, text = "view-reveal-symbolic", _("Unhide")
self.details_view_hide_button.set_icon_name(icon)
self.details_view_hide_button.set_tooltip_text(text)
if self.details_view_game_cover:
self.details_view_game_cover.pictures.remove(self.details_view_cover)
self.details_view_game_cover = game.game_cover
self.details_view_game_cover.add_picture(self.details_view_cover)
self.details_view_blurred_cover.set_paintable(
self.details_view_game_cover.get_blurred()
)
self.details_view_title.set_label(game.name)
self.details_page.set_title(game.name)
date = relative_date(game.added)
self.details_view_added.set_label(
# The variable is the date when the game was added
_("Added: {}").format(date)
)
last_played_date = (
relative_date(game.last_played) if game.last_played else _("Never")
)
self.details_view_last_played.set_label(
# The variable is the date when the game was last played
_("Last played: {}").format(last_played_date)
)
if self.navigation_view.get_visible_page() != self.details_page:
self.navigation_view.push(self.details_page)
self.set_focus(self.details_view_play_button)
self.set_details_view_opacity()
def set_details_view_opacity(self, *_args: Any) -> None:
if self.navigation_view.get_visible_page() != self.details_page:
return
if (
style_manager := Adw.StyleManager.get_default()
).get_high_contrast() or not style_manager.get_system_supports_color_schemes():
self.details_view_blurred_cover.set_opacity(0.3)
return
self.details_view_blurred_cover.set_opacity(
1 - self.details_view_game_cover.luminance[0] # type: ignore
if style_manager.get_dark()
else self.details_view_game_cover.luminance[1] # type: ignore
)
def sort_func(self, child1: Gtk.Widget, child2: Gtk.Widget) -> int:
var, order = "name", True
if self.sort_state in ("newest", "oldest"):
var, order = "added", self.sort_state == "newest"
elif self.sort_state == "last_played":
var = "last_played"
elif self.sort_state == "a-z":
order = False
def get_value(index: int) -> str:
return str(
getattr((child1.get_child(), child2.get_child())[index], var)
).lower()
if var != "name" and get_value(0) == get_value(1):
var, order = "name", False
return ((get_value(0) > get_value(1)) ^ order) * 2 - 1
def set_show_hidden(self, navigation_view: Adw.NavigationView, *_args: Any) -> None:
self.lookup_action("show_hidden").set_enabled(
navigation_view.get_visible_page() == self.library_page
)
def on_show_sidebar_action(self, *_args: Any) -> None:
shared.state_schema.set_boolean(
"show-sidebar", (value := not self.overlay_split_view.get_show_sidebar())
)
self.overlay_split_view.set_show_sidebar(value)
def on_go_to_parent_action(self, *_args: Any) -> None:
if self.navigation_view.get_visible_page() == self.details_page:
self.navigation_view.pop()
def on_go_home_action(self, *_args: Any) -> None:
self.navigation_view.pop_to_page(self.library_page)
def on_show_hidden_action(self, *_args: Any) -> None:
self.navigation_view.push(self.hidden_library_page)
def on_sort_action(self, action: Gio.SimpleAction, state: GLib.Variant) -> None:
action.set_state(state)
self.sort_state = str(state).strip("'")
self.library.invalidate_sort()
shared.state_schema.set_string("sort-mode", self.sort_state)
def on_toggle_search_action(self, *_args: Any) -> None:
if self.navigation_view.get_visible_page() == self.library_page:
search_bar = self.search_bar
search_entry = self.search_entry
elif self.navigation_view.get_visible_page() == self.hidden_library_page:
search_bar = self.hidden_search_bar
search_entry = self.hidden_search_entry
else:
return
search_bar.set_search_mode(not (search_mode := search_bar.get_search_mode()))
if not search_mode:
self.set_focus(search_entry)
search_entry.set_text("")
def on_escape_action(self, *_args: Any) -> None:
if (
self.get_focus() == self.search_entry.get_focus_child()
or self.hidden_search_entry.get_focus_child()
):
self.on_toggle_search_action()
else:
self.navigation_view.pop()
def show_details_page_search(self, widget: Gtk.Widget) -> None:
library = (
self.hidden_library if widget == self.hidden_search_entry else self.library
)
index = 0
while True:
if not (child := library.get_child_at_index(index)):
break
if self.filter_func(child):
self.show_details_page(child.get_child())
break
index += 1
def on_undo_action(
self, _widget: Any, game: Optional[Game] = None, undo: Optional[str] = None
) -> None:
if not game: # If the action was activated via Ctrl + Z
if shared.importer and (
shared.importer.imported_game_ids or shared.importer.removed_game_ids
):
shared.importer.undo_import()
return
try:
game = tuple(self.toasts.keys())[-1][0]
undo = tuple(self.toasts.keys())[-1][1]
except IndexError:
return
if game:
if undo == "hide":
game.toggle_hidden(False)
elif undo == "remove":
game.removed = False
game.save()
game.update()
self.toasts[(game, undo)].dismiss()
self.toasts.pop((game, undo))
def on_open_menu_action(self, *_args: Any) -> None:
if self.navigation_view.get_visible_page() == self.library_page:
self.primary_menu_button.popup()
elif self.navigation_view.get_visible_page() == self.hidden_library_page:
self.hidden_primary_menu_button.popup()
def on_close_action(self, *_args: Any) -> None:
self.close()