Agent Zero
b311ab7aa1
Check Cross-Plugin Imports / check (push) Has been cancelled
- Briefpapier (letterheads): Seiten-Setup (A4/A5/Letter, Ränder), Header/Footer-Blöcke, Wasserzeichen, Logo-Upload (DocumentAsset, data:-URI-only) - Druckvorlagen (print_templates): Block-Komposition mit Briefpapier-Ref + entity_type - Block-Registry (document_blocks.py): text/image/shape(line/rect/circle)/table/spacer/divider/placeholder/pagebreak + Modul-Beiträge via document_blocks()-Contract - Renderer (document_renderer.py): Blocks→HTML→PDF via WeasyPrint (SSRF-Sandbox data:-URI-only), @page-Frame mit running header/footer, Placeholder-Beispiel-Defaults gegen StrictUndefined - Contract-Beitrag contacts: document_placeholders/document_data (#359-Muster wie importexport_entities) - 13 neue Endpoints in documents.py: Letterhead-CRUD, Template-CRUD, Assets, document-blocks, document-placeholders, preview (HTML), render (PDF) - Migration: Plugin-SQL 0003 (idempotent) + Alembic 0143 (Dual-Path, RLS fail-closed crm_api) - Frontend: api/documents.ts, Settings→Dokumente (settings_pages), BlockEditor (@dnd-kit Palette/Canvas/Config/Live-Preview-iframe), LetterheadEditor, PrintTemplateEditor, DocumentGenerationDialog (global, ContactDetailPage-Integration) - i18n de/en, api-documentation.md, plugin-development-guide.md, PROGRESS.md Verifikation: 32/32 neue Tests + 9/9 Regressionen, tsc exit 0, Build OK 2.79s, Alembic-Fresh-DB 0143 mit RLS bewiesen, ruff clean
97 lines
3.6 KiB
Python
97 lines
3.6 KiB
Python
"""Report Generator plugin — PDF/Excel/CSV reports from Jinja2 templates."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from app.plugins.base import BasePlugin
|
|
from app.plugins.manifest import (
|
|
FrontendMenuItem,
|
|
FrontendPageRoute,
|
|
FrontendSettingsPage,
|
|
PluginManifest,
|
|
PluginRouteDef,
|
|
)
|
|
|
|
|
|
class ReportGeneratorPlugin(BasePlugin):
|
|
"""Report Generator plugin for generating reports from Jinja2 templates."""
|
|
|
|
manifest = PluginManifest(
|
|
name="report_generator",
|
|
version="1.0.0",
|
|
display_name="Report Generator",
|
|
description="Generates PDF/Excel/CSV reports from Jinja2 templates and data sources",
|
|
is_core=True,
|
|
dependencies=["permissions"],
|
|
routes=[
|
|
# documents router MUST be registered before routes: its fixed
|
|
# single-segment paths (/letterheads, /print-templates, ...) would
|
|
# otherwise be shadowed by the /{report_id} catch-all in routes.
|
|
PluginRouteDef(
|
|
path="/api/v1/reports",
|
|
module="app.plugins.builtins.report_generator.documents",
|
|
router_attr="router",
|
|
),
|
|
PluginRouteDef(
|
|
path="/api/v1/reports",
|
|
module="app.plugins.builtins.report_generator.routes",
|
|
router_attr="router",
|
|
),
|
|
],
|
|
settings_pages=[
|
|
FrontendSettingsPage(
|
|
path="documents",
|
|
label_key="settings.documents",
|
|
label="Dokumente",
|
|
component="@/pages/DocumentSettings",
|
|
icon="FileText",
|
|
order=75,
|
|
permission="reports:read",
|
|
),
|
|
],
|
|
events=["report.requested", "report.generated"],
|
|
migrations=["0001_initial.sql", "0002_reports_folder_id.sql"],
|
|
permissions=["reports:read", "reports:generate", "reports:manage_templates"],
|
|
menu_items=[
|
|
FrontendMenuItem(label_key='nav.reports', label='Berichte', path='/reports', icon='BarChart3', order=70, permission='reports:read'),
|
|
],
|
|
page_routes=[
|
|
FrontendPageRoute(path='/reports', component='@/pages/Reports', protected=True, permission='reports:read'),
|
|
],
|
|
|
|
author="LeoCRM Team",
|
|
min_app_version="1.0.0",
|
|
contract_version="1.0.0")
|
|
|
|
def get_entity_models(self) -> dict[str, type]:
|
|
from app.plugins.builtins.report_generator.models import (
|
|
DocumentAsset,
|
|
Letterhead,
|
|
PrintTemplate,
|
|
ReportInstance,
|
|
ReportTemplate,
|
|
)
|
|
return {
|
|
"report_template": ReportTemplate,
|
|
"report_instance": ReportInstance,
|
|
"letterhead": Letterhead,
|
|
"print_template": PrintTemplate,
|
|
"document_asset": DocumentAsset,
|
|
}
|
|
|
|
async def on_activate(
|
|
self, db, service_container, event_bus
|
|
) -> None:
|
|
"""Activate plugin: register background jobs and event listeners."""
|
|
# Register background jobs (isolated report generation in worker)
|
|
from app.plugins.builtins.report_generator import jobs # noqa: F401
|
|
await super().on_activate(db, service_container, event_bus)
|
|
|
|
async def on_deactivate(
|
|
self, db, service_container, event_bus
|
|
) -> None:
|
|
"""Deactivate plugin: unregister contract and event listeners."""
|
|
# Contract abmelden
|
|
from app.plugins.builtins.contracts import get_contract_registry
|
|
get_contract_registry().unregister(self.manifest.name)
|
|
await super().on_deactivate(db, service_container, event_bus)
|