Configuration par carnet et extensibilité des plugins¶
Cette page explique pourquoi la configuration d'un site web se fait carnet par carnet plutôt qu'au niveau global de l'espace utilisateur, pourquoi le site d'un carnet naît au rattachement d'un domaine plutôt qu'à l'activation du plugin, et comment ce mécanisme reste générique : d'autres plugins de diffusion pourront exposer leur propre configuration par carnet sans que le cœur ait à les connaître. Pour la procédure côté utilisateur, voir Configurer le site web d'un carnet ; pour le modèle de données des carnets, voir Carnets : modèle de données.
Le carnet comme périmètre de configuration¶
Dans Kirexo, un utilisateur peut tenir plusieurs carnets — autant de lignes éditoriales distinctes. Faire porter la configuration d'un site par le compte entier obligerait tous les carnets d'un même auteur à partager un seul site, un seul domaine, un seul habillage. Ce serait contraire à l'idée même du carnet comme unité éditoriale autonome.
La configuration du site est donc scopée au carnet : chaque carnet a sa propre configuration web, indépendante des autres. Le point d'entrée reflète ce choix — il n'est pas au niveau du compte mais dans le menu ⋯ de la carte du carnet, sous « Configurer Web », dans « Mon espace ». La route des réglages porte l'identifiant du carnet : /u/web/reglages/site/{notebookId}. L'appartenance du carnet à l'utilisateur courant est vérifiée par le NotebookVoter (anti-IDOR) avant tout accès.
Pourquoi l'entête n'a plus de lien « Mon site »¶
Le menu du compte, dans l'entête, a longtemps proposé une entrée « Mon site » pointant vers une configuration unique. Cette entrée n'a plus de sens dès lors que la configuration appartient au carnet : avec plusieurs carnets, il n'existe aucune cible unique à proposer, et en désigner une arbitrairement (le « premier » carnet, par exemple) ferait éditer silencieusement le mauvais site.
Le lien a donc été retiré de templates/components/Header.html.twig. Le menu du compte ne garde que ce qui est réellement global : « Plugins », la page d'activation des canaux pour le compte, et les entrées que les plugins actifs contribuent eux-mêmes — via App\Twig\Components\UserMenuPluginLinks (src/Twig/Components/UserMenuPluginLinks.php), qui ne cite aucune route de plugin. La classe App\Twig\Components\Header (src/Twig/Components/Header.php), elle, ne connaît aucun plugin : elle ne résout que l'identité du compte, la cible de bascule et l'espace courant.
Le corollaire s'applique aussi aux routes : il n'existe pas de variante « sans carnet ». Toute la surface de configuration porte le {notebookId} — le hub (/u/web/reglages/site/{notebookId}) comme les actions qui créent quelque chose dans le carnet (rattachement de domaine, apparence, CSS, création et réordonnancement des pages spéciales). Seules les actions portant sur une entité déjà créée sont désignées par son propre identifiant (/u/web/reglages/site/pages/{id}/…, /u/web/reglages/site/domaines/{id}/suppression) : le carnet y est déduit de l'entité, et la redirection ramène au hub de ce carnet. Les paths exacts sont catalogués dans la Référence — Domaines de site et le guide Configurer le site web d'un carnet.
Le site naît au rattachement d'un domaine¶
Un carnet n'a pas de site tant qu'aucun domaine ne lui est rattaché. C'est un choix délibéré : un carnet sans domaine n'a rien à servir publiquement, et créer un site vide pour chaque carnet encombrerait inutilement le modèle.
Concrètement, tant qu'aucun domaine n'est renseigné, les réglages du carnet ne proposent que l'onglet Domaine — celui qui porte le formulaire de rattachement. Le rattachement du premier domaine est le seul point de naissance d'un site : le contrôleur d'ajout de domaine (src/Plugin/Web/src/Controller/WebPluginSiteDomainAddController.php) crée le Site du carnet à ce moment-là, puis lui rattache le domaine. Une fois le site créé, les onglets Pages spéciales et Apparence apparaissent.
Ce déclencheur unique garde le modèle cohérent : l'existence d'un site est exactement corrélée au fait qu'un carnet a une adresse publique. Pas de domaine, pas de site ; un domaine, un site.
Le contenu du site suit le carnet, lui aussi¶
Le carnet n'est pas seulement le périmètre de configuration du site : c'est aussi le périmètre de son contenu. Un site ne rend que les articles publiés vers le canal web de son carnet — les articles publiés dans les autres carnets du même utilisateur n'y apparaissent pas. Un article du carnet A n'est jamais servi sur le site du carnet B, même s'ils partagent le même auteur.
Cette isolation vaut partout où l'on résout un site depuis un article, toujours par le carnet de l'article (findByNotebookId) et jamais par son auteur :
- le rendu public ne liste et ne sert que les articles du carnet du site (voir Le rendu public du site (plugin web)) ;
- l'aperçu web d'un article se fait dans le site du carnet de cet article (
src/Plugin/Web/src/Controller/WebPluginArticlePreviewController.php) ; si ce carnet n'a pas encore de site, l'aperçu est indisponible ; - l'invalidation du cache à la publication ne purge que le site du carnet concerné.
Le cycle complet est donc : écrire un article dans un carnet → le publier avec le web dans ses destinations → il apparaît sur le site de ce carnet. Si le carnet n'a pas encore de site (aucun domaine rattaché), l'article ne s'affiche nulle part sur le web pour l'instant ; il apparaîtra dès que le carnet aura un site, sans nouvelle action sur l'article.
Une capability neutre, pas un cas particulier « web »¶
Le fait d'être configurable carnet par carnet n'est pas codé en dur pour le plugin web. C'est une capability optionnelle, exprimée par une interface neutre du cœur : Kirexo\Plugin\Contracts\NotebookConfigurablePluginInterface (src/Plugin/Contracts/NotebookConfigurablePluginInterface.php).
Cette interface suit le principe de ségrégation d'interface (ISP), dans le même esprit que ArticlePreviewablePluginInterface : seuls les plugins qui exposent une configuration par carnet l'implémentent. Elle déclare une unique méthode, notebookSettingsRouteName(): string, qui renvoie le nom de la route de configuration du plugin pour un carnet donné. La convention est partagée : cette route doit accepter un paramètre {notebookId} (UUID rfc4122).
Le plugin web l'inaugure : WebDiffusionPlugin (src/Plugin/Web/src/WebDiffusionPlugin.php) implémente l'interface et renvoie la route web_plugin_site_settings.
Comment les liens apparaissent dans le menu du carnet¶
Le menu ⋯ d'un carnet n'est pas au courant de l'existence du plugin web. Il interroge la liste des plugins et ne retient que ceux qui, à la fois :
- déclarent la capability (
instanceof NotebookConfigurablePluginInterface), et - sont actifs pour le propriétaire du carnet.
Ce tri est porté par le composant Twig App\Twig\Components\NotebookConfigLinks (src/Twig/Components/NotebookConfigLinks.php), qui produit un lien « Configurer \<label du plugin> » par plugin retenu, pointant vers sa route de réglages par carnet préfixée du {notebookId}.
La détection se fait par instanceof au moment du rendu, pas par autoconfiguration de tag : les plugins sont déjà agrégés par le registre, et le composant les filtre à la volée. C'est le même parti pris que pour les autres capabilities optionnelles du cœur.
Pourquoi c'est extensible sans toucher au cœur¶
L'intérêt de la capability neutre est qu'un futur plugin — RSS, Api, Mastodon — peut déclarer la même interface le jour où il veut exposer une configuration par carnet, et fournir sa propre route {notebookId}. Il apparaîtra alors automatiquement dans le menu ⋯ de chaque carnet, sans aucune modification du cœur ni du plugin web :
- le cœur ne connaît que le contrat (
NotebookConfigurablePluginInterface), jamais les plugins concrets ; - le composant de menu filtre par
instanceof, donc tout nouvel implémenteur est pris en compte sans code supplémentaire ; - chaque plugin reste maître de sa route et de sa surface de configuration par carnet.
C'est l'application, à la configuration par carnet, du principe qui gouverne toute l'architecture à plugins : le cœur définit des contrats neutres, les plugins s'y branchent, et retirer un plugin ne casse rien.
Voir aussi¶
- Configurer le site web d'un carnet — la procédure pas à pas.
- Carnets : modèle de données — ce qu'est un carnet et comment il appartient à un utilisateur.
- Le rendu public du site (plugin web) — comment un site ne sert que les articles de son carnet.
- Architecture à plugins — le socle de contrats neutres qui rend cette extensibilité possible.
- Contrat de plugin — l'interface principale des plugins de diffusion et ses capabilities optionnelles.