lib/python/Components/config.py

   1 import time
   2 from Tools.NumericalTextInput import NumericalTextInput
   3 from Tools.Directories import resolveFilename, SCOPE_CONFIG
   4 import copy
   5
   6
   7 # ConfigElement, the base class of all ConfigElements.
   8
   9 # it stores:
  10 #   value    the current value, usefully encoded.
  11 #            usually a property which retrieves _value,
  12 #            and maybe does some reformatting
  13 #   _value   the value as it's going to be saved in the configfile,
  14 #            though still in non-string form.
  15 #            this is the object which is actually worked on.
  16 #   default  the initial value. If _value is equal to default,
  17 #            it will not be stored in the config file
  18 #   saved_value is a text representation of _value, stored in the config file
  19 #
  20 # and has (at least) the following methods:
  21 #   save()   stores _value into saved_value,
  22 #            (or stores 'None' if it should not be stored)
  23 #   load()   loads _value from saved_value, or loads
  24 #            the default if saved_value is 'None' (default)
  25 #            or invalid.
  26 #
  27 class ConfigElement(object):
  28         def __init__(self):
  29
  30                 object.__init__(self)
  31                 self.saved_value = None
  32                 self.save_disabled = False
  33                 self.notifiers = []
  34                 self.enabled = True
  35
  36         # you need to override this to do input validation
  37         def setValue(self, value):
  38                 self._value = value
  39                 self.changed()
  40
  41         def getValue(self):
  42                 return self._value
  43
  44         value = property(getValue, setValue)
  45
  46         # you need to override this if self.value is not a string
  47         def fromstring(self, value):
  48                 return value
  49
  50         # you can overide this for fancy default handling
  51         def load(self):
  52                 if self.saved_value is None:
  53                         self.value = self.default
  54                 else:
  55                         self.value = self.fromstring(self.saved_value)
  56
  57         def tostring(self, value):
  58                 return str(value)
  59
  60         # you need to override this if str(self.value) doesn't work
  61         def save(self):
  62                 if self.save_disabled or self.value == self.default:
  63                         self.saved_value = None
  64                 else:
  65                         self.saved_value = self.tostring(self.value)
  66
  67         def cancel(self):
  68                 self.load()
  69
  70         def isChanged(self):
  71                 if self.saved_value is None and self.value == self.default:
  72                         return False
  73                 return self.tostring(self.value) != self.saved_value
  74
  75         def changed(self):
  76                 for x in self.notifiers:
  77                         x(self)
  78
  79         def addNotifier(self, notifier, initial_call = True):
  80                 assert callable(notifier), "notifiers must be callable"
  81                 self.notifiers.append(notifier)
  82
  83                 # CHECKME:
  84                 # do we want to call the notifier
  85                 #  - at all when adding it? (yes, though optional)
  86                 #  - when the default is active? (yes)
  87                 #  - when no value *yet* has been set,
  88                 #    because no config has ever been read (currently yes)
  89                 #    (though that's not so easy to detect.
  90                 #     the entry could just be new.)
  91                 if initial_call:
  92                         notifier(self)
  93
  94         def disableSave(self):
  95                 self.save_disabled = True
  96
  97         def __call__(self, selected):
  98                 return self.getMulti(selected)
  99
 100         def helpWindow(self):
 101                 return None
 102
 103 KEY_LEFT = 0
 104 KEY_RIGHT = 1
 105 KEY_OK = 2
 106 KEY_DELETE = 3
 107 KEY_TIMEOUT = 4
 108 KEY_NUMBERS = range(12, 12+10)
 109 KEY_0 = 12
 110 KEY_9 = 12+9
 111
 112 def getKeyNumber(key):
 113         assert key in KEY_NUMBERS
 114         return key - KEY_0
 115
 116 #
 117 # ConfigSelection is a "one of.."-type.
 118 # it has the "choices", usually a list, which contains
 119 # (id, desc)-tuples (or just only the ids, in case the id
 120 # will be used as description)
 121 #
 122 # all ids MUST be plain strings.
 123 #
 124 class ConfigSelection(ConfigElement):
 125         def __init__(self, choices, default = None):
 126                 ConfigElement.__init__(self)
 127                 self.choices = []
 128                 self.description = {}
 129
 130                 if isinstance(choices, list):
 131                         for x in choices:
 132                                 if isinstance(x, tuple):
 133                                         self.choices.append(x[0])
 134                                         self.description[x[0]] = x[1]
 135                                 else:
 136                                         self.choices.append(x)
 137                                         self.description[x] = x
 138                 elif isinstance(choices, dict):
 139                         for (key, val) in choices.items():
 140                                 self.choices.append(key)
 141                                 self.description[key] = val
 142                 else:
 143                         assert False, "ConfigSelection choices must be dict or list!"
 144
 145                 #assert len(self.choices), "you can't have an empty configselection"
 146                 if len(self.choices) == 0:
 147                         self.choices = [""]
 148                         self.description[""] = ""
 149
 150                 if default is None:
 151                         default = self.choices[0]
 152
 153                 assert default in self.choices, "default must be in choice list, but " + repr(default) + " is not!"
 154                 for x in self.choices:
 155                         assert isinstance(x, str), "ConfigSelection choices must be strings"
 156
 157                 self.value = self.default = default
 158
 159         def setValue(self, value):
 160                 if value in self.choices:
 161                         self._value = value
 162                 else:
 163                         self._value = self.default
 164
 165                 self.changed()
 166
 167         def tostring(self, val):
 168                 return val
 169
 170         def getValue(self):
 171                 return self._value
 172
 173         def setCurrentText(self, text):
 174                 i = self.choices.index(self.value)
 175                 del self.description[self.choices[i]]
 176                 self.choices[i] = text
 177                 self.description[text] = text
 178                 self._value = text
 179
 180         value = property(getValue, setValue)
 181
 182         def getIndex(self):
 183                 return self.choices.index(self.value)
 184
 185         index = property(getIndex)
 186
 187         # GUI
 188         def handleKey(self, key):
 189                 nchoices = len(self.choices)
 190                 i = self.choices.index(self.value)
 191                 if key == KEY_LEFT:
 192                         self.value = self.choices[(i + nchoices - 1) % nchoices]
 193                 elif key == KEY_RIGHT:
 194                         self.value = self.choices[(i + 1) % nchoices]
 195
 196         def getText(self):
 197                 return _(self.description[self.value])
 198
 199         def getMulti(self, selected):
 200                 return ("text", _(self.description[self.value]))
 201
 202         # HTML
 203         def getHTML(self, id):
 204                 res = ""
 205                 for v in self.choices:
 206                         if self.value == v:
 207                                 checked = 'checked="checked" '
 208                         else:
 209                                 checked = ''
 210                         res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + self.description[v] + "</input></br>\n"
 211                 return res;
 212
 213         def unsafeAssign(self, value):
 214                 # setValue does check if value is in choices. This is safe enough.
 215                 self.value = value
 216
 217 # a binary decision.
 218 #
 219 # several customized versions exist for different
 220 # descriptions.
 221 #
 222 class ConfigBoolean(ConfigElement):
 223         def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
 224                 ConfigElement.__init__(self)
 225                 self.descriptions = descriptions
 226                 self.value = self.default = default
 227         def handleKey(self, key):
 228                 if key in [KEY_LEFT, KEY_RIGHT]:
 229                         self.value = not self.value
 230
 231         def getText(self):
 232                 return _(self.descriptions[self.value])
 233
 234         def getMulti(self, selected):
 235                 return ("text", _(self.descriptions[self.value]))
 236
 237         def tostring(self, value):
 238                 if not value:
 239                         return "false"
 240                 else:
 241                         return "true"
 242
 243         def fromstring(self, val):
 244                 if val == "true":
 245                         return True
 246                 else:
 247                         return False
 248
 249         def getHTML(self, id):
 250                 if self.value:
 251                         checked = ' checked="checked"'
 252                 else:
 253                         checked = ''
 254                 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
 255
 256         # this is FLAWED. and must be fixed.
 257         def unsafeAssign(self, value):
 258                 if value == "1":
 259                         self.value = True
 260                 else:
 261                         self.value = False
 262
 263 class ConfigYesNo(ConfigBoolean):
 264         def __init__(self, default = False):
 265                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
 266
 267 class ConfigOnOff(ConfigBoolean):
 268         def __init__(self, default = False):
 269                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
 270
 271 class ConfigEnableDisable(ConfigBoolean):
 272         def __init__(self, default = False):
 273                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
 274
 275 class ConfigDateTime(ConfigElement):
 276         def __init__(self, default, formatstring, increment = 86400):
 277                 ConfigElement.__init__(self)
 278                 self.increment = increment
 279                 self.formatstring = formatstring
 280                 self.value = self.default = int(default)
 281
 282         def handleKey(self, key):
 283                 if key == KEY_LEFT:
 284                         self.value = self.value - self.increment
 285                 if key == KEY_RIGHT:
 286                         self.value = self.value + self.increment
 287
 288
 289         def getText(self):
 290                 return time.strftime(self.formatstring, time.localtime(self.value))
 291
 292         def getMulti(self, selected):
 293                 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
 294
 295         def fromstring(self, val):
 296                 return int(val)
 297
 298 # *THE* mighty config element class
 299 #
 300 # allows you to store/edit a sequence of values.
 301 # can be used for IP-addresses, dates, plain integers, ...
 302 # several helper exist to ease this up a bit.
 303 #
 304 class ConfigSequence(ConfigElement):
 305         def __init__(self, seperator, limits, censor_char = "", default = None):
 306                 ConfigElement.__init__(self)
 307                 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
 308                 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
 309                 #assert isinstance(default, list), "default must be a list"
 310                 #assert isinstance(default[0], int), "list must contain numbers"
 311                 #assert len(default) == len(limits), "length must match"
 312
 313                 self.marked_pos = 0
 314                 self.seperator = seperator
 315                 self.limits = limits
 316                 self.censor_char = censor_char
 317
 318                 self.default = default
 319                 self.value = copy.copy(default)
 320
 321         def validate(self):
 322                 max_pos = 0
 323                 num = 0
 324                 for i in self._value:
 325                         max_pos += len(str(self.limits[num][1]))
 326
 327                         while self._value[num] < self.limits[num][0]:
 328                                 self.value[num] += 1
 329
 330                         while self._value[num] > self.limits[num][1]:
 331                                 self._value[num] -= 1
 332
 333                         num += 1
 334
 335                 if self.marked_pos >= max_pos:
 336                         self.marked_pos = max_pos - 1
 337
 338                 if self.marked_pos < 0:
 339                         self.marked_pos = 0
 340
 341         def validatePos(self):
 342                 if self.marked_pos < 0:
 343                         self.marked_pos = 0
 344
 345                 total_len = sum([len(str(x[1])) for x in self.limits])
 346
 347                 if self.marked_pos >= total_len:
 348                         self.marked_pos = total_len - 1
 349
 350         def handleKey(self, key):
 351                 if key == KEY_LEFT:
 352                         self.marked_pos -= 1
 353                         self.validatePos()
 354
 355                 if key == KEY_RIGHT:
 356                         self.marked_pos += 1
 357                         self.validatePos()
 358
 359                 if key in KEY_NUMBERS:
 360                         block_len = []
 361                         for x in self.limits:
 362                                 block_len.append(len(str(x[1])))
 363
 364                         total_len = sum(block_len)
 365
 366                         pos = 0
 367                         blocknumber = 0
 368                         block_len_total = [0, ]
 369                         for x in block_len:
 370                                 pos += block_len[blocknumber]
 371                                 block_len_total.append(pos)
 372                                 if pos - 1 >= self.marked_pos:
 373                                         pass
 374                                 else:
 375                                         blocknumber += 1
 376
 377                         number = getKeyNumber(key)
 378
 379                         # length of numberblock
 380                         number_len = len(str(self.limits[blocknumber][1]))
 381
 382                         # position in the block
 383                         posinblock = self.marked_pos - block_len_total[blocknumber]
 384
 385                         oldvalue = self._value[blocknumber]
 386                         olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
 387                         newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
 388
 389                         self._value[blocknumber] = newvalue
 390                         self.marked_pos += 1
 391
 392                         self.validate()
 393                         self.changed()
 394
 395         def genText(self):
 396                 value = ""
 397                 mPos = self.marked_pos
 398                 num = 0;
 399                 for i in self._value:
 400                         if len(value):  #fixme no heading separator possible
 401                                 value += self.seperator
 402                                 if mPos >= len(value) - 1:
 403                                         mPos += 1
 404
 405                         if self.censor_char == "":
 406                                 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
 407                         else:
 408                                 value += (self.censor_char * len(str(self.limits[num][1])))
 409                         num += 1
 410                 return (value, mPos)
 411
 412         def getText(self):
 413                 (value, mPos) = self.genText()
 414                 return value
 415
 416         def getMulti(self, selected):
 417                 (value, mPos) = self.genText()
 418                         # only mark cursor when we are selected
 419                         # (this code is heavily ink optimized!)
 420                 if self.enabled:
 421                         return ("mtext"[1-selected:], value, [mPos])
 422                 else:
 423                         return ("text", value)
 424
 425         def tostring(self, val):
 426                 return self.seperator.join([self.saveSingle(x) for x in val])
 427
 428         def saveSingle(self, v):
 429                 return str(v)
 430
 431         def fromstring(self, value):
 432                 return [int(x) for x in self.saved_value.split(self.seperator)]
 433
 434 class ConfigIP(ConfigSequence):
 435         def __init__(self, default):
 436                 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
 437
 438 class ConfigMAC(ConfigSequence):
 439         def __init__(self, default):
 440                 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
 441
 442 class ConfigPosition(ConfigSequence):
 443         def __init__(self, default, args):
 444                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
 445
 446 class ConfigClock(ConfigSequence):
 447         def __init__(self, default):
 448                 import time
 449                 t = time.localtime(default)
 450                 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
 451
 452 class ConfigInteger(ConfigSequence):
 453         def __init__(self, default, limits = (0, 10000000000)):
 454                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
 455
 456         # you need to override this to do input validation
 457         def setValue(self, value):
 458                 self._value = [value]
 459                 self.changed()
 460
 461         def getValue(self):
 462                 return self._value[0]
 463
 464         value = property(getValue, setValue)
 465
 466         def fromstring(self, value):
 467                 return int(value)
 468
 469         def tostring(self, value):
 470                 return str(value)
 471
 472 class ConfigPIN(ConfigInteger):
 473         def __init__(self, default, len = 4, censor = ""):
 474                 assert isinstance(default, int), "ConfigPIN default must be an integer"
 475                 if default == -1:
 476                         default = "aaaa"
 477                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
 478                 self.len = len
 479
 480         def getLength(self):
 481                 return self.len
 482
 483 class ConfigFloat(ConfigSequence):
 484         def __init__(self, default, limits):
 485                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
 486
 487         def getFloat(self):
 488                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
 489
 490         float = property(getFloat)
 491
 492 # an editable text...
 493 class ConfigText(ConfigElement, NumericalTextInput):
 494         def __init__(self, default = "", fixed_size = True):
 495                 ConfigElement.__init__(self)
 496                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
 497
 498                 self.marked_pos = 0
 499                 self.fixed_size = fixed_size
 500
 501                 self.value = self.default = default
 502
 503         def validateMarker(self):
 504                 if self.marked_pos < 0:
 505                         self.marked_pos = 0
 506                 if self.marked_pos >= len(self.text):
 507                         self.marked_pos = len(self.text) - 1
 508
 509         #def nextEntry(self):
 510         #       self.vals[1](self.getConfigPath())
 511
 512         def handleKey(self, key):
 513                 # this will no change anything on the value itself
 514                 # so we can handle it here in gui element
 515                 if key == KEY_DELETE:
 516                         self.text = self.text[0:self.marked_pos] + self.text[self.marked_pos + 1:]
 517                 elif key == KEY_LEFT:
 518                         self.marked_pos -= 1
 519                 elif key == KEY_RIGHT:
 520                         self.marked_pos += 1
 521                         if not self.fixed_size:
 522                                 if self.marked_pos >= len(self.text):
 523                                         self.text = self.text.ljust(len(self.text) + 1)
 524                 elif key in KEY_NUMBERS:
 525                         number = self.getKey(getKeyNumber(key))
 526                         self.text = self.text[0:self.marked_pos] + unicode(number) + self.text[self.marked_pos + 1:]
 527                 elif key == KEY_TIMEOUT:
 528                         self.timeout()
 529                         return
 530
 531                 self.validateMarker()
 532                 self.changed()
 533
 534         def nextFunc(self):
 535                 self.marked_pos += 1
 536                 self.validateMarker()
 537                 self.changed()
 538
 539         def getValue(self):
 540                 return self.text.encode("utf-8")
 541
 542         def setValue(self, val):
 543                 try:
 544                         self.text = val.decode("utf-8")
 545                 except UnicodeDecodeError:
 546                         self.text = val
 547                         print "Broken UTF8!"
 548
 549         value = property(getValue, setValue)
 550         _value = property(getValue, setValue)
 551
 552         def getText(self):
 553                 return self.value
 554
 555         def getMulti(self, selected):
 556                 return ("mtext"[1-selected:], self.value, [self.marked_pos])
 557
 558         def helpWindow(self):
 559                 from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
 560                 return (NumericalTextInputHelpDialog,self)
 561
 562         def getHTML(self, id):
 563                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
 564
 565         def unsafeAssign(self, value):
 566                 self.value = str(value)
 567
 568 # a slider.
 569 class ConfigSlider(ConfigElement):
 570         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
 571                 ConfigElement.__init__(self)
 572                 self.value = self.default = default
 573                 self.min = limits[0]
 574                 self.max = limits[1]
 575                 self.increment = increment
 576
 577         def checkValues(self):
 578                 if self.value < self.min:
 579                         self.value = self.min
 580
 581                 if self.value > self.max:
 582                         self.value = self.max
 583
 584         def handleKey(self, key):
 585                 if key == KEY_LEFT:
 586                         self.value -= self.increment
 587                 elif key == KEY_RIGHT:
 588                         self.value += self.increment
 589                 else:
 590                         return
 591
 592                 self.checkValues()
 593                 self.changed()
 594
 595         def getText(self):
 596                 return "%d / %d" % (self.value, self.max)
 597
 598         def getMulti(self, selected):
 599                 self.checkValues()
 600                 return ("slider", self.value, self.max)
 601
 602         def fromstring(self, value):
 603                 return int(value)
 604
 605 # a satlist. in fact, it's a ConfigSelection.
 606 class ConfigSatlist(ConfigSelection):
 607         def __init__(self, list, default = None):
 608                 if default is not None:
 609                         default = str(default)
 610                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc) in list], default = default)
 611
 612         def getOrbitalPosition(self):
 613                 if self.value == "":
 614                         return None
 615                 return int(self.value)
 616
 617         orbital_position = property(getOrbitalPosition)
 618
 619 # nothing.
 620 class ConfigNothing(ConfigSelection):
 621         def __init__(self):
 622                 ConfigSelection.__init__(self, choices = [""])
 623
 624 # until here, 'saved_value' always had to be a *string*.
 625 # now, in ConfigSubsection, and only there, saved_value
 626 # is a dict, essentially forming a tree.
 627 #
 628 # config.foo.bar=True
 629 # config.foobar=False
 630 #
 631 # turns into:
 632 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
 633 #
 634
 635
 636 class ConfigSubsectionContent(object):
 637         pass
 638
 639 # we store a backup of the loaded configuration
 640 # data in self.stored_values, to be able to deploy
 641 # them when a new config element will be added,
 642 # so non-default values are instantly available
 643
 644 # A list, for example:
 645 # config.dipswitches = ConfigSubList()
 646 # config.dipswitches.append(ConfigYesNo())
 647 # config.dipswitches.append(ConfigYesNo())
 648 # config.dipswitches.append(ConfigYesNo())
 649 class ConfigSubList(list, object):
 650         def __init__(self):
 651                 object.__init__(self)
 652                 list.__init__(self)
 653                 self.stored_values = {}
 654
 655         def save(self):
 656                 for x in self:
 657                         x.save()
 658
 659         def load(self):
 660                 for x in self:
 661                         x.load()
 662
 663         def getSavedValue(self):
 664                 res = {}
 665                 for i in range(len(self)):
 666                         sv = self[i].saved_value
 667                         if sv is not None:
 668                                 res[str(i)] = sv
 669                 return res
 670
 671         def setSavedValue(self, values):
 672                 self.stored_values = dict(values)
 673                 for (key, val) in self.stored_values.items():
 674                         if int(key) < len(self):
 675                                 self[int(key)].saved_value = val
 676
 677         saved_value = property(getSavedValue, setSavedValue)
 678
 679         def append(self, item):
 680                 i = str(len(self))
 681                 list.append(self, item)
 682                 if i in self.stored_values:
 683                         item.saved_value = self.stored_values[i]
 684                         item.load()
 685
 686 # same as ConfigSubList, just as a dictionary.
 687 # care must be taken that the 'key' has a proper
 688 # str() method, because it will be used in the config
 689 # file.
 690 class ConfigSubDict(dict, object):
 691         def __init__(self):
 692                 object.__init__(self)
 693                 dict.__init__(self)
 694                 self.stored_values = {}
 695
 696         def save(self):
 697                 for x in self.values():
 698                         x.save()
 699
 700         def load(self):
 701                 for x in self.values():
 702                         x.load()
 703
 704         def getSavedValue(self):
 705                 res = {}
 706                 for (key, val) in self.items():
 707                         if val.saved_value is not None:
 708                                 res[str(key)] = val.saved_value
 709                 return res
 710
 711         def setSavedValue(self, values):
 712                 self.stored_values = dict(values)
 713                 for (key, val) in self.items():
 714                         if str(key) in self.stored_values:
 715                                 val = self.stored_values[str(key)]
 716
 717         saved_value = property(getSavedValue, setSavedValue)
 718
 719         def __setitem__(self, key, item):
 720                 dict.__setitem__(self, key, item)
 721                 if str(key) in self.stored_values:
 722                         item.saved_value = self.stored_values[str(key)]
 723                         item.load()
 724
 725 # Like the classes above, just with a more "native"
 726 # syntax.
 727 #
 728 # some evil stuff must be done to allow instant
 729 # loading of added elements. this is why this class
 730 # is so complex.
 731 #
 732 # we need the 'content' because we overwrite
 733 # __setattr__.
 734 # If you don't understand this, try adding
 735 # __setattr__ to a usual exisiting class and you will.
 736 class ConfigSubsection(object):
 737         def __init__(self):
 738                 object.__init__(self)
 739                 self.__dict__["content"] = ConfigSubsectionContent()
 740                 self.content.items = { }
 741                 self.content.stored_values = { }
 742
 743         def __setattr__(self, name, value):
 744                 if name == "saved_value":
 745                         return self.setSavedValue(value)
 746                 assert isinstance(value, ConfigSubsection) or isinstance(value, ConfigElement) or isinstance(value, ConfigSubList) or isinstance(value, ConfigSubDict), "ConfigSubsections can only store ConfigSubsections, ConfigSubLists, ConfigSubDicts or ConfigElements"
 747                 self.content.items[name] = value
 748                 if name in self.content.stored_values:
 749                         #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
 750                         value.saved_value = self.content.stored_values[name]
 751                         value.load()
 752
 753         def __getattr__(self, name):
 754                 return self.content.items[name]
 755
 756         def getSavedValue(self):
 757                 res = self.content.stored_values
 758                 for (key, val) in self.content.items.items():
 759                         if val.saved_value is not None:
 760                                 res[key] = val.saved_value
 761                         elif key in res:
 762                                 del res[key]
 763
 764                 return res
 765
 766         def setSavedValue(self, values):
 767                 values = dict(values)
 768
 769                 self.content.stored_values = values
 770
 771                 for (key, val) in self.content.items.items():
 772                         if key in values:
 773                                 val.setSavedValue(values[key])
 774
 775         saved_value = property(getSavedValue, setSavedValue)
 776
 777         def save(self):
 778                 for x in self.content.items.values():
 779                         x.save()
 780
 781         def load(self):
 782                 for x in self.content.items.values():
 783                         x.load()
 784
 785 # the root config object, which also can "pickle" (=serialize)
 786 # down the whole config tree.
 787 #
 788 # we try to keep non-existing config entries, to apply them whenever
 789 # a new config entry is added to a subsection
 790 # also, non-existing config entries will be saved, so they won't be
 791 # lost when a config entry disappears.
 792 class Config(ConfigSubsection):
 793         def __init__(self):
 794                 ConfigSubsection.__init__(self)
 795
 796         def pickle_this(self, prefix, topickle, result):
 797                 for (key, val) in topickle.items():
 798                         name = prefix + "." + key
 799
 800                         if isinstance(val, dict):
 801                                 self.pickle_this(name, val, result)
 802                         elif isinstance(val, tuple):
 803                                 result.append(name + "=" + val[0]) # + " ; " + val[1])
 804                         else:
 805                                 result.append(name + "=" + val)
 806
 807         def pickle(self):
 808                 result = [ ]
 809                 self.pickle_this("config", self.saved_value, result)
 810                 return '\n'.join(result) + "\n"
 811
 812         def unpickle(self, lines):
 813                 tree = { }
 814                 for l in lines:
 815                         if not len(l) or l[0] == '#':
 816                                 continue
 817
 818                         n = l.find('=')
 819                         val = l[n+1:].strip()
 820
 821                         names = l[:n].split('.')
 822 #                       if val.find(' ') != -1:
 823 #                               val = val[:val.find(' ')]
 824
 825                         base = tree
 826
 827                         for n in names[:-1]:
 828                                 base = base.setdefault(n, {})
 829
 830                         base[names[-1]] = val
 831
 832                 # we inherit from ConfigSubsection, so ...
 833                 #object.__setattr__(self, "saved_value", tree["config"])
 834                 if "config" in tree:
 835                         self.setSavedValue(tree["config"])
 836
 837         def saveToFile(self, filename):
 838                 f = open(filename, "w")
 839                 f.write(self.pickle())
 840                 f.close()
 841
 842         def loadFromFile(self, filename):
 843                 f = open(filename, "r")
 844                 self.unpickle(f.readlines())
 845                 f.close()
 846
 847 config = Config()
 848 config.misc = ConfigSubsection()
 849
 850 class ConfigFile:
 851         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
 852
 853         def load(self):
 854                 try:
 855                         config.loadFromFile(self.CONFIG_FILE)
 856                 except IOError, e:
 857                         print "unable to load config (%s), assuming defaults..." % str(e)
 858
 859         def save(self):
 860 #               config.save()
 861                 config.saveToFile(self.CONFIG_FILE)
 862
 863         def __resolveValue(self, pickles, cmap):
 864                 if cmap.has_key(pickles[0]):
 865                         if len(pickles) > 1:
 866                                 return self.__resolveValue(pickles[1:], cmap[pickles[0]].content.items)
 867                         else:
 868                                 return str(cmap[pickles[0]].value)
 869                 return None
 870
 871         def getResolvedKey(self, key):
 872                 names = key.split('.')
 873                 if len(names) > 1:
 874                         if names[0] == "config":
 875                                 ret=self.__resolveValue(names[1:], config.content.items)
 876                                 if ret and len(ret):
 877                                         return ret
 878                 print "getResolvedKey", key, "failed !! (Typo??)"
 879                 return ""
 880
 881 def NoSave(element):
 882         element.disableSave()
 883         return element
 884
 885 configfile = ConfigFile()
 886
 887 configfile.load()
 888
 889 def getConfigListEntry(*args):
 890         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
 891         return args
 892
 893 #def _(x):
 894 #       return x
 895 #
 896 #config.bla = ConfigSubsection()
 897 #config.bla.test = ConfigYesNo()
 898 #config.nim = ConfigSubList()
 899 #config.nim.append(ConfigSubsection())
 900 #config.nim[0].bla = ConfigYesNo()
 901 #config.nim.append(ConfigSubsection())
 902 #config.nim[1].bla = ConfigYesNo()
 903 #config.nim[1].blub = ConfigYesNo()
 904 #config.arg = ConfigSubDict()
 905 #config.arg["Hello"] = ConfigYesNo()
 906 #
 907 #config.arg["Hello"].handleKey(KEY_RIGHT)
 908 #config.arg["Hello"].handleKey(KEY_RIGHT)
 909 #
 910 ##config.saved_value
 911 #
 912 ##configfile.save()
 913 #config.save()
 914 #print config.pickle()