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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
#!/usr/bin/env python
# vim: sts=4 sw=4 et
# This is a component of EMC
# util.py Copyright 2010 Michael Haberler
#
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA'''
'''
persistence support for gladevcp widgets
Michael Haberler 11/2010
'''
import os
import sys
import time
import gtk
from configobj import ConfigObj, flatten_errors
from validate import Validator
from hashlib import sha1
from hal_widgets import _HalWidgetBase
from hal_actions import _EMC_ActionBase
from gladevcp.gladebuilder import widget_name
class UselessIniError(Exception):
pass
class BadDescriptorDictError(Exception):
pass
# map python type names to ConfigObj type names
co_map = {'str': 'string','int':'integer', 'str': 'string', 'bool': 'boolean'}
debug = 0
version_number = 1
def warn(*args):
print >> sys.stderr,''.join(args)
def dbg(level,*args):
global debug
if debug < level: return
print ''.join(args)
def set_debug(value):
global debug
debug = value
def select_widgets(widgets, hal_only=False,output_only = False):
'''
input: a list of widget instances
output: a list of widget instances, pruned according to the flags:
hal_only = True: only add HAL widgets which make sense restoring
output_only = True: only add widgets which let users
set a value (scale,button..)
'''
wlist = []
for w in widgets:
# always skip the following types:
if isinstance(w, (_EMC_ActionBase)):
continue
if hal_only and not isinstance(w, _HalWidgetBase):
continue
if output_only and not isinstance(w, (gtk.Range,
gtk.SpinButton,
gtk.ComboBox,
gtk.CheckButton,
gtk.ToggleButton,
gtk.RadioButton)):
continue
wlist.append(w)
return wlist
def accessors(w):
'''
retrieve getter/setter name of an 'interesting' widget
'''
if isinstance(w, (gtk.Range, gtk.SpinButton)):
return (w.get_value,w.set_value)
if isinstance(w, (gtk.CheckButton, gtk.ToggleButton,gtk.RadioButton,gtk.ComboBox)):
return (w.get_active,w.set_active)
return (None,None)
def store_value(widget,value):
_,setter = accessors(widget)
return setter and setter(value)
def get_value(widget):
getter,_ = accessors(widget)
return getter and getter()
def widget_defaults(widgets):
'''
return a dict name/current value of wvalues which are to be restored
'''
wvalues = dict()
for w in widgets:
k = widget_name(w)
try:
v = get_value(w)
wvalues[k] = v
except Exception,msg:
warn("widget_defaults:" + msg)
continue
return wvalues
class IniFile(object):
# well known section and variable names in .ini files
vars = 'vars'
widgets = 'widgets'
ini = 'ini'
signature = 'signature'
version = 'version'
def _gen_spec(self,vdict):
'''
given a nested dict of sections,vars and default values,
derive a ConfigObj typed spec
NB: only single level nesting supported
FIXME: add safeguards against broken vdict()
'''
spec = ''
for section in sorted(vdict.keys()):
spec += '[' + section + ']\n'
for varname in sorted(vdict[section].keys()):
typename = type(vdict[section][varname]).__name__
if co_map.has_key(typename):
typename = co_map[typename]
spec += '\t' + varname + ' = ' + typename + '\n'
return spec
def restore_state(self,obj):
'''
restore attributes from ini file 'vars' section as obj attributes,
as well as any widget state in 'widgets' section
'''
dbg(1, "restore_state() from %s" % (self.filename))
if not self.defaults.has_key(IniFile.ini):
raise BadDescriptorDictError("defaults dict lacks 'ini' section")
if self.defaults[IniFile.ini][IniFile.signature] != (
self.config[IniFile.ini][IniFile.signature]):
warn("signature mismatch in %s - resetting to default" %
(self.filename))
dbg(1, "expected: %s, got %s" %
(self.defaults[IniFile.ini][IniFile.signature],
self.config[IniFile.ini][IniFile.signature]))
self.create_default_ini()
else:
dbg(1,"signature verified OK for %s " % (self.filename))
if self.config.has_key(IniFile.vars):
for k,v in self.defaults[IniFile.vars].items():
setattr(obj,k,self.config[IniFile.vars][k])
if self.config.has_key(IniFile.widgets):
for k,v in self.config[IniFile.widgets].items():
store_value(self.builder.get_object(k),v)
def save_state(self, obj):
'''
save obj attributes as listed in ini file 'IniFile.vars' section and
widget state to 'widgets' section
'''
if self.defaults.has_key(IniFile.vars):
for k,v in self.defaults[IniFile.vars].items():
self.config[IniFile.vars][k] = getattr(obj,k,None)
if self.config.has_key(IniFile.widgets):
for k in self.defaults[IniFile.widgets].keys():
self.config[IniFile.widgets][k] = get_value(self.builder.get_object(k))
self.config.final_comment = ['last update by %s.save_state() on %s ' %
(__name__,time.asctime())]
self.write()
dbg(1, "save_state() to %s" % (self.filename))
def create_default_ini(self):
'''
create a default ini file with defaults derived from configspec
'''
self.config = ConfigObj(self.filename, interpolation=False,
configspec=self.spec)
vdt = Validator()
self.config.validate(vdt, copy=True)
self.config.update(self.defaults)
self.config.filename = self.filename
self.config.initial_comment.append('generated by %s.create_default_ini() on %s' %
(__name__, time.asctime()))
self.config.write()
def read_ini(self):
'''
make sure current file validates OK, this will also type-convert values
recreate default ini file if bad things happen
'''
retries = 2
while True:
try:
self.config = ConfigObj(self.filename,
file_error=True,
interpolation=False,
configspec=self.spec,
raise_errors=True)
validator = Validator()
results = self.config.validate(validator,preserve_errors=True)
if results != True:
for (section_list, key, error
) in flatten_errors(self.config, results):
if key is not None:
warn("key '%s' in section '%s' : %s" %
(key, ', '.join(section_list),
error if error else "missing"))
else:
warn("section '%s' missing" %
', '.join(section_list))
badfilename = self.filename + '.BAD'
os.rename(self.filename,badfilename)
retries -= 1
if retries:
raise UselessIniError("cant make sense of '%s', renamed to '%s'"
% (self.filename, badfilename))
else:
raise Exception(error)
except (IOError, TypeError,UselessIniError),msg:
warn("%s - creating default" % (msg))
self.create_default_ini()
continue
except: # pass on ConfigObj's other troubles
raise
else: # all great
break
def write(self,filename=None):
'''
write out changed config
'''
if filename:
self.filename = filename
self.config.write()
def __init__(self,filename,defaults,builder):
defaults[IniFile.ini] = { IniFile.signature : 'astring',
IniFile.version : version_number }
self.defaults = defaults
self.filename = filename
self.builder = builder
spec = self._gen_spec(self.defaults)
self.signature = sha1(spec).hexdigest()
self.defaults[IniFile.ini][IniFile.signature] = self.signature
dbg(2, "auto-generated spec:\n%s\nsignature = %s" %
(spec, self.signature))
self.spec = spec.splitlines()
self.read_ini()
|
