Layout fixes, cover update for files.
[wolnelektury.git] / src / ajaxable / utils.py
old mode 100755 (executable)
new mode 100644 (file)
index 89b5622..3a1c455
@@ -1,27 +1,25 @@
-# -*- coding: utf-8 -*-
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
 from functools import wraps
+import json
+from urllib.parse import quote_plus
 
-from django.http import (HttpResponse, HttpResponseRedirect,
-        HttpResponseForbidden)
-from django.shortcuts import render_to_response
-from django.template import RequestContext
-from django.utils.encoding import force_unicode
+from django.http import HttpResponse, HttpResponseRedirect, HttpResponseForbidden
+from django.shortcuts import render
+from django.utils.encoding import force_str
 from django.utils.functional import Promise
-from django.utils.http import urlquote_plus
-import json
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from django.views.decorators.vary import vary_on_headers
 from honeypot.decorators import verify_honeypot_value
+from wolnelektury.utils import is_ajax
 
 
 class LazyEncoder(json.JSONEncoder):
-    def default(self, obj):
-        if isinstance(obj, Promise):
-            return force_unicode(obj)
-        return obj
+    def default(self, o):
+        if isinstance(o, Promise):
+            return force_str(o)
+        return o
 
 
 def method_decorator(function_decorator):
@@ -41,19 +39,18 @@ def method_decorator(function_decorator):
 
 def require_login(request):
     """Return 403 if request is AJAX. Redirect to login page if not."""
-    if request.is_ajax():
+    if is_ajax(request):
         return HttpResponseForbidden('Not logged in')
-    else:
-        return HttpResponseRedirect('/uzytkownicy/zaloguj')# next?=request.build_full_path())
+    return HttpResponseRedirect('/uzytkownicy/zaloguj')  # next?=request.build_full_path())
 
 
 def placeholdized(form):
     for field in form.fields.values():
-        field.widget.attrs['placeholder'] = field.label
+        field.widget.attrs['placeholder'] = field.label + ('*' if field.required else '')
     return form
 
 
-class AjaxableFormView(object):
+class AjaxableFormView:
     """Subclass this to create an ajaxable view for any form.
 
     In the subclass, provide at least form_class.
@@ -64,6 +61,7 @@ class AjaxableFormView(object):
     # override to customize form look
     template = "ajaxable/form.html"
     submit = _('Send')
+    action = ''
 
     title = ''
     success_message = ''
@@ -77,6 +75,11 @@ class AjaxableFormView(object):
     def __call__(self, request, *args, **kwargs):
         """A view displaying a form, or JSON if request is AJAX."""
         obj = self.get_object(request, *args, **kwargs)
+
+        response = self.validate_object(obj, request)
+        if response:
+            return response
+
         form_args, form_kwargs = self.form_args(request, obj)
         if self.form_prefix:
             form_kwargs['prefix'] = self.form_prefix
@@ -88,7 +91,7 @@ class AjaxableFormView(object):
                     return response
 
             # do I need to be logged in?
-            if self.POST_login and not request.user.is_authenticated():
+            if self.POST_login and not request.user.is_authenticated:
                 return require_login(request)
 
             form_kwargs['data'] = request.POST
@@ -102,10 +105,10 @@ class AjaxableFormView(object):
                     }
                 if add_args:
                     response_data.update(add_args)
-                if not request.is_ajax() and response_data['redirect']:
-                    return HttpResponseRedirect(urlquote_plus(
-                            response_data['redirect'], safe='/?=&'))
-            elif request.is_ajax():
+                if not is_ajax(request) and response_data['redirect']:
+                    return HttpResponseRedirect(quote_plus(
+                        response_data['redirect'], safe='/?=&'))
+            elif is_ajax(request):
                 # Form was sent with errors. Send them back.
                 if self.form_prefix:
                     errors = {}
@@ -116,18 +119,17 @@ class AjaxableFormView(object):
                 response_data = {'success': False, 'errors': errors}
             else:
                 response_data = None
-            if request.is_ajax():
+            if is_ajax(request):
                 return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
         else:
-            if (self.POST_login and not request.user.is_authenticated()
-                    and not request.is_ajax()):
+            if self.POST_login and not request.user.is_authenticated and not is_ajax(request):
                 return require_login(request)
 
             form = self.form_class(*form_args, **form_kwargs)
             response_data = None
 
         title = self.title
-        if request.is_ajax():
+        if is_ajax(request):
             template = self.template
         else:
             template = self.full_template
@@ -137,29 +139,31 @@ class AjaxableFormView(object):
         if self.placeholdize:
             form = placeholdized(form)
         context = {
-                self.formname: form,
-                "title": title,
-                "honeypot": self.honeypot,
-                "placeholdize": self.placeholdize,
-                "submit": self.submit,
-                "response_data": response_data,
-                "ajax_template": self.template,
-                "view_args": args,
-                "view_kwargs": kwargs,
-            }
+            self.formname: form,
+            "title": title,
+            "honeypot": self.honeypot,
+            "placeholdize": self.placeholdize,
+            "submit": self.submit,
+            "action": self.action,
+            "response_data": response_data,
+            "ajax_template": self.template,
+            "view_args": args,
+            "view_kwargs": kwargs,
+        }
         context.update(self.extra_context(request, obj))
-        return render_to_response(template, context,
-            context_instance=RequestContext(request))
+        return render(request, template, context)
+
+    def validate_object(self, obj, request):
+        return None
 
     def redirect_or_refresh(self, request, path, message=None):
         """If the form is AJAX, refresh the page. If not, go to `path`."""
-        if request.is_ajax():
+        if is_ajax(request):
             output = "<script>window.location.reload()</script>"
             if message:
                 output = "<div class='normal-text'>" + message + "</div>" + output
             return HttpResponse(output)
-        else:
-            return HttpResponseRedirect(path)
+        return HttpResponseRedirect(path)
 
     def get_object(self, request, *args, **kwargs):
         """Override to parse view args and get some associated data."""