Code

merge Zope Collector #580 fix from ZPT CVS trunk
[roundup.git] / cgi-bin / roundup.cgi
index ad2a7b9980a43d23c3f2107b934bfe93756b0860..1518c400b98111965ddeb1bc662dddc9103afc2b 100755 (executable)
@@ -1,21 +1,53 @@
 #!/usr/bin/env python
-
-# $Id: roundup.cgi,v 1.4 2001-07-23 04:47:27 anthonybaxter Exp $
+#
+# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+# This module is free software, and you may redistribute it and/or modify
+# under the same terms as Python, so long as this copyright message and
+# disclaimer are retained in their original form.
+#
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+# 
+# $Id: roundup.cgi,v 1.33 2002-09-23 00:50:32 richard Exp $
 
 # python version check
+from roundup import version_check
+from roundup.i18n import _
 import sys
-if int(sys.version[0]) < 2:
-    print "Content-Type: text/plain\n"
-    print "Roundup requires Python 2.0 or newer."
-    sys.exit(0)
 
 #
 ##  Configuration
 #
 
+# Configuration can also be provided through the OS environment (or via
+# the Apache "SetEnv" configuration directive). If the variables
+# documented below are set, they _override_ any configuation defaults
+# given in this file. 
+
+# TRACKER_HOMES is a list of instances, in the form
+# "NAME=DIR<sep>NAME2=DIR2<sep>...", where <sep> is the directory path
+# separator (";" on Windows, ":" on Unix). 
+
+# Make sure the NAME part doesn't include any url-unsafe characters like 
+# spaces, as these confuse the cookie handling in browsers like IE.
+
+# ROUNDUP_LOG is the name of the logfile; if it's empty or does not exist,
+# logging is turned off (unless you changed the default below). 
+
+# ROUNDUP_DEBUG is a debug level, currently only 0 (OFF) and 1 (ON) are
+# used in the code. Higher numbers means more debugging output. 
+
 # This indicates where the Roundup instance lives
