feat: Allow running without templates

django-cms · fsbraun · Jul 29, 2024 · Mar 21, 2024 · Mar 21, 2024 · Mar 21, 2024
commit 700e537234d5d50aad5245a1d925d3fa1b46f204
diff --git a/cms/static/cms/sass/components/_structureboard.scss b/cms/static/cms/sass/components/_structureboard.scss
@@ -360,6 +360,9 @@
             box-shadow: inset 0 0 0 1px $gray-light;
         }
     }
+    .cms-drag-disabled .cms-dragitem:hover {
+        box-shadow: inherit;
+    }
     .cms-dragitem-collapsable {
         @include icon(arrow-wide);
         &:before {

diff --git a/cms/templates/cms/toolbar/structure.html b/cms/templates/cms/toolbar/structure.html
@@ -1,6 +1,6 @@
 {% load cms_tags cms_js_tags i18n sekizai_tags %}
 <!DOCTYPE html>
-<html class="cms-overflow cms-structure-mode-endpoint">
+<html class="cms-overflow{% if not CMS_TEMPLATE %} cms-structure-mode-endpoint{% endif %}">
 <head>
     <meta charset="UTF-8">
     <title>{{ object.title }}</title>

diff --git a/cms/templates/cms/toolbar/toolbar_javascript.html b/cms/templates/cms/toolbar/toolbar_javascript.html
@@ -11,7 +11,7 @@
 CMS._plugins = CMS._plugins || [];
 // this is a global shared configuration
 CMS.config = {
-    'mode': {% if cms_toolbar.edit_mode_active %}'draft'{% else %}'live'{% endif %},
+    'mode': {% if cms_toolbar.edit_mode_active or cms_toolbar.structure_mode_active %}'draft'{% else %}'live'{% endif %},
     'auth': {% if user.is_authenticated %}true{% else %}false{% endif %},
     'debug': {% if debug %}true{% else %}false{% endif %},
     'csrf': '{{ csrf_token }}',

diff --git a/cms/toolbar/toolbar.py b/cms/toolbar/toolbar.py
@@ -104,8 +104,7 @@ def edit_mode_active(self):
 
         if self.structure_mode_active:
             return True
-
-        if self._resolver_match:
+        if self.is_staff and self._resolver_match:
             return self._resolver_match.url_name == 'cms_placeholder_render_object_edit'
         return False
 
@@ -119,9 +118,6 @@ def preview_mode_active(self):
     @cached_property
     def content_mode_active(self):
         """``True`` if content mode is active."""
-        if self.structure_mode_active:
-            # Structure mode always takes precedence
-            return False
         return self.is_staff and not self.edit_mode_active
 
     @cached_property
@@ -412,6 +408,15 @@ def object_is_editable(self, obj=None):
             return True
         return False
 
+    @property
+    def edit_mode_active(self):
+        """``True`` if editing mode is active。"""
+        # Cannot be cached since it changes depending on the object.
+        if self.structure_mode_active:
+            return self.object_is_editable()
+        return super().edit_mode_active
+
+
     # Internal API
 
     def _add_item(self, item, position=None):

diff --git a/cms/utils/check.py b/cms/utils/check.py
@@ -345,6 +345,40 @@ def get_class(method_name, model):
                                    'https://django-cms.readthedocs.io/en/latest/extending_cms/extending_page_title.html#handling-relations.')  # noqa
 
 
+@define_check
+def check_template_conf(output):
+    with output.section("Template configuration") as section:
+        if get_cms_setting("TEMPLATES"):
+            if isinstance(get_cms_setting("TEMPLATES"), (list, tuple)):
+                for template in get_cms_setting("TEMPLATES"):
+                    if not isinstance(template, (list, tuple)):
+                        section.error("CMS_TEMPLATES setting contains a non-list/tuple entry")
+                    elif len(template) != 2:
+                        section.error("CMS_TEMPLATES setting contains a list/tuple with != 2 entries")
+                    elif not isinstance(template[0], str):
+                        section.error("CMS_TEMPLATES contains a non-string entry")
+                    else:
+                        section.success("CMS_TEMPLATES_DIR or CMS_TEMPLATES setting  found")
+            else:
+                section.error("CMS_TEMPLATES setting is not a list or tuple")
+            if hasattr(settings, "CMS_PLACEHOLDERS"):
+                section.warn("CMS_PLACEHOLDERS setting is also present but will be ignored.")
+        elif get_cms_setting("PLACEHOLDERS"):
+            if isinstance(get_cms_setting("PLACEHOLDERS"), (list, tuple)):
+                for placeholder in get_cms_setting("PLACEHOLDERS"):
+                    if not isinstance(placeholder, (list, tuple)):
+                        section.error("CMS_PLACEHOLDERS setting contains a non-list/tuple entry")
+                    elif not isinstance(placeholder[0], str):
+                        section.error("CMS_PLACEHOLDERS contains a non-string entry")
+                    else:
+                        section.success("CMS_PLACEHOLDERS setting entry found - CMS will run in headless mode")
+            else:
+                section.error("CMS_PLACEHOLDERS setting is not a list or tuple")
+        else:
+            section.warn("Both CMS_TEMPLATES and CMS_PLACEHOLDERS settings are missing. "
+                         "Will run in headless mode with one placeholder called \"content\"")
+
+
 def check(output):
     """
     Checks the configuration/environment of this django CMS installation.

diff --git a/cms/utils/conf.py b/cms/utils/conf.py
@@ -47,6 +47,7 @@ def wrapper():
     'DEFAULT_X_FRAME_OPTIONS': constants.X_FRAME_OPTIONS_INHERIT,
     'TOOLBAR_SIMPLE_STRUCTURE_MODE': True,
     'PLACEHOLDER_CONF': {},
+    'PLACEHOLDERS': (('', ('content',)),),
     'PERMISSION': False,
     # Whether to use raw ID lookups for users when PERMISSION is True
     'RAW_ID_USERS': False,
@@ -136,7 +137,7 @@ def get_templates():
         if isinstance(tpldir, dict):
             tpldir = tpldir[settings.SITE_ID]
         # We must extract the relative path of CMS_TEMPLATES_DIR to the nearest
-        # valid templates directory. Here we mimic what the filesystem and
+        # valid templates' directory. Here we mimic what the filesystem and
         # app_directories template loaders do
         prefix = ''
         # Relative to TEMPLATE['DIRS'] for filesystem loader
@@ -168,11 +169,19 @@ def get_templates():
             templates = list((os.path.join(prefix, tpl), tpl) for tpl in os.listdir(tpldir))
     else:
         templates = list(getattr(settings, 'CMS_TEMPLATES', []))
-    if get_cms_setting('TEMPLATE_INHERITANCE'):
+    if get_cms_setting('TEMPLATE_INHERITANCE') and templates:
         templates.append((constants.TEMPLATE_INHERITANCE_MAGIC, _('Inherit the template of the nearest ancestor')))
     return templates
 
 
+def get_placeholders():
+    if getattr(settings, 'CMS_PLACEHOLDERS', False):
+        return settings.CMS_PLACEHOLDERS
+    if getattr(settings, 'CMS_TEMPLATES', False) or getattr(settings, 'CMS_TEMPLATES_DIR', False):
+        return ()
+    return DEFAULTS['PLACEHOLDERS']
+
+
 def _ensure_languages_settings(languages):
     valid_language_keys = ['code', 'name', 'fallbacks', 'hide_untranslated', 'redirect_on_fallback', 'public']
     required_language_keys = ['code', 'name']
@@ -272,6 +281,7 @@ def get_unihandecode_host():
     'MEDIA_URL': get_media_url,
     # complex because not prefixed by CMS_
     'TEMPLATES': get_templates,
+    'PLACEHOLDERS': get_placeholders,
     'LANGUAGES': get_languages,
     'UNIHANDECODE_HOST': get_unihandecode_host,
     'CMS_TOOLBAR_URL__PERSIST': get_toolbar_url__persist,

diff --git a/cms/utils/page.py b/cms/utils/page.py
@@ -18,6 +18,10 @@ def get_page_template_from_request(request):
     templates = get_cms_setting('TEMPLATES')
     template_names = frozenset(pair[0] for pair in templates)
 
+    if not templates:
+        # no templates defined, CMS is running headless
+        return None
+
     if len(templates) == 1:
         # there's only one template
         # avoid any further computation

diff --git a/cms/utils/placeholder.py b/cms/utils/placeholder.py
@@ -407,13 +407,21 @@ def rescan_placeholders_for_obj(obj):
 
 
 def get_declared_placeholders_for_obj(obj):
-    """Returns declared placeholders for an object. The object is supposed to have a method ``get_template``
+    """Returns declared placeholders for an object. The object is supposed to either have a method
+    ``get_placeholder_slots`` which returns the list of placeholders or a method ``get_template``
     which returns the template path as a string that renders the object. ``get_declared_placeholders`` returns
     a list of placeholders used in the template by the ``{% placeholder %}`` template tag.
     """
+    if hasattr(obj, "get_placeholder_slots"):
+        from cms.templatetags.cms_tags import DeclaredPlaceholder
+
+        return [
+            DeclaredPlaceholder(slot=slot, inherit=False) if isinstance(slot, str) else DeclaredPlaceholder(*slot)
+            for slot in obj.get_placeholder_slots()
+        ]
     if not hasattr(obj, "get_template"):
         raise NotImplementedError(
-            "%s should implement get_template" % obj.__class__.__name__
+            "%s should implement either get_placeholders or get_template" % obj.__class__.__name__
         )
     return get_placeholders(obj.get_template())