PICARD-1861: WIP

Author: phw

picard/const/appdirs.py

@@ -48,6 +48,5 @@ def cache_folder():
 
 
 def plugin_folder():
-    # FIXME: This really should be in QStandardPaths.StandardLocation.AppDataLocation instead,
-    # but this is a breaking change that requires data migration
-    return os.path.normpath(os.environ.get('PICARD_PLUGIN_DIR', os.path.join(config_folder(), 'plugins')))
+    appdata_folder = QStandardPaths.writableLocation(QStandardPaths.StandardLocation.AppDataLocation)
+    return os.path.normpath(os.environ.get('PICARD_PLUGIN_DIR', os.path.join(appdata_folder, 'plugins3')))

picard/plugin3/api.py

@@ -31,7 +31,6 @@
 from picard.config import (
     Config,
     ConfigSection,
-    config,
     get_config,
 )
 from picard.coverart.providers import (
@@ -77,7 +76,7 @@ def __init__(self, manifest: PluginManifest, tagger) -> None:
         self._manifest = manifest
         full_name = f'plugin.{self._manifest.module_name}'
         self._logger = getLogger(full_name)
-        self._api_config = ConfigSection(config, full_name)
+        self._api_config = ConfigSection(get_config(), full_name)
 
     @property
     def web_service(self) -> WebService:

picard/plugin3/manager.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+#
+# Picard, the next-generation MusicBrainz tagger
+#
+# Copyright (C) 2024 Philipp Wolfer
+#
+# 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 2
+# 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, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+import os
+from typing import List
+
+from picard import (
+    api_versions_tuple,
+    log,
+)
+from picard.plugin3.plugin import Plugin
+
+
+class PluginManager:
+    """Installs, loads and updates plugins from multiple plugin directories.
+    """
+    _primary_plugin_dir: str = None
+    _plugin_dirs: List[str] = []
+    _plugins: List[Plugin] = []
+
+    def __init__(self, tagger):
+        from picard.tagger import Tagger
+        self._tagger: Tagger = tagger
+
+    def add_directory(self, dir_path: str, primary: bool = False) -> None:
+        log.debug('Registering plugin directory %s', dir_path)
+        dir_path = os.path.normpath(dir_path)
+
+        for entry in os.scandir(dir_path):
+            if entry.is_dir():
+                plugin = self._load_plugin(dir_path, entry.name)
+                if plugin:
+                    log.debug('Found plugin %s in %s', plugin.plugin_name, plugin.local_path)
+                    self._plugins.append(plugin)
+
+        self._plugin_dirs.append(dir_path)
+        if primary:
+            self._primary_plugin_dir = dir_path
+
+    def init_plugins(self):
+        # TODO: Only load and enable plugins enabled in configuration
+        for plugin in self._plugins:
+            try:
+                plugin.load_module()
+                plugin.enable(self._tagger)
+            except Exception as ex:
+                log.error('Failed initializing plugin %s from %s',
+                          plugin.plugin_name, plugin.local_path, exc_info=ex)
+
+    def _load_plugin(self, plugin_dir: str, plugin_name: str):
+        plugin = Plugin(plugin_dir, plugin_name)
+        try:
+            plugin.read_manifest()
+            # TODO: Check version compatibility
+            compatible_versions = _compatible_api_versions(plugin.manifest.api_versions)
+            if compatible_versions:
+                return plugin
+            else:
+                log.warning('Plugin "%s" from "%s" is not compatible with this version of Picard.',
+                            plugin.plugin_name, plugin.local_path)
+        except Exception as ex:
+            log.warning('Could not read plugin manifest from %r',
+                        os.path.join(plugin_dir, plugin_name), exc_info=ex)
+            return None
+
+
+def _compatible_api_versions(api_versions):
+    return set(api_versions) & set(api_versions_tuple)

picard/plugin3/plugin.py

@@ -0,0 +1,108 @@
+# -*- coding: utf-8 -*-
+#
+# Picard, the next-generation MusicBrainz tagger
+#
+# Copyright (C) 2024 Laurent Monin
+# Copyright (C) 2024 Philipp Wolfer
+#
+# 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 2
+# 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, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+import importlib.util
+import os
+import sys
+
+from picard.plugin3.api import PluginApi
+from picard.plugin3.manifest import PluginManifest
+
+import pygit2
+
+
+class GitRemoteCallbacks(pygit2.RemoteCallbacks):
+
+    def transfer_progress(self, stats):
+        print(f'{stats.indexed_objects}/{stats.total_objects}')
+
+
+class Plugin:
+    local_path: str = None
+    remote_url: str = None
+    ref = None
+    plugin_name: str = None
+    module_name: str = None
+    manifest: PluginManifest = None
+    _module = None
+
+    def __init__(self, plugins_dir: str, plugin_name: str):
+        if not os.path.exists(plugins_dir):
+            os.makedirs(plugins_dir)
+        self.plugins_dir = plugins_dir
+        self.plugin_name = plugin_name
+        self.module_name = f'picard.plugins.{self.plugin_name}'
+        self.local_path = os.path.join(self.plugins_dir, self.plugin_name)
+
+    def sync(self, url: str = None, ref: str = None):
+        """Sync plugin source
+        Use remote url or local path, and sets the repository to ref
+        """
+        if url:
+            self.remote_url = url
+        if os.path.isdir(self.local_path):
+            print(f'{self.local_path} exists, fetch changes')
+            repo = pygit2.Repository(self.local_path)
+            for remote in repo.remotes:
+                remote.fetch(callbacks=GitRemoteCallbacks())
+        else:
+            print(f'Cloning {url} to {self.local_path}')
+            repo = pygit2.clone_repository(url, self.local_path, callbacks=GitRemoteCallbacks())
+
+            print(list(repo.references))
+            print(list(repo.branches))
+            print(list(repo.remotes))
+
+        if ref:
+            commit = repo.revparse_single(ref)
+        else:
+            commit = repo.revparse_single('HEAD')
+
+        print(commit)
+        print(commit.message)
+        # hard reset to passed ref or HEAD
+        repo.reset(commit.id, pygit2.enums.ResetMode.HARD)
+
+    def read_manifest(self):
+        """Reads metadata for the plugin from the plugin's MANIFEST.toml
+        """
+        manifest_path = os.path.join(self.local_path, 'MANIFEST.toml')
+        with open(manifest_path, 'rb') as manifest_file:
+            self.manifest = PluginManifest(self.plugin_name, manifest_file)
+
+    def load_module(self):
+        """Load corresponding module from source path"""
+        module_file = os.path.join(self.local_path, '__init__.py')
+        spec = importlib.util.spec_from_file_location(self.module_name, module_file)
+        module = importlib.util.module_from_spec(spec)
+        sys.modules[self.module_name] = module
+        spec.loader.exec_module(module)
+        self._module = module
+        return module
+
+    def enable(self, tagger) -> None:
+        """Enable the plugin"""
+        api = PluginApi(self.manifest, tagger)
+        self._module.enable(api)
+
+    def disable(self) -> None:
+        """Disable the plugin"""
+        self._module.disable()

picard/tagger.py

@@ -95,6 +95,7 @@
 )
 from picard.config_upgrade import upgrade_config
 from picard.const import USER_DIR
