Changeset 2015

Timestamp:

07/23/2005 08:33:22 AM (3 years ago)

Author:

mgood

Message:

Add environment settings for CGI and FastCGI equivalent to the mod_python multi-project settings:

• TracEnvParentDir -- TRAC_ENV_PARENT_DIR
• TracEnvIndexTemplate -- TRAC_ENV_INDEX_TEMPLATE
• TracTemplateVars -- TRAC_TEMPLATE_VARS

Location:

trunk/trac/web

Files:

• cgi_frontend.py (modified) (4 diffs)
• fcgi_frontend.py (modified) (3 diffs)
• main.py (modified) (4 diffs)
• modpython_frontend.py (modified) (6 diffs)

trunk/trac/web/cgi_frontend.py

@@ -3 +3 @@
 # Copyright (C) 2005 Edgewall Software
 # Copyright (C) 2005 Christopher Lenz <cmlenz@gmx.de>
+# Copyright (C) 2005 Matthew Good <trac@matt-good.net>
 #
 # Trac is free software; you can redistribute it and/or
@@ -19 +20 @@
 #
 # Author: Christopher Lenz <cmlenz@gmx.de>
+# Author: Matthew Good <trac@matt-good.net>
 
-from trac.env import open_environment
-from trac.web.main import Request, dispatch_request, send_pretty_error
+from trac.web.main import Request, dispatch_request, send_pretty_error, \
+                          get_environment
 
 import cgi
@@ -52 +54 @@
 
         self.cgi_location = self.__environ.get('SCRIPT_NAME')
+        self.idx_location = self.cgi_location
+
+        self.path_info = self.__environ.get('PATH_INFO', '')
+
+        if 'TRAC_ENV_PARENT_DIR' in os.environ and self.path_info:
+            env_path = '/' + self.path_info.split('/', 2)[1]
+            self.path_info = self.path_info[len(env_path):]
+            self.cgi_location += env_path
+
 
 
@@ -97 +108 @@
     locale.setlocale(locale.LC_ALL, '')
 
-    env = open_environment()
     req = CGIRequest()
+    env = get_environment(req, os.environ, threaded=False)
+
+    if not env:
+        return
 
     try:
-        dispatch_request(os.getenv('PATH_INFO', ''), req, env)
+        dispatch_request(req.path_info, req, env)
     except Exception, e:
         send_pretty_error(e, env, req)

trunk/trac/web/fcgi_frontend.py

@@ -3 +3 @@
 # Copyright (C) 2005 Edgewall Software
 # Copyright (C) 2005 Christopher Lenz <cmlenz@gmx.de>
+# Copyright (C) 2005 Matthew Good <trac@matt-good.net>
 #
 # Trac is free software; you can redistribute it and/or
@@ -19 +20 @@
 #
 # Author: Christopher Lenz <cmlenz@gmx.de>
+# Author: Matthew Good <trac@matt-good.net>
 
 from trac.web.cgi_frontend import *
+from trac.web.main import RequestDone, get_environment
+from trac.util import TracError, enum, href_join
+
 import _thfcgi, locale, sys
 
@@ -37 +42 @@
 
 def _handler(_req, _env, _fieldStorage):
-      env = open_environment()
       req = FCGIRequest(_env, _req.stdin, _req.out, _fieldStorage)
+      env = get_environment(req, os.environ)
+
+      if not env:
+          return
 
       try:  
-          dispatch_request(_env.get('PATH_INFO', ''), req, env)
+          dispatch_request(req.path_info, req, env)
       except Exception, e:
           send_pretty_error(e, env, req)

trunk/trac/web/main.py

@@ -3 +3 @@
 # Copyright (C) 2005 Edgewall Software
 # Copyright (C) 2005 Christopher Lenz <cmlenz@gmx.de>
+# Copyright (C) 2005 Matthew Good <trac@matt-good.net>
 #
 # Trac is free software; you can redistribute it and/or
@@ -19 +20 @@
 #
 # Author: Christopher Lenz <cmlenz@gmx.de>
+# Author: Matthew Good <trac@matt-good.net>
 
 import mimetypes
@@ -25 +27 @@
 
 from trac.core import *
