phil/edit-lock-bundle

phil/edit-lock-bundle permet à plusieurs personnes de modifier la même ressource sans écraser le travail des autres. Un rédacteur qui entre dans un bloc d'un document en prend le bail : personne d'autre ne peut écrire ce bloc tant que le bail n'est pas libéré, qu'il n'expire pas faute de pulsation, ou qu'une personne autorisée par l'application, un propriétaire ou un administrateur, ne le reprend pas. Un bail peut aussi couvrir une ressource entière, ce qui exclut alors tout bail d'autrui sur ses parties. Chaque bloc que le détenteur enregistre est vérifié par phil/ujo, remis à l'application et poussé aux autres rédacteurs avec la liste de qui modifie quoi, sous forme de Turbo Streams, par un hub Mercure. Dans le navigateur, un contrôleur Stimulus prend les baux à mesure que le rédacteur passe d'un bloc à l'autre, ferme et nomme les blocs que d'autres détiennent, et applique leurs enregistrements à l'éditeur de phil/block-editor-bundle dès leur arrivée. La granularité est le bloc : il n'y a aucune fusion de caractères.

Il s'adresse à toute application Symfony où des gens écrivent ensemble : une page de wiki, un brouillon partagé, les notes d'un meneur de jeu, le procès-verbal d'une réunion. L'application nomme les ressources (article:42, wiki/home), dit qui écrit et ce que chacun peut modifier, et décide où vont les blocs enregistrés ; le bundle conserve les baux et transporte les messages. Une ressource n'a pas à être un document : un formulaire, un enregistrement ou un fichier peut faire l'objet d'un bail entier, depuis PHP, sans le contrôleur.

C'est un bundle Symfony sur phil/ujo, Doctrine et, en option, MercureBundle. Les baux résident dans une table, écrits par des requêtes de comparaison et échange dans une transaction qui verrouille la ligne de la ressource, afin que deux requêtes en concurrence pour un bloc, ou pour la ressource entière et l'un de ses blocs, ne gagnent jamais toutes les deux ; ou en mémoire pour les tests. Chaque point de terminaison vérifie l'en-tête du contrôleur et le jeton CSRF sans état de Symfony. Sans Mercure, le contrôleur demande la présence à chaque pulsation, et les enregistrements ne sont pas poussés. Le contrôleur est servi par AssetMapper, sans étape de construction. Mercure, Turbo Streams et UJO (Universal JSON Output) sont les formats qu'il parle ; il ne dépend d'aucune autre bibliothèque de verrouillage ou de collaboration.

État

Documentation

Démarrage rapide

composer require phil/edit-lock-bundle symfony/mercure-bundle

# config/packages/phil_edit_lock.yaml
phil_edit_lock:
    holder_provider: App\Collaboration\CurrentWriter   # a HolderProvider
    policy: App\Collaboration\WritersPolicy            # an EditPolicy
    block_store: App\Collaboration\DraftBlocks          # a BlockStore, optional

<div data-controller="phil--edit-lock-bundle--collaboration"
     data-phil--edit-lock-bundle--collaboration-config-value="{{ collaboration|json_encode }}">
    {{ form_row(form.body) }}  {# the block editor of phil/block-editor-bundle #}
    <aside data-phil--edit-lock-bundle--collaboration-target="presence"></aside>
</div>

collaboration vaut ClientConfig::for('article:42', $holder), fourni par le contrôleur de la page.

Prérequis

PHP 8.5 ou plus récent, Symfony 8.2, Doctrine DBAL 4 et ORM 3, phil/ujo. Pour les mises à jour poussées, MercureBundle et un hub Mercure ; pour le contrôleur, Stimulus 3 et phil/block-editor-bundle.

Contribuer

Les contributions sont les bienvenues sur le monodépôt PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. Voir LICENSE.