lib/python/Components/config.py

   1 import time
   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
   6 import copy
   7 import os
   8
   9 # ConfigElement, the base class of all ConfigElements.
  10
  11 # it stores:
  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
  21 #
  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)
  27 #            or invalid.
  28 #
  29 class ConfigElement(object):
  30         def __init__(self):
  31                 object.__init__(self)
  32                 self.saved_value = None
  33                 self.last_value = None
  34                 self.save_disabled = False
  35                 self.notifiers = []
  36                 self.notifiers_final = []
  37                 self.enabled = True
  38                 self.callNotifiersOnSaveAndCancel = False
  39
  40         # you need to override this to do input validation
  41         def setValue(self, value):
  42                 self._value = value
  43                 self.changed()
  44
  45         def getValue(self):
  46                 return self._value
  47
  48         value = property(getValue, setValue)
  49
  50         # you need to override this if self.value is not a string
  51         def fromstring(self, value):
  52                 return value
  53
  54         # you can overide this for fancy default handling
  55         def load(self):
  56                 sv = self.saved_value
  57                 if sv is None:
  58                         self.value = self.default
  59                 else:
  60                         self.value = self.fromstring(sv)
  61
  62         def tostring(self, value):
  63                 return str(value)
  64
  65         # you need to override this if str(self.value) doesn't work
  66         def save(self):
  67                 if self.save_disabled or self.value == self.default:
  68                         self.saved_value = None
  69                 else:
  70                         self.saved_value = self.tostring(self.value)
  71                 if self.callNotifiersOnSaveAndCancel:
  72                         self.changed()
  73
  74         def cancel(self):
  75                 self.load()
  76                 if self.callNotifiersOnSaveAndCancel:
  77                         self.changed()
  78
  79         def isChanged(self):
  80                 sv = self.saved_value
  81                 if sv is None and self.value == self.default:
  82                         return False
  83                 return self.tostring(self.value) != sv
  84
  85         def changed(self):
  86                 for x in self.notifiers:
  87                         x(self)
  88
  89         def changedFinal(self):
  90                 for x in self.notifiers_final:
  91                         x(self)
  92
  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)
  97                 else:
  98                         self.notifiers_final.append(notifier)
  99                 # CHECKME:
 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.)
 107                 if initial_call:
 108                         notifier(self)
 109
 110         def disableSave(self):
 111                 self.save_disabled = True
 112
 113         def __call__(self, selected):
 114                 return self.getMulti(selected)
 115
 116         def onSelect(self, session):
 117                 pass
 118
 119         def onDeselect(self, session):
 120                 if not self.last_value == self.value:
 121                         self.changedFinal()
 122                         self.last_value = self.value
 123
 124 KEY_LEFT = 0
 125 KEY_RIGHT = 1
 126 KEY_OK = 2
 127 KEY_DELETE = 3
 128 KEY_BACKSPACE = 4
 129 KEY_HOME = 5
 130 KEY_END = 6
 131 KEY_TOGGLEOW = 7
 132 KEY_ASCII = 8
 133 KEY_TIMEOUT = 9
 134 KEY_NUMBERS = range(12, 12+10)
 135 KEY_0 = 12
 136 KEY_9 = 12+9
 137
 138 def getKeyNumber(key):
 139         assert key in KEY_NUMBERS
 140         return key - KEY_0
 141
 142 class choicesList(object): # XXX: we might want a better name for this
 143         LIST_TYPE_LIST = 1
 144         LIST_TYPE_DICT = 2
 145
 146         def __init__(self, choices, type = None):
 147                 self.choices = choices
 148                 if type is None:
 149                         if isinstance(choices, list):
 150                                 self.type = choicesList.LIST_TYPE_LIST
 151                         elif isinstance(choices, dict):
 152                                 self.type = choicesList.LIST_TYPE_DICT
 153                         else:
 154                                 assert False, "choices must be dict or list!"
 155                 else:
 156                         self.type = type
 157
 158         def __list__(self):
 159                 if self.type is choicesList.LIST_TYPE_LIST:
 160                         ret = [isinstance(x, tuple) and x[0] or x for x in self.choices]
 161                 else:
 162                         ret = self.choices.keys()
 163                 return ret or [""]
 164
 165         def __iter__(self):
 166                 if self.type is choicesList.LIST_TYPE_LIST:
 167                         ret = [isinstance(x, tuple) and x[0] or x for x in self.choices]
 168                 else:
 169                         ret = self.choices
 170                 return iter(ret or [""])
 171
 172         def __len__(self):
 173                 return len(self.choices) or 1
 174
 175         def __getitem__(self, index):
 176                 if self.type is choicesList.LIST_TYPE_LIST:
 177                         ret = self.choices[index]
 178                         if isinstance(ret, tuple):
 179                                 ret = ret[0]
 180                         return ret
 181                 return self.choices.keys()[index]
 182
 183         def index(self, value):
 184                 return self.__list__().index(value)
 185
 186         def __setitem__(self, index, value):
 187                 if self.type is choicesList.LIST_TYPE_LIST:
 188                         if isinstance(self.choices[index], tuple):
 189                                 self.choices[index] = (value, self.choices[index][1])
 190                         else:
 191                                 self.choices[index] = value
 192                 else:
 193                         key = self.choices.keys()[index]
 194                         orig = self.choices[key]
 195                         del self.choices[key]
 196                         self.choices[value] = orig
 197
 198         def default(self):
 199                 if self.type is choicesList.LIST_TYPE_LIST:
 200                         default = self.choices[0]
 201                         if isinstance(default, tuple):
 202                                 default = default[0]
 203                 else:
 204                         default = self.choices.keys()[0]
 205                 return default
 206
 207 class descriptionList(choicesList): # XXX: we might want a better name for this
 208         def __list__(self):
 209                 if self.type is choicesList.LIST_TYPE_LIST:
 210                         ret = [isinstance(x, tuple) and x[1] or x for x in self.choices]
 211                 else:
 212                         ret = self.choices.values()
 213                 return ret or [""]
 214
 215         def __iter__(self):
 216                 return iter(self.__list__())
 217
 218         def __getitem__(self, index):
 219                 if self.type is choicesList.LIST_TYPE_LIST:
 220                         for x in self.choices:
 221                                 if isinstance(x, tuple):
 222                                         if x[0] is index:
 223                                                 return str(x[1])
 224                                 elif x is index:
 225                                         return str(x)
 226                         return str(index) # Fallback!
 227                 else:
 228                         return str(self.choices.get(index, ""))
 229
 230         def __setitem__(self, index, value):
 231                 if self.type is choicesList.LIST_TYPE_LIST:
 232                         i = self.index(index)
 233                         if isinstance(self.choices[i], tuple):
 234                                 self.choices[i] = (self.choices[i][0], value)
 235                         else:
 236                                 self.choices[i] = value
 237                 else:
 238                         self.choices[index] = value
 239
 240 #
 241 # ConfigSelection is a "one of.."-type.
 242 # it has the "choices", usually a list, which contains
 243 # (id, desc)-tuples (or just only the ids, in case the id
 244 # will be used as description)
 245 #
 246 # all ids MUST be plain strings.
 247 #
 248 class ConfigSelection(ConfigElement):
 249         def __init__(self, choices, default = None):
 250                 ConfigElement.__init__(self)
 251
 252                 # this is an exakt copy of def setChoices.. but we save the call overhead
 253                 self.choices = choicesList(choices)
 254
 255                 if default is None:
 256                         default = self.choices.default()
 257
 258                 self.default = self._value = self.last_value = default
 259                 self.changed()
 260
 261         def setChoices(self, choices, default = None):
 262                 self.choices = choicesList(choices)
 263
 264                 if default is None:
 265                         default = self.choices.default()
 266
 267                 self.default = self._value = self.last_value = default
 268                 self.changed()
 269
 270         def setValue(self, value):
 271                 if value in self.choices:
 272                         self._value = value
 273                 else:
 274                         self._value = self.default
 275                 self.changed()
 276
 277         def tostring(self, val):
 278                 return val
 279
 280         def getValue(self):
 281                 return self._value
 282
 283         def setCurrentText(self, text):
 284                 i = self.choices.index(self.value)
 285                 self.choices[i] = text
 286                 descriptionList(self.choices.choices, self.choices.type)[text] = text
 287                 self._value = text
 288
 289         value = property(getValue, setValue)
 290
 291         def getIndex(self):
 292                 return self.choices.index(self.value)
 293
 294         index = property(getIndex)
 295
 296         # GUI
 297         def handleKey(self, key):
 298                 nchoices = len(self.choices)
 299                 i = self.choices.index(self.value)
 300                 if key == KEY_LEFT:
 301                         self.value = self.choices[(i + nchoices - 1) % nchoices]
 302                 elif key == KEY_RIGHT:
 303                         self.value = self.choices[(i + 1) % nchoices]
 304                 elif key == KEY_HOME:
 305                         self.value = self.choices[0]
 306                 elif key == KEY_END:
 307                         self.value = self.choices[nchoices - 1]
 308
 309         def selectNext(self):
 310                 nchoices = len(self.choices)
 311                 i = self.choices.index(self.value)
 312                 self.value = self.choices[(i + 1) % nchoices]
 313
 314         def getText(self):
 315                 descr = descriptionList(self.choices.choices, self.choices.type)[self.value]
 316                 if len(descr):
 317                         return _(descr)
 318                 return descr
 319
 320         def getMulti(self, selected):
 321                 descr = descriptionList(self.choices.choices, self.choices.type)[self.value]
 322                 if len(descr):
 323                         return ("text", _(descr))
 324                 return ("text", descr)
 325
 326         # HTML
 327         def getHTML(self, id):
 328                 res = ""
 329                 for v in self.choices:
 330                         descr = descriptionList(self.choices.choices, self.choices.type)[v]
 331                         if self.value == v:
 332                                 checked = 'checked="checked" '
 333                         else:
 334                                 checked = ''
 335                         res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + descr + "</input></br>\n"
 336                 return res;
 337
 338         def unsafeAssign(self, value):
 339                 # setValue does check if value is in choices. This is safe enough.
 340                 self.value = value
 341
 342 # a binary decision.
 343 #
 344 # several customized versions exist for different
 345 # descriptions.
 346 #
 347 class ConfigBoolean(ConfigElement):
 348         def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
 349                 ConfigElement.__init__(self)
 350                 self.descriptions = descriptions
 351                 self.value = self.last_value = self.default = default
 352
 353         def handleKey(self, key):
 354                 if key in [KEY_LEFT, KEY_RIGHT]:
 355                         self.value = not self.value
 356                 elif key == KEY_HOME:
 357                         self.value = False
 358                 elif key == KEY_END:
 359                         self.value = True
 360
 361         def getText(self):
 362                 descr = self.descriptions[self.value]
 363                 if len(descr):
 364                         return _(descr)
 365                 return descr
 366
 367         def getMulti(self, selected):
 368                 descr = self.descriptions[self.value]
 369                 if len(descr):
 370                         return ("text", _(descr))
 371                 return ("text", descr)
 372
 373         def tostring(self, value):
 374                 if not value:
 375                         return "false"
 376                 else:
 377                         return "true"
 378
 379         def fromstring(self, val):
 380                 if val == "true":
 381                         return True
 382                 else:
 383                         return False
 384
 385         def getHTML(self, id):
 386                 if self.value:
 387                         checked = ' checked="checked"'
 388                 else:
 389                         checked = ''
 390                 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
 391
 392         # this is FLAWED. and must be fixed.
 393         def unsafeAssign(self, value):
 394                 if value == "1":
 395                         self.value = True
 396                 else:
 397                         self.value = False
 398
 399         def onDeselect(self, session):
 400                 if not self.last_value == self.value:
 401                         self.changedFinal()
 402                         self.last_value = self.value
 403
 404 class ConfigYesNo(ConfigBoolean):
 405         def __init__(self, default = False):
 406                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
 407
 408 class ConfigOnOff(ConfigBoolean):
 409         def __init__(self, default = False):
 410                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
 411
 412 class ConfigEnableDisable(ConfigBoolean):
 413         def __init__(self, default = False):
 414                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
 415
 416 class ConfigDateTime(ConfigElement):
 417         def __init__(self, default, formatstring, increment = 86400):
 418                 ConfigElement.__init__(self)
 419                 self.increment = increment
 420                 self.formatstring = formatstring
 421                 self.value = self.last_value = self.default = int(default)
 422
 423         def handleKey(self, key):
 424                 if key == KEY_LEFT:
 425                         self.value = self.value - self.increment
 426                 elif key == KEY_RIGHT:
 427                         self.value = self.value + self.increment
 428                 elif key == KEY_HOME or key == KEY_END:
 429                         self.value = self.default
 430
 431         def getText(self):
 432                 return time.strftime(self.formatstring, time.localtime(self.value))
 433
 434         def getMulti(self, selected):
 435                 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
 436
 437         def fromstring(self, val):
 438                 return int(val)
 439
 440 # *THE* mighty config element class
 441 #
 442 # allows you to store/edit a sequence of values.
 443 # can be used for IP-addresses, dates, plain integers, ...
 444 # several helper exist to ease this up a bit.
 445 #
 446 class ConfigSequence(ConfigElement):
 447         def __init__(self, seperator, limits, censor_char = "", default = None):
 448                 ConfigElement.__init__(self)
 449                 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
 450                 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
 451                 #assert isinstance(default, list), "default must be a list"
 452                 #assert isinstance(default[0], int), "list must contain numbers"
 453                 #assert len(default) == len(limits), "length must match"
 454
 455                 self.marked_pos = 0
 456                 self.seperator = seperator
 457                 self.limits = limits
 458                 self.censor_char = censor_char
 459
 460                 self.default = default
 461                 self.value = copy.copy(default)
 462                 self.last_value = copy.copy(default)
 463
 464                 self.endNotifier = []
 465
 466         def validate(self):
 467                 max_pos = 0
 468                 num = 0
 469                 for i in self._value:
 470                         max_pos += len(str(self.limits[num][1]))
 471
 472                         if self._value[num] < self.limits[num][0]:
 473                                 self._value[num] = self.limits[num][0]
 474
 475                         if self._value[num] > self.limits[num][1]:
 476                                 self._value[num] = self.limits[num][1]
 477
 478                         num += 1
 479
 480                 if self.marked_pos >= max_pos:
 481                         for x in self.endNotifier:
 482                                 x(self)
 483                         self.marked_pos = max_pos - 1
 484
 485                 if self.marked_pos < 0:
 486                         self.marked_pos = 0
 487
 488         def validatePos(self):
 489                 if self.marked_pos < 0:
 490                         self.marked_pos = 0
 491
 492                 total_len = sum([len(str(x[1])) for x in self.limits])
 493
 494                 if self.marked_pos >= total_len:
 495                         self.marked_pos = total_len - 1
 496
 497         def addEndNotifier(self, notifier):
 498                 self.endNotifier.append(notifier)
 499
 500         def handleKey(self, key):
 501                 if key == KEY_LEFT:
 502                         self.marked_pos -= 1
 503                         self.validatePos()
 504
 505                 if key == KEY_RIGHT:
 506                         self.marked_pos += 1
 507                         self.validatePos()
 508
 509                 if key == KEY_HOME:
 510                         self.marked_pos = 0
 511                         self.validatePos()
 512
 513                 if key == KEY_END:
 514                         max_pos = 0
 515                         num = 0
 516                         for i in self._value:
 517                                 max_pos += len(str(self.limits[num][1]))
 518                                 num += 1
 519                         self.marked_pos = max_pos - 1
 520                         self.validatePos()
 521
 522                 if key in KEY_NUMBERS or key == KEY_ASCII:
 523                         if key == KEY_ASCII:
 524                                 code = getPrevAsciiCode()
 525                                 if code < 48 or code > 57:
 526                                         return
 527                                 number = code - 48
 528                         else:
 529                                 number = getKeyNumber(key)
 530
 531                         block_len = []
 532                         for x in self.limits:
 533                                 block_len.append(len(str(x[1])))
 534
 535                         total_len = sum(block_len)
 536
 537                         pos = 0
 538                         blocknumber = 0
 539                         block_len_total = [0, ]
 540                         for x in block_len:
 541                                 pos += block_len[blocknumber]
 542                                 block_len_total.append(pos)
 543                                 if pos - 1 >= self.marked_pos:
 544                                         pass
 545                                 else:
 546                                         blocknumber += 1
 547
 548                         # length of numberblock
 549                         number_len = len(str(self.limits[blocknumber][1]))
 550
 551                         # position in the block
 552                         posinblock = self.marked_pos - block_len_total[blocknumber]
 553
 554                         oldvalue = self._value[blocknumber]
 555                         olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
 556                         newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
 557
 558                         self._value[blocknumber] = newvalue
 559                         self.marked_pos += 1
 560
 561                         self.validate()
 562                         self.changed()
 563
 564         def genText(self):
 565                 value = ""
 566                 mPos = self.marked_pos
 567                 num = 0;
 568                 for i in self._value:
 569                         if len(value):  #fixme no heading separator possible
 570                                 value += self.seperator
 571                                 if mPos >= len(value) - 1:
 572                                         mPos += 1
 573
 574                         if self.censor_char == "":
 575                                 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
 576                         else:
 577                                 value += (self.censor_char * len(str(self.limits[num][1])))
 578                         num += 1
 579                 return (value, mPos)
 580
 581         def getText(self):
 582                 (value, mPos) = self.genText()
 583                 return value
 584
 585         def getMulti(self, selected):
 586                 (value, mPos) = self.genText()
 587                         # only mark cursor when we are selected
 588                         # (this code is heavily ink optimized!)
 589                 if self.enabled:
 590                         return ("mtext"[1-selected:], value, [mPos])
 591                 else:
 592                         return ("text", value)
 593
 594         def tostring(self, val):
 595                 return self.seperator.join([self.saveSingle(x) for x in val])
 596
 597         def saveSingle(self, v):
 598                 return str(v)
 599
 600         def fromstring(self, value):
 601                 return [int(x) for x in value.split(self.seperator)]
 602
 603         def onDeselect(self, session):
 604                 if not self.last_value == self._value:
 605                         self.changedFinal()
 606                         self.last_value = copy.copy(self._value)
 607
 608 class ConfigIP(ConfigSequence):
 609         def __init__(self, default, auto_jump = False):
 610                 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
 611                 self.block_len = []
 612                 for x in self.limits:
 613                         self.block_len.append(len(str(x[1])))
 614                 self.marked_block = 0
 615                 self.overwrite = True
 616                 self.auto_jump = auto_jump
 617
 618         def handleKey(self, key):
 619
 620                 if key == KEY_LEFT:
 621                         if self.marked_block > 0:
 622                                 self.marked_block -= 1
 623                         self.overwrite = True
 624
 625                 if key == KEY_RIGHT:
 626                         if self.marked_block < len(self.limits)-1:
 627                                 self.marked_block += 1
 628                         self.overwrite = True
 629
 630                 if key == KEY_HOME:
 631                         self.marked_block = 0
 632                         self.overwrite = True
 633
 634                 if key == KEY_END:
 635                         self.marked_block = len(self.limits)-1
 636                         self.overwrite = True
 637
 638                 if key in KEY_NUMBERS or key == KEY_ASCII:
 639                         if key == KEY_ASCII:
 640                                 code = getPrevAsciiCode()
 641                                 if code < 48 or code > 57:
 642                                         return
 643                                 number = code - 48
 644                         else:
 645                                 number = getKeyNumber(key)
 646                         oldvalue = self._value[self.marked_block]
 647
 648                         if self.overwrite:
 649                                 self._value[self.marked_block] = number
 650                                 self.overwrite = False
 651                         else:
 652                                 oldvalue *= 10
 653                                 newvalue = oldvalue + number
 654                                 if self.auto_jump and newvalue > self.limits[self.marked_block][1] and self.marked_block < len(self.limits)-1:
 655                                         self.handleKey(KEY_RIGHT)
 656                                         self.handleKey(key)
 657                                         return
 658                                 else:
 659                                         self._value[self.marked_block] = newvalue
 660
 661                         if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
 662                                 self.handleKey(KEY_RIGHT)
 663
 664                         self.validate()
 665                         self.changed()
 666
 667         def genText(self):
 668                 value = ""
 669                 block_strlen = []
 670                 for i in self._value:
 671                         block_strlen.append(len(str(i)))
 672                         if len(value):
 673                                 value += self.seperator
 674                         value += str(i)
 675                 leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
 676                 rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
 677                 mBlock = range(leftPos, rightPos)
 678                 return (value, mBlock)
 679
 680         def getMulti(self, selected):
 681                 (value, mBlock) = self.genText()
 682                 if self.enabled:
 683                         return ("mtext"[1-selected:], value, mBlock)
 684                 else:
 685                         return ("text", value)
 686
 687         def getHTML(self, id):
 688                 # we definitely don't want leading zeros
 689                 return '.'.join(["%d" % d for d in self.value])
 690
 691 class ConfigMAC(ConfigSequence):
 692         def __init__(self, default):
 693                 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
 694
 695 class ConfigPosition(ConfigSequence):
 696         def __init__(self, default, args):
 697                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
 698
 699 class ConfigClock(ConfigSequence):
 700         def __init__(self, default):
 701                 import time
 702                 t = time.localtime(default)
 703                 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
 704
 705         def increment(self):
 706                 # Check if Minutes maxed out
 707                 if self._value[1] == 59:
 708                         # Increment Hour, reset Minutes
 709                         if self._value[0] < 23:
 710                                 self._value[0] += 1
 711                         else:
 712                                 self._value[0] = 0
 713                         self._value[1] = 0
 714                 else:
 715                         # Increment Minutes
 716                         self._value[1] += 1
 717                 # Trigger change
 718                 self.changed()
 719
 720         def decrement(self):
 721                 # Check if Minutes is minimum
 722                 if self._value[1] == 0:
 723                         # Decrement Hour, set Minutes to 59
 724                         if self._value[0] > 0:
 725                                 self._value[0] -= 1
 726                         else:
 727                                 self._value[0] = 23
 728                         self._value[1] = 59
 729                 else:
 730                         # Decrement Minutes
 731                         self._value[1] -= 1
 732                 # Trigger change
 733                 self.changed()
 734
 735 class ConfigInteger(ConfigSequence):
 736         def __init__(self, default, limits = (0, 9999999999)):
 737                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
 738
 739         # you need to override this to do input validation
 740         def setValue(self, value):
 741                 self._value = [value]
 742                 self.changed()
 743
 744         def getValue(self):
 745                 return self._value[0]
 746
 747         value = property(getValue, setValue)
 748
 749         def fromstring(self, value):
 750                 return int(value)
 751
 752         def tostring(self, value):
 753                 return str(value)
 754
 755 class ConfigPIN(ConfigInteger):
 756         def __init__(self, default, len = 4, censor = ""):
 757                 assert isinstance(default, int), "ConfigPIN default must be an integer"
 758                 if default == -1:
 759                         default = "aaaa"
 760                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
 761                 self.len = len
 762
 763         def getLength(self):
 764                 return self.len
 765
 766 class ConfigFloat(ConfigSequence):
 767         def __init__(self, default, limits):
 768                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
 769
 770         def getFloat(self):
 771                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
 772
 773         float = property(getFloat)
 774
 775 # an editable text...
 776 class ConfigText(ConfigElement, NumericalTextInput):
 777         def __init__(self, default = "", fixed_size = True, visible_width = False):
 778                 ConfigElement.__init__(self)
 779                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
 780
 781                 self.marked_pos = 0
 782                 self.allmarked = (default != "")
 783                 self.fixed_size = fixed_size
 784                 self.visible_width = visible_width
 785                 self.offset = 0
 786                 self.overwrite = fixed_size
 787                 self.help_window = None
 788                 self.value = self.last_value = self.default = default
 789
 790         def validateMarker(self):
 791                 if self.fixed_size:
 792                         if self.marked_pos > len(self.text)-1:
 793                                 self.marked_pos = len(self.text)-1
 794                 else:
 795                         if self.marked_pos > len(self.text):
 796                                 self.marked_pos = len(self.text)
 797                 if self.marked_pos < 0:
 798                         self.marked_pos = 0
 799                 if self.visible_width:
 800                         if self.marked_pos < self.offset:
 801                                 self.offset = self.marked_pos
 802                         if self.marked_pos >= self.offset + self.visible_width:
 803                                 if self.marked_pos == len(self.text):
 804                                         self.offset = self.marked_pos - self.visible_width
 805                                 else:
 806                                         self.offset = self.marked_pos - self.visible_width + 1
 807                         if self.offset > 0 and self.offset + self.visible_width > len(self.text):
 808                                 self.offset = max(0, len(self.text) - self.visible_width)
 809
 810         def insertChar(self, ch, pos, owr):
 811                 if owr or self.overwrite:
 812                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
 813                 elif self.fixed_size:
 814                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
 815                 else:
 816                         self.text = self.text[0:pos] + ch + self.text[pos:]
 817
 818         def deleteChar(self, pos):
 819                 if not self.fixed_size:
 820                         self.text = self.text[0:pos] + self.text[pos + 1:]
 821                 elif self.overwrite:
 822                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
 823                 else:
 824                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
 825
 826         def deleteAllChars(self):
 827                 if self.fixed_size:
 828                         self.text = " " * len(self.text)
 829                 else:
 830                         self.text = ""
 831                 self.marked_pos = 0
 832
 833         def handleKey(self, key):
 834                 # this will no change anything on the value itself
 835                 # so we can handle it here in gui element
 836                 if key == KEY_DELETE:
 837                         self.timeout()
 838                         if self.allmarked:
 839                                 self.deleteAllChars()
 840                                 self.allmarked = False
 841                         else:
 842                                 self.deleteChar(self.marked_pos)
 843                                 if self.fixed_size and self.overwrite:
 844                                         self.marked_pos += 1
 845                 elif key == KEY_BACKSPACE:
 846                         self.timeout()
 847                         if self.allmarked:
 848                                 self.deleteAllChars()
 849                                 self.allmarked = False
 850                         elif self.marked_pos > 0:
 851                                 self.deleteChar(self.marked_pos-1)
 852                                 if not self.fixed_size and self.offset > 0:
 853                                         self.offset -= 1
 854                                 self.marked_pos -= 1
 855                 elif key == KEY_LEFT:
 856                         self.timeout()
 857                         if self.allmarked:
 858                                 self.marked_pos = len(self.text)
 859                                 self.allmarked = False
 860                         else:
 861                                 self.marked_pos -= 1
 862                 elif key == KEY_RIGHT:
 863                         self.timeout()
 864                         if self.allmarked:
 865                                 self.marked_pos = 0
 866                                 self.allmarked = False
 867                         else:
 868                                 self.marked_pos += 1
 869                 elif key == KEY_HOME:
 870                         self.timeout()
 871                         self.allmarked = False
 872                         self.marked_pos = 0
 873                 elif key == KEY_END:
 874                         self.timeout()
 875                         self.allmarked = False
 876                         self.marked_pos = len(self.text)
 877                 elif key == KEY_TOGGLEOW:
 878                         self.timeout()
 879                         self.overwrite = not self.overwrite
 880                 elif key == KEY_ASCII:
 881                         self.timeout()
 882                         newChar = unichr(getPrevAsciiCode())
 883                         if self.allmarked:
 884                                 self.deleteAllChars()
 885                                 self.allmarked = False
 886                         self.insertChar(newChar, self.marked_pos, False)
 887                         self.marked_pos += 1
 888                 elif key in KEY_NUMBERS:
 889                         owr = self.lastKey == getKeyNumber(key)
 890                         newChar = self.getKey(getKeyNumber(key))
 891                         if self.allmarked:
 892                                 self.deleteAllChars()
 893                                 self.allmarked = False
 894                         self.insertChar(newChar, self.marked_pos, owr)
 895                 elif key == KEY_TIMEOUT:
 896                         self.timeout()
 897                         if self.help_window:
 898                                 self.help_window.update(self)
 899                         return
 900
 901                 if self.help_window:
 902                         self.help_window.update(self)
 903                 self.validateMarker()
 904                 self.changed()
 905
 906         def nextFunc(self):
 907                 self.marked_pos += 1
 908                 self.validateMarker()
 909                 self.changed()
 910
 911         def getValue(self):
 912                 return self.text.encode("utf-8")
 913
 914         def setValue(self, val):
 915                 try:
 916                         self.text = val.decode("utf-8")
 917                 except UnicodeDecodeError:
 918                         self.text = val.decode("utf-8", "ignore")
 919                         print "Broken UTF8!"
 920
 921         value = property(getValue, setValue)
 922         _value = property(getValue, setValue)
 923
 924         def getText(self):
 925                 return self.text.encode("utf-8")
 926
 927         def getMulti(self, selected):
 928                 if self.visible_width:
 929                         if self.allmarked:
 930                                 mark = range(0, min(self.visible_width, len(self.text)))
 931                         else:
 932                                 mark = [self.marked_pos-self.offset]
 933                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
 934                 else:
 935                         if self.allmarked:
 936                                 mark = range(0, len(self.text))
 937                         else:
 938                                 mark = [self.marked_pos]
 939                         return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
 940
 941         def onSelect(self, session):
 942                 self.allmarked = (self.value != "")
 943                 if session is not None:
 944                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
 945                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
 946                         self.help_window.show()
 947
 948         def onDeselect(self, session):
 949                 self.marked_pos = 0
 950                 self.offset = 0
 951                 if self.help_window:
 952                         session.deleteDialog(self.help_window)
 953                         self.help_window = None
 954                 if not self.last_value == self.value:
 955                         self.changedFinal()
 956                         self.last_value = self.value
 957
 958         def getHTML(self, id):
 959                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
 960
 961         def unsafeAssign(self, value):
 962                 self.value = str(value)
 963
 964 class ConfigPassword(ConfigText):
 965         def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
 966                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
 967                 self.censor_char = censor
 968                 self.hidden = True
 969
 970         def getMulti(self, selected):
 971                 mtext, text, mark = ConfigText.getMulti(self, selected)
 972                 if self.hidden:
 973                         text = len(text) * self.censor_char
 974                 return (mtext, text, mark)
 975
 976         def onSelect(self, session):
 977                 ConfigText.onSelect(self, session)
 978                 self.hidden = False
 979
 980         def onDeselect(self, session):
 981                 ConfigText.onDeselect(self, session)
 982                 self.hidden = True
 983
 984 class ConfigNumber(ConfigText):
 985         def __init__(self, default = 0):
 986                 ConfigText.__init__(self, str(default), fixed_size = False)
 987
 988         def getValue(self):
 989                 return int(self.text)
 990
 991         def setValue(self, val):
 992                 self.text = str(val)
 993
 994         value = property(getValue, setValue)
 995         _value = property(getValue, setValue)
 996
 997         def conform(self):
 998                 pos = len(self.text) - self.marked_pos
 999                 self.text = self.text.lstrip("0")
