Changeset 909:423e80aa13a9

Timestamp:

01/06/09 03:43:23 (3 years ago)

Author:

mitsuhiko

Branch:

default

Message:

Added support for BEHIND_PROXY and documented environment variables in the README file of the servers.

Files:

• servers/README (modified) (1 diff)
• servers/zine.cgi (modified) (3 diffs)
• servers/zine.fcgi (modified) (2 diffs)
• servers/zine.wsgi (modified) (3 diffs)
• zine/__init__.py (modified) (1 diff)
• zine/_core.py (modified) (2 diffs)
• zine/application.py (modified) (3 diffs)

servers/README

@@ -22 +22 @@
 Just take the file of choice, copy it to where you want it to be and
 adjust it.
+
+All this files have some variables you can configure and invoke the
+actual handler code.  Variables written in uppercase are there for
+you to change if you want.
+
+Some of these can be set from the process environment as well (for
+example via the apache `SetEnv` directive) if you prefix them with
+``ZINE_``.  This works for the following keys:
+
+`POOL_SIZE`
+    The size of the pool to be maintained.  This is the largest number
+    of connections that will be kept persistently in the pool.  Note
+    that the pool begins with no connections; once this number of
+    connections is requested, that number of connections will remain.
+    Defaults to 5.
+    If you are deploying Zine in a forking environment you want to set
+    this number to 1 or 2.
+
+`POOL_RECYCLE`
+    If set to non -1, number of seconds between connection recycling,
+    which means upon checkout, if this timeout is surpassed the
+    connection will be closed and replaced with a newly opened
+    connection.  Defaults to -1.
+
+`POOL_TIMEOUT`
+    The number of seconds to wait before giving up on returning a
+    connection.  Defaults to 30.
+
+`BEHIND_PROXY`
+    If you are proxying into Zine somehow (caching proxies or external
+    fastcgi/http servers) set this value to True to enable proxy support.
+    Do not set this to True if you are not using proxies as this would
+    be a security risk.
+    If you specify this value from the process environment use the values
+    ``1`` and ``0`` instead of ``True`` and ``False``.

servers/zine.cgi

@@ -6 +6 @@
 
     Run Zine as CGI. Requires python 2.5 or python 2.4 with
-    the wsgiref module installed.
+    the wsgiref module installed.  For help con configuration
+    have a look at the README file.
 
-    :copyright: 2008 by Armin Ronacher.
+    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -20 +21 @@
 ZINE_LIB = '/usr/lib/zine'
 
+# these values can be use to override database pool settings.
+# see deployment guide for more details.
+POOL_SIZE = None
+POOL_RECYCLE = None
+POOL_TIMEOUT = None
+
+# if you are proxying into zine somehow (caching proxies or external
+# fastcgi servers) set this value to True to enable proxy support.  Do
+# not set this to True if you are not using proxies as this would be a
+# security risk.
+BEHIND_PROXY = None
+
 # enable this to enable an internal CGI debugging feature.
 CGI_DEBUG = False
 
 
+# ----------------------------------------------------------------------------
 # here you can further configure the wsgi app settings but usually you don't
 # have to touch them
@@ -33 +47 @@
 sys.path.insert(0, ZINE_LIB)
 
-from zine import get_wsgi_app
+from zine import get_wsgi_app, override_environ_config
 from wsgiref.handlers import CGIHandler
+override_environ_config(POOL_SIZE, POOL_RECYCLE, POOL_TIMEOUT, BEHIND_PROXY)
 app = get_wsgi_app(INSTANCE_FOLDER)
 

servers/zine.fcgi

@@ -8 +8 @@
     For working FastCGI support you have to have flup installed.
 
-    :copyright: 2008 by Armin Ronacher.
+    For help on configuration have a look at the README file.
+
+    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -26 +28 @@
 POOL_TIMEOUT = None
 
+# if you are proxying into zine somehow (caching proxies or external
+# fastcgi servers) set this value to True to enable proxy support.  Do
+# not set this to True if you are not using proxies as this would be a
+# security risk.
+BEHIND_PROXY = None
+
 # ----------------------------------------------------------------------------
 # here you can further configure the fastcgi and wsgi app settings
 # but usually you don't have to touch them.
 import sys