+from trac.env import open_environment
 from trac.perm import PermissionCache, PermissionError
-from trac.util import escape, http_date, TRUE
+from trac.util import escape, http_date, TRUE, enum, href_join
 from trac.web.href import Href
 from trac.web.session import Session
+
+try:
+    import threading
+except ImportError:
+    import dummy_threading as threading
 
 
@@ -490 +498 @@
         req.write('\n')
         req.write(tb.getvalue())
+
+def send_project_index(req, dir, options):
+    from trac.web.clearsilver import HDFWrapper
+
+    if 'TRAC_ENV_INDEX_TEMPLATE' in options:
+        tmpl_path, template = os.path.split(options['TRAC_ENV_INDEX_TEMPLATE'])
+
+        from trac.config import default_dir
+        req.hdf = HDFWrapper(loadpaths=[default_dir('templates'), tmpl_path])
+
+        tmpl_vars = {}
+        if 'TRAC_TEMPLATE_VARS' in options:
+            for pair in options['TRAC_TEMPLATE_VARS'].split(','):
+                key, val = pair.split('=')
+                req.hdf[key] = val
+    else:
+        req.hdf = HDFWrapper()
+        template = req.hdf.parse('''<html>
+<head><title>Available Projects</title></head>
+<body><h1>Available Projects</h1><ul><?cs
+ each:project = projects ?><li><a href="<?cs
+  var:project.href ?>"><?cs var:project.name ?></a></li><?cs
+ /each ?></ul></body>
+</html>''')
+
+    try:
+        projects = []
+        for ids, project in enum(os.listdir(dir)):
+            env_path = os.path.join(dir, project)
+            if not os.path.isdir(env_path):
+                continue
+            try:
+                env = open_environment(env_path)
+                projects.append({
+                    'name': env.config.get('project', 'name'),
+                    'description': env.config.get('project', 'descr'),
+                    'href': href_join(req.idx_location, project)
+                })
+            except TracError, e:
+                raise
+# FIXME how should this be done in a cross-frontend way?
+                #req.log_error('Error opening environment at %s: %s'
+                              #% (env_path, e))
+        projects.sort(lambda x, y: cmp(x['name'], y['name']))
+        req.hdf['projects'] = projects
+
+        req.display(template, response=200)
+    except RequestDone:
+        pass
+
+
+env_cache = {}
+env_cache_lock = threading.Lock()
+
+def get_environment(req, options, threaded=True):
+    global env_cache, env_cache_lock
+
+    if 'TRAC_ENV' in options:
+        env_path = options['TRAC_ENV']
+    elif 'TRAC_ENV_PARENT_DIR' in options:
+        env_parent_dir = options['TRAC_ENV_PARENT_DIR']
+        env_name = req.cgi_location.split('/')[-1]
+        env_path = os.path.join(env_parent_dir, env_name)
+        if not len(env_name) or not os.path.exists(env_path):
+            send_project_index(req, env_parent_dir, options)
+            return None
+    else:
+        raise TracError, \
+              'Missing PythonOption "TracEnv" or "TracEnvParentDir". Trac ' \
+              'requires one of these options to locate the Trac environment(s).' \
+              + str(options)
+
+    if not threaded:
+        return open_environment(env_path)
+
+    env = None
+    env_cache_lock.acquire()
+    try:
+        if not env_path in env_cache:
+            env_cache[env_path] = open_environment(env_path)
+        env = env_cache[env_path]
+    finally:
+        env_cache_lock.release()
+    return env
+
+

trunk/trac/web/modpython_frontend.py

@@ -3 +3 @@
 # Copyright (C) 2004, 2005 Edgewall Software
 # Copyright (C) 2004, 2005 Christopher Lenz <cmlenz@gmx.de>
+# Copyright (C) 2005 Matthew Good <trac@matt-good.net>
 #
 # Trac is free software; you can redistribute it and/or
@@ -19 +20 @@
 #
 # Author: Christopher Lenz <cmlenz@gmx.de>
+# Author: Matthew Good <trac@matt-good.net>
 
 import locale
@@ -24 +26 @@
 import os
 import re
