Add default response for terms and privacy endpoints.

- Add setting for `privacy policy` template defining. - Configure default templates for `privacy policy` and `terms of service` pages. - Add route for privacy page. - Remove condition for showing `privacy` and `terms` pages. - Add `privacy_policy` setting to context processor. - Add documentaion part for `privacy` and `terms` templates configuration. - Add tests. Fixes zulip#3686.
JimGomez48 · Apr 12, 2017 · 4891a8d · 4891a8d
1 parent 3d4020f
commit 4891a8d
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 24 deletions.
diff --git a/corporate/urls.py b/corporate/urls.py
@@ -5,9 +5,6 @@
     # Zephyr/MIT
     url(r'^zephyr/$', TemplateView.as_view(template_name='corporate/zephyr.html')),
     url(r'^zephyr-mirror/$', TemplateView.as_view(template_name='corporate/zephyr-mirror.html')),
-
-    # Privacy policy
-    url(r'^privacy/$', TemplateView.as_view(template_name='corporate/privacy.html')),
 ]
 
 urlpatterns = i18n_urlpatterns
diff --git a/docs/prod-customize.md b/docs/prod-customize.md
@@ -1,12 +1,13 @@
 # Customize Zulip
 
 Once you've got Zulip setup, you'll likely want to configure it the
