Le plugin accès restreint par groupes

Historique

Ce plugin reprend la contrib Créer des groupes, limiter l’accès aux rubriques et aux articles... (version 0.7 réservée aux versions 1.8 de spip) dont il constitue la version 1.0. Ce plugin est compatible avec la version 1.9.2 de spip. Il n’a pas été complètement testé avec la version SVN de spip 1.9.3. (Une version compatible spip 1.9.1 est disponible également mais elle n’est plus maintenue).

[Mises à jour]

• la version [1.0.1] remplace la version 1.0 pour permettre d’assurer le filtrage des articles en mode « révision ». Voir ce forum pour plus de détails.
  Il est vivement conseillé de procéder à la mise à niveau des plugins v1.0, la mise à jour des fichiers n’entraînera pas de modification de vos groupes et restrictions existant.
• passage à la version [1.0.2] qui permet l’utilisation du critère tout_voir et du filtre accesgroupes_visualise pour permettre l’affichage d’une liste de toutes les rubriques/articles/brèves y compris les restreintes.
• passage à la version [1.0.3] compatible spip 1.9.2.
• passage à la version [1.0.31] qui corrige un certain nombre de bogues.

But :

Un des besoins fréquent lorsque l’on gère un site sous SPIP est de pouvoir restreindre l’accès à des rubriques afin qu’elles ne soient accessible qu’à certains utilisateurs. De façon complémentaire, pour permettre une gestion de ces accès restreints complète, simple et ergonomique, il s’avère indispensable que les utilisateurs « autorisés » soient gérés par groupes.

Cette contrib répond à ce besoin en essayant d’offrir le maximum de possibilités tant dans la gestion des utilisateurs autorisés que dans les restrictions d’accès, le tout sans avoir à intervenir sur les squelettes utilisés.

Pour permettre de réaliser des contenus totalement protégés, les restrictions d’accès doivent pouvoir s’appliquer aussi bien à l’espace privé qu’à l’espace public.

Pour les utilisateurs de la contrib (v0.7 ou v0.61), les nouveautés de cette version 1.0 (plugin) sont signalées par un : [v1.0]

Ce plugin permet :

• de créer des groupes d’auteurs : ces groupes peuvent êtres constitués d’utilisateurs, d’autres groupes (sous-groupes) ou de statuts (c’est à dire que tous les utilisateurs d’un statut donné appartiennent à ce groupe). Cette organisation génère elle-même d’autres contraintes techniques à gérer : ainsi il ne doit pas être possible d’inclure le groupe « pére » dans le groupe « fils » si celui-ci contient déja « fils » (sinon on risque la boucle infinie lors de la routine de contrôle d’accès).
• de limiter l’accès à certaines rubriques « rubriques restreintes » aux groupes créés : cette limitation d’accès peut s’appliquer soit dans la partie publique ET dans la partie privée, soit à l’une OU l’autre de ces parties séparément.

Les rubriques « à accès restreint » sont gérées automatiquement : dès qu’au moins un groupe contrôle une rubrique, cette dernière devient alors à « accès restreint » et elle est inaccessible pour les lecteurs n’appartenant pas à ce groupe. Inversement, si aucun groupe ne « contrôle » une rubrique, elle est accessible par tous les internautes.

Le fonctionnement du système de restriction d’accès est conçu de manière à ce que toutes les sous-rubriques d’une rubrique à accès restreint soient elles aussi restreintes : principe « d’héritage des restrictions ».

[v1.0] Ce plugin permet également qu’un admin général puisse créer des groupes en ayant la possibilité d’en « déléguer » ensuite la gestion à un admin restreint, ce qui correspond à une sorte de « changement de propriétaire » d’un groupe.

Un exemple de situation à gérer :

Pour mieux cerner le fonctionnement, voici le cahier des charges auquel cette contrib tente de répondre :

