src/ajaxable/utils.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 from functools import wraps
   5 import json
   6 from urllib.parse import quote_plus
   7
   8 from django.http import HttpResponse, HttpResponseRedirect, HttpResponseForbidden
   9 from django.shortcuts import render
  10 from django.utils.encoding import force_str
  11 from django.utils.functional import Promise
  12 from django.utils.translation import gettext_lazy as _
  13 from django.views.decorators.vary import vary_on_headers
  14 from honeypot.decorators import verify_honeypot_value
  15 from wolnelektury.utils import is_ajax
  16
  17
  18 class LazyEncoder(json.JSONEncoder):
  19     def default(self, o):
  20         if isinstance(o, Promise):
  21             return force_str(o)
  22         return o
  23
  24
  25 def method_decorator(function_decorator):
  26     """Converts a function decorator to a method decorator.
  27
  28     It just makes it ignore first argument.
  29     """
  30     def decorator(method):
  31         @wraps(method)
  32         def wrapped_method(self, *args, **kwargs):
  33             def function(*fargs, **fkwargs):
  34                 return method(self, *fargs, **fkwargs)
  35             return function_decorator(function)(*args, **kwargs)
  36         return wrapped_method
  37     return decorator
  38
  39
  40 def require_login(request):
  41     """Return 403 if request is AJAX. Redirect to login page if not."""
  42     if is_ajax(request):
  43         return HttpResponseForbidden('Not logged in')
  44     return HttpResponseRedirect('/uzytkownicy/zaloguj')  # next?=request.build_full_path())
  45
  46
  47 def placeholdized(form):
  48     for field in form.fields.values():
  49         field.widget.attrs['placeholder'] = field.label + ('*' if field.required else '')
  50     return form
  51
  52
  53 class AjaxableFormView:
  54     """Subclass this to create an ajaxable view for any form.
  55
  56     In the subclass, provide at least form_class.
  57
  58     """
  59     form_class = None
  60     placeholdize = False
  61     # override to customize form look
  62     template = "ajaxable/form.html"
  63     submit = _('Send')
  64     action = ''
  65
  66     title = ''
  67     success_message = ''
  68     POST_login = False
  69     formname = "form"
  70     form_prefix = None
  71     full_template = "ajaxable/form_on_page.html"
  72     honeypot = False
  73
  74     @method_decorator(vary_on_headers('X-Requested-With'))
  75     def __call__(self, request, *args, **kwargs):
  76         """A view displaying a form, or JSON if request is AJAX."""
  77         obj = self.get_object(request, *args, **kwargs)
  78
  79         response = self.validate_object(obj, request)
  80         if response:
  81             return response
  82
  83         form_args, form_kwargs = self.form_args(request, obj)
  84         if self.form_prefix:
  85             form_kwargs['prefix'] = self.form_prefix
  86
  87         if request.method == "POST":
  88             if self.honeypot:
  89                 response = verify_honeypot_value(request, None)
  90                 if response:
  91                     return response
  92
  93             # do I need to be logged in?
  94             if self.POST_login and not request.user.is_authenticated:
  95                 return require_login(request)
  96
  97             form_kwargs['data'] = request.POST
  98             form = self.form_class(*form_args, **form_kwargs)
  99             if form.is_valid():
 100                 add_args = self.success(form, request)
 101                 response_data = {
 102                     'success': True,
 103                     'message': self.success_message,
 104                     'redirect': request.GET.get('next')
 105                     }
 106                 if add_args:
 107                     response_data.update(add_args)
 108                 if not is_ajax(request) and response_data['redirect']:
 109                     return HttpResponseRedirect(quote_plus(
 110                         response_data['redirect'], safe='/?=&'))
 111             elif is_ajax(request):
 112                 # Form was sent with errors. Send them back.
 113                 if self.form_prefix:
 114                     errors = {}
 115                     for key, value in form.errors.items():
 116                         errors["%s-%s" % (self.form_prefix, key)] = value
 117                 else:
 118                     errors = form.errors
 119                 response_data = {'success': False, 'errors': errors}
 120             else:
 121                 response_data = None
 122             if is_ajax(request):
 123                 return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
 124         else:
 125             if self.POST_login and not request.user.is_authenticated and not is_ajax(request):
 126                 return require_login(request)
 127
 128             form = self.form_class(*form_args, **form_kwargs)
 129             response_data = None
 130
 131         title = self.title
 132         if is_ajax(request):
 133             template = self.template
 134         else:
 135             template = self.full_template
 136             cd = self.context_description(request, obj)
 137             if cd:
 138                 title += ": " + cd
 139         if self.placeholdize:
 140             form = placeholdized(form)
 141         context = {
 142             self.formname: form,
 143             "title": title,
 144             "honeypot": self.honeypot,
 145             "placeholdize": self.placeholdize,
 146             "submit": self.submit,
 147             "action": self.action,
 148             "response_data": response_data,
 149             "ajax_template": self.template,
 150             "view_args": args,
 151             "view_kwargs": kwargs,
 152         }
 153         context.update(self.extra_context(request, obj))
 154         return render(request, template, context)
 155
 156     def validate_object(self, obj, request):
 157         return None
 158
 159     def redirect_or_refresh(self, request, path, message=None):
 160         """If the form is AJAX, refresh the page. If not, go to `path`."""
 161         if is_ajax(request):
 162             output = "<script>window.location.reload()</script>"
 163             if message:
 164                 output = "<div class='normal-text'>" + message + "</div>" + output
 165             return HttpResponse(output)
 166         return HttpResponseRedirect(path)
 167
 168     def get_object(self, request, *args, **kwargs):
 169         """Override to parse view args and get some associated data."""
 170         return None
 171
 172     def form_args(self, request, obj):
 173         """Override to parse view args and give additional args to the form."""
 174         return (), {}
 175
 176     def extra_context(self, request, obj):
 177         """Override to pass something to template."""
 178         return {}
 179
 180     def context_description(self, request, obj):
 181         """Description to appear in standalone form, but not in AJAX form."""
 182         return ""
 183
 184     def success(self, form, request):
 185         """What to do when the form is valid.
 186
 187         By default, just save the form.
 188
 189         """
 190         return form.save(request)