code.vuplus.com Git - vuplus_dvbapp/blob - lib/python/Components/config.py

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