Gérer sans sfGuard une ouverture de session utilisateur au sein d'une application Web avec Symfony.

Jeremie Engel — Tue, 04 Dec 2007 09:18:00 +0100

Voici un tutorial pas à pas pour gérer une ouverture de session utilisateur au sein d'une application Web avec Symfony. De la création de la table dans la base de données au template HTML, normalement, tout y est pour pouvoir le reproduire sans difficultés.

Créer la table dans la base de données
Saisir le schema de la base dans le fichier /config/schema.yml
Paramétrer symfony pour qu'il puisse se connecter à votre base de données
Construire les classes associées à la table users dans l'arborescence de fichiers de Symfony.
Créer les modules et les controllers de l'application
Créer la page HTML qui proposera l'ouverture de session à l'utilisateur.
Travailler sur le fichier myUser.php
Configurer le controller
Ajouter un filtre pour identifier automatiquement l'utilisateur dans une session ouverte

Dans le cadre de ma découverte de Symfony, je me suis d'abord attaché à développer un système d'authentification des utilisateurs. Grâce à leurs noms d'utilisateur et leur mots de passe, les utilisateurs s'identifient pour accéder à des espaces personnels. Dans cette présentation, je me focalise uniquement sur la procédure d'authentification que je présente en pas à pas.

Créer la table dans la base de données qui gérera les utilisateurs.

Dans mon cas j'utilise Postgresql mais la même définition de table se fait sans problème avec n'importe quel SGBD.

 CREATE TABLE "public"."users" (
 "id" SERIAL, 
 "login" VARCHAR(30) NOT NULL, 
 "password" VARCHAR(20) NOT NULL, 
 CONSTRAINT "user_pkey" PRIMARY KEY("id")
 ) WITH OIDS;

Saisir le schema de la base dans le fichier `/config/schema.yml`

 propel:
   users:
     _attributes: { phpName: User }
     id:
     login:              varchar(30)
     password:           varchar(20)

Attention de ne pas mettre de tabulation et de bien utiliser des espaces.

Paramétrer symfony pour qu'il puisse se connecter à votre base de données

Pour cela saisissez les informations de connexion à votre base de données dans le fichier /config/databases.yml

 all:
   propel:
     class:          sfPropelDatabase
     param:
       dsn:          pgsql://login:pass@serveur/votrebase

Construire les classes associées à la table `users` dans l'arborescence de fichiers de Symfony.

 symfony propel-build-model

Vérifiez bien que vous avec l'info BUILD FINISHED à l'issue de la construction, dans le cas contraire, vérifiez bien la saisie du fichier schema.yml et recommencez la commande symfony propel-build-model

A l'issue de la construction, vous devez avoir les fichiers suivants :

 /lib/model/map
 /lib/model/om
 /lib/model/UserPeer.php -> Gère les collections d'utilisateurs
 /lib/model/User.php -> Classe correspondant à un utilisateur

Voilà, à cette étape, Symfony est prêt à recevoir le code pour gérer l'authentification des utilisateurs.

Créer les modules et les controllers de l'application

Il s'agit là de doter l'application des controllers qui gèreront la fonctionnalité. Dans mon cas, j'ai créé un module main pour la page par défaut de l'application et un module register qui se chargera de réceptionner les action d'ouverture et de fermeture de de session. Dans le répertoire racine de votre projet, il s'agit de saisir les commandes :

 symfony init-module main
 symfony init-module register

Sans oublier d'indiquer à Symfony que le controller par déaut est maintenant main. Ainsi le fichier /apps/frontend/config/routing.yml doit présenter les informations suivantes :

 homepage:
   url:   /
   param: { module: main, action: index }

Créer la page HTML qui proposera l'ouverture de session à l'utilisateur.

Dans cet exemple, le formulaire est directement implémenté dans la page d'accueil du site. Ainsi le fichier /apps/frontend/modules/main/templates/indexSuccess.php présente les données suivantes :

 <p align="center">
 Utilisateur ID : <?php echo  $this->getContext()->getUser()->getAttribute('user_id'); ?><br />
 Utilisateur AUTH : <?php echo ($this->getContext()->getUser()->isAuthenticated())?'oui':'non'; ?><br />
 <?php echo form_tag('register/login') ?>
 Username  : <?php echo input_tag('login'); ?><br />
 Password  : <?php echo input_tag('password'); ?><br />
 <?php echo submit_tag('Login'); ?>
 </form>
 <a href="http://blog.visuaweb.com/index.php/post/2007/12/04/<?php echo url_for('register/logout'); ?>">Logout</a>
 </p>

