increased performance on ConfigSelection and ConfigSet create to speedup enigma2...
[enigma2.git] / lib / python / Components / config.py
old mode 100644 (file)
new mode 100755 (executable)
index c4d4632..1f2975e
@@ -28,12 +28,14 @@ import os
 #
 class ConfigElement(object):
        def __init__(self):
-
                object.__init__(self)
                self.saved_value = None
+               self.last_value = None
                self.save_disabled = False
                self.notifiers = []
+               self.notifiers_final = []
                self.enabled = True
+               self.callNotifiersOnSaveAndCancel = False
 
        # you need to override this to do input validation
        def setValue(self, value):
@@ -66,9 +68,13 @@ class ConfigElement(object):
                        self.saved_value = None
                else:
                        self.saved_value = self.tostring(self.value)
+               if self.callNotifiersOnSaveAndCancel:
+                       self.changed()
 
        def cancel(self):
                self.load()
+               if self.callNotifiersOnSaveAndCancel:
+                       self.changed()
 
        def isChanged(self):
                sv = self.saved_value
@@ -80,10 +86,16 @@ class ConfigElement(object):
                for x in self.notifiers:
                        x(self)
                        
-       def addNotifier(self, notifier, initial_call = True):
+       def changedFinal(self):
+               for x in self.notifiers_final:
+                       x(self)
+                       
+       def addNotifier(self, notifier, initial_call = True, immediate_feedback = True):
                assert callable(notifier), "notifiers must be callable"
-               self.notifiers.append(notifier)
-
+               if immediate_feedback:
+                       self.notifiers.append(notifier)
+               else:
+                       self.notifiers_final.append(notifier)
                # CHECKME:
                # do we want to call the notifier
                #  - at all when adding it? (yes, though optional)
@@ -105,7 +117,9 @@ class ConfigElement(object):
                pass
 
        def onDeselect(self, session):
-               pass
+               if not self.last_value == self.value:
+                       self.changedFinal()
+                       self.last_value = self.value
 
 KEY_LEFT = 0
 KEY_RIGHT = 1
@@ -125,6 +139,104 @@ def getKeyNumber(key):
        assert key in KEY_NUMBERS
        return key - KEY_0
 
+class choicesList(object): # XXX: we might want a better name for this
+       LIST_TYPE_LIST = 1
+       LIST_TYPE_DICT = 2
+
+       def __init__(self, choices, type = None):
+               self.choices = choices
+               if type is None:
+                       if isinstance(choices, list):
+                               self.type = choicesList.LIST_TYPE_LIST
+                       elif isinstance(choices, dict):
+                               self.type = choicesList.LIST_TYPE_DICT
+                       else:
+                               assert False, "choices must be dict or list!"
+               else:
+                       self.type = type
+
+       def __list__(self):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       ret = [isinstance(x, tuple) and x[0] or x for x in self.choices]
+               else:
+                       ret = self.choices.keys()
+               return ret or [""]
+
+       def __iter__(self):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       ret = [isinstance(x, tuple) and x[0] or x for x in self.choices]
+               else:
+                       ret = self.choices
+               return iter(ret or [""])
+
+       def __len__(self):
+               return len(self.choices) or 1
+
+       def __getitem__(self, index):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       ret = self.choices[index]
+                       if isinstance(ret, tuple):
+                               ret = ret[0]
+                       return ret
+               return self.choices.keys()[index]
+
+       def index(self, value):
+               return self.__list__().index(value)
+
+       def __setitem__(self, index, value):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       if isinstance(self.choices[index], tuple):
+                               self.choices[index] = (value, self.choices[index][1])
+                       else:
+                               self.choices[index] = value
+               else:
+                       key = self.choices.keys()[index]
+                       orig = self.choices[key]
+                       del self.choices[key]
+                       self.choices[value] = orig
+
+       def default(self):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       default = self.choices[0]
+                       if isinstance(default, tuple):
+                               default = default[0]
+               else:
+                       default = self.choices.keys()[0]
+               return default
+
+class descriptionList(choicesList): # XXX: we might want a better name for this
+       def __list__(self):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       ret = [isinstance(x, tuple) and x[1] or x for x in self.choices]
+               else:
+                       ret = self.choices.values()
+               return ret or [""]
+
+       def __iter__(self):
+               return iter(self.__list__())
+
+       def __getitem__(self, index):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       for x in self.choices:
+                               if isinstance(x, tuple):
+                                       if x[0] is index:
+                                               return str(x[1])
+                               elif x is index:
+                                       return str(x)
+                       return str(index) # Fallback!
+               else:
+                       return str(self.choices.get(index, ""))
+
+       def __setitem__(self, index, value):
+               if self.type is choicesList.LIST_TYPE_LIST:
+                       i = self.index(index)
+                       if isinstance(self.choices[i], tuple):
+                               self.choices[i] = (self.choices[i][0], value)
+                       else:
+                               self.choices[i] = value
+               else:
+                       self.choices[index] = value
+
 #
 # ConfigSelection is a "one of.."-type.
 # it has the "choices", usually a list, which contains
