views.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. from django.conf import settings
  2. from django.core.urlresolvers import reverse
  3. from django.http import HttpResponseRedirect, QueryDict
  4. from django.template.response import TemplateResponse
  5. from django.utils.http import is_safe_url, urlsafe_base64_decode
  6. from django.utils.translation import ugettext as _
  7. from django.utils.six.moves.urllib.parse import urlparse, urlunparse
  8. from django.shortcuts import resolve_url
  9. from django.views.decorators.debug import sensitive_post_parameters
  10. from django.views.decorators.cache import never_cache
  11. from django.views.decorators.csrf import csrf_protect
  12. # Avoid shadowing the login() and logout() views below.
  13. from django.contrib.auth import (REDIRECT_FIELD_NAME, login as auth_login,
  14. logout as auth_logout, get_user_model, update_session_auth_hash)
  15. from django.contrib.auth.decorators import login_required
  16. from django.contrib.auth.forms import AuthenticationForm, PasswordResetForm, SetPasswordForm, PasswordChangeForm
  17. from django.contrib.auth.tokens import default_token_generator
  18. from django.contrib.sites.shortcuts import get_current_site
  19. @sensitive_post_parameters()
  20. @csrf_protect
  21. @never_cache
  22. def login(request, template_name='registration/login.html',
  23. redirect_field_name=REDIRECT_FIELD_NAME,
  24. authentication_form=AuthenticationForm,
  25. current_app=None, extra_context=None):
  26. """
  27. Displays the login form and handles the login action.
  28. """
  29. redirect_to = request.POST.get(redirect_field_name,
  30. request.GET.get(redirect_field_name, ''))
  31. if request.method == "POST":
  32. form = authentication_form(request, data=request.POST)
  33. if form.is_valid():
  34. # Ensure the user-originating redirection url is safe.
  35. if not is_safe_url(url=redirect_to, host=request.get_host()):
  36. redirect_to = resolve_url(settings.LOGIN_REDIRECT_URL)
  37. # Okay, security check complete. Log the user in.
  38. auth_login(request, form.get_user())
  39. return HttpResponseRedirect(redirect_to)
  40. else:
  41. form = authentication_form(request)
  42. current_site = get_current_site(request)
  43. context = {
  44. 'form': form,
  45. redirect_field_name: redirect_to,
  46. 'site': current_site,
  47. 'site_name': current_site.name,
  48. }
  49. if extra_context is not None:
  50. context.update(extra_context)
  51. return TemplateResponse(request, template_name, context,
  52. current_app=current_app)
  53. def logout(request, next_page=None,
  54. template_name='registration/logged_out.html',
  55. redirect_field_name=REDIRECT_FIELD_NAME,
  56. current_app=None, extra_context=None):
  57. """
  58. Logs out the user and displays 'You are logged out' message.
  59. """
  60. auth_logout(request)
  61. if next_page is not None:
  62. next_page = resolve_url(next_page)
  63. if (redirect_field_name in request.POST or
  64. redirect_field_name in request.GET):
  65. next_page = request.POST.get(redirect_field_name,
  66. request.GET.get(redirect_field_name))
  67. # Security check -- don't allow redirection to a different host.
  68. if not is_safe_url(url=next_page, host=request.get_host()):
  69. next_page = request.path
  70. if next_page:
  71. # Redirect to this page until the session has been cleared.
  72. return HttpResponseRedirect(next_page)
  73. current_site = get_current_site(request)
  74. context = {
  75. 'site': current_site,
  76. 'site_name': current_site.name,
  77. 'title': _('Logged out')
  78. }
  79. if extra_context is not None:
  80. context.update(extra_context)
  81. return TemplateResponse(request, template_name, context,
  82. current_app=current_app)
  83. def logout_then_login(request, login_url=None, current_app=None, extra_context=None):
  84. """
  85. Logs out the user if they are logged in. Then redirects to the log-in page.
  86. """
  87. if not login_url:
  88. login_url = settings.LOGIN_URL
  89. login_url = resolve_url(login_url)
  90. return logout(request, login_url, current_app=current_app, extra_context=extra_context)
  91. def redirect_to_login(next, login_url=None,
  92. redirect_field_name=REDIRECT_FIELD_NAME):
  93. """
  94. Redirects the user to the login page, passing the given 'next' page
  95. """
  96. resolved_url = resolve_url(login_url or settings.LOGIN_URL)
  97. login_url_parts = list(urlparse(resolved_url))
  98. if redirect_field_name:
  99. querystring = QueryDict(login_url_parts[4], mutable=True)
  100. querystring[redirect_field_name] = next
  101. login_url_parts[4] = querystring.urlencode(safe='/')
  102. return HttpResponseRedirect(urlunparse(login_url_parts))
  103. # 4 views for password reset:
  104. # - password_reset sends the mail
  105. # - password_reset_done shows a success message for the above
  106. # - password_reset_confirm checks the link the user clicked and
  107. # prompts for a new password
  108. # - password_reset_complete shows a success message for the above
  109. @csrf_protect
  110. def password_reset(request, is_admin_site=False,
  111. template_name='registration/password_reset_form.html',
  112. email_template_name='registration/password_reset_email.html',
  113. subject_template_name='registration/password_reset_subject.txt',
  114. password_reset_form=PasswordResetForm,
  115. token_generator=default_token_generator,
  116. post_reset_redirect=None,
  117. from_email=None,
  118. current_app=None,
  119. extra_context=None,
  120. html_email_template_name=None):
  121. if post_reset_redirect is None:
  122. post_reset_redirect = reverse('password_reset_done')
  123. else:
  124. post_reset_redirect = resolve_url(post_reset_redirect)
  125. if request.method == "POST":
  126. form = password_reset_form(request.POST)
  127. if form.is_valid():
  128. opts = {
  129. 'use_https': request.is_secure(),
  130. 'token_generator': token_generator,
  131. 'from_email': from_email,
  132. 'email_template_name': email_template_name,
  133. 'subject_template_name': subject_template_name,
  134. 'request': request,
  135. 'html_email_template_name': html_email_template_name,
  136. }
  137. if is_admin_site:
  138. opts = dict(opts, domain_override=request.get_host())
  139. form.save(**opts)
  140. return HttpResponseRedirect(post_reset_redirect)
  141. else:
  142. form = password_reset_form()
  143. context = {
  144. 'form': form,
  145. 'title': _('Password reset'),
  146. }
  147. if extra_context is not None:
  148. context.update(extra_context)
  149. return TemplateResponse(request, template_name, context,
  150. current_app=current_app)
  151. def password_reset_done(request,
  152. template_name='registration/password_reset_done.html',
  153. current_app=None, extra_context=None):
  154. context = {
  155. 'title': _('Password reset successful'),
  156. }
  157. if extra_context is not None:
  158. context.update(extra_context)
  159. return TemplateResponse(request, template_name, context,
  160. current_app=current_app)
  161. # Doesn't need csrf_protect since no-one can guess the URL
  162. @sensitive_post_parameters()
  163. @never_cache
  164. def password_reset_confirm(request, uidb64=None, token=None,
  165. template_name='registration/password_reset_confirm.html',
  166. token_generator=default_token_generator,
  167. set_password_form=SetPasswordForm,
  168. post_reset_redirect=None,
  169. current_app=None, extra_context=None):
  170. """
  171. View that checks the hash in a password reset link and presents a
  172. form for entering a new password.
  173. """
  174. UserModel = get_user_model()
  175. assert uidb64 is not None and token is not None # checked by URLconf
  176. if post_reset_redirect is None:
  177. post_reset_redirect = reverse('password_reset_complete')
  178. else:
  179. post_reset_redirect = resolve_url(post_reset_redirect)
  180. try:
  181. uid = urlsafe_base64_decode(uidb64)
  182. user = UserModel._default_manager.get(pk=uid)
  183. except (TypeError, ValueError, OverflowError, UserModel.DoesNotExist):
  184. user = None
  185. if user is not None and token_generator.check_token(user, token):
  186. validlink = True
  187. title = _('Enter new password')
  188. if request.method == 'POST':
  189. form = set_password_form(user, request.POST)
  190. if form.is_valid():
  191. form.save()
  192. return HttpResponseRedirect(post_reset_redirect)
  193. else:
  194. form = set_password_form(user)
  195. else:
  196. validlink = False
  197. form = None
  198. title = _('Password reset unsuccessful')
  199. context = {
  200. 'form': form,
  201. 'title': title,
  202. 'validlink': validlink,
  203. }
  204. if extra_context is not None:
  205. context.update(extra_context)
  206. return TemplateResponse(request, template_name, context,
  207. current_app=current_app)
  208. def password_reset_complete(request,
  209. template_name='registration/password_reset_complete.html',
  210. current_app=None, extra_context=None):
  211. context = {
  212. 'login_url': resolve_url(settings.LOGIN_URL),
  213. 'title': _('Password reset complete'),
  214. }
  215. if extra_context is not None:
  216. context.update(extra_context)
  217. return TemplateResponse(request, template_name, context,
  218. current_app=current_app)
  219. @sensitive_post_parameters()
  220. @csrf_protect
  221. @login_required
  222. def password_change(request,
  223. template_name='registration/password_change_form.html',
  224. post_change_redirect=None,
  225. password_change_form=PasswordChangeForm,
  226. current_app=None, extra_context=None):
  227. if post_change_redirect is None:
  228. post_change_redirect = reverse('password_change_done')
  229. else:
  230. post_change_redirect = resolve_url(post_change_redirect)
  231. if request.method == "POST":
  232. form = password_change_form(user=request.user, data=request.POST)
  233. if form.is_valid():
  234. form.save()
  235. # Updating the password logs out all other sessions for the user
  236. # except the current one if
  237. # django.contrib.auth.middleware.SessionAuthenticationMiddleware
  238. # is enabled.
  239. update_session_auth_hash(request, form.user)
  240. return HttpResponseRedirect(post_change_redirect)
  241. else:
  242. form = password_change_form(user=request.user)
  243. context = {
  244. 'form': form,
  245. 'title': _('Password change'),
  246. }
  247. if extra_context is not None:
  248. context.update(extra_context)
  249. return TemplateResponse(request, template_name, context,
  250. current_app=current_app)
  251. @login_required
  252. def password_change_done(request,
  253. template_name='registration/password_change_done.html',
  254. current_app=None, extra_context=None):
  255. context = {
  256. 'title': _('Password change successful'),
  257. }
  258. if extra_context is not None:
  259. context.update(extra_context)
  260. return TemplateResponse(request, template_name, context,
  261. current_app=current_app)