Allow template for tracker index page

Justus Pendleton · Justus Pendleton · commit e8fcc8aaa2d3 · 2007-09-02T16:05:36.000Z
[SF#058020] requested the ability to have a user-specified template
page for the tracker index that is generated when roundup-server is
handling multiple trackers.

This adds a "-i" option that allows them to specify a template.
diff --git a/doc/admin_guide.txt b/doc/admin_guide.txt
@@ -2,7 +2,7 @@
 Administration Guide
 ====================
 
-:Version: $Revision: 1.23 $
+:Version: $Revision: 1.24 $
 
 .. contents::
 
@@ -82,6 +82,7 @@ The basic configuration file layout is as follows (take from the
     ;log_ip = yes
     ;pidfile =
     ;logfile =
+    ;template =
 
     [trackers]
     ; Add one of these per tracker being served
@@ -109,6 +110,10 @@ are as follows:
   written to this file. It must be specified if **pidfile** is specified.
   If per-tracker logging is specified, then very little will be written to
   this file.
+**template**
+  Specifies a template used for displaying the tracker index when
+  multiple trackers are being used. The variable "trackers" is available
+  to the template and is a dict of all configured trackers.
 **trackers** section
   Each line denotes a mapping from a URL component to a tracker home.
   Make sure the name part doesn't include any url-unsafe characters like
diff --git a/doc/roundup-server.1 b/doc/roundup-server.1
@@ -21,6 +21,11 @@ Daemonize, and write the server's PID to the nominated file.
 Sets a filename to log to (instead of stdout). This is required if the -d
 option is used.
 .TP
+\fB-i\fP \fIfile\fP
+Sets a filename to use as a template for generating the tracker index page.
+The variable "trackers" is available to the template and is a dict of all
+configured trackers.
+.TP
 \fB-h\fP
 print help
 .TP
diff --git a/doc/roundup-server.ini.example b/doc/roundup-server.ini.example
@@ -1,16 +1,17 @@
 ; This is a sample configuration file for roundup-server. See the
 ; admin_guide for information about its contents.
-[server]
+[main]
 port = 8080
 ;hostname = 
 ;user = 
 ;group = 
 ;log_ip = yes
 ;pidfile = 
 ;logfile = 
+;template =
 
 
 ; Add one of these per tracker being served
-[tracker_url_component]
+[trackers]
 home = /path/to/tracker
 
diff --git a/roundup/scripts/roundup_server.py b/roundup/scripts/roundup_server.py
@@ -17,7 +17,7 @@
 
 """Command-line script that runs a server over roundup.cgi.client.
 
-$Id: roundup_server.py,v 1.88 2007-04-23 19:35:41 forsberg Exp $
+$Id: roundup_server.py,v 1.89 2007-09-02 16:05:36 jpend Exp $
 """
 __docformat__ = 'restructuredtext'
 
@@ -30,6 +30,7 @@
 
 # Roundup modules of use here
 from roundup.cgi import cgitb, client
+from roundup.cgi.PageTemplates.PageTemplate import PageTemplate
 import roundup.instance
 from roundup.i18n import _
 
@@ -152,17 +153,26 @@ def index(self):
             self.end_headers()
         else:
             self.send_response(200)
+
         self.send_header('Content-Type', 'text/html')
         self.end_headers()
         w = self.wfile.write
-        w(_('<html><head><title>Roundup trackers index</title></head>\n'
-            '<body><h1>Roundup trackers index</h1><ol>\n'))
-        keys.sort()
-        for tracker in keys:
-            w('<li><a href="%(tracker_url)s/index">%(tracker_name)s</a>\n'%{
-                'tracker_url': urllib.quote(tracker),
-                'tracker_name': cgi.escape(tracker)})
-        w('</ol></body></html>')
+
+        if self.CONFIG and self.CONFIG['TEMPLATE']:
+            template = open(self.CONFIG['TEMPLATE']).read()
+            pt = PageTemplate()
+            pt.write(template)
+            extra = { 'trackers': self.TRACKERS }
+            w(pt.pt_render(extra_context=extra))
+        else:
+            w(_('<html><head><title>Roundup trackers index</title></head>\n'
+                '<body><h1>Roundup trackers index</h1><ol>\n'))
+            keys.sort()
+            for tracker in keys:
+                w('<li><a href="%(tracker_url)s/index">%(tracker_name)s</a>\n'%{
+                    'tracker_url': urllib.quote(tracker),
+                    'tracker_name': cgi.escape(tracker)})
+            w('</ol></body></html>')
 
     def inner_run_cgi(self):
         ''' This is the inner part of the CGI handling
@@ -394,6 +404,8 @@ class ServerConfig(configuration.Config):
             (configuration.Option, "multiprocess", DEFAULT_MULTIPROCESS,
                 "Set processing of each request in separate subprocess.\n"
                 "Allowed values: %s." % ", ".join(MULTIPROCESS_TYPES)),
+            (configuration.NullableFilePathOption, "template", "",
+                "Tracker index template. If unset, built-in will be used."),
         )),
         ("trackers", (), "Roundup trackers to serve.\n"
             "Each option in this section defines single Roundup tracker.\n"
@@ -414,6 +426,7 @@ class ServerConfig(configuration.Config):
         "nodaemon": "D",
         "log_hostnames": "N",
         "multiprocess": "t:",
+        "template": "i:",
     }
 
     def __init__(self, config_file=None):
@@ -595,6 +608,7 @@ def usage(message=''):
  -p <port>     set the port to listen on (default: %(port)s)
  -l <fname>    log to the file indicated by fname instead of stderr/stdout
  -N            log client machine names instead of IP addresses (much slower)
+ -i            set tracker index template
  -t <mode>     multiprocess mode (default: %(mp_def)s).
                Allowed values: %(mp_types)s.
 %(os_part)s