@@ -136,51 +248,30 @@ def getKeyNumber(key):
 class ConfigSelection(ConfigElement):
        def __init__(self, choices, default = None):
                ConfigElement.__init__(self)
-               self._value = None
-               self.setChoices(choices, default)
 
-       def setChoices(self, choices, default = None):
-               self.choices = []
-               self.description = {}
-               
-               if isinstance(choices, list):
-                       for x in choices:
-                               if isinstance(x, tuple):
-                                       self.choices.append(x[0])
-                                       self.description[x[0]] = x[1]
-                               else:
-                                       self.choices.append(x)
-                                       self.description[x] = x
-               elif isinstance(choices, dict):
-                       for (key, val) in choices.items():
-                               self.choices.append(key)
-                               self.description[key] = val
-               else:
-                       assert False, "ConfigSelection choices must be dict or list!"
-               
-               #assert len(self.choices), "you can't have an empty configselection"
-               if len(self.choices) == 0:
-                       self.choices = [""]
-                       self.description[""] = ""
+               # this is an exakt copy of def setChoices.. but we save the call overhead
+               self.choices = choicesList(choices)
 
                if default is None:
-                       default = self.choices[0]
+                       default = self.choices.default()
 
-               assert default in self.choices, "default must be in choice list, but " + repr(default) + " is not!"
-               for x in self.choices:
-                       assert isinstance(x, str), "ConfigSelection choices must be strings"
-               
-               self.default = default
+               self.default = self._value = self.last_value = default
+               self.changed()
+
+       def setChoices(self, choices, default = None):
+               self.choices = choicesList(choices)
+
+               if default is None:
+                       default = self.choices.default()
 
-               if self.value == None or not self.value in self.choices:
-                       self.value = default
+               self.default = self._value = self.last_value = default
+               self.changed()
 
        def setValue(self, value):
                if value in self.choices:
                        self._value = value
                else:
                        self._value = self.default
-               
                self.changed()
 
        def tostring(self, val):
@@ -191,9 +282,8 @@ class ConfigSelection(ConfigElement):
 
        def setCurrentText(self, text):
                i = self.choices.index(self.value)
-               del self.description[self.choices[i]]
                self.choices[i] = text
-               self.description[text] = text
+               descriptionList(self.choices.choices, self.choices.type)[text] = text
                self._value = text
 
        value = property(getValue, setValue)
@@ -222,13 +312,13 @@ class ConfigSelection(ConfigElement):
                self.value = self.choices[(i + 1) % nchoices]
 
        def getText(self):
-               descr = self.description[self.value]
+               descr = descriptionList(self.choices.choices, self.choices.type)[self.value]
                if len(descr):
                        return _(descr)
                return descr
 
        def getMulti(self, selected):
