Feature/ogc 2880 use predicate registry

src/onegov/core/framework.py

@@ -37,6 +37,7 @@
 from functools import cached_property, wraps
 from itsdangerous import BadSignature, Signer
 from libres.db.models import ORMBase
+from morepath import dispatch_method
 from morepath.publish import resolve_model, get_view_name
 from more.content_security import ContentSecurityApp
 from more.content_security import ContentSecurityPolicy
@@ -46,6 +47,8 @@
 from more.webassets import WebassetsApp
 from more.webassets.core import webassets_injector_tween
 from more.webassets.tweens import METHODS, CONTENT_TYPES
+from reg import ClassIndex
+
 from onegov.core import cache, log, utils
 from onegov.core import directives
 from onegov.core.crypto import stored_random_token
@@ -68,6 +71,7 @@
 
 
 from typing import overload, Any, Literal, TypeVar, TYPE_CHECKING
+
 if TYPE_CHECKING:
     from _typeshed import StrPath
     from _typeshed.wsgi import WSGIApplication, WSGIEnvironment, StartResponse
@@ -1552,6 +1556,18 @@
             self.hashed_identity_key
         ).decrypt(cyphertext).decode('utf-8')
 
+    @dispatch_method('model')
+    def get_layout_class(self, model: object) -> type | None:
+        return None
+
+
+@Framework.predicate(Framework.get_layout_class, name='model', default=None, index=ClassIndex)
+def model_predicate(self, model: object) -> type:
+    # return model if isinstance(model, type) else model.__class__
+    retval = model if isinstance(model, type) else model.__class__
+    print('*** tschupre model predicate called for object:', model, 'retval:', retval)
+    return retval
+
 
 @Framework.webasset_url()
 def get_webasset_url() -> str:

src/onegov/org/app.py

@@ -12,7 +12,7 @@
 from more.content_security import NONE
 from more.content_security.core import content_security_policy_tween_factory
 from onegov.core import Framework, utils
-from onegov.core.framework import default_content_security_policy
+from onegov.core.framework import default_content_security_policy, model_predicate
 from onegov.core.i18n import default_locale_negotiator
 from onegov.core.orm.cache import orm_cached, request_cached
 from onegov.core.templates import PageTemplate, render_template
@@ -24,6 +24,7 @@
 from onegov.org.auth import MTANAuth
 from onegov.org.exceptions import MTANAccessLimitExceeded
 from onegov.org.initial_content import create_new_organisation
+from onegov.org.layout import Layout, DefaultLayout
 from onegov.org.models import Dashboard, Organisation, PublicationCollection
 from onegov.org.request import OrgRequest
 from onegov.org.theme import OrgTheme
@@ -69,7 +70,6 @@
     event_search_widget = directive(directives.EventSearchWidgetAction)
     settings_view = directive(directives.SettingsView)
     boardlet = directive(directives.Boardlet)
-    layout = directive(directives.Layout)
 
     #: cronjob settings
     send_ticket_statistics = True
@@ -492,6 +492,12 @@
         return URL(request.link(dashboard)).path()
 
 
+@OrgApp.predicate_fallback(OrgApp.get_layout_class, model_predicate)
+def model_not_found(self, model: object) -> type[Layout]:
+    print('*** tschupre using DEFAULTLAYOUT ORG for model', model)
+    return DefaultLayout
+
+
 @OrgApp.webasset_path()
 def get_shared_assets_path() -> str:
     return utils.module_path('onegov.shared', 'assets/js')

src/onegov/org/directives.py

@@ -293,30 +293,3 @@ def perform(  # type:ignore[override]
             'order': self.order,
             'icon': self.icon,
         }
-
-
-class Layout(Action):
-    """
-    Registers a layout for a model. This is used to show breadcrumbs
-    for search results.
-    """
-
-    config = {
-        'layout_registry': dict
-    }
-
-    def __init__(self, model: type) -> None:
-        self.model = model
-
-    def identifier(  # type:ignore[override]
-        self,
-        layout_registry: dict[type, Layout]
-    ) -> str:
-        return str(self.model)
-
-    def perform(  # type:ignore[override]
-        self,
-        layout: Layout,
-        layout_registry: dict[type, Layout]
-    ) -> None:
-        layout_registry[self.model] = layout

src/onegov/org/request.py

@@ -289,16 +289,6 @@ def get_layout(self, model: object) -> Layout | DefaultLayout:
         """
         Get the registered layout for a model instance.
         """
-        layout_registry = self.app.config.layout_registry
-        model_type = model if isinstance(model, type) else type(model)
-
-        layout_class = None
-        for cls in model_type.mro():
-            layout_class = layout_registry.get(cls)
-            if layout_class:
-                break
-
-        if layout_class is None:
-            layout_class = DefaultLayout
-
+        layout_class = self.app.get_layout_class(model)
+        assert layout_class is not None
         return layout_class(model, self)

src/onegov/town6/app.py

@@ -6,7 +6,8 @@
 from sedate import replace_timezone
 
 from onegov.api import ApiApp
-from onegov.core import utils
+from onegov.core import utils, Framework
+from onegov.core.framework import model_predicate
 from onegov.core.i18n import default_locale_negotiator
 from onegov.core.templates import render_template
 from onegov.core.utils import module_path
@@ -30,6 +31,7 @@
     from onegov.core.types import RenderData
     from onegov.org.exceptions import MTANAccessLimitExceeded
     from onegov.org.models import Organisation
