feat: extension model and form validation

geonode_mapstore_client/admin.py

@@ -1,7 +1,48 @@
+import os
+from django import forms
 from django.contrib import admin
-from geonode_mapstore_client.models import SearchService
+from geonode_mapstore_client.models import SearchService, Extension
 
 
 @admin.register(SearchService)
 class SearchServiceAdmin(admin.ModelAdmin):
     pass
+
+
+class ExtensionAdminForm(forms.ModelForm):
+    class Meta:
+        model = Extension
+        fields = '__all__'
+
+    def clean_uploaded_file(self):
+        """
+        It checks the uploaded file's name for uniqueness before the model is saved.
+        """
+        uploaded_file = self.cleaned_data.get('uploaded_file')
+
+        if uploaded_file:
+            extension_name = os.path.splitext(os.path.basename(uploaded_file.name))[0]
+
+            queryset = Extension.objects.filter(name=extension_name)
+
+            # If we are updating an existing instance, we can exclude it from the check
+            if self.instance.pk:
+                queryset = queryset.exclude(pk=self.instance.pk)
+
+            # If the queryset finds any conflicting extension, raise a validation error
+            if queryset.exists():
+                raise forms.ValidationError(
+                    f"An extension with the name '{extension_name}' already exists. Please upload a file with a different name."
+                )
+
+        return uploaded_file
+
+
+@admin.register(Extension)
+class ExtensionAdmin(admin.ModelAdmin):
+
+    form = ExtensionAdminForm
+    list_display = ('name', 'active', 'is_map_extension', 'updated_at')
+    list_filter = ('active', 'is_map_extension')
+    search_fields = ('name',)
+    readonly_fields = ('name', 'created_at', 'updated_at')

geonode_mapstore_client/apps.py

@@ -77,6 +77,9 @@ def run_setup_hooks(*args, **kwargs):
         pass
 
     urlpatterns += [
+        re_path("/client/extension", views.ExtensionsView.as_view(), name="mapstore-extension"),
+        re_path("/client/pluginsconfig", views.PluginsConfigView.as_view(), name="mapstore-pluginsconfig"),
+
         re_path(
             r"^catalogue/",
             TemplateView.as_view(

geonode_mapstore_client/migrations/0005_extension.py

@@ -0,0 +1,66 @@
+# Generated by Django 4.2.23 on 2025-10-03 12:14
+
+from django.db import migrations, models
+import geonode_mapstore_client.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("geonode_mapstore_client", "0004_auto_20231114_1705"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Extension",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(
+                        blank=True,
+                        help_text="Name of the extension, derived from the zip file name. Must be unique.",
+                        max_length=255,
+                        unique=True,
+                    ),
+                ),
+                (
+                    "uploaded_file",
+                    models.FileField(
+                        help_text="Upload the MapStore extension as a zip folder.",
+                        upload_to=geonode_mapstore_client.models.extension_upload_path,
+                        validators=[geonode_mapstore_client.models.validate_zip_file],
+                    ),
+                ),
+                (
+                    "active",
+                    models.BooleanField(
+                        default=True,
+                        help_text="Whether the extension is active and should be included in the index.",
+                    ),
+                ),
+                (
+                    "is_map_extension",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Check if this extension is a map-specific plugin for Map Viewers.",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                "verbose_name": "MapStore Extension",
+                "verbose_name_plural": "MapStore Extensions",
+                "ordering": ("name",),
+            },
+        ),
+    ]

geonode_mapstore_client/models.py

@@ -1,14 +1,21 @@
+import os
+import shutil
+import zipfile
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 from django.contrib.postgres.fields import ArrayField
 from django.dispatch import receiver
 from django.db.models import signals
 from django.core.cache import caches
-
+from django.db import models
+from geonode_mapstore_client.utils import validate_zip_file, clear_extension_caches
 from geonode_mapstore_client.templatetags.get_search_services import (
     populate_search_service_options,
 )
+from django.conf import settings
 
+# Define the target directory for static extensions
+EXTENSIONS_STATIC_DIR = os.path.join(settings.STATIC_ROOT, 'extensions')
 
 class SearchService(models.Model):
     class Meta:
@@ -73,3 +80,81 @@ def post_save_search_service(instance, sender, created, **kwargs):
         services_cache.delete("search_services")
 
     services_cache.set("search_services", populate_search_service_options(), 300)
+
+
+
+def extension_upload_path(instance, filename):
+    return f"mapstore_extensions/{filename}"
+
+
+class Extension(models.Model):
+    name = models.CharField(
+        max_length=255,
+        unique=True,
+        blank=True,  # Will be populated from the zip filename
+        help_text="Name of the extension, derived from the zip file name. Must be unique.",
+    )
+    uploaded_file = models.FileField(
+        upload_to=extension_upload_path,
+        validators=[validate_zip_file],
+        help_text="Upload the MapStore extension as a zip folder.",
+    )
+    active = models.BooleanField(
+        default=True,
+        help_text="Whether the extension is active and should be included in the index.",
+    )
+    is_map_extension = models.BooleanField(
+        default=False,
+        help_text="Check if this extension is a map-specific plugin for Map Viewers.",
+    )
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.name
+
+    def save(self, *args, **kwargs):
+        if not self.name and self.uploaded_file:
+            self.name = os.path.splitext(os.path.basename(self.uploaded_file.name))[0]
+        super().save(*args, **kwargs)
+
+    class Meta:
+        ordering = ("name",)
+        verbose_name = "MapStore Extension"
+        verbose_name_plural = "MapStore Extensions"
+
+
+@receiver(signals.post_save, sender=Extension)
+def handle_extension_upload(sender, instance, **kwargs):
+    """
+    Unzips the extension file and clears the API cache after saving.
+    """
+    os.makedirs(EXTENSIONS_STATIC_DIR, exist_ok=True)
+    target_path = os.path.join(EXTENSIONS_STATIC_DIR, instance.name)
+
+    if os.path.exists(target_path):
+        shutil.rmtree(target_path)
+
+    try:
+        with zipfile.ZipFile(instance.uploaded_file.path, "r") as zip_ref:
+            zip_ref.extractall(target_path)
+    except FileNotFoundError:
+        pass
+
+    clear_extension_caches()
+
+
+@receiver(signals.post_delete, sender=Extension)
+def handle_extension_delete(sender, instance, **kwargs):
+    """
+    Removes the extension's files and clears the API cache on deletion.
+    """
+    if instance.name:
+        extension_path = os.path.join(EXTENSIONS_STATIC_DIR, instance.name)
+        if os.path.exists(extension_path):
+            shutil.rmtree(extension_path)
+
+    if instance.uploaded_file and os.path.exists(instance.uploaded_file.path):
+        os.remove(instance.uploaded_file.path)
+
+    clear_extension_caches()

geonode_mapstore_client/utils.py

@@ -1,9 +1,15 @@
 import os
 import json
-
+import zipfile
+from django.core.exceptions import ValidationError
 from geoserver.catalog import FailedRequestError
 from geonode.geoserver.helpers import gs_catalog
 from geonode.layers.models import Dataset
+from django.core.cache import cache
+
+MAPSTORE_PLUGINS_CACHE_KEY = "mapstore_plugins_config"
+MAPSTORE_EXTENSIONS_CACHE_KEY = "mapstore_extensions_index"
+MAPSTORE_EXTENSION_CACHE_TIMEOUT = 60 * 60 * 24 * 1  # 1 day
 
 
 def set_default_style_to_open_in_visual_mode(instance, **kwargs):
@@ -25,3 +31,26 @@ def set_default_style_to_open_in_visual_mode(instance, **kwargs):
                         style.name, resp.status_code, resp.text
                     )
                 )
+
+
+def validate_zip_file(file):
+    """
+    Validates that the uploaded file is a zip and contains the required structure.
+    """
+    if not zipfile.is_zipfile(file):
+        raise ValidationError("File is not a valid zip archive.")
+
+    file.seek(0)
+    with zipfile.ZipFile(file, 'r') as zip_ref:
+        filenames = zip_ref.namelist()
+        required_files = {'index.js', 'index.json'}
+        if not required_files.issubset(filenames):
+            raise ValidationError("The zip file must contain index.js and index.json at its root.")
+    file.seek(0)
+
+
+def clear_extension_caches():
+    """A helper function to clear all MapStore Extension caches."""
+    cache.delete(MAPSTORE_EXTENSIONS_CACHE_KEY)
+    cache.delete(MAPSTORE_PLUGINS_CACHE_KEY)
+    print("MapStore extension caches cleared.")