-               descr = self.description[self.value]
+               descr = descriptionList(self.choices.choices, self.choices.type)[self.value]
                if len(descr):
                        return ("text", _(descr))
                return ("text", descr)
@@ -237,11 +327,12 @@ class ConfigSelection(ConfigElement):
        def getHTML(self, id):
                res = ""
                for v in self.choices:
+                       descr = descriptionList(self.choices.choices, self.choices.type)[v]
                        if self.value == v:
                                checked = 'checked="checked" '
                        else:
                                checked = ''
-                       res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + self.description[v] + "</input></br>\n"
+                       res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + descr + "</input></br>\n"
                return res;
 
        def unsafeAssign(self, value):
@@ -257,7 +348,8 @@ class ConfigBoolean(ConfigElement):
        def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
                ConfigElement.__init__(self)
                self.descriptions = descriptions
-               self.value = self.default = default
+               self.value = self.last_value = self.default = default
+
        def handleKey(self, key):
                if key in [KEY_LEFT, KEY_RIGHT]:
                        self.value = not self.value
@@ -304,6 +396,11 @@ class ConfigBoolean(ConfigElement):
                else:
                        self.value = False
 
+       def onDeselect(self, session):
+               if not self.last_value == self.value:
+                       self.changedFinal()
+                       self.last_value = self.value
+
 class ConfigYesNo(ConfigBoolean):
        def __init__(self, default = False):
                ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
@@ -321,7 +418,7 @@ class ConfigDateTime(ConfigElement):
                ConfigElement.__init__(self)
                self.increment = increment
                self.formatstring = formatstring
-               self.value = self.default = int(default)
+               self.value = self.last_value = self.default = int(default)
 
        def handleKey(self, key):
                if key == KEY_LEFT:
@@ -362,6 +459,7 @@ class ConfigSequence(ConfigElement):
                
                self.default = default
                self.value = copy.copy(default)
+               self.last_value = copy.copy(default)
                
                self.endNotifier = []
 
@@ -502,27 +600,93 @@ class ConfigSequence(ConfigElement):
        def fromstring(self, value):
                return [int(x) for x in value.split(self.seperator)]
 
+       def onDeselect(self, session):
+               if not self.last_value == self._value:
+                       self.changedFinal()
+                       self.last_value = copy.copy(self._value)
+
 class ConfigIP(ConfigSequence):
-       def __init__(self, default):
+       def __init__(self, default, auto_jump = False):
                ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
-       
-       def getHTML(self, id):
-               # we definitely don't want leading zeros
-               return '.'.join(["%d" % d for d in self.value])
-       
+               self.block_len = []
+               for x in self.limits:
+                       self.block_len.append(len(str(x[1])))
+               self.marked_block = 0
+               self.overwrite = True
+               self.auto_jump = auto_jump
+
+       def handleKey(self, key):
+               
+               if key == KEY_LEFT:
+                       if self.marked_block > 0:
+                               self.marked_block -= 1
+                       self.overwrite = True
+
+               if key == KEY_RIGHT:
+                       if self.marked_block < len(self.limits)-1:
+                               self.marked_block += 1
+                       self.overwrite = True
+
+               if key == KEY_HOME:
+                       self.marked_block = 0
+                       self.overwrite = True
+
+               if key == KEY_END:
+                       self.marked_block = len(self.limits)-1
+                       self.overwrite = True
+
+               if key in KEY_NUMBERS or key == KEY_ASCII:
+                       if key == KEY_ASCII:
+                               code = getPrevAsciiCode()
+                               if code < 48 or code > 57:
+                                       return
+                               number = code - 48
+                       else:   
+                               number = getKeyNumber(key)
+                       oldvalue = self._value[self.marked_block]
+                       
+                       if self.overwrite:
+                               self._value[self.marked_block] = number
+                               self.overwrite = False          
+                       else:
+                               oldvalue *= 10
+                               newvalue = oldvalue + number
+                               if self.auto_jump and newvalue > self.limits[self.marked_block][1] and self.marked_block < len(self.limits)-1:
+                                       self.handleKey(KEY_RIGHT)
+                                       self.handleKey(key)
+                                       return
+                               else:
+                                       self._value[self.marked_block] = newvalue
+
+                       if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
+                               self.handleKey(KEY_RIGHT)
+
+                       self.validate()
+                       self.changed()
+
        def genText(self):
                value = ""
