django-content-studio 1.0.0b5__py3-none-any.whl

content_studio/static/content_studio/img/media_placeholder.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="1200" fill="none"><rect width="1200" height="1200" fill="#EAEAEA" rx="3"/><g opacity=".5"><g opacity=".5"><path fill="#FAFAFA" d="M600.709 736.5c-75.454 0-136.621-61.167-136.621-136.62 0-75.454 61.167-136.621 136.621-136.621 75.453 0 136.62 61.167 136.62 136.621 0 75.453-61.167 136.62-136.62 136.62Z"/><path stroke="#C9C9C9" stroke-width="2.418" d="M600.709 736.5c-75.454 0-136.621-61.167-136.621-136.62 0-75.454 61.167-136.621 136.621-136.621 75.453 0 136.62 61.167 136.62 136.621 0 75.453-61.167 136.62-136.62 136.62Z"/></g><path stroke="url(#a)" stroke-width="2.418" d="M0-1.209h553.581" transform="scale(1 -1) rotate(45 1163.11 91.165)"/><path stroke="url(#b)" stroke-width="2.418" d="M404.846 598.671h391.726"/><path stroke="url(#c)" stroke-width="2.418" d="M599.5 795.742V404.017"/><path stroke="url(#d)" stroke-width="2.418" d="m795.717 796.597-391.441-391.44"/><path fill="#fff" d="M600.709 656.704c-31.384 0-56.825-25.441-56.825-56.824 0-31.384 25.441-56.825 56.825-56.825 31.383 0 56.824 25.441 56.824 56.825 0 31.383-25.441 56.824-56.824 56.824Z"/><g clip-path="url(#e)"><path fill="#666" fill-rule="evenodd" d="M616.426 586.58h-31.434v16.176l3.553-3.554.531-.531h9.068l.074-.074 8.463-8.463h2.565l7.18 7.181V586.58Zm-15.715 14.654 3.698 3.699 1.283 1.282-2.565 2.565-1.282-1.283-5.2-5.199h-6.066l-5.514 5.514-.073.073v2.876a2.418 2.418 0 0 0 2.418 2.418h26.598a2.418 2.418 0 0 0 2.418-2.418v-8.317l-8.463-8.463-7.181 7.181-.071.072Zm-19.347 5.442v4.085a6.045 6.045 0 0 0 6.046 6.045h26.598a6.044 6.044 0 0 0 6.045-6.045v-7.108l1.356-1.355-1.282-1.283-.074-.073v-17.989h-38.689v23.43l-.146.146.146.147Z" clip-rule="evenodd"/></g><path stroke="#C9C9C9" stroke-width="2.418" d="M600.709 656.704c-31.384 0-56.825-25.441-56.825-56.824 0-31.384 25.441-56.825 56.825-56.825 31.383 0 56.824 25.441 56.824 56.825 0 31.383-25.441 56.824-56.824 56.824Z"/></g><defs><linearGradient id="a" x1="554.061" x2="-.48" y1=".083" y2=".087" gradientUnits="userSpaceOnUse"><stop stop-color="#C9C9C9" stop-opacity="0"/><stop offset=".208" stop-color="#C9C9C9"/><stop offset=".792" stop-color="#C9C9C9"/><stop offset="1" stop-color="#C9C9C9" stop-opacity="0"/></linearGradient><linearGradient id="b" x1="796.912" x2="404.507" y1="599.963" y2="599.965" gradientUnits="userSpaceOnUse"><stop stop-color="#C9C9C9" stop-opacity="0"/><stop offset=".208" stop-color="#C9C9C9"/><stop offset=".792" stop-color="#C9C9C9"/><stop offset="1" stop-color="#C9C9C9" stop-opacity="0"/></linearGradient><linearGradient id="c" x1="600.792" x2="600.794" y1="403.677" y2="796.082" gradientUnits="userSpaceOnUse"><stop stop-color="#C9C9C9" stop-opacity="0"/><stop offset=".208" stop-color="#C9C9C9"/><stop offset=".792" stop-color="#C9C9C9"/><stop offset="1" stop-color="#C9C9C9" stop-opacity="0"/></linearGradient><linearGradient id="d" x1="404.85" x2="796.972" y1="403.903" y2="796.02" gradientUnits="userSpaceOnUse"><stop stop-color="#C9C9C9" stop-opacity="0"/><stop offset=".208" stop-color="#C9C9C9"/><stop offset=".792" stop-color="#C9C9C9"/><stop offset="1" stop-color="#C9C9C9" stop-opacity="0"/></linearGradient><clipPath id="e"><path fill="#fff" d="M581.364 580.535h38.689v38.689h-38.689z"/></clipPath></defs></svg>

