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):
32 self.saved_value = None
33 self.last_value = None
34 self.save_disabled = False
36 self.notifiers_final = []
38 self.callNotifiersOnSaveAndCancel = False
40 # you need to override this to do input validation
41 def setValue(self, value):
48 value = property(getValue, setValue)
50 # you need to override this if self.value is not a string
51 def fromstring(self, value):
54 # you can overide this for fancy default handling
58 self.value = self.default
60 self.value = self.fromstring(sv)
62 def tostring(self, value):
65 # you need to override this if str(self.value) doesn't work
67 if self.save_disabled or self.value == self.default:
68 self.saved_value = None
70 self.saved_value = self.tostring(self.value)
71 if self.callNotifiersOnSaveAndCancel:
76 if self.callNotifiersOnSaveAndCancel:
81 if sv is None and self.value == self.default:
83 return self.tostring(self.value) != sv
86 for x in self.notifiers:
89 def changedFinal(self):
90 for x in self.notifiers_final:
93 def addNotifier(self, notifier, initial_call = True, immediate_feedback = True):
94 assert callable(notifier), "notifiers must be callable"
95 if immediate_feedback:
96 self.notifiers.append(notifier)
98 self.notifiers_final.append(notifier)
100 # do we want to call the notifier
101 # - at all when adding it? (yes, though optional)
102 # - when the default is active? (yes)
103 # - when no value *yet* has been set,
104 # because no config has ever been read (currently yes)
105 # (though that's not so easy to detect.
106 # the entry could just be new.)
110 def disableSave(self):
111 self.save_disabled = True
113 def __call__(self, selected):
114 return self.getMulti(selected)
116 def onSelect(self, session):
119 def onDeselect(self, session):
120 if not self.last_value == self.value:
122 self.last_value = self.value
134 KEY_NUMBERS = range(12, 12+10)
138 def getKeyNumber(key):
139 assert key in KEY_NUMBERS
142 class choicesList(object): # XXX: we might want a better name for this
146 def __init__(self, choices, type = None):
147 object.__init__(self)
148 self.choices = choices
150 if isinstance(choices, list):
151 self.type = choicesList.LIST_TYPE_LIST
152 elif isinstance(choices, dict):
153 self.type = choicesList.LIST_TYPE_DICT
155 assert False, "choices must be dict or list!"
160 if self.type == choicesList.LIST_TYPE_LIST:
161 ret = [isinstance(x, tuple) and x[0] or x for x in self.choices]
163 ret = self.choices.keys()
167 if self.type == choicesList.LIST_TYPE_LIST:
168 ret = [isinstance(x, tuple) and x[0] or x for x in self.choices]
171 return iter(ret or [""])
174 return len(self.choices) or 1
176 def __getitem__(self, index):
177 if self.type == choicesList.LIST_TYPE_LIST:
178 ret = self.choices[index]
179 if isinstance(ret, tuple):
182 return self.choices.keys()[index]
184 def index(self, value):
185 return self.__list__().index(value)
187 def __setitem__(self, index, value):
188 if self.type == choicesList.LIST_TYPE_LIST:
189 orig = self.choices[index]
190 if isinstance(orig, tuple):
191 self.choices[index] = (value, orig[1])
193 self.choices[index] = value
195 key = self.choices.keys()[index]
196 orig = self.choices[key]
197 del self.choices[key]
198 self.choices[value] = orig
201 if self.type is choicesList.LIST_TYPE_LIST:
202 default = self.choices[0]
203 if isinstance(default, tuple):
206 default = self.choices.keys()[0]
209 class descriptionList(choicesList): # XXX: we might want a better name for this
211 if self.type == choicesList.LIST_TYPE_LIST:
212 ret = [isinstance(x, tuple) and x[1] or x for x in self.choices]
214 ret = self.choices.values()
218 return iter(self.__list__())
220 def __getitem__(self, index):
221 if self.type == choicesList.LIST_TYPE_LIST:
222 for x in self.choices:
223 if isinstance(x, tuple):
228 return str(index) # Fallback!
230 return str(self.choices.get(index, ""))
232 def __setitem__(self, index, value):
233 if self.type == choicesList.LIST_TYPE_LIST:
234 i = self.index(index)
235 orig = self.choices[i]
236 if isinstance(orig, tuple):
237 self.choices[i] = (orig[0], value)
239 self.choices[i] = value
241 self.choices[index] = value
244 # ConfigSelection is a "one of.."-type.
245 # it has the "choices", usually a list, which contains
246 # (id, desc)-tuples (or just only the ids, in case the id
247 # will be used as description)
249 # all ids MUST be plain strings.
251 class ConfigSelection(ConfigElement):
252 def __init__(self, choices, default = None):
253 ConfigElement.__init__(self)
254 self.choices = choicesList(choices)
257 default = self.choices.default()
259 self.default = self._value = self.last_value = default
262 def setChoices(self, choices, default = None):
263 self.choices = choicesList(choices)
266 default = self.choices.default()
268 if self.value not in self.choices:
271 def setValue(self, value):
272 if value in self.choices:
275 self._value = self.default
278 def tostring(self, val):
284 def setCurrentText(self, text):
285 i = self.choices.index(self.value)
286 self.choices[i] = text
287 self.description[text] = text
290 value = property(getValue, setValue)
293 return self.choices.index(self.value)
295 index = property(getIndex)
298 def handleKey(self, key):
299 nchoices = len(self.choices)
300 i = self.choices.index(self.value)
302 self.value = self.choices[(i + nchoices - 1) % nchoices]
303 elif key == KEY_RIGHT:
304 self.value = self.choices[(i + 1) % nchoices]
305 elif key == KEY_HOME:
306 self.value = self.choices[0]
308 self.value = self.choices[nchoices - 1]
310 def selectNext(self):
311 nchoices = len(self.choices)
312 i = self.choices.index(self.value)
313 self.value = self.choices[(i + 1) % nchoices]
316 descr = self.description[self.value]
321 def getMulti(self, selected):
322 descr = self.description[self.value]
324 return ("text", _(descr))
325 return ("text", descr)
328 def getHTML(self, id):
330 for v in self.choices:
331 descr = self.description[v]
333 checked = 'checked="checked" '
336 res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + descr + "</input></br>\n"
339 def unsafeAssign(self, value):
340 # setValue does check if value is in choices. This is safe enough.
343 description = property(lambda self: descriptionList(self.choices.choices, self.choices.type))
347 # several customized versions exist for different
350 class ConfigBoolean(ConfigElement):
351 def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
352 ConfigElement.__init__(self)
353 self.descriptions = descriptions
354 self.value = self.last_value = self.default = default
356 def handleKey(self, key):
357 if key in [KEY_LEFT, KEY_RIGHT]:
358 self.value = not self.value
359 elif key == KEY_HOME:
365 descr = self.descriptions[self.value]
370 def getMulti(self, selected):
371 descr = self.descriptions[self.value]
373 return ("text", _(descr))
374 return ("text", descr)
376 def tostring(self, value):
382 def fromstring(self, val):
388 def getHTML(self, id):
390 checked = ' checked="checked"'
393 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
395 # this is FLAWED. and must be fixed.
396 def unsafeAssign(self, value):
402 def onDeselect(self, session):
403 if not self.last_value == self.value:
405 self.last_value = self.value
407 class ConfigYesNo(ConfigBoolean):
408 def __init__(self, default = False):
409 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
411 class ConfigOnOff(ConfigBoolean):
412 def __init__(self, default = False):
413 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
415 class ConfigEnableDisable(ConfigBoolean):
416 def __init__(self, default = False):
417 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
419 class ConfigDateTime(ConfigElement):
420 def __init__(self, default, formatstring, increment = 86400):
421 ConfigElement.__init__(self)
422 self.increment = increment
423 self.formatstring = formatstring
424 self.value = self.last_value = self.default = int(default)
426 def handleKey(self, key):
428 self.value = self.value - self.increment
429 elif key == KEY_RIGHT:
430 self.value = self.value + self.increment
431 elif key == KEY_HOME or key == KEY_END:
432 self.value = self.default
435 return time.strftime(self.formatstring, time.localtime(self.value))
437 def getMulti(self, selected):
438 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
440 def fromstring(self, val):
443 # *THE* mighty config element class
445 # allows you to store/edit a sequence of values.
446 # can be used for IP-addresses, dates, plain integers, ...
447 # several helper exist to ease this up a bit.
449 class ConfigSequence(ConfigElement):
450 def __init__(self, seperator, limits, censor_char = "", default = None):
451 ConfigElement.__init__(self)
452 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
453 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
454 #assert isinstance(default, list), "default must be a list"
455 #assert isinstance(default[0], int), "list must contain numbers"
456 #assert len(default) == len(limits), "length must match"
459 self.seperator = seperator
461 self.censor_char = censor_char
463 self.default = default
464 self.value = copy.copy(default)
465 self.last_value = copy.copy(default)
467 self.endNotifier = []
472 for i in self._value:
473 max_pos += len(str(self.limits[num][1]))
475 if self._value[num] < self.limits[num][0]:
476 self._value[num] = self.limits[num][0]
478 if self._value[num] > self.limits[num][1]:
479 self._value[num] = self.limits[num][1]
483 if self.marked_pos >= max_pos:
484 for x in self.endNotifier:
486 self.marked_pos = max_pos - 1
488 if self.marked_pos < 0:
491 def validatePos(self):
492 if self.marked_pos < 0:
495 total_len = sum([len(str(x[1])) for x in self.limits])
497 if self.marked_pos >= total_len:
498 self.marked_pos = total_len - 1
500 def addEndNotifier(self, notifier):
501 self.endNotifier.append(notifier)
503 def handleKey(self, key):
519 for i in self._value:
520 max_pos += len(str(self.limits[num][1]))
522 self.marked_pos = max_pos - 1
525 if key in KEY_NUMBERS or key == KEY_ASCII:
527 code = getPrevAsciiCode()
528 if code < 48 or code > 57:
532 number = getKeyNumber(key)
535 for x in self.limits:
536 block_len.append(len(str(x[1])))
538 total_len = sum(block_len)
542 block_len_total = [0, ]
544 pos += block_len[blocknumber]
545 block_len_total.append(pos)
546 if pos - 1 >= self.marked_pos:
551 # length of numberblock
552 number_len = len(str(self.limits[blocknumber][1]))
554 # position in the block
555 posinblock = self.marked_pos - block_len_total[blocknumber]
557 oldvalue = self._value[blocknumber]
558 olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
559 newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
561 self._value[blocknumber] = newvalue
569 mPos = self.marked_pos
571 for i in self._value:
572 if len(value): #fixme no heading separator possible
573 value += self.seperator
574 if mPos >= len(value) - 1:
577 if self.censor_char == "":
578 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
580 value += (self.censor_char * len(str(self.limits[num][1])))
585 (value, mPos) = self.genText()
588 def getMulti(self, selected):
589 (value, mPos) = self.genText()
590 # only mark cursor when we are selected
591 # (this code is heavily ink optimized!)
593 return ("mtext"[1-selected:], value, [mPos])
595 return ("text", value)
597 def tostring(self, val):
598 return self.seperator.join([self.saveSingle(x) for x in val])
600 def saveSingle(self, v):
603 def fromstring(self, value):
604 return [int(x) for x in value.split(self.seperator)]
606 def onDeselect(self, session):
607 if not self.last_value == self._value:
609 self.last_value = copy.copy(self._value)
611 class ConfigIP(ConfigSequence):
612 def __init__(self, default, auto_jump = False):
613 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
615 for x in self.limits:
616 self.block_len.append(len(str(x[1])))
617 self.marked_block = 0
618 self.overwrite = True
619 self.auto_jump = auto_jump
621 def handleKey(self, key):
624 if self.marked_block > 0:
625 self.marked_block -= 1
626 self.overwrite = True
629 if self.marked_block < len(self.limits)-1:
630 self.marked_block += 1
631 self.overwrite = True
634 self.marked_block = 0
635 self.overwrite = True
638 self.marked_block = len(self.limits)-1
639 self.overwrite = True
641 if key in KEY_NUMBERS or key == KEY_ASCII:
643 code = getPrevAsciiCode()
644 if code < 48 or code > 57:
648 number = getKeyNumber(key)
649 oldvalue = self._value[self.marked_block]
652 self._value[self.marked_block] = number
653 self.overwrite = False
656 newvalue = oldvalue + number
657 if self.auto_jump and newvalue > self.limits[self.marked_block][1] and self.marked_block < len(self.limits)-1:
658 self.handleKey(KEY_RIGHT)
662 self._value[self.marked_block] = newvalue
664 if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
665 self.handleKey(KEY_RIGHT)
673 for i in self._value:
674 block_strlen.append(len(str(i)))
676 value += self.seperator
678 leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
679 rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
680 mBlock = range(leftPos, rightPos)
681 return (value, mBlock)
683 def getMulti(self, selected):
684 (value, mBlock) = self.genText()
686 return ("mtext"[1-selected:], value, mBlock)
688 return ("text", value)
690 def getHTML(self, id):
691 # we definitely don't want leading zeros
692 return '.'.join(["%d" % d for d in self.value])
694 class ConfigMAC(ConfigSequence):
695 def __init__(self, default):
696 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
698 class ConfigPosition(ConfigSequence):
699 def __init__(self, default, args):
700 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
702 class ConfigClock(ConfigSequence):
703 def __init__(self, default):
705 t = time.localtime(default)
706 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
709 # Check if Minutes maxed out
710 if self._value[1] == 59:
711 # Increment Hour, reset Minutes
712 if self._value[0] < 23:
724 # Check if Minutes is minimum
725 if self._value[1] == 0:
726 # Decrement Hour, set Minutes to 59
727 if self._value[0] > 0:
738 class ConfigInteger(ConfigSequence):
739 def __init__(self, default, limits = (0, 9999999999)):
740 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
742 # you need to override this to do input validation
743 def setValue(self, value):
744 self._value = [value]
748 return self._value[0]
750 value = property(getValue, setValue)
752 def fromstring(self, value):
755 def tostring(self, value):
758 class ConfigPIN(ConfigInteger):
759 def __init__(self, default, len = 4, censor = ""):
760 assert isinstance(default, int), "ConfigPIN default must be an integer"
763 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
769 class ConfigFloat(ConfigSequence):
770 def __init__(self, default, limits):
771 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
774 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
776 float = property(getFloat)
778 # an editable text...
779 class ConfigText(ConfigElement, NumericalTextInput):
780 def __init__(self, default = "", fixed_size = True, visible_width = False):
781 ConfigElement.__init__(self)
782 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
785 self.allmarked = (default != "")
786 self.fixed_size = fixed_size
787 self.visible_width = visible_width
789 self.overwrite = fixed_size
790 self.help_window = None
791 self.value = self.last_value = self.default = default
793 def validateMarker(self):
795 if self.marked_pos > len(self.text)-1:
796 self.marked_pos = len(self.text)-1
798 if self.marked_pos > len(self.text):
799 self.marked_pos = len(self.text)
800 if self.marked_pos < 0:
802 if self.visible_width:
803 if self.marked_pos < self.offset:
804 self.offset = self.marked_pos
805 if self.marked_pos >= self.offset + self.visible_width:
806 if self.marked_pos == len(self.text):
807 self.offset = self.marked_pos - self.visible_width
809 self.offset = self.marked_pos - self.visible_width + 1
810 if self.offset > 0 and self.offset + self.visible_width > len(self.text):
811 self.offset = max(0, len(self.text) - self.visible_width)
813 def insertChar(self, ch, pos, owr):
814 if owr or self.overwrite:
815 self.text = self.text[0:pos] + ch + self.text[pos + 1:]
816 elif self.fixed_size:
817 self.text = self.text[0:pos] + ch + self.text[pos:-1]
819 self.text = self.text[0:pos] + ch + self.text[pos:]
821 def deleteChar(self, pos):
822 if not self.fixed_size:
823 self.text = self.text[0:pos] + self.text[pos + 1:]
825 self.text = self.text[0:pos] + " " + self.text[pos + 1:]
827 self.text = self.text[0:pos] + self.text[pos + 1:] + " "
829 def deleteAllChars(self):
831 self.text = " " * len(self.text)
836 def handleKey(self, key):
837 # this will no change anything on the value itself
838 # so we can handle it here in gui element
839 if key == KEY_DELETE:
842 self.deleteAllChars()
843 self.allmarked = False
845 self.deleteChar(self.marked_pos)
846 if self.fixed_size and self.overwrite:
848 elif key == KEY_BACKSPACE:
851 self.deleteAllChars()
852 self.allmarked = False
853 elif self.marked_pos > 0:
854 self.deleteChar(self.marked_pos-1)
855 if not self.fixed_size and self.offset > 0:
858 elif key == KEY_LEFT:
861 self.marked_pos = len(self.text)
862 self.allmarked = False
865 elif key == KEY_RIGHT:
869 self.allmarked = False
872 elif key == KEY_HOME:
874 self.allmarked = False
878 self.allmarked = False
879 self.marked_pos = len(self.text)
880 elif key == KEY_TOGGLEOW:
882 self.overwrite = not self.overwrite
883 elif key == KEY_ASCII:
885 newChar = unichr(getPrevAsciiCode())
887 self.deleteAllChars()
888 self.allmarked = False
889 self.insertChar(newChar, self.marked_pos, False)
891 elif key in KEY_NUMBERS:
892 owr = self.lastKey == getKeyNumber(key)
893 newChar = self.getKey(getKeyNumber(key))
895 self.deleteAllChars()
896 self.allmarked = False
897 self.insertChar(newChar, self.marked_pos, owr)
898 elif key == KEY_TIMEOUT:
901 self.help_window.update(self)
905 self.help_window.update(self)
906 self.validateMarker()
911 self.validateMarker()
915 return self.text.encode("utf-8")
917 def setValue(self, val):
919 self.text = val.decode("utf-8")
920 except UnicodeDecodeError:
921 self.text = val.decode("utf-8", "ignore")
924 value = property(getValue, setValue)
925 _value = property(getValue, setValue)
928 return self.text.encode("utf-8")
930 def getMulti(self, selected):
931 if self.visible_width:
933 mark = range(0, min(self.visible_width, len(self.text)))
935 mark = [self.marked_pos-self.offset]
936 return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
939 mark = range(0, len(self.text))
941 mark = [self.marked_pos]
942 return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
944 def onSelect(self, session):
945 self.allmarked = (self.value != "")
946 if session is not None:
947 from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
948 self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
949 self.help_window.show()
951 def onDeselect(self, session):
955 session.deleteDialog(self.help_window)
956 self.help_window = None
957 if not self.last_value == self.value:
959 self.last_value = self.value
961 def getHTML(self, id):
962 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
964 def unsafeAssign(self, value):
965 self.value = str(value)
967 class ConfigPassword(ConfigText):
968 def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
969 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
970 self.censor_char = censor
973 def getMulti(self, selected):
974 mtext, text, mark = ConfigText.getMulti(self, selected)
976 text = len(text) * self.censor_char
977 return (mtext, text, mark)
979 def onSelect(self, session):
980 ConfigText.onSelect(self, session)
983 def onDeselect(self, session):
984 ConfigText.onDeselect(self, session)
987 class ConfigNumber(ConfigText):
988 def __init__(self, default = 0):
989 ConfigText.__init__(self, str(default), fixed_size = False)
992 return int(self.text)
994 def setValue(self, val):
997 value = property(getValue, setValue)
998 _value = property(getValue, setValue)
1001 pos = len(self.text) - self.marked_pos
1002 self.text = self.text.lstrip("0")
1005 if pos > len(self.text):
1008 self.marked_pos = len(self.text) - pos
1010 def handleKey(self, key):
1011 if key in KEY_NUMBERS or key == KEY_ASCII:
1012 if key == KEY_ASCII:
1013 ascii = getPrevAsciiCode()
1014 if not (48 <= ascii <= 57):
1017 ascii = getKeyNumber(key) + 48
1018 newChar = unichr(ascii)
1020 self.deleteAllChars()
1021 self.allmarked = False
1022 self.insertChar(newChar, self.marked_pos, False)
1023 self.marked_pos += 1
1025 ConfigText.handleKey(self, key)
1028 def onSelect(self, session):
1029 self.allmarked = (self.value != "")
1031 def onDeselect(self, session):
1034 if not self.last_value == self.value:
1036 self.last_value = self.value
1038 class ConfigSearchText(ConfigText):
1039 def __init__(self, default = "", fixed_size = False, visible_width = False):
1040 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1041 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False, search = True)
1043 class ConfigDirectory(ConfigText):
1044 def __init__(self, default="", visible_width=60):
1045 ConfigText.__init__(self, default, fixed_size = True, visible_width = visible_width)
1046 def handleKey(self, key):
1052 return ConfigText.getValue(self)
1053 def setValue(self, val):
1056 ConfigText.setValue(self, val)
1057 def getMulti(self, selected):
1059 return ("mtext"[1-selected:], _("List of Storage Devices"), range(0))
1061 return ConfigText.getMulti(self, selected)
1064 class ConfigSlider(ConfigElement):
1065 def __init__(self, default = 0, increment = 1, limits = (0, 100)):
1066 ConfigElement.__init__(self)
1067 self.value = self.last_value = self.default = default
1068 self.min = limits[0]
1069 self.max = limits[1]
1070 self.increment = increment
1072 def checkValues(self):
1073 if self.value < self.min:
1074 self.value = self.min
1076 if self.value > self.max:
1077 self.value = self.max
1079 def handleKey(self, key):
1081 self.value -= self.increment
1082 elif key == KEY_RIGHT:
1083 self.value += self.increment
1084 elif key == KEY_HOME:
1085 self.value = self.min
1086 elif key == KEY_END:
1087 self.value = self.max
1093 return "%d / %d" % (self.value, self.max)
1095 def getMulti(self, selected):
1097 return ("slider", self.value, self.max)
1099 def fromstring(self, value):
1102 # a satlist. in fact, it's a ConfigSelection.
1103 class ConfigSatlist(ConfigSelection):
1104 def __init__(self, list, default = None):
1105 if default is not None:
1106 default = str(default)
1107 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
1109 def getOrbitalPosition(self):
1110 if self.value == "":
1112 return int(self.value)
1114 orbital_position = property(getOrbitalPosition)
1116 class ConfigSet(ConfigElement):
1117 def __init__(self, choices, default = []):
1118 ConfigElement.__init__(self)
1119 if isinstance(choices, list):
1121 self.choices = choicesList(choices, choicesList.LIST_TYPE_LIST)
1123 assert False, "ConfigSet choices must be a list!"
1128 self.last_value = self.default = default
1129 self.value = default[:]
1131 def toggleChoice(self, choice):
1132 if choice in self.value:
1133 self.value.remove(choice)
1135 self.value.append(choice)
1139 def handleKey(self, key):
1140 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
1142 self.toggleChoice(self.choices[self.pos])
1143 elif key == KEY_LEFT:
1146 self.pos = len(self.choices)-1
1147 elif key == KEY_RIGHT:
1149 if self.pos >= len(self.choices):
1151 elif key in [KEY_HOME, KEY_END]:
1154 def genString(self, lst):
1157 res += self.description[x]+" "
1161 return self.genString(self.value)
1163 def getMulti(self, selected):
1164 if not selected or self.pos == -1:
1165 return ("text", self.genString(self.value))
1168 ch = self.choices[self.pos]
1169 mem = ch in self.value
1174 val1 = self.genString(tmp[:ind])
1175 val2 = " "+self.genString(tmp[ind+1:])
1177 chstr = " "+self.description[ch]+" "
1179 chstr = "("+self.description[ch]+")"
1180 return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
1182 def onDeselect(self, session):
1184 if not self.last_value == self.value:
1186 self.last_value = self.value[:]
1188 def tostring(self, value):
1191 def fromstring(self, val):
1194 description = property(lambda self: descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST))
1196 class ConfigLocations(ConfigElement):
1197 def __init__(self, default = [], visible_width = False):
1198 ConfigElement.__init__(self)
1199 self.visible_width = visible_width
1201 self.default = default
1203 self.mountpoints = []
1204 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
1205 self.value = default+[]
1207 def setValue(self, value):
1208 loc = [x[0] for x in self.locations if x[3]]
1209 add = [x for x in value if not x in loc]
1210 diff = add + [x for x in loc if not x in value]
1211 self.locations = [x for x in self.locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
1212 self.locations.sort(key = lambda x: x[0])
1216 self.checkChangedMountpoints()
1217 for x in self.locations:
1219 return [x[0] for x in self.locations if x[3]]
1221 value = property(getValue, setValue)
1223 def tostring(self, value):
1226 def fromstring(self, val):
1230 sv = self.saved_value
1234 tmp = self.fromstring(sv)
1235 self.locations = [[x, None, False, False] for x in tmp]
1236 self.refreshMountpoints()
1237 for x in self.locations:
1238 if os.path.exists(x[0]):
1239 x[1] = self.getMountpoint(x[0])
1243 if self.save_disabled or self.locations == []:
1244 self.saved_value = None
1246 self.saved_value = self.tostring([x[0] for x in self.locations])
1248 def isChanged(self):
1249 sv = self.saved_value
1250 if val is None and self.locations == []:
1252 return self.tostring([x[0] for x in self.locations]) != sv
1254 def mountpointsChanged(self, action, dev):
1255 print "Mounts changed: ", action, dev
1256 mp = dev.mountpoint+"/"
1259 elif action == "remove":
1260 self.removedMount(mp)
1261 self.refreshMountpoints()
1263 def addedMount(self, mp):
1264 for x in self.locations:
1267 elif x[1] == None and os.path.exists(x[0]):
1268 x[1] = self.getMountpoint(x[0])
1271 def removedMount(self, mp):
1272 for x in self.locations:
1276 def refreshMountpoints(self):
1277 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1278 self.mountpoints.sort(key = lambda x: -len(x))
1280 def checkChangedMountpoints(self):
1281 oldmounts = self.mountpoints
1282 self.refreshMountpoints()
1283 if oldmounts == self.mountpoints:
1286 if not x in self.mountpoints:
1287 self.removedMount(x)
1288 for x in self.mountpoints:
1289 if not x in oldmounts:
1292 def getMountpoint(self, file):
1293 file = os.path.realpath(file)+"/"
1294 for m in self.mountpoints:
1295 if file.startswith(m):
1299 def handleKey(self, key):
1303 self.pos = len(self.value)-1
1304 elif key == KEY_RIGHT:
1306 if self.pos >= len(self.value):
1308 elif key in [KEY_HOME, KEY_END]:
1312 return " ".join(self.value)
1314 def getMulti(self, selected):
1316 valstr = " ".join(self.value)
1317 if self.visible_width and len(valstr) > self.visible_width:
1318 return ("text", valstr[0:self.visible_width])
1320 return ("text", valstr)
1326 for val in self.value:
1329 valstr += str(val)+" "
1333 if self.visible_width and len(valstr) > self.visible_width:
1334 if ind1+1 < self.visible_width/2:
1337 off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1338 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1340 return ("mtext", valstr, range(ind1,ind2))
1342 def onDeselect(self, session):
1346 class ConfigNothing(ConfigSelection):
1348 ConfigSelection.__init__(self, choices = [""])
1350 # until here, 'saved_value' always had to be a *string*.
1351 # now, in ConfigSubsection, and only there, saved_value
1352 # is a dict, essentially forming a tree.
1354 # config.foo.bar=True
1355 # config.foobar=False
1358 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1362 class ConfigSubsectionContent(object):
1365 # we store a backup of the loaded configuration
1366 # data in self.stored_values, to be able to deploy
1367 # them when a new config element will be added,
1368 # so non-default values are instantly available
1370 # A list, for example:
1371 # config.dipswitches = ConfigSubList()
1372 # config.dipswitches.append(ConfigYesNo())
1373 # config.dipswitches.append(ConfigYesNo())
1374 # config.dipswitches.append(ConfigYesNo())
1375 class ConfigSubList(list, object):
1377 object.__init__(self)
1379 self.stored_values = {}
1389 def getSavedValue(self):
1391 for i in range(len(self)):
1392 sv = self[i].saved_value
1397 def setSavedValue(self, values):
1398 self.stored_values = dict(values)
1399 for (key, val) in self.stored_values.items():
1400 if int(key) < len(self):
1401 self[int(key)].saved_value = val
1403 saved_value = property(getSavedValue, setSavedValue)
1405 def append(self, item):
1407 list.append(self, item)
1408 if i in self.stored_values:
1409 item.saved_value = self.stored_values[i]
1414 for index in range(len(self)):
1415 res[str(index)] = self[index]
1418 # same as ConfigSubList, just as a dictionary.
1419 # care must be taken that the 'key' has a proper
1420 # str() method, because it will be used in the config
1422 class ConfigSubDict(dict, object):
1424 object.__init__(self)
1426 self.stored_values = {}
1429 for x in self.values():
1433 for x in self.values():
1436 def getSavedValue(self):
1438 for (key, val) in self.items():
1439 sv = val.saved_value
1444 def setSavedValue(self, values):
1445 self.stored_values = dict(values)
1446 for (key, val) in self.items():
1447 if str(key) in self.stored_values:
1448 val = self.stored_values[str(key)]
1450 saved_value = property(getSavedValue, setSavedValue)
1452 def __setitem__(self, key, item):
1453 dict.__setitem__(self, key, item)
1454 if str(key) in self.stored_values:
1455 item.saved_value = self.stored_values[str(key)]
1461 # Like the classes above, just with a more "native"
1464 # some evil stuff must be done to allow instant
1465 # loading of added elements. this is why this class
1468 # we need the 'content' because we overwrite
1470 # If you don't understand this, try adding
1471 # __setattr__ to a usual exisiting class and you will.
1472 class ConfigSubsection(object):
1474 object.__init__(self)
1475 self.__dict__["content"] = ConfigSubsectionContent()
1476 self.content.items = { }
1477 self.content.stored_values = { }
1479 def __setattr__(self, name, value):
1480 if name == "saved_value":
1481 return self.setSavedValue(value)
1482 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"
1483 self.content.items[name] = value
1484 if name in self.content.stored_values:
1485 #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
1486 value.saved_value = self.content.stored_values[name]
1489 def __getattr__(self, name):
1490 return self.content.items[name]
1492 def getSavedValue(self):
1493 res = self.content.stored_values
1494 for (key, val) in self.content.items.items():
1495 sv = val.saved_value
1502 def setSavedValue(self, values):
1503 values = dict(values)
1505 self.content.stored_values = values
1507 for (key, val) in self.content.items.items():
1509 val.saved_value = values[key]
1511 saved_value = property(getSavedValue, setSavedValue)
1514 for x in self.content.items.values():
1518 for x in self.content.items.values():
1522 return self.content.items
1524 # the root config object, which also can "pickle" (=serialize)
1525 # down the whole config tree.
1527 # we try to keep non-existing config entries, to apply them whenever
1528 # a new config entry is added to a subsection
1529 # also, non-existing config entries will be saved, so they won't be
1530 # lost when a config entry disappears.
1531 class Config(ConfigSubsection):
1533 ConfigSubsection.__init__(self)
1535 def pickle_this(self, prefix, topickle, result):
1536 for (key, val) in topickle.items():
1537 name = prefix + "." + key
1539 if isinstance(val, dict):
1540 self.pickle_this(name, val, result)
1541 elif isinstance(val, tuple):
1542 result.append(name + "=" + val[0]) # + " ; " + val[1])
1544 result.append(name + "=" + val)
1548 self.pickle_this("config", self.saved_value, result)
1549 return '\n'.join(result) + "\n"
1551 def unpickle(self, lines):
1554 if not len(l) or l[0] == '#':
1558 val = l[n+1:].strip()
1560 names = l[:n].split('.')
1561 # if val.find(' ') != -1:
1562 # val = val[:val.find(' ')]
1566 for n in names[:-1]:
1567 base = base.setdefault(n, {})
1569 base[names[-1]] = val
1571 # we inherit from ConfigSubsection, so ...
1572 #object.__setattr__(self, "saved_value", tree["config"])
1573 if "config" in tree:
1574 self.setSavedValue(tree["config"])
1576 def saveToFile(self, filename):
1577 f = open(filename, "w")
1578 f.write(self.pickle())
1581 def loadFromFile(self, filename):
1582 f = open(filename, "r")
1583 self.unpickle(f.readlines())
1587 config.misc = ConfigSubsection()
1590 CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1594 config.loadFromFile(self.CONFIG_FILE)
1596 print "unable to load config (%s), assuming defaults..." % str(e)
1600 config.saveToFile(self.CONFIG_FILE)
1602 def __resolveValue(self, pickles, cmap):
1603 if cmap.has_key(pickles[0]):
1604 if len(pickles) > 1:
1605 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1607 return str(cmap[pickles[0]].value)
1610 def getResolvedKey(self, key):
1611 names = key.split('.')
1613 if names[0] == "config":
1614 ret=self.__resolveValue(names[1:], config.content.items)
1615 if ret and len(ret):
1617 print "getResolvedKey", key, "failed !! (Typo??)"
1620 def NoSave(element):
1621 element.disableSave()
1624 configfile = ConfigFile()
1628 def getConfigListEntry(*args):
1629 assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1632 def updateConfigElement(element, newelement):
1633 newelement.value = element.value
1639 #config.bla = ConfigSubsection()
1640 #config.bla.test = ConfigYesNo()
1641 #config.nim = ConfigSubList()
1642 #config.nim.append(ConfigSubsection())
1643 #config.nim[0].bla = ConfigYesNo()
1644 #config.nim.append(ConfigSubsection())
1645 #config.nim[1].bla = ConfigYesNo()
1646 #config.nim[1].blub = ConfigYesNo()
1647 #config.arg = ConfigSubDict()
1648 #config.arg["Hello"] = ConfigYesNo()
1650 #config.arg["Hello"].handleKey(KEY_RIGHT)
1651 #config.arg["Hello"].handleKey(KEY_RIGHT)
1653 ##config.saved_value
1657 #print config.pickle()