231 lines
8.9 KiB
Python
231 lines
8.9 KiB
Python
from __future__ import annotations
|
|
|
|
from dataclasses import replace
|
|
from pathlib import Path
|
|
|
|
from sqlalchemy import inspect
|
|
|
|
from govoplan_calendar.backend.db import models as calendar_models # noqa: F401 - populate Calendar ORM metadata
|
|
from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER
|
|
from govoplan_core.core.calendar import (
|
|
CALENDAR_AVAILABILITY_READ_SCOPE,
|
|
CALENDAR_EVENT_WRITE_SCOPE,
|
|
CAPABILITY_CALENDAR_OUTBOX,
|
|
CAPABILITY_CALENDAR_SCHEDULING,
|
|
)
|
|
from govoplan_core.core.module_guards import drop_table_retirement_provider, persistent_table_uninstall_guard
|
|
from govoplan_core.core.modules import (
|
|
FrontendModule,
|
|
FrontendRoute,
|
|
MigrationSpec,
|
|
ModuleContext,
|
|
ModuleInterfaceProvider,
|
|
ModuleManifest,
|
|
NavItem,
|
|
PermissionDefinition,
|
|
RoleTemplate,
|
|
)
|
|
from govoplan_core.db.base import Base
|
|
|
|
|
|
_calendar_table_retirement_provider = drop_table_retirement_provider(
|
|
calendar_models.CalendarCollection,
|
|
calendar_models.CalendarEvent,
|
|
calendar_models.CalendarOutboxOperation,
|
|
calendar_models.CalendarSyncCredential,
|
|
calendar_models.CalendarSyncSource,
|
|
label="Calendar",
|
|
)
|
|
|
|
|
|
def _calendar_retirement_provider(session: object | None, module_id: str):
|
|
plan = _calendar_table_retirement_provider(session, module_id)
|
|
base_executor = plan.destroy_data_executor
|
|
if base_executor is None:
|
|
return plan
|
|
|
|
def executor(execute_session: object, execute_module_id: str) -> None:
|
|
if not hasattr(execute_session, "get_bind") or not hasattr(execute_session, "query"):
|
|
raise RuntimeError("No database session is available for Calendar credential retirement.")
|
|
if inspect(execute_session.get_bind()).has_table(calendar_models.CalendarSyncCredential.__tablename__):
|
|
from govoplan_calendar.backend.service import delete_calendar_credentials_for_retirement
|
|
|
|
delete_calendar_credentials_for_retirement(execute_session)
|
|
base_executor(execute_session, execute_module_id)
|
|
|
|
return replace(
|
|
plan,
|
|
destroy_data_warnings=(
|
|
*plan.destroy_data_warnings,
|
|
"Calendar-owned credentials are deleted immediately before tables are dropped; retirement fails if an external secret provider is unavailable.",
|
|
),
|
|
destroy_data_executor=executor,
|
|
)
|
|
|
|
|
|
def _permission(scope: str, label: str, description: str) -> PermissionDefinition:
|
|
module_id, resource, action = scope.split(":", 2)
|
|
return PermissionDefinition(
|
|
scope=scope,
|
|
label=label,
|
|
description=description,
|
|
category="Calendar",
|
|
level="tenant",
|
|
module_id=module_id,
|
|
resource=resource,
|
|
action=action,
|
|
)
|
|
|
|
|
|
PERMISSIONS = (
|
|
_permission("calendar:calendar:read", "View calendars", "List tenant calendar collections and metadata."),
|
|
_permission("calendar:calendar:write", "Manage calendars", "Create and edit tenant calendar collections."),
|
|
_permission("calendar:calendar:admin", "Administer calendars", "Delete calendars and manage tenant-level calendar settings."),
|
|
_permission("calendar:event:read", "View calendar events", "List and inspect calendar events."),
|
|
_permission(CALENDAR_EVENT_WRITE_SCOPE, "Manage calendar events", "Create and edit calendar events."),
|
|
_permission("calendar:event:delete", "Delete calendar events", "Delete or cancel calendar events where policy allows it."),
|
|
_permission("calendar:event:import", "Import iCalendar events", "Import VEVENT data from iCalendar sources."),
|
|
_permission("calendar:event:export", "Export iCalendar events", "Export events as text/calendar VEVENT data."),
|
|
_permission(CALENDAR_AVAILABILITY_READ_SCOPE, "Read availability", "Read free/busy and availability data for integrations."),
|
|
)
|
|
|
|
ROLE_TEMPLATES = (
|
|
RoleTemplate(
|
|
slug="calendar_manager",
|
|
name="Calendar manager",
|
|
description="Manage tenant calendars and events.",
|
|
permissions=(
|
|
"calendar:calendar:read",
|
|
"calendar:calendar:write",
|
|
"calendar:event:read",
|
|
CALENDAR_EVENT_WRITE_SCOPE,
|
|
"calendar:event:delete",
|
|
"calendar:event:import",
|
|
"calendar:event:export",
|
|
CALENDAR_AVAILABILITY_READ_SCOPE,
|
|
),
|
|
),
|
|
RoleTemplate(
|
|
slug="calendar_viewer",
|
|
name="Calendar viewer",
|
|
description="Read calendars, events, exports, and availability.",
|
|
permissions=(
|
|
"calendar:calendar:read",
|
|
"calendar:event:read",
|
|
"calendar:event:export",
|
|
CALENDAR_AVAILABILITY_READ_SCOPE,
|
|
),
|
|
),
|
|
)
|
|
|
|
|
|
def _tenant_summary(session, tenant_id: str) -> dict[str, int]:
|
|
from govoplan_calendar.backend.db.models import (
|
|
CalendarCollection,
|
|
CalendarEvent,
|
|
CalendarOutboxOperation,
|
|
CalendarSyncCredential,
|
|
CalendarSyncSource,
|
|
)
|
|
|
|
return {
|
|
"calendars": session.query(CalendarCollection).filter(CalendarCollection.tenant_id == tenant_id, CalendarCollection.deleted_at.is_(None)).count(),
|
|
"calendar_events": session.query(CalendarEvent).filter(CalendarEvent.tenant_id == tenant_id, CalendarEvent.deleted_at.is_(None)).count(),
|
|
"calendar_sync_sources": session.query(CalendarSyncSource).filter(CalendarSyncSource.tenant_id == tenant_id, CalendarSyncSource.deleted_at.is_(None)).count(),
|
|
"calendar_sync_credentials": session.query(CalendarSyncCredential).filter(CalendarSyncCredential.tenant_id == tenant_id, CalendarSyncCredential.deleted_at.is_(None)).count(),
|
|
"calendar_outbox_pending": session.query(CalendarOutboxOperation)
|
|
.filter(
|
|
CalendarOutboxOperation.tenant_id == tenant_id,
|
|
CalendarOutboxOperation.status.in_(("pending", "retry", "in_progress")),
|
|
)
|
|
.count(),
|
|
}
|
|
|
|
|
|
def _calendar_router(context: ModuleContext):
|
|
from govoplan_calendar.backend.runtime import configure_runtime
|
|
|
|
configure_runtime(registry=context.registry, settings=context.settings)
|
|
from govoplan_calendar.backend.router import router
|
|
|
|
return router
|
|
|
|
|
|
def _calendar_scheduling_provider(context: ModuleContext) -> object:
|
|
del context
|
|
from govoplan_calendar.backend.capabilities import SqlCalendarSchedulingProvider
|
|
|
|
return SqlCalendarSchedulingProvider()
|
|
|
|
|
|
def _calendar_outbox_provider(context: ModuleContext) -> object:
|
|
from govoplan_calendar.backend.outbox import (
|
|
OUTBOX_DEFAULT_TERMINAL_RETENTION_DAYS,
|
|
SqlCalendarOutboxProvider,
|
|
)
|
|
|
|
return SqlCalendarOutboxProvider(
|
|
terminal_retention_days=getattr(
|
|
context.settings,
|
|
"calendar_outbox_terminal_retention_days",
|
|
OUTBOX_DEFAULT_TERMINAL_RETENTION_DAYS,
|
|
)
|
|
)
|
|
|
|
|
|
manifest = ModuleManifest(
|
|
id="calendar",
|
|
name="Calendar",
|
|
version="0.1.8",
|
|
required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR),
|
|
optional_dependencies=("mail", "tasks", "scheduling", "appointments", "workflow", "notifications", "dms", "connectors"),
|
|
provides_interfaces=(
|
|
ModuleInterfaceProvider(name="calendar.outbox", version="0.1.8"),
|
|
ModuleInterfaceProvider(name="calendar.scheduling", version="0.1.8"),
|
|
),
|
|
permissions=PERMISSIONS,
|
|
route_factory=_calendar_router,
|
|
role_templates=ROLE_TEMPLATES,
|
|
tenant_summary_providers=(_tenant_summary,),
|
|
capability_factories={
|
|
CAPABILITY_CALENDAR_OUTBOX: _calendar_outbox_provider,
|
|
CAPABILITY_CALENDAR_SCHEDULING: _calendar_scheduling_provider,
|
|
},
|
|
nav_items=(NavItem(path="/calendar", label="Calendar", icon="calendar", required_any=("calendar:event:read",), order=55),),
|
|
frontend=FrontendModule(
|
|
module_id="calendar",
|
|
package_name="@govoplan/calendar-webui",
|
|
routes=(
|
|
FrontendRoute(
|
|
path="/calendar",
|
|
component="CalendarPage",
|
|
required_any=("calendar:event:read",),
|
|
order=55,
|
|
),
|
|
),
|
|
nav_items=(NavItem(path="/calendar", label="Calendar", icon="calendar", required_any=("calendar:event:read",), order=55),),
|
|
),
|
|
migration_spec=MigrationSpec(
|
|
module_id="calendar",
|
|
metadata=Base.metadata,
|
|
script_location=str(Path(__file__).with_name("migrations") / "versions"),
|
|
retirement_supported=True,
|
|
retirement_provider=_calendar_retirement_provider,
|
|
retirement_notes="Destructive retirement drops calendar-owned database tables after the installer captures a database snapshot.",
|
|
),
|
|
uninstall_guard_providers=(
|
|
persistent_table_uninstall_guard(
|
|
calendar_models.CalendarCollection,
|
|
calendar_models.CalendarEvent,
|
|
calendar_models.CalendarOutboxOperation,
|
|
calendar_models.CalendarSyncCredential,
|
|
calendar_models.CalendarSyncSource,
|
|
label="Calendar",
|
|
),
|
|
),
|
|
)
|
|
|
|
|
|
def get_manifest() -> ModuleManifest:
|
|
return manifest
|