+    from onegov.town6.layout import Layout, DefaultLayout
     from onegov.town6.request import TownRequest
 
 
@@ -76,6 +78,13 @@
         return False
 
 
+@TownApp.predicate_fallback(TownApp.get_layout_class, model_predicate)
+def model_not_found(self, model: object) -> type[Layout]:
+    print('*** tschupre using DEFAULTLAYOUT TOWN6 for model', model)
+    from onegov.town6.layout import DefaultLayout
+    return DefaultLayout
+
+
 @TownApp.webasset_path()
 def get_shared_assets_path() -> str:
     return utils.module_path('onegov.shared', 'assets/js')

src/onegov/town6/layout.py

@@ -3,12 +3,13 @@
 import secrets
 from functools import cached_property
 
+from onegov.core import Framework
 from onegov.core.elements import Confirm, Intercooler, Link, LinkGroup
 from onegov.core.static import StaticFile
 from onegov.core.utils import append_query_param, to_html_ul
 from onegov.chat.collections import ChatCollection
 from onegov.chat.models import Chat
 from onegov.directory import DirectoryCollection, DirectoryEntry, Directory
 from onegov.event import Event
 from onegov.event import OccurrenceCollection, Occurrence
 from onegov.org.elements import QrCodeLink, IFrameLink
@@ -288,7 +289,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=Topic)
 class PageLayout(OrgTopicLayout, AdjacencyListLayout):
 
     app: TownApp
@@ -301,7 +301,6 @@
         )
 
 
-@TownApp.layout(model=News)
 class NewsLayout(OrgNewsLayout, AdjacencyListLayout):
 
     app: TownApp
@@ -416,7 +415,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=FormDefinition)
 class FormDefinitionLayout(OrgFormDefinitionLayout, DefaultLayout):
 
     app: TownApp
@@ -442,7 +440,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=Person)
 class PersonLayout(OrgPersonLayout, DefaultLayout):
 
     app: TownApp
@@ -461,7 +458,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=Ticket)
 class TicketLayout(OrgTicketLayout, DefaultLayout):
 
     app: TownApp
@@ -574,7 +570,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=Resource)
 class ResourceLayout(OrgResourceLayout, DefaultLayout):
 
     app: TownApp
@@ -655,7 +650,6 @@
         return links
 
 
-@TownApp.layout(model=Occurrence)
 class OccurrenceLayout(OrgOccurrenceLayout, DefaultLayout):
 
     app: TownApp
@@ -686,7 +680,6 @@
     cls_before='EventLayout',
     cls_after='TicketChatMessageLayout'
 )
-@TownApp.layout(model=Event)
 class EventLayout(StepsLayoutExtension, OrgEventLayout, DefaultLayout):
 
     app: TownApp
@@ -727,7 +720,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=ImageSet)
 class ImageSetLayout(OrgImageSetLayout, DefaultLayout):
 
     app: TownApp
@@ -740,7 +732,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=User)
 class UserLayout(OrgUserLayout, DefaultLayout):
 
     app: TownApp
@@ -798,7 +789,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=Directory)
 class DirectoryLayout(OrgDirectoryLayout, DefaultLayout):
 
     app: TownApp
@@ -932,7 +922,6 @@
 
 
 @step_sequences.registered_step(1, _('Form'), cls_after='FormSubmissionLayout')
-@TownApp.layout(model=DirectoryEntry)
 class DirectoryEntryLayout(
     StepsLayoutExtension,
     OrgDirectoryEntryLayout,
@@ -968,7 +957,6 @@
     request: TownRequest
 
 
-@TownApp.layout(model=GeneralFile)
 class GeneralFileCollectionLayout(DefaultLayout):
 
     def __init__(self, model: Any, request: TownRequest) -> None:
@@ -1146,7 +1134,6 @@
         return None
 
 
-@TownApp.layout(model=Meeting)
 class MeetingLayout(DefaultLayout):
 
     @cached_property
@@ -1216,7 +1203,6 @@
         return None
 
 
-@TownApp.layout(model=MeetingItem)
 class MeetingItemLayout(DefaultLayout):
 
     @cached_property
@@ -1275,7 +1261,6 @@
         return None
 
 
-@TownApp.layout(model=RISParliamentarian)
 class RISParliamentarianLayout(DefaultLayout):
 
     @cached_property
@@ -1457,7 +1442,6 @@
         return None
 
 
-@TownApp.layout(model=RISParliamentaryGroup)
 class RISParliamentaryGroupLayout(DefaultLayout):
 
     @cached_property
@@ -1593,7 +1577,6 @@
         return None
 
 
-@TownApp.layout(model=RISCommission)
 class RISCommissionLayout(DefaultLayout):
 
     @cached_property
@@ -1686,7 +1669,21 @@
         return None
 
 
-@TownApp.layout(model=PoliticalBusiness)
+def register_layout_for(model):
+    def decorator(cls):
+        @TownApp.get_layout_class.register(model=model)
+        def _factory(self, model: object):
+            print(f'*** tschupre matched! Returning {cls.__name} for {model}')
+            return cls
+
+        # Debug: verify registration happened
+        print(f'*** tschupre registered {cls.__name__} for {model}')
+
+        return cls
+    return decorator
+
+
+@register_layout_for(PoliticalBusiness)
 class PoliticalBusinessLayout(DefaultLayout):
 
     @cached_property