Le driver jAcl2.db ne fonctionne qu'avec une base de données. Il vous faut donc configurer une connexion de base de données, et créer les tables nécessaires.

Configuration de la connexion ¶

default = foo
jacl_profile= acl2

[foo]
driver="mysql"
database="jelix"
host= "localhost"
user= "jelix"
password= "jelix"
persistent= on
force_encoding=true

[acl2]
driver="mysql"
database="droits"
host= "localhost"
user= "jelix"
password= "xilej"
persistent= on
force_encoding=true

Création des tables ¶

La configuration se fait au moyen de commandes du script jelix en ligne de commande. Ouvrez donc un terminal et placez-vous dans le répertoire lib/jelix-scripts.

$  cd lib/jelix-scripts/        # sous linux
$  cd lib\jelix-scripts\        # sous windows

(note : $ représente l'invité de commande).

Mémorisez ensuite le nom de votre appli dans la variable d'environnement JELIX_APP_NAME :

$  export JELIX_APP_NAME="myapp"        # sous linux
$  set JELIX_APP_NAME=myapp             # sous windows

Dans la suite, il faut exécuter le script jelix.php. Rappelez-vous que l'on fait comme ceci, en appelant php :

$  php jelix.php une_commande argument argument argument...

Sous linux, vous avez un script bash qui facilite un peu les choses :

$  ./jelix une_commande argument argument argument...

Il y a deux commandes pour configurer jAcl2.db : acl2group et acl2right. Chacune prenant en argument un nom de "sous-commande" suivi de 0 à n arguments suivant la sous commande.

Dans le système de droits, vous devez déterminer des "sujets" représentant une valeur de droit.

Imaginons que l'on veuille créer des droits sur les articles d'un CMS, les différents droits seraient : READ, LIST, CREATE, DELETE, UPDATE. Autrement dit :

• "cms.articles.read",
• "cms.articles.list",
• "cms.articles.create",
• "cms.articles.delete",
• "cms.articles.update",

On peut d'abord lister les sujets déjà existants :

$ php jelix.php acl2right subject_list

Au départ, vous devriez obtenir une liste vide :

----Liste des sujets

id			label key
--------------------------------------------------------

Un sujet est représenté par une valeur de droit et une clé de locale qui indiquera son label (clé que vous devrez enregistrer dans un fichier de locale).

Créons nos sujets :

$ php jelix.php acl2right subject_create "cms.articles.create" "cms~acl2.articles.create"
$ php jelix.php acl2right subject_create "cms.articles.update" "cms~acl2.articles.update"
$ php jelix.php acl2right subject_create "cms.articles.delete" "cms~acl2.articles.delete"
$ php jelix.php acl2right subject_create "cms.articles.list" "cms~acl2.articles.list"
$ php jelix.php acl2right subject_create "cms.articles.read" "cms~acl2.articles.read"

Si vous n'utilisez pas de module qui permette de gérer les droits, alors la clé de locale n'est pas indispensable. Mettez alors la chaîne que vous voulez.

À l'exécution de la commande, vous obtenez :

----Création d'un sujet

OK

Quand une commande acl2 se passe bien, il y a toujours le message OK. On peut le vérifier en listant à nouveau les groupes :

$ php jelix.php acl2right subject_list
----Liste des sujets

id			label key
--------------------------------------------------------
cms.articles.create	cms~acl2.articles.create
cms.articles.delete	cms~acl2.articles.delete
cms.articles.list	cms~acl2.articles.list
cms.articles.read	cms~acl2.articles.read
cms.articles.update	cms~acl2.articles.update

Sachez que vous pouvez supprimer un sujet en faisant :

$ php jelix.php acl2right subject_delete  <nom du sujet>

Table concernée ¶

La déclaration d'un droit, nécessite un couple sujet/groupe d'utilisateur. Nous devons donc créer un groupe d'utilisateurs. La gestion des groupes d'utilisateurs se fait au moyen de la commande acl2group.

Créons par exemple un groupe de rédacteurs.

$ php jelix.php acl2group  create "rédacteurs"

Le message OK s'affiche, avec l'identifiant du nouveau groupe (ici 1) :

----Création d'un nouveau groupe

OK. Group id is: 1

Nous allons en créer un deuxième, en indiquant avec l'option -defaultgroup que l'on veut que ce soit un groupe par défaut, c'est à dire dans lequel sera mis tout nouvel utilisateur.

$ php jelix.php acl2group -defaultgroup create "lecteurs"

On peut lister les groupes avec la sous-commande list :

$ php jelix.php acl2group  list
----Liste des groupes d'utilisateurs

id      label name              default
--------------------------------------------------------
2       lecteurs                yes
1       rédacteurs

On peut changer le statut "default" plus tard, avec la sous-commande setdefault, en indiquant l'identifiant du groupe (ou son nom) :

$ php jelix.php acl2group setdefault 1 true
ou
$ php jelix.php acl2group setdefault 1 false
ou encore
$ php jelix.php acl2group setdefault lecteurs true

Il est aussi possible de changer le nom du groupe :

$ php jelix.php acl2group changename 1 "super rédacteurs"

Ou encore d'effacer un groupe d'utilisateur :

$ php jelix.php acl2group delete "super rédacteurs"

Tables concernées ¶

Dans ces groupes, vous allez indiquer des utilisateurs. Pour ajouter un utilisateur, vous devez d'abord déclarer l'utilisateur dans le système jAcl2.

$ php jelix.php acl2group createuser laurent

Cela déclare l'utilisateur Laurent, et un groupe privé lui est crée.

Ensuite, vous pouvez l'ajouter à des groupes. Il faut utiliser la sous-commande "adduser" et le numéro du groupe (ou son nom).

$ php jelix.php acl2group adduser lecteurs laurent

Pour retirer un utilisateur :

$ php jelix.php acl2group removeuser lecteurs laurent

Enfin, pour avoir la liste des utilisateurs d'un groupe :

$ php jelix.php acl2group userslist lecteurs

Ou tout les utilisateurs de tout les groupes :

$ php jelix.php acl2group alluserslist

Tables concernées ¶

Puisque nous avons maintenant tout ce qu'il faut pour définir des droits, définissons-en. On utilise la commande acl2right.

Déjà, pour les lecteurs, on va dire qu'ils peuvent lire et lister les articles. On va donc assigner les sujets "cms.articles.list" et "cms.articles.read" au groupe des lecteurs dont l'identifiant est 2 :

$ php jelix.php acl2right add  2 "cms.articles.list"
$ php jelix.php acl2right add  2 "cms.articles.read"

Vérifions la liste des droits définis au moyen de la sous-commande list :

$ php jelix.php acl2right list
----Liste des droits

group	subject		resource
---------------------------------------------------------------
- anonymous group

- group lecteurs (2)
	cms.articles.list
	cms.articles.read
		

Passons maintenant au groupe rédacteur. On va leur donner tous les droits sur le sujet cms.articles.

$ php jelix.php acl2right add  1 "cms.articles.list"
$ php jelix.php acl2right add  1 "cms.articles.read"
$ php jelix.php acl2right add  1 "cms.articles.create"
$ php jelix.php acl2right add  1 "cms.articles.delete"
$ php jelix.php acl2right add  1 "cms.articles.update"

On vérifie :

$ php jelix.php acl2right list
----Liste des droits

group   subject value           resource
---------------------------------------------------------------
- group lecteurs (2)
	cms.articles.list
	cms.articles.read
- group rédacteurs (1)
	cms.articles.create
	cms.articles.delete
	cms.articles.list
	cms.articles.read
	cms.articles.update

Imaginons qu'on veuille donner toutefois aux lecteurs le droit de modifier l'article "opinions", on crée alors un droit sur la ressource "opinions", en indiquant l'identifiant de cette ressource en dernier paramètre à la sous-commande add :

$ php jelix.php acl2right add  2 "cms.articles.update" "opinions"

On vérifie :

$ php jelix.php acl2right list
----Liste des droits

group   subject value           resource
---------------------------------------------------------------
- group lecteurs (2)
	cms.articles.list
	cms.articles.read
	cms.articles.update
		opinions

- group rédacteurs (1)
	cms.articles.create
	cms.articles.delete
	cms.articles.list
	cms.articles.read
	cms.articles.update

On peut aussi retirer un droit avec la sous-commande remove, en indiquant, comme pour la sous-commande create, le groupe d'utilisateur et le sujet (plus éventuellement la ressource si on a une ressource).

Exemple, on change d'avis à propos de l'article "opinions" (il y a vraiment trop de spam :-) ) :

$ php jelix.php acl2right remove  2 "cms.articles.update" "opinions"

Une fois tous les droits établis, l'application peut fonctionner selon vos règles, et les modules peuvent faire appel à l'API de jAcl2 pour agir en fonction des droits que vous avez configuré.

Table concernée ¶