watolib: pass the page context into WatoMode constructors

WatoMode.__init__ now takes the PageContext alongside the edition and
stores it as self._ctx, making the request's config and request objects
an explicit constructor dependency rather than implicit reads of the
global proxies. The page handler and every mode construction site thread
the context through; modes with custom constructors (key management,
simple config modes, backup, OTel, DCD, ...) forward it to
super().__init__.

The base mode stays generic and does not depend on the folder tree: modes
that need the tree keep building it themselves.

The two Setup search match-item generators that build a mode outside a
page request construct a PageContext from active_config at call time.

CMK-35767
Change-Id: I5950c99c8b213fab8a4d11e3a35c6543d9530d60

Author: LarsMichelsen

cmk/gui/background_job/wato/_modes.py

@@ -202,7 +202,7 @@ def __init__(self, edition: Edition) -> None:
 
     @override
     def handle_page(self, ctx: PageContext) -> None:
-        self.action()
+        self.action(ctx)
         super().handle_page(ctx)
 
     @override
@@ -231,8 +231,8 @@ def _show_details_page(self, job_id: str) -> BackgroundStatusSnapshot | None:
         job_manager.show_job_details_from_snapshot(job_snapshot)
         return job_snapshot
 
-    def action(self) -> None:
-        job_details_page = ModeBackgroundJobDetails(self._edition)
+    def action(self, ctx: PageContext) -> None:
+        job_details_page = ModeBackgroundJobDetails(self._edition, ctx)
         action_handler = ActionHandler(job_details_page.breadcrumb())
         action_handler.handle_actions()
         if action_handler.did_delete_job():

cmk/gui/bi/_config.py

@@ -219,8 +219,8 @@ def is_show_more(self) -> bool:
 
 
 class ABCBIMode(WatoMode):
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._bi_packs = get_cached_bi_packs()
         self._bi_pack = None
 
@@ -508,8 +508,8 @@ def _vs_pack(self) -> Dictionary:
 
 
 class ModeBIPacks(ABCBIMode):
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._contact_group_names = load_contact_group_information()
 
     @classmethod
@@ -727,8 +727,8 @@ def mode_url(cls, **kwargs: str) -> str: ...
     def mode_url(cls, **kwargs: str) -> str:
         return super().mode_url(**kwargs)
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._view_type = request.var("view", "list")
 
     @classmethod
@@ -1226,8 +1226,8 @@ def name(cls) -> str:
     def static_permissions() -> Collection[PermissionName]:
         return ["bi_rules"]
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._rule_id = request.get_str_input("id")
         self._new = self._rule_id is None
 
@@ -1828,8 +1828,8 @@ def name(cls) -> str:
     def static_permissions() -> Collection[PermissionName]:
         return ["bi_rules"]
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         aggr_id = request.get_str_input_mandatory("id", "")
         clone_id = request.get_str_input_mandatory("clone", "")
         self._new = False
@@ -2598,8 +2598,8 @@ def static_permissions() -> Collection[PermissionName]:
     def parent_mode(cls) -> type[WatoMode] | None:
         return ModeBIPacks
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._rule_id = request.get_str_input_mandatory("id")
         if not (rule_tree_bi_pack := self._bi_packs.get_pack_of_rule(self._rule_id)):
             raise MKUserError("id", _("This BI rule does not exist"))

cmk/gui/key_mgmt.py

@@ -31,6 +31,7 @@
     PageMenuEntry,
     PageMenuTopic,
 )
+from cmk.gui.pages import PageContext
 from cmk.gui.table import table_element
 from cmk.gui.type_defs import ActionResult, IconNames, StaticIcon
 from cmk.gui.utils.csrf_token import check_csrf_token
@@ -55,8 +56,8 @@ class ModeKeyManagement(WatoMode[object]):
     upload_mode = "upload_key"
     download_mode = "download_key"
 
-    def __init__(self, edition: Edition, key_store: KeypairStore) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext, key_store: KeypairStore) -> None:
+        super().__init__(edition, ctx)
         self.key_store = key_store
 
     @override
@@ -206,8 +207,8 @@ def page(self, config: Config) -> None:
 class ModeEditKey(WatoMode[object]):
     back_mode: str
 
-    def __init__(self, edition: Edition, key_store: KeypairStore) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext, key_store: KeypairStore) -> None:
+        super().__init__(edition, ctx)
         self._minlen = 12
         self.key_store = key_store
 
@@ -309,8 +310,8 @@ def _passphrase_help(self) -> str:
 class ModeUploadKey(WatoMode[object]):
     back_mode: str
 
-    def __init__(self, edition: Edition, key_store: KeypairStore) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext, key_store: KeypairStore) -> None:
+        super().__init__(edition, ctx)
         self.key_store = key_store
 
     @override