geonode_mapstore_client/views.py

@@ -1,7 +1,15 @@
+import os
+import json
+from rest_framework.views import APIView
 from django.shortcuts import render
 from django.http import Http404
 from django.utils.translation.trans_real import get_language_from_request
 from dateutil import parser
+from django.conf import settings
+from django.templatetags.static import static
+from rest_framework.response import Response
+from django.core.cache import cache
+
 
 def _parse_value(value, schema):
     schema_type = schema.get('type')
@@ -70,3 +78,98 @@ def metadata(request, pk, template="geonode-mapstore-client/metadata.html"):
 
 def metadata_embed(request, pk):
     return metadata(request, pk, template="geonode-mapstore-client/metadata_embed.html")
+
+
+
+class ExtensionsView(APIView):
+    permission_classes = []
+
+    def get(self, request, *args, **kwargs):
+        from geonode_mapstore_client.models import Extension
+        from geonode_mapstore_client.utils import (
+            MAPSTORE_EXTENSIONS_CACHE_KEY,
+            MAPSTORE_EXTENSION_CACHE_TIMEOUT,
+        )
+
+        cached_data = cache.get(MAPSTORE_EXTENSIONS_CACHE_KEY)
+        if cached_data:
+            return Response(cached_data)
+
+        final_extensions = {}
+        legacy_file_path = os.path.join(
+            settings.STATIC_ROOT, "geonode", "js", "extensions.json"
+        )
+
+        try:
+            with open(legacy_file_path, "r") as f:
+                final_extensions = json.load(f)
+        except (FileNotFoundError, json.JSONDecodeError):
+            pass
+
+        active_extensions = Extension.objects.filter(active=True)
+        dynamic_extensions = {}
+        for ext in active_extensions:
+            dynamic_extensions[ext.name] = {
+                "bundle": static(f"extensions/{ext.name}/index.js"),
+                "translations": static(f"extensions/{ext.name}/translations"),
+                "assets": static(f"extensions/{ext.name}/assets"),
+            }
+
+        final_extensions.update(dynamic_extensions)
+
+        cache.set(
+            MAPSTORE_EXTENSIONS_CACHE_KEY,
+            final_extensions,
+            timeout=MAPSTORE_EXTENSION_CACHE_TIMEOUT,
+        )
+
+        return Response(final_extensions)
+
+
+class PluginsConfigView(APIView):
+    permission_classes = []
+
+    def get(self, request, *args, **kwargs):
+        from geonode_mapstore_client.models import Extension
+        from geonode_mapstore_client.utils import (
+            MAPSTORE_PLUGINS_CACHE_KEY,
+            MAPSTORE_EXTENSION_CACHE_TIMEOUT,
+        )
+
+        cached_data = cache.get(MAPSTORE_PLUGINS_CACHE_KEY)
+        if cached_data:
+            return Response(cached_data)
+
+        base_config_path = os.path.join(
+            settings.PROJECT_ROOT, 'static', 'mapstore', 'configs', 'pluginsConfig.json'
+        )
+
+        config_data = {"plugins": []}
+
+        try:
+            with open(base_config_path, 'r') as f:
+                config_data = json.load(f)
+        except (FileNotFoundError, json.JSONDecodeError):
+            pass
+
+        plugins = config_data.get("plugins", [])
+        existing_plugin_names = {p.get("name") for p in plugins if isinstance(p, dict)}
+
+        map_extensions = Extension.objects.filter(active=True, is_map_extension=True)
+
+        for ext in map_extensions:
+            if ext.name not in existing_plugin_names:
+                plugins.append({
+                    "name": ext.name,
+                    "bundle": static(f'extensions/{ext.name}/index.js'),
+                    "translations": static(f'extensions/{ext.name}/translations'),
+                    "assets": static(f'extensions/{ext.name}/assets'),
+                })
+
+        cache.set(
+            MAPSTORE_PLUGINS_CACHE_KEY,
+            config_data,
+            timeout=MAPSTORE_EXTENSION_CACHE_TIMEOUT,
+        )
+
+        return Response({"plugins": plugins})