Login event listener in Symfony2

Login event listener in Symfony2

So you have a Symfony2 project under construction. Login works. Now you want to execute some code right after the user successfully logs in.

The solution: Make a custom event listener.

An event listener is actually a service with a proper tag associated with it. So first step is to register the listener. The configuration file shown corresponds to the listener in file Acme/UserBundle/Listener/LoginListener.php. You can read more about services here.

In services.yml:

Let’s go through the configuration.

class defines the listener class.

With arguments we inject services that this listener depends on. In this case the security.context service for retrieving the User object and doctrine service for EntityManager.

tags is important. Every listener must be tagged with kernel.event_listener and must specify it’s event. For successful login that event is security.interactive_login. You can also specify the optional method tag.

Ok, our listener is registered. Let’s create it.

The above code should be pretty self-explanatory. The only required method is onSecurityInteractiveLogin(InteractiveLoginEvent $event). You do not need the other stuff, but you probably will if you want to modify the User object, or something else in the DB.

29 Responses so far.

  1. Ruben de Vries says:
    August 5, 2011 at 14:23

    Thanks for the snippets, really helped me out a lot 🙂

    Reply
  2. Ivo Azirjans says:
    January 6, 2012 at 15:37

    Easy. Thanks!

    Reply
  3. Sergio Bastias says:
    January 14, 2012 at 08:43

    This is MISTAKEN – you need to put the ->getUser() in the onSecurityInteractiveLogin function. Otherwise, the user isn’t logged in yet!

    Reply
  4. Metod says:
    January 15, 2012 at 16:24

    Updated. 😉

    Reply
  5. Dattaya says:
    January 20, 2012 at 12:32

    I’ve got user object this way: $user = $event->getAuthenticationToken()->getUser();
    (sf2.0.9)

    Reply
  6. bnlab says:
    January 26, 2012 at 02:00

    thanks for this simple but powerful tuti!

    Reply
  7. Flo says:
    March 8, 2012 at 15:25

    Thanks for the snippets.

    But how to get the container to do this:

    $this->container->get(‘request’)->getSession->setFlashes(‘message’, ………..);

    Thanks

    Reply
  8. Metod says:
    March 11, 2012 at 11:32

    You should add a new dependency to the service: @session

    Then you can get it in the constructor and do what you need. 🙂

    Reply
  9. Paolo says:
    March 15, 2012 at 21:33

    Great tutorial

    Is possible to do the same with logout action ?

    Thanks again

    Reply
  10. Thierry says:
    August 21, 2012 at 16:06

    Hi,
    With sf2.1, i think one use must be updated :
    use Doctrine\Bundle\DoctrineBundle\Registry as Doctrine;

    Thanks for the article.

    Reply
  11. Metod says:
    August 24, 2012 at 12:43

    You are correct. Thanks, will update. 🙂

    Reply
  12. Norbert Kéri says:
    October 10, 2012 at 16:50

    This is the first time I encounter this security.interactive_login event, is this documented somewhere? Or is there some place in the docs where all the events are listed?

    Reply
  13. Metod says:
    October 13, 2012 at 12:18

    I haven’t found a page where all events would be documented yet. I think I found this event in the source code of the Security component.

    https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Security/Http/SecurityEvents.php

    You can find other events in similar files in other components, for example:

    https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/KernelEvents.php

    Hope this helps 😉

    Reply
  14. Guillaume says:
    November 28, 2012 at 15:49

    Thanks for the tip. But what if user logs in with a cookie. How can we perform actions in that case ?

    Reply
  15. Metod says:
    December 8, 2012 at 11:13

    You can check out this answer: http://stackoverflow.com/a/11431221/268592

    Basically the same event gets triggered on remember_me and on usual login. You need to just inspect the cookie. I will add an example later.

    Reply
  16. Metod says:
    December 11, 2012 at 11:41

    Actually you don’t need to inspect the cookie. I’ve refined the gist above and added the remember me check aswell.

    Reply
  17. George says:
    April 12, 2013 at 09:03

    Creating a Login and SignUp application using symfony2 and twitter bootstrap in 30min
    5 video to show hot to setup a login and signup application from scratch..
    http://youtu.be/AvLk3i2CBgw
    http://youtu.be/seztFo5j7H4
    http://youtu.be/hzURtNJUQb4
    http://youtu.be/Uh0a7m2XxLU
    http://youtu.be/sE7f5k9NZ6A

    Reply
  18. gondo says:
    August 18, 2013 at 14:52

    hi
    using your code im getting “The security context contains no authentication token. One possible reason may be that there is no firewall configured for this URL.”
    im using symfony2.3.2 and FOSUser dev-master 6fc28e4 (from 18.7.13)
    for now i’ve solved this by adding this into onSecurityInteractiveLogin:
    $token = $event->getAuthenticationToken();
    $this->securityContext->setToken($token);

    the question is, is this correct/secure?

    Reply
  19. Sergio says:
    February 22, 2014 at 14:52

    You Rock man!

    Thanks very much!

    Reply
  20. Benoît Wery says:
    March 27, 2014 at 17:37

    Short and usefull : thanks you !
    I’ve implemented a last ip remember in few minutes, thanks to your post

    Reply
  21. Panos says:
    May 10, 2014 at 21:21

    Thank you for sharing

    Reply
  22. Kegan says:
    January 1, 2015 at 00:35

    Great, simple tutorial. Thanks!

    Reply
  23. Gaurav says:
    February 19, 2015 at 12:49

    Hi,

    This is very informative, here is another example of Symfony2 FOSUserBundle.

    http://webmuch.com/override-fosuserbundle/

    I hope you

    Reply
  24. Denis says:
    May 5, 2015 at 18:26

    Great article!

    Really helped me! Thanks! =D

    Reply
  25. Edouard HINVI says:
    June 11, 2015 at 14:13

    Thank you very much. You saved a life ! 🙂

    Reply
  26. JoseFG says:
    June 24, 2015 at 12:15

    This tutorial is just what I needed, thank you very much!

    Reply
  27. Answer for FOSUserBundle - Force password change after first login - Tech Magazine says:
    October 25, 2015 at 17:48

    […] that drove me to fos_user.security.implicit_login and an external topic about doing stuff right after login, I got a working […]

    Reply
  28. gintare says:
    November 27, 2015 at 08:59

    Thank you. But it would be perfect that it would be possible to download full example Bundle with User entity and event!

    Reply