On remarque que l'action d'ouverture de session est orienté vers le module register avec l'action login et que l'action de fermeture est orientée vers le même module avec l'action logout.

Travailler sur le fichier myUser.php

Dans le cadre de Symfony, le fichier /apps/frontend/lib/myUser.php a une importance toute particulière, il s'agit de la classe qui une fois instanciée et retournée par la méthode $this->getUser() d'un controller par exemple. C'est dans cette classe que l'implémentation des méthodes d'ouverture et de fermeture de session va être implémentée. Ainsi, il s'agit de définir 2 méthodes pour la tentative d'ouverture de session et la fermeture de celle-ci :

 class myUser extends sfBasicSecurityUser
 {
 	public $user = null;
 
 	public function tryLogin($login, $password) {
 		$c = new Criteria(); 
 		$c->add(UserPeer::LOGIN, $login);
 		$c->add(UserPeer::PASSWORD, $password);
 		$this->user = UserPeer::doSelectOne($c);
 		if ($this->user) {
 			$this->setAuthenticated(true);
   		$this->setAttribute('user_id', $this->user->getId());	
 			return true;
 		}
 		return false;
 	}
 	
 	public function Logout() {
 		if ($this->isAuthenticated()) {
 			$this->getAttributeHolder()->remove('user_id');
 			$this->setAuthenticated(0);
 		}
 	}
 	
 }

Dans cette classe, un attribut $user est définit. Cette attribut recevra une instance de la classe User précédemment créée correponsant aux données de l'utilisateur en base de données.

Configurer le controller

Il s'agit maintenant de configurer le controller register. Le fichier /apps/frontend/modules/register/actions/actions.class.php doit présenter le code suivant :

 class registerActions extends sfActions
 {
   /**
    * Executes index action
    *
    */
   public function executeIndex()
   {
     $this->forward('default', 'module');
   }
 
   public function executeLogin() {
	 $this->getUser()->tryLogin($this->getRequestParameter('login'), $this->getRequestParameter('password'));  
   	$this->forward('main', 'index');
 }
 
 	public function executeLogout() {
 		$this->getUser()->Logout();
 		$this->forward('main', 'index');
 	}
 }

A ce stade, l'authentification utilisateur fonctionne. Seul le problème de l'initialisation de l'utilisateur au sein d'une session ouverte reste à solutionner. Pour cela plusieurs méthodes existent. J'ai choisis d'utiliser les Filtes de Symphony qui permettent en amont et en aval de l'appel des controllers de réaliser des traitements.

Ajouter un filtre pour identifier automatique l'utilisateur dans une session ouverte

Il s'agit là de créer un fichier /lib/zGlobalUserAuthFilter.php qui contient le code suivant :

 class zGlobalUserAuthFilter extends sfFilter {
 	public function execute($filterChain) {
     // Execute this filter only once
 	  if ($this->isFirstCall()) {
 	  	$user = $this->getContext()->getUser();
 	  	if ($user->isAuthenticated()) {
 	  		$c = new Criteria();
 				$c->add(UserPeer::ID, $user->getAttribute('user_id'));
 				$user->user = UserPeer::doSelectOne($c);
 
 	  	}
 	  }
     // Execute next filter
     $filterChain->execute();
   }
 
 }

et de déclarer le filtre dans le fichier /apps/frontend/config/filters.yml

 rendering: ~
 web_debug: ~
 security:  ~
 
 # generally, you will want to insert your own filters here
 zUserAuth:
   class: zGlobalUserAuthFilter
   
 cache:     ~
 common:    ~
 flash:     ~
 execution: ~

C'est terminé !

Vous n'avez plus qu'à attaquer votre serveur web, créer un utilisateur dans votre base de données et de vous identifier dans l'appli web. Il s'agit du minimum pour pouvoir gérer une ouverture de session utilisateur. A partir de ce cadre, il s'agit d'enrichir le code pour gérer par exemple les problèmes d'ouverture de session (mauvais login/pass) ou encore gérer l'expiration de la session. Mais mon intention était juste de présenter le gabarit fonctionnel.

Si une méthode plus élégante existe, je suis preneur :)

VisuaBlog - symfony sfGuard