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