← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to loggerhead/zptsupport.py

  • Committer: Andrew Bennetts
  • Date: 2011-06-28 17:31:00 UTC
  • mfrom: (450.1.1 diff-of-r1)
  • Revision ID: andrew.bennetts@canonical.com-20110628173100-owrifrnckvoi60af
Fix /diff/1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
loggerhead/zptsupport.py
1
 
"TurboGears support for Zope Page Templates"
 
1
#
 
2
# This program is free software; you can redistribute it and/or modify
 
3
# it under the terms of the GNU General Public License as published by
 
4
# the Free Software Foundation; either version 2 of the License, or
 
5
# (at your option) any later version.
 
6
#
 
7
# This program is distributed in the hope that it will be useful,
 
8
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
9
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
10
# GNU General Public License for more details.
 
11
#
 
12
# You should have received a copy of the GNU General Public License
 
13
# along with this program; if not, write to the Free Software
 
14
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
#
 
16
"""Support for Zope Page Templates using the simpletal library."""
2
17
 
3
 
import StringIO
4
18
import logging
 
19
import os
5
20
import pkg_resources
 
21
import re
 
22
import StringIO
6
23
 
7
 
#from zope.pagetemplate.pagetemplatefile import PageTemplateFile
8
24
from simpletal import simpleTAL, simpleTALES
9
25
 
10
 
log = logging.getLogger("turbogears.zptsupport")
11
 
 
12
26
_zpt_cache = {}
13
27
 
 
28
 
14
29
def zpt(tfile):
15
30
    tinstance = _zpt_cache.get(tfile)
16
 
    if tinstance is None:
 
31
    stat = os.stat(tfile)
 
32
    if tinstance is None or tinstance.stat != stat:
 
33
        text = open(tfile).read()
 
34
        text = re.sub(r'\s*\n\s*', '\n', text)
 
35
        text = re.sub(r'[ \t]+', ' ', text)
17
36
        tinstance = _zpt_cache[tfile] = TemplateWrapper(
18
 
            simpleTAL.compileXMLTemplate(open(tfile)), tfile)
 
37
            simpleTAL.compileXMLTemplate(text), tfile, stat)
19
38
    return tinstance
20
39
 
 
40
 
21
41
class TemplateWrapper(object):
22
42
 
23
 
    def __init__(self, template, filename):
 
43
    def __init__(self, template, filename, stat):
24
44
        self.template = template
25
45
        self.filename = filename
 
46
        self.stat = stat
26
47
 
27
48
    def expand(self, **info):
28
49
        context = simpleTALES.Context(allowPythonPath=1)
32
53
        self.template.expandInline(context, s)
33
54
        return s.getvalue()
34
55
 
 
56
    def expand_into(self, f, **info):
 
57
        context = simpleTALES.Context(allowPythonPath=1)
 
58
        for k, v in info.iteritems():
 
59
            context.addGlobal(k, v)
 
60
        self.template.expand(context, f, 'utf-8')
 
61
 
35
62
    @property
36
63
    def macros(self):
37
64
        return self.template.macros
38
65
 
39
 
## class TGPageTemplateFile(PageTemplateFile):
40
 
 
41
 
##     def pt_getContext(self, args=(), options={}, **ignored):
42
 
##         namespace = super(TGPageTemplateFile, self).pt_getContext(
43
 
##             args, options, **ignored)
44
 
##         namespace.update(options)
45
 
##         return namespace
46
 
 
47
 
class TurboZpt(object):
48
 
    extension = "pt"
49
 
 
50
 
    def __init__(self, extra_vars_func=None):
51
 
        self.get_extra_vars = extra_vars_func
52
 
 
53
 
    def load_template(self, classname, loadingSite=False):
54
 
        """Searches for a template along the Python path.
55
 
 
56
 
        Template files must end in ".pt" and be in legitimate packages.
57
 
        Templates are automatically checked for changes and reloaded as
58
 
        neccessary.
59
 
        """
60
 
        divider = classname.rfind(".")
61
 
        if divider > -1:
62
 
            package = classname[0:divider]
63
 
            basename = classname[divider+1:]
64
 
        else:
65
 
            raise ValueError, "All templates must be in a package"
66
 
 
67
 
        tfile = pkg_resources.resource_filename(
68
 
            package, "%s.%s" % (basename, self.extension))
69
 
        return zpt(tfile)
70
 
 
71
 
    def render(self, info, format="html", fragment=False, template=None):
72
 
        """Renders data in the desired format.
73
 
 
74
 
        @param info: the data / context itself
75
 
        @type info: dict
76
 
        @para format: "html"
77
 
        @type format: "string"
78
 
        @para template: name of the template to use
79
 
        @type template: string
80
 
        """
81
 
        tinstance = self.load_template(template)
82
 
        log.debug("Applying template %s" % (tinstance.filename))
83
 
        data = dict()
84
 
        if self.get_extra_vars:
85
 
            data.update(self.get_extra_vars())
86
 
        data.update(info)
87
 
        return tinstance.expand(**data).encode('utf-8')
 
66
 
 
67
def load_template(classname):
 
68
    """Searches for a template along the Python path.
 
69
 
 
70
    Template files must end in ".pt" and be in legitimate packages.
 
71
    Templates are automatically checked for changes and reloaded as
 
72
    neccessary.
 
73
    """
 
74
    divider = classname.rfind(".")
 
75
    if divider > -1:
 
76
        package = classname[0:divider]
 
77
        basename = classname[divider+1:]
 
78
    else:
 
79
        raise ValueError("All templates must be in a package")
 
80
 
 
81
    tfile = pkg_resources.resource_filename(
 
82
        package, "%s.%s" % (basename, "pt"))
 
83
    return zpt(tfile)