content_studio/static/content_studio/locales/en/translation.json

@@ -0,0 +1,85 @@
+{
+  "common": {
+    "search": "Search",
+    "save": "Save",
+    "create": "Create",
+    "cancel": "Cancel",
+    "general": "General",
+    "delete": "Delete",
+    "deleting": "Deleting...",
+    "deleted": "Deleted",
+    "edit": "Edit",
+    "continue": "Continue",
+    "delete_confirm_title": "Are you sure?",
+    "delete_confirm_description": "This action cannot be undone. Are you sure you want to delete?"
+  },
+  "app": {
+    "copied_to_clipboard": "Copied to clipboard!"
+  },
+  "login": {
+    "title": "Welcome back",
+    "subtitle": "Sign in to your account",
+    "submit": "Sign in",
+    "email_placeholder": "Enter your email",
+    "username_placeholder": "Enter your username",
+    "password_placeholder": "Enter your password",
+    "remember_me": "Remember me",
+    "forgot_password": "Forgot password?",
+    "no_account": "Don't have an account? Contact your administrator"
+  },
+  "main_menu": {
+    "dashboard": "Dashboard",
+    "media_library": "Media library",
+    "settings": "Settings",
+    "log_out": "Log out"
+  },
+  "editor": {
+    "title_create": "Create {{modelName}}",
+    "title_edit": "Edit {{modelName}}",
+    "last_edited": "Last edited",
+    "unsaved_alert": "There are unsaved changes. Are you sure you want to leave?"
+  },
+  "media-library": {
+    "title": "Media library",
+    "description": "Manage your media files here.",
+    "new_folder": "New folder",
+     "file_types": {
+      "file": "File",
+      "image": "Image",
+      "video": "Video",
+      "audio": "Audio"
+    }
+  },
+  "widgets": {
+     "rich_text_widget": {
+        "heading1": "Heading 1",
+        "heading2": "Heading 2",
+        "heading3": "Heading 3",
+        "heading4": "Heading 4",
+        "heading5": "Heading 5",
+        "heading6": "Heading 6",
+        "paragraph": "Paragraph",
+        "blockquote": "Blockquote",
+        "codeBlock": "Code block",
+        "set_link": "Add link",
+        "update_link": "Edit link",
+        "remove_link": "Remove link"
+     },
+    "media_widget": {
+      "select_media": "Select media",
+      "dialog_title": "Select media",
+      "upload_label": "Upload media"
+    },
+    "date_picker": {
+      "placeholder": "Select a date"
+    }
+  },
+    "dashboard": {
+    "widgets": {
+      "activity_log": {
+        "title": "Activity log",
+        "subtitle": "Latest updates from your team"
+      }
+    }
+  }
+}

content_studio/static/content_studio/locales/nl/translation.json