+from picard.const.appdirs import plugin_folder
 from picard.const.sys import (
     IS_HAIKU,
     IS_MACOS,
@@ -111,10 +112,8 @@
 from picard.file import File
 from picard.formats import open_ as open_file
 from picard.i18n import setup_gettext
-from picard.pluginmanager import (
-    PluginManager,
-    plugin_dirs,
-)
+from picard.plugin3.manager import PluginManager
+from picard.pluginmanager import PluginManager as LegacyPluginManager
 from picard.releasegroup import ReleaseGroup
 from picard.track import (
     NonAlbumTrack,
@@ -354,10 +353,12 @@ def __init__(self, picard_args, localedir, autoupdate, pipe_handler=None):
         self.enable_menu_icons(config.setting['show_menu_icons'])
 
         # Load plugins
-        self.pluginmanager = PluginManager()
+        # FIXME: Legacy, remove as soong no longer used by other code
+        self.pluginmanager = LegacyPluginManager()
+
+        self.pluginmanager3 = PluginManager(self)
         if not self._no_plugins:
-            for plugin_dir in plugin_dirs():
-                self.pluginmanager.load_plugins_from_directory(plugin_dir)
+            self.pluginmanager3.add_directory(plugin_folder(), primary=True)
 
         self.browser_integration = BrowserIntegration()
         self.browser_integration.listen_port_changed.connect(self.listen_port_changed)
@@ -749,6 +750,7 @@ def _run_init(self):
     def run(self):
         self.update_browser_integration()
         self.window.show()
+        self.pluginmanager3.init_plugins()
         QtCore.QTimer.singleShot(0, self._run_init)
         res = self.exec()
         self.exit()

requirements-macos-11.txt

@@ -1,6 +1,7 @@
 discid==1.2.0
 Markdown==3.5.1
 mutagen==1.47.0
+pygit2==1.14.1
 PyJWT==2.8.0
 pyobjc-core==10.1
 pyobjc-framework-Cocoa==10.1

requirements-win.txt

@@ -1,6 +1,7 @@
 discid==1.2.0
 Markdown==3.5.1
 mutagen==1.47.0
+pygit2==1.14.1
 PyJWT==2.8.0
 PyQt6==6.6.1
 PyQt6-Qt6==6.6.1

requirements.txt

@@ -1,6 +1,7 @@
 discid~=1.0
 Markdown~=3.2
 mutagen~=1.37
+pygit2~=1.14.1
 PyJWT~=2.0
 pyobjc-core>=6.2, <11; sys_platform == 'darwin'
 pyobjc-framework-Cocoa>=6.2, <11; sys_platform == 'darwin'

test/test_const_appdirs.py

@@ -67,12 +67,12 @@ def test_cache_folder_linux(self):
 
     @unittest.skipUnless(IS_WIN, "Windows test")
     def test_plugin_folder_win(self):
-        self.assert_home_path_equals('~/AppData/Local/MusicBrainz/Picard/plugins', plugin_folder())
+        self.assert_home_path_equals('~/AppData/Roaming/MusicBrainz/Picard/plugins3', plugin_folder())
 
     @unittest.skipUnless(IS_MACOS, "macOS test")
     def test_plugin_folder_macos(self):
-        self.assert_home_path_equals('~/Library/Preferences/MusicBrainz/Picard/plugins', plugin_folder())
+        self.assert_home_path_equals('~/Library/Application Support/MusicBrainz/Picard/plugins3', plugin_folder())
 
     @unittest.skipUnless(IS_LINUX, "Linux test")
     def test_plugin_folder_linux(self):
-        self.assert_home_path_equals('~/.config/MusicBrainz/Picard/plugins', plugin_folder())
+        self.assert_home_path_equals('~/.local/share/MusicBrainz/Picard/plugins3', plugin_folder())