• un SPIP est installé sur le site d’un établissement scolaire (disons un lycée) pour permettre la publication de contenus élaborés par les profs et/ou les élèves.
• Ce SPIP comprend une rubrique par discipline (Anglais, Lettres, SVT...), tous les profs d’une discipline sont administrateurs de la rubrique de leur discipline afin qu’il puissent gérer/modérer les publications des élèves dans celle-ci. Tous les élèves sont rédacteurs dans ce SPIP, les parents peuvent avoir un compte visiteur.
• On souhaite que les profs d’une discipline puissent, s’ils le veulent, créer des sous-rubriques à accès réservé selon leurs besoins. Par exemple une sous-rubrique « travail en cours » dans laquelle ils pourront mettre au point ensemble les sujets de leurs prochains devoirs ou les corrections de ceux-ci. Il semble évident qu’il ne faut PAS que les élèves (comptes auteurs) aient un accès à cette sous-rubrique que ce soit dans la partie publique ou la partie privée !
• On veut également qu’il soit possible d’avoir des rubriques à accès réservé uniquement aux profs (comptes admins restreints) pour qu’ils puissent publier des infos qui ne concernent pas les élèves (documents administratif, comptes-rendus de réunions syndicales, préparation de projets pluridisciplinaires...).
• Il doit également être possible d’avoir des rubriques dans lesquelles les profs peuvent préparer des documents (par exemple les comptes-rendus des conseils de classe) qui seront accessibles une fois publiés (donc accès non-restreint dans la partie publique) mais confidentiels tant qu’ils sont en mode « en cours de rédaction » ou « proposé à l’évaluation » (donc accès restreint dans la partie privée).
• Il faudra aussi une rubrique dont l’accès est réservé à tous les utilisateurs inscrits dans l’établissement (profs = admins restreints + élèves = auteurs + parents = visiteurs) dans laquelle on mettra, par exemple, les emplois du temps qui ne seront donc pas visibles par les « extérieurs » à l’établissement.
• Enfin, il doit également être possible de créer des rubriques réservées :
  • aux élèves d’une classe (un groupe « classe »),
  • à plusieurs élèves et quelques profs, par ex le groupe « club informatique »
  • aux profs de 2 ou 3 disciplines (par ex« profs de sciences », cad les profs de SVT + Physique/Chimie + Maths). On obtient donc un groupe de groupes
  • ...
• l’administrateur général du spip doit également pouvoir créer des groupes dont il déléguera ensuite la gestion aux admins de rubriques
• avec comme circonstance aggravante que les admins généraux doient pouvoir « s’inviter » dans n’importe quel groupe pour consulter le contenu des rubriques à accès réservé.

Installation du plugin acces groupes :

[v1.0] Comme tous les plugins : récupérez le dernier zip à jour de cette contrib sur https://plugins.spip.net/accesgroup... ou sur le miroir http://miroirspip.ventre.name/build..., décompactez le et placez le dossier « acces_groupes » obtenu dans votre répertoire /plugins (à créer à la racine de votre spip si nécessaire), rendez vous sur l’interface de gestion des plugins (menu Configuration > Gestion des plugins), cochez le plugin « acces_groupes » et validez.

Vous devriez voir apparaître une icone supplémentaire dans le menu « auteur » pour les administrateurs (de rubriques et généraux) (merci à Litteul Kevin pour son icone nettement plus « classe » que mes pauvres bidouillages...)

Du point de vue de la base de données, ce plugin installe 3 tables supplémentaires : spip_accesgroupes_auteurs, spip_accesgroupes_acces et spip_accesgroupes_groupes, sachant que grâce au nouveau système de gestion des requètes MySQL par le core de spip 1.9 (« SPIP est grand et ses codeurs sont mes prophètes ! »), le préfixe ’spip’ sera automatiquement remplacé par le préfixe des tables que vous avez défini dans votre fichier /ecrire/mes_options.php (variable $table_prefix) si vous gérez plusieurs spip avec une seule base de données.

[*ATTENTION !!!*]

• ce plugin n’est PAS compatible avec le plugin « acces restreint » puisqu’il surcharge les mêmes fonctions que lui pour le filtrage des BOUCLES (affichage de l’espace public) : si celui-ci est actif, vous devez d’ABORD le désactiver (la vérification n’est pas gérée par le plugin) !!!
• Si vous procédez à une mise à jour depuis une version antérieure dans le cas ou votre spip serait passé de la version 1.8 (où vous utilisiez la version 0.7 ou 0.61 de la contrib originale) à la 1.9, vous devez d’ABORD procéder à la mise à jour des tables utilisées. Pour cela connectez vous sur le script /plugins/acces_groupes/maj_tables.php qui permet de « patcher » les tables à partir de celles de la version 0.7 ou 0.61. Ce script est extrèmement sommaire [1] et vous demandera de saisir les paramètres de connexion à votre base de données MySQL pour éviter que n’importe qui puisse le lancer. Une fois ce script joué, vous pouvez effacer le fichier maj_tables.php.

