Implement search provider (#201)

* Begin work on search provider

* Initial search provider work, organize meson

* Initial work on icons

* Implement LaunchSearch

* Don't hold arbitrary reference to service

I don't know why Lollypop does this

* Send notification, pad images

* Update translations

* Fix init_search_term typing

cartridges/store/managers/async_manager.py

@@ -0,0 +1,62 @@
+# async_manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# 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, Callable
+
+from gi.repository import Gio
+
+from cartridges.game import Game
+from cartridges.store.managers.manager import Manager
+
+
+class AsyncManager(Manager):
+    """Manager that can run asynchronously"""
+
+    blocking = False
+    cancellable: Gio.Cancellable = None
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.cancellable = Gio.Cancellable()
+
+    def cancel_tasks(self):
+        """Cancel all tasks for this manager"""
+        self.cancellable.cancel()
+
+    def reset_cancellable(self):
+        """Reset the cancellable for this manager.
+        Already scheduled Tasks will no longer be cancellable."""
+        self.cancellable = Gio.Cancellable()
+
+    def process_game(
+        self, game: Game, additional_data: dict, callback: Callable[["Manager"], Any]
+    ) -> None:
+        """Create a task to process the game in a separate thread"""
+        task = Gio.Task.new(None, self.cancellable, self._task_callback, (callback,))
+        task.run_in_thread(lambda *_: self._task_thread_func((game, additional_data)))
+
+    def _task_thread_func(self, data):
+        """Task thread entry point"""
+        game, additional_data, *_rest = data
+        self.run(game, additional_data)
+
+    def _task_callback(self, _source_object, _result, data):
+        """Method run after the task is done"""
+        callback, *_rest = data
+        callback(self)

cartridges/store/managers/cover_manager.py

@@ -0,0 +1,198 @@
+# local_cover_manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+# Copyright 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 pathlib import Path
+from typing import NamedTuple
+
+import requests
+from gi.repository import GdkPixbuf, Gio
+from requests.exceptions import HTTPError, SSLError
+
+from cartridges import shared
+from cartridges.game import Game
+from cartridges.store.managers.manager import Manager
+from cartridges.store.managers.steam_api_manager import SteamAPIManager
+from cartridges.utils.save_cover import convert_cover, save_cover
+
+
+class ImageSize(NamedTuple):
+    width: float = 0
+    height: float = 0
+
+    @property
+    def aspect_ratio(self) -> float:
+        return self.width / self.height
+
+    def __str__(self):
+        return f"{self.width}x{self.height}"
+
+    def __mul__(self, scale: float | int) -> "ImageSize":
+        return ImageSize(
+            self.width * scale,
+            self.height * scale,
+        )
+
+    def __truediv__(self, divisor: float | int) -> "ImageSize":
+        return self * (1 / divisor)
+
+    def __add__(self, other_size: "ImageSize") -> "ImageSize":
+        return ImageSize(
+            self.width + other_size.width,
+            self.height + other_size.height,
+        )
+
+    def __sub__(self, other_size: "ImageSize") -> "ImageSize":
+        return self + (other_size * -1)
+
+    def element_wise_div(self, other_size: "ImageSize") -> "ImageSize":
+        """Divide every element of self by the equivalent in the other size"""
+        return ImageSize(
+            self.width / other_size.width,
+            self.height / other_size.height,
+        )
+
+    def element_wise_mul(self, other_size: "ImageSize") -> "ImageSize":
+        """Multiply every element of self by the equivalent in the other size"""
+        return ImageSize(
+            self.width * other_size.width,
+            self.height * other_size.height,
+        )
+
+    def invert(self) -> "ImageSize":
+        """Invert the element of self"""
+        return ImageSize(1, 1).element_wise_div(self)
+
+
+class CoverManager(Manager):
+    """
+    Manager in charge of adding the cover image of the game
+
+    Order of priority is:
+    1. local cover
+    2. icon cover
+    3. online cover
+    """
+
+    run_after = (SteamAPIManager,)
+    retryable_on = (HTTPError, SSLError, ConnectionError)
+
+    def download_image(self, url: str) -> Path:
+        image_file = Gio.File.new_tmp()[0]
+        path = Path(image_file.get_path())
+        with requests.get(url, timeout=5) as cover:
+            cover.raise_for_status()
+            path.write_bytes(cover.content)
+        return path
+
+    def is_stretchable(self, source_size: ImageSize, cover_size: ImageSize) -> bool:
+        is_taller = source_size.aspect_ratio < cover_size.aspect_ratio
+        if is_taller:
+            return True
+        max_stretch = 0.12
+        resized_height = (1 / source_size.aspect_ratio) * cover_size.width
+        stretch = 1 - (resized_height / cover_size.height)
+        return stretch <= max_stretch
+
+    def composite_cover(
+        self,
+        image_path: Path,
+        scale: float = 1,
+        blur_size: ImageSize = ImageSize(2, 2),
+    ) -> GdkPixbuf.Pixbuf:
+        """
+        Return the image composited with a background blur.
+        If the image is stretchable, just stretch it.
+
+        :param path: Path where the source image is located
+        :param scale:
+            Scale of the smalled image side
+            compared to the corresponding side in the cover
+        :param blur_size: Size of the downscaled image used for the blur
+        """
+
+        # Load source image
+        source = GdkPixbuf.Pixbuf.new_from_file(
+            str(convert_cover(image_path, resize=False))
+        )
+        source_size = ImageSize(source.get_width(), source.get_height())
+        cover_size = ImageSize._make(shared.image_size)
+
+        # Stretch if possible
+        if scale == 1 and self.is_stretchable(source_size, cover_size):
+            return source
+
+        # Create the blurred cover background
+        # fmt: off
+        cover = (
+            source
+            .scale_simple(*blur_size, GdkPixbuf.InterpType.BILINEAR)
+            .scale_simple(*cover_size, GdkPixbuf.InterpType.BILINEAR)
+        )
+        # fmt: on
+
+        # Scale to fit, apply scaling, then center
+        uniform_scale = scale * min(cover_size.element_wise_div(source_size))
+        source_in_cover_size = source_size * uniform_scale
+        source_in_cover_position = (cover_size - source_in_cover_size) / 2
+
+        # Center the scaled source image in the cover
+        source.composite(
+            cover,
+            *source_in_cover_position,
+            *source_in_cover_size,
+            *source_in_cover_position,
+            uniform_scale,
+            uniform_scale,
+            GdkPixbuf.InterpType.BILINEAR,
+            255,
+        )
+        return cover
+
+    def main(self, game: Game, additional_data: dict) -> None:
+        if game.blacklisted:
+            return
+        for key in (
+            "local_image_path",
+            "local_icon_path",
+            "online_cover_url",
+        ):
+            # Get an image path
+            if not (value := additional_data.get(key)):
+                continue
+            if key == "online_cover_url":
+                image_path = self.download_image(value)
+            else:
+                image_path = Path(value)
+            if not image_path.is_file():
+                continue
+
+            # Icon cover
+            composite_kwargs = {}
+
+            if key == "local_icon_path":
+                composite_kwargs["scale"] = 0.7
+                composite_kwargs["blur_size"] = ImageSize(1, 2)
+
+            save_cover(
+                game.game_id,
+                convert_cover(
+                    pixbuf=self.composite_cover(image_path, **composite_kwargs)
+                ),
+            )

cartridges/store/managers/display_manager.py

@@ -0,0 +1,76 @@
+# display_manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# 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 cartridges import shared
+from cartridges.game import Game
+from cartridges.game_cover import GameCover
+from cartridges.store.managers.manager import Manager
+from cartridges.store.managers.sgdb_manager import SgdbManager
+from cartridges.store.managers.steam_api_manager import SteamAPIManager
+
+
+class DisplayManager(Manager):
+    """Manager in charge of adding a game to the UI"""
+
+    run_after = (SteamAPIManager, SgdbManager)
+    signals = {"update-ready"}
+
+    def main(self, game: Game, _additional_data: dict) -> None:
+        if game.get_parent():
+            game.get_parent().get_parent().remove(game)
+            if game.get_parent():
+                game.get_parent().set_child()
+
+        game.menu_button.set_menu_model(
+            game.hidden_game_options if game.hidden else game.game_options
+        )
+
+        game.title.set_label(game.name)
+
+        game.menu_button.get_popover().connect(
+            "notify::visible", game.toggle_play, None
+        )
+        game.menu_button.get_popover().connect(
+            "notify::visible", shared.win.set_active_game, game
+        )
+
+        if game.game_id in shared.win.game_covers:
+            game.game_cover = shared.win.game_covers[game.game_id]
+            game.game_cover.add_picture(game.cover)
+        else:
+            game.game_cover = GameCover({game.cover}, game.get_cover_path())
+            shared.win.game_covers[game.game_id] = game.game_cover
+
+        if (
+            shared.win.navigation_view.get_visible_page() == shared.win.details_page
+            and shared.win.active_game == game
+        ):
+            shared.win.show_details_page(game)
+
+        if not game.removed and not game.blacklisted:
+            if game.hidden:
+                shared.win.hidden_library.append(game)
+            else:
+                shared.win.library.append(game)
+            game.get_parent().set_focusable(False)
+
+        shared.win.set_library_child()
+
+        if shared.win.get_application().state == shared.AppState.DEFAULT:
+            shared.win.create_source_rows()

cartridges/store/managers/file_manager.py

@@ -0,0 +1,59 @@
+# file_manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# 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
+
+import json
+
+from cartridges import shared
+from cartridges.game import Game
+from cartridges.store.managers.async_manager import AsyncManager
+from cartridges.store.managers.steam_api_manager import SteamAPIManager
+
+
+class FileManager(AsyncManager):
+    """Manager in charge of saving a game to a file"""
+
+    run_after = (SteamAPIManager,)
+    signals = {"save-ready"}
+
+    def main(self, game: Game, additional_data: dict) -> None:
+        if additional_data.get("skip_save"):  # Skip saving when loading games from disk
+            return
+
+        shared.games_dir.mkdir(parents=True, exist_ok=True)
+
+        attrs = (
+            "added",
+            "executable",
+            "game_id",
+            "source",
+            "hidden",
+            "last_played",
+            "name",
+            "developer",
+            "removed",
+            "blacklisted",
+            "version",
+        )
+
+        json.dump(
+            {attr: getattr(game, attr) for attr in attrs if attr},
+            (shared.games_dir / f"{game.game_id}.json").open("w"),
+            indent=4,
+            sort_keys=True,
+        )

cartridges/store/managers/manager.py

@@ -0,0 +1,120 @@
+# manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# 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
+
+import logging
+from abc import abstractmethod
+from time import sleep
+from typing import Any, Callable, Container
+
+from cartridges.errors.error_producer import ErrorProducer
+from cartridges.errors.friendly_error import FriendlyError
+from cartridges.game import Game
+
+
+class Manager(ErrorProducer):
+    """Class in charge of handling a post creation action for games.
+
+    * May connect to signals on the game to handle them.
+    * May cancel its running tasks on critical error,
+    in that case a new cancellable must be generated for new tasks to run.
+    * May be retried on some specific error types
+    """
+
+    run_after: Container[type["Manager"]] = tuple()
+    blocking: bool = True
+
+    retryable_on: Container[type[Exception]] = tuple()
+    continue_on: Container[type[Exception]] = tuple()
+    signals: Container[type[str]] = set()
+    retry_delay: int = 3
+    max_tries: int = 3
+
+    @property
+    def name(self) -> str:
+        return type(self).__name__
+
+    @abstractmethod
+    def main(self, game: Game, additional_data: dict) -> None:
+        """
+        Manager specific logic triggered by the run method
+        * Implemented by final child classes
+        * May block its thread
+        * May raise retryable exceptions that will trigger a retry if possible
+        * May raise other exceptions that will be reported
+        """
+
+    def run(self, game: Game, additional_data: dict) -> None:
+        """Handle errors (retry, ignore or raise) that occur in the manager logic"""
+
+        # Keep track of the number of tries
+        tries = 1
+
+        def handle_error(error: Exception) -> None:
+            nonlocal tries
+
+            # If FriendlyError, handle its cause instead
+            base_error = error
+            if isinstance(error, FriendlyError):
+                error = error.__cause__
+
+            log_args = (
+                type(error).__name__,
+                self.name,
+                f"{game.name} ({game.game_id})",
+            )
+
+            out_of_retries_format = "Out of retries dues to %s in %s for %s"
+            retrying_format = "Retrying %s in %s for %s"
+            unretryable_format = "Unretryable %s in %s for %s"
+
+            if type(error) in self.continue_on:
+                # Handle skippable errors (skip silently)
+                return
+
+            if type(error) in self.retryable_on:
+                if tries > self.max_tries:
+                    # Handle being out of retries
+                    logging.error(out_of_retries_format, *log_args)
+                    self.report_error(base_error)
+                else:
+                    # Handle retryable errors
+                    logging.error(retrying_format, *log_args)
+                    sleep(self.retry_delay)
+                    tries += 1
+                    try_manager_logic()
+
+            else:
+                # Handle unretryable errors
+                logging.error(unretryable_format, *log_args, exc_info=error)
+                self.report_error(base_error)
+
+        def try_manager_logic() -> None:
+            try:
+                self.main(game, additional_data)
+            except Exception as error:  # pylint: disable=broad-exception-caught
+                handle_error(error)
+
+        try_manager_logic()
+
+    def process_game(
+        self, game: Game, additional_data: dict, callback: Callable[["Manager"], Any]
+    ) -> None:
+        """Pass the game through the manager"""
+        self.run(game, additional_data)
+        callback(self)

cartridges/store/managers/sgdb_manager.py

@@ -0,0 +1,48 @@
+# sgdb_manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# 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 json import JSONDecodeError
+
+from requests.exceptions import HTTPError, SSLError
+
+from cartridges.errors.friendly_error import FriendlyError
+from cartridges.game import Game
+from cartridges.store.managers.async_manager import AsyncManager
+from cartridges.store.managers.cover_manager import CoverManager
+from cartridges.store.managers.steam_api_manager import SteamAPIManager
+from cartridges.utils.steamgriddb import SgdbAuthError, SgdbHelper
+
+
+class SgdbManager(AsyncManager):
+    """Manager in charge of downloading a game's cover from SteamGridDB"""
+
+    run_after = (SteamAPIManager, CoverManager)
+    retryable_on = (HTTPError, SSLError, ConnectionError, JSONDecodeError)
+
+    def main(self, game: Game, _additional_data: dict) -> None:
+        try:
+            sgdb = SgdbHelper()
+            sgdb.conditionaly_update_cover(game)
+        except SgdbAuthError as error:
+            # If invalid auth, cancel all SGDBManager tasks
+            self.cancellable.cancel()
+            raise FriendlyError(
+                _("Couldn't Authenticate SteamGridDB"),
+                _("Verify your API key in preferences"),
+            ) from error

cartridges/store/managers/steam_api_manager.py

@@ -0,0 +1,57 @@
+# steam_api_manager.py
+#
+# Copyright 2023 Geoffrey Coulaud
+#
+# 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 requests.exceptions import HTTPError, SSLError
+from urllib3.exceptions import ConnectionError as Urllib3ConnectionError
+
+from cartridges.game import Game
+from cartridges.store.managers.async_manager import AsyncManager
+from cartridges.utils.steam import (
+    SteamAPIHelper,
+    SteamGameNotFoundError,
+    SteamNotAGameError,
+    SteamRateLimiter,
+)
+
+
+class SteamAPIManager(AsyncManager):
+    """Manager in charge of completing a game's data from the Steam API"""
+
+    retryable_on = (HTTPError, SSLError, Urllib3ConnectionError)
+
+    steam_api_helper: SteamAPIHelper = None
+    steam_rate_limiter: SteamRateLimiter = None
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.steam_rate_limiter = SteamRateLimiter()
+        self.steam_api_helper = SteamAPIHelper(self.steam_rate_limiter)
+
+    def main(self, game: Game, additional_data: dict) -> None:
+        # Skip non-Steam games
+        appid = additional_data.get("steam_appid", None)
+        if appid is None:
+            return
+        # Get online metadata
+        try:
+            online_data = self.steam_api_helper.get_api_data(appid=appid)
+        except (SteamNotAGameError, SteamGameNotFoundError):
+            game.update_values({"blacklisted": True})
+        else:
+            game.update_values(online_data)