From ecba7b2bd8b2652609101fc06e14f85954a4e305 Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Sat, 7 Nov 2026 06:27:14 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20(admin):=20A=C3=B1ade=20acciones=20?= =?UTF-8?q?para=20declarar=20el=20panel?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit DeclareAdminSections, DeclareAdminPages, DeclareAdminTasks y DeclareAdminActions permiten a cada extensión aportar secciones, páginas, pestañas y botones al panel de administración. Están en `base::action::admin`, con el mismo patrón que las demás acciones. --- src/base/action.rs | 10 +++- src/base/action/admin.rs | 32 +++++++++++ .../action/admin/declare_admin_actions.rs | 53 ++++++++++++++++++ src/base/action/admin/declare_admin_pages.rs | 38 +++++++++++++ .../action/admin/declare_admin_sections.rs | 53 ++++++++++++++++++ src/base/action/admin/declare_admin_tasks.rs | 54 +++++++++++++++++++ 6 files changed, 239 insertions(+), 1 deletion(-) create mode 100644 src/base/action/admin.rs create mode 100644 src/base/action/admin/declare_admin_actions.rs create mode 100644 src/base/action/admin/declare_admin_pages.rs create mode 100644 src/base/action/admin/declare_admin_sections.rs create mode 100644 src/base/action/admin/declare_admin_tasks.rs diff --git a/src/base/action.rs b/src/base/action.rs index b1c83aaf..95a816ae 100644 --- a/src/base/action.rs +++ b/src/base/action.rs @@ -1,7 +1,15 @@ -//! Acciones predefinidas para alterar el funcionamiento interno de PageTop. +//! Acciones predefinidas para intervenir en el funcionamiento de PageTop. +//! +//! Se agrupan por ámbito, para el renderizado de páginas ([`page`]) y componentes ([`component`]), +//! para extender el tratamiento de usuarios y permisos ([`auth`]) y mantener el panel de +//! administración ([`admin`]). Todas se declaran igual, con su constructor `new()` en +//! [`Extension::actions()`](crate::core::extension::Extension::actions), y se escriben con la ruta +//! de su ámbito, por ejemplo `action::page::BeforeRenderBody` o `action::auth::CheckPermission`. pub mod component; pub mod page; pub mod auth; + +pub mod admin; diff --git a/src/base/action/admin.rs b/src/base/action/admin.rs new file mode 100644 index 00000000..a24d0c34 --- /dev/null +++ b/src/base/action/admin.rs @@ -0,0 +1,32 @@ +//! Acciones para declarar las piezas que componen el panel de administración. +//! +//! Cada extensión aporta sus secciones, páginas, pestañas y botones al panel de administración con +//! estas acciones, sin depender de ninguna otra extensión, y PageTop las reúne al arrancar en el +//! registro del panel ([`AdminRegistry`](crate::admin::AdminRegistry)). El resto del panel está en +//! el módulo [`admin`](crate::admin). + +use crate::admin::{AdminActionBag, AdminPageBag, AdminSectionBag, AdminTaskBag}; + +/// Tipo de función para declarar secciones del panel de administración. +pub type FnActionDeclareAdminSections = fn(bag: &mut AdminSectionBag); + +/// Tipo de función para declarar páginas del panel de administración. +pub type FnActionDeclareAdminPages = fn(bag: &mut AdminPageBag); + +/// Tipo de función para declarar tareas (pestañas) locales de las páginas del panel. +pub type FnActionDeclareAdminTasks = fn(bag: &mut AdminTaskBag); + +/// Tipo de función para declarar acciones locales (botones) de las páginas del panel. +pub type FnActionDeclareAdminActions = fn(bag: &mut AdminActionBag); + +mod declare_admin_sections; +pub use declare_admin_sections::*; + +mod declare_admin_pages; +pub use declare_admin_pages::*; + +mod declare_admin_tasks; +pub use declare_admin_tasks::*; + +mod declare_admin_actions; +pub use declare_admin_actions::*; diff --git a/src/base/action/admin/declare_admin_actions.rs b/src/base/action/admin/declare_admin_actions.rs new file mode 100644 index 00000000..33b9d0c5 --- /dev/null +++ b/src/base/action/admin/declare_admin_actions.rs @@ -0,0 +1,53 @@ +use crate::prelude::*; + +use super::FnActionDeclareAdminActions; + +/// Acción para declarar acciones locales (botones de acción) en páginas del panel. +/// +/// Cada [`AdminAction`] indica en `for_path` la página en la que aparece el botón. +/// +/// # Ejemplo +/// +/// ```rust,no_run +/// # use pagetop::prelude::*; +/// fn declare_actions(bag: &mut AdminActionBag) { +/// bag.add(AdminAction { +/// url: "config/export/new".to_owned(), +/// for_path: "config/export".to_owned(), +/// title: Lc::n("Add export"), +/// weight: 0, +/// permission: None, +/// }); +/// } +/// // En Extension::actions(): +/// // action::admin::DeclareAdminActions::new(declare_actions) +/// ``` +pub struct DeclareAdminActions { + f: FnActionDeclareAdminActions, + weight: Weight, +} + +impl ActionDispatcher for DeclareAdminActions { + fn weight(&self) -> Weight { + self.weight + } +} + +impl DeclareAdminActions { + /// Permite [registrar](Extension::actions) una nueva acción [`FnActionDeclareAdminActions`]. + pub fn new(f: FnActionDeclareAdminActions) -> Self { + DeclareAdminActions { f, weight: 0 } + } + + /// Opcional. Acciones con pesos más bajos se aplican antes. Se pueden usar valores negativos. + pub fn with_weight(mut self, value: Weight) -> Self { + self.weight = value; + self + } + + /// Despacha las acciones sobre la bolsa de acciones locales. + #[inline] + pub(crate) fn dispatch(bag: &mut AdminActionBag) { + dispatch_actions(|action: &Self| (action.f)(bag)); + } +} diff --git a/src/base/action/admin/declare_admin_pages.rs b/src/base/action/admin/declare_admin_pages.rs new file mode 100644 index 00000000..7e45dd2f --- /dev/null +++ b/src/base/action/admin/declare_admin_pages.rs @@ -0,0 +1,38 @@ +use crate::prelude::*; + +use super::FnActionDeclareAdminPages; + +/// Acción para declarar páginas del panel de administración. +/// +/// Declarar una página la incluye en la navegación del panel; su *handler* lo monta la propia +/// extensión en [`Extension::configure_router()`] con [`Routes::admin_route()`], que exige el +/// permiso de la página. Ver el ejemplo del módulo [`admin`](crate::admin). +pub struct DeclareAdminPages { + f: FnActionDeclareAdminPages, + weight: Weight, +} + +impl ActionDispatcher for DeclareAdminPages { + fn weight(&self) -> Weight { + self.weight + } +} + +impl DeclareAdminPages { + /// Permite [registrar](Extension::actions) una nueva acción [`FnActionDeclareAdminPages`]. + pub fn new(f: FnActionDeclareAdminPages) -> Self { + DeclareAdminPages { f, weight: 0 } + } + + /// Opcional. Acciones con pesos más bajos se aplican antes. Se pueden usar valores negativos. + pub fn with_weight(mut self, value: Weight) -> Self { + self.weight = value; + self + } + + /// Despacha las acciones sobre la bolsa de páginas. + #[inline] + pub(crate) fn dispatch(bag: &mut AdminPageBag) { + dispatch_actions(|action: &Self| (action.f)(bag)); + } +} diff --git a/src/base/action/admin/declare_admin_sections.rs b/src/base/action/admin/declare_admin_sections.rs new file mode 100644 index 00000000..3d341642 --- /dev/null +++ b/src/base/action/admin/declare_admin_sections.rs @@ -0,0 +1,53 @@ +use crate::prelude::*; + +use super::FnActionDeclareAdminSections; + +/// Acción para declarar secciones del panel de administración. +/// +/// PageTop ya declara las secciones habituales: `"people"`, `"structure"`, `"config"`, +/// `"reports"` y `"help"`. Una sección declarada con la misma clave que otra la sustituye. +/// +/// # Ejemplo +/// +/// ```rust,no_run +/// # use pagetop::prelude::*; +/// fn declare_sections(bag: &mut AdminSectionBag) { +/// bag.add(AdminSection { +/// key: "tools".to_owned(), +/// path: "tools".to_owned(), +/// title: Lc::n("Tools"), +/// weight: 60, +/// }); +/// } +/// // En Extension::actions(): +/// // action::admin::DeclareAdminSections::new(declare_sections) +/// ``` +pub struct DeclareAdminSections { + f: FnActionDeclareAdminSections, + weight: Weight, +} + +impl ActionDispatcher for DeclareAdminSections { + fn weight(&self) -> Weight { + self.weight + } +} + +impl DeclareAdminSections { + /// Permite [registrar](Extension::actions) una nueva acción [`FnActionDeclareAdminSections`]. + pub fn new(f: FnActionDeclareAdminSections) -> Self { + DeclareAdminSections { f, weight: 0 } + } + + /// Opcional. Acciones con pesos más bajos se aplican antes. Se pueden usar valores negativos. + pub fn with_weight(mut self, value: Weight) -> Self { + self.weight = value; + self + } + + /// Despacha las acciones sobre la bolsa de secciones. + #[inline] + pub(crate) fn dispatch(bag: &mut AdminSectionBag) { + dispatch_actions(|action: &Self| (action.f)(bag)); + } +} diff --git a/src/base/action/admin/declare_admin_tasks.rs b/src/base/action/admin/declare_admin_tasks.rs new file mode 100644 index 00000000..0b885296 --- /dev/null +++ b/src/base/action/admin/declare_admin_tasks.rs @@ -0,0 +1,54 @@ +use crate::prelude::*; + +use super::FnActionDeclareAdminTasks; + +/// Acción para declarar tareas (pestañas) locales en páginas del panel. +/// +/// Cada [`AdminTask`] indica en `parent_path` la página a la que pertenece. +/// +/// # Ejemplo +/// +/// ```rust,no_run +/// # use pagetop::prelude::*; +/// fn declare_tasks(bag: &mut AdminTaskBag) { +/// bag.add(AdminTask { +/// path: "config/export/csv".to_owned(), +/// parent_path: "config/export".to_owned(), +/// title: Lc::n("CSV"), +/// weight: 0, +/// is_default: true, +/// permission: None, +/// }); +/// } +/// // En Extension::actions(): +/// // action::admin::DeclareAdminTasks::new(declare_tasks) +/// ``` +pub struct DeclareAdminTasks { + f: FnActionDeclareAdminTasks, + weight: Weight, +} + +impl ActionDispatcher for DeclareAdminTasks { + fn weight(&self) -> Weight { + self.weight + } +} + +impl DeclareAdminTasks { + /// Permite [registrar](Extension::actions) una nueva acción [`FnActionDeclareAdminTasks`]. + pub fn new(f: FnActionDeclareAdminTasks) -> Self { + DeclareAdminTasks { f, weight: 0 } + } + + /// Opcional. Acciones con pesos más bajos se aplican antes. Se pueden usar valores negativos. + pub fn with_weight(mut self, value: Weight) -> Self { + self.weight = value; + self + } + + /// Despacha las acciones sobre la bolsa de tareas. + #[inline] + pub(crate) fn dispatch(bag: &mut AdminTaskBag) { + dispatch_actions(|action: &Self| (action.f)(bag)); + } +}