2 from Tools.NumericalTextInput import NumericalTextInput
3 from Tools.Directories import resolveFilename, SCOPE_CONFIG
7 # ConfigElement, the base class of all ConfigElements.
10 # value the current value, usefully encoded.
11 # usually a property which retrieves _value,
12 # and maybe does some reformatting
13 # _value the value as it's going to be saved in the configfile,
14 # though still in non-string form.
15 # this is the object which is actually worked on.
16 # default the initial value. If _value is equal to default,
17 # it will not be stored in the config file
18 # saved_value is a text representation of _value, stored in the config file
20 # and has (at least) the following methods:
21 # save() stores _value into saved_value,
22 # (or stores 'None' if it should not be stored)
23 # load() loads _value from saved_value, or loads
24 # the default if saved_value is 'None' (default)
27 class ConfigElement(object):
31 self.saved_value = None
32 self.save_disabled = False
36 # you need to override this to do input validation
37 def setValue(self, value):
44 value = property(getValue, setValue)
46 # you need to override this if self.value is not a string
47 def fromstring(self, value):
50 # you can overide this for fancy default handling
52 if self.saved_value is None:
53 self.value = self.default
55 self.value = self.fromstring(self.saved_value)
57 def tostring(self, value):
60 # you need to override this if str(self.value) doesn't work
62 if self.save_disabled or self.value == self.default:
63 self.saved_value = None
65 self.saved_value = self.tostring(self.value)
71 for x in self.notifiers:
74 def addNotifier(self, notifier, initial_call = True):
75 assert callable(notifier), "notifiers must be callable"
76 self.notifiers.append(notifier)
79 # do we want to call the notifier
80 # - at all when adding it? (yes, though optional)
81 # - when the default is active? (yes)
82 # - when no value *yet* has been set,
83 # because no config has ever been read (currently yes)
84 # (though that's not so easy to detect.
85 # the entry could just be new.)
89 def disableSave(self):
90 self.save_disabled = True
92 def __call__(self, selected):
93 return self.getMulti(selected)
103 KEY_NUMBERS = range(12, 12+10)
107 def getKeyNumber(key):
108 assert key in KEY_NUMBERS
112 # ConfigSelection is a "one of.."-type.
113 # it has the "choices", usually a list, which contains
114 # (id, desc)-tuples (or just only the ids, in case the id
115 # will be used as description)
117 # all ids MUST be plain strings.
119 class ConfigSelection(ConfigElement):
120 def __init__(self, choices, default = None):
121 ConfigElement.__init__(self)
123 self.description = {}
125 if isinstance(choices, list):
127 if isinstance(x, tuple):
128 self.choices.append(x[0])
129 self.description[x[0]] = x[1]
131 self.choices.append(x)
132 self.description[x] = x
133 elif isinstance(choices, dict):
134 for (key, val) in choices.items():
135 self.choices.append(key)
136 self.description[key] = val
138 assert False, "ConfigSelection choices must be dict or list!"
140 #assert len(self.choices), "you can't have an empty configselection"
141 if len(self.choices) == 0:
143 self.description[""] = ""
146 default = self.choices[0]
148 assert default in self.choices, "default must be in choice list, but " + repr(default) + " is not!"
149 for x in self.choices:
150 assert isinstance(x, str), "ConfigSelection choices must be strings"
152 self.value = self.default = default
154 def setValue(self, value):
155 if value in self.choices:
158 self._value = self.default
162 def tostring(self, val):
168 def setCurrentText(self, text):
169 i = self.choices.index(self.value)
170 del self.description[self.choices[i]]
171 self.choices[i] = text
172 self.description[text] = text
175 value = property(getValue, setValue)
178 return self.choices.index(self.value)
180 index = property(getIndex)
183 def handleKey(self, key):
184 nchoices = len(self.choices)
185 i = self.choices.index(self.value)
187 self.value = self.choices[(i + nchoices - 1) % nchoices]
188 elif key == KEY_RIGHT:
189 self.value = self.choices[(i + 1) % nchoices]
191 def getMulti(self, selected):
192 return ("text", self.description[self.value])
195 def getHTML(self, id):
197 for v in self.choices:
199 checked = 'checked="checked" '
202 res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + self.description[v] + "</input></br>\n"
205 def unsafeAssign(self, value):
206 # setValue does check if value is in choices. This is safe enough.
211 # several customized versions exist for different
214 class ConfigBoolean(ConfigElement):
215 def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
216 ConfigElement.__init__(self)
217 self.descriptions = descriptions
218 self.value = self.default = default
219 def handleKey(self, key):
220 if key in [KEY_LEFT, KEY_RIGHT]:
221 self.value = not self.value
223 def getMulti(self, selected):
224 return ("text", _(self.descriptions[self.value]))
226 def tostring(self, value):
232 def fromstring(self, val):
238 def getHTML(self, id):
240 checked = ' checked="checked"'
243 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
245 # this is FLAWED. and must be fixed.
246 def unsafeAssign(self, value):
252 class ConfigYesNo(ConfigBoolean):
253 def __init__(self, default = False):
254 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
256 class ConfigOnOff(ConfigBoolean):
257 def __init__(self, default = False):
258 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
260 class ConfigEnableDisable(ConfigBoolean):
261 def __init__(self, default = False):
262 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
264 class ConfigDateTime(ConfigElement):
265 def __init__(self, default, formatstring, increment = 86400):
266 ConfigElement.__init__(self)
267 self.increment = increment
268 self.formatstring = formatstring
269 self.value = self.default = int(default)
271 def handleKey(self, key):
273 self.value = self.value - self.increment
275 self.value = self.value + self.increment
277 def getMulti(self, selected):
278 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
280 def fromstring(self, val):
283 # *THE* mighty config element class
285 # allows you to store/edit a sequence of values.
286 # can be used for IP-addresses, dates, plain integers, ...
287 # several helper exist to ease this up a bit.
289 class ConfigSequence(ConfigElement):
290 def __init__(self, seperator, limits, censor_char = "", default = None):
291 ConfigElement.__init__(self)
292 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
293 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
294 #assert isinstance(default, list), "default must be a list"
295 #assert isinstance(default[0], int), "list must contain numbers"
296 #assert len(default) == len(limits), "length must match"
299 self.seperator = seperator
301 self.censor_char = censor_char
303 self.default = default
304 self.value = copy.copy(default)
309 for i in self._value:
310 max_pos += len(str(self.limits[num][1]))
312 while self._value[num] < self.limits[num][0]:
315 while self._value[num] > self.limits[num][1]:
316 self._value[num] -= 1
320 if self.marked_pos >= max_pos:
321 self.marked_pos = max_pos - 1
323 if self.marked_pos < 0:
326 def validatePos(self):
327 if self.marked_pos < 0:
330 total_len = sum([len(str(x[1])) for x in self.limits])
332 if self.marked_pos >= total_len:
333 self.marked_pos = total_len - 1
335 def handleKey(self, key):
344 if key in KEY_NUMBERS:
346 for x in self.limits:
347 block_len.append(len(str(x[1])))
349 total_len = sum(block_len)
353 block_len_total = [0, ]
355 pos += block_len[blocknumber]
356 block_len_total.append(pos)
357 if pos - 1 >= self.marked_pos:
362 number = getKeyNumber(key)
364 # length of numberblock
365 number_len = len(str(self.limits[blocknumber][1]))
367 # position in the block
368 posinblock = self.marked_pos - block_len_total[blocknumber]
370 oldvalue = self._value[blocknumber]
371 olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
372 newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
374 self._value[blocknumber] = newvalue
380 def getMulti(self, selected):
382 mPos = self.marked_pos
384 for i in self._value:
385 if len(value): #fixme no heading separator possible
386 value += self.seperator
387 if mPos >= len(value) - 1:
390 if self.censor_char == "":
391 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
393 value += (self.censor_char * len(str(self.limits[num][1])))
396 # only mark cursor when we are selected
397 # (this code is heavily ink optimized!)
399 return ("mtext"[1-selected:], value, [mPos])
401 return ("text", value)
403 def tostring(self, val):
404 return self.seperator.join([self.saveSingle(x) for x in val])
406 def saveSingle(self, v):
409 def fromstring(self, value):
410 return [int(x) for x in self.saved_value.split(self.seperator)]
412 class ConfigIP(ConfigSequence):
413 def __init__(self, default):
414 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
416 class ConfigMAC(ConfigSequence):
417 def __init__(self, default):
418 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
420 class ConfigPosition(ConfigSequence):
421 def __init__(self, default, args):
422 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
424 class ConfigClock(ConfigSequence):
425 def __init__(self, default):
427 t = time.localtime(default)
428 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
430 class ConfigInteger(ConfigSequence):
431 def __init__(self, default, limits = (0, 10000000000)):
432 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
434 # you need to override this to do input validation
435 def setValue(self, value):
436 self._value = [value]
440 return self._value[0]
442 value = property(getValue, setValue)
444 def fromstring(self, value):
447 def tostring(self, value):
450 class ConfigPIN(ConfigInteger):
451 def __init__(self, default, len = 4, censor = ""):
452 assert isinstance(default, int), "ConfigPIN default must be an integer"
455 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
461 class ConfigFloat(ConfigSequence):
462 def __init__(self, default, limits):
463 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
466 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
468 float = property(getFloat)
470 # an editable text...
471 class ConfigText(ConfigElement, NumericalTextInput):
472 def __init__(self, default = "", fixed_size = True):
473 ConfigElement.__init__(self)
474 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
477 self.fixed_size = fixed_size
479 self.value = self.default = default
481 def validateMarker(self):
482 if self.marked_pos < 0:
484 if self.marked_pos >= len(self.text):
485 self.marked_pos = len(self.text) - 1
487 #def nextEntry(self):
488 # self.vals[1](self.getConfigPath())
490 def handleKey(self, key):
491 # this will no change anything on the value itself
492 # so we can handle it here in gui element
493 if key == KEY_DELETE:
494 self.text = self.text[0:self.marked_pos] + self.text[self.marked_pos + 1:]
495 elif key == KEY_LEFT:
497 elif key == KEY_RIGHT:
499 if not self.fixed_size:
500 if self.marked_pos >= len(self.text):
501 self.text = self.text.ljust(len(self.text) + 1)
502 elif key in KEY_NUMBERS:
503 number = self.getKey(getKeyNumber(key))
504 self.text = self.text[0:self.marked_pos] + unicode(number) + self.text[self.marked_pos + 1:]
505 elif key == KEY_TIMEOUT:
509 self.validateMarker()
514 self.validateMarker()
518 return self.text.encode("utf-8")
520 def setValue(self, val):
522 self.text = val.decode("utf-8")
523 except UnicodeDecodeError:
527 value = property(getValue, setValue)
528 _value = property(getValue, setValue)
530 def getMulti(self, selected):
531 return ("mtext"[1-selected:], self.value, [self.marked_pos])
533 def helpWindow(self):
534 from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
535 return (NumericalTextInputHelpDialog,self)
537 def getHTML(self, id):
538 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
540 def unsafeAssign(self, value):
541 self.value = str(value)
544 class ConfigSlider(ConfigElement):
545 def __init__(self, default = 0, increment = 1, limits = (0, 100)):
546 ConfigElement.__init__(self)
547 self.value = self.default = default
550 self.increment = increment
552 def checkValues(self):
553 if self.value < self.min:
554 self.value = self.min
556 if self.value > self.max:
557 self.value = self.max
559 def handleKey(self, key):
561 self.value -= self.increment
562 elif key == KEY_RIGHT:
563 self.value += self.increment
570 def getMulti(self, selected):
572 return ("slider", self.value, self.max)
574 def fromstring(self, value):
577 # a satlist. in fact, it's a ConfigSelection.
578 class ConfigSatlist(ConfigSelection):
579 def __init__(self, list, default = None):
580 if default is not None:
581 default = str(default)
582 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc) in list], default = default)
584 def getOrbitalPosition(self):
587 return int(self.value)
589 orbital_position = property(getOrbitalPosition)
592 class ConfigNothing(ConfigSelection):
594 ConfigSelection.__init__(self, choices = [""])
596 # until here, 'saved_value' always had to be a *string*.
597 # now, in ConfigSubsection, and only there, saved_value
598 # is a dict, essentially forming a tree.
600 # config.foo.bar=True
601 # config.foobar=False
604 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
608 class ConfigSubsectionContent(object):
611 # we store a backup of the loaded configuration
612 # data in self.stored_values, to be able to deploy
613 # them when a new config element will be added,
614 # so non-default values are instantly available
616 # A list, for example:
617 # config.dipswitches = ConfigSubList()
618 # config.dipswitches.append(ConfigYesNo())
619 # config.dipswitches.append(ConfigYesNo())
620 # config.dipswitches.append(ConfigYesNo())
621 class ConfigSubList(list, object):
623 object.__init__(self)
625 self.stored_values = {}
635 def getSavedValue(self):
637 for i in range(len(self)):
638 sv = self[i].saved_value
643 def setSavedValue(self, values):
644 self.stored_values = dict(values)
645 for (key, val) in self.stored_values.items():
646 if int(key) < len(self):
647 self[int(key)].saved_value = val
649 saved_value = property(getSavedValue, setSavedValue)
651 def append(self, item):
653 list.append(self, item)
654 if i in self.stored_values:
655 item.saved_value = self.stored_values[i]
658 # same as ConfigSubList, just as a dictionary.
659 # care must be taken that the 'key' has a proper
660 # str() method, because it will be used in the config
662 class ConfigSubDict(dict, object):
664 object.__init__(self)
666 self.stored_values = {}
669 for x in self.values():
673 for x in self.values():
676 def getSavedValue(self):
678 for (key, val) in self.items():
679 if val.saved_value is not None:
680 res[str(key)] = val.saved_value
683 def setSavedValue(self, values):
684 self.stored_values = dict(values)
685 for (key, val) in self.items():
686 if str(key) in self.stored_values:
687 val = self.stored_values[str(key)]
689 saved_value = property(getSavedValue, setSavedValue)
691 def __setitem__(self, key, item):
692 dict.__setitem__(self, key, item)
693 if str(key) in self.stored_values:
694 item.saved_value = self.stored_values[str(key)]
697 # Like the classes above, just with a more "native"
700 # some evil stuff must be done to allow instant
701 # loading of added elements. this is why this class
704 # we need the 'content' because we overwrite
706 # If you don't understand this, try adding
707 # __setattr__ to a usual exisiting class and you will.
708 class ConfigSubsection(object):
710 object.__init__(self)
711 self.__dict__["content"] = ConfigSubsectionContent()
712 self.content.items = { }
713 self.content.stored_values = { }
715 def __setattr__(self, name, value):
716 if name == "saved_value":
717 return self.setSavedValue(value)
718 assert isinstance(value, ConfigSubsection) or isinstance(value, ConfigElement) or isinstance(value, ConfigSubList) or isinstance(value, ConfigSubDict), "ConfigSubsections can only store ConfigSubsections, ConfigSubLists, ConfigSubDicts or ConfigElements"
719 self.content.items[name] = value
720 if name in self.content.stored_values:
721 #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
722 value.saved_value = self.content.stored_values[name]
725 def __getattr__(self, name):
726 return self.content.items[name]
728 def getSavedValue(self):
729 res = self.content.stored_values
730 for (key, val) in self.content.items.items():
731 if val.saved_value is not None:
732 res[key] = val.saved_value
738 def setSavedValue(self, values):
739 values = dict(values)
741 self.content.stored_values = values
743 for (key, val) in self.content.items.items():
745 val.setSavedValue(values[key])
747 saved_value = property(getSavedValue, setSavedValue)
750 for x in self.content.items.values():
754 for x in self.content.items.values():
757 # the root config object, which also can "pickle" (=serialize)
758 # down the whole config tree.
760 # we try to keep non-existing config entries, to apply them whenever
761 # a new config entry is added to a subsection
762 # also, non-existing config entries will be saved, so they won't be
763 # lost when a config entry disappears.
764 class Config(ConfigSubsection):
766 ConfigSubsection.__init__(self)
768 def pickle_this(self, prefix, topickle, result):
769 for (key, val) in topickle.items():
770 name = prefix + "." + key
772 if isinstance(val, dict):
773 self.pickle_this(name, val, result)
774 elif isinstance(val, tuple):
775 result.append(name + "=" + val[0]) # + " ; " + val[1])
777 result.append(name + "=" + val)
781 self.pickle_this("config", self.saved_value, result)
782 return '\n'.join(result) + "\n"
784 def unpickle(self, lines):
787 if not len(l) or l[0] == '#':
791 val = l[n+1:].strip()
793 names = l[:n].split('.')
794 # if val.find(' ') != -1:
795 # val = val[:val.find(' ')]
800 base = base.setdefault(n, {})
802 base[names[-1]] = val
804 # we inherit from ConfigSubsection, so ...
805 #object.__setattr__(self, "saved_value", tree["config"])
807 self.setSavedValue(tree["config"])
809 def saveToFile(self, filename):
810 f = open(filename, "w")
811 f.write(self.pickle())
814 def loadFromFile(self, filename):
815 f = open(filename, "r")
816 self.unpickle(f.readlines())
820 config.misc = ConfigSubsection()
823 CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
827 config.loadFromFile(self.CONFIG_FILE)
829 print "unable to load config (%s), assuming defaults..." % str(e)
833 config.saveToFile(self.CONFIG_FILE)
835 def __resolveValue(self, pickles, cmap):
836 if cmap.has_key(pickles[0]):
838 return self.__resolveValue(pickles[1:], cmap[pickles[0]].content.items)
840 return str(cmap[pickles[0]].value)
843 def getResolvedKey(self, key):
844 names = key.split('.')
846 if names[0] == "config":
847 ret=self.__resolveValue(names[1:], config.content.items)
850 print "getResolvedKey", key, "failed !! (Typo??)"
854 element.disableSave()
857 configfile = ConfigFile()
861 def getConfigListEntry(desc, config):
862 return (desc, config)
867 #config.bla = ConfigSubsection()
868 #config.bla.test = ConfigYesNo()
869 #config.nim = ConfigSubList()
870 #config.nim.append(ConfigSubsection())
871 #config.nim[0].bla = ConfigYesNo()
872 #config.nim.append(ConfigSubsection())
873 #config.nim[1].bla = ConfigYesNo()
874 #config.nim[1].blub = ConfigYesNo()
875 #config.arg = ConfigSubDict()
876 #config.arg["Hello"] = ConfigYesNo()
878 #config.arg["Hello"].handleKey(KEY_RIGHT)
879 #config.arg["Hello"].handleKey(KEY_RIGHT)
885 #print config.pickle()