moving templates around

Author: Richard Jones

CHANGES.txt

@@ -59,6 +59,9 @@ Feature:
 - added command-line functionality for roundup-adming (sf feature 687664)
 - added nicer popup windows for topic, nosy, etc (has add/remove buttons)
   thanks Gus Gollings
+- HTML templating files now have a .html extension
+- Roundup templates are now distributed much more sanely, allowing for
+  3rd-party templates.
 
 
 Fixed:

MANIFEST.in

@@ -1,13 +1,15 @@
-recursive-include roundup *.* home* page*
+recursive-include roundup *.*
 recursive-include frontends *.*
 recursive-include scripts *.* *-*
 recursive-include tools *.*
 recursive-include cgi-bin *.cgi
 recursive-include test *.py *.txt
 recursive-include doc *.html *.png *.txt *.css *.1
 recursive-include detectors *.py
+recursive-include templates *.* home* page*
 recursive-exclude roundup *.pyc *.pyo .cvsignore
 recursive-exclude frontends *.pyc *.pyo .cvsignore
+recursive-exclude templates *.pyc *.pyo .cvsignore
 include run_tests *.txt
 exclude BUILD.txt I18N_PROGRESS.txt TODO.txt
 exclude doc/security.txt doc/templating.txt

roundup/admin.py

@@ -16,12 +16,12 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: admin.py,v 1.50 2003-03-27 05:23:39 richard Exp $
+# $Id: admin.py,v 1.51 2003-04-17 03:37:57 richard Exp $
 
 '''Administration commands for maintaining Roundup trackers.
 '''
 
-import sys, os, getpass, getopt, re, UserDict, shlex, shutil
+import sys, os, getpass, getopt, re, UserDict, shlex, shutil, rfc822
 try:
     import csv
 except ImportError:
@@ -278,10 +278,43 @@ def do_help(self, args, nl_re=re.compile('[\r\n]'),
                     print line
         return 0
 
+    def listTemplates(self):
+        ''' List all the available templates.
+
+            Look in three places:
+                <prefix>/share/roundup/templates
+                <__file__>/../templates
+                current dir
+        '''
+        # OK, try <prefix>/share/roundup/templates
+        # -- this module (roundup.admin) will be installed in something
+        # _like_ /usr/lib/python2.2/site-packages/roundup/admin.py, and
+        # we're interested in where the "lib" directory is - ie. the /usr/
+        # part
+        path = __file__
+        for i in range(5):
+            path = os.path.dirname(path)
+        tdir = os.path.join(path, 'share', 'roundup', 'templates')
+        if os.path.isdir(tdir):
+            templates = listTemplates(tdir)
+        else:
+            templates = {}
+
+        # OK, now try as if we're in the roundup source distribution
+        # directory, so this module will be in .../roundup-*/roundup/admin.py
+        # and we're interested in the .../roundup-*/ part.
+        path = __file__
+        for i in range(2):
+            path = os.path.dirname(path)
+        tdir = os.path.join(path, 'templates')
+        if os.path.isdir(tdir):
+            templates.update(listTemplates(tdir))
+
+        return templates
+
     def help_initopts(self):
-        import roundup.templates
-        templates = roundup.templates.listTemplates()
-        print _('Templates:'), ', '.join(templates)
+        templates = self.listTemplates()
+        print _('Templates:'), ', '.join(templates.keys())
         import roundup.backends
         backends = roundup.backends.__all__
         print _('Back ends:'), ', '.join(backends)
@@ -312,12 +345,11 @@ def do_install(self, tracker_home, args):
                 ' does not exist')%locals()
 
         # select template
-        import roundup.templates
-        templates = roundup.templates.listTemplates()
+        templates = self.listTemplates()
         template = len(args) > 1 and args[1] or ''
-        if template not in templates:
-            print _('Templates:'), ', '.join(templates)
-        while template not in templates:
+        if not templates.has_key(template):
+            print _('Templates:'), ', '.join(templates.keys())
+        while not templates.has_key(template):
             template = raw_input(_('Select template [classic]: ')).strip()
             if not template:
                 template = 'classic'
@@ -335,7 +367,7 @@ def do_install(self, tracker_home, args):
         # XXX perform a unit test based on the user's selections
 
         # install!