@@ -479,8 +480,8 @@ def _passphrase_help(self) -> str:
 class ModeDownloadKey(WatoMode[object]):
     back_mode: str
 
-    def __init__(self, edition: Edition, key_store: KeypairStore) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext, key_store: KeypairStore) -> None:
+        super().__init__(edition, ctx)
         self.key_store = key_store
 
     @override

cmk/gui/mkeventd/wato.py

@@ -62,6 +62,7 @@
     PageMenuSearch,
     PageMenuTopic,
 )
+from cmk.gui.pages import PageContext
 from cmk.gui.permissions import Permission, PermissionRegistry
 from cmk.gui.rule_specs.legacy_converter import convert_dictionary_formspec_to_valuespec
 from cmk.gui.search.matchers import (
@@ -305,7 +306,9 @@ def register(
         MatchItemGeneratorSettings(
             "event_console_settings",
             _("Event Console settings"),
-            lambda: ModeEventConsoleSettings(edition),
+            lambda: ModeEventConsoleSettings(
+                edition, PageContext(config=active_config, request=request)
+            ),
         )
     )
 
@@ -1548,13 +1551,13 @@ def generate(self, tree: FolderTree) -> None:
 
 
 class ABCEventConsoleMode(WatoMode, abc.ABC):
-    def __init__(self, edition: Edition) -> None:
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
         config_domain = config_domain_registry[EVENT_CONSOLE]
         assert isinstance(config_domain, ConfigDomainEventConsole)
         self._config_domain = config_domain
         self._paths = ec.create_paths(cmk.utils.paths.omd_root)
         self._rule_packs = list(ec.load_rule_packs(self._paths))
-        super().__init__(edition)
+        super().__init__(edition, ctx)
 
     def _mib_dirs(self) -> Sequence[tuple[Path, str, bool]]:
         # ASN1 MIB source directory candidates. Non existing dirs are ok.
@@ -3278,8 +3281,8 @@ def static_permissions() -> Collection[PermissionName]:
     def parent_mode(cls) -> type[WatoMode] | None:
         return ModeEventConsoleRulePacks
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
 
         self._default_values = self._config_domain.default_globals()
         self._current_settings = dict(load_configuration_settings())
@@ -3418,8 +3421,8 @@ def static_permissions() -> Collection[PermissionName]:
     def parent_mode(cls) -> type[WatoMode] | None:
         return ModeEventConsoleSettings
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._need_restart = None
 
     @override

cmk/gui/oauth2_connections/wato/_modes.py

@@ -34,6 +34,7 @@
     PageMenuSearch,
     PageMenuTopic,
 )
+from cmk.gui.pages import PageContext
 from cmk.gui.site_config import site_is_local
 from cmk.gui.table import Table
 from cmk.gui.type_defs import ActionResult, IconNames, PermissionName, StaticIcon
@@ -477,10 +478,14 @@ def _connector_type(cls) -> str | None:
         return None
 
     def __init__(
-        self, edition: Edition, mode_type: SimpleModeType[OAuth2Connection] | None = None
+        self,
+        edition: Edition,
+        ctx: PageContext,
+        mode_type: SimpleModeType[OAuth2Connection] | None = None,
     ) -> None:
         super().__init__(
             edition,
+            ctx,
             mode_type=mode_type or OAuth2ModeType(),
             store=OAuth2ConnectionsConfigFile(),
         )
@@ -663,8 +668,8 @@ def _delete_passwords(
 
 
 class ModeMicrosoftEntraIdConnections(ModeOAuth2Connections):
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition, mode_type=MicrosoftEntraIdModeType())
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx, mode_type=MicrosoftEntraIdModeType())
 
     @classmethod
     @override
@@ -693,10 +698,14 @@ def name(cls) -> str:
         return "edit_oauth2_connection"
 
     def __init__(
-        self, edition: Edition, mode_type: SimpleModeType[OAuth2Connection] | None = None
+        self,
+        edition: Edition,
+        ctx: PageContext,
+        mode_type: SimpleModeType[OAuth2Connection] | None = None,
     ) -> None:
         super().__init__(
             edition,
+            ctx,
             mode_type=mode_type or OAuth2ModeType(),
             store=OAuth2ConnectionsConfigFile(),
         )
@@ -829,8 +838,8 @@ def page(self, config: Config, form_name: str = "edit") -> None:
 
 
 class ModeCreateMicrosoftEntraIdConnection(ModeCreateOAuth2Connection):
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition, mode_type=MicrosoftEntraIdModeType())
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx, mode_type=MicrosoftEntraIdModeType())
 
     @classmethod
     @override

