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