-        init.install(tracker_home, template)
+        init.install(tracker_home, templates[template]['path'])
         init.write_select_db(tracker_home, backend)
 
         print _('''
@@ -1377,6 +1409,28 @@ def main(self):
             if self.db:
                 self.db.close()
 
+
+def listTemplates(dir):
+    ''' List all the Roundup template directories in a given directory.
+
+        Find all the dirs that contain a TEMPLATE-INFO.txt and parse it.
+
+        Return a list of dicts of info about the templates.
+    '''
+    ret = {}
+    for idir in os.listdir(dir):
+        idir = os.path.join(dir, idir)
+        ti = os.path.join(idir, 'TEMPLATE-INFO.txt')
+        if os.path.isfile(ti):
+            m = rfc822.Message(open(ti))
+            ti = {}
+            ti['name'] = m['name']
+            ti['description'] = m['description']
+            ti['intended-for'] = m['intended-for']
+            ti['path'] = idir
+            ret[m['name']] = ti
+    return ret
+
 if __name__ == '__main__':
     tool = AdminTool()
     sys.exit(tool.main())

roundup/cgi/templating.py

@@ -38,9 +38,9 @@ def precompileTemplates(self):
             if os.path.isdir(filename): continue
             if '.' in filename:
                 name, extension = filename.split('.')
-                self.getTemplate(name, extension)
+                self.get(name, extension)
             else:
-                self.getTemplate(filename, None)
+                self.get(filename, None)
 
     def get(self, name, extension=None):
         ''' Interface to get a template, possibly loading a compiled template.
@@ -66,27 +66,31 @@ def get(self, name, extension=None):
             filename = name
 
         src = os.path.join(self.dir, filename)
+        if not os.path.exists(src):
+            filename = filename + '.html'
+            src = os.path.join(self.dir, filename)
+            if not os.path.exists(src):
+                if not extension:
+                    raise NoTemplate, 'Template file "%s" doesn\'t exist'%name
+
+                # try for a generic template
+                generic = '_generic.%s'%extension
+                src = os.path.join(self.dir, generic)
+                if not os.path.exists(src):
+                    generic = '_generic.%s.html'%extension
+                    src = os.path.join(self.dir, generic)
+                    if not os.path.exists(src):
+                        raise NoTemplate, 'No template file exists for '\
+                            'templating "%s" with template "%s" (neither '\
+                            '"%s" nor "%s")'%(name, extension, filename,
+                            generic)
+                filename = generic
+
         try:
             stime = os.stat(src)[os.path.stat.ST_MTIME]
         except os.error, error:
             if error.errno != errno.ENOENT:
                 raise
-            if not extension:
-                raise NoTemplate, 'Template file "%s" doesn\'t exist'%name
-
-            # try for a generic template
-            generic = '_generic.%s'%extension
-            src = os.path.join(self.dir, generic)
-            try:
-                stime = os.stat(src)[os.path.stat.ST_MTIME]
-            except os.error, error:
-                if error.errno != errno.ENOENT:
-                    raise
-                # nicer error
-                raise NoTemplate, 'No template file exists for templating '\
-                    '"%s" with template "%s" (neither "%s" nor "%s")'%(name,
-                    extension, filename, generic)
-            filename = generic
 
         if self.templates.has_key(src) and \
                 stime < self.templates[src].mtime:

roundup/init.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: init.py,v 1.25 2003-02-25 10:19:31 richard Exp $
+# $Id: init.py,v 1.26 2003-04-17 03:37:58 richard Exp $
 
 __doc__ = """
 Init (create) a roundup instance.
@@ -58,8 +58,8 @@ def install(instance_home, template):
     '''Install an instance using the named template and backend.
 
     instance_home - the directory to place the instance data in
-    template - the template to use in creating the instance data
-    backend - the database to use to store the instance data
+    template      - the directory holding the template to use in creating
+                    the instance data
 
     The instance_home directory will be created using the files found in
     the named template (roundup.templates.<name>). A standard instance_home
@@ -82,20 +82,10 @@ def install(instance_home, template):
         . detectors/
           - the auditor and reactor modules for this instance
 
-    The html directory is typically extracted from the htmlbase module in
-    the template.
     '''
-    # first, copy the template dir over
-    from roundup.templates import builder
-
-    # copy the roundup.templates.<template> package contents to the instance dir
-    template_dir = os.path.split(__file__)[0]
-    template_name = template
-    template = os.path.join(template_dir, 'templates', template)
+    # At the moment, it's just a copy
     copytree(template, instance_home)
 
-    builder.installHtmlBase(template_name, instance_home)
-
 
 def write_select_db(instance_home, backend):
     ''' Write the file that selects the backend for the tracker

roundup/mailgw.py

@@ -73,7 +73,7 @@ class node. Any parts of other types are each stored in separate files
 an exception, the original message is bounced back to the sender with the
 explanatory message given in the exception. 
 
-$Id: mailgw.py,v 1.114 2003-04-10 05:12:41 richard Exp $
+$Id: mailgw.py,v 1.115 2003-04-17 03:37:59 richard Exp $
 '''
 
 import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
@@ -806,6 +806,7 @@ def handle_message(self, message):
         # parse the body of the message, stripping out bits as appropriate
         summary, content = parseContent(content, keep_citations, 
             keep_body)
+        content = content.strip()
 
         # 
         # handle the attachments