django-switchuser makes it easy for an administrator to switch to
temporarily switch to another account by visiting /su.
Because django-switchuser was a quick project, it does make one assumption:
- If a user is not allowed to su, then they will get an HTTP 404 if they try
to visit
/su/or do anything su-related. - Any superuser is allowed to switch to any other user. If this assumption does
not hold: you'll need to submit a pull request (hint: take a look at
django_switchuser/state.py)... Sorry :(
Tested with Django 1.8 through 1.10, should work with earlier Django versions too.
pip install django-switchuserAdd a few things to
settings.py(note: theSuStateMiddlewareshould be the very first class in the list; this guarantees thatrequest.su_statewill always be available):INSTALLED_APPS = ( ... "django_switchuser", ... ) MIDDLEWARE_CLASSES = ( "django_switchuser.middleware.SuStateMiddleware", ... ) TEMPLATE_CONTEXT_PROCESSORS = ( ... "django_switchuser.context_processors.su_state", ... )Add an entry to
urls.py(note: you can use whatever URL you'd like;su/is simply convenient):urlpatterns += patterns("", ... url(r"^su/", include("django_switchuser.urls")), ... )Start the server and check that everything is working by visiting http://localhost:8000/su/ Note: an HTTP 404 will be returned if the currently logged in user isn't allowed to su (by default, only administrators are allowed to su).
(Optional) Add an entry to your
base.htmltemplate which will show a convenient logout button:<html> <head>...</head> <body> ... {% include "su/statusbar.html" %} </body> </html>(Optional) Override
SuStateso it better suits your application. For example, to include fields from a user's profile, you subclassSuStatelike this (see below for more detailed documentation):from django.contrib.auth.models import User from django_switchuser.state import SuState as DefaultSuState class SuState(DefaultSuState): def available_users(self): return User.objects.all()\ .select_related("profile")\ .order_by("profile__client_id") def user_long_label(self, user): return "%s (%s)" %(user.get_profile().client_id, user.username) def user_short_label(self, user): return "%s" %(user.get_profile().client_id, )And then add to your
settings.pyfile:SU_STATE_CLASS = 'myapp.su.SuState'
Doing your own thing is easy. The SuStateMiddleware and su_state
context processors add a su_state attribute to the request and a
su_state variable to the template rendering context. su_state is an
instance of django_switchuser.state.SuState, and has the following
attributes:
SuState.is_active():- Returns
Trueif the current user has been switched.SuState.auth_user:- The original user associated with the request. For example, if the user
adminhas switched tojane, thensu_state.auth_userwill beadmin.SuState.active_user:- The user which has been switched to, or
Noneif no user has been switched. For example, if the useradminhas switched tojane, thensu_state.active_userwill beadmin.SuState.can_su():- Returns
Trueif the current user is allowed to switch.SuState.available_users():Returns a
QuerySetofUserof the users which the current user is allowed to switch to. It may be useful to override this method toselect_related()on the user's profile:def available_users(self): return User.objects.all()\ .select_related("profile")\ .order_by("profile__client_id")SuState.user_long_label(user):Returns the "long" label for the user, used in the list of users. It may be useful to override this method so that it includes information specific to your application:
def user_long_label(self, user): return "%s (%s)" %(user.get_profile().client_id, user.username)SuState.user_short_label(user):Returns the "short" label for the user, used in the status bar and other places. It may be useful to override this method so that it includes information specific to your application:
def user_short_label(self, user): return "%s" %(user.get_profile().client_id, )SuState.set_su_user_id(su_user_id):- Switches to the user with id
su_user_idif they are included inSuState.available_users().SuState.set_su_user(su_user):- Switches to User
su_user. No permissions checks are performed.SuState.clear_su():- Reverts back to the original user.
For example, if you don't like the default switch user bar, you could add your
own to your base.html:
{% load switchuser %}
{% load url from future %}
{% if su_state.is_active %}
<a href="{% url "su-logout" %}">deactive {% su_user_short_label su.active_user %}</a>
{% elif su_state.can_su %}
<a href="{% url "su-login" %}">switch user</a>
{% endif %}