From 31646e4a72e2606ffc6098f2d8bb225884426549 Mon Sep 17 00:00:00 2001 From: Dan Powell Date: Tue, 24 Nov 2015 19:27:37 -0500 Subject: [PATCH 1/2] Don't render unconfigured marketing links in CMS footer. --- cms/templates/widgets/footer.html | 26 +++++++++++++++--------- common/djangoapps/edxmako/shortcuts.py | 26 ++++++++++++++++++++++++ common/djangoapps/edxmako/tests.py | 28 ++++++++++++++++++++++++++ 3 files changed, 70 insertions(+), 10 deletions(-) diff --git a/cms/templates/widgets/footer.html b/cms/templates/widgets/footer.html index 8c1e21fbbf..08a9bf2130 100644 --- a/cms/templates/widgets/footer.html +++ b/cms/templates/widgets/footer.html @@ -11,16 +11,22 @@ from django.core.urlresolvers import reverse

© ${settings.COPYRIGHT_YEAR} ${settings.PLATFORM_NAME}.

- + % if is_any_marketing_link_set(['TOS', 'PRIVACY']): + + % endif
diff --git a/common/djangoapps/edxmako/shortcuts.py b/common/djangoapps/edxmako/shortcuts.py index 3e584567cf..3eda270d41 100644 --- a/common/djangoapps/edxmako/shortcuts.py +++ b/common/djangoapps/edxmako/shortcuts.py @@ -57,6 +57,30 @@ def marketing_link(name): return '#' +def is_any_marketing_link_set(names): + """ + Returns a boolean if any given named marketing links are configured. + """ + + return any(is_marketing_link_set(name) for name in names) + + +def is_marketing_link_set(name): + """ + Returns a boolean if a given named marketing link is configured. + """ + + enable_mktg_site = microsite.get_value( + 'ENABLE_MKTG_SITE', + settings.FEATURES.get('ENABLE_MKTG_SITE', False) + ) + + if enable_mktg_site: + return name in settings.MKTG_URLS + else: + return name in settings.MKTG_URL_LINK_MAP + + def marketing_link_context_processor(request): """ A django context processor to give templates access to marketing URLs @@ -112,6 +136,8 @@ def render_to_string(template_name, dictionary, context=None, namespace='main'): context_instance['settings'] = settings context_instance['EDX_ROOT_URL'] = settings.EDX_ROOT_URL context_instance['marketing_link'] = marketing_link + context_instance['is_any_marketing_link_set'] = is_any_marketing_link_set + context_instance['is_marketing_link_set'] = is_marketing_link_set # In various testing contexts, there might not be a current request context. request_context = get_template_request_context() diff --git a/common/djangoapps/edxmako/tests.py b/common/djangoapps/edxmako/tests.py index b77ddfd5ef..9fd7c0357f 100644 --- a/common/djangoapps/edxmako/tests.py +++ b/common/djangoapps/edxmako/tests.py @@ -14,6 +14,8 @@ from edxmako.middleware import get_template_request_context from edxmako import add_lookup, LOOKUP from edxmako.shortcuts import ( marketing_link, + is_marketing_link_set, + is_any_marketing_link_set, render_to_string, open_source_footer_context_processor ) @@ -41,6 +43,32 @@ class ShortcutsTests(UrlResetMixin, TestCase): link = marketing_link('ABOUT') self.assertEquals(link, expected_link) + @override_settings(MKTG_URLS={'ROOT': 'dummy-root', 'ABOUT': '/about-us'}) + @override_settings(MKTG_URL_LINK_MAP={'ABOUT': 'login'}) + def test_is_marketing_link_set(self): + # test marketing site on + with patch.dict('django.conf.settings.FEATURES', {'ENABLE_MKTG_SITE': True}): + self.assertTrue(is_marketing_link_set('ABOUT')) + self.assertFalse(is_marketing_link_set('NOT_CONFIGURED')) + # test marketing site off + with patch.dict('django.conf.settings.FEATURES', {'ENABLE_MKTG_SITE': False}): + self.assertTrue(is_marketing_link_set('ABOUT')) + self.assertFalse(is_marketing_link_set('NOT_CONFIGURED')) + + @override_settings(MKTG_URLS={'ROOT': 'dummy-root', 'ABOUT': '/about-us'}) + @override_settings(MKTG_URL_LINK_MAP={'ABOUT': 'login'}) + def test_is_any_marketing_link_set(self): + # test marketing site on + with patch.dict('django.conf.settings.FEATURES', {'ENABLE_MKTG_SITE': True}): + self.assertTrue(is_any_marketing_link_set(['ABOUT'])) + self.assertTrue(is_any_marketing_link_set(['ABOUT', 'NOT_CONFIGURED'])) + self.assertFalse(is_any_marketing_link_set(['NOT_CONFIGURED'])) + # test marketing site off + with patch.dict('django.conf.settings.FEATURES', {'ENABLE_MKTG_SITE': False}): + self.assertTrue(is_any_marketing_link_set(['ABOUT'])) + self.assertTrue(is_any_marketing_link_set(['ABOUT', 'NOT_CONFIGURED'])) + self.assertFalse(is_any_marketing_link_set(['NOT_CONFIGURED'])) + @ddt.data((True, None), (False, None)) @ddt.unpack def test_edx_footer(self, expected_result, _): From 696e1962d9a293443c8c3b6bbfe298bbc809cc44 Mon Sep 17 00:00:00 2001 From: Dan Powell Date: Tue, 24 Nov 2015 19:30:36 -0500 Subject: [PATCH 2/2] Add Dan Powell to AUTHORS --- AUTHORS | 1 + 1 file changed, 1 insertion(+) diff --git a/AUTHORS b/AUTHORS index 8026729689..eb566a264f 100644 --- a/AUTHORS +++ b/AUTHORS @@ -257,3 +257,4 @@ Muhammad Rehan Shawn Milochik Afeef Janjua Jacek Bzdak +Dan Powell