1 from enigma import getPrevAsciiCode
2 from Tools.NumericalTextInput import NumericalTextInput
3 from Tools.Directories import resolveFilename, SCOPE_CONFIG
4 from Components.Harddisk import harddiskmanager
5 from copy import copy as copy_copy
6 from os import path as os_path
7 from time import localtime, strftime
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):
31 self.saved_value = None
32 self.last_value = None
33 self.save_disabled = False
34 self.__notifiers = None
35 self.__notifiers_final = None
37 self.callNotifiersOnSaveAndCancel = False
39 def getNotifiers(self):
40 if self.__notifiers is None:
41 self.__notifiers = [ ]
42 return self.__notifiers
44 def setNotifiers(self, val):
45 self.__notifiers = val
47 notifiers = property(getNotifiers, setNotifiers)
49 def getNotifiersFinal(self):
50 if self.__notifiers_final is None:
51 self.__notifiers_final = [ ]
52 return self.__notifiers_final
54 def setNotifiersFinal(self, val):
55 self.__notifiers_final = val
57 notifiers_final = property(getNotifiersFinal, setNotifiersFinal)
59 # you need to override this to do input validation
60 def setValue(self, value):
67 value = property(getValue, setValue)
69 # you need to override this if self.value is not a string
70 def fromstring(self, value):
73 # you can overide this for fancy default handling
77 self.value = self.default
79 self.value = self.fromstring(sv)
81 def tostring(self, value):
84 # you need to override this if str(self.value) doesn't work
86 if self.save_disabled or self.value == self.default:
87 self.saved_value = None
89 self.saved_value = self.tostring(self.value)
90 if self.callNotifiersOnSaveAndCancel:
95 if self.callNotifiersOnSaveAndCancel:
100 if sv is None and self.value == self.default:
102 return self.tostring(self.value) != sv
106 for x in self.notifiers:
109 def changedFinal(self):
110 if self.__notifiers_final:
111 for x in self.notifiers_final:
114 def addNotifier(self, notifier, initial_call = True, immediate_feedback = True):
115 assert callable(notifier), "notifiers must be callable"
116 if immediate_feedback:
117 self.notifiers.append(notifier)
119 self.notifiers_final.append(notifier)
121 # do we want to call the notifier
122 # - at all when adding it? (yes, though optional)
123 # - when the default is active? (yes)
124 # - when no value *yet* has been set,
125 # because no config has ever been read (currently yes)
126 # (though that's not so easy to detect.
127 # the entry could just be new.)
131 def disableSave(self):
132 self.save_disabled = True
134 def __call__(self, selected):
135 return self.getMulti(selected)
137 def onSelect(self, session):
140 def onDeselect(self, session):
141 if not self.last_value == self.value:
143 self.last_value = self.value
155 KEY_NUMBERS = range(12, 12+10)
159 def getKeyNumber(key):
160 assert key in KEY_NUMBERS
163 class choicesList(object): # XXX: we might want a better name for this
167 def __init__(self, choices, type = None):
168 self.choices = choices
170 if isinstance(choices, list):
171 self.type = choicesList.LIST_TYPE_LIST
172 elif isinstance(choices, dict):
173 self.type = choicesList.LIST_TYPE_DICT
175 assert False, "choices must be dict or list!"
180 if self.type == choicesList.LIST_TYPE_LIST:
181 ret = [not isinstance(x, tuple) and x or x[0] for x in self.choices]
183 ret = self.choices.keys()
187 if self.type == choicesList.LIST_TYPE_LIST:
188 ret = [not isinstance(x, tuple) and x or x[0] for x in self.choices]
191 return iter(ret or [""])
194 return len(self.choices) or 1
196 def __getitem__(self, index):
197 if self.type == choicesList.LIST_TYPE_LIST:
198 ret = self.choices[index]
199 if isinstance(ret, tuple):
202 return self.choices.keys()[index]
204 def index(self, value):
205 return self.__list__().index(value)
207 def __setitem__(self, index, value):
208 if self.type == choicesList.LIST_TYPE_LIST:
209 orig = self.choices[index]
210 if isinstance(orig, tuple):
211 self.choices[index] = (value, orig[1])
213 self.choices[index] = value
215 key = self.choices.keys()[index]
216 orig = self.choices[key]
217 del self.choices[key]
218 self.choices[value] = orig
221 choices = self.choices
224 if self.type is choicesList.LIST_TYPE_LIST:
226 if isinstance(default, tuple):
229 default = choices.keys()[0]
232 class descriptionList(choicesList): # XXX: we might want a better name for this
234 if self.type == choicesList.LIST_TYPE_LIST:
235 ret = [not isinstance(x, tuple) and x or x[1] for x in self.choices]
237 ret = self.choices.values()
241 return iter(self.__list__())
243 def __getitem__(self, index):
244 if self.type == choicesList.LIST_TYPE_LIST:
245 for x in self.choices:
246 if isinstance(x, tuple):
251 return str(index) # Fallback!
253 return str(self.choices.get(index, ""))
255 def __setitem__(self, index, value):
256 if self.type == choicesList.LIST_TYPE_LIST:
257 i = self.index(index)
258 orig = self.choices[i]
259 if isinstance(orig, tuple):
260 self.choices[i] = (orig[0], value)
262 self.choices[i] = value
264 self.choices[index] = value
267 # ConfigSelection is a "one of.."-type.
268 # it has the "choices", usually a list, which contains
269 # (id, desc)-tuples (or just only the ids, in case the id
270 # will be used as description)
272 # all ids MUST be plain strings.
274 class ConfigSelection(ConfigElement):
275 def __init__(self, choices, default = None):
276 ConfigElement.__init__(self)
277 self.choices = choicesList(choices)
280 default = self.choices.default()
283 self.default = self._value = self.last_value = default
285 def setChoices(self, choices, default = None):
286 self.choices = choicesList(choices)
289 default = self.choices.default()
291 if self.value not in self.choices:
294 def setValue(self, value):
295 if value in self.choices:
298 self._value = self.default
302 def tostring(self, val):
308 def setCurrentText(self, text):
309 i = self.choices.index(self.value)
310 self.choices[i] = text
311 self._descr = self.description[text] = text
314 value = property(getValue, setValue)
317 return self.choices.index(self.value)
319 index = property(getIndex)
322 def handleKey(self, key):
323 nchoices = len(self.choices)
324 i = self.choices.index(self.value)
326 self.value = self.choices[(i + nchoices - 1) % nchoices]
327 elif key == KEY_RIGHT:
328 self.value = self.choices[(i + 1) % nchoices]
329 elif key == KEY_HOME:
330 self.value = self.choices[0]
332 self.value = self.choices[nchoices - 1]
334 def selectNext(self):
335 nchoices = len(self.choices)
336 i = self.choices.index(self.value)
337 self.value = self.choices[(i + 1) % nchoices]
340 if self._descr is not None:
342 descr = self._descr = self.description[self.value]
347 def getMulti(self, selected):
348 if self._descr is not None:
351 descr = self._descr = self.description[self.value]
353 return ("text", _(descr))
354 return ("text", descr)
357 def getHTML(self, id):
359 for v in self.choices:
360 descr = self.description[v]
362 checked = 'checked="checked" '
365 res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + descr + "</input></br>\n"
368 def unsafeAssign(self, value):
369 # setValue does check if value is in choices. This is safe enough.
372 description = property(lambda self: descriptionList(self.choices.choices, self.choices.type))
376 # several customized versions exist for different
379 boolean_descriptions = {False: "false", True: "true"}
380 class ConfigBoolean(ConfigElement):
381 def __init__(self, default = False, descriptions = boolean_descriptions):
382 ConfigElement.__init__(self)
383 self.descriptions = descriptions
384 self.value = self.last_value = self.default = default
386 def handleKey(self, key):
387 if key in (KEY_LEFT, KEY_RIGHT):
388 self.value = not self.value
389 elif key == KEY_HOME:
395 descr = self.descriptions[self.value]
400 def getMulti(self, selected):
401 descr = self.descriptions[self.value]
403 return ("text", _(descr))
404 return ("text", descr)
406 def tostring(self, value):
412 def fromstring(self, val):
418 def getHTML(self, id):
420 checked = ' checked="checked"'
423 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
425 # this is FLAWED. and must be fixed.
426 def unsafeAssign(self, value):
432 def onDeselect(self, session):
433 if not self.last_value == self.value:
435 self.last_value = self.value
437 yes_no_descriptions = {False: _("no"), True: _("yes")}
438 class ConfigYesNo(ConfigBoolean):
439 def __init__(self, default = False):
440 ConfigBoolean.__init__(self, default = default, descriptions = yes_no_descriptions)
442 on_off_descriptions = {False: _("off"), True: _("on")}
443 class ConfigOnOff(ConfigBoolean):
444 def __init__(self, default = False):
445 ConfigBoolean.__init__(self, default = default, descriptions = on_off_descriptions)
447 enable_disable_descriptions = {False: _("disable"), True: _("enable")}
448 class ConfigEnableDisable(ConfigBoolean):
449 def __init__(self, default = False):
450 ConfigBoolean.__init__(self, default = default, descriptions = enable_disable_descriptions)
452 class ConfigDateTime(ConfigElement):
453 def __init__(self, default, formatstring, increment = 86400):
454 ConfigElement.__init__(self)
455 self.increment = increment
456 self.formatstring = formatstring
457 self.value = self.last_value = self.default = int(default)
459 def handleKey(self, key):
461 self.value = self.value - self.increment
462 elif key == KEY_RIGHT:
463 self.value = self.value + self.increment
464 elif key == KEY_HOME or key == KEY_END:
465 self.value = self.default
468 return strftime(self.formatstring, localtime(self.value))
470 def getMulti(self, selected):
471 return ("text", strftime(self.formatstring, localtime(self.value)))
473 def fromstring(self, val):
476 # *THE* mighty config element class
478 # allows you to store/edit a sequence of values.
479 # can be used for IP-addresses, dates, plain integers, ...
480 # several helper exist to ease this up a bit.
482 class ConfigSequence(ConfigElement):
483 def __init__(self, seperator, limits, default, censor_char = ""):
484 ConfigElement.__init__(self)
485 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
486 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
487 #assert isinstance(default, list), "default must be a list"
488 #assert isinstance(default[0], int), "list must contain numbers"
489 #assert len(default) == len(limits), "length must match"
492 self.seperator = seperator
494 self.censor_char = censor_char
496 self.last_value = self.default = default
497 self.value = copy_copy(default)
498 self.endNotifier = None
503 for i in self._value:
504 max_pos += len(str(self.limits[num][1]))
506 if self._value[num] < self.limits[num][0]:
507 self._value[num] = self.limits[num][0]
509 if self._value[num] > self.limits[num][1]:
510 self._value[num] = self.limits[num][1]
514 if self.marked_pos >= max_pos:
516 for x in self.endNotifier:
518 self.marked_pos = max_pos - 1
520 if self.marked_pos < 0:
523 def validatePos(self):
524 if self.marked_pos < 0:
527 total_len = sum([len(str(x[1])) for x in self.limits])
529 if self.marked_pos >= total_len:
530 self.marked_pos = total_len - 1
532 def addEndNotifier(self, notifier):
533 if self.endNotifier is None:
534 self.endNotifier = []
535 self.endNotifier.append(notifier)
537 def handleKey(self, key):
542 elif key == KEY_RIGHT:
546 elif key == KEY_HOME:
553 for i in self._value:
554 max_pos += len(str(self.limits[num][1]))
556 self.marked_pos = max_pos - 1
559 elif key in KEY_NUMBERS or key == KEY_ASCII:
561 code = getPrevAsciiCode()
562 if code < 48 or code > 57:
566 number = getKeyNumber(key)
568 block_len = [len(str(x[1])) for x in self.limits]
569 total_len = sum(block_len)
573 block_len_total = [0, ]
575 pos += block_len[blocknumber]
576 block_len_total.append(pos)
577 if pos - 1 >= self.marked_pos:
582 # length of numberblock
583 number_len = len(str(self.limits[blocknumber][1]))
585 # position in the block
586 posinblock = self.marked_pos - block_len_total[blocknumber]
588 oldvalue = self._value[blocknumber]
589 olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
590 newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
592 self._value[blocknumber] = newvalue
600 mPos = self.marked_pos
602 for i in self._value:
603 if value: #fixme no heading separator possible
604 value += self.seperator
605 if mPos >= len(value) - 1:
607 if self.censor_char == "":
608 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
610 value += (self.censor_char * len(str(self.limits[num][1])))
615 (value, mPos) = self.genText()
618 def getMulti(self, selected):
619 (value, mPos) = self.genText()
620 # only mark cursor when we are selected
621 # (this code is heavily ink optimized!)
623 return ("mtext"[1-selected:], value, [mPos])
625 return ("text", value)
627 def tostring(self, val):
628 return self.seperator.join([self.saveSingle(x) for x in val])
630 def saveSingle(self, v):
633 def fromstring(self, value):
634 return [int(x) for x in value.split(self.seperator)]
636 def onDeselect(self, session):
637 if self.last_value != self._value:
639 self.last_value = copy_copy(self._value)
641 ip_limits = [(0,255),(0,255),(0,255),(0,255)]
642 class ConfigIP(ConfigSequence):
643 def __init__(self, default, auto_jump = False):
644 ConfigSequence.__init__(self, seperator = ".", limits = ip_limits, default = default)
645 self.block_len = [len(str(x[1])) for x in self.limits]
646 self.marked_block = 0
647 self.overwrite = True
648 self.auto_jump = auto_jump
650 def handleKey(self, key):
652 if self.marked_block > 0:
653 self.marked_block -= 1
654 self.overwrite = True
656 elif key == KEY_RIGHT:
657 if self.marked_block < len(self.limits)-1:
658 self.marked_block += 1
659 self.overwrite = True
661 elif key == KEY_HOME:
662 self.marked_block = 0
663 self.overwrite = True
666 self.marked_block = len(self.limits)-1
667 self.overwrite = True
669 elif key in KEY_NUMBERS or key == KEY_ASCII:
671 code = getPrevAsciiCode()
672 if code < 48 or code > 57:
676 number = getKeyNumber(key)
677 oldvalue = self._value[self.marked_block]
680 self._value[self.marked_block] = number
681 self.overwrite = False
684 newvalue = oldvalue + number
685 if self.auto_jump and newvalue > self.limits[self.marked_block][1] and self.marked_block < len(self.limits)-1:
686 self.handleKey(KEY_RIGHT)
690 self._value[self.marked_block] = newvalue
692 if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
693 self.handleKey(KEY_RIGHT)
701 for i in self._value:
702 block_strlen.append(len(str(i)))
704 value += self.seperator
706 leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
707 rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
708 mBlock = range(leftPos, rightPos)
709 return (value, mBlock)
711 def getMulti(self, selected):
712 (value, mBlock) = self.genText()
714 return ("mtext"[1-selected:], value, mBlock)
716 return ("text", value)
718 def getHTML(self, id):
719 # we definitely don't want leading zeros
720 return '.'.join(["%d" % d for d in self.value])
722 mac_limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)]
723 class ConfigMAC(ConfigSequence):
724 def __init__(self, default):
725 ConfigSequence.__init__(self, seperator = ":", limits = mac_limits, default = default)
727 class ConfigPosition(ConfigSequence):
728 def __init__(self, default, args):
729 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
731 clock_limits = [(0,23),(0,59)]
732 class ConfigClock(ConfigSequence):
733 def __init__(self, default):
734 t = localtime(default)
735 ConfigSequence.__init__(self, seperator = ":", limits = clock_limits, default = [t.tm_hour, t.tm_min])
738 # Check if Minutes maxed out
739 if self._value[1] == 59:
740 # Increment Hour, reset Minutes
741 if self._value[0] < 23:
753 # Check if Minutes is minimum
754 if self._value[1] == 0:
755 # Decrement Hour, set Minutes to 59
756 if self._value[0] > 0:
767 integer_limits = (0, 9999999999)
768 class ConfigInteger(ConfigSequence):
769 def __init__(self, default, limits = integer_limits):
770 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
772 # you need to override this to do input validation
773 def setValue(self, value):
774 self._value = [value]
778 return self._value[0]
780 value = property(getValue, setValue)
782 def fromstring(self, value):
785 def tostring(self, value):
788 class ConfigPIN(ConfigInteger):
789 def __init__(self, default, len = 4, censor = ""):
790 assert isinstance(default, int), "ConfigPIN default must be an integer"
793 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
799 class ConfigFloat(ConfigSequence):
800 def __init__(self, default, limits):
801 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
804 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
806 float = property(getFloat)
808 # an editable text...
809 class ConfigText(ConfigElement, NumericalTextInput):
810 def __init__(self, default = "", fixed_size = True, visible_width = False):
811 ConfigElement.__init__(self)
812 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
815 self.allmarked = (default != "")
816 self.fixed_size = fixed_size
817 self.visible_width = visible_width
819 self.overwrite = fixed_size
820 self.help_window = None
821 self.value = self.last_value = self.default = default
823 def validateMarker(self):
824 textlen = len(self.text)
826 if self.marked_pos > textlen-1:
827 self.marked_pos = textlen-1
829 if self.marked_pos > textlen:
830 self.marked_pos = textlen
831 if self.marked_pos < 0:
833 if self.visible_width:
834 if self.marked_pos < self.offset:
835 self.offset = self.marked_pos
836 if self.marked_pos >= self.offset + self.visible_width:
837 if self.marked_pos == textlen:
838 self.offset = self.marked_pos - self.visible_width
840 self.offset = self.marked_pos - self.visible_width + 1
841 if self.offset > 0 and self.offset + self.visible_width > textlen:
842 self.offset = max(0, len - self.visible_width)
844 def insertChar(self, ch, pos, owr):
845 if owr or self.overwrite:
846 self.text = self.text[0:pos] + ch + self.text[pos + 1:]
847 elif self.fixed_size:
848 self.text = self.text[0:pos] + ch + self.text[pos:-1]
850 self.text = self.text[0:pos] + ch + self.text[pos:]
852 def deleteChar(self, pos):
853 if not self.fixed_size:
854 self.text = self.text[0:pos] + self.text[pos + 1:]
856 self.text = self.text[0:pos] + " " + self.text[pos + 1:]
858 self.text = self.text[0:pos] + self.text[pos + 1:] + " "
860 def deleteAllChars(self):
862 self.text = " " * len(self.text)
867 def handleKey(self, key):
868 # this will no change anything on the value itself
869 # so we can handle it here in gui element
870 if key == KEY_DELETE:
873 self.deleteAllChars()
874 self.allmarked = False
876 self.deleteChar(self.marked_pos)
877 if self.fixed_size and self.overwrite:
879 elif key == KEY_BACKSPACE:
882 self.deleteAllChars()
883 self.allmarked = False
884 elif self.marked_pos > 0:
885 self.deleteChar(self.marked_pos-1)
886 if not self.fixed_size and self.offset > 0:
889 elif key == KEY_LEFT:
892 self.marked_pos = len(self.text)
893 self.allmarked = False
896 elif key == KEY_RIGHT:
900 self.allmarked = False
903 elif key == KEY_HOME:
905 self.allmarked = False
909 self.allmarked = False
910 self.marked_pos = len(self.text)
911 elif key == KEY_TOGGLEOW:
913 self.overwrite = not self.overwrite
914 elif key == KEY_ASCII:
916 newChar = unichr(getPrevAsciiCode())
918 self.deleteAllChars()
919 self.allmarked = False
920 self.insertChar(newChar, self.marked_pos, False)
922 elif key in KEY_NUMBERS:
923 owr = self.lastKey == getKeyNumber(key)
924 newChar = self.getKey(getKeyNumber(key))
926 self.deleteAllChars()
927 self.allmarked = False
928 self.insertChar(newChar, self.marked_pos, owr)
929 elif key == KEY_TIMEOUT:
932 self.help_window.update(self)
936 self.help_window.update(self)
937 self.validateMarker()
942 self.validateMarker()
946 return self.text.encode("utf-8")
948 def setValue(self, val):
950 self.text = val.decode("utf-8")
951 except UnicodeDecodeError:
952 self.text = val.decode("utf-8", "ignore")
955 value = property(getValue, setValue)
956 _value = property(getValue, setValue)
959 return self.text.encode("utf-8")
961 def getMulti(self, selected):
962 if self.visible_width:
964 mark = range(0, min(self.visible_width, len(self.text)))
966 mark = [self.marked_pos-self.offset]
967 return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
970 mark = range(0, len(self.text))
972 mark = [self.marked_pos]
973 return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
975 def onSelect(self, session):
976 self.allmarked = (self.value != "")
977 if session is not None:
978 from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
979 self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
980 self.help_window.show()
982 def onDeselect(self, session):
986 session.deleteDialog(self.help_window)
987 self.help_window = None
988 if not self.last_value == self.value:
990 self.last_value = self.value
992 def getHTML(self, id):
993 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
995 def unsafeAssign(self, value):
996 self.value = str(value)
998 class ConfigPassword(ConfigText):
999 def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
1000 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1001 self.censor_char = censor
1004 def getMulti(self, selected):
1005 mtext, text, mark = ConfigText.getMulti(self, selected)
1007 text = len(text) * self.censor_char
1008 return (mtext, text, mark)
1010 def onSelect(self, session):
1011 ConfigText.onSelect(self, session)
1014 def onDeselect(self, session):
1015 ConfigText.onDeselect(self, session)
1018 class ConfigNumber(ConfigText):
1019 def __init__(self, default = 0):
1020 ConfigText.__init__(self, str(default), fixed_size = False)
1023 return int(self.text)
1025 def setValue(self, val):
1026 self.text = str(val)
1028 value = property(getValue, setValue)
1029 _value = property(getValue, setValue)
1031 def isChanged(self):
1032 sv = self.saved_value
1033 strv = self.tostring(self.value)
1034 if sv is None and strv == self.default:
1039 pos = len(self.text) - self.marked_pos
1040 self.text = self.text.lstrip("0")
1043 if pos > len(self.text):
1046 self.marked_pos = len(self.text) - pos
1048 def handleKey(self, key):
1049 if key in KEY_NUMBERS or key == KEY_ASCII:
1050 if key == KEY_ASCII:
1051 ascii = getPrevAsciiCode()
1052 if not (48 <= ascii <= 57):
1055 ascii = getKeyNumber(key) + 48
1056 newChar = unichr(ascii)
1058 self.deleteAllChars()
1059 self.allmarked = False
1060 self.insertChar(newChar, self.marked_pos, False)
1061 self.marked_pos += 1
1063 ConfigText.handleKey(self, key)
1066 def onSelect(self, session):
1067 self.allmarked = (self.value != "")
1069 def onDeselect(self, session):
1072 if not self.last_value == self.value:
1074 self.last_value = self.value
1076 class ConfigSearchText(ConfigText):
1077 def __init__(self, default = "", fixed_size = False, visible_width = False):
1078 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1079 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False, search = True)
1081 class ConfigDirectory(ConfigText):
1082 def __init__(self, default="", visible_width=60):
1083 ConfigText.__init__(self, default, fixed_size = True, visible_width = visible_width)
1085 def handleKey(self, key):
1092 return ConfigText.getValue(self)
1094 def setValue(self, val):
1097 ConfigText.setValue(self, val)
1099 def getMulti(self, selected):
1101 return ("mtext"[1-selected:], _("List of Storage Devices"), range(0))
1103 return ConfigText.getMulti(self, selected)
1106 class ConfigSlider(ConfigElement):
1107 def __init__(self, default = 0, increment = 1, limits = (0, 100)):
1108 ConfigElement.__init__(self)
1109 self.value = self.last_value = self.default = default
1110 self.min = limits[0]
1111 self.max = limits[1]
1112 self.increment = increment
1114 def checkValues(self):
1115 if self.value < self.min:
1116 self.value = self.min
1118 if self.value > self.max:
1119 self.value = self.max
1121 def handleKey(self, key):
1123 self.value -= self.increment
1124 elif key == KEY_RIGHT:
1125 self.value += self.increment
1126 elif key == KEY_HOME:
1127 self.value = self.min
1128 elif key == KEY_END:
1129 self.value = self.max
1135 return "%d / %d" % (self.value, self.max)
1137 def getMulti(self, selected):
1139 return ("slider", self.value, self.max)
1141 def fromstring(self, value):
1144 # a satlist. in fact, it's a ConfigSelection.
1145 class ConfigSatlist(ConfigSelection):
1146 def __init__(self, list, default = None):
1147 if default is not None:
1148 default = str(default)
1149 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
1151 def getOrbitalPosition(self):
1152 if self.value == "":
1154 return int(self.value)
1156 orbital_position = property(getOrbitalPosition)
1158 class ConfigSet(ConfigElement):
1159 def __init__(self, choices, default = []):
1160 ConfigElement.__init__(self)
1161 if isinstance(choices, list):
1163 self.choices = choicesList(choices, choicesList.LIST_TYPE_LIST)
1165 assert False, "ConfigSet choices must be a list!"
1170 self.last_value = self.default = default
1171 self.value = default[:]
1173 def toggleChoice(self, choice):
1176 value.remove(choice)
1178 value.append(choice)
1182 def handleKey(self, key):
1183 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
1185 self.toggleChoice(self.choices[self.pos])
1186 elif key == KEY_LEFT:
1188 self.pos = len(self.choices)-1
1191 elif key == KEY_RIGHT:
1192 if self.pos >= len(self.choices)-1:
1196 elif key in (KEY_HOME, KEY_END):
1199 def genString(self, lst):
1202 res += self.description[x]+" "
1206 return self.genString(self.value)
1208 def getMulti(self, selected):
1209 if not selected or self.pos == -1:
1210 return ("text", self.genString(self.value))
1213 ch = self.choices[self.pos]
1214 mem = ch in self.value
1219 val1 = self.genString(tmp[:ind])
1220 val2 = " "+self.genString(tmp[ind+1:])
1222 chstr = " "+self.description[ch]+" "
1224 chstr = "("+self.description[ch]+")"
1225 len_val1 = len(val1)
1226 return ("mtext", val1+chstr+val2, range(len_val1, len_val1 + len(chstr)))
1228 def onDeselect(self, session):
1230 if not self.last_value == self.value:
1232 self.last_value = self.value[:]
1234 def tostring(self, value):
1237 def fromstring(self, val):
1240 description = property(lambda self: descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST))
1242 class ConfigLocations(ConfigElement):
1243 def __init__(self, default = [], visible_width = False):
1244 ConfigElement.__init__(self)
1245 self.visible_width = visible_width
1247 self.default = default
1249 self.mountpoints = []
1250 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
1251 self.value = default[:]
1253 def setValue(self, value):
1254 locations = self.locations
1255 loc = [x[0] for x in locations if x[3]]
1256 add = [x for x in value if not x in loc]
1257 diff = add + [x for x in loc if not x in value]
1258 locations = [x for x in locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
1259 locations.sort(key = lambda x: x[0])
1260 self.locations = locations
1264 self.checkChangedMountpoints()
1265 locations = self.locations
1268 return [x[0] for x in locations if x[3]]
1270 value = property(getValue, setValue)
1272 def tostring(self, value):
1275 def fromstring(self, val):
1279 sv = self.saved_value
1283 tmp = self.fromstring(sv)
1284 locations = [[x, None, False, False] for x in tmp]
1285 self.refreshMountpoints()
1287 if os_path.exists(x[0]):
1288 x[1] = self.getMountpoint(x[0])
1290 self.locations = locations
1293 locations = self.locations
1294 if self.save_disabled or not locations:
1295 self.saved_value = None
1297 self.saved_value = self.tostring([x[0] for x in locations])
1299 def isChanged(self):
1300 sv = self.saved_value
1301 locations = self.locations
1302 if val is None and not locations:
1304 return self.tostring([x[0] for x in locations]) != sv
1306 def mountpointsChanged(self, action, dev):
1307 print "Mounts changed: ", action, dev
1308 mp = dev.mountpoint+"/"
1311 elif action == "remove":
1312 self.removedMount(mp)
1313 self.refreshMountpoints()
1315 def addedMount(self, mp):
1316 for x in self.locations:
1319 elif x[1] == None and os_path.exists(x[0]):
1320 x[1] = self.getMountpoint(x[0])
1323 def removedMount(self, mp):
1324 for x in self.locations:
1328 def refreshMountpoints(self):
1329 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1330 self.mountpoints.sort(key = lambda x: -len(x))
1332 def checkChangedMountpoints(self):
1333 oldmounts = self.mountpoints
1334 self.refreshMountpoints()
1335 newmounts = self.mountpoints
1336 if oldmounts == newmounts:
1339 if not x in newmounts:
1340 self.removedMount(x)
1342 if not x in oldmounts:
1345 def getMountpoint(self, file):
1346 file = os_path.realpath(file)+"/"
1347 for m in self.mountpoints:
1348 if file.startswith(m):
1352 def handleKey(self, key):
1356 self.pos = len(self.value)-1
1357 elif key == KEY_RIGHT:
1359 if self.pos >= len(self.value):
1361 elif key in (KEY_HOME, KEY_END):
1365 return " ".join(self.value)
1367 def getMulti(self, selected):
1369 valstr = " ".join(self.value)
1370 if self.visible_width and len(valstr) > self.visible_width:
1371 return ("text", valstr[0:self.visible_width])
1373 return ("text", valstr)
1379 for val in self.value:
1382 valstr += str(val)+" "
1386 if self.visible_width and len(valstr) > self.visible_width:
1387 if ind1+1 < self.visible_width/2:
1390 off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1391 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1393 return ("mtext", valstr, range(ind1,ind2))
1395 def onDeselect(self, session):
1399 class ConfigNothing(ConfigSelection):
1401 ConfigSelection.__init__(self, choices = [("","")])
1403 # until here, 'saved_value' always had to be a *string*.
1404 # now, in ConfigSubsection, and only there, saved_value
1405 # is a dict, essentially forming a tree.
1407 # config.foo.bar=True
1408 # config.foobar=False
1411 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1414 class ConfigSubsectionContent(object):
1417 # we store a backup of the loaded configuration
1418 # data in self.stored_values, to be able to deploy
1419 # them when a new config element will be added,
1420 # so non-default values are instantly available
1422 # A list, for example:
1423 # config.dipswitches = ConfigSubList()
1424 # config.dipswitches.append(ConfigYesNo())
1425 # config.dipswitches.append(ConfigYesNo())
1426 # config.dipswitches.append(ConfigYesNo())
1427 class ConfigSubList(list, object):
1430 self.stored_values = {}
1440 def getSavedValue(self):
1442 for i, val in enumerate(self):
1443 sv = val.saved_value
1448 def setSavedValue(self, values):
1449 self.stored_values = dict(values)
1450 for (key, val) in self.stored_values.items():
1451 if int(key) < len(self):
1452 self[int(key)].saved_value = val
1454 saved_value = property(getSavedValue, setSavedValue)
1456 def append(self, item):
1458 list.append(self, item)
1459 if i in self.stored_values:
1460 item.saved_value = self.stored_values[i]
1464 return dict([(str(index), value) for index, value in enumerate(self)])
1466 # same as ConfigSubList, just as a dictionary.
1467 # care must be taken that the 'key' has a proper
1468 # str() method, because it will be used in the config
1470 class ConfigSubDict(dict, object):
1473 self.stored_values = {}
1476 for x in self.values():
1480 for x in self.values():
1483 def getSavedValue(self):
1485 for (key, val) in self.items():
1486 sv = val.saved_value
1491 def setSavedValue(self, values):
1492 self.stored_values = dict(values)
1493 for (key, val) in self.items():
1494 if str(key) in self.stored_values:
1495 val = self.stored_values[str(key)]
1497 saved_value = property(getSavedValue, setSavedValue)
1499 def __setitem__(self, key, item):
1500 dict.__setitem__(self, key, item)
1501 if str(key) in self.stored_values:
1502 item.saved_value = self.stored_values[str(key)]
1508 # Like the classes above, just with a more "native"
1511 # some evil stuff must be done to allow instant
1512 # loading of added elements. this is why this class
1515 # we need the 'content' because we overwrite
1517 # If you don't understand this, try adding
1518 # __setattr__ to a usual exisiting class and you will.
1519 class ConfigSubsection(object):
1521 self.__dict__["content"] = ConfigSubsectionContent()
1522 self.content.items = { }
1523 self.content.stored_values = { }
1525 def __setattr__(self, name, value):
1526 if name == "saved_value":
1527 return self.setSavedValue(value)
1528 assert isinstance(value, (ConfigSubsection, ConfigElement, ConfigSubList, ConfigSubDict)), "ConfigSubsections can only store ConfigSubsections, ConfigSubLists, ConfigSubDicts or ConfigElements"
1529 content = self.content
1530 content.items[name] = value
1531 x = content.stored_values.get(name, None)
1533 #print "ok, now we have a new item,", name, "and have the following value for it:", x
1534 value.saved_value = x
1537 def __getattr__(self, name):
1538 return self.content.items[name]
1540 def getSavedValue(self):
1541 res = self.content.stored_values
1542 for (key, val) in self.content.items.items():
1543 sv = val.saved_value
1550 def setSavedValue(self, values):
1551 values = dict(values)
1552 self.content.stored_values = values
1553 for (key, val) in self.content.items.items():
1554 value = values.get(key, None)
1555 if value is not None:
1556 val.saved_value = value
1558 saved_value = property(getSavedValue, setSavedValue)
1561 for x in self.content.items.values():
1565 for x in self.content.items.values():
1569 return self.content.items
1571 # the root config object, which also can "pickle" (=serialize)
1572 # down the whole config tree.
1574 # we try to keep non-existing config entries, to apply them whenever
1575 # a new config entry is added to a subsection
1576 # also, non-existing config entries will be saved, so they won't be
1577 # lost when a config entry disappears.
1578 class Config(ConfigSubsection):
1580 ConfigSubsection.__init__(self)
1582 def pickle_this(self, prefix, topickle, result):
1583 for (key, val) in topickle.items():
1584 name = '.'.join((prefix, key))
1585 if isinstance(val, dict):
1586 self.pickle_this(name, val, result)
1587 elif isinstance(val, tuple):
1588 result += [name, '=', val[0], '\n']
1590 result += [name, '=', val, '\n']
1594 self.pickle_this("config", self.saved_value, result)
1595 return ''.join(result)
1597 def unpickle(self, lines):
1600 if not l or l[0] == '#':
1604 val = l[n+1:].strip()
1606 names = l[:n].split('.')
1607 # if val.find(' ') != -1:
1608 # val = val[:val.find(' ')]
1612 for n in names[:-1]:
1613 base = base.setdefault(n, {})
1615 base[names[-1]] = val
1617 # we inherit from ConfigSubsection, so ...
1618 #object.__setattr__(self, "saved_value", tree["config"])
1619 if "config" in tree:
1620 self.setSavedValue(tree["config"])
1622 def saveToFile(self, filename):
1623 text = self.pickle()
1624 f = open(filename, "w")
1628 def loadFromFile(self, filename):
1629 f = open(filename, "r")
1630 self.unpickle(f.readlines())
1634 config.misc = ConfigSubsection()
1637 CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1641 config.loadFromFile(self.CONFIG_FILE)
1643 print "unable to load config (%s), assuming defaults..." % str(e)
1647 config.saveToFile(self.CONFIG_FILE)
1649 def __resolveValue(self, pickles, cmap):
1651 if cmap.has_key(key):
1652 if len(pickles) > 1:
1653 return self.__resolveValue(pickles[1:], cmap[key].dict())
1655 return str(cmap[key].value)
1658 def getResolvedKey(self, key):
1659 names = key.split('.')
1661 if names[0] == "config":
1662 ret=self.__resolveValue(names[1:], config.content.items)
1663 if ret and len(ret):
1665 print "getResolvedKey", key, "failed !! (Typo??)"
1668 def NoSave(element):
1669 element.disableSave()
1672 configfile = ConfigFile()
1676 def getConfigListEntry(*args):
1677 assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1680 def updateConfigElement(element, newelement):
1681 newelement.value = element.value
1687 #config.bla = ConfigSubsection()
1688 #config.bla.test = ConfigYesNo()
1689 #config.nim = ConfigSubList()
1690 #config.nim.append(ConfigSubsection())
1691 #config.nim[0].bla = ConfigYesNo()
1692 #config.nim.append(ConfigSubsection())
1693 #config.nim[1].bla = ConfigYesNo()
1694 #config.nim[1].blub = ConfigYesNo()
1695 #config.arg = ConfigSubDict()
1696 #config.arg["Hello"] = ConfigYesNo()
1698 #config.arg["Hello"].handleKey(KEY_RIGHT)
1699 #config.arg["Hello"].handleKey(KEY_RIGHT)
1701 ##config.saved_value
1705 #print config.pickle()