-               mPos = self.marked_pos
-               num = 0;
+               block_strlen = []
                for i in self._value:
+                       block_strlen.append(len(str(i)))        
                        if len(value):
                                value += self.seperator
-                               if mPos >= len(value) - 1:
-                                       mPos += 1
-                       value += (" " * (len(str(self.limits[num][1]))-len(str(i))))
                        value += str(i)
-                       num += 1
-               return (value, mPos)
+               leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
+               rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
+               mBlock = range(leftPos, rightPos)
+               return (value, mBlock)
+       
+       def getMulti(self, selected):
+               (value, mBlock) = self.genText()
+               if self.enabled:
+                       return ("mtext"[1-selected:], value, mBlock)
+               else:
+                       return ("text", value)
+
+       def getHTML(self, id):
+               # we definitely don't want leading zeros
+               return '.'.join(["%d" % d for d in self.value])
 
 class ConfigMAC(ConfigSequence):
        def __init__(self, default):
@@ -538,6 +702,36 @@ class ConfigClock(ConfigSequence):
                t = time.localtime(default)
                ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
 
+       def increment(self):
+               # Check if Minutes maxed out
+               if self._value[1] == 59:
+                       # Increment Hour, reset Minutes
+                       if self._value[0] < 23:
+                               self._value[0] += 1
+                       else:
+                               self._value[0] = 0
+                       self._value[1] = 0
+               else:
+                       # Increment Minutes
+                       self._value[1] += 1
+               # Trigger change
+               self.changed()
+
+       def decrement(self):
+               # Check if Minutes is minimum
+               if self._value[1] == 0:
+                       # Decrement Hour, set Minutes to 59
+                       if self._value[0] > 0:
+                               self._value[0] -= 1
+                       else:
+                               self._value[0] = 23
+                       self._value[1] = 59
+               else:
+                       # Decrement Minutes
+                       self._value[1] -= 1
+               # Trigger change
+               self.changed()
+
 class ConfigInteger(ConfigSequence):
        def __init__(self, default, limits = (0, 9999999999)):
                ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
@@ -591,7 +785,7 @@ class ConfigText(ConfigElement, NumericalTextInput):
                self.offset = 0
                self.overwrite = fixed_size
                self.help_window = None
-               self.value = self.default = default
+               self.value = self.last_value = self.default = default
 
        def validateMarker(self):
                if self.fixed_size:
@@ -716,12 +910,12 @@ class ConfigText(ConfigElement, NumericalTextInput):
 
        def getValue(self):
                return self.text.encode("utf-8")
-               
+
        def setValue(self, val):
                try:
                        self.text = val.decode("utf-8")
                except UnicodeDecodeError:
-                       self.text = val
+                       self.text = val.decode("utf-8", "ignore")
                        print "Broken UTF8!"
 
        value = property(getValue, setValue)
@@ -757,6 +951,9 @@ class ConfigText(ConfigElement, NumericalTextInput):
                if self.help_window:
                        session.deleteDialog(self.help_window)
                        self.help_window = None
+               if not self.last_value == self.value:
+                       self.changedFinal()
+                       self.last_value = self.value
 
        def getHTML(self, id):
                return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
@@ -831,12 +1028,40 @@ class ConfigNumber(ConfigText):
        def onDeselect(self, session):
                self.marked_pos = 0
                self.offset = 0