4. Fonctionnement obtenu lorsque l’on intègre ce plugin :

• pour un internaute qui n’est pas authentifié toutes les rubriques restreintes (ce qui inclus les sous rubriques, les articles, les brèves, les liens ...) seront [v1.0] invisibles à ce visiteur dans la partie publique.

• 

  pour un visiteur authentifié, seules les rubriques restreintes auxquelles il n’a pas accès (via son appartenance à un groupe ou son statut) seront invisibles.

• 

  pour les auteurs authentifié : idem les visiteurs pour la partie publique,

  

  en revanche pour la partie privée, les rubriques à accès restreint sont (pour l’instant !) visibles mais non accessibles.

• 

  pour les administrateurs de rubriques (« admin restreint ») : idem les auteurs SAUF pour les rubriques dont ils sont administrateurs. Pour ces rubriques, ils ont un accès dans la partie publique et la partie privée MEME s’ils n’appartiennent pas à un groupe autorisé à l’accès. Il paraissait en effet logique qu’un admin de rubrique ait forcément accès aux rubriques dont il à la gestion. Il peut également créer des groupes (ou utiliser des groupes existants) pour limiter l’accès aux rubriques qu’il administre et à leurs sous-rubriques. Il ne peut modifier que les groupes et sous-groupes qu’il a créé (= dont il est le « propriétaire »).

• 

  pour les administrateurs généraux (« admin général »), idem les auteurs mais ils peuvent accéder au gestionnaire de groupes pour modifier n’importe quel groupe et donc s’ajouter aux utilisateurs autorisés. Un admin général peut ainsi visiter/modérer une rubrique à accès restreint MAIS il deviendra alors visible dans la liste des utilisateurs autorisés, ce qui permet au « propriétaire » d’une rubrique restreinte (admin restreint) de savoir que l’admin général s’est « invité » dans sa rubrique.

Concernant l’intégration des statuts dans un groupe :

l’idée est la suivante : TOUS les utilisateurs du statut sélectionné sont membres du groupe. Cela implique qu’ils ont donc TOUS accès aux rubriques réservés à ce groupe.

Par exemple si un admin choisit de faire un groupe « tous les admins restreints » dans lequel il intègre le statut « Administrateurs » et qu’il donne l’accès à ce groupe pour la rubrique « le coin des admins », on aura comme résultat que tous les admins du SPIP (restreints ou généraux) peuvent accéder à cette rubrique mais que ni les visiteurs ni les auteurs ne pourront la visiter. Mais si l’administrateur le souhaite, il peut également intégrer l’auteur Toto dans ce groupe afin de lui permettre d’accéder aussi à cette rubrique.

L’interface de gestion des groupes et des rubriques restreintes :

• Pour rendre les chose plus faciles à apréhender (l’imbrication groupes/sous-groupe peut devenir complexe, les restrictions des rubriques multiples...), l’interface de gestion des groupes (exec=accesgroupes_admin) intègre :
  • l’affichage de la liste des groupes et des rubriques qu’ils contrôlent
  • l’arborescence des groupes/sous-groupes.

• 

  Chaque rubrique à accès restreint peut être configurée pour que la restriction porte soit sur la partie privée, soit sur la partie publique, soit sur les 2 (privé + public). Il est possible (pour un admin général ou pour un admin de rubrique dans une rubrique qu’il administre) de configurer une restriction d’accès sur une sous-rubrique d’une rubrique elle-même déja restreinte. Néanmoins, le principe « d’héritage des restrictions » d’une rubrique sur ses sous-rubriques impose les règles suivantes :

  • rubrique parent restreinte « privé + public » => sous-rubrique restreinte obligatoirement « privé + public »
  • rubrique parent restreinte « privé » uniquement => sous-rubrique restreinte « privé » ou « privé + public »
  • rubrique parent restreinte « public » uniquement => sous-rubrique restreinte « public » ou « privé + public »

