Search: Add breadcrumbs to search results in order to provide more context

src/onegov/core/directives.py

@@ -2,13 +2,16 @@
 
 import os.path
 
-from dectate import Action, Query
+from dectate import Action, Query, convert_dotted_name  # type:ignore[attr-defined]
 from itertools import count
 from morepath.directive import HtmlAction
+from morepath.directive import isbaseclass
+from morepath.directive import PredicateAction
+from morepath.directive import PredicateFallbackAction
 from morepath.directive import SettingAction
 from morepath.settings import SettingRegistry, SettingSection
-from onegov.core.utils import Bunch
 
+from onegov.core.utils import Bunch
 
 from typing import Any, ClassVar, TYPE_CHECKING
 if TYPE_CHECKING:
@@ -18,7 +21,9 @@
     from wtforms import Form
 
     from .analytics import AnalyticsProvider
-    from .request import CoreRequest
+    from onegov.core import Framework
+    from onegov.core.layout import Layout as CoreLayout
+    from onegov.core.request import CoreRequest
 
 
 class HtmlHandleFormAction(HtmlAction):
@@ -383,3 +388,36 @@ class ReplaceSettingAction(SettingAction):
     """
 
     depends = [ReplaceSettingSectionAction]
+
+
+class Layout(Action):
+    """
+    Registers a layout for a model. This is used to show breadcrumbs
+    for search results.
+    """
+
+    app_class_arg = True
+    depends = [PredicateFallbackAction, PredicateAction]
+    filter_convert = {'model': convert_dotted_name}
+    filter_compare = {'model': isbaseclass}
+
+    def __init__(self, model: type) -> None:
+        self.model = model
+
+    def identifier(  # type:ignore[override]
+        self,
+        app_class: type[Framework]
+    ) -> str:
+        return str(self.model)
+
+    def perform(  # type:ignore[override]
+        self,
+        obj: type[CoreLayout],
+        app_class: type[Framework]
+    ) -> None:
+
+        layout_class = obj
+        # `lambda self, obj, request` is required to match the signature
+        app_class.get_layout.register(  # type:ignore[attr-defined]
+            lambda self, obj, request: layout_class(obj, request),
+            model=self.model)

src/onegov/core/framework.py

@@ -37,6 +37,7 @@ class MyApplication(Framework):
 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 @@ class MyApplication(Framework):
 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 @@ class MyApplication(Framework):
 
 
 from typing import overload, Any, Literal, TypeVar, TYPE_CHECKING
+
 if TYPE_CHECKING:
     from _typeshed import StrPath
     from _typeshed.wsgi import WSGIApplication, WSGIEnvironment, StartResponse
@@ -83,6 +87,7 @@ class MyApplication(Framework):
     from webob import Response
 
     from .analytics import AnalyticsProvider
+    from .layout import Layout
     from .mail import Attachment
     from .metadata import Metadata
     from .security.permissions import Intent
@@ -129,6 +134,7 @@ class Framework(
     template_variables = directive(directives.TemplateVariablesAction)
     replace_setting = directive(directives.ReplaceSettingAction)
     replace_setting_section = directive(directives.ReplaceSettingSectionAction)
+    layout = directive(directives.Layout)
 
     #: sets the same-site cookie directive, (may need removal inside iframes)
     same_site_cookie_policy: str | None = 'Lax'
@@ -1552,6 +1558,28 @@ def decrypt(self, cyphertext: bytes) -> str:
             self.hashed_identity_key
         ).decrypt(cyphertext).decode('utf-8')
 
+    @dispatch_method()
+    def get_layout(
+        self,
+        obj: object,
+        request: CoreRequest
+    ) -> Layout | None:
+        return None
+
+
+@Framework.predicate(
+    Framework.get_layout,
+    name='model',
+    default=None,
+    index=ClassIndex
+)
+def layout_predicate(
+    self: type[Framework],
+    obj: object,
+    request: CoreRequest
+) -> type[object]:
+    return obj.__class__
+
 
 @Framework.webasset_url()
 def get_webasset_url() -> str:

src/onegov/org/directives.py

@@ -3,8 +3,8 @@
 from dectate import Action
 from itertools import count
 
-
 from typing import cast, Any, ClassVar, Literal, TYPE_CHECKING
+
 if TYPE_CHECKING:
     from collections.abc import Callable
     from onegov.core.elements import LinkGroup

src/onegov/org/exports/base.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from onegov.org.models import Export
-from onegov.town6 import _
+from onegov.org import _
 
 
 from typing import Any, TYPE_CHECKING