1000                 if self.text == "":
1001                         self.text = "0"
1002                 if pos > len(self.text):
1003                         self.marked_pos = 0
1004                 else:
1005                         self.marked_pos = len(self.text) - pos
1006
1007         def handleKey(self, key):
1008                 if key in KEY_NUMBERS or key == KEY_ASCII:
1009                         if key == KEY_ASCII:
1010                                 ascii = getPrevAsciiCode()
1011                                 if not (48 <= ascii <= 57):
1012                                         return
1013                         else:
1014                                 ascii = getKeyNumber(key) + 48
1015                         newChar = unichr(ascii)
1016                         if self.allmarked:
1017                                 self.deleteAllChars()
1018                                 self.allmarked = False
1019                         self.insertChar(newChar, self.marked_pos, False)
1020                         self.marked_pos += 1
1021                 else:
1022                         ConfigText.handleKey(self, key)
1023                 self.conform()
1024
1025         def onSelect(self, session):
1026                 self.allmarked = (self.value != "")
1027
1028         def onDeselect(self, session):
1029                 self.marked_pos = 0
1030                 self.offset = 0
1031                 if not self.last_value == self.value:
1032                         self.changedFinal()
1033                         self.last_value = self.value
1034
1035 class ConfigSearchText(ConfigText):
1036         def __init__(self, default = "", fixed_size = False, visible_width = False):
1037                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1038                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False, search = True)
1039
1040 class ConfigDirectory(ConfigText):
1041         def __init__(self, default="", visible_width=60):
1042                 ConfigText.__init__(self, default, fixed_size = True, visible_width = visible_width)
1043         def handleKey(self, key):
1044                 pass
1045         def getValue(self):
1046                 if self.text == "":
1047                         return None
1048                 else:
1049                         return ConfigText.getValue(self)
1050         def setValue(self, val):
1051                 if val == None:
1052                         val = ""
1053                 ConfigText.setValue(self, val)
1054         def getMulti(self, selected):
1055                 if self.text == "":
1056                         return ("mtext"[1-selected:], _("List of Storage Devices"), range(0))
1057                 else:
1058                         return ConfigText.getMulti(self, selected)
1059
1060 # a slider.
1061 class ConfigSlider(ConfigElement):
1062         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
1063                 ConfigElement.__init__(self)
1064                 self.value = self.last_value = self.default = default
1065                 self.min = limits[0]
1066                 self.max = limits[1]
1067                 self.increment = increment
1068
1069         def checkValues(self):
1070                 if self.value < self.min:
1071                         self.value = self.min
1072
1073                 if self.value > self.max:
1074                         self.value = self.max
1075
1076         def handleKey(self, key):
1077                 if key == KEY_LEFT:
1078                         self.value -= self.increment
1079                 elif key == KEY_RIGHT:
1080                         self.value += self.increment
1081                 elif key == KEY_HOME:
1082                         self.value = self.min
1083                 elif key == KEY_END:
1084                         self.value = self.max
1085                 else:
1086                         return
1087                 self.checkValues()
1088
1089         def getText(self):
1090                 return "%d / %d" % (self.value, self.max)
1091
1092         def getMulti(self, selected):
1093                 self.checkValues()
1094                 return ("slider", self.value, self.max)
1095
1096         def fromstring(self, value):
1097                 return int(value)
1098
1099 # a satlist. in fact, it's a ConfigSelection.
1100 class ConfigSatlist(ConfigSelection):
1101         def __init__(self, list, default = None):
1102                 if default is not None:
1103                         default = str(default)
1104                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
1105
1106         def getOrbitalPosition(self):
1107                 if self.value == "":
1108                         return None
1109                 return int(self.value)
1110
1111         orbital_position = property(getOrbitalPosition)
1112
1113 class ConfigSet(ConfigElement):
1114         def __init__(self, choices, default = []):
1115                 ConfigElement.__init__(self)
1116                 if isinstance(choices, list):
1117                         choices.sort()
1118                         self.choices = choicesList(choices, choicesList.LIST_TYPE_LIST)
1119                 else:
1120                         assert False, "ConfigSet choices must be a list!"
1121                 if default is None:
1122                         default = []
1123                 self.pos = -1
1124                 default.sort()
1125                 self.last_value = self.default = default
1126                 self.value = default[:]
1127
1128         def toggleChoice(self, choice):
1129                 if choice in self.value:
1130                         self.value.remove(choice)
1131                 else:
1132                         self.value.append(choice)
1133                         self.value.sort()
1134                 self.changed()
1135
1136         def handleKey(self, key):
1137                 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
1138                         if self.pos != -1:
1139                                 self.toggleChoice(self.choices[self.pos])
1140                 elif key == KEY_LEFT:
1141                         self.pos -= 1
1142                         if self.pos < -1:
1143                             self.pos = len(self.choices)-1
1144                 elif key == KEY_RIGHT:
1145                         self.pos += 1
1146                         if self.pos >= len(self.choices):
1147                             self.pos = -1
1148                 elif key in [KEY_HOME, KEY_END]:
1149                         self.pos = -1
1150
1151         def genString(self, lst):
1152                 res = ""
1153                 description = descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST)
1154                 for x in lst:
1155                         res += description[x]+" "
1156                 return res
1157
1158         def getText(self):
1159                 return self.genString(self.value)
1160
1161         def getMulti(self, selected):
1162                 if not selected or self.pos == -1:
1163                         return ("text", self.genString(self.value))
1164                 else:
1165                         description = descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST)
1166                         tmp = self.value[:]
1167                         ch = self.choices[self.pos]
1168                         mem = ch in self.value
1169                         if not mem:
1170                                 tmp.append(ch)
1171                                 tmp.sort()
1172                         ind = tmp.index(ch)
1173                         val1 = self.genString(tmp[:ind])
1174                         val2 = " "+self.genString(tmp[ind+1:])
1175                         if mem:
1176                                 chstr = " "+description[ch]+" "
1177                         else:
1178                                 chstr = "("+description[ch]+")"
1179                         return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
1180
1181         def onDeselect(self, session):
1182                 self.pos = -1
1183                 if not self.last_value == self.value:
1184                         self.changedFinal()
1185                         self.last_value = self.value[:]
1186
1187         def tostring(self, value):
1188                 return str(value)
1189
1190         def fromstring(self, val):
1191                 return eval(val)
1192
1193 class ConfigLocations(ConfigElement):
1194         def __init__(self, default = [], visible_width = False):
1195                 ConfigElement.__init__(self)
1196                 self.visible_width = visible_width
1197                 self.pos = -1
1198                 self.default = default
1199                 self.locations = []
1200                 self.mountpoints = []
1201                 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
1202                 self.value = default+[]
1203
1204         def setValue(self, value):
1205                 loc = [x[0] for x in self.locations if x[3]]
1206                 add = [x for x in value if not x in loc]
1207                 diff = add + [x for x in loc if not x in value]
1208                 self.locations = [x for x in self.locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
1209                 self.locations.sort(key = lambda x: x[0])
1210                 self.changed()
1211
1212         def getValue(self):
1213                 self.checkChangedMountpoints()
1214                 for x in self.locations:
1215                         x[3] = x[2]
1216                 return [x[0] for x in self.locations if x[3]]
1217
1218         value = property(getValue, setValue)
1219
1220         def tostring(self, value):
1221                 return str(value)
1222
1223         def fromstring(self, val):
1224                 return eval(val)
1225
1226         def load(self):
1227                 sv = self.saved_value
1228                 if sv is None:
1229                         tmp = self.default
1230                 else:
1231                         tmp = self.fromstring(sv)
1232                 self.locations = [[x, None, False, False] for x in tmp]
1233                 self.refreshMountpoints()
1234                 for x in self.locations:
1235                         if os.path.exists(x[0]):
1236                                 x[1] = self.getMountpoint(x[0])
1237                                 x[2] = True
1238
1239         def save(self):
1240                 if self.save_disabled or self.locations == []:
1241                         self.saved_value = None
1242                 else:
1243                         self.saved_value = self.tostring([x[0] for x in self.locations])
1244
1245         def isChanged(self):
1246                 sv = self.saved_value
1247                 if val is None and self.locations == []:
1248                         return False
1249                 return self.tostring([x[0] for x in self.locations]) != sv
1250
1251         def mountpointsChanged(self, action, dev):
1252                 print "Mounts changed: ", action, dev
1253                 mp = dev.mountpoint+"/"
1254                 if action == "add":
1255                         self.addedMount(mp)
1256                 elif action == "remove":
1257                         self.removedMount(mp)
1258                 self.refreshMountpoints()
1259
1260         def addedMount(self, mp):
1261                 for x in self.locations:
1262                         if x[1] == mp:
1263                                 x[2] = True
1264                         elif x[1] == None and os.path.exists(x[0]):
1265                                 x[1] = self.getMountpoint(x[0])
1266                                 x[2] = True
1267
1268         def removedMount(self, mp):
1269                 for x in self.locations:
1270                         if x[1] == mp:
1271                                 x[2] = False
1272
1273         def refreshMountpoints(self):
1274                 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1275                 self.mountpoints.sort(key = lambda x: -len(x))
1276
1277         def checkChangedMountpoints(self):
1278                 oldmounts = self.mountpoints
1279                 self.refreshMountpoints()
1280                 if oldmounts == self.mountpoints:
1281                         return
1282                 for x in oldmounts:
1283                         if not x in self.mountpoints:
1284                                 self.removedMount(x)
1285                 for x in self.mountpoints:
1286                         if not x in oldmounts:
1287                                 self.addedMount(x)
1288
1289         def getMountpoint(self, file):
1290                 file = os.path.realpath(file)+"/"
1291                 for m in self.mountpoints:
1292                         if file.startswith(m):
1293                                 return m
1294                 return None
1295
1296         def handleKey(self, key):
1297                 if key == KEY_LEFT:
1298                         self.pos -= 1
1299                         if self.pos < -1:
1300                             self.pos = len(self.value)-1
1301                 elif key == KEY_RIGHT:
1302                         self.pos += 1
1303                         if self.pos >= len(self.value):
1304                             self.pos = -1
1305                 elif key in [KEY_HOME, KEY_END]:
1306                         self.pos = -1
1307
1308         def getText(self):
1309                 return " ".join(self.value)
1310
1311         def getMulti(self, selected):
1312                 if not selected:
1313                         valstr = " ".join(self.value)
1314                         if self.visible_width and len(valstr) > self.visible_width:
1315                                 return ("text", valstr[0:self.visible_width])
1316                         else:
1317                                 return ("text", valstr)
1318                 else:
1319                         i = 0
1320                         valstr = ""
1321                         ind1 = 0
1322                         ind2 = 0
1323                         for val in self.value:
1324                                 if i == self.pos:
1325                                         ind1 = len(valstr)
1326                                 valstr += str(val)+" "
1327                                 if i == self.pos:
1328                                         ind2 = len(valstr)
1329                                 i += 1
1330                         if self.visible_width and len(valstr) > self.visible_width:
1331                                 if ind1+1 < self.visible_width/2:
1332                                         off = 0
1333                                 else:
1334                                         off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1335                                 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1336                         else:
1337                                 return ("mtext", valstr, range(ind1,ind2))
1338
1339         def onDeselect(self, session):
1340                 self.pos = -1
1341
1342 # nothing.
1343 class ConfigNothing(ConfigSelection):
1344         def __init__(self):
1345                 ConfigSelection.__init__(self, choices = [""])
1346
1347 # until here, 'saved_value' always had to be a *string*.
1348 # now, in ConfigSubsection, and only there, saved_value
1349 # is a dict, essentially forming a tree.
1350 #
1351 # config.foo.bar=True
1352 # config.foobar=False
1353 #
1354 # turns into:
1355 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1356 #
1357
1358
1359 class ConfigSubsectionContent(object):
1360         pass
1361
1362 # we store a backup of the loaded configuration
1363 # data in self.stored_values, to be able to deploy
1364 # them when a new config element will be added,
1365 # so non-default values are instantly available
1366
1367 # A list, for example:
1368 # config.dipswitches = ConfigSubList()
1369 # config.dipswitches.append(ConfigYesNo())
1370 # config.dipswitches.append(ConfigYesNo())
1371 # config.dipswitches.append(ConfigYesNo())
1372 class ConfigSubList(list, object):
1373         def __init__(self):
1374                 object.__init__(self)
1375                 list.__init__(self)
1376                 self.stored_values = {}
1377
1378         def save(self):
1379                 for x in self:
1380                         x.save()
1381
1382         def load(self):
1383                 for x in self:
1384                         x.load()
1385
1386         def getSavedValue(self):
1387                 res = {}
1388                 for i in range(len(self)):
1389                         sv = self[i].saved_value
1390                         if sv is not None:
1391                                 res[str(i)] = sv
1392                 return res
1393
1394         def setSavedValue(self, values):
1395                 self.stored_values = dict(values)
1396                 for (key, val) in self.stored_values.items():
1397                         if int(key) < len(self):
1398                                 self[int(key)].saved_value = val
1399
1400         saved_value = property(getSavedValue, setSavedValue)
1401
1402         def append(self, item):
1403                 i = str(len(self))
1404                 list.append(self, item)
1405                 if i in self.stored_values:
1406                         item.saved_value = self.stored_values[i]
1407                         item.load()
1408
1409         def dict(self):
1410                 res = dict()
1411                 for index in range(len(self)):
1412                         res[str(index)] = self[index]
1413                 return res
1414
1415 # same as ConfigSubList, just as a dictionary.
1416 # care must be taken that the 'key' has a proper
1417 # str() method, because it will be used in the config
1418 # file.
1419 class ConfigSubDict(dict, object):
1420         def __init__(self):
1421                 object.__init__(self)
1422                 dict.__init__(self)
1423                 self.stored_values = {}
1424
1425         def save(self):
1426                 for x in self.values():
1427                         x.save()
1428
1429         def load(self):
1430                 for x in self.values():
1431                         x.load()
1432
1433         def getSavedValue(self):
1434                 res = {}
1435                 for (key, val) in self.items():
1436                         sv = val.saved_value
1437                         if sv is not None:
1438                                 res[str(key)] = sv
1439                 return res
1440
1441         def setSavedValue(self, values):
1442                 self.stored_values = dict(values)
1443                 for (key, val) in self.items():
1444                         if str(key) in self.stored_values:
1445                                 val = self.stored_values[str(key)]
1446
1447         saved_value = property(getSavedValue, setSavedValue)
1448
1449         def __setitem__(self, key, item):
1450                 dict.__setitem__(self, key, item)
1451                 if str(key) in self.stored_values:
1452                         item.saved_value = self.stored_values[str(key)]
1453                         item.load()
1454
1455         def dict(self):
1456                 return self
1457
1458 # Like the classes above, just with a more "native"
1459 # syntax.
1460 #
1461 # some evil stuff must be done to allow instant
1462 # loading of added elements. this is why this class
1463 # is so complex.
1464 #
1465 # we need the 'content' because we overwrite
1466 # __setattr__.
1467 # If you don't understand this, try adding
1468 # __setattr__ to a usual exisiting class and you will.
1469 class ConfigSubsection(object):
1470         def __init__(self):
1471                 object.__init__(self)
1472                 self.__dict__["content"] = ConfigSubsectionContent()
1473                 self.content.items = { }
1474                 self.content.stored_values = { }
1475
1476         def __setattr__(self, name, value):
1477                 if name == "saved_value":
1478                         return self.setSavedValue(value)
1479                 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"
1480                 self.content.items[name] = value
1481                 if name in self.content.stored_values:
1482                         #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
1483                         value.saved_value = self.content.stored_values[name]
1484                         value.load()
1485
1486         def __getattr__(self, name):
1487                 return self.content.items[name]
1488
1489         def getSavedValue(self):
1490                 res = self.content.stored_values
1491                 for (key, val) in self.content.items.items():
1492                         sv = val.saved_value
1493                         if sv is not None:
1494                                 res[key] = sv
1495                         elif key in res:
1496                                 del res[key]
1497                 return res
1498
1499         def setSavedValue(self, values):
1500                 values = dict(values)
1501
1502                 self.content.stored_values = values
1503
1504                 for (key, val) in self.content.items.items():
1505                         if key in values:
1506                                 val.saved_value = values[key]
1507
1508         saved_value = property(getSavedValue, setSavedValue)
1509
1510         def save(self):
1511                 for x in self.content.items.values():
1512                         x.save()
1513
1514         def load(self):
1515                 for x in self.content.items.values():
1516                         x.load()
1517
1518         def dict(self):
1519                 return self.content.items
1520
1521 # the root config object, which also can "pickle" (=serialize)
1522 # down the whole config tree.
1523 #
1524 # we try to keep non-existing config entries, to apply them whenever
1525 # a new config entry is added to a subsection
1526 # also, non-existing config entries will be saved, so they won't be
1527 # lost when a config entry disappears.
1528 class Config(ConfigSubsection):
1529         def __init__(self):
1530                 ConfigSubsection.__init__(self)
1531
1532         def pickle_this(self, prefix, topickle, result):
1533                 for (key, val) in topickle.items():
1534                         name = prefix + "." + key
1535
1536                         if isinstance(val, dict):
1537                                 self.pickle_this(name, val, result)
1538                         elif isinstance(val, tuple):
1539                                 result.append(name + "=" + val[0]) # + " ; " + val[1])
1540                         else:
1541                                 result.append(name + "=" + val)
1542
1543         def pickle(self):
1544                 result = [ ]
1545                 self.pickle_this("config", self.saved_value, result)
1546                 return '\n'.join(result) + "\n"
1547
1548         def unpickle(self, lines):
1549                 tree = { }
1550                 for l in lines:
1551                         if not len(l) or l[0] == '#':
1552                                 continue
1553
1554                         n = l.find('=')
1555                         val = l[n+1:].strip()
1556
1557                         names = l[:n].split('.')
1558 #                       if val.find(' ') != -1:
1559 #                               val = val[:val.find(' ')]
1560
1561                         base = tree
1562
1563                         for n in names[:-1]:
1564                                 base = base.setdefault(n, {})
1565
1566                         base[names[-1]] = val
1567
1568                 # we inherit from ConfigSubsection, so ...
1569                 #object.__setattr__(self, "saved_value", tree["config"])
1570                 if "config" in tree:
1571                         self.setSavedValue(tree["config"])
1572
1573         def saveToFile(self, filename):
1574                 f = open(filename, "w")
1575                 f.write(self.pickle())
1576                 f.close()
1577
1578         def loadFromFile(self, filename):
1579                 f = open(filename, "r")
1580                 self.unpickle(f.readlines())
1581                 f.close()
1582
1583 config = Config()
1584 config.misc = ConfigSubsection()
1585
1586 class ConfigFile:
1587         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1588
1589         def load(self):
1590                 try:
1591                         config.loadFromFile(self.CONFIG_FILE)
1592                 except IOError, e:
1593                         print "unable to load config (%s), assuming defaults..." % str(e)
1594
1595         def save(self):
1596 #               config.save()
1597                 config.saveToFile(self.CONFIG_FILE)
1598
1599         def __resolveValue(self, pickles, cmap):
1600                 if cmap.has_key(pickles[0]):
1601                         if len(pickles) > 1:
1602                                 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1603                         else:
1604                                 return str(cmap[pickles[0]].value)
1605                 return None
1606
1607         def getResolvedKey(self, key):
1608                 names = key.split('.')
1609                 if len(names) > 1:
1610                         if names[0] == "config":
1611                                 ret=self.__resolveValue(names[1:], config.content.items)
1612                                 if ret and len(ret):
1613                                         return ret
1614                 print "getResolvedKey", key, "failed !! (Typo??)"
1615                 return ""
1616
1617 def NoSave(element):
1618         element.disableSave()
1619         return element
1620
1621 configfile = ConfigFile()
1622
1623 configfile.load()
1624
1625 def getConfigListEntry(*args):
1626         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1627         return args
1628
1629 def updateConfigElement(element, newelement):
1630         newelement.value = element.value
1631         return newelement
1632
1633 #def _(x):
1634 #       return x
1635 #
1636 #config.bla = ConfigSubsection()
1637 #config.bla.test = ConfigYesNo()
1638 #config.nim = ConfigSubList()
1639 #config.nim.append(ConfigSubsection())
1640 #config.nim[0].bla = ConfigYesNo()
1641 #config.nim.append(ConfigSubsection())
1642 #config.nim[1].bla = ConfigYesNo()
1643 #config.nim[1].blub = ConfigYesNo()
1644 #config.arg = ConfigSubDict()
1645 #config.arg["Hello"] = ConfigYesNo()
1646 #
1647 #config.arg["Hello"].handleKey(KEY_RIGHT)
1648 #config.arg["Hello"].handleKey(KEY_RIGHT)
1649 #
1650 ##config.saved_value
1651 #
1652 ##configfile.save()
1653 #config.save()
1654 #print config.pickle()