• 

  Les administrateurs de rubriques ne peuvent modifier QUE les groupes qu’ils ont eux-même créés (= propriétaires). Cela permet de rester cohérent avec le fonctionnement de l’administration des rubriques : ils ne peuvent interdire l’accès qu’a l’intérieur de leurs rubriques. Ils peuvent utiliser des groupes créés par d’autres admins mais ne peuvent les modifier.

• 

  [v1.0] Pour simplifier la vie des admins de rubriques, un admin général peut créer un groupe, lui attribuer des rubriques en accès restreint puis transférer la « propriété » de ce groupe à un admin de rubrique : celui-ci pourra alors gérer ce groupe comme s’il l’avait créé lui même.

• 

  Chaque groupe peut être configuré pour permettre aux utilisateurs n’ayant pas le droit d’accès à une rubrique d’envoyer un message au propriétaire du groupe demandant leur intégration dans celui-ci. Cette situation va se rencontrer principalement dans l’espace privé (les rubriques restreintes étant visibles dans les listes de rubriques/sous-rubriques) mais également dans l’espace public pour un utilisateur qui suivrait un lien vers une rubrique protégée (si le squelette le prévoit, cf « Type de filtrage et squelette » ci-dessous).

  

  Ce paramètre permet d’afficher un formulaire de demande d’inscription dans le groupe lorsque l’utilisateur ne peut accéder à une rubrique. Ce message sera consultable par le propriétaire du groupe (si c’est un admin de rubrique) ou par n’importe quel admin général (si le groupe est créé par un admin général) dans la messagerie de l’interface privée, il comporte un lien direct vers l’interface de gestion du groupe concerné.

  

  Les auteurs en attente d’intégration sont listés dans cette interface et peuvent être intégrés ou rejetés en un clic.
  [v1.0] Lorsque le propriétaire du groupe aura rejeté ou accepté la demande d’inscription de l’auteur, le message de demande sera automatiquement effacé.

Type de filtrage et squelette :

[v1.0] Etant donné que ce plugin filtre directement les BOUCLES qui génèrent le contenu de l’espace public rendant invisibles celles qui sont restreintes pour un utilisateur non-authentifié, vous avez le choix entre 2 types de filtrages :

• Un filtrage fort : pas d’indication qu’un contenu existe mais qu’il n’est pas accessible (page 404 si un utilisateur non-autorisé essaye d’accéder directement au contenu d’une rubrique restreinte, par ex en suivant un lien ou un signet de son bookmark). Si vous ne souhaitez pas modifier votre squelette, c’est cette solution qui sera retenue par défaut.

Pour rendre les choses plus ergonomiques, vous devriez donc avoir un lien ’S’identifier’ générique sur tout le site, qui permet aux personnes habilitées de se connecter pour accéder au contenu. Pour cela utilisez par exemple la balise #LOGIN_PUBLIC (cf cet article de spip-contrib pour plus d’infos).

• 

  Un filtrage avec information : si l’internaute essaye d’accéder au contenu d’une rubrique restreinte alors il se retrouve sur une page l’informant qu’il est nécessaire de s’identifier pour accéder au contenu. Si une fois connecté il ne fait pas partie des utilisateurs autorisés, alors il aura éventuellement le formulaire de demande d’intégration au groupe (selon la config du groupe, cf paragraphe précédent).

  

  Pour obtenir ce fonctionnement vous disposez des filtres « accesgroupes_article_restreint », « accesgroupes_rubrique_restreinte » et « accesgroupes_breve_restreinte » qui vous permettent d’intégrer dans vos squelettes des pages « article.html », « rubrique.html » ou « breve.html » le formulaire de #LOGIN_PUBLIC (si l’utilisateur n’est pas connecté) ou (selon config) le formulaire de demande d’accés.

Pour réaliser cette intégration dans ces pages, il vous suffit de rajouter aux BOUCLES principales de ces pages le code suivant (exemple pour la page article.html) :

<!-- fin du fichier = fin de la boucle générale de la page -- >
</BOUCLE_article_principal>

