1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
# Copyright (c) 2004 Divmod.
# See LICENSE for details.
"""Builtin template loaders that supply a Page or renderer with a
document to render.
Nevow provides the following DocFactory loaders by default:
- B{stan} - turn a stan tag tree into a DocFactory
- B{xmlfile} - load a well formed XML document from file
- B{htmlfile} - load a HTML file from disk
- B{xmlstr} - load a well formed XML document from a string
- B{htmlstr} - load a HTML document from a string
Unless absolutely necessary you should use either the stan loader or
one of the xml loaders. The html loaders should only be used for badly
formed HTML documents, i.e. if your HTML developer hasn't heard of
XHTML yet. Even then, you should probably try to educate the HTML
developer first ;-).
"""
import warnings
import os.path
from zope.interface import implements
from nevow import context
from nevow import inevow
from nevow import tags
from nevow import flat
from nevow.flat import flatsax
from twisted.python.reflect import getClass
class DocFactory:
"""Base class for document factories. I am responsible for loading a document
template for the renderer to use.
"""
implements(inevow.IDocFactory)
pattern = None
precompiledDoc = None
def __init__(self, pattern=None):
warnings.warn(
"[v0.4] DocFactory is deprecated - it just made things more complicated. Please update the %r loader."%self.__class__,
DeprecationWarning,
stacklevel=2)
if pattern:
self.pattern = pattern
def precompile(self, parent):
ctx = context.WovenContext(parent=parent, precompile=True)
from nevow import flat
doc = flat.precompile(self.getDoc(), ctx)
if self.pattern:
tag = tags.invisible[doc]
doc = [tag.onePattern(self.pattern)]
return doc
def load(self, ctx=None):
"""Load and return the document for the renderer"""
if self.precompiledDoc is None:
self.precompiledDoc = self.precompile(ctx)
return self.precompiledDoc
class stan(object):
"""A stan tags document factory"""
implements(inevow.IDocFactory)
stan = None
pattern = None
_cache = None
def __init__(self, stan=None, pattern=None):
if stan is not None:
self.stan = stan
if pattern is not None:
self.pattern = pattern
def load(self, ctx=None):
if self._cache is None:
stan = flat.precompile(self.stan, ctx)
if self.pattern is not None:
stan = inevow.IQ(stan).onePattern(self.pattern)
self._cache = stan
return self._cache
class htmlstr(object):
"""A document factory for HTML contained in a string"""
implements(inevow.IDocFactory)
template = None
pattern = None
beExtremelyLenient = True
_cache = None
def __init__(self, template=None, pattern=None, beExtremelyLenient=None):
warnings.warn(
"[v0.8] htmlstr is deprecated because it's buggy. Please start using xmlfile and/or xmlstr.",
DeprecationWarning,
stacklevel=2)
if template is not None:
self.template = template
if pattern is not None:
self.pattern = pattern
if beExtremelyLenient is not None:
self.beExtremelyLenient = beExtremelyLenient
def load(self, ctx=None):
if self._cache is None:
from twisted.web import microdom
doc = microdom.parseString(self.template, beExtremelyLenient=self.beExtremelyLenient)
doc = flat.precompile(doc, ctx)
if self.pattern is not None:
doc = inevow.IQ(doc).onePattern(self.pattern)
self._cache = doc
return self._cache
class htmlfile(object):
"""A document factory for an HTML disk template"""
implements(inevow.IDocFactory)
template = None
pattern = None
templateDir = ''
beExtremelyLenient = True
_filename = None
_mtime = None
_cache = None
def __init__(self, template=None, pattern=None, templateDir=None, beExtremelyLenient=None):
warnings.warn(
"[v0.8] htmlfile is deprecated because it's buggy. Please start using xmlfile and/or xmlstr.",
DeprecationWarning,
stacklevel=2)
if template is not None:
self.template = template
if pattern is not None:
self.pattern = pattern
if templateDir is not None:
self.templateDir = templateDir
if beExtremelyLenient is not None:
self.beExtremelyLenient = beExtremelyLenient
self._filename = os.path.join(self.templateDir, self.template)
def load(self, ctx=None):
mtime = os.path.getmtime(self._filename)
if mtime != self._mtime or self._cache is None:
from twisted.web import microdom
doc = microdom.parse(self._filename, beExtremelyLenient=self.beExtremelyLenient)
doc = flat.precompile(doc, ctx)
if self.pattern is not None:
doc = inevow.IQ(doc).onePattern(self.pattern)
self._mtime = mtime
self._cache = doc
return self._cache
class xmlstr(object):
implements(inevow.IDocFactory)
template = None
pattern = None
ignoreDocType = None
ignoreComment = None
_cache = None
def __init__(self, template=None, pattern=None, ignoreDocType=False, ignoreComment=False):
if template is not None:
self.template = template
if pattern is not None:
self.pattern = pattern
if ignoreDocType is not None:
self.ignoreDocType = ignoreDocType
if ignoreComment is not None:
self.ignoreComment = ignoreComment
def load(self, ctx=None):
if self._cache is None:
doc = flatsax.parseString(self.template, self.ignoreDocType, self.ignoreComment)
doc = flat.precompile(doc, ctx)
if self.pattern is not None:
doc = inevow.IQ(doc).onePattern(self.pattern)
self._cache = doc
return self._cache
class xmlfile(object):
implements(inevow.IDocFactory)
template = None
templateDir = None
pattern = None
ignoreDocType = False
ignoreComment = False
_filename = None
_mtime = None
_cache = None
def __init__(self, template=None, pattern=None, templateDir=None, ignoreDocType=None, ignoreComment=None):
self._cache = {}
if template is not None:
self.template = template
if pattern is not None:
self.pattern = pattern
if templateDir is not None:
self.templateDir = templateDir
if ignoreDocType is not None:
self.ignoreDocType = ignoreDocType
if ignoreComment is not None:
self.ignoreComment = ignoreComment
if self.templateDir is not None:
self._filename = os.path.join(self.templateDir, self.template)
else:
self._filename = self.template
def load(self, ctx=None):
rendererFactoryClass = None
if ctx is not None:
r = inevow.IRendererFactory(ctx, None)
if r is not None:
rendererFactoryClass = getClass(r)
cacheKey = (self._filename, self.pattern, rendererFactoryClass)
try:
cachedModified, doc = self._cache[cacheKey]
except KeyError:
cachedModified = doc = None
currentModified = os.path.getmtime(self._filename)
if currentModified == cachedModified:
return doc
doc = flatsax.parse(open(self._filename), self.ignoreDocType, self.ignoreComment)
doc = flat.precompile(doc, ctx)
if self.pattern is not None:
doc = inevow.IQ(doc).onePattern(self.pattern)
self._mtime = currentModified
self._cache[cacheKey] = currentModified, doc
return doc
|