cmk/gui/wato/_search_permissions.py

@@ -20,6 +20,7 @@
 class SetupPermissionsHandler:
     def __init__(self, edition: Edition, ctx: PageContext) -> None:
         self._edition = edition
+        self._ctx = ctx
         self._config = ctx.config
         self._request = ctx.request
         self._category_permissions = {
@@ -70,7 +71,7 @@ def _check_page_handler(self, url: str) -> bool:
 
         try:
             if mode:
-                mode_registry[mode](self._edition).ensure_permissions()
+                mode_registry[mode](self._edition, self._ctx).ensure_permissions()
             else:
                 self._check_if_handling_page_triggers_exception(file_name)
             return True

cmk/gui/wato/page_handler.py

@@ -74,7 +74,7 @@ def page_handler(edition: Edition, ctx: PageContext) -> None:
     ):
         raise MKGeneralException(_("Checkmk can only be configured on the managers central site."))
 
-    mode_instance = mode_registry.get(current_mode, ModeNotImplemented)(edition)
+    mode_instance = mode_registry.get(current_mode, ModeNotImplemented)(edition, ctx)
     mode_instance.ensure_permissions()
 
     display_options.load_from_html(request, html)

cmk/gui/wato/pages/_simple_modes.py

@@ -58,6 +58,7 @@
     PageMenuSearch,
     PageMenuTopic,
 )
+from cmk.gui.pages import PageContext
 from cmk.gui.table import Table, table_element
 from cmk.gui.type_defs import ActionResult, IconNames, RenderMode, StaticIcon
 from cmk.gui.user_sites import activation_sites
@@ -180,7 +181,11 @@ class _SimpleWatoModeBase[T: Mapping[str, Any]](WatoMode):
     """
 
     def __init__(
-        self, edition: Edition, mode_type: SimpleModeType[T], store: WatoSimpleConfigFile[T]
+        self,
+        edition: Edition,
+        ctx: PageContext,
+        mode_type: SimpleModeType[T],
+        store: WatoSimpleConfigFile[T],
     ) -> None:
         self._mode_type = mode_type
         self._store = store
@@ -189,7 +194,7 @@ def __init__(
         # to be set before it is executed. Therefore we execute the super constructor
         # here.
         # TODO: Make the _from_vars() mechanism more explicit
-        super().__init__(edition)
+        super().__init__(edition, ctx)
 
     def _add_change(
         self,
@@ -416,12 +421,16 @@ class SimpleEditMode[T: Mapping[str, Any]](_SimpleWatoModeBase[T]):
     """Base class for edit modes"""
 
     def __init__(
-        self, edition: Edition, mode_type: SimpleModeType[T], store: WatoSimpleConfigFile[T]
+        self,
+        edition: Edition,
+        ctx: PageContext,
+        mode_type: SimpleModeType[T],
+        store: WatoSimpleConfigFile[T],
     ):
         self._ident: str | None = None
         self._clone: str | None = None
         self._new: bool = True
-        super().__init__(edition, mode_type, store)
+        super().__init__(edition, ctx, mode_type, store)
 
     def _vs_individual_elements(self) -> list[DictionaryEntry]:
         raise NotImplementedError

cmk/gui/wato/pages/activate_changes.py

@@ -152,8 +152,8 @@ def name(cls) -> str:
     def static_permissions() -> Collection[PermissionName]:
         return ["discard"]
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._changes = activate_changes.ActivateChanges()
         self._changes.load(list(activation_sites(active_config.sites)))
 
@@ -400,8 +400,8 @@ def name(cls) -> str:
     def static_permissions() -> Collection[PermissionName]:
         return []
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._changes = activate_changes.ActivateChanges()
         self._changes.load(list(activation_sites(active_config.sites)))
         self._license_usage_report_validity = get_license_usage_report_validity(

cmk/gui/wato/pages/analyze_configuration.py

@@ -37,6 +37,7 @@
     PageMenuEntry,
     PageMenuTopic,
 )
+from cmk.gui.pages import PageContext
 from cmk.gui.table import Table, table_element
 from cmk.gui.type_defs import ActionResult, IconNames, PermissionName, StaticIcon
 from cmk.gui.user_sites import activation_sites
@@ -70,8 +71,8 @@ def name(cls) -> str:
     def static_permissions() -> Collection[PermissionName]:
         return ["analyze_config"]
 
-    def __init__(self, edition: Edition) -> None:
-        super().__init__(edition)
+    def __init__(self, edition: Edition, ctx: PageContext) -> None:
+        super().__init__(edition, ctx)
         self._logger = logger.getChild("analyze-config")
         self._acks = self._load_acknowledgements()