Merge pull request #150 from kra-mo/heroic-fixes-and-improvements
Heroic fixes and improvements
This commit is contained in:
@@ -174,6 +174,15 @@ template $PreferencesWindow : Adw.PreferencesWindow {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Adw.ActionRow {
|
||||||
|
title: _("Import Amazon Games");
|
||||||
|
activatable-widget: heroic_import_amazon_switch;
|
||||||
|
|
||||||
|
Switch heroic_import_amazon_switch {
|
||||||
|
valign: center;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
Adw.ActionRow {
|
Adw.ActionRow {
|
||||||
title: _("Import Sideloaded Games");
|
title: _("Import Sideloaded Games");
|
||||||
activatable-widget: heroic_import_sideload_switch;
|
activatable-widget: heroic_import_sideload_switch;
|
||||||
|
|||||||
@@ -43,6 +43,9 @@
|
|||||||
<key name="heroic-import-gog" type="b">
|
<key name="heroic-import-gog" type="b">
|
||||||
<default>true</default>
|
<default>true</default>
|
||||||
</key>
|
</key>
|
||||||
|
<key name="heroic-import-amazon" type="b">
|
||||||
|
<default>true</default>
|
||||||
|
</key>
|
||||||
<key name="heroic-import-sideload" type="b">
|
<key name="heroic-import-sideload" type="b">
|
||||||
<default>true</default>
|
<default>true</default>
|
||||||
</key>
|
</key>
|
||||||
|
|||||||
@@ -15,6 +15,7 @@
|
|||||||
"--filesystem=~/.var/app/com.valvesoftware.Steam/data/Steam/:ro",
|
"--filesystem=~/.var/app/com.valvesoftware.Steam/data/Steam/:ro",
|
||||||
"--filesystem=~/.var/app/net.lutris.Lutris/:ro",
|
"--filesystem=~/.var/app/net.lutris.Lutris/:ro",
|
||||||
"--filesystem=~/.var/app/com.heroicgameslauncher.hgl/config/heroic/:ro",
|
"--filesystem=~/.var/app/com.heroicgameslauncher.hgl/config/heroic/:ro",
|
||||||
|
"--filesystem=~/.var/app/com.heroicgameslauncher.hgl/config/legendary/:ro",
|
||||||
"--filesystem=~/.var/app/com.usebottles.bottles/data/bottles/:ro",
|
"--filesystem=~/.var/app/com.usebottles.bottles/data/bottles/:ro",
|
||||||
"--filesystem=~/.var/app/io.itch.itch/config/itch/:ro",
|
"--filesystem=~/.var/app/io.itch.itch/config/itch/:ro",
|
||||||
"--filesystem=/var/lib/flatpak:ro"
|
"--filesystem=/var/lib/flatpak:ro"
|
||||||
|
|||||||
@@ -26,17 +26,13 @@ import yaml
|
|||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
from src.importer.sources.source import (
|
from src.importer.sources.source import SourceIterable, URLExecutableSource
|
||||||
SourceIterationResult,
|
|
||||||
SourceIterator,
|
|
||||||
URLExecutableSource,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class BottlesSourceIterator(SourceIterator):
|
class BottlesSourceIterable(SourceIterable):
|
||||||
source: "BottlesSource"
|
source: "BottlesSource"
|
||||||
|
|
||||||
def generator_builder(self) -> SourceIterationResult:
|
def __iter__(self):
|
||||||
"""Generator method producing games"""
|
"""Generator method producing games"""
|
||||||
|
|
||||||
data = self.source.data_location["library.yml"].read_text("utf-8")
|
data = self.source.data_location["library.yml"].read_text("utf-8")
|
||||||
@@ -84,7 +80,7 @@ class BottlesSource(URLExecutableSource):
|
|||||||
"""Generic Bottles source"""
|
"""Generic Bottles source"""
|
||||||
|
|
||||||
name = _("Bottles")
|
name = _("Bottles")
|
||||||
iterator_class = BottlesSourceIterator
|
iterable_class = BottlesSourceIterable
|
||||||
url_format = 'bottles:run/"{bottle_name}"/"{game_name}"'
|
url_format = 'bottles:run/"{bottle_name}"/"{game_name}"'
|
||||||
available_on = {"linux"}
|
available_on = {"linux"}
|
||||||
|
|
||||||
|
|||||||
@@ -25,13 +25,13 @@ from gi.repository import GLib, Gtk
|
|||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
from src.importer.sources.source import Source, SourceIterationResult, SourceIterator
|
from src.importer.sources.source import Source, SourceIterable
|
||||||
|
|
||||||
|
|
||||||
class FlatpakSourceIterator(SourceIterator):
|
class FlatpakSourceIterable(SourceIterable):
|
||||||
source: "FlatpakSource"
|
source: "FlatpakSource"
|
||||||
|
|
||||||
def generator_builder(self) -> SourceIterationResult:
|
def __iter__(self):
|
||||||
"""Generator method producing games"""
|
"""Generator method producing games"""
|
||||||
|
|
||||||
added_time = int(time())
|
added_time = int(time())
|
||||||
@@ -115,7 +115,7 @@ class FlatpakSource(Source):
|
|||||||
"""Generic Flatpak source"""
|
"""Generic Flatpak source"""
|
||||||
|
|
||||||
name = _("Flatpak")
|
name = _("Flatpak")
|
||||||
iterator_class = FlatpakSourceIterator
|
iterable_class = FlatpakSourceIterable
|
||||||
executable_format = "flatpak run {flatpak_id}"
|
executable_format = "flatpak run {flatpak_id}"
|
||||||
available_on = {"linux"}
|
available_on = {"linux"}
|
||||||
|
|
||||||
|
|||||||
@@ -20,21 +20,47 @@
|
|||||||
|
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
from abc import abstractmethod
|
||||||
from hashlib import sha256
|
from hashlib import sha256
|
||||||
from json import JSONDecodeError
|
from json import JSONDecodeError
|
||||||
|
from pathlib import Path
|
||||||
from time import time
|
from time import time
|
||||||
from typing import Optional, TypedDict
|
from typing import Iterable, Optional, TypedDict
|
||||||
|
from functools import cached_property
|
||||||
|
|
||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
from src.importer.sources.source import (
|
from src.importer.sources.source import (
|
||||||
URLExecutableSource,
|
SourceIterable,
|
||||||
SourceIterationResult,
|
SourceIterationResult,
|
||||||
SourceIterator,
|
URLExecutableSource,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def path_json_load(path: Path):
|
||||||
|
"""
|
||||||
|
Load JSON from the file at the given path
|
||||||
|
|
||||||
|
:raises OSError: if the file can't be opened
|
||||||
|
:raises JSONDecodeError: if the file isn't valid JSON
|
||||||
|
"""
|
||||||
|
with path.open("r", encoding="utf-8") as open_file:
|
||||||
|
return json.load(open_file)
|
||||||
|
|
||||||
|
|
||||||
|
class InvalidLibraryFileError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class InvalidInstalledFileError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class InvalidStoreFileError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
class HeroicLibraryEntry(TypedDict):
|
class HeroicLibraryEntry(TypedDict):
|
||||||
app_name: str
|
app_name: str
|
||||||
installed: Optional[bool]
|
installed: Optional[bool]
|
||||||
@@ -44,115 +70,304 @@ class HeroicLibraryEntry(TypedDict):
|
|||||||
art_square: str
|
art_square: str
|
||||||
|
|
||||||
|
|
||||||
class HeroicSubSource(TypedDict):
|
class SubSourceIterable(Iterable):
|
||||||
service: str
|
"""Class representing a Heroic sub-source"""
|
||||||
path: tuple[str]
|
|
||||||
|
|
||||||
|
|
||||||
class HeroicSourceIterator(SourceIterator):
|
|
||||||
source: "HeroicSource"
|
source: "HeroicSource"
|
||||||
|
source_iterable: "HeroicSourceIterable"
|
||||||
|
name: str
|
||||||
|
service: str
|
||||||
|
image_uri_params: str = ""
|
||||||
|
relative_library_path: Path
|
||||||
|
library_json_entries_key: str = "library"
|
||||||
|
|
||||||
sub_sources: dict[str, HeroicSubSource] = {
|
def __init__(self, source, source_iterable) -> None:
|
||||||
"sideload": {
|
self.source = source
|
||||||
"service": "sideload",
|
self.source_iterable = source_iterable
|
||||||
"path": ("sideload_apps", "library.json"),
|
|
||||||
},
|
|
||||||
"legendary": {
|
|
||||||
"service": "epic",
|
|
||||||
"path": ("store_cache", "legendary_library.json"),
|
|
||||||
},
|
|
||||||
"gog": {
|
|
||||||
"service": "gog",
|
|
||||||
"path": ("store_cache", "gog_library.json"),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
def game_from_library_entry(
|
@cached_property
|
||||||
|
def library_path(self) -> Path:
|
||||||
|
path = self.source.config_location.root / self.relative_library_path
|
||||||
|
logging.debug("Using Heroic %s library.json path %s", self.name, path)
|
||||||
|
return path
|
||||||
|
|
||||||
|
def process_library_entry(
|
||||||
self, entry: HeroicLibraryEntry, added_time: int
|
self, entry: HeroicLibraryEntry, added_time: int
|
||||||
) -> SourceIterationResult:
|
) -> SourceIterationResult:
|
||||||
"""Helper method used to build a Game from a Heroic library entry"""
|
"""Build a Game from a Heroic library entry"""
|
||||||
|
|
||||||
# Skip games that are not installed
|
app_name = entry["app_name"]
|
||||||
if not entry["is_installed"]:
|
|
||||||
return None
|
|
||||||
|
|
||||||
# Build game
|
# Build game
|
||||||
app_name = entry["app_name"]
|
|
||||||
runner = entry["runner"]
|
|
||||||
service = self.sub_sources[runner]["service"]
|
|
||||||
values = {
|
values = {
|
||||||
"source": f"{self.source.id}_{service}",
|
"source": f"{self.source.id}_{self.service}",
|
||||||
"added": added_time,
|
"added": added_time,
|
||||||
"name": entry["title"],
|
"name": entry["title"],
|
||||||
"developer": entry.get("developer", None),
|
"developer": entry.get("developer", None),
|
||||||
"game_id": self.source.game_id_format.format(
|
"game_id": self.source.game_id_format.format(
|
||||||
service=service, game_id=app_name
|
service=self.service, game_id=app_name
|
||||||
),
|
),
|
||||||
"executable": self.source.executable_format.format(app_name=app_name),
|
"executable": self.source.executable_format.format(app_name=app_name),
|
||||||
|
"hidden": self.source_iterable.is_hidden(app_name),
|
||||||
}
|
}
|
||||||
game = Game(values)
|
game = Game(values)
|
||||||
|
|
||||||
# Get the image path from the heroic cache
|
# Get the image path from the heroic cache
|
||||||
# Filenames are derived from the URL that heroic used to get the file
|
# Filenames are derived from the URL that heroic used to get the file
|
||||||
uri: str = entry["art_square"]
|
uri: str = entry["art_square"] + self.image_uri_params
|
||||||
if service == "epic":
|
|
||||||
uri += "?h=400&resize=1&w=300"
|
|
||||||
digest = sha256(uri.encode()).hexdigest()
|
digest = sha256(uri.encode()).hexdigest()
|
||||||
image_path = self.source.config_location.root / "images-cache" / digest
|
image_path = self.source.config_location.root / "images-cache" / digest
|
||||||
additional_data = {"local_image_path": image_path}
|
additional_data = {"local_image_path": image_path}
|
||||||
|
|
||||||
return (game, additional_data)
|
return (game, additional_data)
|
||||||
|
|
||||||
def generator_builder(self) -> SourceIterationResult:
|
def __iter__(self):
|
||||||
"""Generator method producing games from all the Heroic sub-sources"""
|
"""
|
||||||
|
Iterate through the games with a generator
|
||||||
for sub_source_name, sub_source in self.sub_sources.items():
|
:raises InvalidLibraryFileError: on initial call if the library file is bad
|
||||||
# Skip disabled sub-sources
|
"""
|
||||||
if not shared.schema.get_boolean("heroic-import-" + sub_source["service"]):
|
|
||||||
continue
|
|
||||||
# Load games from JSON
|
|
||||||
file = self.source.config_location.root.joinpath(*sub_source["path"])
|
|
||||||
try:
|
|
||||||
contents = json.load(file.open())
|
|
||||||
key = "library" if sub_source_name == "legendary" else "games"
|
|
||||||
library = contents[key]
|
|
||||||
except (JSONDecodeError, OSError, KeyError):
|
|
||||||
# Invalid library.json file, skip it
|
|
||||||
logging.warning("Couldn't open Heroic file: %s", str(file))
|
|
||||||
continue
|
|
||||||
|
|
||||||
added_time = int(time())
|
added_time = int(time())
|
||||||
|
|
||||||
for entry in library:
|
|
||||||
try:
|
try:
|
||||||
result = self.game_from_library_entry(entry, added_time)
|
iterator = iter(
|
||||||
|
path_json_load(self.library_path)[self.library_json_entries_key]
|
||||||
|
)
|
||||||
|
except (OSError, JSONDecodeError, TypeError, KeyError) as error:
|
||||||
|
raise InvalidLibraryFileError(
|
||||||
|
f"Invalid {self.library_path.name}"
|
||||||
|
) from error
|
||||||
|
for entry in iterator:
|
||||||
|
try:
|
||||||
|
yield self.process_library_entry(entry, added_time)
|
||||||
except KeyError as error:
|
except KeyError as error:
|
||||||
# Skip invalid games
|
|
||||||
logging.warning(
|
logging.warning(
|
||||||
"Invalid Heroic game skipped in %s", str(file), exc_info=error
|
"Skipped invalid %s game %s",
|
||||||
|
self.name,
|
||||||
|
entry.get("app_name", "UNKNOWN"),
|
||||||
|
exc_info=error,
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
|
||||||
|
class StoreSubSourceIterable(SubSourceIterable):
|
||||||
|
"""
|
||||||
|
Class representing a "store" sub source.
|
||||||
|
Games can be installed or not, this class does the check accordingly.
|
||||||
|
"""
|
||||||
|
|
||||||
|
relative_installed_path: Path
|
||||||
|
installed_app_names: set[str]
|
||||||
|
|
||||||
|
@cached_property
|
||||||
|
def installed_path(self) -> Path:
|
||||||
|
path = self.source.config_location.root / self.relative_installed_path
|
||||||
|
logging.debug("Using Heroic %s installed.json path %s", self.name, path)
|
||||||
|
return path
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def get_installed_app_names(self) -> set[str]:
|
||||||
|
"""
|
||||||
|
Get the sub source's installed app names as a set.
|
||||||
|
|
||||||
|
:raises InvalidInstalledFileError: if the installed file data cannot be read
|
||||||
|
Whenever possible, `__cause__` is set with the original exception
|
||||||
|
"""
|
||||||
|
|
||||||
|
def is_installed(self, app_name: str) -> bool:
|
||||||
|
return app_name in self.installed_app_names
|
||||||
|
|
||||||
|
def process_library_entry(self, entry, added_time):
|
||||||
|
# Skip games that are not installed
|
||||||
|
app_name = entry["app_name"]
|
||||||
|
if not self.is_installed(app_name):
|
||||||
|
logging.warning(
|
||||||
|
"Skipped %s game %s (%s): not installed",
|
||||||
|
self.service,
|
||||||
|
entry["title"],
|
||||||
|
app_name,
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
# Process entry as normal
|
||||||
|
return super().process_library_entry(entry, added_time)
|
||||||
|
|
||||||
|
def __iter__(self):
|
||||||
|
"""
|
||||||
|
Iterate through the installed games with a generator
|
||||||
|
:raises InvalidLibraryFileError: on initial call if the library file is bad
|
||||||
|
:raises InvalidInstalledFileError: on initial call if the installed file is bad
|
||||||
|
"""
|
||||||
|
self.installed_app_names = self.get_installed_app_names()
|
||||||
|
yield from super().__iter__()
|
||||||
|
|
||||||
|
|
||||||
|
class SideloadIterable(SubSourceIterable):
|
||||||
|
name = "sideload"
|
||||||
|
service = "sideload"
|
||||||
|
relative_library_path = Path("sideload_apps") / "library.json"
|
||||||
|
library_json_entries_key = "games"
|
||||||
|
|
||||||
|
|
||||||
|
class LegendaryIterable(StoreSubSourceIterable):
|
||||||
|
name = "legendary"
|
||||||
|
service = "epic"
|
||||||
|
image_uri_params = "?h=400&resize=1&w=300"
|
||||||
|
relative_library_path = Path("store_cache") / "legendary_library.json"
|
||||||
|
|
||||||
|
# relative_installed_path = (
|
||||||
|
# Path("legendary") / "legendaryConfig" / "legendary" / "installed.json"
|
||||||
|
# )
|
||||||
|
|
||||||
|
@cached_property
|
||||||
|
def installed_path(self) -> Path:
|
||||||
|
"""
|
||||||
|
Get the right path depending on the Heroic version
|
||||||
|
|
||||||
|
TODO after heroic 2.9 has been out for a while
|
||||||
|
We should use the commented out relative_installed_path
|
||||||
|
and remove this property override.
|
||||||
|
"""
|
||||||
|
|
||||||
|
heroic_config_path = self.source.config_location.root
|
||||||
|
# Heroic >= 2.9
|
||||||
|
if (path := heroic_config_path / "legendaryConfig").is_dir():
|
||||||
|
logging.debug("Using Heroic >= 2.9 legendary file")
|
||||||
|
# Heroic <= 2.8
|
||||||
|
elif heroic_config_path.is_relative_to(shared.flatpak_dir):
|
||||||
|
# Heroic flatpak
|
||||||
|
path = shared.flatpak_dir / "com.heroicgameslauncher.hgl" / "config"
|
||||||
|
logging.debug("Using Heroic flatpak <= 2.8 legendary file")
|
||||||
|
else:
|
||||||
|
# Heroic native
|
||||||
|
logging.debug("Using Heroic native <= 2.8 legendary file")
|
||||||
|
path = Path.home() / ".config"
|
||||||
|
|
||||||
|
path = path / "legendary" / "installed.json"
|
||||||
|
logging.debug("Using Heroic %s installed.json path %s", self.name, path)
|
||||||
|
return path
|
||||||
|
|
||||||
|
def get_installed_app_names(self):
|
||||||
|
try:
|
||||||
|
return set(path_json_load(self.installed_path).keys())
|
||||||
|
except (OSError, JSONDecodeError, AttributeError) as error:
|
||||||
|
raise InvalidInstalledFileError(
|
||||||
|
f"Invalid {self.installed_path.name}"
|
||||||
|
) from error
|
||||||
|
|
||||||
|
|
||||||
|
class GogIterable(StoreSubSourceIterable):
|
||||||
|
name = "gog"
|
||||||
|
service = "gog"
|
||||||
|
library_json_entries_key = "games"
|
||||||
|
relative_library_path = Path("store_cache") / "gog_library.json"
|
||||||
|
relative_installed_path = Path("gog_store") / "installed.json"
|
||||||
|
|
||||||
|
def get_installed_app_names(self):
|
||||||
|
try:
|
||||||
|
return {
|
||||||
|
app_name
|
||||||
|
for entry in path_json_load(self.installed_path)["installed"]
|
||||||
|
if (app_name := entry.get("appName")) is not None
|
||||||
|
}
|
||||||
|
except (OSError, JSONDecodeError, KeyError, AttributeError) as error:
|
||||||
|
raise InvalidInstalledFileError(
|
||||||
|
f"Invalid {self.installed_path.name}"
|
||||||
|
) from error
|
||||||
|
|
||||||
|
|
||||||
|
class NileIterable(StoreSubSourceIterable):
|
||||||
|
name = "nile"
|
||||||
|
service = "amazon"
|
||||||
|
relative_library_path = Path("store_cache") / "nile_library.json"
|
||||||
|
relative_installed_path = Path("nile_config") / "nile" / "installed.json"
|
||||||
|
|
||||||
|
def get_installed_app_names(self):
|
||||||
|
try:
|
||||||
|
installed_json = path_json_load(self.installed_path)
|
||||||
|
return {
|
||||||
|
app_name
|
||||||
|
for entry in installed_json
|
||||||
|
if (app_name := entry.get("id")) is not None
|
||||||
|
}
|
||||||
|
except (OSError, JSONDecodeError, AttributeError) as error:
|
||||||
|
raise InvalidInstalledFileError(
|
||||||
|
f"Invalid {self.installed_path.name}"
|
||||||
|
) from error
|
||||||
|
|
||||||
|
|
||||||
|
class HeroicSourceIterable(SourceIterable):
|
||||||
|
source: "HeroicSource"
|
||||||
|
|
||||||
|
hidden_app_names: set[str] = set()
|
||||||
|
|
||||||
|
def is_hidden(self, app_name: str) -> bool:
|
||||||
|
return app_name in self.hidden_app_names
|
||||||
|
|
||||||
|
def get_hidden_app_names(self) -> set[str]:
|
||||||
|
"""Get the hidden app names from store/config.json
|
||||||
|
|
||||||
|
:raises InvalidStoreFileError: if the store is invalid for some reason
|
||||||
|
"""
|
||||||
|
|
||||||
|
try:
|
||||||
|
store = path_json_load(self.source.config_location["store_config.json"])
|
||||||
|
self.hidden_app_names = {
|
||||||
|
app_name
|
||||||
|
for game in store["games"]["hidden"]
|
||||||
|
if (app_name := game.get("appName")) is not None
|
||||||
|
}
|
||||||
|
except KeyError:
|
||||||
|
logging.warning('No ["games"]["hidden"] key in Heroic store file')
|
||||||
|
except (OSError, JSONDecodeError, TypeError) as error:
|
||||||
|
logging.error("Invalid Heroic store file", exc_info=error)
|
||||||
|
raise InvalidStoreFileError() from error
|
||||||
|
|
||||||
|
def __iter__(self):
|
||||||
|
"""Generator method producing games from all the Heroic sub-sources"""
|
||||||
|
|
||||||
|
self.get_hidden_app_names()
|
||||||
|
|
||||||
|
# Get games from the sub sources
|
||||||
|
for sub_source_class in (
|
||||||
|
SideloadIterable,
|
||||||
|
LegendaryIterable,
|
||||||
|
GogIterable,
|
||||||
|
NileIterable,
|
||||||
|
):
|
||||||
|
sub_source = sub_source_class(self.source, self)
|
||||||
|
|
||||||
|
if not shared.schema.get_boolean("heroic-import-" + sub_source.service):
|
||||||
|
logging.debug("Skipping Heroic %s: disabled", sub_source.service)
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
sub_source_iterable = iter(sub_source)
|
||||||
|
yield from sub_source_iterable
|
||||||
|
except (InvalidLibraryFileError, InvalidInstalledFileError) as error:
|
||||||
|
logging.error(
|
||||||
|
"Skipping bad Heroic sub-source %s",
|
||||||
|
sub_source.service,
|
||||||
|
exc_info=error,
|
||||||
)
|
)
|
||||||
continue
|
continue
|
||||||
yield result
|
|
||||||
|
|
||||||
|
|
||||||
class HeroicSource(URLExecutableSource):
|
class HeroicSource(URLExecutableSource):
|
||||||
"""Generic Heroic Games Launcher source"""
|
"""Generic Heroic Games Launcher source"""
|
||||||
|
|
||||||
name = _("Heroic")
|
name = _("Heroic")
|
||||||
iterator_class = HeroicSourceIterator
|
iterable_class = HeroicSourceIterable
|
||||||
url_format = "heroic://launch/{app_name}"
|
url_format = "heroic://launch/{app_name}"
|
||||||
available_on = {"linux", "win32"}
|
available_on = {"linux", "win32"}
|
||||||
|
|
||||||
config_location = Location(
|
config_location = Location(
|
||||||
schema_key="heroic-location",
|
schema_key="heroic-location",
|
||||||
candidates=(
|
candidates=(
|
||||||
shared.flatpak_dir / "com.heroicgameslauncher.hgl" / "config" / "heroic",
|
|
||||||
shared.config_dir / "heroic",
|
shared.config_dir / "heroic",
|
||||||
shared.home / ".config" / "heroic",
|
shared.home / ".config" / "heroic",
|
||||||
|
shared.flatpak_dir / "com.heroicgameslauncher.hgl" / "config" / "heroic",
|
||||||
shared.appdata_dir / "heroic",
|
shared.appdata_dir / "heroic",
|
||||||
),
|
),
|
||||||
paths={
|
paths={
|
||||||
"config.json": (False, "config.json"),
|
"config.json": (False, "config.json"),
|
||||||
|
"store_config.json": (False, Path("store") / "config.json"),
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -25,18 +25,14 @@ from time import time
|
|||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
from src.importer.sources.source import (
|
from src.importer.sources.source import SourceIterable, URLExecutableSource
|
||||||
SourceIterationResult,
|
|
||||||
SourceIterator,
|
|
||||||
URLExecutableSource,
|
|
||||||
)
|
|
||||||
from src.utils.sqlite import copy_db
|
from src.utils.sqlite import copy_db
|
||||||
|
|
||||||
|
|
||||||
class ItchSourceIterator(SourceIterator):
|
class ItchSourceIterable(SourceIterable):
|
||||||
source: "ItchSource"
|
source: "ItchSource"
|
||||||
|
|
||||||
def generator_builder(self) -> SourceIterationResult:
|
def __iter__(self):
|
||||||
"""Generator method producing games"""
|
"""Generator method producing games"""
|
||||||
|
|
||||||
# Query the database
|
# Query the database
|
||||||
@@ -80,7 +76,7 @@ class ItchSourceIterator(SourceIterator):
|
|||||||
|
|
||||||
class ItchSource(URLExecutableSource):
|
class ItchSource(URLExecutableSource):
|
||||||
name = _("itch")
|
name = _("itch")
|
||||||
iterator_class = ItchSourceIterator
|
iterable_class = ItchSourceIterable
|
||||||
url_format = "itch://caves/{cave_id}/launch"
|
url_format = "itch://caves/{cave_id}/launch"
|
||||||
available_on = {"linux", "win32"}
|
available_on = {"linux", "win32"}
|
||||||
|
|
||||||
|
|||||||
@@ -21,15 +21,14 @@ import json
|
|||||||
import logging
|
import logging
|
||||||
from json import JSONDecodeError
|
from json import JSONDecodeError
|
||||||
from time import time
|
from time import time
|
||||||
from typing import Generator
|
|
||||||
|
|
||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
from src.importer.sources.source import Source, SourceIterationResult, SourceIterator
|
from src.importer.sources.source import Source, SourceIterationResult, SourceIterable
|
||||||
|
|
||||||
|
|
||||||
class LegendarySourceIterator(SourceIterator):
|
class LegendarySourceIterable(SourceIterable):
|
||||||
source: "LegendarySource"
|
source: "LegendarySource"
|
||||||
|
|
||||||
def game_from_library_entry(
|
def game_from_library_entry(
|
||||||
@@ -65,7 +64,7 @@ class LegendarySourceIterator(SourceIterator):
|
|||||||
game = Game(values)
|
game = Game(values)
|
||||||
return (game, data)
|
return (game, data)
|
||||||
|
|
||||||
def generator_builder(self) -> Generator[SourceIterationResult, None, None]:
|
def __iter__(self):
|
||||||
# Open library
|
# Open library
|
||||||
file = self.source.config_location["installed.json"]
|
file = self.source.config_location["installed.json"]
|
||||||
try:
|
try:
|
||||||
@@ -94,7 +93,7 @@ class LegendarySource(Source):
|
|||||||
executable_format = "legendary launch {app_name}"
|
executable_format = "legendary launch {app_name}"
|
||||||
available_on = {"linux"}
|
available_on = {"linux"}
|
||||||
|
|
||||||
iterator_class = LegendarySourceIterator
|
iterable_class = LegendarySourceIterable
|
||||||
config_location: Location = Location(
|
config_location: Location = Location(
|
||||||
schema_key="legendary-location",
|
schema_key="legendary-location",
|
||||||
candidates=(
|
candidates=(
|
||||||
|
|||||||
@@ -24,18 +24,14 @@ from time import time
|
|||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
from src.importer.sources.source import (
|
from src.importer.sources.source import SourceIterable, URLExecutableSource
|
||||||
SourceIterationResult,
|
|
||||||
SourceIterator,
|
|
||||||
URLExecutableSource,
|
|
||||||
)
|
|
||||||
from src.utils.sqlite import copy_db
|
from src.utils.sqlite import copy_db
|
||||||
|
|
||||||
|
|
||||||
class LutrisSourceIterator(SourceIterator):
|
class LutrisSourceIterable(SourceIterable):
|
||||||
source: "LutrisSource"
|
source: "LutrisSource"
|
||||||
|
|
||||||
def generator_builder(self) -> SourceIterationResult:
|
def __iter__(self):
|
||||||
"""Generator method producing games"""
|
"""Generator method producing games"""
|
||||||
|
|
||||||
# Query the database
|
# Query the database
|
||||||
@@ -91,7 +87,7 @@ class LutrisSource(URLExecutableSource):
|
|||||||
"""Generic Lutris source"""
|
"""Generic Lutris source"""
|
||||||
|
|
||||||
name = _("Lutris")
|
name = _("Lutris")
|
||||||
iterator_class = LutrisSourceIterator
|
iterable_class = LutrisSourceIterable
|
||||||
url_format = "lutris:rungameid/{game_id}"
|
url_format = "lutris:rungameid/{game_id}"
|
||||||
available_on = {"linux"}
|
available_on = {"linux"}
|
||||||
|
|
||||||
|
|||||||
@@ -29,25 +29,16 @@ from src.importer.sources.location import Location
|
|||||||
SourceIterationResult = None | Game | tuple[Game, tuple[Any]]
|
SourceIterationResult = None | Game | tuple[Game, tuple[Any]]
|
||||||
|
|
||||||
|
|
||||||
class SourceIterator(Iterator):
|
class SourceIterable(Iterable):
|
||||||
"""Data producer for a source of games"""
|
"""Data producer for a source of games"""
|
||||||
|
|
||||||
source: "Source" = None
|
source: "Source" = None
|
||||||
generator: Generator = None
|
|
||||||
|
|
||||||
def __init__(self, source: "Source") -> None:
|
def __init__(self, source: "Source") -> None:
|
||||||
super().__init__()
|
|
||||||
self.source = source
|
self.source = source
|
||||||
self.generator = self.generator_builder()
|
|
||||||
|
|
||||||
def __iter__(self) -> "SourceIterator":
|
|
||||||
return self
|
|
||||||
|
|
||||||
def __next__(self) -> SourceIterationResult:
|
|
||||||
return next(self.generator)
|
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def generator_builder(self) -> Generator[SourceIterationResult, None, None]:
|
def __iter__(self) -> Generator[SourceIterationResult, None, None]:
|
||||||
"""
|
"""
|
||||||
Method that returns a generator that produces games
|
Method that returns a generator that produces games
|
||||||
* Should be implemented as a generator method
|
* Should be implemented as a generator method
|
||||||
@@ -66,7 +57,7 @@ class Source(Iterable):
|
|||||||
data_location: Optional[Location] = None
|
data_location: Optional[Location] = None
|
||||||
cache_location: Optional[Location] = None
|
cache_location: Optional[Location] = None
|
||||||
config_location: Optional[Location] = None
|
config_location: Optional[Location] = None
|
||||||
iterator_class: type[SourceIterator]
|
iterable_class: type[SourceIterable]
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def full_name(self) -> str:
|
def full_name(self) -> str:
|
||||||
@@ -98,7 +89,7 @@ class Source(Iterable):
|
|||||||
def executable_format(self) -> str:
|
def executable_format(self) -> str:
|
||||||
"""The executable format used to construct game executables"""
|
"""The executable format used to construct game executables"""
|
||||||
|
|
||||||
def __iter__(self) -> SourceIterator:
|
def __iter__(self) -> Generator[SourceIterationResult, None, None]:
|
||||||
"""
|
"""
|
||||||
Get an iterator for the source
|
Get an iterator for the source
|
||||||
:raises UnresolvableLocationError: Not iterable if any of the locations are unresolvable
|
:raises UnresolvableLocationError: Not iterable if any of the locations are unresolvable
|
||||||
@@ -108,7 +99,7 @@ class Source(Iterable):
|
|||||||
if location is None:
|
if location is None:
|
||||||
continue
|
continue
|
||||||
location.resolve()
|
location.resolve()
|
||||||
return self.iterator_class(self)
|
return iter(self.iterable_class(self))
|
||||||
|
|
||||||
|
|
||||||
# pylint: disable=abstract-method
|
# pylint: disable=abstract-method
|
||||||
|
|||||||
@@ -18,6 +18,7 @@
|
|||||||
#
|
#
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
import logging
|
||||||
import re
|
import re
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from time import time
|
from time import time
|
||||||
@@ -25,16 +26,12 @@ from typing import Iterable
|
|||||||
|
|
||||||
from src import shared
|
from src import shared
|
||||||
from src.game import Game
|
from src.game import Game
|
||||||
from src.importer.sources.source import (
|
|
||||||
SourceIterationResult,
|
|
||||||
SourceIterator,
|
|
||||||
URLExecutableSource,
|
|
||||||
)
|
|
||||||
from src.utils.steam import SteamFileHelper, SteamInvalidManifestError
|
|
||||||
from src.importer.sources.location import Location
|
from src.importer.sources.location import Location
|
||||||
|
from src.importer.sources.source import SourceIterable, URLExecutableSource
|
||||||
|
from src.utils.steam import SteamFileHelper, SteamInvalidManifestError
|
||||||
|
|
||||||
|
|
||||||
class SteamSourceIterator(SourceIterator):
|
class SteamSourceIterable(SourceIterable):
|
||||||
source: "SteamSource"
|
source: "SteamSource"
|
||||||
|
|
||||||
def get_manifest_dirs(self) -> Iterable[Path]:
|
def get_manifest_dirs(self) -> Iterable[Path]:
|
||||||
@@ -62,7 +59,7 @@ class SteamSourceIterator(SourceIterator):
|
|||||||
)
|
)
|
||||||
return manifests
|
return manifests
|
||||||
|
|
||||||
def generator_builder(self) -> SourceIterationResult:
|
def __iter__(self):
|
||||||
"""Generator method producing games"""
|
"""Generator method producing games"""
|
||||||
appid_cache = set()
|
appid_cache = set()
|
||||||
manifests = self.get_manifests()
|
manifests = self.get_manifests()
|
||||||
@@ -74,17 +71,20 @@ class SteamSourceIterator(SourceIterator):
|
|||||||
steam = SteamFileHelper()
|
steam = SteamFileHelper()
|
||||||
try:
|
try:
|
||||||
local_data = steam.get_manifest_data(manifest)
|
local_data = steam.get_manifest_data(manifest)
|
||||||
except (OSError, SteamInvalidManifestError):
|
except (OSError, SteamInvalidManifestError) as error:
|
||||||
|
logging.debug("Couldn't load appmanifest %s", manifest, exc_info=error)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
# Skip non installed games
|
# Skip non installed games
|
||||||
installed_mask = 4
|
installed_mask = 4
|
||||||
if not int(local_data["stateflags"]) & installed_mask:
|
if not int(local_data["stateflags"]) & installed_mask:
|
||||||
|
logging.debug("Skipped %s: not installed", manifest)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
# Skip duplicate appids
|
# Skip duplicate appids
|
||||||
appid = local_data["appid"]
|
appid = local_data["appid"]
|
||||||
if appid in appid_cache:
|
if appid in appid_cache:
|
||||||
|
logging.debug("Skipped %s: appid already seen during import", manifest)
|
||||||
continue
|
continue
|
||||||
appid_cache.add(appid)
|
appid_cache.add(appid)
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ class SteamSourceIterator(SourceIterator):
|
|||||||
class SteamSource(URLExecutableSource):
|
class SteamSource(URLExecutableSource):
|
||||||
name = _("Steam")
|
name = _("Steam")
|
||||||
available_on = {"linux", "win32"}
|
available_on = {"linux", "win32"}
|
||||||
iterator_class = SteamSourceIterator
|
iterable_class = SteamSourceIterable
|
||||||
url_format = "steam://rungameid/{game_id}"
|
url_format = "steam://rungameid/{game_id}"
|
||||||
|
|
||||||
data_location = Location(
|
data_location = Location(
|
||||||
|
|||||||
@@ -73,7 +73,7 @@ def setup_logging():
|
|||||||
"PIL": {
|
"PIL": {
|
||||||
"handlers": ["lib_console_handler", "file_handler"],
|
"handlers": ["lib_console_handler", "file_handler"],
|
||||||
"propagate": False,
|
"propagate": False,
|
||||||
"level": "NOTSET",
|
"level": "WARNING",
|
||||||
},
|
},
|
||||||
"urllib3": {
|
"urllib3": {
|
||||||
"handlers": ["lib_console_handler", "file_handler"],
|
"handlers": ["lib_console_handler", "file_handler"],
|
||||||
|
|||||||
@@ -68,6 +68,7 @@ class PreferencesWindow(Adw.PreferencesWindow):
|
|||||||
heroic_config_file_chooser_button = Gtk.Template.Child()
|
heroic_config_file_chooser_button = Gtk.Template.Child()
|
||||||
heroic_import_epic_switch = Gtk.Template.Child()
|
heroic_import_epic_switch = Gtk.Template.Child()
|
||||||
heroic_import_gog_switch = Gtk.Template.Child()
|
heroic_import_gog_switch = Gtk.Template.Child()
|
||||||
|
heroic_import_amazon_switch = Gtk.Template.Child()
|
||||||
heroic_import_sideload_switch = Gtk.Template.Child()
|
heroic_import_sideload_switch = Gtk.Template.Child()
|
||||||
|
|
||||||
bottles_expander_row = Gtk.Template.Child()
|
bottles_expander_row = Gtk.Template.Child()
|
||||||
@@ -181,6 +182,7 @@ class PreferencesWindow(Adw.PreferencesWindow):
|
|||||||
"lutris-import-flatpak",
|
"lutris-import-flatpak",
|
||||||
"heroic-import-epic",
|
"heroic-import-epic",
|
||||||
"heroic-import-gog",
|
"heroic-import-gog",
|
||||||
|
"heroic-import-amazon",
|
||||||
"heroic-import-sideload",
|
"heroic-import-sideload",
|
||||||
"flatpak-import-launchers",
|
"flatpak-import-launchers",
|
||||||
"sgdb",
|
"sgdb",
|
||||||
|
|||||||
@@ -18,6 +18,8 @@
|
|||||||
#
|
#
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
from gi.repository import GdkPixbuf
|
from gi.repository import GdkPixbuf
|
||||||
|
|
||||||
from src import shared
|
from src import shared
|
||||||
@@ -35,6 +37,7 @@ class LocalCoverManager(Manager):
|
|||||||
def manager_logic(self, game: Game, additional_data: dict) -> None:
|
def manager_logic(self, game: Game, additional_data: dict) -> None:
|
||||||
if image_path := additional_data.get("local_image_path"):
|
if image_path := additional_data.get("local_image_path"):
|
||||||
if not image_path.is_file():
|
if not image_path.is_file():
|
||||||
|
logging.error("Local image path is not a file: %s", image_path)
|
||||||
return
|
return
|
||||||
save_cover(game.game_id, resize_cover(image_path))
|
save_cover(game.game_id, resize_cover(image_path))
|
||||||
elif icon_path := additional_data.get("local_icon_path"):
|
elif icon_path := additional_data.get("local_icon_path"):
|
||||||
|
|||||||
Reference in New Issue
Block a user