-try:
-    import threading
-except ImportError:
-    import dummy_threading as threading
 
 try:
@@ -36 +34 @@
 from mod_python import apache, util
 
-from trac.env import open_environment
-from trac.util import TracError, enum, href_join, http_date, rstrip
+from trac.util import http_date, rstrip
 from trac.web.main import Request, RequestDone, dispatch_request, \
-                          send_pretty_error
+                          send_pretty_error, get_environment
 
 
@@ -172 +169 @@
                              {}, None, {}))
 
-
-def send_project_index(req, mpr, dir, options):
-    from trac.web.clearsilver import HDFWrapper
-
-    if 'TracEnvIndexTemplate' in options:
-        # Custom project listing template configured
-        tmpl_path, template = os.path.split(options['TracEnvIndexTemplate'])
-
-        from trac.config import default_dir
-        mpr.hdf = HDFWrapper(loadpaths=[default_dir('templates'), tmpl_path])
-
-        tmpl_vars = {}
-        if 'TracTemplateVars' in options:
-            pairs = options['TracTemplateVars'].split(',')
-            for pair in pairs:
-                key,val = pair.split('=')
-                mpr.hdf[key] = val
-
-    else:
-        # Use the default project listing template
-        mpr.hdf = HDFWrapper()
-        template = mpr.hdf.parse("""<html>
-<head><title>Available Projects</title></head>
-<body><h1>Available Projects</h1><ul><?cs
- each:project = projects ?><li><a href="<?cs
-  var:project.href ?>"><?cs var:project.name ?></a></li><?cs
- /each ?></ul></body>
-</html>""")
-
-    try:
-        projects = []
-        for idx, project in enum(os.listdir(dir)):
-            env_path = os.path.join(dir, project)
-            if not os.path.isdir(env_path):
-                continue
-            try:
-                env = open_environment(env_path)
-                projects.append({
-                    'name': env.config.get('project', 'name'),
-                    'description': env.config.get('project', 'descr'),
-                    'href': href_join(mpr.idx_location, project)
-                })
-            except TracError, e:
-                req.log_error('Error opening environment at %s: %s'
-                              % (env_path, e))
-        projects.sort(lambda x, y: cmp(x['name'], y['name']))
-        mpr.hdf['projects'] = projects
-        mpr.display(template, response=200)
-    except RequestDone:
-        pass
-
-env_cache = {}
-env_cache_lock = threading.Lock()
-
-def get_environment(req, mpr, options):
-    global env_cache, env_cache_lock
-
-    if options.has_key('TracEnv'):
-        env_path = options['TracEnv']
-    elif options.has_key('TracEnvParentDir'):
-        env_parent_dir = options['TracEnvParentDir']
-        env_name = mpr.cgi_location.split('/')[-1]
-        env_path = os.path.join(env_parent_dir, env_name)
-        if len(env_name) == 0 or not os.path.exists(env_path):
-            send_project_index(req, mpr, env_parent_dir, options)
-            return None
-    else:
-        raise TracError, \
-              'Missing PythonOption "TracEnv" or "TracEnvParentDir". Trac ' \
-              'requires one of these options to locate the Trac environment(s).'
-
-    env = None
-    env_cache_lock.acquire()
-    try:
-        if not env_path in env_cache:
-            env_cache[env_path] = open_environment(env_path)
-        env = env_cache[env_path]
-    finally:
-        env_cache_lock.release()
-    return env
+def dict_translate(orig, *mappings):
+    result = {}
+    for src, dest in mappings:
+        if src in orig:
+            result[dest] = orig[src]
+    return result
 
 def handler(req):
@@ -265 +188 @@
 
     mpr = ModPythonRequest(req, options)
-    env = get_environment(req, mpr, options)
+    env = get_environment(mpr, dict_translate(options,
+                ('TracEnv', 'TRAC_ENV'),
+                ('TracEnvParentDir', 'TRAC_ENV_PARENT_DIR'),
+                ('TracEnvIndexTemplate', 'TRAC_ENV_INDEX_TEMPLATE'),
+                ('TracTemplateVars', 'TRAC_TEMPLATE_VARS')))
     if not env:
         return apache.OK