Differential D9127 Diff 29958 blendercloud/middleware.py

Changeset View

Standalone View

blendercloud/middleware.py

This file was added.

				"""Takes care of reading Flask session and storing its data in our own Django session.

				The goal of this is to allow Blender Studio pages to be run as part of Blender Cloud,
				sharing login information without requiring users to login again every time they visit pages
				that aren't actually served by Blender Cloud.
				"""
				import logging

				from django.conf import settings
				from django.contrib.auth import login, logout

				import blendercloud.session

				logger = logging.getLogger(__name__)


				class SessionMiddleware:
				"""Copies login info from Blender Cloud session into current Django session."""

				def __init__(self, get_response):
				"""One-time configuration and initialization."""
				self.get_response = get_response

				def __call__(self, request):
				"""Copy Blender Cloud session data into current session.

				Blender Cloud fully controls the authentication, which means that if its session cookie
				is not available, user is not logged in from Django's point of view.
				This middleware can be enabled with a `settings.BLENDER_CLOUD_AUTH_ENABLED` flag.
				"""
				if settings.BLENDER_CLOUD_AUTH_ENABLED:
				# Allow logging in as an admin via the admin panel to simplify development
				if not (settings.DEBUG and request.user.is_authenticated and request.user.is_superuser):
				self._modify_session(request)

				response = self.get_response(request)
				# This middleware doesn't do anything with the response
				return response

				def _modify_session(self, request):
				try:
				user = blendercloud.session.get_or_create_current_user(request)
				except Exception:
				user = None
				logger.exception('Error while reading Blender Cloud session')

				if user is not None:
				login(request, user)
				sybrenUnsubmitted Done Inline Actions For info and debug level logging (basically: for all logging levels that might be disabled in production), it's better to use percent formatting. logger.debug('Authenticated Blender Cloud user: %s', user) This will only call `str(user)` and do the string formatting when debug-level logging is actually enabled. I don't feel very strongly about this, though, so if you think the small performance cost is worth it to get more readable code, that's fine too. sybren: For info and debug level logging (basically: for all logging levels that might be disabled in…
				logger.debug('Authenticated Blender Cloud user: %s', user)
				elif request.user.is_authenticated:
				logout(request)
				sybrenUnsubmitted Done Inline Actions I suspect this will happen quite a bit, when the Blender Cloud session expires (or when people log out, which I expect to happen less often). Is it necessary to send a warning to Sentry about this? sybren: I suspect this will happen quite a bit, when the Blender Cloud session expires (or when people…
				logger.debug('User is authenticated but Blender Cloud session is not available')