+               if not self.last_value == self.value:
+                       self.changedFinal()
+                       self.last_value = self.value
+
+class ConfigSearchText(ConfigText):
+       def __init__(self, default = "", fixed_size = False, visible_width = False):
+               ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
+               NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False, search = True)
+
+class ConfigDirectory(ConfigText):
+       def __init__(self, default="", visible_width=60):
+               ConfigText.__init__(self, default, fixed_size = True, visible_width = visible_width)
+       def handleKey(self, key):
+               pass
+       def getValue(self):
+               if self.text == "":
+                       return None
+               else:
+                       return ConfigText.getValue(self)
+       def setValue(self, val):
+               if val == None:
+                       val = ""
+               ConfigText.setValue(self, val)
+       def getMulti(self, selected):
+               if self.text == "":
+                       return ("mtext"[1-selected:], _("List of Storage Devices"), range(0))
+               else:
+                       return ConfigText.getMulti(self, selected)
 
 # a slider.
 class ConfigSlider(ConfigElement):
        def __init__(self, default = 0, increment = 1, limits = (0, 100)):
                ConfigElement.__init__(self)
-               self.value = self.default = default
+               self.value = self.last_value = self.default = default
                self.min = limits[0]
                self.max = limits[1]
                self.increment = increment
@@ -888,28 +1113,17 @@ class ConfigSatlist(ConfigSelection):
 class ConfigSet(ConfigElement):
        def __init__(self, choices, default = []):
                ConfigElement.__init__(self)
-               self.choices = []
-               self.description = {}
                if isinstance(choices, list):
                        choices.sort()
-                       for x in choices:
-                               if isinstance(x, tuple):
-                                       self.choices.append(x[0])
-                                       self.description[x[0]] = str(x[1])
-                               else:
-                                       self.choices.append(x)
-                                       self.description[x] = str(x)
+                       self.choices = choicesList(choices, choicesList.LIST_TYPE_LIST)
                else:
                        assert False, "ConfigSet choices must be a list!"
-               if len(self.choices) == 0:
-                       self.choices = [""]
-                       self.description[""] = ""
                if default is None:
                        default = []
                self.pos = -1
                default.sort()
-               self.default = default
-               self.value = default+[]
+               self.last_value = self.default = default
+               self.value = default[:]
 
        def toggleChoice(self, choice):
                if choice in self.value:
@@ -917,6 +1131,7 @@ class ConfigSet(ConfigElement):
                else:
                        self.value.append(choice)
                        self.value.sort()
+               self.changed()
 
        def handleKey(self, key):
                if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
@@ -935,8 +1150,9 @@ class ConfigSet(ConfigElement):
 
        def genString(self, lst):
                res = ""
+               description = descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST)
                for x in lst:
-                       res += self.description[x]+" "
+                       res += description[x]+" "
                return res
 
        def getText(self):
@@ -946,7 +1162,8 @@ class ConfigSet(ConfigElement):
                if not selected or self.pos == -1:
                        return ("text", self.genString(self.value))
                else:
-                       tmp = self.value+[]
+                       description = descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST)
+                       tmp = self.value[:]
                        ch = self.choices[self.pos]
                        mem = ch in self.value
                        if not mem:
@@ -956,14 +1173,16 @@ class ConfigSet(ConfigElement):
                        val1 = self.genString(tmp[:ind])
                        val2 = " "+self.genString(tmp[ind+1:])
                        if mem:
-                               chstr = " "+self.description[ch]+" "
+                               chstr = " "+description[ch]+" "
                        else:
-                               chstr = "("+self.description[ch]+")"
+                               chstr = "("+description[ch]+")"
                        return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
 
        def onDeselect(self, session):
                self.pos = -1
-               self.changed()
+               if not self.last_value == self.value:
+                       self.changedFinal()
+                       self.last_value = self.value[:]
                
        def tostring(self, value):
                return str(value)
@@ -980,6 +1199,7 @@ class ConfigLocations(ConfigElement):
                self.locations = []
                self.mountpoints = []
                harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
+               self.value = default+[]
 
        def setValue(self, value):
                loc = [x[0] for x in self.locations if x[3]]