Changes between Version 1 and Version 2 of TracModPython2.7

Timestamp:

Dec 13, 2007, 7:35:49 PM (16 years ago)

Author:

fg@…

Comment:

Updated the instruction to trac 0.11

TracModPython2.7

@@ -1 +1 @@
 = Trac and mod_python 2.7 =
 
-Trac was written to use Apache 2, but if you want to use Apache 1.3, you couldn't use [http://www.modpython.org/ mod_python] because [http://www.modpython.org/ mod_python] 3 only runs on Apache 2. Since this wasn't an option in my case, I patched [http://www.modpython.org/ mod_python] 2.7.11 and also made a couple of small changes to Trac to make it work.
+TracModPython setup is for Apache 2, but it may be possible to work with Apache 1.3.
 
-There are two patches, one for [http://www.modpython.org/ mod_python] 2.7.11, and one for Trac 0.8.4. They have only been tested on Mac OS X, with these specific versions, so your mileage may vary.
+The instructions below have worked on MacOS 10.4
 
-Here's the [http://www.modpython.org/ mod_python] patch.
+== Installing mod_python ==
+
+The instruction below work for:
+  * the Apache installation that comes with MacOS 10.4
+  * Python 2.4.3 installed using Fink 
+  * Trac 0.11dev-r6202
+
+First, make sure that the python in the {{{$PATH}}} is the python you want to use (you can revert it later):
+{{{
+sudo mv /usr/bin/python /usr/bin/python.back
+sudo ln -s /sw/bin/python2.4 /usr/bin/python
+}}}
+
+Then download and build the [http://www.modpython.org/ mod_python] 2.7 module. Use the most recent 2.7 version, mine was 2.7.11:
+{{{
+curl http://www.axint.net/apache/httpd/modpython/mod_python-2.7.11.tgz > mod_python-2.7.11.tgz
+tar -xzf mod_python-2.7.11.tgz
+cd mod_python-2.7.11 
+./configure -with-apxs=/usr/sbin/apxs
+}}}
+
+At this stage, I had to edit the build settings, because once installed, I was getting an warning. So in {{{src/Makefile}}} I changed:
 
 {{{
-diff -r -u mod_python-2.7.11.orig/lib/python/mod_python/util.py mod_python-2.7.11/lib/python/mod_python/util.py
---- mod_python-2.7.11.orig/lib/python/mod_python/util.py        2000-12-13 23:45:48.000000000 +0000
-+++ mod_python-2.7.11/lib/python/mod_python/util.py     2005-09-16 12:58:07.000000000 +0100
-@@ -47,6 +47,9 @@
- import string
- import StringIO
- 
-+from types import *
-+from exceptions import *
-+
- parse_qs = apache.parse_qs
- parse_qsl = apache.parse_qsl
- 
-@@ -95,6 +98,14 @@
-     def __del__(self):
-         self.file.close()
- 
-+class StringField(str):
-+    """ This class is basically a string with
-+    a value attribute for compatibility with std lib cgi.py
-+    """
-+
-+    def __init__(self, str=""):
-+       str.__init__(self, str)
-+       self.value = self.__str__()
- 
- class FieldStorage:
- 
-@@ -239,10 +250,10 @@
-         found = []
-         for item in self.list:
-             if item.name == key:
--                if isinstance(item.file, StringIO.StringIO):
--                    found.append(item.value)
--                else:
--                    found.append(item)
-+               if isinstance(item.file, FileType):
-+                   found.append(item)
-+               else:
-+                   found.append(StringField(item.value))
-         if not found:
-             raise KeyError, key
-         if len(found) == 1:
-@@ -250,6 +261,12 @@
-         else:
-             return found
- 
-+    def get(self, key, default):
-+       try:
-+           return self.__getitem__(key)
-+       except KeyError:
-+           return default
-+
-     def keys(self):
-         """Dictionary style keys() method."""
-         if self.list is None:
-@@ -271,23 +288,121 @@
-         """Dictionary style len(x) support."""
-         return len(self.keys())
- 
--            
-+    def getfirst(self, key, default=None):
-+        """ return the first value received """
-+        for item in self.list:
-+            if item.name == key:
-+                if isinstance(item.file, FileType):
-+                    return item
-+                else:
-+                    return StringField(item.value)
-+        return default
-+                                                                    
-+    def getlist(self, key):
-+        """ return a list of received values """
-+        if self.list is None:
-+            raise TypeError, "not indexable"
-+        found = []
-+        for item in self.list:
-+            if item.name == key:
-+                if isinstance(item.file, FileType):
-+                    found.append(item)
-+                else:
-+                    found.append(StringField(item.value))
-+        return found
-+
- def parse_header(line):
-     """Parse a Content-type like header.
- 
-     Return the main content-type and a dictionary of options.
- 
-     """
--    plist = map(string.strip, string.splitfields(line, ';'))
--    key = string.lower(plist[0])
-+    
-+    plist = map(lambda a: a.strip(), line.split(';'))
-+    key = plist[0].lower()
-     del plist[0]
-     pdict = {}
-     for p in plist:
--        i = string.find(p, '=')
-+        i = p.find('=')
-         if i >= 0:
--            name = string.lower(string.strip(p[:i]))
--            value = string.strip(p[i+1:])
-+            name = p[:i].strip().lower()
-+            value = p[i+1:].strip()
-             if len(value) >= 2 and value[0] == value[-1] == '"':
-                 value = value[1:-1]
-             pdict[name] = value
-     return key, pdict
-+
-+def apply_fs_data(object, fs, **args):
-+    """
-+    Apply FieldStorage data to an object - the object must be
-+    callable. Examine the args, and match then with fs data,
-+    then call the object, return the result.
-+    """
-+
-+    # add form data to args
-+    for field in fs.list:
-+        if field.filename:
-+            val = field
-+        else:
-+            val = field.value
-+        args.setdefault(field.name, []).append(val)
-+
-+    # replace lists with single values
-+    for arg in args:
-+        if ((type(args[arg]) is ListType) and
-+            (len(args[arg]) == 1)):
-+            args[arg] = args[arg][0]
-+
-+    # we need to weed out unexpected keyword arguments
-+    # and for that we need to get a list of them. There
-+    # are a few options for callable objects here:
-+
-+    if type(object) is InstanceType:
-+        # instances are callable when they have __call__()
-+        object = object.__call__
-+
-+    expected = []
-+    if hasattr(object, "func_code"):
-+        # function
-+        fc = object.func_code
-+        expected = fc.co_varnames[0:fc.co_argcount]
-+    elif hasattr(object, 'im_func'):
-+        # method
-+        fc = object.im_func.func_code
-+        expected = fc.co_varnames[1:fc.co_argcount]
-+    elif type(object) is ClassType:
-+        # class
-+        fc = object.__init__.im_func.func_code
-+        expected = fc.co_varnames[1:fc.co_argcount]
-+
-+    # remove unexpected args unless co_flags & 0x08,
-+    # meaning function accepts **kw syntax
-+    if not (fc.co_flags & 0x08):
-+        for name in args.keys():
-+            if name not in expected:
-+                del args[name]
-+
-+    return object(**args)
-+
-+def redirect(req, location, permanent=0, text=None):
-+    """
-+    A convenience function to provide redirection
-+    """
-+
-+    if req.sent_bodyct:
-+        raise IOError, "Cannot redirect after headers have already been sent."
-+
-+    req.err_headers_out["Location"] = location
-+    if permanent:
-+        req.status = apache.HTTP_MOVED_PERMANENTLY
-+    else:
-+        req.status = apache.HTTP_MOVED_TEMPORARILY
-+
-+    if text is None:
-+        req.write('<p>The document has moved' 
-+                  ' <a href="%s">here</a></p>\n'
-+                  % location)
-+    else:
-+        req.write(text)
-+
-+    raise apache.SERVER_RETURN, apache.OK
-diff -r -u mod_python-2.7.11.orig/src/include/mod_python.h mod_python-2.7.11/src/include/mod_python.h
---- mod_python-2.7.11.orig/src/include/mod_python.h     2003-12-08 04:36:10.000000000 +0000
-+++ mod_python-2.7.11/src/include/mod_python.h  2005-09-16 01:01:47.000000000 +0100
-@@ -67,7 +67,7 @@
- #include "http_protocol.h"
- #include "util_script.h"
- #include "http_log.h"
--
-+#include "multithread.h"
- 
- /* Python headers */
- /* this gets rid of some comile warnings */
-diff -r -u mod_python-2.7.11.orig/src/mod_python.c mod_python-2.7.11/src/mod_python.c
---- mod_python-2.7.11.orig/src/mod_python.c     2001-05-28 21:00:41.000000000 +0100
-+++ mod_python-2.7.11/src/mod_python.c  2005-09-16 01:38:05.000000000 +0100
-@@ -264,6 +264,9 @@
-        server.register_cleanup() */
-     pool *child_init_pool = NULL;
- 
-+    /* Fudge for OS X */
-+    static int initialized = 0;
-+
-     /* mod_python version */
-     ap_add_version_component(VERSION_COMPONENT);
-     
-@@ -272,8 +275,9 @@
-     ap_add_version_component(buff);
- 
-     /* initialize global Python interpreter if necessary */
--    if (! Py_IsInitialized()) 
-+    if (!initialized || !Py_IsInitialized()) 
-     {
-+      initialized = 1;
- 
-        /* initialze the interpreter */
-        Py_Initialize();
-diff -r -u mod_python-2.7.11.orig/src/requestobject.c mod_python-2.7.11/src/requestobject.c
---- mod_python-2.7.11.orig/src/requestobject.c  2001-05-23 03:49:43.000000000 +0100
-+++ mod_python-2.7.11/src/requestobject.c       2005-09-16 02:18:33.000000000 +0100
-@@ -849,6 +849,7 @@
-     {"filename",           T_STRING,    OFF(filename),               },
-     {"path_info",          T_STRING,    OFF(path_info),            RO},
-     {"args",               T_STRING,    OFF(args),                 RO},
-+    {"user",               T_STRING,                                 },
-     /* XXX - test an array header */
-     /* XXX finfo */
-     /* XXX parsed_uri */
-@@ -1015,6 +1016,15 @@
-     else if (strcmp(name, "hstack") == 0) {
-        return PyString_FromString(self->hstack);
-     }
-+    else if (strcmp(name, "user") == 0) {
-+        if (!self->request_rec->connection
-+           || !self->request_rec->connection->user) {
-+           Py_INCREF(Py_None);
-+           return Py_None;
-+        }
-+
-+        return PyString_FromString(self->request_rec->connection->user);
-+    }
-     else if (strcmp(name, "_content_type_set") == 0) {
-        return PyInt_FromLong(self->content_type_set);
-     }
-@@ -1058,6 +1068,16 @@
-            ap_pstrdup(self->request_rec->pool, PyString_AsString(value));
-        return 0;
-     }
-+    else if (strcmp(name, "user") == 0) {
-+        if (!self->request_rec->connection) {
-+           PyErr_SetString(PyExc_AttributeError, "no connection");
-+           return -1;
-+        }
-+
-+        self->request_rec->connection->user =
-+           ap_pstrdup(self->request_rec->pool, PyString_AsString(value));
-+       return 0;
-+    }
-     else if (strcmp(name, "hstack") == 0) {
-        self->hstack = ap_pstrdup(self->request_rec->pool, PyString_AsString(value));
-        return 0;
+   CFLAGS=$(OPT) $(INCLUDES)
+}}}
+into:
+{{{
+   CFLAGS=$(OPT) $(INCLUDES) -DEAPI
 }}}
 
-You also need the following patch for Trac's ModPythonHandler.py:
+Then, do the build:
+{{{
+make clean
+make
+sudo make install
+}}}
+
+{{{mod_python}}} is now installed.
+
+== Configurating and testing mod_python ==
+
+You must add the following lines to your {{{httpd.conf}}}:
+{{{
+    LoadModule python_module libexec/mod_python.so
+}}}
+(The actual path to mod_python.so may vary, but make install should report at the very end exactly where mod_python.so was placed and how the LoadModule directive should appear), and
+{{{
+    AddModule mod_python.c
+}}}
+
+You can test that everything is OK using the instructions on http://www.modpython.org/live/mod_python-2.7.8/doc-html/inst-testing.html
+
+Then, modify the settings for your Trac instance into:
+{{{
+<Location /projects/myproject>
+   SetHandler python-program
+   PythonHandler trac.web.modpython_frontend
+   PythonOption TracEnv /var/trac/myproject
+   PythonOption TracUriRoot /projects/myproject
+</Location>
+}}}
+Of course, use your own values for {{{/projects/myproject}}} and {{{/var/trac/myproject}}}. {{{TracUriRoot}}} may not be necessary.
+
+Restart Apache after each configuration change.
+
+== Patching and testing Trac ==
+
+At this stage, opening http://localhost/projects/myproject in your browser will give you an error 500. You can look in the error_log file: it is likely a Python exception, because the {{{trac.web.modpython_frontend}}} code tries to use APIs from mod_python that are different in 3.3.
+
+Here's a simple patch for {{{trac/web/modpython_frontend.py}}}. It's just a hack, but it does the job:
 
 {{{
-diff -r -u trac-0.8.4.orig/trac/ModPythonHandler.py trac-0.8.4/trac/ModPythonHandler.py
---- trac-0.8.4.orig/trac/ModPythonHandler.py    2005-06-17 19:22:32.000000000 +0100
-+++ trac-0.8.4/trac/ModPythonHandler.py 2005-09-16 16:54:13.000000000 +0100
-@@ -99,7 +99,7 @@
-         self.req.write(data)
+--- /sw/lib/python2.4/site-packages/Trac-0.11dev_r6202-py2.4.egg/trac/web/modpython_frontend.py.r6202   2007-11-21 16:11:25.000000000 -0800
++++ /sw/lib/python2.4/site-packages/Trac-0.11dev_r6202-py2.4.egg/trac/web/modpython_frontend.py 2007-12-13 10:44:05.000000000 -0800
+@@ -47,25 +47,14 @@
  
-     def get_header(self, name):
--        return self.req.headers_in.get(name)
-+        return self.req.headers_in[name]
+ class ModPythonGateway(WSGIGateway):
  
-     def send_response(self, code):
-         self.req.status = code
-@@ -108,11 +108,10 @@
-         if name.lower() == 'content-type':
-             self.req.content_type = value
-         else:
--            self.req.headers_out.add(name, str(value))
-+            self.req.headers_out[name] = str(value)
+-    wsgi_multithread = apache.mpm_query(apache.AP_MPMQ_IS_THREADED) > 0
+-    wsgi_multiprocess = apache.mpm_query(apache.AP_MPMQ_IS_FORKED) > 0
+-
+     def __init__(self, req, options):
+         environ = {}
+         environ.update(apache.build_cgi_env(req))
  
-     def end_headers(self):
--        pass
+-        if 'TracEnv' in options:
+-            environ['trac.env_path'] = options['TracEnv']
+-        if 'TracEnvParentDir' in options:
+-            environ['trac.env_parent_dir'] = options['TracEnvParentDir']
+-        if 'TracEnvIndexTemplate' in options:
+-            environ['trac.env_index_template'] = options['TracEnvIndexTemplate']
+-        if 'TracTemplateVars' in options:
+-            environ['trac.template_vars'] = options['TracTemplateVars']
+-        if 'TracLocale' in options:
+-            environ['trac.locale'] = options['TracLocale']
++       environ['trac.env_path'] = options['TracEnv']   
++
+ 
+-        if 'TracUriRoot' in options:
++       if True:
+             # Special handling of SCRIPT_NAME/PATH_INFO for mod_python, which
+             # tends to get confused for whatever reason
+             root_uri = options['TracUriRoot'].rstrip('/')
+@@ -76,10 +65,6 @@
+             environ['SCRIPT_NAME'] = root_uri
+             environ['PATH_INFO'] = urllib.unquote(request_uri[len(root_uri):])
+ 
+-        egg_cache = req.subprocess_env.get('PYTHON_EGG_CACHE')
+-        if egg_cache:
+-            os.environ['PYTHON_EGG_CACHE'] = egg_cache
 -
-+       self.req.send_http_header()
+         WSGIGateway.__init__(self, environ, InputWrapper(req),
+                              _ErrorsWrapper(lambda x: req.log_error(x)))
+         self.req = req
+@@ -91,17 +76,11 @@
+             status, headers = self.headers_sent = self.headers_set
+             self.req.status = int(status[:3])
+             for name, value in headers:
+-                if name.lower() == 'content-length':
+-                    self.req.set_content_length(int(value))
+-                elif name.lower() == 'content-type':
++                if name.lower() == 'content-type':
+                     self.req.content_type = value
+                 else:
+                     self.req.headers_out.add(name, value)
  
- class TracFieldStorage(util.FieldStorage):
-     """
+-    def _sendfile(self, fileobj):
+-        self._send_headers()
+-        self.req.sendfile(fileobj.name)
+-
+     def _write(self, data):
+         self._send_headers()
+         try:
 }}}
-