@@ -0,0 +1,90 @@
+{
+  "common": {
+    "search": "Zoeken",
+    "save": "Opslaan",
+    "create": "Maak aan",
+    "cancel": "Annuleren",
+    "general": "Algemeen",
+    "delete": "Verwijderen",
+    "deleting": "Verwijderen...",
+    "deleted": "Verwijderd",
+    "edit": "Bewerken",
+    "continue": "Doorgaan",
+    "delete_confirm_title": "Weet je het zeker?",
+    "delete_confirm_description": "Deze actie kan niet ongedaan gemaakt worden. Weet je zeker dat je dit wilt verwijderen?"
+  },
+  "app": {
+    "copied_to_clipboard": "Gekopieerd naar klembord"
+  },
+  "login": {
+    "title": "Welkom terug",
+    "subtitle": "Log in op je account",
+    "submit": "Inloggen",
+    "email_placeholder": "Voer je e-mailadres in",
+    "username_placeholder": "Voer je gebruikersnaam in",
+    "password_placeholder": "Voer je wachtwoord in",
+    "remember_me": "Onthoud mij",
+    "forgot_password": "Wachtwoord vergeten?",
+    "no_account": "Geen account? Neem contact op met je administrator."
+  },
+  "main_menu": {
+    "dashboard": "Dashboard",
+    "media_library": "Mediabibliotheek",
+    "settings": "Instellingen",
+    "log_out": "Uitloggen"
+  },
+  "editor": {
+    "title_create": "Maak {{modelName}} aan",
+    "title_edit": "Bewerk {{modelName}}",
+    "last_edited": "Laatst bewerkt",
+    "unsaved_alert": "Je hebt niet-opgeslagen wijzigen. Weet je zeker dat je weg wilt gaan?"
+  },
+  "media-library": {
+    "title": "Mediabibliotheek",
+    "description": "Beheer je media-bestanden hier.",
+    "new_folder": "Nieuwe map",
+    "file_types": {
+      "file": "Bestand",
+      "image": "Afbeelding",
+      "video": "Video",
+      "audio": "Audio"
+    }
+  },
+  "widgets": {
+    "rich_text_widget": {
+        "heading1": "Kop 1",
+        "heading2": "Kop 2",
+        "heading3": "Kop 3",
+        "heading4": "Kop 4",
+        "heading5": "Kop 5",
+        "heading6": "Kop 6",
+        "paragraph": "Paragraaf",
+        "blockquote": "Citaat",
+        "codeBlock": "Codeblok",
+        "set_link": "Voeg link toe",
+        "update_link": "Bewerk link",
+        "remove_link": "Verwijder link"
+    },
+    "media_widget": {
+      "select_media": "Selecteer media",
+      "dialog_title": "Selecteer media",
+      "upload_label": "Upload media"
+    },
+     "date_picker": {
+      "placeholder": "Selecteer een datum"
+    }
+  },
+  "dashboard": {
+    "widgets": {
+      "activity_log": {
+        "title": "Activiteitenlogboek",
+        "subtitle": "Recente updates van je team",
+        "action_flags": {
+          "1": "voegde toe",
+          "2": "bewerkte",
+          "3": "verwijderde"
+        }
+      }
+    }
+  }
+}

content_studio/static/content_studio/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

content_studio/templates/content_studio/index.html

@@ -0,0 +1,24 @@
+{% load static %}
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="icon" href={% static 'content_studio/icon.png' %}>
+    <title>Django Content Studio</title>
+    <script>
+        window.DCS_STATIC_PREFIX = "{% static '' %}content_studio/";
+        window.DCS_BASENAME = "{% url 'content_studio_web' %}";
+    </script>
+  <script type="module" crossorigin src="{% static 'content_studio/assets/index.js' %}"></script>
+  <link rel="stylesheet" crossorigin href="{% static 'content_studio/assets/index.css' %}">
+  <link rel="stylesheet" crossorigin href="{% static 'content_studio/icons/pi/style.css' %}">
+
+  <link rel="preconnect" href="https://fonts.googleapis.com">
+  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+  <link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&family=DM+Serif+Text:ital@0;1&family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Montserrat:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">
+</head>
+<body>
+    <div id="root"></div>
+</body>
+</html>

content_studio/token_backends/__init__.py

@@ -0,0 +1,39 @@
+from django.core.exceptions import ImproperlyConfigured
+
+from .jwt import SimpleJwtBackend
+from ..router import content_studio_router
+
+
+class TokenBackendManager:
+    """
+    Manages different token authentication backends for use by
+    Content Studio.
+
+    While login backends are used to identify a user,
+    token backends determine are used to authenticate
+    communication between Content Studio and the admin API.
+    """
+
+    available_backends = [SimpleJwtBackend]
+    _active_backend = None
+
+    @property
+    def active_backend(self):
+        if self._active_backend:
+            return self._active_backend
+
+        for backend in self.available_backends:
+            if backend.is_available:
+                self._active_backend = backend
+                return backend
+
+        raise ImproperlyConfigured(
+            "You need to install at least one of the support authentication backends."
+        )
+
+    def set_up_router(self):
+        content_studio_router.register(
+            f"api/tokens/{self.active_backend.__name__.lower().replace('backend', '')}",
+            self.active_backend.view_set,
+            basename="content_studio_token_backend",
+        )

content_studio/token_backends/jwt.py

