Exécuter une fonction quelle que soit la route

Version imprimable

27/07/2011, 13h42
Manuk

Exécuter une fonction quelle que soit la route

Bonjour tout le monde,

Je débute avec SF2 et je me pose la question suivante :
Comment peut-on faire pour executer une fonction à chaque fois qu'une page (une route) est affichée.

Par ex : Enregistrer l'ip d'un user et l'heure d'ouverture de session (qu'il arrive sur n'importe quelle page)

1/ L'utilisateur arrive sur example.com/foor/bar
2/ Une session est ouverte et il n'a pas encore été logué
3/ On logue son ip et l'heure via un bundle (persist en DB)
4/ On indique en session qu'il a été logué
5/ On continue l'exécution classique de la route foo/bar
6/ L'utilisateur clique sur un lien example.com/anotherfoo
7/ On check en session et on constate qu'il a été logué, on zappe donc l'enregistrement de l'ip et de l'heure
8/ On continue l'exécution classique.

Dans un deuxième temps, ce serait bien de ne pas loguer les utilisateurs inconnus si ils arrivent par example sur des url contenant /xml ou d'autres termes prédéfinis.

D'avance merci pour vos conseils.
Je n'ai pas encore écrit de code pour cette fonctionnalité étant donné que je ne sais pas par ou commencer ... mis a part la création d'un bundle qui ferait l'enregistrement.
27/07/2011, 13h46
pc.bertineau

si tu souhaites exécuter ce traitement à chaque fois qu'un user est loggé, tu dois déclarer un AuthenticationSuccessHandler et le brancher sur le SecurityBundle.
27/07/2011, 13h58
Manuk

@pc.bertineau

Quand je dis "loggé" je veux dire par la que sa visite est enregistrée en DB (ip & heure). Pas qu'il est authentifié par login/pass.

L'inconnue pour moi est de savoir commet et surtout ou effectuer une telle action pour ne pas répéter la vérification et l'enregistrment (si nécessaire) dans chacun de mes controleurs.
Quand je suis dans le controleur, il est déjà trop tard. J'aimerais effectuer l'action de logging en DB avant d'être branché sur un controleur.

Salut,

Ce que tu cherches à faire est très simple.

Construit un service avec une méthode qui fait ce que tu veux. Puis dans la définition du service dans ta configuration, rajoute le tag kernel.event_listener, et tu dois écouter sur l'événement kernel.controler (juste avant que le controleur ne s'exécute).

Un exemple de la définition de ton service pourrait être :
Code:

1 2 3 4 5 asso_am.asso_selector: class: Asso\AMBundle\Listener\AssoSelectorListener arguments: [@session, @security.context, @router] tags: - { name: kernel.event_listener, priority: -256, event: kernel.controller, method: onKernelController }
Tu l'as compris, la méthode de ton service qui est exécutée lors de l'événement est onKernelControler (comme défini à la dernière ligne).

@winzou

Merci !

Grâce à ton exemple et à la doc de Symfony, j'ai pu avancer d'un pas mais il me reste encore quelques inconnues.

Voici ce que j'ai fait :

Dans Logging/UserBundle/Ressources/Config/services.yml
Code:

1 2 3 4 5 6 7 8 9 parameters: logging_user.class: Logging\UserBundle\ControllerListener services: logging_user.example: class: %logging_user.class% arguments: [@session, @security.context, @router] tags : - { name: kernel.event_listener, event: kernel.controller, method: onKernelController }
Et dans Logging/UserBundle/ControllerListener
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 namespace Logging\UserBundle; use Symfony\Component\EventDispatcher\Event; use Symfony\Component\HttpKernel\HttpKernelInterface; use Symfony\Component\HttpKernel\Event\FilterControllerEvent; use Logging\UserBundle\Entity\User; class ControllerListener { protected $session; protected $securitycontext; protected $router; public function __construct($session, $securitycontext, $router) { $this->session = $session; $this->securitycontext = $securitycontext; $this->router = $router; } public function onKernelController() { $usertoken = $this->session->get('token'); if(empty($usertoken)) { $user = new User(); $user->setIp('192.168.1.10'); $this->session->set('token', sha1($user->getIp())); } } }
Dans le profiler, je vois bien que onKernelController est appelée et que la variable 'token' existe bien en session, donc on passe bien par là, c'est cool ;)

Il me reste les points d'interrogations suivants :
(j'ai cherché dans la doc et sur le net mais ... :cry: )

1/Comment récupérer l'ip du client ?
L'ip se trouve dans la Request mais comment y accéder ?
J'ai tenté de rajouter @request dans les params yml mais j'ai une erreur.

2/Comment récupérer l'entitymanager pour pouvoir persister mon $user en DB ?

3/ Ai-je vraiment besoin de security.context et router ?

28/07/2011, 15h12
winzou

Mon code était un exemple, tu peux le personnaliser à souhait ;)

arguments: [@doctrine.entity_manager, @request]

T'as quoi comme erreur quand tu mets request ? Une histoire de scope ? J'ai plus la syntaxe sous la main, mais il faut rajouter scope: request dans la définition de ton service, enfin qqch comme ca.

Pour l'ip elle se trouve dans les server parameters de la requete, essaie $request->server->get('REMOTE_ADDR') ?

@winzou

Un grand merci, tu cartonnes ! :ccool:

Oui j'avais un souci de scope lorsque je rajoutais "request" dans les arguments... et il faut effectivement rajouter scope: request dans la définition.

Existe t-il une liste des arguments symfony que l'on peut passer ?

Si ca peut aider des devs, voici le code.

Dans Logging/UserBundle/Ressources/Config/services.yml

Code:

1
2
3
4
5
6
7
8
9
10
parameters:
    logging_user.class: Logging\UserBundle\ControllerListener
 
services:
    logging_user.example:
        class: %logging_user.class%
        arguments: [@session, @doctrine.orm.entity_manager, @request]
        scope: request
        tags :
          - { name: kernel.event_listener, event: kernel.controller, method: onKernelController }

Et dans Logging/UserBundle/ControllerListener

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
namespace Logging\UserBundle;
 
use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
use Logging\UserBundle\Entity\User;
 
 
class ControllerListener
{
 
    protected $session;
 
    protected $entitymanager;
 
    protected $request;
 
 
    public function __construct($session, $entitymanager, $request)
    {
        $this->session =       $session;
        $this->entitymanager = $entitymanager;
        $this->request =       $request;
    }
 
    public function onKernelController()
    {
        $usertoken = $this->session->get('token');
        if(empty($usertoken))
        {
            $user = new User();
            $user->setIp($this->request->getClientIp());
            $user->setUrl($this->request->getUri());
            $this->entitymanager->persist($user);
            $this->session->set('token', $user->getToken());
            $this->entitymanager->flush();
         }
    }
}