ssify/middleware.py

   1 # -*- coding: utf-8 -*-
   2 # This file is part of django-ssify, licensed under GNU Affero GPLv3 or later.
   3 # Copyright © Fundacja Nowoczesna Polska. See README.md for more information.
   4 #
   5 """
   6 Middleware classes provide by django-ssify.
   7
   8 The main middleware you should use is SsiMiddleware. It's responsible
   9 for providing the SSI variables needed for the SSI part of rendering.
  10
  11 If you're using django's UpdateCacheMiddleware, add
  12 PrepareForCacheMiddleware *after it* also. It will add all the data
  13 needed by SsiMiddleware to the response.
  14
  15 If you're using SessionMiddleware with LocaleMiddleware and your
  16 USE_I18N or USE_L10N is True, you should also use the provided
  17 LocaleMiddleware instead of the stock one.
  18
  19 And, last but not least, if using CsrfViewMiddleware, move it to the
  20 top of MIDDLEWARE_CLASSES, even before SsiMiddleware, and use
  21 `csrf_token` from `ssify` tags library in your templates, this way
  22 your CSRF tokens will be set correctly.
  23
  24 So, you should end up with something like this:
  25
  26     MIDDLEWARE_CLASSES = [
  27        'django.middleware.csrf.CsrfViewMiddleware',
  28        'ssify.middleware.SsiMiddleware',
  29        'django.middleware.cache.UpdateCacheMiddleware',
  30        'ssify.middleware.PrepareForCacheMiddleware',
  31        ...
  32        'ssify.middleware.LocaleMiddleware',
  33        ...
  34     ]
  35
  36
  37 """
  38 from __future__ import unicode_literals
  39 from django.conf import settings
  40 from django.middleware import locale
  41 from django.utils.cache import patch_vary_headers
  42 from .conf import conf
  43 from .serializers import json_decode, json_encode
  44 from .utils import ssi_vary_on_cookie
  45 from .variables import SsiVariable, provide_vars
  46
  47
  48 CACHE_HEADERS = ('Pragma', 'Cache-Control', 'Vary')
  49
  50
  51 class PrepareForCacheMiddleware(object):
  52     """
  53     Patches the response object with all the data SsiMiddleware needs.
  54
  55     This should go after UpdateCacheMiddleware in MIDDLEWARE_CLASSES.
  56     """
  57     @staticmethod
  58     def process_response(request, response):
  59         """Adds a 'X-Ssi-Vars-Needed' header to the response."""
  60         if ('X-Ssi-Vars-Needed' not in response and
  61                 getattr(request, 'ssi_vars_needed', None)):
  62             vars_needed = {}
  63             for (k, v) in request.ssi_vars_needed.items():
  64                 vars_needed[k] = v.definition
  65             response['X-Ssi-Vars-Needed'] = json_encode(
  66                 vars_needed, sort_keys=True)
  67
  68         if ('X-ssi-restore' not in response and
  69                 getattr(request, 'ssi_patch_response', None)):
  70             # We have some response modifiers set by ssi_includes and
  71             # ssi_variables. Those are used, because unrendered SSI
  72             # templates Django cache receives should have different
  73             # caching headers, than pages rendered with request-specific
  74             # information.
  75             # What we do here is apply the modifiers, but restore
  76             # previous values of any cache-relevant headers and set
  77             # a custom header with modified values to set them
  78             # after-cache.
  79             original_fields = {}
  80             for field in CACHE_HEADERS:
  81                 original_fields[field] = response.get(field, None)
  82             for modifier in request.ssi_patch_response:
  83                 modifier(response)
  84             restore_fields = {}
  85             for field in CACHE_HEADERS:
  86                 new_value = response.get(field, None)
  87                 if new_value != original_fields[field]:
  88                     restore_fields[field] = new_value
  89                     if original_fields[field] is None:
  90                         del response[field]
  91                     else:
  92                         response[field] = original_fields[field]
  93             response['X-ssi-restore'] = json_encode(restore_fields)
  94
  95         return response
  96
  97
  98 class SsiMiddleware(object):
  99     """
 100     The main django-ssify middleware.
 101
 102     It prepends the response content with SSI set statements,
 103     providing values for any SSI variables used in the templates.
 104
 105     It also patches the Vary header with the values given by
 106     the SSI variables.
 107
 108     If SSIFY_RENDER is set, it also passes the response through
 109     SsiRenderMiddleware, which interprets and renders the SSI
 110     statements, so you can see the output without an actual
 111     SSI-enabled webserver.
 112
 113     """
 114     def process_request(self, request):
 115         request.ssi_patch_response = []
 116
 117     def process_view(self, request, view_func, view_args, view_kwargs):
 118         request.ssi_vars_needed = {}
 119
 120     def _process_rendered_response(self, request, response):
 121         # Prepend the SSI variables.
 122         if hasattr(request, 'ssi_vars_needed'):
 123             vars_needed = request.ssi_vars_needed
 124         else:
 125             vars_needed = json_decode(response.get('X-Ssi-Vars-Needed', '{}'))
 126             for k, v in vars_needed.items():
 127                 vars_needed[k] = SsiVariable(*v)
 128
 129         if vars_needed:
 130             response.content = provide_vars(request, vars_needed) + \
 131                 response.content
 132
 133         if 'X-ssi-restore' in response:
 134             # The modifiers have already been applied to the response
 135             # by the PrepareForCacheMiddleware.
 136             # All we need to do is restore cache-relevant headers.
 137             for header, content in json_decode(response['X-ssi-restore']).items():
 138                 if content is None:
 139                     del response[header]
 140                 else:
 141                     response[header] = content
 142         else:
 143             for response_modifier in getattr(request, 'ssi_patch_response', []):
 144                 response_modifier(response)
 145
 146     def process_response(self, request, response):
 147         if hasattr(response, 'render') and callable(response.render):
 148             response.add_post_render_callback(
 149                 lambda r: self._process_rendered_response(request, r)
 150             )
 151         else:
 152             self._process_rendered_response(request, response)
 153
 154         if conf.RENDER:
 155             from .middleware_debug import SsiRenderMiddleware
 156             response = SsiRenderMiddleware().process_response(
 157                 request, response)
 158
 159         return response
 160
 161
 162 class LocaleMiddleware(locale.LocaleMiddleware):
 163     """
 164     Version of the LocaleMiddleware for use together with the
 165     SsiMiddleware if USE_I18N or USE_L10N is set.
 166
 167     Stock LocaleMiddleware looks for user language selection in
 168     the session data and cookies, before it falls back to parsing
 169     Accept-Language. The effect of accessing the session is adding
 170     the `Vary: Cookie` header to the response.  While this is correct
 171     behaviour, it renders the cache system useless (see
 172     https://code.djangoproject.com/ticket/13217).
 173
 174     This version of LocaleMiddleware doesn't mark the session
 175     as accessed on every request, so SessionMiddleware doesn't add the
 176     Vary: Cookie header (unless something else actually uses the session
 177     in a meaningful way, of course). Instead, it tells SsiMiddleware
 178     to add the Vary: Cookie header to the final response.
 179
 180     """
 181     def process_request(self, request):
 182         if hasattr(request, 'session'):
 183             session_accessed_before = request.session.accessed
 184         else:
 185             session_accessed_before = None
 186         super(LocaleMiddleware, self).process_request(request)
 187         if session_accessed_before is False:
 188             if (request.session.accessed and
 189                     (settings.USE_I18N or settings.USE_L10N)):
 190                 request.session.accessed = False
 191                 request.ssi_patch_response.append(ssi_vary_on_cookie)