Opened 8 years ago

Closed 5 years ago

Last modified 4 years ago

#5612 closed (fixed)

Signals for login / logout

Reported by: pterk Owned by: SmileyChris
Component: Core (Other) Version: master
Severity: Keywords:
Cc: pterk@…, bthomas@…, siddhartag@…, egmanoj@…, mmitar@…, piquadrat@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

A small patch that adds signals for login / logout events. The signal passes on the request. I use it to clean up session-data.

Attachments (5)

login_logout_signals.diff (1.4 KB) - added by pterk 8 years ago.
login_logout_signals-2.diff (1.4 KB) - added by pterk 8 years ago.
Self contained (moved signals to contrib.auth.signals)
login_logout_signals_r10823.diff (1.6 KB) - added by JohnDoe 6 years ago.
5612.diff (7.1 KB) - added by SmileyChris 5 years ago.
5612.2.diff (7.2 KB) - added by SmileyChris 5 years ago.

Download all attachments as: .zip

Change History (32)

Changed 8 years ago by pterk

comment:1 Changed 8 years ago by anonymous

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement set

I believe the contrib modules are supposed to be self-contained, so should the signal objects should probably be within contrib.auth rather than core.

Changed 8 years ago by pterk

Self contained (moved signals to contrib.auth.signals)

comment:2 Changed 8 years ago by anonymous

  • Cc pterk@… added

comment:3 Changed 8 years ago by brosner

  • Resolution set to wontfix
  • Status changed from new to closed

Marking as wont fix. Signal dispatching is slow. This should be accomplished using the daily_cleanup.py found in django/bin. If that doesn't suit you then rewrite parts of django.contrib.auth or maybe through a custom auth backend. Please reopen with better use cases. I just don't see signals being a solution to really any use case for something like this.

comment:4 Changed 8 years ago by anonymous

Signals are slow, but login and logout events would occur so rarely that signal performance shouldn't be a consideration here.

comment:5 Changed 8 years ago by pterk

Another use case could be to log all login/outs in a single place (iso /admin/, /accounts/registration and possibly other locations or rewriting bits of django core). To alleviate the worries about speed, it could be made entirely optional and off by default.

comment:6 Changed 8 years ago by brosner

  • Resolution wontfix deleted
  • Status changed from closed to reopened
  • Triage Stage changed from Unreviewed to Design decision needed

Alright, I am going to re-open this ticket to get some exposure by the core devs. There are a few use cases for this and having an optional on and off switch would be nice to alleviate any performance issues.

comment:7 Changed 8 years ago by PJCrosier

  • Has patch set

comment:8 Changed 7 years ago by bthomas

  • Cc bthomas@… added

Changed 6 years ago by JohnDoe

comment:9 Changed 6 years ago by JohnDoe

Updated patch to work with newer version, changed behavior to trigger login signal before updating last_login because i need to log time between logins.

comment:10 Changed 6 years ago by siddhi

  • Cc siddhartag@… added

comment:11 Changed 6 years ago by anonymous

  • Cc egmanoj@… added

comment:12 Changed 6 years ago by imbaczek@…

another use case: demo users - profiles, passwords and other data needs to be reset on login/logout.

comment:13 Changed 6 years ago by coleifer

I'd love to see this one - we'd like to hook into the login process and are considering wrapping the default views. What's the status on this one?

comment:14 Changed 5 years ago by SmileyChris

  • Owner changed from nobody to SmileyChris
  • Patch needs improvement unset
  • Status changed from reopened to new

New patch with docs & tests. Also moved the update for last_login to a signal which allows for it to be disconnected if someone wanted to.

Changed 5 years ago by SmileyChris

comment:15 Changed 5 years ago by SmileyChris

  • Summary changed from [patch] Signals for login / logout to Signals for login / logout

comment:16 Changed 5 years ago by mitar

  • Cc mmitar@… added

Another use case: with signal you could add a message to the user informing her that she was successfully logged in or out and redirect her to the page she wanted to go in the first place and not to the default login page. It is a nice information to users that they know what is happening behind the scenes.

comment:17 Changed 5 years ago by drizzo4shizzo

I'd love to see this as in my app I'm currently wrapping the default login view to store login attempts. So preferably a hook for a successful login and another for a failed attempt.

I tried using a custom authentication back end to handle failed login attempts but those only get username/password - need the http request to dig out IP...

comment:18 Changed 5 years ago by SmileyChris

mitar: using signals doesn't just make that possible. In fact, it confuses the issue more: what if you have two conflicting responses from signal listeners?

drizzo4shizzo: that's an interesting idea - I don't think it's part of this primary ticket though so perhaps you should open a new ticket for that (and crosslink it to here)

comment:19 Changed 5 years ago by mitar

I do not understand why it would not be possible. I am quite happily using such views:

def login(request, *args, **kwargs):
  res = login_view(request, *args, **kwargs)
  if request.user.is_authenticated():
    signals.user_login.send(sender=login, request=request, user=request.user)
  return res
def logout(request, *args, **kwargs):
  user = request.user
  res = logout_view(request, *args, **kwargs)
  signals.user_logout.send(sender=logout_redirect, request=request, user=user)
  return res

comment:20 Changed 5 years ago by mitar

And then:

def user_login_message(request, user, **kwargs):
  messages.success(request, _("You have successfully logged in."), fail_silently=True)
user_login.connect(user_login_message)

def user_logout_message(request, user, **kwargs):
  messages.success(request, _("You have successfully logged out."), fail_silently=True)
user_logout.connect(user_logout_message)

comment:21 Changed 5 years ago by SmileyChris

Right, I get that adding a message would be a useful use of the signal.

It's was the "redirect her to the page she wanted to go in the first place and not the default login page" statement that I was referring to. It has nothing to do with signal listeners, which is what this ticket was about ;)

comment:22 Changed 5 years ago by mitar

Ah, yes. This is something else. I pass next parameter to login view so that user is redirected back to where it started the login process. So I do not use signals for redirecting. But once you do redirecting it is nice to tell user that login was successful, because otherwise just some small part of the page changes (like that username is written somewhere instead of "login" link). So messages are useful to tell the user this. And having signals then makes this really easy to do.

comment:23 Changed 5 years ago by russellm

  • Triage Stage changed from Design decision needed to Accepted

Speed isn't a concern for signals any more, and it's an obvious place to be raising a signal. Accepting.

Changed 5 years ago by SmileyChris

comment:24 Changed 5 years ago by anonymous

  • Cc piquadrat@… added

comment:25 Changed 5 years ago by jezdez

  • milestone set to 1.3
  • Triage Stage changed from Accepted to Ready for checkin

comment:26 Changed 5 years ago by jezdez

  • Resolution set to fixed
  • Status changed from new to closed

(In [14710]) Fixed #5612 -- Added login and logout signals to contrib auth app. Thanks SmileyChris and pterk.

comment:27 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

Note: See TracTickets for help on using tickets.
Back to Top