-ROUNDUP_INSTANCE_HOMES = {
-    'test': '/tmp/roundup_test',
+TRACKER_HOMES = {
+    'demo': '/var/roundup/instances/demo',
 }
 
 # Where to log debugging information to. Use an instance of DevNull if you
@@ -23,8 +55,10 @@ ROUNDUP_INSTANCE_HOMES = {
 class DevNull:
     def write(self, info):
         pass
-LOG = open('/var/log/roundup.cgi.log', 'a')
-#LOG = DevNull()
+    def close(self):
+        pass
+#LOG = open('/var/log/roundup.cgi.log', 'a')
+LOG = DevNull()
 
 #
 ##  end configuration
@@ -36,88 +70,144 @@ LOG = open('/var/log/roundup.cgi.log', 'a')
 # 
 try:
     import traceback, StringIO, cgi
-    from roundup import cgitb
+    from roundup.cgi import cgitb
 except:
-    print "Content-Type: text/html\n"
-    print "Failed to import cgitb.<pre>"
+    print "Content-Type: text/plain\n"
+    print _("Failed to import cgitb!\n\n")
     s = StringIO.StringIO()
     traceback.print_exc(None, s)
-    print cgi.escape(s.getvalue()), "</pre>"
-
-def main(instance, out):
-    from roundup import cgi_client
-    db = instance.open('admin')
-    auth = os.environ.get("HTTP_CGI_AUTHORIZATION", None)
-    message = 'Unauthorised'
-    if auth:
-        import binascii
-        l = binascii.a2b_base64(auth.split(' ')[1]).split(':')
-        user = l[0]
-        password = None
-        if len(l) > 1:
-            password = l[1]
-        try:
-            uid = db.user.lookup(user)
-        except KeyError:
-            auth = None
-            message = 'Username not recognised'
+    print s.getvalue()
+
+
+#
+# Check environment for config items
+#
+def checkconfig():
+    import os, string
+    global TRACKER_HOMES, LOG
+
+    # see if there's an environment var. ROUNDUP_INSTANCE_HOMES is the
+    # old name for it.
+    if os.environ.has_key('ROUNDUP_INSTANCE_HOMES'):
+        homes = os.environ.get('ROUNDUP_INSTANCE_HOMES')
+    else:
+        homes = os.environ.get('TRACKER_HOMES', '')
+    if homes:
+        TRACKER_HOMES = {}
+        for home in string.split(homes, os.pathsep):
+            try:
+                name, dir = string.split(home, '=', 1)
+            except ValueError:
+                # ignore invalid definitions
+                continue
+            if name and dir:
+                TRACKER_HOMES[name] = dir
+                
+    logname = os.environ.get('ROUNDUP_LOG', '')
+    if logname:
+        LOG = open(logname, 'a')
+
+    # ROUNDUP_DEBUG is checked directly in "roundup.cgi.client"
+
+
+#
+# Provide interface to CGI HTTP response handling
+#
+class RequestWrapper:
+    '''Used to make the CGI server look like a BaseHTTPRequestHandler
+    '''
+    def __init__(self, wfile):
+        self.wfile = wfile
+    def write(self, data):
+        self.wfile.write(data)
+    def send_response(self, code):
+        self.write('Status: %s\r\n'%code)
+    def send_header(self, keyword, value):
+        self.write("%s: %s\r\n" % (keyword, value))
+    def end_headers(self):
+        self.write("\r\n")
+
+#
+# Main CGI handler
+#
+def main(out, err):
+    import os, string
+    import roundup.instance
+    path = string.split(os.environ.get('PATH_INFO', '/'), '/')
+    request = RequestWrapper(out)
+    request.path = os.environ.get('PATH_INFO', '/')
+    instance = path[1]
+    os.environ['TRACKER_NAME'] = instance
+    os.environ['PATH_INFO'] = string.join(path[2:], '/')
+    if TRACKER_HOMES.has_key(instance):
+        # redirect if we need a trailing '/'
+        if len(path) == 2:
+            request.send_response(301)
+            # redirect
+            if os.environ.get('HTTPS', '') == 'on':
+                protocol = 'https'
+            else:
+                protocol = 'http'
+            absolute_url = '%s://%s%s/'%(protocol, os.environ['HTTP_HOST'],
+                os.environ['REQUEST_URI'])
+            request.send_header('Location', absolute_url)
+            request.end_headers()
+            out.write('Moved Permanently')
         else:
-            if password != db.user.get(uid, 'password'):
-                message = 'Incorrect password'
-                auth = None
-    if not auth:
-        out.write('Content-Type: text/html\n')
-        out.write('Status: 401\n')
-        out.write('WWW-Authenticate: basic realm="Roundup"\n\n')
-        keys = os.environ.keys()
-        keys.sort()
-        out.write(message)
-        return
-    client = instance.Client(out, db, os.environ, user)
-    try:
-        client.main()
-    except cgi_client.Unauthorised:
-        out.write('Content-Type: text/html\n')
-        out.write('Status: 403\n\n')
-        out.write('Unauthorised')
+            instance_home = TRACKER_HOMES[instance]
+            instance = roundup.instance.open(instance_home)
+            from roundup.cgi.client import Unauthorised, NotFound
+            client = instance.Client(instance, request, os.environ)
+            try:
+                client.main()
+            except Unauthorised:
+                request.send_response(403)
+                request.send_header('Content-Type', 'text/html')
+                request.end_headers()
+                out.write('Unauthorised')
+            except NotFound:
+                request.send_response(404)
+                request.send_header('Content-Type', 'text/html')
+                request.end_headers()
+                out.write('Not found: %s'%client.path)
+
+    else:
+        import urllib
+        request.send_response(200)
+        request.send_header('Content-Type', 'text/html')
+        request.end_headers()
+        w = request.write
+        w(_('<html><head><title>Roundup instances index</title></head>\n'))
+        w(_('<body><h1>Roundup instances index</h1><ol>\n'))
+        homes = TRACKER_HOMES.keys()
+        homes.sort()
+        for instance in homes:
+            w(_('<li><a href="%(instance_url)s/index">%(instance_name)s</a>\n')%{
+                'instance_url': os.environ['SCRIPT_NAME']+'/'+urllib.quote(instance),
+                'instance_name': cgi.escape(instance)})
+        w(_('</ol></body></html>'))
 
 #
 # Now do the actual CGI handling
-# 
+#
 out, err = sys.stdout, sys.stderr
 try:
+    # force input/output to binary (important for file up/downloads)
+    if sys.platform == "win32":
+        import os, msvcrt
+        msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
+        msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
+    checkconfig()
     sys.stdout = sys.stderr = LOG
-    import os, string
-    path = string.split(os.environ['PATH_INFO'], '/')
-    instance = path[1]
-    os.environ['PATH_INFO'] = string.join(path[2:], '/')
-    if ROUNDUP_INSTANCE_HOMES.has_key(instance):
-        instance_home = ROUNDUP_INSTANCE_HOMES[instance]
-        module_path, instance = os.path.split(instance_home)
-        sys.path.insert(0, module_path)
-        try:
-            instance = __import__(instance)
-        finally:
-            del sys.path[0]
-    else:
-        raise ValueError, 'No such instance "%s"'%instance
-    main(instance, out)
+    main(out, err)
+except SystemExit:
+    pass
 except:
     sys.stdout, sys.stderr = out, err
     out.write('Content-Type: text/html\n\n')
     cgitb.handler()
 sys.stdout.flush()
 sys.stdout, sys.stderr = out, err
+LOG.close()
 
-#
-# $Log: not supported by cvs2svn $
-# Revision 1.3  2001/07/23 04:33:30  richard
-# brought the CGI instance config dict in line with roundup-server
-#
-# Revision 1.2  2001/07/23 04:31:40  richard
-# Fixed the roundup CGI script for updates to cgi_client.py
-#
-# Revision 1.1  2001/07/22 11:47:07  richard
-# More Grande Splite
-#
-#
+# vim: set filetype=python ts=4 sw=4 et si