@@ -0,0 +1,56 @@
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from rest_framework.viewsets import ViewSet
+from rest_framework_simplejwt.authentication import JWTAuthentication
+from rest_framework_simplejwt.settings import api_settings as simplejwt_settings
+from rest_framework_simplejwt.tokens import RefreshToken
+from rest_framework_simplejwt.views import TokenRefreshView
+
+
+class SimpleJwtViewSet(ViewSet):
+    @action(
+        detail=False, methods=["post"], permission_classes=[], authentication_classes=[]
+    )
+    def refresh(self, request):
+
+        view_instance = TokenRefreshView()
+        view_instance.request = request
+        view_instance.format_kwarg = None
+        return view_instance.post(request)
+
+
+class SimpleJwtBackend:
+    name = "Simple JWT"
+    authentication_class = JWTAuthentication
+    view_set = SimpleJwtViewSet
+
+    @classmethod
+    def get_info(cls):
+
+        return {
+            "type": cls.__name__,
+            "config": {
+                "ACCESS_TOKEN_LIFETIME": simplejwt_settings.ACCESS_TOKEN_LIFETIME.total_seconds(),
+            },
+        }
+
+    @property
+    def is_available(self) -> bool:
+        try:
+            import rest_framework_simplejwt
+
+            return True
+        except ImportError:
+            return False
+
+    @classmethod
+    def get_response_for_user(cls, user):
+
+        refresh = RefreshToken.for_user(user)
+
+        return Response(
+            {
+                "refresh": str(refresh),
+                "access": str(refresh.access_token),
+            }
+        )

content_studio/urls.py

@@ -0,0 +1,21 @@
+from django.urls import re_path
+
+from .media_library.viewsets import MediaLibraryViewSet, MediaFolderViewSet
+from .router import content_studio_router
+from .views import ContentStudioWebAppView, AdminApiViewSet
+
+content_studio_router.register("api", AdminApiViewSet, "content_studio_admin")
+content_studio_router.register(
+    "api/media-library/items", MediaLibraryViewSet, "content_studio_media_library_items"
+)
+content_studio_router.register(
+    "api/media-library/folders",
+    MediaFolderViewSet,
+    "content_studio_media_library_folders",
+)
+
+urlpatterns = [
+    re_path(
+        "^(?!api).*$", ContentStudioWebAppView.as_view(), name="content_studio_web"
+    ),
+] + content_studio_router.urls

content_studio/utils.py

@@ -0,0 +1,62 @@
+import json
+import sys
+
+from rich.console import Console
+
+console = Console()
+
+
+def log(*args, **kwargs):
+    console.print(*args, **kwargs)
+
+
+def flatten(xss):
+    return [x for xs in xss for x in xs]
+
+
+def is_runserver():
+    """
+    Checks if the Django application is started as a server.
+    We'll also assume it started if manage.py is not used (e.g. when Django is started using wsgi/asgi).
+    The main purpose of this check is to not run certain code on other management commands such
+    as `migrate`.
+    """
+    is_manage_cmd = sys.argv[0].endswith("/manage.py")
+
+    return not is_manage_cmd or sys.argv[1] == "runserver"
+
+
+def is_jsonable(x):
+    try:
+        json.dumps(x)
+        return True
+    except (TypeError, OverflowError):
+        return False
+
+
+def get_related_field_name(inline, parent_model):
+    """
+    Get the name of the foreign key field in the inline model.
+    """
+    if inline.fk_name:
+        return inline.fk_name
+
+    # Let Django figure it out
+
+    opts = inline.model._meta
+
+    # Find all foreign keys pointing to parent model
+    fks = [
+        f
+        for f in opts.get_fields()
+        if f.many_to_one and f.remote_field.model == parent_model
+    ]
+
+    if len(fks) == 1:
+        return fks[0].name
+    elif len(fks) == 0:
+        raise ValueError(
+            f"No foreign key found in {inline.model} pointing to {parent_model}"
+        )
+    else:
+        raise ValueError(f"Multiple foreign keys found. Specify fk_name on the inline.")

content_studio/views.py