-import os
-
 sys.path.insert(0, ZINE_LIB)
 
-for key in 'POOL_SIZE', 'POOL_RECYCLE', 'POOL_TIMEOUT':
-    value = locals().get(key)
-    if value is not None:
-        os.environ['ZINE_DATABASE_' + key] = value
-
-from zine import get_wsgi_app
+from zine import get_wsgi_app, override_environ_config
 from flup.server.fcgi import WSGIServer
+override_environ_config(POOL_SIZE, POOL_RECYCLE, POOL_TIMEOUT, BEHIND_PROXY)
 app = get_wsgi_app(INSTANCE_FOLDER)
 srv = WSGIServer(app)

servers/zine.wsgi

@@ -2 +2 @@
 """
     Zine mod_wsgi Runner
-    ~~~~~~~~~~~~~~~~~~~~~~~~~
+    ~~~~~~~~~~~~~~~~~~~~
 
-    Run Zine in mod_wsgi.
+    Run Zine in mod_wsgi.  For help on configuration have a look at the
+    README file.
 
-    :copyright: 2008 by Armin Ronacher.
+    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -24 +25 @@
 POOL_TIMEOUT = None
 
+# if you are proxying into zine somehow (caching proxies or external
+# fastcgi servers) set this value to True to enable proxy support.  Do
+# not set this to True if you are not using proxies as this would be a
+# security risk.
+BEHIND_PROXY = None
+
+# ----------------------------------------------------------------------------
 # here you can further configure the wsgi app settings but usually you don't
 # have to touch them
@@ -31 +39 @@
     sys.path.insert(0, ZINE_LIB)
 
-for key in 'POOL_SIZE', 'POOL_RECYCLE', 'POOL_TIMEOUT':
-    value = locals().get(key)
-    if value is not None:
-        os.environ['ZINE_DATABASE_' + key] = value
-
-from zine import get_wsgi_app
+from zine import get_wsgi_app, override_environ_config
+from flup.server.fcgi import WSGIServer
+override_environ_config(POOL_SIZE, POOL_RECYCLE, POOL_TIMEOUT, BEHIND_PROXY)
 application = get_wsgi_app(INSTANCE_FOLDER)

zine/__init__.py

@@ -34 +34 @@
 # the core module is *not* reloaded, thus stuff will get lost if it's not
 # properly listed.
-from zine._core import setup, get_wsgi_app
-__all__ = ('setup', 'get_wsgi_app')
+from zine._core import setup, get_wsgi_app, override_environ_config
+__all__ = ('setup', 'get_wsgi_app', 'override_environ_config')

zine/_core.py

@@ -10 +10 @@
 """
 
+import os
 from thread import allocate_lock
 from time import time, sleep
@@ -141 +142 @@
         return app(environ, start_response)
     return application
+
+
+def override_environ_config(pool_size=None, pool_recycle=None,
+                            pool_timeout=None, behind_proxy=None):
+    """Some configuration parameters are not stored in the zine.ini but
+    in the os environment.  These are process wide configuration settings
+    used for different deployments.
+    """
+    for key, value in locals().items():
+        if value is not None:
+            if key == 'behind_proxy':
+                value = int(bool(value))
+            os.environ['ZINE_' + key.upper()] = str(value)

zine/application.py

@@ -11 +11 @@
     :license: BSD, see LICENSE for more details.
 """
-from os import path, remove, makedirs, walk
+from os import path, remove, makedirs, walk, environ
 from time import time
 from itertools import izip
@@ -232 +232 @@
     """This class holds the incoming request data."""
 
+
     def __init__(self, environ, app=None):
         RequestBase.__init__(self, environ)
@@ -255 +256 @@
         self.user = user
         self.session = session
+
+    @property
+    def is_behind_proxy(self):
+        """Are we behind a proxy?"""
+        return environ.get('ZINE_BEHIND_PROXY') == '1'
 
     def login(self, user, permanent=False):