Changeset 5690

Timestamp:

11/17/08 06:36:45 (2 months ago)

Author:

carndt

Message:

Adding new 'absolute_url' function to 'controllers' module. Fixes #316

Files:

• branches/1.1/CHANGELOG.txt (modified) (1 diff)
• branches/1.1/turbogears/controllers.py (modified) (2 diffs)
• branches/1.1/turbogears/__init__.py (modified) (2 diffs)
• branches/1.1/turbogears/tests/test_controllers.py (modified) (3 diffs)

branches/1.1/CHANGELOG.txt

@@ -26 +26 @@
-* New config option ``safempfilter.on`` to enable the ``SafeMultipartFilter``
-  (see end of ``app.cfg`` in a quickstarted project for usage example) (r5666).
-
+
+
-
-Changes

branches/1.1/turbogears/controllers.py

@@ -558 +558 @@
-    return tgpath
-
+def get_server_name():
+    """Return name of the server this application runs on.
+
+    Respects 'Host' and 'X-Forwarded-Host' header.
+
+    See the docstring of the 'absolute_url' function for more information.
+
+    """
+    get = config.get
+    h = request.headers
+    host = get('tg.url_domain') or h.get('X-Forwarded-Host', h.get('Host'))
+    if not host:
+        host = '%s:%s' % (get('server.socket_host', 'localhost'),
+            get('server.socket_port', 8080))
+    return host
+
+def absolute_url(tgpath='/', params=None, **kw):
+    """Return absolute URL (including schema and host to this server).
+
+    Tries to account for 'Host' header and reverse proxying
+    ('X-Forwarded-Host').
+
+    The host name is determined this way:
+
+    * If the config setting 'tg.url_domain' is set and non-null, use this value.
+    * Else, if the 'base_url_filter.use_x_forwarded_host' config setting is
+      True, use the value from the 'Host' or 'X-Forwarded-Host' request header.
+    * Else, if config setting 'base_url_filter.on' is True and
+      'base_url_filter.base_url' is non-null, use its value for the host AND
+      scheme part of the URL.
+    * As a last fallback, use the value of 'server.socket_host' and
+      'server.socket_port' config settings (defaults to 'localhost:8080').
+
+    The URL scheme ('http' or 'http') used is determined in the following way:
+
+    * If 'base_url_filter.base_url' is used, use the scheme from this URL.
+    * If there is a 'X-Use-SSL' request header, use 'https'.
+    * Else, if the config setting 'tg.url_scheme' is set, use its value.
+    * Else, use the value of 'cherrypy.request.scheme'.
+
+    """
+    get = config.get
+    use_xfh = get('base_url_filter.use_x_forwarded_host', False)
+    if request.headers.get('X-Use-SSL'):
+        scheme = 'https'
+    else:
+        scheme = get('tg.url_scheme')
+    if not scheme:
+        scheme = request.scheme
+    base_url = '%s://%s' % (scheme, get_server_name())
+    if get('base_url_filter.on', False) and not use_xfh:
+        base_url = get('base_url_filter.base_url').rstrip('/')
+    return '%s%s' % (base_url, url(tgpath, params, **kw))
-
-def check_app_root():
@@ -610 +663 @@
-__all__ = [
-    "Controller",
+    "absolute_url",
-    "error_handler",
-    "exception_handler",
-    "expose",
+    "get_server_name",
-    "flash",
-    "redirect",

branches/1.1/turbogears/__init__.py

@@ -4 +4 @@
-
-from turbogears import config
-
-
-
-
-
-
-
+
+
+
+
+
+
-from turbogears.widgets import mochikit
-from turbogears.widgets import jsi18nwidget
@@ -27 +26 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

branches/1.1/turbogears/tests/test_controllers.py

@@ -4 +4 @@
-import cherrypy
-import pkg_resources
-config, controllers, database, \
-\
-startup, testutil, url, validate, validators, util
+(absolute_url, config, controllers, database,
+startup,
+testutil, url, util, validate, validators)
-
-
@@ -264 +264 @@
-        return
-
+    @expose()
+    def absolute_url(self, url='/'):
+        return absolute_url(url)
-
-class TestRoot(testutil.TGTest):
@@ -723 +726 @@
-        assert 'foo' in url('/foo', params, spamm='ham')
-        assert params['spamm'] == 'eggs'
+
+class TestAbsoluteURLs(testutil.TGTest):
+    root = MyRoot
+
+    #def setUp(self):
+    #    super(TestAbsoluteURLs, self).setUp()
+    #
+    #def tearDown(self):
+    #    super(TestAbsoluteURLs, self).tearDown()
+    #    config.update({"server.webpath": ""})
+
+    def _config_update(self, data=None, **kw):
+        self.config_backup = {}
+        if not data:
+            data = {}
+        else:
+            data = data.copy()
+        data.update(kw)
+        for k in data:
+            self.config_backup[k] = config.get(k)
+        config.update(data)
+
+    def _config_reset(self):
+        config.update(self.config_backup)
+
+    def test_scheme_from_config(self):
+        """absolute_url() gets correct URL scheme from 'tg.url_scheme' setting
+        """
+        hostname = 'foo.org'
+        scheme = 'https'
+        self._config_update({
+            "base_url_filter.on": False,
+            "base_url_filter.use_x_forwarded_host": True,
+            "tg.url_scheme": scheme
+        })
+        url = self.app.get('/absolute_url/?url=%2Ffoo',
+            headers={'X-Forwarded-Host': hostname}).body
+        self._config_reset()
+        print url
+        assert url == '%s://%s/foo' % (scheme, hostname)
+
+    def test_scheme_from_header(self):
+        """absolute_url() gets correct URL scheme from 'X-Use-SSL' header"""
+        hostname = 'foo.org'
+        scheme = 'https'
+        self._config_update({
+            "base_url_filter.on": False,
+            "base_url_filter.use_x_forwarded_host": True,
+        })
+        url = self.app.get('/absolute_url/?url=%2Ffoo',
+            headers={'X-Forwarded-Host': hostname, 'X-Use-SSL': scheme}).body
+        self._config_reset()
+        print url
+        assert url == '%s://%s/foo' % (scheme, hostname)
+
+    def test_use_base_url(self):
+        """absolute_url() gets correct host name from 'base_url' setting"""
+        hostname = 'foo.org'
+        port = 1234
+        self._config_update({
+            "base_url_filter.on": True,
+            "base_url_filter.use_x_forwarded_host": False,
+            "base_url_filter.base_url": 'http://%s:%s' % (hostname, port)
+        })
+        url = self.app.get('/absolute_url/?url=%2Ffoo').body
+        self._config_reset()
+        print url
+        assert url == 'http://%s:%s/foo' % (hostname, port)
+
+    def test_use_config(self):
+        """absolute_url() gets correct host name from 'tg.url_domain' setting"""
+        hostname = 'foo.org'
+        port = 1234
+        self._config_update({
+            "base_url_filter.on": False,
+            "base_url_filter.use_x_forwarded_host": False,
+            "tg.url_domain": '%s:%s' % (hostname, port)
+        })
+        url = self.app.get('/absolute_url/?url=%2Ffoo').body
+        self._config_reset()
+        print url
+        assert url == 'http://%s:%s/foo' % (hostname, port)
+
+    def test_use_host(self):
+        """absolute_url() gets correct host name from 'Host' header"""
+        self._config_update({
+            "base_url_filter.on": False,
+            "base_url_filter.use_x_forwarded_host": False,
+        })
+        hostname = 'foo.org'
+        url = self.app.get('/absolute_url/?url=%2Ffoo',
+            headers={'Host': hostname}).body
+        self._config_reset()
+        print url
+        assert url == 'http://%s/foo' % hostname
+
+    def test_use_server_config(self):
+        """absolute_url() gets correct host name from server config"""
+        hostname = 'foo.org'
+        port = 1234
+        self._config_update({
+            "base_url_filter.on": False,
+            "base_url_filter.use_x_forwarded_host": False,
+            'server.socket_host': hostname,
+            'server.socket_port': port
+        })
+        url = self.app.get('/absolute_url/?url=%2Ffoo',
+            headers={'Host': ''}).body
+        self._config_reset()
+        print url
+        assert url == 'http://%s:%s/foo' % (hostname, port)
+
+    def test_use_x_forwarded_host(self):
+        """absolute_url() gets correct host name from 'X-Forwarded-Host' header"""
+        self._config_update({
+            "base_url_filter.on": False,
+            "base_url_filter.use_x_forwarded_host": True,
+        })
+        hostname = 'foo.org'
+        url = self.app.get('/absolute_url/?url=%2Ffoo',
+            headers={'X-Forwarded-Host': hostname}).body
+        self._config_reset()
+        print url
+        assert url == 'http://%s/foo' % hostname