From c887f8f2765c13e392200da862eb210e1f28b09b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20P=C3=A9ters?= <fpeters@entrouvert.com>
Date: Thu, 7 Jun 2018 09:38:15 +0200
Subject: [PATCH] misc: give widget templates full access to publisher context
 (#24338)

---
 tests/templates/qommon/forms/widgets/select--test.html | 1 +
 tests/test_form_pages.py                               | 9 +++++++++
 wcs/qommon/form.py                                     | 6 +++++-
 3 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/tests/templates/qommon/forms/widgets/select--test.html b/tests/templates/qommon/forms/widgets/select--test.html
index 688f8db5..98a2cba8 100644
--- a/tests/templates/qommon/forms/widgets/select--test.html
+++ b/tests/templates/qommon/forms/widgets/select--test.html
@@ -2,6 +2,7 @@
 {% block widget-control %}
 <!-- TEST TEMPLATE -->
 <!-- backoffice: {{ request.quixote_request.is_in_backoffice|pprint }} -->
+<!-- substitution variable: {{ example_url }} -->
 <select id="form_{{widget.name}}" name="{{widget.name}}"
     {% for attr in widget.attrs.items %}{{attr.0}}="{{attr.1}}"{% endfor %}>
   <option value="">---</option>
diff --git a/tests/test_form_pages.py b/tests/test_form_pages.py
index 0b8376d0..165ca11b 100644
--- a/tests/test_form_pages.py
+++ b/tests/test_form_pages.py
@@ -4581,6 +4581,15 @@ def test_form_custom_select_template(pub):
     # make sure request is available in context
     assert '<!-- backoffice: False -->' in resp.body
 
+    # test for substitution variables being available
+    if not pub.site_options.has_section('variables'):
+        pub.site_options.add_section('variables')
+    pub.site_options.set('variables', 'example_url', 'http://remote.example.net/')
+    with open(os.path.join(pub.app_dir, 'site-options.cfg'), 'w') as fd:
+        pub.site_options.write(fd)
+    resp = get_app(pub).get('/test/')
+    assert 'substitution variable: http://remote.example.net/' in resp.body
+
 def test_form_status_appearance_keywords(pub):
     create_user(pub)
     formdef = create_formdef()
diff --git a/wcs/qommon/form.py b/wcs/qommon/form.py
index 3e020e53..7ee32d59 100644
--- a/wcs/qommon/form.py
+++ b/wcs/qommon/form.py
@@ -128,7 +128,11 @@ def render(self):
     self.rendered_title = lambda: safe(self.render_title(self.get_title()))
     self.rendered_error = lambda: safe(self.render_error(self.get_error()))
     self.rendered_hint = lambda: safe(self.render_hint(self.get_hint()))
-    context = {'widget': self}
+    if get_publisher():
+        context = get_publisher().substitutions.get_context_variables()
+    else:
+        context = {}
+    context['widget'] = self
     template_names = get_template_names(self)
     return htmltext(render_template(template_names, context))
 
-- 
2.17.1