<!-- code à rajouter -- >
[(#ID_ARTICLE|accesgroupes_article_restreint|?{' ',''})<INCLURE{fond=inc_accesgroupes_login}{skel=#CHEMIN{inc_accesgroupes_login}}>]

<//B_article_principal>

Comme le montre le code ci-dessus, vous ajoutez donc à la BOUCLE_article_principal (celle qui englobe TOUTE la page) une condition en cas de retour vide (cad en principe affichage de la page 404 : « page non trouvée ») qui permet d’INCLURE le fichier inc_accesgroupes_login.html (situé à la racine du répertoire /plugins/acces_groupes) dans le cas où l’absence de page est due à une restriction d’accès et non pas à une page vraiment absente.

La page inc_accesgroupes_login.html livrée avec le plugin est (volontairement) dépouillée, ce qui vous laisse la possibilité de la « customiser » selon vos goûts et votre charte graphique.

Fonctionnement du plugin :

Les filtrages des parties publiques et privée reposent sur 2 principes différents (pour l(instant !) :

• Pour la partie privée, peu de modifications par rapport aux versions précédentes de cette contrib : on vérifie dans les pages de gestion des articles (exec=articles et exec=articles_edit) , rubriques (exec=naviguer et exec=rubriques_edit) et breves (exec=breves_voir et exec=breves_edit) si l’élément dont on affiche la page id_article=xxx par ex) fait partie d’une rubrique à accès restreint (en fonction de l’id_auteur et de son appartenance aux groupes/statuts) et si c’est le cas on envoie le message de restriction d’accès : jusque là rien de bien compliqué...
• [v1.0] Pour la partie publique les choses se compliquent puisqu’il faut gérer le cache... Et pour « rendre à César ce qui appartient à César » il me faut ici remercier Cedric Morin pour son système de filtrage mis au point pour le plugin « accès retreint » qui permet de surcharger directement les requêtes SQL des BOUCLES de spip. Cela permet donc d’exclure des résultats renvoyés par la base de données tous les éléments appartenant à une rubrique à laquelle l’utilisateur n’a pas accès (soit il n’est pas connecté, soit il ne fait pas partie d’un groupe autorisé). Ce code est bien évidemment adapté au fonctionnement par groupe (alors que le plugin "accès restreint fonctionne par zones) mais reste le même dans son principe de filtrage. Je cite donc textuellement l’explication donnée par l’inventeur de ce système cf doc du plugin Accès restreint :

« L’intérêt de cette démarche, c’est qu’elle fonctionne sur toutes les boucles, donc tout le site se trouve instantanément sécurisé sans aucune modification de squelette. Il n’y a pas de risque d’oublier un morceau.

Ce plugin nous garantie l’absence de fuite liée a de nouvelles fonctionnalités de SPIP (comme les modèles de 1.9.1 qui seraient une belle faille pour ceux qui sécuriseraient du contenu au moyen des squelettes).

Le principe même de fonctionnement du plugin acces-restreint est de ’supprimer’ du résultat des boucles tout ce que le visiteur n’a pas le droit de voir. Ainsi les zones à accès réservées sont invisibles pour qui n’y est pas habilité.

N’ayez donc aucune crainte en ce qui concerne les robots, les moteurs de recherche, ou les fichiers de backend. Le filtre est infaillible.

Ce principe de fonctionnement permet au plugin de filtrer le contenu publié sans modification du squelette. Cela permet aussi d’avoir des menus (liste de rubriques) cohérents avec le contenu effectivement accessible. Bref c’est un parti pris, qui fait son efficacité même. »

Donc vous pouvez dormir sur vos deux oreilles : pas de fuites possibles !

Du point de vue du cache, pour minimiser son volume tout en obligeant le recalcul des pages selon les droits de l’utilisateur, (et en utilisant un principe toujours pompé sur le plugin accès restreint !), il sera créé un fichier de cache par combinaison de rubriques interdites : donc si un utilisateur affiche une page, celle-ci sera tirée du cache correspondant au groupe de rubriques auxquelles il a accès, ainsi là également, pas de risque d’indiscrétions.

Outils à disposition pour les squelettes :

[v1.0.2]Selon le type de site utilisant ce plugin il peut apparaître le besoin de vouloir afficher une liste intégrale des rubriques (ou articles, brèves) c’est à dire y compris les éléments à accès restreint qui sont normalement invisibles. La version [1.0.2] intègre donc le critère tout_voir qui permet de réaliser cela [2].

De façon complémentaire, si on utilise ce critère il est utile de pouvoir « marquer » par une icone les titres des éléments à accès restreints : le filtre |accesgroupes_visualise, utilisable sur les #BALISEs des boucles ARTICLES, RUBRIQUES ou BREVES, permet d’ajouter une icone (par défaut cadenas-24.gif) devant la balise si l’élément fait partie d’une rubrique à accès restreint.

Exemple typique d’utilisation de ce critère et du filtre : modification du fichier inc-rubriques.html qui fait le menu latéral des rubrique de la dist :

<B_rubriques>
<div class="rubriques">
   <h2 class="menu-titre"><:rubriques:></h2>
   <ul>
     <BOUCLE_rubriques(RUBRIQUES) {racine} {par num titre, titre}{tout_voir}>
     <li>
       <a href="#URL_RUBRIQUE"[ class="(#EXPOSE)"]>[(#TITRE|couper{80}|accesgroupes_visualise{#ID_RUBRIQUE})]</a>
       <B_sous_rubriques>
          <ul>
            <BOUCLE_sous_rubriques(RUBRIQUES) {id_parent} {par num titre, titre}{tout_voir}>
            <BOUCLE_test_expose(RUBRIQUES) {id_enfant}{tout_voir}>#EXPOSE{' '}</BOUCLE_test_expose_total>
            <li><a href="#URL_RUBRIQUE"[ class="(#EXPOSE)"]>[(#TITRE|couper{80}|accesgroupes_visualise{#ID_RUBRIQUE})]</a>
              <BOUCLE_re(BOUCLE_sous_rubriques){tout_voir}></BOUCLE_re>
            </li>
            </B_test_expose>
            </BOUCLE_sous_rubriques>
          </ul>
       </B_sous_rubriques>
     </li>
     </BOUCLE_rubriques>
   </ul>
</div>
</B_rubriques>

Remarque : le paramètre #ID_RUBRIQUE du filtre accesgroupes_visualise est obligatoire !

Si l’image (cadenas) utilisée ne vous plait pas, ce filtre vous offre la possibilité de choisir un autre fichier image en passant le nom de ce fichier en second paramètre du filtre. Exemple pour utiliser le fichier cadenas-petit.png placée dans le répertoire /img de votre dossier de squelette :

[(#TITRE|couper{80}|accesgroupes_visualise{#ID_RUBRIQUE, #CHEMIN{img/cadenas-petit.png}})]

Ce qu’il reste à faire :

• Ainsi que je le mentionne par 2 fois plus haut, l’idée pour la suite des développements est de réaliser un filtrage complet de l’espace privé afin que, comme pour l’espace public, un utilisateur ne voit que les rubriques auxquelles il à accès. Cela concernerait donc la liste des rubriques affichées dans la page d’accueil de /ecrire, les sous-rubriques affichées dans /exec=naviguer, les rubriques et articles affichés dans /exec=articles_tous, le navigateur rapide de rubriques du bandeau et surtout le mini-navigateur ajax de choix de la rubrique lors de la création d’un article ou d’une sous-rubrique (afin d’empécher un auteur de créer un article dans une rubrique à laquelle il n’a pas accès, ce qui, dans cette version, l’empèche ensuite d’y accéder dès qu’il l’a enregistré une fois).
• comme suggéré dans ce message du forum, la prochaine version devrait intégrer des groupes basés sur l’adresse IP du poste connecté (groupe = plages d’adresses IP)
  Cela permettra de gérer des restrictions d’accès différents selon que l’accès au spip se fait depuis l’intranet ou internet ou selon le sous-réseaux de l’intranet etc...

Pour cette partie, soyez patients : on y travaille !

• comme suggéré par le forum public de la version précédente de cette contrib on pourrait aussi imaginer :
  • que les restrictions d’accès puissent s’appliquer au niveau des articles (et pas seulement au niveau des rubriques)
  • que les groupes puissent êtres récupérés à partir d’un LDAP

Pour ces 2 points, on y travaille PAS mais toutes les bonnes volontées sont les bienvenues... et comme pour beaucoup d’autres plugins, afin de faciliter le developpement collaboratif, vous trouverez l’ensemble des fichiers en cours sur le SVN de spip-zone !

• et, bien sûr, toutes les traductions du fichier de langue sont également les bienvenues (le fichier accesgroupes_en.php livré avec cette version est super incomplet...)