Merge pull request #2553 from edx/cdodge/microsite-cleanup

Address Microsite PR feedback - separate out middleware from microsite logic, shor...

Author: chrisndodge

cms/djangoapps/contentstore/views/course.py

@@ -55,7 +55,7 @@
 from student.roles import CourseInstructorRole, CourseStaffRole, CourseCreatorRole, GlobalStaff
 from student import auth
 
-from microsite_configuration.middleware import MicrositeConfiguration
+from microsite_configuration import microsite
 
 __all__ = ['course_info_handler', 'course_handler', 'course_info_update_handler',
            'settings_handler',
@@ -535,7 +535,7 @@ def settings_handler(request, tag=None, package_id=None, branch=None, version_gu
 
         # see if the ORG of this course can be attributed to a 'Microsite'. In that case, the
         # course about page should be editable in Studio
-        about_page_editable = not MicrositeConfiguration.get_microsite_configuration_value_for_org(
+        about_page_editable = not microsite.get_value_for_org(
             course_module.location.org,
             'ENABLE_MKTG_SITE',
             settings.FEATURES.get('ENABLE_MKTG_SITE', False)

cms/djangoapps/contentstore/views/public.py

@@ -10,7 +10,7 @@
 from edxmako.shortcuts import render_to_response
 
 from external_auth.views import ssl_login_shortcut, ssl_get_cert_from_request
-from microsite_configuration.middleware import MicrositeConfiguration
+from microsite_configuration import microsite
 
 __all__ = ['signup', 'login_page', 'howitworks']
 
@@ -49,7 +49,7 @@ def login_page(request):
         {
             'csrf': csrf_token,
             'forgot_password_link': "//{base}/login#forgot-password-modal".format(base=settings.LMS_BASE),
-            'platform_name': MicrositeConfiguration.get_microsite_configuration_value('platform_name', settings.PLATFORM_NAME),
+            'platform_name': microsite.get_value('platform_name', settings.PLATFORM_NAME),
         }
     )
 

cms/envs/aws.py

@@ -239,16 +239,8 @@
 MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED = ENV_TOKENS.get("MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED", 5)
 MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS = ENV_TOKENS.get("MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS", 15 * 60)
 
-
 MICROSITE_CONFIGURATION = ENV_TOKENS.get('MICROSITE_CONFIGURATION', {})
-MICROSITE_ROOT_DIR = ENV_TOKENS.get('MICROSITE_ROOT_DIR')
-if len(MICROSITE_CONFIGURATION.keys()) > 0:
-    enable_microsites(
-        MICROSITE_CONFIGURATION,
-        SUBDOMAIN_BRANDING,
-        VIRTUAL_UNIVERSITIES,
-        microsites_root=path(MICROSITE_ROOT_DIR)
-    )
+MICROSITE_ROOT_DIR = path(ENV_TOKENS.get('MICROSITE_ROOT_DIR', ''))
 
 #### PASSWORD POLICY SETTINGS #####
 PASSWORD_MIN_LENGTH = ENV_TOKENS.get("PASSWORD_MIN_LENGTH")

cms/envs/common.py

@@ -27,7 +27,7 @@
 import sys
 import lms.envs.common
 from lms.envs.common import (
-    USE_TZ, TECH_SUPPORT_EMAIL, PLATFORM_NAME, BUGS_EMAIL, DOC_STORE_CONFIG, enable_microsites, ALL_LANGUAGES
+    USE_TZ, TECH_SUPPORT_EMAIL, PLATFORM_NAME, BUGS_EMAIL, DOC_STORE_CONFIG, ALL_LANGUAGES
 )
 from path import path
 
@@ -84,6 +84,9 @@
 
     # Toggles embargo functionality
     'EMBARGO': False,
+
+    # Turn on/off Microsites feature
+    'USE_MICROSITES': False,
 }
 ENABLE_JASMINE = False
 

cms/envs/microsite_test.py

@@ -6,10 +6,7 @@
 # pylint: disable=W0401, W0614
 
 from .dev import *
-from .dev import SUBDOMAIN_BRANDING, VIRTUAL_UNIVERSITIES
 
 MICROSITE_NAMES = ['openedx']
 MICROSITE_CONFIGURATION = {}
-
-if MICROSITE_NAMES and len(MICROSITE_NAMES) > 0:
-    enable_microsites(MICROSITE_NAMES, MICROSITE_CONFIGURATION, SUBDOMAIN_BRANDING, VIRTUAL_UNIVERSITIES)
+FEATURES['USE_MICROSITES'] = True

cms/envs/test.py

@@ -199,3 +199,31 @@
 
 # Toggles embargo on for testing
 FEATURES['EMBARGO'] = True
+
+# set up some testing for microsites
+MICROSITE_CONFIGURATION = {
+    "test_microsite": {
+        "domain_prefix": "testmicrosite",
+        "university": "test_microsite",
+        "platform_name": "Test Microsite",
+        "logo_image_url": "test_microsite/images/header-logo.png",
+        "email_from_address": "[email protected]",
+        "payment_support_email": "[email protected]",
+        "ENABLE_MKTG_SITE": False,
+        "SITE_NAME": "test_microsite.localhost",
+        "course_org_filter": "TestMicrositeX",
+        "course_about_show_social_links": False,
+        "css_overrides_file": "test_microsite/css/test_microsite.css",
+        "show_partners": False,
+        "show_homepage_promo_video": False,
+        "course_index_overlay_text": "This is a Test Microsite Overlay Text.",
+        "course_index_overlay_logo_file": "test_microsite/images/header-logo.png",
+        "homepage_overlay_html": "<h1>This is a Test Microsite Overlay HTML</h1>"
+    },
+    "default": {
+        "university": "default_university",
+        "domain_prefix": "www",
+    }
+}
+MICROSITE_ROOT_DIR = COMMON_ROOT / 'test' / 'test_microsites'
+FEATURES['USE_MICROSITES'] = True

common/djangoapps/edxmako/shortcuts.py

@@ -16,7 +16,7 @@
 from django.http import HttpResponse
 import logging
 
-from microsite_configuration.middleware import MicrositeConfiguration
+from microsite_configuration import microsite
 
 from edxmako import lookup_template
 import edxmako.middleware
@@ -37,7 +37,7 @@ def marketing_link(name):
     # link_map maps URLs from the marketing site to the old equivalent on
     # the Django site
     link_map = settings.MKTG_URL_LINK_MAP
-    enable_mktg_site = MicrositeConfiguration.get_microsite_configuration_value(
+    enable_mktg_site = microsite.get_value(
         'ENABLE_MKTG_SITE',
         settings.FEATURES.get('ENABLE_MKTG_SITE', False)
     )
@@ -80,7 +80,7 @@ def marketing_link_context_processor(request):
 def render_to_string(template_name, dictionary, context=None, namespace='main'):
 
     # see if there is an override template defined in the microsite
-    template_name = MicrositeConfiguration.get_microsite_template_path(template_name)
+    template_name = microsite.get_template_path(template_name)
 
     context_instance = Context(dictionary)
     # add dictionary to context_instance
@@ -111,7 +111,7 @@ def render_to_response(template_name, dictionary=None, context_instance=None, na
     """
 
     # see if there is an override template defined in the microsite
-    template_name = MicrositeConfiguration.get_microsite_template_path(template_name)
+    template_name = microsite.get_template_path(template_name)
 
     dictionary = dictionary or {}
     return HttpResponse(render_to_string(template_name, dictionary, context_instance, namespace), **kwargs)

common/djangoapps/edxmako/startup.py

@@ -8,6 +8,9 @@
 def run():
     """
     Setup mako lookup directories.
+
+    IMPORTANT: This method can be called multiple times during application startup. Any changes to this method
+    must be safe for multiple callers during startup phase.
     """
     template_locations = settings.MAKO_TEMPLATES
     for namespace, directories in template_locations.items():

common/djangoapps/microsite_configuration/microsite.py

@@ -0,0 +1,142 @@
+"""
+This file implements the Microsite support for the Open edX platform.
+A microsite enables the following features:
+
+1) Mapping of sub-domain name to a 'brand', e.g. foo-university.edx.org
+2) Present a landing page with a listing of courses that are specific to the 'brand'
+3) Ability to swap out some branding elements in the website
+"""
+import threading
+import os.path
+
+from django.conf import settings
+
+CURRENT_REQUEST_CONFIGURATION = threading.local()
+CURRENT_REQUEST_CONFIGURATION.data = {}
+
+
+def has_configuration_set():
+    """
+    Returns whether there is any Microsite configuration settings
+    """
+    return getattr(settings, "MICROSITE_CONFIGURATION", False)
+
+
+def get_configuration():
+    """
+    Returns the current request's microsite configuration
+    """
+    if not hasattr(CURRENT_REQUEST_CONFIGURATION, 'data'):
+        return {}
+
+    return CURRENT_REQUEST_CONFIGURATION.data
+
+
+def is_request_in_microsite():
+    """
+    This will return if current request is a request within a microsite
+    """
+    return get_configuration()
+
+
+def get_value(val_name, default=None):
+    """
+    Returns a value associated with the request's microsite, if present
+    """
+    configuration = get_configuration()
+    return configuration.get(val_name, default)
+
+
+def get_template_path(relative_path):
+    """
+    Returns a path (string) to a Mako template, which can either be in
+    a microsite directory (as an override) or will just return what is passed in which is
+    expected to be a string
+    """
+
+    if not is_request_in_microsite():
+        return relative_path
+
+    microsite_template_path = str(get_value('template_dir'))
+
+    if microsite_template_path:
+        search_path = os.path.join(microsite_template_path, relative_path)
+
+        if os.path.isfile(search_path):
+            path = '{0}/templates/{1}'.format(
+                get_value('microsite_name'),
+                relative_path
+            )
+            return path
+
+    return relative_path
+
+
+def get_value_for_org(org, val_name, default=None):
+    """
+    This returns a configuration value for a microsite which has an org_filter that matches
+    what is passed in
+    """
+    if not has_configuration_set():
+        return default
+
+    for value in settings.MICROSITE_CONFIGURATION.values():
+        org_filter = value.get('course_org_filter', None)
+        if org_filter == org:
+            return value.get(val_name, default)
+    return default
+
+
+def get_all_orgs():
+    """
+    This returns a set of orgs that are considered within a microsite. This can be used,
+    for example, to do filtering
+    """
+    org_filter_set = set()
+    if not has_configuration_set():
+        return org_filter_set
+
+    for value in settings.MICROSITE_CONFIGURATION.values():
+        org_filter = value.get('course_org_filter')
+        if org_filter:
+            org_filter_set.add(org_filter)
+
+    return org_filter_set
+
+
+def clear():
+    """
+    Clears out any microsite configuration from the current request/thread
+    """
+    CURRENT_REQUEST_CONFIGURATION.data = {}
+
+
+def _set_current_microsite(microsite_config_key, subdomain, domain):
+    """
+    Helper internal method to actually put a microsite on the threadlocal
+    """
+    config = settings.MICROSITE_CONFIGURATION[microsite_config_key].copy()
+    config['subdomain'] = subdomain
+    config['site_domain'] = domain
+    CURRENT_REQUEST_CONFIGURATION.data = config
+
+
+def set_by_domain(domain):
+    """
+    For a given request domain, find a match in our microsite configuration and then assign
+    it to the thread local so that it is available throughout the entire
+    Django request processing
+    """
+    if not has_configuration_set() or not domain:
+        return
+
+    for key, value in settings.MICROSITE_CONFIGURATION.items():
+        subdomain = value.get('domain_prefix')
+        if subdomain and domain.startswith(subdomain):
+            _set_current_microsite(key, subdomain, domain)
+            return
+
+    # if no match on subdomain then see if there is a 'default' microsite defined
+    # if so, then use that
+    if 'default' in settings.MICROSITE_CONFIGURATION:
+        _set_current_microsite('default', subdomain, domain)