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
|
""" Handle <Path type='file' ...> entries """
import os
import sys
import stat
import difflib
import tempfile
import Bcfg2.Options
from Bcfg2.Client.Tools.POSIX.base import POSIXTool
from Bcfg2.Compat import unicode, b64encode, b64decode # pylint: disable=W0622
class POSIXFile(POSIXTool):
""" Handle <Path type='file' ...> entries """
__req__ = ['name', 'mode', 'owner', 'group']
def fully_specified(self, entry):
return entry.text is not None or entry.get('empty', 'false') == 'true'
def _is_string(self, strng, encoding):
""" Returns true if the string contains no ASCII control
characters and can be decoded from the specified encoding. """
for char in strng:
if ord(char) < 9 or ord(char) > 13 and ord(char) < 32:
return False
if not hasattr(strng, "decode"):
# py3k
return True
try:
strng.decode(encoding)
return True
except: # pylint: disable=W0702
return False
def _get_data(self, entry):
""" Get a tuple of (<file data>, <is binary>) for the given entry """
is_binary = entry.get('encoding', 'ascii') == 'base64'
if entry.get('empty', 'false') == 'true' or not entry.text:
tempdata = ''
elif is_binary:
tempdata = b64decode(entry.text)
else:
tempdata = entry.text
if isinstance(tempdata, unicode) and unicode != str:
try:
tempdata = tempdata.encode(Bcfg2.Options.setup.encoding)
except UnicodeEncodeError:
err = sys.exc_info()[1]
self.logger.error("POSIX: Error encoding file %s: %s" %
(entry.get('name'), err))
return (tempdata, is_binary)
def verify(self, entry, modlist):
ondisk = self._exists(entry)
tempdata, is_binary = self._get_data(entry)
if isinstance(tempdata, str) and str != unicode:
tempdatasize = len(tempdata)
else:
tempdatasize = len(tempdata.encode(Bcfg2.Options.setup.encoding))
different = False
content = None
if not ondisk:
# first, see if the target file exists at all; if not,
# they're clearly different
different = True
content = ""
elif tempdatasize != ondisk[stat.ST_SIZE]:
# next, see if the size of the target file is different
# from the size of the desired content
different = True
else:
# finally, read in the target file and compare them
# directly. comparison could be done with a checksum,
# which might be faster for big binary files, but slower
# for everything else
try:
content = open(entry.get('name')).read()
except UnicodeDecodeError:
content = open(entry.get('name'),
encoding=Bcfg2.Options.setup.encoding).read()
except IOError:
self.logger.error("POSIX: Failed to read %s: %s" %
(entry.get("name"), sys.exc_info()[1]))
return False
different = content != tempdata
if different:
self.logger.debug("POSIX: %s has incorrect contents" %
entry.get("name"))
self._get_diffs(
entry, interactive=Bcfg2.Options.setup.interactive,
sensitive=entry.get('sensitive', 'false').lower() == 'true',
is_binary=is_binary, content=content)
return POSIXTool.verify(self, entry, modlist) and not different
def _write_tmpfile(self, entry):
""" Write the file data to a temp file """
filedata = self._get_data(entry)[0]
# get a temp file to write to that is in the same directory as
# the existing file in order to preserve any permissions
# protections on that directory, and also to avoid issues with
# /tmp set nosetuid while creating files that are supposed to
# be setuid
try:
(newfd, newfile) = \
tempfile.mkstemp(prefix=os.path.basename(entry.get("name")),
dir=os.path.dirname(entry.get("name")))
except OSError:
err = sys.exc_info()[1]
self.logger.error("POSIX: Failed to create temp file in %s: %s" %
(os.path.dirname(entry.get('name')), err))
return False
try:
if isinstance(filedata, str) and str != unicode:
os.fdopen(newfd, 'w').write(filedata)
else:
os.fdopen(newfd, 'wb').write(
filedata.encode(Bcfg2.Options.setup.encoding))
except (OSError, IOError):
err = sys.exc_info()[1]
self.logger.error("POSIX: Failed to open temp file %s for writing "
"%s: %s" %
(newfile, entry.get("name"), err))
return False
return newfile
def _rename_tmpfile(self, newfile, entry):
""" Rename the given file to the appropriate filename for entry """
try:
os.rename(newfile, entry.get('name'))
return True
except OSError:
err = sys.exc_info()[1]
self.logger.error("POSIX: Failed to rename temp file %s to %s: %s"
% (newfile, entry.get('name'), err))
try:
os.unlink(newfile)
except OSError:
err = sys.exc_info()[1]
self.logger.error("POSIX: Could not remove temp file %s: %s" %
(newfile, err))
return False
def install(self, entry):
"""Install device entries."""
if not os.path.exists(os.path.dirname(entry.get('name'))):
if not self._makedirs(entry,
path=os.path.dirname(entry.get('name'))):
return False
newfile = self._write_tmpfile(entry)
if not newfile:
return False
rv = self._set_perms(entry, path=newfile)
if not self._rename_tmpfile(newfile, entry):
return False
return POSIXTool.install(self, entry) and rv
def _get_diffs(self, entry, interactive=False, # pylint: disable=R0912
sensitive=False, is_binary=False, content=None):
""" generate the necessary diffs for entry """
if not interactive and sensitive:
return
prompt = [entry.get('qtext', '')]
attrs = dict()
if content is None:
# it's possible that we figured out the files are
# different without reading in the local file. if the
# supplied version of the file is not binary, we now have
# to read in the local file to figure out if _it_ is
# binary, and either include that fact or the diff in our
# prompts for -I and the reports
try:
content = open(entry.get('name')).read()
except UnicodeDecodeError:
content = open(entry.get('name'), encoding='utf-8').read()
except IOError:
self.logger.error("POSIX: Failed to read %s: %s" %
(entry.get("name"), sys.exc_info()[1]))
return False
if not is_binary:
is_binary |= not self._is_string(content,
Bcfg2.Options.setup.encoding)
if is_binary:
# don't compute diffs if the file is binary
prompt.append('Binary file, no printable diff')
attrs['current_bfile'] = b64encode(content)
else:
diff = self._diff(content, self._get_data(entry)[0],
filename=entry.get("name"))
if interactive:
if diff:
udiff = '\n'.join(diff)
if hasattr(udiff, "decode"):
udiff = udiff.decode(Bcfg2.Options.setup.encoding)
try:
prompt.append(udiff)
except UnicodeEncodeError:
prompt.append("Could not encode diff")
elif entry.get("empty", "true"):
# the file doesn't exist on disk, but there's no
# expected content
prompt.append("%s does not exist" % entry.get("name"))
else:
prompt.append("Diff took too long to compute, no "
"printable diff")
if not sensitive:
if diff:
attrs["current_bdiff"] = b64encode("\n".join(diff))
else:
attrs['current_bfile'] = b64encode(content)
if interactive:
entry.set("qtext", "\n".join(prompt))
if not sensitive:
for attr, val in attrs.items():
entry.set(attr, val)
def _diff(self, content1, content2, filename=None):
""" Return a unified diff of the two strings """
if filename:
fromfile = "%s (on disk)" % filename
tofile = "%s (from bcfg2)" % filename
else:
fromfile = ""
tofile = ""
return difflib.unified_diff(content1.split('\n'),
content2.split('\n'),
fromfile=fromfile,
tofile=tofile)
|
