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 = [not isinstance(x, tuple) and x or x[0] 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 = [not isinstance(x, tuple) and x or x[0] 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 = [not isinstance(x, tuple) and x or x[1] 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                 elif key == KEY_RIGHT:
 537                         self.marked_pos += 1
 538                         self.validatePos()
 539
 540                 elif key == KEY_HOME:
 541                         self.marked_pos = 0
 542                         self.validatePos()
 543
 544                 elif 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                 elif 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 = [len(str(x[1])) for x in self.limits]
 563                         total_len = sum(block_len)
 564
 565                         pos = 0
 566                         blocknumber = 0
 567                         block_len_total = [0, ]
 568                         for x in block_len:
 569                                 pos += block_len[blocknumber]
 570                                 block_len_total.append(pos)
 571                                 if pos - 1 >= self.marked_pos:
 572                                         pass
 573                                 else:
 574                                         blocknumber += 1
 575
 576                         # length of numberblock
 577                         number_len = len(str(self.limits[blocknumber][1]))
 578
 579                         # position in the block
 580                         posinblock = self.marked_pos - block_len_total[blocknumber]
 581
 582                         oldvalue = self._value[blocknumber]
 583                         olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
 584                         newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
 585
 586                         self._value[blocknumber] = newvalue
 587                         self.marked_pos += 1
 588
 589                         self.validate()
 590                         self.changed()
 591
 592         def genText(self):
 593                 value = ""
 594                 mPos = self.marked_pos
 595                 num = 0;
 596                 for i in self._value:
 597                         if value:       #fixme no heading separator possible
 598                                 value += self.seperator
 599                                 if mPos >= len(value) - 1:
 600                                         mPos += 1
 601                         if self.censor_char == "":
 602                                 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
 603                         else:
 604                                 value += (self.censor_char * len(str(self.limits[num][1])))
 605                         num += 1
 606                 return (value, mPos)
 607
 608         def getText(self):
 609                 (value, mPos) = self.genText()
 610                 return value
 611
 612         def getMulti(self, selected):
 613                 (value, mPos) = self.genText()
 614                         # only mark cursor when we are selected
 615                         # (this code is heavily ink optimized!)
 616                 if self.enabled:
 617                         return ("mtext"[1-selected:], value, [mPos])
 618                 else:
 619                         return ("text", value)
 620
 621         def tostring(self, val):
 622                 return self.seperator.join([self.saveSingle(x) for x in val])
 623
 624         def saveSingle(self, v):
 625                 return str(v)
 626
 627         def fromstring(self, value):
 628                 return [int(x) for x in value.split(self.seperator)]
 629
 630         def onDeselect(self, session):
 631                 if self.last_value != self._value:
 632                         self.changedFinal()
 633                         self.last_value = copy_copy(self._value)
 634
 635 ip_limits = [(0,255),(0,255),(0,255),(0,255)]
 636 class ConfigIP(ConfigSequence):
 637         def __init__(self, default, auto_jump = False):
 638                 ConfigSequence.__init__(self, seperator = ".", limits = ip_limits, default = default)
 639                 self.block_len = [len(str(x[1])) for x in self.limits]
 640                 self.marked_block = 0
 641                 self.overwrite = True
 642                 self.auto_jump = auto_jump
 643
 644         def handleKey(self, key):
 645                 if key == KEY_LEFT:
 646                         if self.marked_block > 0:
 647                                 self.marked_block -= 1
 648                         self.overwrite = True
 649
 650                 elif key == KEY_RIGHT:
 651                         if self.marked_block < len(self.limits)-1:
 652                                 self.marked_block += 1
 653                         self.overwrite = True
 654
 655                 elif key == KEY_HOME:
 656                         self.marked_block = 0
 657                         self.overwrite = True
 658
 659                 elif key == KEY_END:
 660                         self.marked_block = len(self.limits)-1
 661                         self.overwrite = True
 662
 663                 elif key in KEY_NUMBERS or key == KEY_ASCII:
 664                         if key == KEY_ASCII:
 665                                 code = getPrevAsciiCode()
 666                                 if code < 48 or code > 57:
 667                                         return
 668                                 number = code - 48
 669                         else:
 670                                 number = getKeyNumber(key)
 671                         oldvalue = self._value[self.marked_block]
 672
 673                         if self.overwrite:
 674                                 self._value[self.marked_block] = number
 675                                 self.overwrite = False
 676                         else:
 677                                 oldvalue *= 10
 678                                 newvalue = oldvalue + number
 679                                 if self.auto_jump and newvalue > self.limits[self.marked_block][1] and self.marked_block < len(self.limits)-1:
 680                                         self.handleKey(KEY_RIGHT)
 681                                         self.handleKey(key)
 682                                         return
 683                                 else:
 684                                         self._value[self.marked_block] = newvalue
 685
 686                         if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
 687                                 self.handleKey(KEY_RIGHT)
 688
 689                         self.validate()
 690                         self.changed()
 691
 692         def genText(self):
 693                 value = ""
 694                 block_strlen = []
 695                 for i in self._value:
 696                         block_strlen.append(len(str(i)))
 697                         if value:
 698                                 value += self.seperator
 699                         value += str(i)
 700                 leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
 701                 rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
 702                 mBlock = range(leftPos, rightPos)
 703                 return (value, mBlock)
 704
 705         def getMulti(self, selected):
 706                 (value, mBlock) = self.genText()
 707                 if self.enabled:
 708                         return ("mtext"[1-selected:], value, mBlock)
 709                 else:
 710                         return ("text", value)
 711
 712         def getHTML(self, id):
 713                 # we definitely don't want leading zeros
 714                 return '.'.join(["%d" % d for d in self.value])
 715
 716 mac_limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)]
 717 class ConfigMAC(ConfigSequence):
 718         def __init__(self, default):
 719                 ConfigSequence.__init__(self, seperator = ":", limits = mac_limits, default = default)
 720
 721 class ConfigPosition(ConfigSequence):
 722         def __init__(self, default, args):
 723                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
 724
 725 clock_limits = [(0,23),(0,59)]
 726 class ConfigClock(ConfigSequence):
 727         def __init__(self, default):
 728                 t = localtime(default)
 729                 ConfigSequence.__init__(self, seperator = ":", limits = clock_limits, default = [t.tm_hour, t.tm_min])
 730
 731         def increment(self):
 732                 # Check if Minutes maxed out
 733                 if self._value[1] == 59:
 734                         # Increment Hour, reset Minutes
 735                         if self._value[0] < 23:
 736                                 self._value[0] += 1
 737                         else:
 738                                 self._value[0] = 0
 739                         self._value[1] = 0
 740                 else:
 741                         # Increment Minutes
 742                         self._value[1] += 1
 743                 # Trigger change
 744                 self.changed()
 745
 746         def decrement(self):
 747                 # Check if Minutes is minimum
 748                 if self._value[1] == 0:
 749                         # Decrement Hour, set Minutes to 59
 750                         if self._value[0] > 0:
 751                                 self._value[0] -= 1
 752                         else:
 753                                 self._value[0] = 23
 754                         self._value[1] = 59
 755                 else:
 756                         # Decrement Minutes
 757                         self._value[1] -= 1
 758                 # Trigger change
 759                 self.changed()
 760
 761 integer_limits = (0, 9999999999)
 762 class ConfigInteger(ConfigSequence):
 763         def __init__(self, default, limits = integer_limits):
 764                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
 765
 766         # you need to override this to do input validation
 767         def setValue(self, value):
 768                 self._value = [value]
 769                 self.changed()
 770
 771         def getValue(self):
 772                 return self._value[0]
 773
 774         value = property(getValue, setValue)
 775
 776         def fromstring(self, value):
 777                 return int(value)
 778
 779         def tostring(self, value):
 780                 return str(value)
 781
 782 class ConfigPIN(ConfigInteger):
 783         def __init__(self, default, len = 4, censor = ""):
 784                 assert isinstance(default, int), "ConfigPIN default must be an integer"
 785                 if default == -1:
 786                         default = "aaaa"
 787                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
 788                 self.len = len
 789
 790         def getLength(self):
 791                 return self.len
 792
 793 class ConfigFloat(ConfigSequence):
 794         def __init__(self, default, limits):
 795                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
 796
 797         def getFloat(self):
 798                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
 799
 800         float = property(getFloat)
 801
 802 # an editable text...
 803 class ConfigText(ConfigElement, NumericalTextInput):
 804         def __init__(self, default = "", fixed_size = True, visible_width = False):
 805                 ConfigElement.__init__(self)
 806                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
 807
 808                 self.marked_pos = 0
 809                 self.allmarked = (default != "")
 810                 self.fixed_size = fixed_size
 811                 self.visible_width = visible_width
 812                 self.offset = 0
 813                 self.overwrite = fixed_size
 814                 self.help_window = None
 815                 self.value = self.last_value = self.default = default
 816
 817         def validateMarker(self):
 818                 textlen = len(self.text)
 819                 if self.fixed_size:
 820                         if self.marked_pos > textlen-1:
 821                                 self.marked_pos = textlen-1
 822                 else:
 823                         if self.marked_pos > textlen:
 824                                 self.marked_pos = textlen
 825                 if self.marked_pos < 0:
 826                         self.marked_pos = 0
 827                 if self.visible_width:
 828                         if self.marked_pos < self.offset:
 829                                 self.offset = self.marked_pos
 830                         if self.marked_pos >= self.offset + self.visible_width:
 831                                 if self.marked_pos == textlen:
 832                                         self.offset = self.marked_pos - self.visible_width
 833                                 else:
 834                                         self.offset = self.marked_pos - self.visible_width + 1
 835                         if self.offset > 0 and self.offset + self.visible_width > textlen:
 836                                 self.offset = max(0, len - self.visible_width)
 837
 838         def insertChar(self, ch, pos, owr):
 839                 if owr or self.overwrite:
 840                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
 841                 elif self.fixed_size:
 842                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
 843                 else:
 844                         self.text = self.text[0:pos] + ch + self.text[pos:]
 845
 846         def deleteChar(self, pos):
 847                 if not self.fixed_size:
 848                         self.text = self.text[0:pos] + self.text[pos + 1:]
 849                 elif self.overwrite:
 850                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
 851                 else:
 852                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
 853
 854         def deleteAllChars(self):
 855                 if self.fixed_size:
 856                         self.text = " " * len(self.text)
 857                 else:
 858                         self.text = ""
 859                 self.marked_pos = 0
 860
 861         def handleKey(self, key):
 862                 # this will no change anything on the value itself
 863                 # so we can handle it here in gui element
 864                 if key == KEY_DELETE:
 865                         self.timeout()
 866                         if self.allmarked:
 867                                 self.deleteAllChars()
 868                                 self.allmarked = False
 869                         else:
 870                                 self.deleteChar(self.marked_pos)
 871                                 if self.fixed_size and self.overwrite:
 872                                         self.marked_pos += 1
 873                 elif key == KEY_BACKSPACE:
 874                         self.timeout()
 875                         if self.allmarked:
 876                                 self.deleteAllChars()
 877                                 self.allmarked = False
 878                         elif self.marked_pos > 0:
 879                                 self.deleteChar(self.marked_pos-1)
 880                                 if not self.fixed_size and self.offset > 0:
 881                                         self.offset -= 1
 882                                 self.marked_pos -= 1
 883                 elif key == KEY_LEFT:
 884                         self.timeout()
 885                         if self.allmarked:
 886                                 self.marked_pos = len(self.text)
 887                                 self.allmarked = False
 888                         else:
 889                                 self.marked_pos -= 1
 890                 elif key == KEY_RIGHT:
 891                         self.timeout()
 892                         if self.allmarked:
 893                                 self.marked_pos = 0
 894                                 self.allmarked = False
 895                         else:
 896                                 self.marked_pos += 1
 897                 elif key == KEY_HOME:
 898                         self.timeout()
 899                         self.allmarked = False
 900                         self.marked_pos = 0
 901                 elif key == KEY_END:
 902                         self.timeout()
 903                         self.allmarked = False
 904                         self.marked_pos = len(self.text)
 905                 elif key == KEY_TOGGLEOW:
 906                         self.timeout()
 907                         self.overwrite = not self.overwrite
 908                 elif key == KEY_ASCII:
 909                         self.timeout()
 910                         newChar = unichr(getPrevAsciiCode())
 911                         if self.allmarked:
 912                                 self.deleteAllChars()
 913                                 self.allmarked = False
 914                         self.insertChar(newChar, self.marked_pos, False)
 915                         self.marked_pos += 1
 916                 elif key in KEY_NUMBERS:
 917                         owr = self.lastKey == getKeyNumber(key)
 918                         newChar = self.getKey(getKeyNumber(key))
 919                         if self.allmarked:
 920                                 self.deleteAllChars()
 921                                 self.allmarked = False
 922                         self.insertChar(newChar, self.marked_pos, owr)
 923                 elif key == KEY_TIMEOUT:
 924                         self.timeout()
 925                         if self.help_window:
 926                                 self.help_window.update(self)
 927                         return
 928
 929                 if self.help_window:
 930                         self.help_window.update(self)
 931                 self.validateMarker()
 932                 self.changed()
 933
 934         def nextFunc(self):
 935                 self.marked_pos += 1
 936                 self.validateMarker()
 937                 self.changed()
 938
 939         def getValue(self):
 940                 return self.text.encode("utf-8")
 941
 942         def setValue(self, val):
 943                 try:
 944                         self.text = val.decode("utf-8")
 945                 except UnicodeDecodeError:
 946                         self.text = val.decode("utf-8", "ignore")
 947                         print "Broken UTF8!"
 948
 949         value = property(getValue, setValue)
 950         _value = property(getValue, setValue)
 951
 952         def getText(self):
 953                 return self.text.encode("utf-8")
 954
 955         def getMulti(self, selected):
 956                 if self.visible_width:
 957                         if self.allmarked:
 958                                 mark = range(0, min(self.visible_width, len(self.text)))
 959                         else:
 960                                 mark = [self.marked_pos-self.offset]
 961                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
 962                 else:
 963                         if self.allmarked:
 964                                 mark = range(0, len(self.text))
 965                         else:
 966                                 mark = [self.marked_pos]
 967                         return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
 968
 969         def onSelect(self, session):
 970                 self.allmarked = (self.value != "")
 971                 if session is not None:
 972                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
 973                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
 974                         self.help_window.show()
 975
 976         def onDeselect(self, session):
 977                 self.marked_pos = 0
 978                 self.offset = 0
 979                 if self.help_window:
 980                         session.deleteDialog(self.help_window)
 981                         self.help_window = None
 982                 if not self.last_value == self.value:
 983                         self.changedFinal()
 984                         self.last_value = self.value
 985
 986         def getHTML(self, id):
 987                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
 988
 989         def unsafeAssign(self, value):
 990                 self.value = str(value)
 991
 992 class ConfigPassword(ConfigText):
 993         def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
 994                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
 995                 self.censor_char = censor
 996                 self.hidden = True
 997
 998         def getMulti(self, selected):
 999                 mtext, text, mark = ConfigText.getMulti(self, selected)
1000                 if self.hidden:
1001                         text = len(text) * self.censor_char
1002                 return (mtext, text, mark)
1003
1004         def onSelect(self, session):
1005                 ConfigText.onSelect(self, session)
1006                 self.hidden = False
1007
1008         def onDeselect(self, session):
1009                 ConfigText.onDeselect(self, session)
1010                 self.hidden = True
1011
1012 class ConfigNumber(ConfigText):
1013         def __init__(self, default = 0):
1014                 ConfigText.__init__(self, str(default), fixed_size = False)
1015
1016         def getValue(self):
1017                 return int(self.text)
1018
1019         def setValue(self, val):
1020                 self.text = str(val)
1021
1022         value = property(getValue, setValue)
1023         _value = property(getValue, setValue)
1024
1025         def conform(self):
1026                 pos = len(self.text) - self.marked_pos
1027                 self.text = self.text.lstrip("0")
1028                 if self.text == "":
1029                         self.text = "0"
1030                 if pos > len(self.text):
1031                         self.marked_pos = 0
1032                 else:
1033                         self.marked_pos = len(self.text) - pos
1034
1035         def handleKey(self, key):
1036                 if key in KEY_NUMBERS or key == KEY_ASCII:
1037                         if key == KEY_ASCII:
1038                                 ascii = getPrevAsciiCode()
1039                                 if not (48 <= ascii <= 57):
1040                                         return
1041                         else:
1042                                 ascii = getKeyNumber(key) + 48
1043                         newChar = unichr(ascii)
1044                         if self.allmarked:
1045                                 self.deleteAllChars()
1046                                 self.allmarked = False
1047                         self.insertChar(newChar, self.marked_pos, False)
1048                         self.marked_pos += 1
1049                 else:
1050                         ConfigText.handleKey(self, key)
1051                 self.conform()
1052
1053         def onSelect(self, session):
1054                 self.allmarked = (self.value != "")
1055
1056         def onDeselect(self, session):
1057                 self.marked_pos = 0
1058                 self.offset = 0
1059                 if not self.last_value == self.value:
1060                         self.changedFinal()
1061                         self.last_value = self.value
1062
1063 class ConfigSearchText(ConfigText):
1064         def __init__(self, default = "", fixed_size = False, visible_width = False):
1065                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1066                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False, search = True)
1067
1068 class ConfigDirectory(ConfigText):
1069         def __init__(self, default="", visible_width=60):
1070                 ConfigText.__init__(self, default, fixed_size = True, visible_width = visible_width)
1071
1072         def handleKey(self, key):
1073                 pass
1074
1075         def getValue(self):
1076                 if self.text == "":
1077                         return None
1078                 else:
1079                         return ConfigText.getValue(self)
1080
1081         def setValue(self, val):
1082                 if val == None:
1083                         val = ""
1084                 ConfigText.setValue(self, val)
1085
1086         def getMulti(self, selected):
1087                 if self.text == "":
1088                         return ("mtext"[1-selected:], _("List of Storage Devices"), range(0))
1089                 else:
1090                         return ConfigText.getMulti(self, selected)
1091
1092 # a slider.
1093 class ConfigSlider(ConfigElement):
1094         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
1095                 ConfigElement.__init__(self)
1096                 self.value = self.last_value = self.default = default
1097                 self.min = limits[0]
1098                 self.max = limits[1]
1099                 self.increment = increment
1100
1101         def checkValues(self):
1102                 if self.value < self.min:
1103                         self.value = self.min
1104
1105                 if self.value > self.max:
1106                         self.value = self.max
1107
1108         def handleKey(self, key):
1109                 if key == KEY_LEFT:
1110                         self.value -= self.increment
1111                 elif key == KEY_RIGHT:
1112                         self.value += self.increment
1113                 elif key == KEY_HOME:
1114                         self.value = self.min
1115                 elif key == KEY_END:
1116                         self.value = self.max
1117                 else:
1118                         return
1119                 self.checkValues()
1120
1121         def getText(self):
1122                 return "%d / %d" % (self.value, self.max)
1123
1124         def getMulti(self, selected):
1125                 self.checkValues()
1126                 return ("slider", self.value, self.max)
1127
1128         def fromstring(self, value):
1129                 return int(value)
1130
1131 # a satlist. in fact, it's a ConfigSelection.
1132 class ConfigSatlist(ConfigSelection):
1133         def __init__(self, list, default = None):
1134                 if default is not None:
1135                         default = str(default)
1136                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
1137
1138         def getOrbitalPosition(self):
1139                 if self.value == "":
1140                         return None
1141                 return int(self.value)
1142
1143         orbital_position = property(getOrbitalPosition)
1144
1145 class ConfigSet(ConfigElement):
1146         def __init__(self, choices, default = []):
1147                 ConfigElement.__init__(self)
1148                 if isinstance(choices, list):
1149                         choices.sort()
1150                         self.choices = choicesList(choices, choicesList.LIST_TYPE_LIST)
1151                 else:
1152                         assert False, "ConfigSet choices must be a list!"
1153                 if default is None:
1154                         default = []
1155                 self.pos = -1
1156                 default.sort()
1157                 self.last_value = self.default = default
1158                 self.value = default[:]
1159
1160         def toggleChoice(self, choice):
1161                 value = self.value
1162                 if choice in value:
1163                         value.remove(choice)
1164                 else:
1165                         value.append(choice)
1166                         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                         if self.pos < 0:
1175                                 self.pos = len(self.choices)-1
1176                         else:
1177                                 self.pos -= 1
1178                 elif key == KEY_RIGHT:
1179                         if self.pos >= len(self.choices)-1:
1180                                 self.pos = -1
1181                         else:
1182                                 self.pos += 1
1183                 elif key in [KEY_HOME, KEY_END]:
1184                         self.pos = -1
1185
1186         def genString(self, lst):
1187                 res = ""
1188                 for x in lst:
1189                         res += self.description[x]+" "
1190                 return res
1191
1192         def getText(self):
1193                 return self.genString(self.value)
1194
1195         def getMulti(self, selected):
1196                 if not selected or self.pos == -1:
1197                         return ("text", self.genString(self.value))
1198                 else:
1199                         tmp = self.value[:]
1200                         ch = self.choices[self.pos]
1201                         mem = ch in self.value
1202                         if not mem:
1203                                 tmp.append(ch)
1204                                 tmp.sort()
1205                         ind = tmp.index(ch)
1206                         val1 = self.genString(tmp[:ind])
1207                         val2 = " "+self.genString(tmp[ind+1:])
1208                         if mem:
1209                                 chstr = " "+self.description[ch]+" "
1210                         else:
1211                                 chstr = "("+self.description[ch]+")"
1212                         len_val1 = len(val1)
1213                         return ("mtext", val1+chstr+val2, range(len_val1, len_val1 + len(chstr)))
1214
1215         def onDeselect(self, session):
1216                 self.pos = -1
1217                 if not self.last_value == self.value:
1218                         self.changedFinal()
1219                         self.last_value = self.value[:]
1220
1221         def tostring(self, value):
1222                 return str(value)
1223
1224         def fromstring(self, val):
1225                 return eval(val)
1226
1227         description = property(lambda self: descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST))
1228
1229 class ConfigLocations(ConfigElement):
1230         def __init__(self, default = [], visible_width = False):
1231                 ConfigElement.__init__(self)
1232                 self.visible_width = visible_width
1233                 self.pos = -1
1234                 self.default = default
1235                 self.locations = []
1236                 self.mountpoints = []
1237                 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
1238                 self.value = default[:]
1239
1240         def setValue(self, value):
1241                 locations = self.locations
1242                 loc = [x[0] for x in locations if x[3]]
1243                 add = [x for x in value if not x in loc]
1244                 diff = add + [x for x in loc if not x in value]
1245                 locations = [x for x in locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
1246                 locations.sort(key = lambda x: x[0])
1247                 self.locations = locations
1248                 self.changed()
1249
1250         def getValue(self):
1251                 self.checkChangedMountpoints()
1252                 locations = self.locations
1253                 for x in locations:
1254                         x[3] = x[2]
1255                 return [x[0] for x in locations if x[3]]
1256
1257         value = property(getValue, setValue)
1258
1259         def tostring(self, value):
1260                 return str(value)
1261
1262         def fromstring(self, val):
1263                 return eval(val)
1264
1265         def load(self):
1266                 sv = self.saved_value
1267                 if sv is None:
1268                         tmp = self.default
1269                 else:
1270                         tmp = self.fromstring(sv)
1271                 locations = [[x, None, False, False] for x in tmp]
1272                 self.refreshMountpoints()
1273                 for x in locations:
1274                         if os_path.exists(x[0]):
1275                                 x[1] = self.getMountpoint(x[0])
1276                                 x[2] = True
1277                 self.locations = locations
1278
1279         def save(self):
1280                 locations = self.locations
1281                 if self.save_disabled or not locations:
1282                         self.saved_value = None
1283                 else:
1284                         self.saved_value = self.tostring([x[0] for x in locations])
1285
1286         def isChanged(self):
1287                 sv = self.saved_value
1288                 locations = self.locations
1289                 if val is None and not locations:
1290                         return False
1291                 return self.tostring([x[0] for x in locations]) != sv
1292
1293         def mountpointsChanged(self, action, dev):
1294                 print "Mounts changed: ", action, dev
1295                 mp = dev.mountpoint+"/"
1296                 if action == "add":
1297                         self.addedMount(mp)
1298                 elif action == "remove":
1299                         self.removedMount(mp)
1300                 self.refreshMountpoints()
1301
1302         def addedMount(self, mp):
1303                 for x in self.locations:
1304                         if x[1] == mp:
1305                                 x[2] = True
1306                         elif x[1] == None and os_path.exists(x[0]):
1307                                 x[1] = self.getMountpoint(x[0])
1308                                 x[2] = True
1309
1310         def removedMount(self, mp):
1311                 for x in self.locations:
1312                         if x[1] == mp:
1313                                 x[2] = False
1314
1315         def refreshMountpoints(self):
1316                 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1317                 self.mountpoints.sort(key = lambda x: -len(x))
1318
1319         def checkChangedMountpoints(self):
1320                 oldmounts = self.mountpoints
1321                 self.refreshMountpoints()
1322                 newmounts = self.mountpoints
1323                 if oldmounts == newmounts:
1324                         return
1325                 for x in oldmounts:
1326                         if not x in newmounts:
1327                                 self.removedMount(x)
1328                 for x in newmounts:
1329                         if not x in oldmounts:
1330                                 self.addedMount(x)
1331
1332         def getMountpoint(self, file):
1333                 file = os_path.realpath(file)+"/"
1334                 for m in self.mountpoints:
1335                         if file.startswith(m):
1336                                 return m
1337                 return None
1338
1339         def handleKey(self, key):
1340                 if key == KEY_LEFT:
1341                         self.pos -= 1
1342                         if self.pos < -1:
1343                                 self.pos = len(self.value)-1
1344                 elif key == KEY_RIGHT:
1345                         self.pos += 1
1346                         if self.pos >= len(self.value):
1347                                 self.pos = -1
1348                 elif key in [KEY_HOME, KEY_END]:
1349                         self.pos = -1
1350
1351         def getText(self):
1352                 return " ".join(self.value)
1353
1354         def getMulti(self, selected):
1355                 if not selected:
1356                         valstr = " ".join(self.value)
1357                         if self.visible_width and len(valstr) > self.visible_width:
1358                                 return ("text", valstr[0:self.visible_width])
1359                         else:
1360                                 return ("text", valstr)
1361                 else:
1362                         i = 0
1363                         valstr = ""
1364                         ind1 = 0
1365                         ind2 = 0
1366                         for val in self.value:
1367                                 if i == self.pos:
1368                                         ind1 = len(valstr)
1369                                 valstr += str(val)+" "
1370                                 if i == self.pos:
1371                                         ind2 = len(valstr)
1372                                 i += 1
1373                         if self.visible_width and len(valstr) > self.visible_width:
1374                                 if ind1+1 < self.visible_width/2:
1375                                         off = 0
1376                                 else:
1377                                         off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1378                                 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1379                         else:
1380                                 return ("mtext", valstr, range(ind1,ind2))
1381
1382         def onDeselect(self, session):
1383                 self.pos = -1
1384
1385 # nothing.
1386 class ConfigNothing(ConfigSelection):
1387         def __init__(self):
1388                 ConfigSelection.__init__(self, choices = [("","")])
1389
1390 # until here, 'saved_value' always had to be a *string*.
1391 # now, in ConfigSubsection, and only there, saved_value
1392 # is a dict, essentially forming a tree.
1393 #
1394 # config.foo.bar=True
1395 # config.foobar=False
1396 #
1397 # turns into:
1398 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1399 #
1400
1401 class ConfigSubsectionContent(object):
1402         pass
1403
1404 # we store a backup of the loaded configuration
1405 # data in self.stored_values, to be able to deploy
1406 # them when a new config element will be added,
1407 # so non-default values are instantly available
1408
1409 # A list, for example:
1410 # config.dipswitches = ConfigSubList()
1411 # config.dipswitches.append(ConfigYesNo())
1412 # config.dipswitches.append(ConfigYesNo())
1413 # config.dipswitches.append(ConfigYesNo())
1414 class ConfigSubList(list, object):
1415         def __init__(self):
1416                 list.__init__(self)
1417                 self.stored_values = {}
1418
1419         def save(self):
1420                 for x in self:
1421                         x.save()
1422
1423         def load(self):
1424                 for x in self:
1425                         x.load()
1426
1427         def getSavedValue(self):
1428                 res = { }
1429                 for i, val in enumerate(self):
1430                         sv = val.saved_value
1431                         if sv is not None:
1432                                 res[str(i)] = sv
1433                 return res
1434
1435         def setSavedValue(self, values):
1436                 self.stored_values = dict(values)
1437                 for (key, val) in self.stored_values.items():
1438                         if int(key) < len(self):
1439                                 self[int(key)].saved_value = val
1440
1441         saved_value = property(getSavedValue, setSavedValue)
1442
1443         def append(self, item):
1444                 i = str(len(self))
1445                 list.append(self, item)
1446                 if i in self.stored_values:
1447                         item.saved_value = self.stored_values[i]
1448                         item.load()
1449
1450         def dict(self):
1451                 return dict([(str(index), value) for index, value in enumerate(self)])
1452
1453 # same as ConfigSubList, just as a dictionary.
1454 # care must be taken that the 'key' has a proper
1455 # str() method, because it will be used in the config
1456 # file.
1457 class ConfigSubDict(dict, object):
1458         def __init__(self):
1459                 dict.__init__(self)
1460                 self.stored_values = {}
1461
1462         def save(self):
1463                 for x in self.values():
1464                         x.save()
1465
1466         def load(self):
1467                 for x in self.values():
1468                         x.load()
1469
1470         def getSavedValue(self):
1471                 res = {}
1472                 for (key, val) in self.items():
1473                         sv = val.saved_value
1474                         if sv is not None:
1475                                 res[str(key)] = sv
1476                 return res
1477
1478         def setSavedValue(self, values):
1479                 self.stored_values = dict(values)
1480                 for (key, val) in self.items():
1481                         if str(key) in self.stored_values:
1482                                 val = self.stored_values[str(key)]
1483
1484         saved_value = property(getSavedValue, setSavedValue)
1485
1486         def __setitem__(self, key, item):
1487                 dict.__setitem__(self, key, item)
1488                 if str(key) in self.stored_values:
1489                         item.saved_value = self.stored_values[str(key)]
1490                         item.load()
1491
1492         def dict(self):
1493                 return self
1494
1495 # Like the classes above, just with a more "native"
1496 # syntax.
1497 #
1498 # some evil stuff must be done to allow instant
1499 # loading of added elements. this is why this class
1500 # is so complex.
1501 #
1502 # we need the 'content' because we overwrite
1503 # __setattr__.
1504 # If you don't understand this, try adding
1505 # __setattr__ to a usual exisiting class and you will.
1506 class ConfigSubsection(object):
1507         def __init__(self):
1508                 self.__dict__["content"] = ConfigSubsectionContent()
1509                 self.content.items = { }
1510                 self.content.stored_values = { }
1511
1512         def __setattr__(self, name, value):
1513                 if name == "saved_value":
1514                         return self.setSavedValue(value)
1515                 assert isinstance(value, (ConfigSubsection, ConfigElement, ConfigSubList, ConfigSubDict)), "ConfigSubsections can only store ConfigSubsections, ConfigSubLists, ConfigSubDicts or ConfigElements"
1516                 content = self.content
1517                 content.items[name] = value
1518                 x = content.stored_values.get(name, None)
1519                 if x is not None:
1520                         #print "ok, now we have a new item,", name, "and have the following value for it:", x
1521                         value.saved_value = x
1522                         value.load()
1523
1524         def __getattr__(self, name):
1525                 return self.content.items[name]
1526
1527         def getSavedValue(self):
1528                 res = self.content.stored_values
1529                 for (key, val) in self.content.items.items():
1530                         sv = val.saved_value
1531                         if sv is not None:
1532                                 res[key] = sv
1533                         elif key in res:
1534                                 del res[key]
1535                 return res
1536
1537         def setSavedValue(self, values):
1538                 values = dict(values)
1539                 self.content.stored_values = values
1540                 for (key, val) in self.content.items.items():
1541                         value = values.get(key, None)
1542                         if value is not None:
1543                                 val.saved_value = value
1544
1545         saved_value = property(getSavedValue, setSavedValue)
1546
1547         def save(self):
1548                 for x in self.content.items.values():
1549                         x.save()
1550
1551         def load(self):
1552                 for x in self.content.items.values():
1553                         x.load()
1554
1555         def dict(self):
1556                 return self.content.items
1557
1558 # the root config object, which also can "pickle" (=serialize)
1559 # down the whole config tree.
1560 #
1561 # we try to keep non-existing config entries, to apply them whenever
1562 # a new config entry is added to a subsection
1563 # also, non-existing config entries will be saved, so they won't be
1564 # lost when a config entry disappears.
1565 class Config(ConfigSubsection):
1566         def __init__(self):
1567                 ConfigSubsection.__init__(self)
1568
1569         def pickle_this(self, prefix, topickle, result):
1570                 for (key, val) in topickle.items():
1571                         name = '.'.join((prefix, key))
1572                         if isinstance(val, dict):
1573                                 self.pickle_this(name, val, result)
1574                         elif isinstance(val, tuple):
1575                                 result += [name, '=', val[0], '\n']
1576                         else:
1577                                 result += [name, '=', val, '\n']
1578
1579         def pickle(self):
1580                 result = []
1581                 self.pickle_this("config", self.saved_value, result)
1582                 return ''.join(result)
1583
1584         def unpickle(self, lines):
1585                 tree = { }
1586                 for l in lines:
1587                         if not l or l[0] == '#':
1588                                 continue
1589
1590                         n = l.find('=')
1591                         val = l[n+1:].strip()
1592
1593                         names = l[:n].split('.')
1594 #                       if val.find(' ') != -1:
1595 #                               val = val[:val.find(' ')]
1596
1597                         base = tree
1598
1599                         for n in names[:-1]:
1600                                 base = base.setdefault(n, {})
1601
1602                         base[names[-1]] = val
1603
1604                 # we inherit from ConfigSubsection, so ...
1605                 #object.__setattr__(self, "saved_value", tree["config"])
1606                 if "config" in tree:
1607                         self.setSavedValue(tree["config"])
1608
1609         def saveToFile(self, filename):
1610                 f = open(filename, "w")
1611                 f.write(self.pickle())
1612                 f.close()
1613
1614         def loadFromFile(self, filename):
1615                 f = open(filename, "r")
1616                 self.unpickle(f.readlines())
1617                 f.close()
1618
1619 config = Config()
1620 config.misc = ConfigSubsection()
1621
1622 class ConfigFile:
1623         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1624
1625         def load(self):
1626                 try:
1627                         config.loadFromFile(self.CONFIG_FILE)
1628                 except IOError, e:
1629                         print "unable to load config (%s), assuming defaults..." % str(e)
1630
1631         def save(self):
1632 #               config.save()
1633                 config.saveToFile(self.CONFIG_FILE)
1634
1635         def __resolveValue(self, pickles, cmap):
1636                 key = pickles[0]
1637                 if cmap.has_key(key):
1638                         if len(pickles) > 1:
1639                                 return self.__resolveValue(pickles[1:], cmap[key].dict())
1640                         else:
1641                                 return str(cmap[key].value)
1642                 return None
1643
1644         def getResolvedKey(self, key):
1645                 names = key.split('.')
1646                 if len(names) > 1:
1647                         if names[0] == "config":
1648                                 ret=self.__resolveValue(names[1:], config.content.items)
1649                                 if ret and len(ret):
1650                                         return ret
1651                 print "getResolvedKey", key, "failed !! (Typo??)"
1652                 return ""
1653
1654 def NoSave(element):
1655         element.disableSave()
1656         return element
1657
1658 configfile = ConfigFile()
1659
1660 configfile.load()
1661
1662 def getConfigListEntry(*args):
1663         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1664         return args
1665
1666 def updateConfigElement(element, newelement):
1667         newelement.value = element.value
1668         return newelement
1669
1670 #def _(x):
1671 #       return x
1672 #
1673 #config.bla = ConfigSubsection()
1674 #config.bla.test = ConfigYesNo()
1675 #config.nim = ConfigSubList()
1676 #config.nim.append(ConfigSubsection())
1677 #config.nim[0].bla = ConfigYesNo()
1678 #config.nim.append(ConfigSubsection())
1679 #config.nim[1].bla = ConfigYesNo()
1680 #config.nim[1].blub = ConfigYesNo()
1681 #config.arg = ConfigSubDict()
1682 #config.arg["Hello"] = ConfigYesNo()
1683 #
1684 #config.arg["Hello"].handleKey(KEY_RIGHT)
1685 #config.arg["Hello"].handleKey(KEY_RIGHT)
1686 #
1687 ##config.saved_value
1688 #
1689 ##configfile.save()
1690 #config.save()
1691 #print config.pickle()