2 from enigma import getPrevAsciiCode
3 from Tools.NumericalTextInput import NumericalTextInput
4 from Tools.Directories import resolveFilename, SCOPE_CONFIG
5 from Components.Harddisk import harddiskmanager
9 # ConfigElement, the base class of all ConfigElements.
12 # value the current value, usefully encoded.
13 # usually a property which retrieves _value,
14 # and maybe does some reformatting
15 # _value the value as it's going to be saved in the configfile,
16 # though still in non-string form.
17 # this is the object which is actually worked on.
18 # default the initial value. If _value is equal to default,
19 # it will not be stored in the config file
20 # saved_value is a text representation of _value, stored in the config file
22 # and has (at least) the following methods:
23 # save() stores _value into saved_value,
24 # (or stores 'None' if it should not be stored)
25 # load() loads _value from saved_value, or loads
26 # the default if saved_value is 'None' (default)
29 class ConfigElement(object):
33 self.saved_value = None
34 self.save_disabled = False
38 # you need to override this to do input validation
39 def setValue(self, value):
46 value = property(getValue, setValue)
48 # you need to override this if self.value is not a string
49 def fromstring(self, value):
52 # you can overide this for fancy default handling
54 if self.saved_value is None:
55 self.value = self.default
57 self.value = self.fromstring(self.saved_value)
59 def tostring(self, value):
62 # you need to override this if str(self.value) doesn't work
64 if self.save_disabled or self.value == self.default:
65 self.saved_value = None
67 self.saved_value = self.tostring(self.value)
73 if self.saved_value is None and self.value == self.default:
75 return self.tostring(self.value) != self.saved_value
78 for x in self.notifiers:
81 def addNotifier(self, notifier, initial_call = True):
82 assert callable(notifier), "notifiers must be callable"
83 self.notifiers.append(notifier)
86 # do we want to call the notifier
87 # - at all when adding it? (yes, though optional)
88 # - when the default is active? (yes)
89 # - when no value *yet* has been set,
90 # because no config has ever been read (currently yes)
91 # (though that's not so easy to detect.
92 # the entry could just be new.)
96 def disableSave(self):
97 self.save_disabled = True
99 def __call__(self, selected):
100 return self.getMulti(selected)
102 def onSelect(self, session):
105 def onDeselect(self, session):
118 KEY_NUMBERS = range(12, 12+10)
122 def getKeyNumber(key):
123 assert key in KEY_NUMBERS
127 # ConfigSelection is a "one of.."-type.
128 # it has the "choices", usually a list, which contains
129 # (id, desc)-tuples (or just only the ids, in case the id
130 # will be used as description)
132 # all ids MUST be plain strings.
134 class ConfigSelection(ConfigElement):
135 def __init__(self, choices, default = None):
136 ConfigElement.__init__(self)
138 self.setChoices(choices, default)
140 def setChoices(self, choices, default = None):
142 self.description = {}
144 if isinstance(choices, list):
146 if isinstance(x, tuple):
147 self.choices.append(x[0])
148 self.description[x[0]] = x[1]
150 self.choices.append(x)
151 self.description[x] = x
152 elif isinstance(choices, dict):
153 for (key, val) in choices.items():
154 self.choices.append(key)
155 self.description[key] = val
157 assert False, "ConfigSelection choices must be dict or list!"
159 #assert len(self.choices), "you can't have an empty configselection"
160 if len(self.choices) == 0:
162 self.description[""] = ""
165 default = self.choices[0]
167 assert default in self.choices, "default must be in choice list, but " + repr(default) + " is not!"
168 for x in self.choices:
169 assert isinstance(x, str), "ConfigSelection choices must be strings"
171 self.default = default
173 if self.value == None or not self.value in self.choices:
176 def setValue(self, value):
177 if value in self.choices:
180 self._value = self.default
184 def tostring(self, val):
190 def setCurrentText(self, text):
191 i = self.choices.index(self.value)
192 del self.description[self.choices[i]]
193 self.choices[i] = text
194 self.description[text] = text
197 value = property(getValue, setValue)
200 return self.choices.index(self.value)
202 index = property(getIndex)
205 def handleKey(self, key):
206 nchoices = len(self.choices)
207 i = self.choices.index(self.value)
209 self.value = self.choices[(i + nchoices - 1) % nchoices]
210 elif key == KEY_RIGHT:
211 self.value = self.choices[(i + 1) % nchoices]
212 elif key == KEY_HOME:
213 self.value = self.choices[0]
215 self.value = self.choices[nchoices - 1]
217 def selectNext(self):
218 nchoices = len(self.choices)
219 i = self.choices.index(self.value)
220 self.value = self.choices[(i + 1) % nchoices]
223 descr = self.description[self.value]
228 def getMulti(self, selected):
229 descr = self.description[self.value]
231 return ("text", _(descr))
232 return ("text", descr)
235 def getHTML(self, id):
237 for v in self.choices:
239 checked = 'checked="checked" '
242 res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + self.description[v] + "</input></br>\n"
245 def unsafeAssign(self, value):
246 # setValue does check if value is in choices. This is safe enough.
251 # several customized versions exist for different
254 class ConfigBoolean(ConfigElement):
255 def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
256 ConfigElement.__init__(self)
257 self.descriptions = descriptions
258 self.value = self.default = default
259 def handleKey(self, key):
260 if key in [KEY_LEFT, KEY_RIGHT]:
261 self.value = not self.value
262 elif key == KEY_HOME:
268 descr = self.descriptions[self.value]
273 def getMulti(self, selected):
274 descr = self.descriptions[self.value]
276 return ("text", _(descr))
277 return ("text", descr)
279 def tostring(self, value):
285 def fromstring(self, val):
291 def getHTML(self, id):
293 checked = ' checked="checked"'
296 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
298 # this is FLAWED. and must be fixed.
299 def unsafeAssign(self, value):
305 class ConfigYesNo(ConfigBoolean):
306 def __init__(self, default = False):
307 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
309 class ConfigOnOff(ConfigBoolean):
310 def __init__(self, default = False):
311 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
313 class ConfigEnableDisable(ConfigBoolean):
314 def __init__(self, default = False):
315 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
317 class ConfigDateTime(ConfigElement):
318 def __init__(self, default, formatstring, increment = 86400):
319 ConfigElement.__init__(self)
320 self.increment = increment
321 self.formatstring = formatstring
322 self.value = self.default = int(default)
324 def handleKey(self, key):
326 self.value = self.value - self.increment
327 elif key == KEY_RIGHT:
328 self.value = self.value + self.increment
329 elif key == KEY_HOME or key == KEY_END:
330 self.value = self.default
333 return time.strftime(self.formatstring, time.localtime(self.value))
335 def getMulti(self, selected):
336 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
338 def fromstring(self, val):
341 # *THE* mighty config element class
343 # allows you to store/edit a sequence of values.
344 # can be used for IP-addresses, dates, plain integers, ...
345 # several helper exist to ease this up a bit.
347 class ConfigSequence(ConfigElement):
348 def __init__(self, seperator, limits, censor_char = "", default = None):
349 ConfigElement.__init__(self)
350 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
351 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
352 #assert isinstance(default, list), "default must be a list"
353 #assert isinstance(default[0], int), "list must contain numbers"
354 #assert len(default) == len(limits), "length must match"
357 self.seperator = seperator
359 self.censor_char = censor_char
361 self.default = default
362 self.value = copy.copy(default)
364 self.endNotifier = []
369 for i in self._value:
370 max_pos += len(str(self.limits[num][1]))
372 if self._value[num] < self.limits[num][0]:
373 self._value[num] = self.limits[num][0]
375 if self._value[num] > self.limits[num][1]:
376 self._value[num] = self.limits[num][1]
380 if self.marked_pos >= max_pos:
381 for x in self.endNotifier:
383 self.marked_pos = max_pos - 1
385 if self.marked_pos < 0:
388 def validatePos(self):
389 if self.marked_pos < 0:
392 total_len = sum([len(str(x[1])) for x in self.limits])
394 if self.marked_pos >= total_len:
395 self.marked_pos = total_len - 1
397 def addEndNotifier(self, notifier):
398 self.endNotifier.append(notifier)
400 def handleKey(self, key):
416 for i in self._value:
417 max_pos += len(str(self.limits[num][1]))
419 self.marked_pos = max_pos - 1
422 if key in KEY_NUMBERS or key == KEY_ASCII:
424 code = getPrevAsciiCode()
425 if code < 48 or code > 57:
429 number = getKeyNumber(key)
432 for x in self.limits:
433 block_len.append(len(str(x[1])))
435 total_len = sum(block_len)
439 block_len_total = [0, ]
441 pos += block_len[blocknumber]
442 block_len_total.append(pos)
443 if pos - 1 >= self.marked_pos:
448 # length of numberblock
449 number_len = len(str(self.limits[blocknumber][1]))
451 # position in the block
452 posinblock = self.marked_pos - block_len_total[blocknumber]
454 oldvalue = self._value[blocknumber]
455 olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
456 newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
458 self._value[blocknumber] = newvalue
466 mPos = self.marked_pos
468 for i in self._value:
469 if len(value): #fixme no heading separator possible
470 value += self.seperator
471 if mPos >= len(value) - 1:
474 if self.censor_char == "":
475 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
477 value += (self.censor_char * len(str(self.limits[num][1])))
482 (value, mPos) = self.genText()
485 def getMulti(self, selected):
486 (value, mPos) = self.genText()
487 # only mark cursor when we are selected
488 # (this code is heavily ink optimized!)
490 return ("mtext"[1-selected:], value, [mPos])
492 return ("text", value)
494 def tostring(self, val):
495 return self.seperator.join([self.saveSingle(x) for x in val])
497 def saveSingle(self, v):
500 def fromstring(self, value):
501 return [int(x) for x in value.split(self.seperator)]
503 class ConfigIP(ConfigSequence):
504 def __init__(self, default):
505 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
507 def getHTML(self, id):
508 # we definitely don't want leading zeros
509 return '.'.join(["%d" % d for d in self.value])
511 class ConfigMAC(ConfigSequence):
512 def __init__(self, default):
513 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
515 class ConfigPosition(ConfigSequence):
516 def __init__(self, default, args):
517 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
519 class ConfigClock(ConfigSequence):
520 def __init__(self, default):
522 t = time.localtime(default)
523 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
525 class ConfigInteger(ConfigSequence):
526 def __init__(self, default, limits = (0, 9999999999)):
527 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
529 # you need to override this to do input validation
530 def setValue(self, value):
531 self._value = [value]
535 return self._value[0]
537 value = property(getValue, setValue)
539 def fromstring(self, value):
542 def tostring(self, value):
545 class ConfigPIN(ConfigInteger):
546 def __init__(self, default, len = 4, censor = ""):
547 assert isinstance(default, int), "ConfigPIN default must be an integer"
550 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
556 class ConfigFloat(ConfigSequence):
557 def __init__(self, default, limits):
558 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
561 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
563 float = property(getFloat)
565 # an editable text...
566 class ConfigText(ConfigElement, NumericalTextInput):
567 def __init__(self, default = "", fixed_size = True, visible_width = False):
568 ConfigElement.__init__(self)
569 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
572 self.allmarked = (default != "")
573 self.fixed_size = fixed_size
574 self.visible_width = visible_width
576 self.overwrite = fixed_size
577 self.help_window = None
578 self.value = self.default = default
580 def validateMarker(self):
582 if self.marked_pos > len(self.text)-1:
583 self.marked_pos = len(self.text)-1
585 if self.marked_pos > len(self.text):
586 self.marked_pos = len(self.text)
587 if self.marked_pos < 0:
589 if self.visible_width:
590 if self.marked_pos < self.offset:
591 self.offset = self.marked_pos
592 if self.marked_pos >= self.offset + self.visible_width:
593 if self.marked_pos == len(self.text):
594 self.offset = self.marked_pos - self.visible_width
596 self.offset = self.marked_pos - self.visible_width + 1
597 if self.offset > 0 and self.offset + self.visible_width > len(self.text):
598 self.offset = max(0, len(self.text) - self.visible_width)
600 def insertChar(self, ch, pos, owr):
601 if owr or self.overwrite:
602 self.text = self.text[0:pos] + ch + self.text[pos + 1:]
603 elif self.fixed_size:
604 self.text = self.text[0:pos] + ch + self.text[pos:-1]
606 self.text = self.text[0:pos] + ch + self.text[pos:]
608 def deleteChar(self, pos):
609 if not self.fixed_size:
610 self.text = self.text[0:pos] + self.text[pos + 1:]
612 self.text = self.text[0:pos] + " " + self.text[pos + 1:]
614 self.text = self.text[0:pos] + self.text[pos + 1:] + " "
616 def deleteAllChars(self):
618 self.text = " " * len(self.text)
623 def handleKey(self, key):
624 # this will no change anything on the value itself
625 # so we can handle it here in gui element
626 if key == KEY_DELETE:
629 self.deleteAllChars()
630 self.allmarked = False
632 self.deleteChar(self.marked_pos)
633 if self.fixed_size and self.overwrite:
635 elif key == KEY_BACKSPACE:
638 self.deleteAllChars()
639 self.allmarked = False
640 elif self.marked_pos > 0:
641 self.deleteChar(self.marked_pos-1)
642 if not self.fixed_size and self.offset > 0:
645 elif key == KEY_LEFT:
648 self.marked_pos = len(self.text)
649 self.allmarked = False
652 elif key == KEY_RIGHT:
656 self.allmarked = False
659 elif key == KEY_HOME:
661 self.allmarked = False
665 self.allmarked = False
666 self.marked_pos = len(self.text)
667 elif key == KEY_TOGGLEOW:
669 self.overwrite = not self.overwrite
670 elif key == KEY_ASCII:
672 newChar = unichr(getPrevAsciiCode())
674 self.deleteAllChars()
675 self.allmarked = False
676 self.insertChar(newChar, self.marked_pos, False)
678 elif key in KEY_NUMBERS:
679 owr = self.lastKey == getKeyNumber(key)
680 newChar = self.getKey(getKeyNumber(key))
682 self.deleteAllChars()
683 self.allmarked = False
684 self.insertChar(newChar, self.marked_pos, owr)
685 elif key == KEY_TIMEOUT:
688 self.help_window.update(self)
692 self.help_window.update(self)
693 self.validateMarker()
698 self.validateMarker()
702 return self.text.encode("utf-8")
704 def setValue(self, val):
706 self.text = val.decode("utf-8")
707 except UnicodeDecodeError:
711 value = property(getValue, setValue)
712 _value = property(getValue, setValue)
715 return self.text.encode("utf-8")
717 def getMulti(self, selected):
718 if self.visible_width:
720 mark = range(0, min(self.visible_width, len(self.text)))
722 mark = [self.marked_pos-self.offset]
723 return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
726 mark = range(0, len(self.text))
728 mark = [self.marked_pos]
729 return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
731 def onSelect(self, session):
732 self.allmarked = (self.value != "")
733 if session is not None:
734 from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
735 self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
736 self.help_window.show()
738 def onDeselect(self, session):
742 session.deleteDialog(self.help_window)
743 self.help_window = None
745 def getHTML(self, id):
746 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
748 def unsafeAssign(self, value):
749 self.value = str(value)
751 class ConfigNumber(ConfigText):
752 def __init__(self, default = 0):
753 ConfigText.__init__(self, str(default), fixed_size = False)
756 return int(self.text)
758 def setValue(self, val):
761 value = property(getValue, setValue)
762 _value = property(getValue, setValue)
765 pos = len(self.text) - self.marked_pos
766 self.text = self.text.lstrip("0")
769 if pos > len(self.text):
772 self.marked_pos = len(self.text) - pos
774 def handleKey(self, key):
775 if key in KEY_NUMBERS or key == KEY_ASCII:
777 ascii = getPrevAsciiCode()
778 if not (48 <= ascii <= 57):
781 ascii = getKeyNumber(key) + 48
782 newChar = unichr(ascii)
784 self.deleteAllChars()
785 self.allmarked = False
786 self.insertChar(newChar, self.marked_pos, False)
789 ConfigText.handleKey(self, key)
792 def onSelect(self, session):
793 self.allmarked = (self.value != "")
795 def onDeselect(self, session):
800 class ConfigSlider(ConfigElement):
801 def __init__(self, default = 0, increment = 1, limits = (0, 100)):
802 ConfigElement.__init__(self)
803 self.value = self.default = default
806 self.increment = increment
808 def checkValues(self):
809 if self.value < self.min:
810 self.value = self.min
812 if self.value > self.max:
813 self.value = self.max
815 def handleKey(self, key):
817 self.value -= self.increment
818 elif key == KEY_RIGHT:
819 self.value += self.increment
820 elif key == KEY_HOME:
821 self.value = self.min
823 self.value = self.max
831 return "%d / %d" % (self.value, self.max)
833 def getMulti(self, selected):
835 return ("slider", self.value, self.max)
837 def fromstring(self, value):
840 # a satlist. in fact, it's a ConfigSelection.
841 class ConfigSatlist(ConfigSelection):
842 def __init__(self, list, default = None):
843 if default is not None:
844 default = str(default)
845 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
847 def getOrbitalPosition(self):
850 return int(self.value)
852 orbital_position = property(getOrbitalPosition)
854 class ConfigSet(ConfigElement):
855 def __init__(self, choices, default = []):
856 ConfigElement.__init__(self)
858 self.description = {}
859 if isinstance(choices, list):
862 if isinstance(x, tuple):
863 self.choices.append(x[0])
864 self.description[x[0]] = str(x[1])
866 self.choices.append(x)
867 self.description[x] = str(x)
869 assert False, "ConfigSet choices must be a list!"
870 if len(self.choices) == 0:
872 self.description[""] = ""
877 self.default = default
878 self.value = default+[]
880 def toggleChoice(self, choice):
881 if choice in self.value:
882 self.value.remove(choice)
884 self.value.append(choice)
887 def handleKey(self, key):
888 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
890 self.toggleChoice(self.choices[self.pos])
891 elif key == KEY_LEFT:
894 self.pos = len(self.choices)-1
895 elif key == KEY_RIGHT:
897 if self.pos >= len(self.choices):
899 elif key in [KEY_HOME, KEY_END]:
902 def genString(self, lst):
905 res += self.description[x]+" "
909 return self.genString(self.value)
911 def getMulti(self, selected):
912 if not selected or self.pos == -1:
913 return ("text", self.genString(self.value))
916 ch = self.choices[self.pos]
917 mem = ch in self.value
922 val1 = self.genString(tmp[:ind])
923 val2 = " "+self.genString(tmp[ind+1:])
925 chstr = " "+self.description[ch]+" "
927 chstr = "("+self.description[ch]+")"
928 return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
930 def onDeselect(self, session):
934 def tostring(self, value):
937 def fromstring(self, val):
940 class ConfigLocations(ConfigElement):
941 def __init__(self, default = [], visible_width = False):
942 ConfigElement.__init__(self)
943 self.visible_width = visible_width
945 self.default = default
947 self.mountpoints = []
948 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
950 def setValue(self, value):
951 loc = [x[0] for x in self.locations if x[3]]
952 add = [x for x in value if not x in loc]
953 diff = add + [x for x in loc if not x in value]
954 self.locations = [x for x in self.locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
955 self.locations.sort(key = lambda x: x[0])
959 self.checkChangedMountpoints()
960 for x in self.locations:
962 return [x[0] for x in self.locations if x[3]]
964 value = property(getValue, setValue)
966 def tostring(self, value):
969 def fromstring(self, val):
973 if self.saved_value is None:
976 tmp = self.fromstring(self.saved_value)
977 self.locations = [[x, None, False, False] for x in tmp]
978 self.refreshMountpoints()
979 for x in self.locations:
980 if os.path.exists(x[0]):
981 x[1] = self.getMountpoint(x[0])
985 if self.save_disabled or self.locations == []:
986 self.saved_value = None
988 self.saved_value = self.tostring([x[0] for x in self.locations])
991 if self.saved_value is None and self.locations == []:
993 return self.tostring([x[0] for x in self.locations]) != self.saved_value
995 def mountpointsChanged(self, action, dev):
996 print "Mounts changed: ", action, dev
997 mp = dev.mountpoint+"/"
1000 elif action == "remove":
1001 self.removedMount(mp)
1002 self.refreshMountpoints()
1004 def addedMount(self, mp):
1005 for x in self.locations:
1008 elif x[1] == None and os.path.exists(x[0]):
1009 x[1] = self.getMountpoint(x[0])
1012 def removedMount(self, mp):
1013 for x in self.locations:
1017 def refreshMountpoints(self):
1018 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1019 self.mountpoints.sort(key = lambda x: -len(x))
1021 def checkChangedMountpoints(self):
1022 oldmounts = self.mountpoints
1023 self.refreshMountpoints()
1024 if oldmounts == self.mountpoints:
1027 if not x in self.mountpoints:
1028 self.removedMount(x)
1029 for x in self.mountpoints:
1030 if not x in oldmounts:
1033 def getMountpoint(self, file):
1034 file = os.path.realpath(file)+"/"
1035 for m in self.mountpoints:
1036 if file.startswith(m):
1040 def handleKey(self, key):
1044 self.pos = len(self.value)-1
1045 elif key == KEY_RIGHT:
1047 if self.pos >= len(self.value):
1049 elif key in [KEY_HOME, KEY_END]:
1053 return " ".join(self.value)
1055 def getMulti(self, selected):
1057 valstr = " ".join(self.value)
1058 if self.visible_width and len(valstr) > self.visible_width:
1059 return ("text", valstr[0:self.visible_width])
1061 return ("text", valstr)
1067 for val in self.value:
1070 valstr += str(val)+" "
1074 if self.visible_width and len(valstr) > self.visible_width:
1075 if ind1+1 < self.visible_width/2:
1078 off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1079 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1081 return ("mtext", valstr, range(ind1,ind2))
1083 def onDeselect(self, session):
1087 class ConfigNothing(ConfigSelection):
1089 ConfigSelection.__init__(self, choices = [""])
1091 # until here, 'saved_value' always had to be a *string*.
1092 # now, in ConfigSubsection, and only there, saved_value
1093 # is a dict, essentially forming a tree.
1095 # config.foo.bar=True
1096 # config.foobar=False
1099 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1103 class ConfigSubsectionContent(object):
1106 # we store a backup of the loaded configuration
1107 # data in self.stored_values, to be able to deploy
1108 # them when a new config element will be added,
1109 # so non-default values are instantly available
1111 # A list, for example:
1112 # config.dipswitches = ConfigSubList()
1113 # config.dipswitches.append(ConfigYesNo())
1114 # config.dipswitches.append(ConfigYesNo())
1115 # config.dipswitches.append(ConfigYesNo())
1116 class ConfigSubList(list, object):
1118 object.__init__(self)
1120 self.stored_values = {}
1130 def getSavedValue(self):
1132 for i in range(len(self)):
1133 sv = self[i].saved_value
1138 def setSavedValue(self, values):
1139 self.stored_values = dict(values)
1140 for (key, val) in self.stored_values.items():
1141 if int(key) < len(self):
1142 self[int(key)].saved_value = val
1144 saved_value = property(getSavedValue, setSavedValue)
1146 def append(self, item):
1148 list.append(self, item)
1149 if i in self.stored_values:
1150 item.saved_value = self.stored_values[i]
1155 for index in range(len(self)):
1156 res[str(index)] = self[index]
1159 # same as ConfigSubList, just as a dictionary.
1160 # care must be taken that the 'key' has a proper
1161 # str() method, because it will be used in the config
1163 class ConfigSubDict(dict, object):
1165 object.__init__(self)
1167 self.stored_values = {}
1170 for x in self.values():
1174 for x in self.values():
1177 def getSavedValue(self):
1179 for (key, val) in self.items():
1180 if val.saved_value is not None:
1181 res[str(key)] = val.saved_value
1184 def setSavedValue(self, values):
1185 self.stored_values = dict(values)
1186 for (key, val) in self.items():
1187 if str(key) in self.stored_values:
1188 val = self.stored_values[str(key)]
1190 saved_value = property(getSavedValue, setSavedValue)
1192 def __setitem__(self, key, item):
1193 dict.__setitem__(self, key, item)
1194 if str(key) in self.stored_values:
1195 item.saved_value = self.stored_values[str(key)]
1201 # Like the classes above, just with a more "native"
1204 # some evil stuff must be done to allow instant
1205 # loading of added elements. this is why this class
1208 # we need the 'content' because we overwrite
1210 # If you don't understand this, try adding
1211 # __setattr__ to a usual exisiting class and you will.
1212 class ConfigSubsection(object):
1214 object.__init__(self)
1215 self.__dict__["content"] = ConfigSubsectionContent()
1216 self.content.items = { }
1217 self.content.stored_values = { }
1219 def __setattr__(self, name, value):
1220 if name == "saved_value":
1221 return self.setSavedValue(value)
1222 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"
1223 self.content.items[name] = value
1224 if name in self.content.stored_values:
1225 #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
1226 value.saved_value = self.content.stored_values[name]
1229 def __getattr__(self, name):
1230 return self.content.items[name]
1232 def getSavedValue(self):
1233 res = self.content.stored_values
1234 for (key, val) in self.content.items.items():
1235 if val.saved_value is not None:
1236 res[key] = val.saved_value
1242 def setSavedValue(self, values):
1243 values = dict(values)
1245 self.content.stored_values = values
1247 for (key, val) in self.content.items.items():
1249 val.saved_value = values[key]
1251 saved_value = property(getSavedValue, setSavedValue)
1254 for x in self.content.items.values():
1258 for x in self.content.items.values():
1262 return self.content.items
1264 # the root config object, which also can "pickle" (=serialize)
1265 # down the whole config tree.
1267 # we try to keep non-existing config entries, to apply them whenever
1268 # a new config entry is added to a subsection
1269 # also, non-existing config entries will be saved, so they won't be
1270 # lost when a config entry disappears.
1271 class Config(ConfigSubsection):
1273 ConfigSubsection.__init__(self)
1275 def pickle_this(self, prefix, topickle, result):
1276 for (key, val) in topickle.items():
1277 name = prefix + "." + key
1279 if isinstance(val, dict):
1280 self.pickle_this(name, val, result)
1281 elif isinstance(val, tuple):
1282 result.append(name + "=" + val[0]) # + " ; " + val[1])
1284 result.append(name + "=" + val)
1288 self.pickle_this("config", self.saved_value, result)
1289 return '\n'.join(result) + "\n"
1291 def unpickle(self, lines):
1294 if not len(l) or l[0] == '#':
1298 val = l[n+1:].strip()
1300 names = l[:n].split('.')
1301 # if val.find(' ') != -1:
1302 # val = val[:val.find(' ')]
1306 for n in names[:-1]:
1307 base = base.setdefault(n, {})
1309 base[names[-1]] = val
1311 # we inherit from ConfigSubsection, so ...
1312 #object.__setattr__(self, "saved_value", tree["config"])
1313 if "config" in tree:
1314 self.setSavedValue(tree["config"])
1316 def saveToFile(self, filename):
1317 f = open(filename, "w")
1318 f.write(self.pickle())
1321 def loadFromFile(self, filename):
1322 f = open(filename, "r")
1323 self.unpickle(f.readlines())
1327 config.misc = ConfigSubsection()
1330 CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1334 config.loadFromFile(self.CONFIG_FILE)
1336 print "unable to load config (%s), assuming defaults..." % str(e)
1340 config.saveToFile(self.CONFIG_FILE)
1342 def __resolveValue(self, pickles, cmap):
1343 if cmap.has_key(pickles[0]):
1344 if len(pickles) > 1:
1345 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1347 return str(cmap[pickles[0]].value)
1350 def getResolvedKey(self, key):
1351 names = key.split('.')
1353 if names[0] == "config":
1354 ret=self.__resolveValue(names[1:], config.content.items)
1355 if ret and len(ret):
1357 print "getResolvedKey", key, "failed !! (Typo??)"
1360 def NoSave(element):
1361 element.disableSave()
1364 configfile = ConfigFile()
1368 def getConfigListEntry(*args):
1369 assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1372 def updateConfigElement(element, newelement):
1373 newelement.value = element.value
1379 #config.bla = ConfigSubsection()
1380 #config.bla.test = ConfigYesNo()
1381 #config.nim = ConfigSubList()
1382 #config.nim.append(ConfigSubsection())
1383 #config.nim[0].bla = ConfigYesNo()
1384 #config.nim.append(ConfigSubsection())
1385 #config.nim[1].bla = ConfigYesNo()
1386 #config.nim[1].blub = ConfigYesNo()
1387 #config.arg = ConfigSubDict()
1388 #config.arg["Hello"] = ConfigYesNo()
1390 #config.arg["Hello"].handleKey(KEY_RIGHT)
1391 #config.arg["Hello"].handleKey(KEY_RIGHT)
1393 ##config.saved_value
1397 #print config.pickle()