@@ -0,0 +1,181 @@
+from django.conf import settings
+from django.contrib import admin
+from django.urls import reverse, NoReverseMatch
+from django.utils.translation import gettext_lazy as _
+from django.views.generic import TemplateView
+from rest_framework.decorators import action
+from rest_framework.permissions import IsAdminUser, AllowAny
+from rest_framework.renderers import JSONRenderer
+from rest_framework.response import Response
+from rest_framework.viewsets import ViewSet
+
+from . import __version__
+from .admin import AdminSerializer, ModelGroup
+from .models import ModelSerializer
+from .serializers import SessionUserSerializer
+from .settings import cs_settings
+
+
+class ContentStudioWebAppView(TemplateView):
+    """
+    View for rendering the content studio web app.
+    """
+
+    template_name = "content_studio/index.html"
+
+
+class AdminApiViewSet(ViewSet):
+    """
+    View set for content studio admin endpoints.
+    """
+
+    permission_classes = [IsAdminUser]
+    renderer_classes = [JSONRenderer]
+
+    @action(
+        methods=["get"],
+        detail=False,
+        url_path="info",
+        permission_classes=[AllowAny],
+    )
+    def info(self, request):
+        """
+        Returns public information about the Content Studio admin.
+        """
+        admin_site = cs_settings.ADMIN_SITE
+
+        data = {
+            "version": __version__,
+            "site_header": admin_site.site_header,
+            "site_title": admin_site.site_title,
+            "index_title": admin_site.index_title,
+            "site_url": admin_site.site_url,
+            "health_check": get_health_check_path(),
+            "login_backends": [
+                backend.get_info()
+                for backend in admin_site.login_backend.active_backends
+            ],
+            "token_backend": admin_site.token_backend.active_backend.get_info(),
+            "formats": {
+                model_class.__name__: frmt.serialize()
+                for model_class, frmt in admin_site.default_format_mapping.items()
+            },
+            "widgets": get_widgets(),
+            "settings": {
+                "created_by_attr": cs_settings.CREATED_BY_ATTR,
+                "created_at_attr": cs_settings.CREATED_AT_ATTR,
+                "edited_by_attr": cs_settings.EDITED_BY_ATTR,
+                "edited_at_attr": cs_settings.EDITED_AT_ATTR,
+            },
+        }
+
+        return Response(data=data)
+
+    @action(
+        methods=["get"],
+        detail=False,
+        url_path="discover",
+    )
+    def discover(
+        self,
+        request,
+    ):
+        """
+        Returns information about the Django app (models, admin models, admin site, settings, etc.).
+        """
+        admin_site = cs_settings.ADMIN_SITE
+        data = {
+            "models": get_models(request),
+            "model_groups": get_model_groups(),
+            "user_model": settings.AUTH_USER_MODEL,
+        }
+
+        media_model = cs_settings.MEDIA_LIBRARY_MODEL
+        folder_model = cs_settings.MEDIA_LIBRARY_FOLDER_MODEL
+
+        data["media_library"] = {
+            "enabled": media_model is not None,
+            "folders": folder_model is not None,
+            "models": {
+                "media_model": media_model._meta.label_lower,
+                "folder_model": folder_model._meta.label_lower,
+            },
+        }
+
+        if admin_site.dashboard:
+            data["dashboard"] = admin_site.dashboard.serialize()
+        else:
+            data["dashboard"] = {"widgets": []}
+
+        return Response(data=data)
+
+    @action(methods=["get"], detail=False, url_path="me")
+    def me(self, request):
+        """
+        Returns information about the current user.
+        """
+        return Response(SessionUserSerializer(request.user).data)
+
+
+def get_models(request):
+    models = []
+    registered_models = admin.site._registry
+
+    for model, admin_class in registered_models.items():
+        models.append(
+            {
+                **ModelSerializer(model).serialize(),
+                "admin": AdminSerializer(admin_class).serialize(request),
+            }
+        )
+        for inline in admin_class.inlines:
+            if inline.model not in registered_models:
+                models.append(
+                    {
+                        **ModelSerializer(inline.model).serialize(),
+                    }
+                )
+
+    return models
+
+
+def get_model_groups():
+    admin_site = cs_settings.ADMIN_SITE
+
+    default_group = [
+        ModelGroup(
+            label=_("Content"),
+            name="default",
+            icon=None,
+            models=[model for model, admin_model in admin.site._registry.items()],
+        )
+    ]
+    # Get custom model groups or use the default one
+    model_groups = getattr(admin_site, "model_groups", None) or default_group
+
+    return [
+        {
+            "name": group.name,
+            "icon": group.icon,
+            "color": group.color,
+            "label": group.label,
+            "models": [m._meta.label_lower for m in group.models],
+        }
+        for group in model_groups
+    ]
+
+
+def get_widgets():
+    admin_site = cs_settings.ADMIN_SITE
+
+    return {
+        (m if isinstance(m, str) else m.__name__): widget.serialize()
+        for m, widget in admin_site.default_widget_mapping.items()
+    }
+
+
+def get_health_check_path():
+    try:
+        return reverse("healthcheck")
+    except NoReverseMatch:
+        return None