Merge pull request #8749 from edx/rc/2015-06-29

Merge back into master

common/djangoapps/dark_lang/middleware.py

@@ -17,7 +17,6 @@ from dark_lang.models import DarkLangConfig
 from openedx.core.djangoapps.user_api.preferences.api import (
     delete_user_preference, get_user_preference, set_user_preference
 )
-from openedx.core.djangoapps.user_api.errors import UserNotFound
 from lang_pref import LANGUAGE_KEY
 
 # TODO re-import this once we're on Django 1.5 or greater. [PLAT-671]
@@ -133,27 +132,36 @@ class DarkLangMiddleware(object):
         and that language doesn't appear in ``self.released_langs``,
         then set the session LANGUAGE_SESSION_KEY to that language.
         """
+        auth_user = request.user.is_authenticated()
         if 'clear-lang' in request.GET:
-            # Reset dark lang
-            delete_user_preference(request.user, DARK_LANGUAGE_KEY)
-            # Reset user's language to their language preference, if they have one
-            user_pref = get_user_preference(request.user, LANGUAGE_KEY)
-            if user_pref:
-                request.session[LANGUAGE_SESSION_KEY] = user_pref
-            elif LANGUAGE_SESSION_KEY in request.session:
+            # delete the session language key (if one is set)
+            if LANGUAGE_SESSION_KEY in request.session:
                 del request.session[LANGUAGE_SESSION_KEY]
+
+            if auth_user:
+                # Reset user's dark lang preference to null
+                delete_user_preference(request.user, DARK_LANGUAGE_KEY)
+                # Get & set user's preferred language
+                user_pref = get_user_preference(request.user, LANGUAGE_KEY)
+                if user_pref:
+                    request.session[LANGUAGE_SESSION_KEY] = user_pref
             return
 
+        # Get the user's preview lang - this is either going to be set from a query
+        # param `?preview-lang=xx`, or we may have one already set as a dark lang preference.
         preview_lang = request.GET.get('preview-lang', None)
-        if not preview_lang:
-            try:
-                # Try to get the request user's preference (might not have a user, though)
-                preview_lang = get_user_preference(request.user, DARK_LANGUAGE_KEY)
-            except UserNotFound:
-                return
+        if not preview_lang and auth_user:
+            # Get the request user's dark lang preference
+            preview_lang = get_user_preference(request.user, DARK_LANGUAGE_KEY)
 
+        # User doesn't have a dark lang preference, so just return
         if not preview_lang:
             return
 
+        # Set the session key to the requested preview lang
         request.session[LANGUAGE_SESSION_KEY] = preview_lang
-        set_user_preference(request.user, DARK_LANGUAGE_KEY, preview_lang)
+
+        # Make sure that we set the requested preview lang as the dark lang preference for the
+        # user, so that the lang_pref middleware doesn't clobber away the dark lang preview.
+        if auth_user:
+            set_user_preference(request.user, DARK_LANGUAGE_KEY, preview_lang)

common/djangoapps/student/cookies.py

@@ -65,7 +65,12 @@ def set_logged_in_cookies(request, response, user):
     # is logged in.  This is just a boolean value, so it's not very useful.
     # In the future, we should be able to replace this with the "user info"
     # cookie set below.
-    response.set_cookie(settings.EDXMKTG_LOGGED_IN_COOKIE_NAME, 'true', secure=None, **cookie_settings)
+    response.set_cookie(
+        settings.EDXMKTG_LOGGED_IN_COOKIE_NAME.encode('utf-8'),
+        'true',
+        secure=None,
+        **cookie_settings
+    )
 
     # Set a cookie with user info.  This can be used by external sites
     # to customize content based on user information.  Currently,
@@ -107,7 +112,7 @@ def set_logged_in_cookies(request, response, user):
     user_info_cookie_is_secure = request.is_secure()
 
     response.set_cookie(
-        settings.EDXMKTG_USER_INFO_COOKIE_NAME,
+        settings.EDXMKTG_USER_INFO_COOKIE_NAME.encode('utf-8'),
         json.dumps(user_info),
         secure=user_info_cookie_is_secure,
         **cookie_settings
@@ -128,7 +133,11 @@ def delete_logged_in_cookies(response):
 
     """
     for cookie_name in [settings.EDXMKTG_LOGGED_IN_COOKIE_NAME, settings.EDXMKTG_USER_INFO_COOKIE_NAME]:
-        response.delete_cookie(cookie_name, path='/', domain=settings.SESSION_COOKIE_DOMAIN)
+        response.delete_cookie(
+            cookie_name.encode('utf-8'),
+            path='/',
+            domain=settings.SESSION_COOKIE_DOMAIN
+        )
 
     return response
 

common/djangoapps/student/tests/test_login.py

@@ -6,6 +6,7 @@ import unittest
 
 from django.test import TestCase
 from django.test.client import Client
+from django.test.utils import override_settings
 from django.conf import settings
 from django.core.cache import cache
 from django.core.urlresolvers import reverse, NoReverseMatch
@@ -195,6 +196,20 @@ class LoginTest(TestCase):
             cookie = self.client.cookies[cookie_name]
             self.assertIn("01-Jan-1970", cookie.get('expires'))
 
+    @override_settings(
+        EDXMKTG_LOGGED_IN_COOKIE_NAME=u"unicode-logged-in",
+        EDXMKTG_USER_INFO_COOKIE_NAME=u"unicode-user-info",
+    )
+    def test_unicode_mktg_cookie_names(self):
+        # When logged in cookie names are loaded from JSON files, they may
+        # have type `unicode` instead of `str`, which can cause errors
+        # when calling Django cookie manipulation functions.
+        response, _ = self._login_response('test@edx.org', 'test_password')
+        self._assert_response(response, success=True)
+
+        response = self.client.post(reverse('logout'))
+        self.assertRedirects(response, "/")
+
     @patch.dict("django.conf.settings.FEATURES", {'SQUELCH_PII_IN_LOGS': True})
     def test_logout_logging_no_pii(self):
         response, _ = self._login_response('test@edx.org', 'test_password')