django-dh-map 0.0.0__py3-none-any.whl

django_dh_map/admin.py

@@ -0,0 +1,408 @@
+import json
+from django.contrib import admin
+from django.db import models
+from django.utils.safestring import mark_safe
+from django_rq import enqueue
+from django.contrib import messages
+from django.forms import widgets
+from django.utils.html import escape
+from tinymce.widgets import TinyMCE
+from js_asset import JS
+from adminsortable2.admin import SortableAdminMixin
+from solo.admin import SingletonModelAdmin
+from polymorphic.admin import PolymorphicParentModelAdmin, PolymorphicChildModelAdmin, \
+    PolymorphicChildModelFilter
+from nested_admin.nested import NestedModelAdmin, NestedStackedInline
+from nested_admin.polymorphic import NestedPolymorphicModelAdmin, NestedStackedPolymorphicInline
+
+from .tasks import task_overhead_map_tiles_generator, task_panorama_map_tiles_generator, \
+    task_video_stream_generator, task_video_snapshot_generator, task_video_thumbnails_vtt_generator, \
+    task_audio_stream_generator
+from .helpers import get_success_failure_status_tick
+from .models import Map, OverheadImageMap, PanoramaImageMap, AbstractImageMap, XyzMap, \
+    InfoPage, Feature, ContentBlock, ContentBlockRichText, ContentBlockImage, ContentBlockImageGallery, \
+    ContentBlockImageGalleryImage, ContentBlockImageBeforeAndAfter, ContentBlockVideo, ContentBlockAudio, \
+    Icon, IconImage, IconNumbered
+# IconFont
+from .font_icons import FontIcon
+from .serializers import ContentBlockImageGalleryImageSerializer
+from .widgets import TextDataListWidget
+from .forms import BaseMapAdminForm, XyzMapForm, OverheadImageMapForm, PanoramaImageMapForm
+from .settings import DH_MAP_DEFAULT_PROPERTIES_SCHEMA, DH_MAP_CI_FEATURE_PROPERTIES_SCHEMA
+
+def video_preview_app_tag(video, title, thumbnail, thumbnails_vtt):
+    return f'<div class="admin-video-preview-app" data-video="{video.url}" data-title="{title}" data-thumbnail="{thumbnail.url if thumbnail else ''}" data-thumbnails-vtt="{thumbnails_vtt.url if thumbnails_vtt else ''}"></div>'
+
+class DjangoDhMapAdminMixin:
+  class Media:
+    css = { 'all': ['django_dh_map/admin/dist/admin.css'] }
+    js = [JS('django_dh_map/admin/dist/admin.js', {'type': 'module'})]
+
+# based of SortableHiddenMixin
+class SortableHiddenMixinTinyMceFix:
+    sortable_field_name = "position"
+    def formfield_for_dbfield(self, db_field, request, **kwargs):
+        if db_field.name == self.sortable_field_name:
+            kwargs["widget"] = widgets.HiddenInput(attrs={'class': '_sortable_field_'})
+        return super().formfield_for_dbfield(db_field, request, **kwargs)
+
+class SortablePolymorphicParentModelAdmin(PolymorphicParentModelAdmin):
+    @property
+    def change_list_template(self):
+        return "admin/change_list.html"
+
+class MapAdminChildAdmin(DjangoDhMapAdminMixin, PolymorphicChildModelAdmin):
+    base_form = BaseMapAdminForm
+
+@admin.register(XyzMap)
+class XyzMapChildAdmin(MapAdminChildAdmin):
+    base_form = XyzMapForm
+    base_model = XyzMap
+
+@admin.register(OverheadImageMap)
+class OverheadImageMapChildAdmin(MapAdminChildAdmin):
+    base_form = OverheadImageMapForm
+    base_model = OverheadImageMap
+
+    def get_fields(self, request, obj=None):
+        fields = super().get_fields(request, obj)
+        if not obj or not obj.has_tiles():
+            fields.remove('map_geojson')
+            fields.remove('properties')
+        return fields
+
+@admin.register(PanoramaImageMap)
+class PanoramaImageMapChildAdmin(MapAdminChildAdmin):
+    base_form = PanoramaImageMapForm
+    base_model = PanoramaImageMap
+
+    def get_fields(self, request, obj=None):
+        fields = super().get_fields(request, obj)
+        if not obj or not obj.has_tiles():
+            fields.remove('map_geojson')
+            fields.remove('properties')
+        return fields
+
+@admin.register(Map)
+class MapParentAdmin(DjangoDhMapAdminMixin, SortableAdminMixin, SortablePolymorphicParentModelAdmin):
+    child_models = (XyzMap, OverheadImageMap, PanoramaImageMap)
+    list_filter = [PolymorphicChildModelFilter]
+    polymorphic_list = True
+    list_per_page = 5
+    ordering = ['position']
+
+    list_display = ('position', 'id', '_type', 'label', 'date_taken', '_preview', '_status')
+    list_display_links = ('id', '_type', 'label', 'date_taken')
+    actions = ['reprocess_maps']
+
+    @admin.action(description="(Re)process selected map(s)")
+    def reprocess_maps(self, request, queryset):
+        job_count = 0
+        for map in queryset:
+            if isinstance(map, OverheadImageMap) and map.has_image():
+                enqueue(task_overhead_map_tiles_generator, map.pk)
+                # task_overhead_map_tiles_generator(map.pk)
+                job_count+=1
+            elif isinstance(map, PanoramaImageMap) and map.has_image():
+                enqueue(task_panorama_map_tiles_generator, map.pk)
+                # task_panorama_map_tiles_generator(map.pk)
+                job_count+=1
+        self.message_user(request, f'Created {job_count} jobs.', messages.SUCCESS)
+
+    def _type(self, obj):
+        return obj._meta.verbose_name
+    _type.short_description = 'Map Type'
+
+    def _preview(self, obj):
+        if isinstance(obj, XyzMap) and obj.url:
+            return mark_safe(f'<div class="openlayers-preview-app" data-map-id="{obj.pk}"></div>')
+        elif isinstance(obj, OverheadImageMap) and obj.tiles_dir:
+            return mark_safe(f'<div class="openlayers-preview-app" data-map-id="{obj.pk}"></div>')
+        elif isinstance(obj, PanoramaImageMap) and obj.tiles_dir:
+            return mark_safe(f'<div class="pannellum-preview-app" data-map-id="{obj.pk}"></div>')
+        return ''
+    _preview.short_description = 'Preview'
+
+    def _status(self, obj):
+        tiles_status_str = ''
+        if isinstance(obj, AbstractImageMap):
+            tiles_status_str = mark_safe(f'{get_success_failure_status_tick(obj.has_tiles())} Map Tiles <br />')
+
+        return mark_safe(f'''
+            {get_success_failure_status_tick(obj.published)} Published<br />
+            {tiles_status_str}
+        ''')
+    _status.short_description = "Status"
+
+class ContentBlockInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline):
+    model = ContentBlock
+
+    class ContentBlockRichTextInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = ContentBlockRichText
+        formfield_overrides = { models.TextField: { 'widget': TinyMCE } }
+
+    class ContentBlockImageInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = ContentBlockImage
+        fields = [('_thumbnail_tag', 'original'), ('name', 'description', 'license'), 'position']
+        readonly_fields = ['_thumbnail_tag']
+        def _thumbnail_tag(self, obj):
+            return mark_safe(f'<img class="admin-image-preview" src="{obj.thumbnail.url}" />') if obj.thumbnail else 'N/A'
+        _thumbnail_tag.short_description = 'Preview'
+
+    class ContentBlockImageGalleryInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = ContentBlockImageGallery
+        fields = ['_gallery_preview_tag', 'position']
+
+        readonly_fields = ['_gallery_preview_tag']
+        def _gallery_preview_tag(self, obj):
+            images = obj.images.all()
+            images_json = json.dumps(ContentBlockImageGalleryImageSerializer(images, many=True).data) if len(images) > 0 else None
+            return mark_safe(f'<div class="admin-gallery-preview-app" data-gallery-images-json="{escape(images_json)}"></div>') if images_json else 'N/A'
+        _gallery_preview_tag.short_description = 'Preview'
+
+        class ContentBlockImageGalleryImageInline(SortableHiddenMixinTinyMceFix, NestedStackedInline):
+            model = ContentBlockImageGalleryImage
+            min_num = 1
+            extra = 0
+            classes = ['collapse']
+            fields = [('_thumbnail_tag', 'original'), ('name', 'description', 'license'), 'position']
+            readonly_fields = ['_thumbnail_tag']
+            def _thumbnail_tag(self, obj):
+                return mark_safe(f'<img class="admin-image-preview" src="{obj.thumbnail.url}" />') if obj.thumbnail else 'N/A'
+            _thumbnail_tag.short_description = 'Preview'
+
+        inlines = [ContentBlockImageGalleryImageInline]
+
+    class ContentBlockImageBeforeAndAfterInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = ContentBlockImageBeforeAndAfter
+        fieldsets = (
+            (None, { 'fields': [
+                ('_before_after_preview_tag', 'caption',), 'position',
+            ], }),
+            ('Before Image', { 'classes': ('collapse', 'expanded'), 'fields': [
+                ('_before_thumbnail_tag', 'before_original'),
+                ('before_name', 'before_description', 'before_license'),
+            ], }),
+            ('After Image', { 'classes': ('collapse', 'expanded'), 'fields': [
+                ('_after_thumbnail_tag', 'after_original'),
+                ('after_name', 'after_description', 'after_license'),
+            ], }),
+        )
+        readonly_fields = ['_before_after_preview_tag', '_before_thumbnail_tag', '_after_thumbnail_tag']
+        def _before_after_preview_tag(self, obj):
+            return mark_safe(f'<div class="admin-before-after-preview-app" data-before="{obj.before_thumbnail.url}" data-after="{obj.after_thumbnail.url}"></div>') if obj.before_thumbnail and obj.after_thumbnail else 'N/A'
+        _before_after_preview_tag.short_description = 'Preview'
+        def _before_thumbnail_tag(self, obj):
+            return mark_safe(f'<img class="admin-image-preview" src="{obj.before_thumbnail.url}" />') if obj.before_thumbnail else 'N/A'
+        _before_thumbnail_tag.short_description = 'Preview'
+        def _after_thumbnail_tag(self, obj):
+            return mark_safe(f'<img class="admin-image-preview" src="{obj.after_thumbnail.url}" />') if obj.after_thumbnail else 'N/A'
+        _after_thumbnail_tag.short_description = 'Preview'
+
+    class ContentBlockVideoInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = ContentBlockVideo
+        fields = [('_video_tag', 'original'), ('name', 'license'), 'position']
+        readonly_fields = ['_video_tag']
+
+        def _video_tag(self, obj):
+            return mark_safe(video_preview_app_tag(obj.video, f'{obj}', obj.thumbnail, obj.thumbnails_vtt)) if obj.video else 'N/A'
+        _video_tag.short_description = 'Preview'
+
+    class ContentBlockAudioInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = ContentBlockAudio
+        fields = [('_audio_tag', 'original'), ('name', 'license'), 'position']
+        readonly_fields = ['_audio_tag']
+        def _audio_tag(self, obj):
+            return mark_safe(f'<audio src="{obj.audio.url}" controls preload="metadata" />') if obj.audio else 'N/A'
+        _audio_tag.short_description = 'Preview'
+
+    child_inlines = (
+        ContentBlockRichTextInline,
+        ContentBlockImageInline,
+        ContentBlockImageGalleryInline,
+        ContentBlockImageBeforeAndAfterInline,
+        ContentBlockVideoInline,
+        ContentBlockAudioInline,
+    )
+
+@admin.register(ContentBlockVideo)
+class ContentBlockVideoAdmin(DjangoDhMapAdminMixin, PolymorphicChildModelAdmin):
+    base_model = ContentBlockVideo
+    fields = [('_video_tag', 'original'), ('name', 'license')]
+    readonly_fields = ['_video_tag']
+    show_in_index = True
+    list_display = ('id', '_name', '_status')
+    list_display_links = ('id', '_name')
+    ordering = ['id']
+    actions = ['reprocess_snapshot', 'reprocess_video_stream', 'reprocess_thumbnails_vtt']
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+    def _name(self, obj):
+        return f'{obj}'
+    _name.short_description = 'Name'
+
+    def _status(self, obj):
+        return mark_safe(f'''
+            {get_success_failure_status_tick(obj.has_video())} Streamable<br />
+            {get_success_failure_status_tick(obj.has_snapshot())} Poster Image<br />
+            {get_success_failure_status_tick(obj.has_thumbnails_vtt())} Preview Thumbnails
+        ''')
+    _status.short_description = 'Status'
+
+    def _video_tag(self, obj):
+        return mark_safe(video_preview_app_tag(obj.video, f'{obj}', obj.thumbnail, obj.thumbnails_vtt)) if obj.video else 'N/A'
+    _video_tag.short_description = 'Preview'
+
+    @admin.action(description="(Re)process poster images for selected video(s)")
+    def reprocess_snapshot(self, request, queryset):
+        job_count = 0
+        for video in queryset:
+            enqueue(task_video_snapshot_generator, video.pk)
+            # task_video_snapshot_generator(video.pk)
+            job_count+=1
+        self.message_user(request, f'Created {job_count} jobs.', messages.SUCCESS)
+
+    @admin.action(description="(Re)process video stream for selected video(s)")
+    def reprocess_video_stream(self, request, queryset):
+        job_count = 0
+        for video in queryset:
+            enqueue(task_video_stream_generator, video.pk)
+            # task_video_stream_generator(video.pk)
+            job_count+=1
+        self.message_user(request, f'Created {job_count} jobs.', messages.SUCCESS)
+
+    @admin.action(description="(Re)process preview thumbnails for selected video(s)")
+    def reprocess_thumbnails_vtt(self, request, queryset):
+        job_count = 0
+        for video in queryset:
+            enqueue(task_video_thumbnails_vtt_generator, video.pk)
+            # task_video_thumbnails_vtt_generator(video.pk)
+            job_count+=1
+        self.message_user(request, f'Created {job_count} jobs.', messages.SUCCESS)
+
+@admin.register(ContentBlockAudio)
+class ContentBlockAudioAdmin(DjangoDhMapAdminMixin, PolymorphicChildModelAdmin):
+    base_model = ContentBlockAudio
+    fields = [('_audio_tag', 'original'), ('name', 'license')]
+    readonly_fields = ['_audio_tag']
+    show_in_index = True
+    list_display = ('id', '_name', '_status')
+    list_display_links = ('id', '_name')
+    ordering = ['id']
+    actions = ['reprocess_audio_stream']
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+    def _name(self, obj):
+        return f'{obj}'
+    _name.short_description = 'Name'
+
+    def _status(self, obj):
+        return mark_safe(f'''
+            {get_success_failure_status_tick(obj.has_audio())} Streamable
+        ''')
+    _status.short_description = 'Status'
+
+    def _audio_tag(self, obj):
+        return mark_safe(f'<audio src="{obj.audio.url}" controls preload="metadata" />') if obj.audio else 'N/A'
+    _audio_tag.short_description = 'Preview'
+
+    @admin.action(description="(Re)process audio stream for selected audio(s)")
+    def reprocess_audio_stream(self, request, queryset):
+        job_count = 0
+        for audio in queryset:
+            # enqueue(task_audio_stream_generator, audio.pk)
+            task_audio_stream_generator(audio.pk)
+            job_count+=1
+        self.message_user(request, f'Created {job_count} jobs.', messages.SUCCESS)
+
+class AbstractContentItemAdmin(DjangoDhMapAdminMixin, NestedPolymorphicModelAdmin):
+    inlines = [ContentBlockInline]
+
+    def _status(self, obj):
+        video_status = [
+            f'- {get_success_failure_status_tick(video.has_video())} Streamable | {get_success_failure_status_tick(video.has_snapshot())} Poster Image | {get_success_failure_status_tick(video.has_thumbnails_vtt())} Preview Thumbnails | {video.name if video.name else video.original.name}' for video in obj.content_blocks.instance_of(ContentBlockVideo).all()
+        ]
+        video_status_str = '' if len(video_status) == 0 else 'Videos: <br />' + '<br />'.join(video_status) + '<br />'
+        audio_status = [
+            f'- {get_success_failure_status_tick(audio.has_audio())} Streamable | {audio.name if audio.name else audio.original.name}' for audio in obj.content_blocks.instance_of(ContentBlockAudio).all()
+        ]
+        audio_status_str = '' if len(audio_status) == 0 else 'Audio: <br />' + '<br />'.join(audio_status) + '<br />'
+
+        return mark_safe(f'''
+            {get_success_failure_status_tick(obj.published)} Published<br />
+            {video_status_str}
+            {audio_status_str}
+        ''')
+    _status.short_description = "Status"
+
+@admin.register(InfoPage)
+class InfoPageAdmin(SortableAdminMixin, AbstractContentItemAdmin):
+    list_display = ('position', 'id', 'title', '_status')
+    list_display_links = ('id', 'title')
+    ordering = ['position']
+    fields = ['title', 'published']
+    inlines = [ContentBlockInline]
+
+class IconInline(NestedStackedPolymorphicInline):
+    model = Icon
+    min_num = 0
+    max_num = 1
+    extra = 0
+
+    # # TODO: FIX: doesn't work well at the moment
+    # class IconFontInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+    #     model = IconFont
+    #     fields = ['class_value']
+    #     def formfield_for_dbfield(self, db_field, **kwargs):
+    #         if db_field.name == 'class_value':
+    #             kwargs['widget'] = Select2Widget(attrs={
+    #                     'data-placeholder': 'Click to select a Bootstrap or Fontawesome icon',
+    #                 },
+    #                 choices=FontIcon.choices,
+    #             )
+    #         return super().formfield_for_dbfield(db_field, **kwargs)
+
+    class IconImageInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = IconImage
+        fields = [('_thumbnail_tag', 'original')]
+        readonly_fields = ['_thumbnail_tag']
+        def _thumbnail_tag(self, obj):
+            return mark_safe(f'<img class="admin-image-preview" style="border-radius: 50%" src="{obj.icon_thumbnail.url}" />') if obj.icon_thumbnail else 'N/A'
+        _thumbnail_tag.short_description = 'Preview'
+
+    class IconNumberedInline(SortableHiddenMixinTinyMceFix, NestedStackedPolymorphicInline.Child):
+        model = IconNumbered
+        fields = ['number']
+
+    child_inlines = (
+        # IconFontInline,
+        IconImageInline,
+        IconNumberedInline,
+    )
+
+@admin.register(Feature)
+class FeatureAdmin(AbstractContentItemAdmin):
+    list_display = ('id', 'title', '_status')
+    list_display_links = ('id', 'title')
+    ordering = ['id']
+    fields = ['title', 'published', 'properties']
+    inlines = [
+        IconInline,
+        ContentBlockInline,
+    ]
+
+    def get_fields(self, request, obj=None):
+        fields = super().get_fields(request, obj)
+        if obj and 'properties' in fields and DH_MAP_CI_FEATURE_PROPERTIES_SCHEMA == DH_MAP_DEFAULT_PROPERTIES_SCHEMA:
+            fields.remove('properties')
+        return fields