-way you like.  There are four big things to focus on:
+way you like.  There are several things to focus on:
 
 1. [Integrations](#integrations)
 2. [Streams and Topics](#streams-and-topics)
 3. [Notification settings](#notification-settings)
 4. [Mobile and desktop apps](#mobile-and-desktop-apps)
+5. [Terms of service and Privacy policy](#terms-of-service-and-privacy-policy)
 
 Lastly, read about Zulip's other [great features](#all-other-features), and
 then [enjoy your Zulip installation](#enjoy-your-zulip-installation)!
@@ -70,6 +71,16 @@ over which messages trigger desktop notifications; you can configure
 these extensively in the `/#settings` page (get there from the gear
 menu).
 
+## Terms of service and Privacy policy
+
+Zulip allows you to configure your server's Terms of Service and
+Privacy Policy pages (`/terms` and `/privacy`, respectively).  You can
+use the `TERMS_OF_SERVICE` and `PRIVACY_POLICY` settings to configure
+the path to your server's policies.  The syntax is Markdown (with
+support for included HTML).  A good approach is to use paths like
+`/etc/zulip/terms.md`, so that it's easy to back up your policy
+configuration along with your other Zulip server configuration.
+
 ## Mobile and desktop apps
 
 Currently, the Zulip Desktop app

diff --git a/templates/zerver/portico.html b/templates/zerver/portico.html
@@ -67,19 +67,12 @@
             {% if about_link_disabled %}
             {% else %}
             <li><a href="{{ server_uri }}/hello">{{ _('About') }}</a></li>
+            <li><span class="little-bullet">·</span></li>
             {% endif %}
 
-            {% if terms_of_service %}
-                {% if about_link_disabled %}
-                {% else %}
-                <li><span class="little-bullet">·</span></li>
-                {% endif %}
-
-                <li><a href="{{ server_uri }}/terms">{{ _('Legal') }}</a></li>
-                <li><span class="little-bullet">·</span></li>
-                <li><a href="{{ server_uri }}/privacy">{{ _('Privacy') }}</a></li>
-            {% endif %}
-
+            <li><a href="{{ server_uri }}/terms">{{ _('Legal') }}</a></li>
+            <li><span class="little-bullet">·</span></li>
+            <li><a href="{{ server_uri }}/privacy">{{ _('Privacy') }}</a></li>
             <li><span class="little-bullet">·</span></li>
             <li><a href="{{ server_uri }}/features">{{ _('Features') }}</a></li>
             <li><span class="little-bullet">·</span></li>

diff --git a/templates/zerver/privacy.html b/templates/zerver/privacy.html
@@ -0,0 +1,22 @@
+{% extends "zerver/portico.html" %}
+
+{# Privacy policy. #}
+
+{% block portico_content %}
+
+<div class="app terms-page">
+    <div class="app-main terms-page-container">
+
+        {% if privacy_policy %}
+            {{ privacy_policy|render_markdown_path }}
+        {% else %}
+            {% trans %}
+            This installation of Zulip does not have a configured privacy policy.
+            Contact this <a href="mailto:{{ support_email }}">server's administrator</a>
+            if you have any questions.
+            {% endtrans %}
+        {% endif %}
+    </div>
+</div>
+
+{% endblock %}
diff --git a/templates/zerver/terms.html b/templates/zerver/terms.html
@@ -6,9 +6,14 @@
 
 <div class="app terms-page">
     <div class="app-main terms-page-container">
-
         {% if terms_of_service %}
-        {{ terms_of_service|render_markdown_path }}
+            {{ terms_of_service|render_markdown_path }}
+        {% else %}
+            {% trans %}
+            This installation of Zulip does not have a configured terms of service.
+            Contact this <a href="mailto:{{ support_email }}">server's administrator</a>
+            if you have any questions.
+            {% endtrans %}
         {% endif %}
     </div>
 </div>

diff --git a/zerver/context_processors.py b/zerver/context_processors.py
@@ -43,6 +43,7 @@ def add_settings(request):
         'show_oss_announcement': settings.SHOW_OSS_ANNOUNCEMENT,
         'zulip_admin': settings.ZULIP_ADMINISTRATOR,
         'terms_of_service': settings.TERMS_OF_SERVICE,
+        'privacy_policy': settings.PRIVACY_POLICY,
         'login_url': settings.HOME_NOT_LOGGED_IN,
         'only_sso': settings.ONLY_SSO,
         'external_api_path': settings.EXTERNAL_API_PATH,

diff --git a/zerver/tests/test_templates.py b/zerver/tests/test_templates.py
@@ -115,7 +115,9 @@ def test_templates(self):
 
         integrations_regexp = re.compile('zerver/integrations/.*.html')
 
-        skip = covered + defer + logged_out + logged_in + unusual + ['tests/test_markdown.html', 'zerver/terms.html']
+        skip = covered + defer + logged_out + logged_in + unusual + ['tests/test_markdown.html',
+                                                                     'zerver/terms.html',
+                                                                     'zerver/privacy.html']
         templates = [t for t in get_all_templates() if not (t in skip or integrations_regexp.match(t))]
         self.render_templates(templates, self.get_context())
 
@@ -211,3 +213,27 @@ def test_custom_tos_template(self):
         self.assert_in_success_response([u"Thanks for using our products and services (\"Services\"). ",
                                          u"By using our Services, you are agreeing to these terms"],
                                         response)
+
+    def test_custom_terms_of_service_template(self):
+        # type: () -> None
+        not_configured_message = 'This Zulip server does not have a configured ' \
+                                 '<strong>terms of service</strong>'
+        with self.settings(TERMS_OF_SERVICE=None):
+            response = self.client_get('/terms/')
+        self.assert_in_success_response([not_configured_message], response)
+        with self.settings(TERMS_OF_SERVICE='zerver/tests/markdown/test_markdown.md'):
+            response = self.client_get('/terms/')
+        self.assert_in_success_response(['This is some <em>bold text</em>.'], response)
+        self.assert_not_in_success_response([not_configured_message], response)
+
+    def test_custom_privacy_policy_template(self):
+        # type: () -> None
+        not_configured_message = 'This Zulip server does not have a configured ' \
+                                 '<strong>privacy policy</strong>'
+        with self.settings(PRIVACY_POLICY=None):
+            response = self.client_get('/privacy/')
+        self.assert_in_success_response([not_configured_message], response)
+        with self.settings(PRIVACY_POLICY='zerver/tests/markdown/test_markdown.md'):
+            response = self.client_get('/privacy/')
+        self.assert_in_success_response(['This is some <em>bold text</em>.'], response)
+        self.assert_not_in_success_response([not_configured_message], response)
diff --git a/zproject/dev_settings.py b/zproject/dev_settings.py
@@ -37,7 +37,6 @@
 # Disable Camo in development
 CAMO_URI = ''
 OPEN_REALM_CREATION = True
-TERMS_OF_SERVICE = 'zproject/terms.md.template'
 
 SAVE_FRONTEND_STACKTRACES = True
 EVENT_LOGS_ENABLED = True

diff --git a/zproject/settings.py b/zproject/settings.py
@@ -197,6 +197,7 @@ def get_secret(key):
                     },
                     'REALM_CREATION_LINK_VALIDITY_DAYS': 7,
                     'TERMS_OF_SERVICE': None,
+                    'PRIVACY_POLICY': None,
                     'TOS_VERSION': None,
                     'SYSTEM_ONLY_REALMS': {"zulip"},
                     'FIRST_TIME_TOS_TEMPLATE': None,

diff --git a/zproject/urls.py b/zproject/urls.py
@@ -144,12 +144,12 @@
     url(r'^new-user/$', RedirectView.as_view(url='/hello', permanent=True)),
     url(r'^features/$', TemplateView.as_view(template_name='zerver/features.html')),
     url(r'^find_my_team/$', zerver.views.registration.find_my_team, name='zerver.views.registration.find_my_team'),
-    url(r'^authors/$', zerver.views.users.authors_view, name='zerver.views.users.authors_view')
-]
+    url(r'^authors/$', zerver.views.users.authors_view, name='zerver.views.users.authors_view'),
 
-# If a Terms of Service is supplied, add that route
-if settings.TERMS_OF_SERVICE is not None:
-    i18n_urls += [url(r'^terms/$', TemplateView.as_view(template_name='zerver/terms.html'))]
+    # Terms of service and privacy pages.
+    url(r'^terms/$', TemplateView.as_view(template_name='zerver/terms.html'), name='terms'),
+    url(r'^privacy/$', TemplateView.as_view(template_name='zerver/privacy.html'), name='privacy'),
+]
 
 # Make a copy of i18n_urls so that they appear without prefix for english
 urls = list(i18n_urls)