cms-server

Module isotope-cms (Spring Boot/Kotlin)

Cette brique fournit :

• Modèles d’entités CMS (CmsEntityModel) et déclinaisons : Page, Form, ArticleModel + Article et résultats de champs.
• API d’administration sécurisée (Spring Security, autorités access_cms_*).
• Rendu côté serveur via Freemarker pour pages/articles.
• Système de contributeurs (injection de variables dans les templates).

Architecture et composants clés

• Configuration Spring : IsotopeCmsConfiguration déclare les beans (services/validators) et charge application-isotope-cms.properties.
• Propriétés : CmsProperties (langue par défaut, domaine, chemin CSS, listes de champs activés, etc.) et CmsConfigurationController pour exposer un light-bean au front.
• Entités et JPA :
  • CmsEntityModel (table is_cms_entity_model) : champs communs, contributeurs associés (is_cms_contributor).
  • Pages : Page, PageUrl (tables is_cms_page, is_cms_page_url).
  • Formulaires : Form, FormField, FormFieldAttribute, résultats FormResult, FormFieldResult.
  • Articles : ArticleModel, ArticleModelField, ArticleModelFieldAttribute, Article, ArticleFieldResult.
• Templates Freemarker : src/main/resources/templates (pages, forms, articles) surchargeables par projet.
• View Engine : ViewEngineServiceImpl (non listé ici) pour le rendu de contenu (pages/articles) via Freemarker.

Schéma d’architecture (Pages / Articles / Forms / Inputs)

Endpoints principaux

• Pages (/api/admin/cms/pages, autorité access_cms_page) :
  • GET liste paginée avec filtres (search, statut de publication, catégorie)
  • GET /{id}, POST, PUT /{id}, DELETE /{id}
• Formulaires (/api/admin/cms/forms, autorité access_cms_forms) :
  • CRUD formulaire + CRUD champs (/forms/{id}/fields)
  • Rendu public des soumissions : /api/public/forms-results/{shortcut} (POST)
  • BO résultats : /api/admin/cms/forms-results (liste, suppression, export CSV)
• Articles et modèles (/api/admin/cms/articles*, autorités access_cms_articles_model et access_cms_articles) :
  • CRUD articles-model, CRUD champs de modèle
  • CRUD articles, preview rendu public /api/admin/cms/articles/{shortcut}/view
• CSS (/api/admin/css, autorité access_css) : CRUD + stockage FS via StorageCssServiceImpl.
• Config CMS : /api/admin/cms/config retourne CmsPropertiesLightBean.
• Rendu HTML côté serveur :
  • Public : GET /view/{shortcut}
  • BO sécurisé : GET /secured-view/{shortcut} (nécessite access_cms_page)

Sécurité

• Basée sur Spring Security/Authorities (ex. access_cms_page, access_cms_forms, etc.).
• Menu et fonctions disponibles dans docs/data.sql et docs/menu.sql (exemples d’initialisation).

Base de données

• Modèle MySQL dans docs/mysql.sql (tables CMS + contributeurs).
• Scripts additionnels docs/scripts/3.4.4.sql (ex. colonnes mail soumission formulaire).

Propriétés (application-isotope-cms.properties)

Extraits gérés par CmsProperties :

• isotope.cms.default-language
• isotope.cms.domain-url
• isotope.cms.css-upload-path
• isotope.cms.days-before-result-form-deletion
• isotope.cms.enabled-article-field-list
• isotope.cms.enabled-form-field-list
• isotope.cms.article-number-step-tolerance
• isotope.cms.enable-contributors
• isotope.cms.use-native-required
• isotope.cms.mail-from

Rendu et templating

• ViewEngineController fournit deux endpoints de rendu.
• ViewEngineService assemble le modèle : entités + variables (ex. contributeurs) + ressources médias (isotope-media) + messages i18n.

Rendu ordonné récursif (ViewEngineServiceImpl)

Principe : à partir d’une Page (shortcut, locale), le service rend le contenu en remplaçant dans l’ordre d’apparition les inclusions dynamiques (Formulaires, Articles) par leur HTML rendu, puis applique le template de page. Le processus est récursif et ordonné pour garantir un DOM final cohérent.

Étapes clés (simplifiées) :

• Charger la Page par shortcut et initialiser le modèle (variables Freemarker, serverUrl, i18n, contributeurs, …).
• Détecter dans content les marqueurs via CmsRegexPatterns :
  • @form(<shortcut>)
  • @article(<shortcut>)
• Pour chaque inclusion détectée, dans l’ordre d’apparition :
  • Récupérer l’entité (Form / Article) et ses champs.
  • Résoudre les valeurs par locale (labels, listes de valeurs via ValueListService, médias via MediaProperties).
  • Appliquer les contributeurs si activés.
  • Rendre le fragment avec Freemarker (templates forms/*.ftl ou articles/*.ftl).
  • Remplacer le marqueur dans le content parent par le HTML rendu.
• Une fois toutes les inclusions rendues et remplacées, appliquer le template pages/page.ftl pour le rendu final.

Schéma fonctionnel (flow) :

Schéma séquentiel (rendu ordonné) :

Contributeurs

• Interface : IContributor (méthode contribute(model) + meta getName/getDescription).
• Exemples : TodayContributor, UserAgentContributor, FrenchRegionsContributor.
• Affectation par entité via /api/admin/cms/contributors/{id}.

Validation

• Nombreux validateurs pour assurer cohérence des modèles et données : FormValidator, FormFieldValidator, ArticleModelValidator, ArticleModelFieldValidator, ArticleValidator, PageValidator, FormResultValidator.

Jobs

• ClearFormResults : purge des résultats de formulaires selon isotope.cms.days-before-result-form-deletion. Planification via propriétés (voir README cms).

Points d’extension

• Surcharger les templates Freemarker dans votre application.
• Ajouter des contributeurs via Spring (@Component) : ils seront détectés automatiquement.
• Restreindre/ouvrir les types de champs avec enabled-*.