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