Draft: add rdmo.config app for Plugin model (plugin management)

conftest.py

@@ -25,7 +25,8 @@ def fixtures():
         'sites',
         'tasks',
         'users',
-        'views'
+        'views',
+        'config'
     }
     fixtures = []
     for fixture_dir in settings.FIXTURE_DIRS:

package.json

@@ -19,6 +19,7 @@
   },
   "dependencies": {
     "@codemirror/lang-html": "^6.4.2",
+    "@codemirror/lang-json": "^6.0.2",
     "@codemirror/lang-javascript": "^6.2.2",
     "@uiw/react-codemirror": "^4.25.1",
     "bootstrap-sass": "^3.4.1",

rdmo/accounts/checks.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 from django.conf import settings
 from django.core.checks import Tags, Warning, register
 

rdmo/accounts/tests/test_checks_shibboleth.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 from rdmo.accounts.checks import W_FIX_DISABLED, W_MISSING_FIX, check_shibboleth_remoteuser
 
 from .helpers import enable_shibboleth, fake_shibboleth  # noqa: F401

rdmo/config/admin.py

@@ -0,0 +1,41 @@
+from django import forms
+from django.contrib import admin
+
+from rdmo.core.admin import ElementAdminForm
+from rdmo.core.utils import get_language_fields, get_plugin_python_paths
+
+from .models import Plugin
+from .validators import (
+    PluginLockedValidator,
+    PluginPythonPathValidator,
+    PluginUniqueURIValidator,
+    PluginURLNameValidator,
+)
+
+
+class PluginAdminForm(ElementAdminForm):
+
+    python_path = forms.ChoiceField(choices=[(plugin, plugin) for plugin in get_plugin_python_paths()])
+
+
+    class Meta:
+        model = Plugin
+        fields = '__all__'
+
+    def clean(self):
+        PluginUniqueURIValidator(self.instance)(self.cleaned_data)
+        PluginLockedValidator(self.instance)(self.cleaned_data)
+        PluginPythonPathValidator(self.instance)(self.cleaned_data)
+        PluginURLNameValidator(self.instance)(self.cleaned_data)
+
+
+@admin.register(Plugin)
+class PluginAdmin(admin.ModelAdmin):
+    form = PluginAdminForm
+
+    search_fields = ['uri', 'python_path', *get_language_fields('title'), *get_language_fields('help')]
+    list_display = ('uri', 'python_path', 'plugin_type', 'available')
+    readonly_fields = ('uri', 'plugin_type')
+    list_filter = ('available', 'python_path', 'sites' , 'groups', 'catalogs')
+    filter_horizontal = ('catalogs', 'sites', 'editors', 'groups')
+    ordering = ('python_path','order')

rdmo/config/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class ConfigConfig(AppConfig):
+    name = 'rdmo.config'
+    verbose_name = _('Config')
+
+    def ready(self):
+        from . import checks  # noqa: F401

rdmo/config/checks.py

@@ -0,0 +1,78 @@
+from collections import defaultdict
+
+from django.core.checks import Warning, register
+from django.utils.module_loading import import_string
+
+
+@register()
+def deprecated_plugin_settings_check(app_configs, **kwargs):
+    from django.conf import settings
+    legacy_settings = [
+        "PROJECT_EXPORTS",
+        "PROJECT_SNAPSHOT_EXPORTS",
+        "PROJECT_IMPORTS",
+        "PROJECT_ISSUE_PROVIDERS",
+        "PROJECT_IMPORTS_LIST",
+        "OPTIONSET_PROVIDERS",
+    ]
+    issues = []
+    legacy_settings_used_keys = {
+        i for i in legacy_settings if hasattr(settings, i)
+    }
+    if legacy_settings_used_keys:
+        _verb = "are" if len(legacy_settings_used_keys) > 1 else "is"
+        legacy_settings = {
+            i: getattr(settings, i) for i in legacy_settings_used_keys
+        }
+        _legacy_settings_plugins = defaultdict(list)
+        _python_paths = set()
+        for name,entries in legacy_settings.items():
+            for entry in entries:
+                _legacy_settings_plugins[name].append(entry)
+                if len(entry) == 3:
+                    _python_paths.add(entry[-1])
+        issues.append(Warning(
+            f"{', '.join(legacy_settings_used_keys)} {_verb} deprecated as of RDMO 2.5.0; "
+            f"use PLUGINS = ['python.dotted.paths', ...] instead.",
+            id="rdmo.config.W001",
+            hint="Define the legacy plugin settings in PLUGINS and remove the legacy settings."
+                 f"\n{repr_new_settings(_python_paths)}",
+        ))
+        # If both PLUGINS and any legacy key exist
+        if settings.PLUGINS:
+            issues.append(Warning(
+                "PLUGINS is set in addition to legacy settings; the legacy settings are ignored.",
+                id="rdmo.config.W002",
+                hint="Remove the following legacy settings to avoid confusion: "
+                     f"{', '.join(legacy_settings_used_keys)}."
+            ))
+    return issues
+
+
+def repr_new_settings(python_paths) -> str:
+    if not python_paths:
+        return ""
+    elif len(python_paths) == 1:
+        return f"PLUGINS = ['{python_paths}']"
+    msg = "PLUGINS = ["
+    for python_path in sorted(python_paths):
+        msg += f"\n\t{python_path}, "
+    msg += "\n]"
+    return msg
+
+
+@register()
+def plugins_importable_check(app_configs, **kwargs):
+    from django.conf import settings
+
+    issues = []
+    for plugin_path in settings.PLUGINS:
+        try:
+            import_string(plugin_path)
+        except ImportError as exc:
+            issues.append(Warning(
+                f"Plugin import failed: {plugin_path} ({exc})",
+                id="rdmo.config.W003",
+                hint="Ensure the plugin path is valid and the module is installed.",
+            ))
+    return issues

rdmo/config/constants.py

@@ -0,0 +1,9 @@
+from django.db.models import TextChoices
+
+
+class PLUGIN_TYPES(TextChoices):
+    PROJECT_EXPORT = "project_export", "Project export"
+    PROJECT_SNAPSHOT_EXPORT = "project_snapshot_export", "Project snapshot export"
+    PROJECT_IMPORT = "project_import", "Project import"
+    PROJECT_ISSUE_PROVIDER = "project_issue_provider", "Project issue provider"
+    OPTIONSET_PROVIDER = "optionset_provider", "Optionset provider"

rdmo/config/imports.py

@@ -0,0 +1,20 @@
+from rdmo.core.import_helpers import ElementImportHelper, ExtraFieldHelper
+
+from .models import Plugin
+from .validators import PluginLockedValidator, PluginUniqueURIValidator
+
+import_helper_plugin = ElementImportHelper(
+    model=Plugin,
+    validators=(PluginLockedValidator, PluginUniqueURIValidator),
+    lang_fields=('title', 'help'),
+    extra_fields=(
+        ExtraFieldHelper(field_name='python_path'),
+        ExtraFieldHelper(field_name='plugin_settings', overwrite_in_element=True),
+        ExtraFieldHelper(field_name='available', overwrite_in_element=True),
+        ExtraFieldHelper(field_name='locked'),
+        ExtraFieldHelper(field_name='order'),
+        ExtraFieldHelper(field_name='url_name'),
+
+    ),
+    add_current_site_sites = True,
+)

rdmo/config/legacy.py

@@ -0,0 +1,44 @@
+from django.conf import settings
+
+from rdmo.config.constants import PLUGIN_TYPES
+
+PLUGIN_TYPE_TO_SETTING_KEY = {
+    PLUGIN_TYPES.PROJECT_IMPORT: "PROJECT_IMPORTS",
+    PLUGIN_TYPES.PROJECT_EXPORT: "PROJECT_EXPORTS",
+    PLUGIN_TYPES.PROJECT_SNAPSHOT_EXPORT: "PROJECT_SNAPSHOT_EXPORTS",
+    PLUGIN_TYPES.PROJECT_ISSUE_PROVIDER: "PROJECT_ISSUE_PROVIDERS",
+    PLUGIN_TYPES.OPTIONSET_PROVIDER: "OPTIONSET_PROVIDERS",
+}
+
+def get_plugins_from_legacy_settings(select_plugin_type=None) -> list[dict]:
+    """Read 3-tuples (key, label, python-path) from legacy settings."""
+    plugin_definitions: list[dict] = []
+    for plugin_type, legacy_setting in PLUGIN_TYPE_TO_SETTING_KEY.items():
+        if not hasattr(settings, legacy_setting):
+            continue
+        if select_plugin_type is not None and select_plugin_type != plugin_type:
+            continue
+
+        legacy_plugins = getattr(settings, legacy_setting, None)
+        if not legacy_plugins:
+            continue
+
+        for entry in legacy_plugins:
+            try:
+                key, label, dotted = entry
+            except ValueError as exc:
+                raise ValueError(
+                    f"{legacy_setting} must be a sequence of 3-tuples "
+                    f"(key, label, python-path); got {entry!r}"
+                ) from exc
+
+            plugin_definitions.append({
+                "uri_prefix": settings.DEFAULT_URI_PREFIX,
+                "uri_path": f"{legacy_setting.lower()}/{key}",
+                "title": label,
+                "python_path": dotted,
+                "plugin_type": plugin_type,
+                "url_name": key,
+            })
+
+    return plugin_definitions

rdmo/config/management/commands/check_plugins.py

@@ -0,0 +1,26 @@
+from django.core.management.base import BaseCommand
+from django.utils.module_loading import import_string
+
+from rdmo.config.models import Plugin
+
+
+class Command(BaseCommand):
+    help = "Check that all configured plugins can be imported"
+
+    def handle(self, *args, **options):
+        if not Plugin.objects.exists():
+            self.stdout.write(self.style.SUCCESS("No plugins found."))
+
+        for plugin in Plugin.objects.order_by('python_path').all():
+            try:
+                import_string(plugin.python_path)
+                self.stdout.write(self.style.SUCCESS(f"✔ {plugin.python_path}, type={plugin.plugin_type}."))
+            except ImportError as e:
+                if plugin.available:
+                    self.stdout.write(self.style.ERROR(
+                        f"✖ {plugin.python_path}, type={plugin.plugin_type} failed: {e}")
+                    )
+                else:
+                    self.stdout.write(self.style.WARNING(
+                        f"!! {plugin.python_path}, type={plugin.plugin_type} (=unavailable) failed: {e}")
+                    )