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