django_dh_map/api.py

@@ -0,0 +1,103 @@
+from django.views.decorators.cache import cache_page
+from django.utils.decorators import method_decorator
+from django.conf import settings
+from django.db.models import Q
+from rest_framework.viewsets import ReadOnlyModelViewSet, GenericViewSet
+from rest_framework.mixins import ListModelMixin, RetrieveModelMixin
+from rest_framework.routers import DefaultRouter
+from rest_framework.permissions import IsAdminUser
+from rest_framework.renderers import JSONRenderer
+from rest_framework.decorators import action
+from rest_framework.response import Response
+
+
+from .serializers import MapGeoJsonPolymorphicSerializer, MapPolymorphicSerializer, \
+    FeatureStubSerializer, FeatureSerializer, InfoPageSerializer
+from .models import Map, MapGeoJson, Feature, InfoPage
+
+
+class ReadOnlyModelListViewSet(ListModelMixin, GenericViewSet):
+    pass
+
+class ReadOnlyModelRetrieveViewSet(RetrieveModelMixin, GenericViewSet):
+    pass
+
+class GeoJsonRenderer(JSONRenderer):
+    media_type = 'application/geo+json'
+
+class BaseMapGeoJsonViewSet(ReadOnlyModelListViewSet):
+    renderer_classes = [GeoJsonRenderer]
+    queryset = MapGeoJson.objects
+    serializer_class = MapGeoJsonPolymorphicSerializer
+    # turn off pagination for GeoJson (send whole thing)
+    pagination_class = None
+
+    def get_queryset(self):
+        return super().get_queryset().filter(map=self.kwargs['map_id'])
+
+class AdminMapGeoJsonViewSet(BaseMapGeoJsonViewSet):
+    permission_classes = [IsAdminUser]
+
+class PublicMapGeoJsonViewSet(BaseMapGeoJsonViewSet):
+    queryset = MapGeoJson.objects \
+        .filter(Q(mapgeojsonfeature__feature__published=True) | Q(mapgeojsontransition__destination_map__published=True) | Q(mapgeojsonlabel__isnull=False)) \
+        .filter(map__published=True)
+
+    @method_decorator(cache_page(settings.CACHE_SECONDS))
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+class BaseFeatureViewSet(ReadOnlyModelViewSet):
+    renderer_classes = [JSONRenderer]
+    queryset = Feature.objects.prefetch_related('icon').all()
+    serializer_class = FeatureSerializer
+
+class AdminFeatureViewSet(BaseFeatureViewSet):
+    permission_classes = [IsAdminUser]
+    serializer_class = FeatureStubSerializer
+
+class PublicFeatureViewSet(BaseFeatureViewSet):
+    queryset = Feature.objects.prefetch_related('content_blocks', 'icon').filter(published=True).all()
+
+    @method_decorator(cache_page(settings.CACHE_SECONDS))
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+    @method_decorator(cache_page(settings.CACHE_SECONDS))
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+class BaseMapViewSet(ReadOnlyModelViewSet):
+    renderer_classes = [JSONRenderer]
+    queryset = Map.objects.all()
+    serializer_class = MapPolymorphicSerializer
+
+class AdminMapViewSet(BaseMapViewSet):
+    permission_classes = [IsAdminUser]
+
+class PublicMapViewSet(BaseMapViewSet):
+    queryset = Map.objects.filter(published=True).all()
+
+    @method_decorator(cache_page(settings.CACHE_SECONDS))
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+    @method_decorator(cache_page(settings.CACHE_SECONDS))
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+class InfoPageViewSet(ReadOnlyModelViewSet):
+    renderer_classes = [JSONRenderer]
+    queryset = InfoPage.objects.prefetch_related('content_blocks').filter(published=True).all()
+    serializer_class = InfoPageSerializer
+
+admin_router = DefaultRouter(use_regex_path=False, trailing_slash=False)
+admin_router.register('maps/<int:map_id>/geojson', AdminMapGeoJsonViewSet)
+admin_router.register('features', AdminFeatureViewSet)
+admin_router.register('maps', AdminMapViewSet)
+
+public_router = DefaultRouter(use_regex_path=False, trailing_slash=False)
+public_router.register('maps/<int:map_id>/geojson', PublicMapGeoJsonViewSet)
+public_router.register('features', PublicFeatureViewSet)
+public_router.register('maps', PublicMapViewSet)
+public_router.register('pages', InfoPageViewSet)

