Merge pull request #23 from Garulf/improve-search

Garulf · web-flow · commit 1050236307a8 · 2022-09-12T14:05:50.000-04:00
Improve Playnite search and library detection
diff --git a/README.md b/README.md
@@ -24,19 +24,6 @@ Copy and paste this into your browser to automatically start installation.
 
 Simply type the default keyword: `pn` and search your Playnite library.
 
-### Filter by Source:
-
-Type: `#` to filter by a specific Source
-
-![Screenshot 2022-01-11 103736](https://user-images.githubusercontent.com/535299/148973352-27c22827-4a19-4975-83e6-24bc814103ca.png)
-
-
-### Filter by install status:
-
-Type: `@` to show all games including uninstalled games.
-
-![Screenshot 2022-01-11 103608](https://user-images.githubusercontent.com/535299/148973214-aecfd4b9-20a5-4d55-a998-b6e972673187.png)
-
 
 ## Screenshots:
 <details>
diff --git a/SettingsTemplate.yaml b/SettingsTemplate.yaml
@@ -7,16 +7,34 @@ body:
   - type: input
     attributes:
       name: playnite_path
-      label: 'Playnite User Directory:'
-      description: Location of Playnite user folder 
+      label: 'Playnite Directory:'
+      description: Location of Playnite folder or database file.
+      defaultValue: "%appdata%\\Playnite"
+  - type: textBlock
+    attributes:
+      name: description
+      description: >
+        Path should be either your Playnite install directory or the database file path.
+        Examples: 
+  - type: textBlock
+    attributes:
+      name: description
+      description: >
+        C:\Users\%USERNAME%\AppData\Roaming\Playnite
+  - type: textBlock
+    attributes:
+      name: description
+      description: >
+        %APPDATA%\Playnite\ExtensionsData\FlowLauncher_Exporter\library.json
   - type: checkbox
     attributes:
       name: hide_uninstalled
       label: 'Hide Uninstalled:'
       defaultValue: "true"
       description: Hides uninstalled from default results
-  - type: textBlock
+  - type: checkbox
     attributes:
-      name: description
-      description: >
-        Hide Games that are currently not installed from defautl results. You can unhide them temporarily by using the "@" keyword.
+      name: show_hidden
+      label: 'Show Hidden:'
+      defaultValue: "false"
+      description: Show hidden games in default results
diff --git a/plugin.json b/plugin.json
@@ -4,7 +4,7 @@
     "Name": "Playnite",
     "Description": "Search and launch your Playnite library.",
     "Author": "Garulf",
-    "Version": "1.7.0",
+    "Version": "2.0.0",
     "Language": "python",
     "Website": "https://github.com/Garulf/playnite-plugin",
     "IcoPath": "./icon.png",
diff --git a/plugin/exceptions.py b/plugin/exceptions.py
@@ -0,0 +1,16 @@
+
+class LibraryNotFound(Exception):
+    
+    def __init__(self, library):
+        self.library = library
+
+    def __str__(self):
+        return f"No library file not found for {self.library}"
+
+class PlayniteNotFound(Exception):
+    
+    def __init__(self, path):
+        self.path = path
+
+    def __str__(self):
+        return f"Playnite directory not found at {self.path}"
diff --git a/plugin/filters.py b/plugin/filters.py
@@ -0,0 +1,55 @@
+from typing import TYPE_CHECKING, List
+
+if TYPE_CHECKING:
+    from playnite import Game
+
+class LibraryFilter:
+
+    def __init__(self, invert: bool = False):
+        self.invert = invert
+
+    def filter(self, game: 'Game') -> bool:
+        pass
+
+    def __call__(self, game: 'Game') -> bool:
+        if self.invert:
+            return not self.filter(game)
+        return self.filter(game)
+
+class IsHidden(LibraryFilter):
+
+    def filter(self, game: 'Game') -> bool:
+        return game.Hidden
+
+class IsInstalled(LibraryFilter):
+
+    def filter(self, game: 'Game') -> bool:
+        return game.IsInstalled
+
+class IsSource(LibraryFilter):
+
+    def __init__(self, source: str, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.source = source
+
+    def filter(self, game: 'Game') -> bool:
+        if game.Source is not None:
+            return game.Source["Name"].lower() == self.source.lower()
+        return False
+
+class IsID(LibraryFilter):
+
+    def __init__(self, id: str, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.id = id
+
+    def filter(self, game: 'Game') -> bool:
+        return game.Id == self.id
+
+def filter_game(filters: List[LibraryFilter], game: "Game", query: str = None) -> bool:
+    for filter in filters:
+        if not isinstance(filter, LibraryFilter):
+            filter = filter()
+        if not filter(game):
+            return False
+    return True
diff --git a/plugin/game.py b/plugin/game.py
@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from datetime import datetime
+from pathlib import Path
+import webbrowser
+from typing import TypedDict, TYPE_CHECKING, Union
+
+PLAYNITE_SCHEME = 'playnite://'
+
+if TYPE_CHECKING:
+    from playnite import PlayniteApp
+
+class ReleaseDate(TypedDict):
+    """Release date of the game"""
+    Day: int
+    Month: int
+    Year: int
+
+class Source(TypedDict):
+    """Source library of the game"""
+    Name: str
+    Id: str
+
+ID = str
+NAME = str
+PLAYTIME = int
+IS_INSTALLED = bool
+INSTALL_DIRECTORY = str
+ICON = str
+HIDDEN = bool
+RELEASE_DATE = Union[ReleaseDate, None]
+SOURCE = Union[Source, None]
+PLAYNITE = 'PlayniteApp'
+
+@dataclass
+class Game:
+    """Playnite Game"""
+    Id: ID
+    Name: NAME
+    Playtime: PLAYTIME
+    IsInstalled: IS_INSTALLED
+    InstallDirectory: INSTALL_DIRECTORY
+    Icon: ICON
+    Hidden: HIDDEN
+    ReleaseDate: RELEASE_DATE 
+    Source: SOURCE
+    Playnite: PLAYNITE = field(repr=False)
+
+
+    def _build_uri(self, action, scheme=PLAYNITE_SCHEME) -> str:
+        return f"{scheme}playnite/{action}/{self.Id}"
+
+    def get_release_date(self) -> datetime | None:
+        if self.ReleaseDate:
+            return datetime(self.ReleaseDate.Year, self.ReleaseDate.Month, self.ReleaseDate.Day)
+        return None
+
+    @property
+    def start_uri(self) -> str:
+        return self._build_uri('start')
+
+    @property
+    def show_game_uri(self) -> str:
+        return self._build_uri('showgame')
+
+    @property
+    def icon_path(self) -> Path | None:
+        if self.Icon:
+            path = Path(self.Playnite.path, 'library', 'files', self.Icon)
+            if path.is_file():
+                return path
+        return None
+
+    def start(self) -> None:
+        webbrowser.open(self.start_uri)
+
+    def show_game(self) -> None:
+        webbrowser.open(self.show_game_uri)
diff --git a/plugin/main.py b/plugin/main.py
@@ -1,130 +1,55 @@
 import webbrowser
 from pathlib import Path
-from difflib import SequenceMatcher as SM
 
-from flox import Flox, ICON_SETTINGS
-import playnite as pn
+from flox import Flox
+from playnite import DEFAULT_PLAYNITE_DIR, PlayniteApp
+from result import Result, OpenInPlaynite, LaunchGameContext
+from filters import IsInstalled, IsHidden
+from exceptions import PlayniteNotFound, LibraryNotFound
 
-
-SOURCE_FILTER = '#'
-INSTALL_FILTER = '@'
-HIDDEN_FILTER = '!'
-SCORE_CUTOFF = 10
 PLUGIN_URI = 'playnite://playnite/installaddon/FlowLauncherExporter'
 
-def match(query, text):
-    return int(SM(
-                lambda x: x == " ", 
-                query, 
-                text.lower()).ratio() * 100
-            )
-
 class Playnite(Flox):
 
     def load_settings(self):
-        self.playnite_path = self.settings.setdefault('playnite_path', str(pn.DATA_FOLDER))
+        self.applied_filters = []
+        self.playnite_path = self.settings.setdefault('playnite_path', str(DEFAULT_PLAYNITE_DIR))
         self.hide_uninstalled = self.settings.get('hide_uninstalled', True)
-
-    def missing_library(self):
-        self.add_item(
-            title='Library file not found!',
-            subtitle="Please set the path to Playnite\'s data directory in settings.",
-            icon=ICON_SETTINGS,
-            method=self.open_setting_dialog
-        )
-        self.add_item(
-            title='Install FlowLauncherExporter plugin.',
-            subtitle='FlowLauncherExporter plugin is required to use this plugin.',
-            icon='',
-            method=self.uri,
-            parameters=[PLUGIN_URI]
-
-        )
-
-    def main_search(self, query):
-        for game in self.games:
-            score = match(query, game.name)
-            if score >= SCORE_CUTOFF or query == '':
-                if game.is_installed:
-                    subtitle = game.install_directory
-                    uri = game.start_uri
-                else:
-                    subtitle = 'Not Installed'
-                    uri = game.show_uri
-                self.add_item(
-                    title=game.name,
-                    subtitle=f'{game.source["Name"]}: {subtitle}',
-                    icon=str(game.icon_path),
-                    method=self.uri,
-                    parameters=[uri],
-                    context=[game.show_uri],
-                    score=score
-                )
-
-    def source_filter(self, query):
-        sources = [game.source['Name'] for game in self.games]
-        sources = set(sources)
-        for source in sources:
-            if source.lower() in query:
-                query = query.replace(source.lower(), '').lstrip()
-                self.games = [game for game in self.games if source.lower() == game.source['Name'].lower()]
-                break
-            if query in source.lower() or query == '':
-                _ = self.add_item(
-                    title=f'{SOURCE_FILTER}{source}',
-                    subtitle='Filter by source.',
-                    icon='',
-                    method=self.change_query,
-                    dont_hide=True,
-                )
-                _['JsonRPCAction']['Parameters'] = [f"{_['AutoCompleteText']} "]
-        else:
-            self.games = []
-        return query
-
-    def install_filter(self):
-        self.games = [game for game in self.games if not game.is_installed]
-
-    def uninstalled_filter(self):
-        self.games = [game for game in self.games if game.is_installed and (game.install_directory != None or game.install_directory != "")]
-
-    def remove_hidden(self):
-        self.games = [game for game in self.games if not game.hidden]
+        if self.hide_uninstalled:
+            self.applied_filters.append(IsInstalled)
+        # If has "Show Hidden" setting, hide hidden games
+        if not self.settings.get('show_hidden', False):
+            self.applied_filters.append(IsHidden(invert=True))
+        self.pn = PlayniteApp(self.playnite_path)
 
     def query(self, query):
-        self.load_settings()
-        query = query.lower()
         try:
-            self.games = pn.import_games(self.playnite_path)
-        except FileNotFoundError:
-            self.missing_library()
-            return
-        if query.startswith(SOURCE_FILTER):
-            query = query[len(SOURCE_FILTER):]
-            query = self.source_filter(query)
-        if INSTALL_FILTER in query:
-            query = query.replace(INSTALL_FILTER, '')
-            self.install_filter()
-        elif self.hide_uninstalled:
-            self.uninstalled_filter()
-        if HIDDEN_FILTER not in query:
-            self.remove_hidden()
-        else:
-            query = query.replace(HIDDEN_FILTER, '')
-        self.main_search(query)
-        
+            self.load_settings()
+            games = self.pn.search(query, self.applied_filters)
+            for game in games:
+                self.add_item(
+                    **Result(game).to_dict()
+            )
+        except PlayniteNotFound:
+            self.add_item(
+                title='Playnite not found! Set the path in the settings.',
+                subtitle='Open settings.',
+                method=self.open_setting_dialog
+            )
+        except LibraryNotFound:
+            self.add_item(
+                title='Flow Launcher Exporter not found! Install it in Playnite.',
+                subtitle='Click to install now.',
+                method=self.uri,
+                parameters=[PLUGIN_URI]
+            )
 
     def context_menu(self, data):
-        show_uri = data[0]
-        icon = str(self.icon if Path(self.icon).is_absolute() else Path(self.plugindir, self.icon))
-        self.logger.warning(icon)
-        self.add_item(
-            title='Open in Playnite',
-            subtitle='Shows Game in Playnite library.',
-            icon=icon,
-            method=self.uri,
-            parameters=[show_uri],
-        )
+        self.load_settings()
+        game = self.pn.game(data)
+        if game:
+            self.add_item(**OpenInPlaynite(game).to_dict())
+            self.add_item(**LaunchGameContext(game).to_dict())
 
     def uri(self, uri):
         webbrowser.open(uri)
diff --git a/plugin/playnite.py b/plugin/playnite.py
diff --git a/plugin/result.py b/plugin/result.py
