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
|
"""This module implements a templating generator based on Genshi."""
import binascii
import logging
import sys
import Bcfg2.Server.Plugin
# py3k compatibility
if sys.hexversion >= 0x03000000:
unicode = str
logger = logging.getLogger('Bcfg2.Plugins.TGenshi')
# try to import genshi stuff
try:
import genshi.core
import genshi.input
from genshi.template import TemplateLoader, \
TextTemplate, MarkupTemplate, TemplateError
except ImportError:
logger.error("TGenshi: Failed to import Genshi. Is it installed?")
raise Bcfg2.Server.Plugin.PluginInitError
try:
from genshi.template import NewTextTemplate
have_ntt = True
except:
have_ntt = False
def removecomment(stream):
"""A genshi filter that removes comments from the stream."""
for kind, data, pos in stream:
if kind is genshi.core.COMMENT:
continue
yield kind, data, pos
class TemplateFile:
"""Template file creates Genshi template structures for the loaded file."""
def __init__(self, name, specific, encoding):
self.name = name
self.specific = specific
self.encoding = encoding
if self.specific.all:
matchname = self.name
elif self.specific.group:
matchname = self.name[:self.name.find('.G')]
else:
matchname = self.name[:self.name.find('.H')]
if matchname.endswith('.txt'):
self.template_cls = TextTemplate
elif matchname.endswith('.newtxt'):
if not have_ntt:
logger.error("Genshi NewTextTemplates not supported by this version of Genshi")
else:
self.template_cls = NewTextTemplate
else:
self.template_cls = MarkupTemplate
self.HandleEvent = self.handle_event
def handle_event(self, event=None):
"""Handle all fs events for this template."""
if event and event.code2str() == 'deleted':
return
try:
loader = TemplateLoader()
try:
self.template = loader.load(self.name, cls=self.template_cls,
encoding=self.encoding)
except LookupError:
lerror = sys.exc_info()[1]
logger.error('Genshi lookup error: %s' % lerror)
except TemplateError:
terror = sys.exc_info()[1]
logger.error('Genshi template error: %s' % terror)
except genshi.input.ParseError:
perror = sys.exc_info()[1]
logger.error('Genshi parse error: %s' % perror)
def bind_entry(self, entry, metadata):
"""Build literal file information."""
fname = entry.get('realname', entry.get('name'))
if entry.tag == 'Path':
entry.set('type', 'file')
try:
stream = self.template.generate( \
name=fname, metadata=metadata,
path=self.name).filter(removecomment)
if have_ntt:
ttypes = [TextTemplate, NewTextTemplate]
else:
ttypes = [TextTemplate]
if True in [isinstance(self.template, t) for t in ttypes]:
try:
textdata = stream.render('text', strip_whitespace=False)
except TypeError:
textdata = stream.render('text')
if type(textdata) == unicode:
entry.text = textdata
else:
if entry.get('encoding') == 'base64':
# take care of case where file needs base64 encoding
entry.text = binascii.b2a_base64(textdata)
else:
entry.text = unicode(textdata, self.encoding)
else:
try:
xmldata = stream.render('xml', strip_whitespace=False)
except TypeError:
xmldata = stream.render('xml')
if type(xmldata) == unicode:
entry.text = xmldata
else:
entry.text = unicode(xmldata, self.encoding)
if entry.text == '':
entry.set('empty', 'true')
except TemplateError:
terror = sys.exc_info()[1]
logger.error('Genshi template error: %s' % terror)
raise Bcfg2.Server.Plugin.PluginExecutionError
except AttributeError:
err = sys.exc_info()[1]
logger.error('Genshi template loading error: %s' % err)
raise Bcfg2.Server.Plugin.PluginExecutionError
class TGenshi(Bcfg2.Server.Plugin.GroupSpool):
"""
The TGenshi generator implements a templating
mechanism for configuration files.
"""
name = 'TGenshi'
__author__ = 'jeff@ocjtech.us'
filename_pattern = 'template\.(txt|newtxt|xml)'
es_child_cls = TemplateFile
|