django_dh_map/apps.py

@@ -0,0 +1,85 @@
+import shutil
+from pathlib import Path
+from typing import List
+
+from django.apps import AppConfig
+from django.core.checks import Error, Warning as CheckWarning, register, Tags
+from django.core.exceptions import ImproperlyConfigured
+
+REQUIRED_APPS = [
+    'admin_interface',
+    'colorfield',
+    'nested_admin',
+    'django_jsonform',
+    'adminsortable2',
+    'solo',
+    'tinymce',
+    'admin_async_upload',
+    'imagekit',
+    'django_rq',
+    'django.contrib.gis',
+    'django.contrib.postgres',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'polymorphic',
+    'rest_framework',
+    'rest_framework_gis',
+]
+
+
+class DjangoDhMapConfig(AppConfig):
+    name = 'django_dh_map'
+    verbose_name = 'Digital Humanities Maps'
+
+    def ready(self):
+        # Import settings inside ready() to avoid circular import issues
+        from django.conf import settings
+        for app in REQUIRED_APPS:
+            if app not in settings.INSTALLED_APPS:
+                raise ImproperlyConfigured(
+                    f"'{self.name}' requires '{app}' to be present in INSTALLED_APPS. "
+                    f"Please add '{app}' to your INSTALLED_APPS in settings.py."
+                )
+
+        import django_dh_map.signals
+        register(check_ffmpeg_availability, Tags.compatibility)
+        register(check_gdal_availability, Tags.compatibility)
+
+def check_ffmpeg_availability(app_configs, **kwargs) -> List[Error]:
+    from .settings import DH_MAP_FFMPEG, DH_MAP_FFPROBE
+    errors = []
+    if not shutil.which(DH_MAP_FFMPEG):
+        errors += [Error(
+            "FFmpeg not found",
+            hint=(f'FFmpeg binary not found at "{DH_MAP_FFMPEG}". Install FFmpeg or set DH_MAP_FFMPEG setting to correct path.')
+        )]
+    if not shutil.which(DH_MAP_FFPROBE):
+        errors += [Error(
+            "FFprobe not found",
+            hint=(f'FFprobe binary not found at "{DH_MAP_FFPROBE}". Install FFmpeg or set DH_MAP_FFPROBE setting to correct path.')
+        )]
+    return errors
+
+def check_gdal_availability(app_configs, **kwargs) -> List[Error]:
+    from .settings import GDAL_LIBRARY_PATH, GEOS_LIBRARY_PATH, DH_MAP_GDAL2TILES
+    errors = []
+    if not shutil.which(GDAL_LIBRARY_PATH):
+        errors += [Error(
+            "gdal not found",
+            hint=(f'gdal binary not found at "{GDAL_LIBRARY_PATH}". Install gdal or set GDAL_LIBRARY_PATH setting to correct path.')
+        )]
+    if not shutil.which(GEOS_LIBRARY_PATH):
+        errors += [Error(
+            "geos not found",
+            hint=(f'geos binary not found at "{GEOS_LIBRARY_PATH}". Install geos or set GEOS_LIBRARY_PATH setting to correct path.')
+        )]
+    if not shutil.which(DH_MAP_GDAL2TILES):
+        errors += [Error(
+            "gdal2tiles not found",
+            hint=(f'gdal2tiles binary not found at "{DH_MAP_GDAL2TILES}". Install gdal-tools or set DH_MAP_GDAL2TILES setting to correct path.')
+        )]
+    return errors

django_dh_map/fields.py

@@ -0,0 +1,29 @@
+from django.db import models
+from django_ffield.fields import FileFField
+from admin_async_upload.models import AsyncFileField
+
+from .validators import FileTypeValidator, FixFileTypeValidator
+
+class AsyncFFileField(FileFField, AsyncFileField):
+    # use custom validator
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        # remove FileFField's problematic validator (file needs to be reopened when async)
+        self.validators = [validator for validator in self.validators if not isinstance(validator, FileTypeValidator)]
+        if self.allowd_types or self.disallowed_types:
+            self.validators.append(
+                FixFileTypeValidator(allowd_types=self.allowd_types, disallowed_types=self.disallowed_types,)
+            )
+    pass
+
+class ImageFFileField(models.ImageField, FileFField):
+    # use custom validator
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        # remove FileFField's problematic validator (file needs to be reopened when async)
+        self.validators = [validator for validator in self.validators if not isinstance(validator, FileTypeValidator)]
+        if self.allowd_types or self.disallowed_types:
+            self.validators.append(
+                FixFileTypeValidator(allowd_types=self.allowd_types, disallowed_types=self.disallowed_types,)
+            )
+    pass