lib/python/Components/config.py

   1 import time
   2 from enigma import getPrevAsciiCode
   3 from Tools.NumericalTextInput import NumericalTextInput
   4 from Tools.Directories import resolveFilename, SCOPE_CONFIG
   5 from Components.Harddisk import harddiskmanager
   6 import copy
   7 import os
   8
   9 # ConfigElement, the base class of all ConfigElements.
  10
  11 # it stores:
  12 #   value    the current value, usefully encoded.
  13 #            usually a property which retrieves _value,
  14 #            and maybe does some reformatting
  15 #   _value   the value as it's going to be saved in the configfile,
  16 #            though still in non-string form.
  17 #            this is the object which is actually worked on.
  18 #   default  the initial value. If _value is equal to default,
  19 #            it will not be stored in the config file
  20 #   saved_value is a text representation of _value, stored in the config file
  21 #
  22 # and has (at least) the following methods:
  23 #   save()   stores _value into saved_value,
  24 #            (or stores 'None' if it should not be stored)
  25 #   load()   loads _value from saved_value, or loads
  26 #            the default if saved_value is 'None' (default)
  27 #            or invalid.
  28 #
  29 class ConfigElement(object):
  30         def __init__(self):
  31
  32                 object.__init__(self)
  33                 self.saved_value = None
  34                 self.save_disabled = False
  35                 self.notifiers = []
  36                 self.enabled = True
  37
  38         # you need to override this to do input validation
  39         def setValue(self, value):
  40                 self._value = value
  41                 self.changed()
  42
  43         def getValue(self):
  44                 return self._value
  45
  46         value = property(getValue, setValue)
  47
  48         # you need to override this if self.value is not a string
  49         def fromstring(self, value):
  50                 return value
  51
  52         # you can overide this for fancy default handling
  53         def load(self):
  54                 sv = self.saved_value
  55                 if sv is None:
  56                         self.value = self.default
  57                 else:
  58                         self.value = self.fromstring(sv)
  59
  60         def tostring(self, value):
  61                 return str(value)
  62
  63         # you need to override this if str(self.value) doesn't work
  64         def save(self):
  65                 if self.save_disabled or self.value == self.default:
  66                         self.saved_value = None
  67                 else:
  68                         self.saved_value = self.tostring(self.value)
  69
  70         def cancel(self):
  71                 self.load()
  72
  73         def isChanged(self):
  74                 sv = self.saved_value
  75                 if sv is None and self.value == self.default:
  76                         return False
  77                 return self.tostring(self.value) != sv
  78
  79         def changed(self):
  80                 for x in self.notifiers:
  81                         x(self)
  82
  83         def addNotifier(self, notifier, initial_call = True):
  84                 assert callable(notifier), "notifiers must be callable"
  85                 self.notifiers.append(notifier)
  86
  87                 # CHECKME:
  88                 # do we want to call the notifier
  89                 #  - at all when adding it? (yes, though optional)
  90                 #  - when the default is active? (yes)
  91                 #  - when no value *yet* has been set,
  92                 #    because no config has ever been read (currently yes)
  93                 #    (though that's not so easy to detect.
  94                 #     the entry could just be new.)
  95                 if initial_call:
  96                         notifier(self)
  97
  98         def disableSave(self):
  99                 self.save_disabled = True
 100
 101         def __call__(self, selected):
 102                 return self.getMulti(selected)
 103
 104         def onSelect(self, session):
 105                 pass
 106
 107         def onDeselect(self, session):
 108                 pass
 109
 110 KEY_LEFT = 0
 111 KEY_RIGHT = 1
 112 KEY_OK = 2
 113 KEY_DELETE = 3
 114 KEY_BACKSPACE = 4
 115 KEY_HOME = 5
 116 KEY_END = 6
 117 KEY_TOGGLEOW = 7
 118 KEY_ASCII = 8
 119 KEY_TIMEOUT = 9
 120 KEY_NUMBERS = range(12, 12+10)
 121 KEY_0 = 12
 122 KEY_9 = 12+9
 123
 124 def getKeyNumber(key):
 125         assert key in KEY_NUMBERS
 126         return key - KEY_0
 127
 128 #
 129 # ConfigSelection is a "one of.."-type.
 130 # it has the "choices", usually a list, which contains
 131 # (id, desc)-tuples (or just only the ids, in case the id
 132 # will be used as description)
 133 #
 134 # all ids MUST be plain strings.
 135 #
 136 class ConfigSelection(ConfigElement):
 137         def __init__(self, choices, default = None):
 138                 ConfigElement.__init__(self)
 139                 self._value = None
 140                 self.setChoices(choices, default)
 141
 142         def setChoices(self, choices, default = None):
 143                 self.choices = []
 144                 self.description = {}
 145
 146                 if isinstance(choices, list):
 147                         for x in choices:
 148                                 if isinstance(x, tuple):
 149                                         self.choices.append(x[0])
 150                                         self.description[x[0]] = x[1]
 151                                 else:
 152                                         self.choices.append(x)
 153                                         self.description[x] = x
 154                 elif isinstance(choices, dict):
 155                         for (key, val) in choices.items():
 156                                 self.choices.append(key)
 157                                 self.description[key] = val
 158                 else:
 159                         assert False, "ConfigSelection choices must be dict or list!"
 160
 161                 #assert len(self.choices), "you can't have an empty configselection"
 162                 if len(self.choices) == 0:
 163                         self.choices = [""]
 164                         self.description[""] = ""
 165
 166                 if default is None:
 167                         default = self.choices[0]
 168
 169                 assert default in self.choices, "default must be in choice list, but " + repr(default) + " is not!"
 170                 for x in self.choices:
 171                         assert isinstance(x, str), "ConfigSelection choices must be strings"
 172
 173                 self.default = default
 174
 175                 if self.value == None or not self.value in self.choices:
 176                         self.value = default
 177
 178         def setValue(self, value):
 179                 if value in self.choices:
 180                         self._value = value
 181                 else:
 182                         self._value = self.default
 183
 184                 self.changed()
 185
 186         def tostring(self, val):
 187                 return val
 188
 189         def getValue(self):
 190                 return self._value
 191
 192         def setCurrentText(self, text):
 193                 i = self.choices.index(self.value)
 194                 del self.description[self.choices[i]]
 195                 self.choices[i] = text
 196                 self.description[text] = text
 197                 self._value = text
 198
 199         value = property(getValue, setValue)
 200
 201         def getIndex(self):
 202                 return self.choices.index(self.value)
 203
 204         index = property(getIndex)
 205
 206         # GUI
 207         def handleKey(self, key):
 208                 nchoices = len(self.choices)
 209                 i = self.choices.index(self.value)
 210                 if key == KEY_LEFT:
 211                         self.value = self.choices[(i + nchoices - 1) % nchoices]
 212                 elif key == KEY_RIGHT:
 213                         self.value = self.choices[(i + 1) % nchoices]
 214                 elif key == KEY_HOME:
 215                         self.value = self.choices[0]
 216                 elif key == KEY_END:
 217                         self.value = self.choices[nchoices - 1]
 218
 219         def selectNext(self):
 220                 nchoices = len(self.choices)
 221                 i = self.choices.index(self.value)
 222                 self.value = self.choices[(i + 1) % nchoices]
 223
 224         def getText(self):
 225                 descr = self.description[self.value]
 226                 if len(descr):
 227                         return _(descr)
 228                 return descr
 229
 230         def getMulti(self, selected):
 231                 descr = self.description[self.value]
 232                 if len(descr):
 233                         return ("text", _(descr))
 234                 return ("text", descr)
 235
 236         # HTML
 237         def getHTML(self, id):
 238                 res = ""
 239                 for v in self.choices:
 240                         if self.value == v:
 241                                 checked = 'checked="checked" '
 242                         else:
 243                                 checked = ''
 244                         res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + self.description[v] + "</input></br>\n"
 245                 return res;
 246
 247         def unsafeAssign(self, value):
 248                 # setValue does check if value is in choices. This is safe enough.
 249                 self.value = value
 250
 251 # a binary decision.
 252 #
 253 # several customized versions exist for different
 254 # descriptions.
 255 #
 256 class ConfigBoolean(ConfigElement):
 257         def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
 258                 ConfigElement.__init__(self)
 259                 self.descriptions = descriptions
 260                 self.value = self.default = default
 261         def handleKey(self, key):
 262                 if key in [KEY_LEFT, KEY_RIGHT]:
 263                         self.value = not self.value
 264                 elif key == KEY_HOME:
 265                         self.value = False
 266                 elif key == KEY_END:
 267                         self.value = True
 268
 269         def getText(self):
 270                 descr = self.descriptions[self.value]
 271                 if len(descr):
 272                         return _(descr)
 273                 return descr
 274
 275         def getMulti(self, selected):
 276                 descr = self.descriptions[self.value]
 277                 if len(descr):
 278                         return ("text", _(descr))
 279                 return ("text", descr)
 280
 281         def tostring(self, value):
 282                 if not value:
 283                         return "false"
 284                 else:
 285                         return "true"
 286
 287         def fromstring(self, val):
 288                 if val == "true":
 289                         return True
 290                 else:
 291                         return False
 292
 293         def getHTML(self, id):
 294                 if self.value:
 295                         checked = ' checked="checked"'
 296                 else:
 297                         checked = ''
 298                 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
 299
 300         # this is FLAWED. and must be fixed.
 301         def unsafeAssign(self, value):
 302                 if value == "1":
 303                         self.value = True
 304                 else:
 305                         self.value = False
 306
 307 class ConfigYesNo(ConfigBoolean):
 308         def __init__(self, default = False):
 309                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
 310
 311 class ConfigOnOff(ConfigBoolean):
 312         def __init__(self, default = False):
 313                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
 314
 315 class ConfigEnableDisable(ConfigBoolean):
 316         def __init__(self, default = False):
 317                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
 318
 319 class ConfigDateTime(ConfigElement):
 320         def __init__(self, default, formatstring, increment = 86400):
 321                 ConfigElement.__init__(self)
 322                 self.increment = increment
 323                 self.formatstring = formatstring
 324                 self.value = self.default = int(default)
 325
 326         def handleKey(self, key):
 327                 if key == KEY_LEFT:
 328                         self.value = self.value - self.increment
 329                 elif key == KEY_RIGHT:
 330                         self.value = self.value + self.increment
 331                 elif key == KEY_HOME or key == KEY_END:
 332                         self.value = self.default
 333
 334         def getText(self):
 335                 return time.strftime(self.formatstring, time.localtime(self.value))
 336
 337         def getMulti(self, selected):
 338                 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
 339
 340         def fromstring(self, val):
 341                 return int(val)
 342
 343 # *THE* mighty config element class
 344 #
 345 # allows you to store/edit a sequence of values.
 346 # can be used for IP-addresses, dates, plain integers, ...
 347 # several helper exist to ease this up a bit.
 348 #
 349 class ConfigSequence(ConfigElement):
 350         def __init__(self, seperator, limits, censor_char = "", default = None):
 351                 ConfigElement.__init__(self)
 352                 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
 353                 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
 354                 #assert isinstance(default, list), "default must be a list"
 355                 #assert isinstance(default[0], int), "list must contain numbers"
 356                 #assert len(default) == len(limits), "length must match"
 357
 358                 self.marked_pos = 0
 359                 self.seperator = seperator
 360                 self.limits = limits
 361                 self.censor_char = censor_char
 362
 363                 self.default = default
 364                 self.value = copy.copy(default)
 365
 366                 self.endNotifier = []
 367
 368         def validate(self):
 369                 max_pos = 0
 370                 num = 0
 371                 for i in self._value:
 372                         max_pos += len(str(self.limits[num][1]))
 373
 374                         if self._value[num] < self.limits[num][0]:
 375                                 self._value[num] = self.limits[num][0]
 376
 377                         if self._value[num] > self.limits[num][1]:
 378                                 self._value[num] = self.limits[num][1]
 379
 380                         num += 1
 381
 382                 if self.marked_pos >= max_pos:
 383                         for x in self.endNotifier:
 384                                 x(self)
 385                         self.marked_pos = max_pos - 1
 386
 387                 if self.marked_pos < 0:
 388                         self.marked_pos = 0
 389
 390         def validatePos(self):
 391                 if self.marked_pos < 0:
 392                         self.marked_pos = 0
 393
 394                 total_len = sum([len(str(x[1])) for x in self.limits])
 395
 396                 if self.marked_pos >= total_len:
 397                         self.marked_pos = total_len - 1
 398
 399         def addEndNotifier(self, notifier):
 400                 self.endNotifier.append(notifier)
 401
 402         def handleKey(self, key):
 403                 if key == KEY_LEFT:
 404                         self.marked_pos -= 1
 405                         self.validatePos()
 406
 407                 if key == KEY_RIGHT:
 408                         self.marked_pos += 1
 409                         self.validatePos()
 410
 411                 if key == KEY_HOME:
 412                         self.marked_pos = 0
 413                         self.validatePos()
 414
 415                 if key == KEY_END:
 416                         max_pos = 0
 417                         num = 0
 418                         for i in self._value:
 419                                 max_pos += len(str(self.limits[num][1]))
 420                                 num += 1
 421                         self.marked_pos = max_pos - 1
 422                         self.validatePos()
 423
 424                 if key in KEY_NUMBERS or key == KEY_ASCII:
 425                         if key == KEY_ASCII:
 426                                 code = getPrevAsciiCode()
 427                                 if code < 48 or code > 57:
 428                                         return
 429                                 number = code - 48
 430                         else:
 431                                 number = getKeyNumber(key)
 432
 433                         block_len = []
 434                         for x in self.limits:
 435                                 block_len.append(len(str(x[1])))
 436
 437                         total_len = sum(block_len)
 438
 439                         pos = 0
 440                         blocknumber = 0
 441                         block_len_total = [0, ]
 442                         for x in block_len:
 443                                 pos += block_len[blocknumber]
 444                                 block_len_total.append(pos)
 445                                 if pos - 1 >= self.marked_pos:
 446                                         pass
 447                                 else:
 448                                         blocknumber += 1
 449
 450                         # length of numberblock
 451                         number_len = len(str(self.limits[blocknumber][1]))
 452
 453                         # position in the block
 454                         posinblock = self.marked_pos - block_len_total[blocknumber]
 455
 456                         oldvalue = self._value[blocknumber]
 457                         olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
 458                         newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
 459
 460                         self._value[blocknumber] = newvalue
 461                         self.marked_pos += 1
 462
 463                         self.validate()
 464                         self.changed()
 465
 466         def genText(self):
 467                 value = ""
 468                 mPos = self.marked_pos
 469                 num = 0;
 470                 for i in self._value:
 471                         if len(value):  #fixme no heading separator possible
 472                                 value += self.seperator
 473                                 if mPos >= len(value) - 1:
 474                                         mPos += 1
 475
 476                         if self.censor_char == "":
 477                                 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
 478                         else:
 479                                 value += (self.censor_char * len(str(self.limits[num][1])))
 480                         num += 1
 481                 return (value, mPos)
 482
 483         def getText(self):
 484                 (value, mPos) = self.genText()
 485                 return value
 486
 487         def getMulti(self, selected):
 488                 (value, mPos) = self.genText()
 489                         # only mark cursor when we are selected
 490                         # (this code is heavily ink optimized!)
 491                 if self.enabled:
 492                         return ("mtext"[1-selected:], value, [mPos])
 493                 else:
 494                         return ("text", value)
 495
 496         def tostring(self, val):
 497                 return self.seperator.join([self.saveSingle(x) for x in val])
 498
 499         def saveSingle(self, v):
 500                 return str(v)
 501
 502         def fromstring(self, value):
 503                 return [int(x) for x in value.split(self.seperator)]
 504
 505 class ConfigIP(ConfigSequence):
 506         def __init__(self, default):
 507                 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
 508
 509         def getHTML(self, id):
 510                 # we definitely don't want leading zeros
 511                 return '.'.join(["%d" % d for d in self.value])
 512
 513         def genText(self):
 514                 value = ""
 515                 mPos = self.marked_pos
 516                 num = 0;
 517                 for i in self._value:
 518                         if len(value):
 519                                 value += self.seperator
 520                                 if mPos >= len(value) - 1:
 521                                         mPos += 1
 522                         value += (" " * (len(str(self.limits[num][1]))-len(str(i))))
 523                         value += str(i)
 524                         num += 1
 525                 return (value, mPos)
 526
 527 class ConfigMAC(ConfigSequence):
 528         def __init__(self, default):
 529                 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
 530
 531 class ConfigPosition(ConfigSequence):
 532         def __init__(self, default, args):
 533                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
 534
 535 class ConfigClock(ConfigSequence):
 536         def __init__(self, default):
 537                 import time
 538                 t = time.localtime(default)
 539                 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
 540
 541 class ConfigInteger(ConfigSequence):
 542         def __init__(self, default, limits = (0, 9999999999)):
 543                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
 544
 545         # you need to override this to do input validation
 546         def setValue(self, value):
 547                 self._value = [value]
 548                 self.changed()
 549
 550         def getValue(self):
 551                 return self._value[0]
 552
 553         value = property(getValue, setValue)
 554
 555         def fromstring(self, value):
 556                 return int(value)
 557
 558         def tostring(self, value):
 559                 return str(value)
 560
 561 class ConfigPIN(ConfigInteger):
 562         def __init__(self, default, len = 4, censor = ""):
 563                 assert isinstance(default, int), "ConfigPIN default must be an integer"
 564                 if default == -1:
 565                         default = "aaaa"
 566                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
 567                 self.len = len
 568
 569         def getLength(self):
 570                 return self.len
 571
 572 class ConfigFloat(ConfigSequence):
 573         def __init__(self, default, limits):
 574                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
 575
 576         def getFloat(self):
 577                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
 578
 579         float = property(getFloat)
 580
 581 # an editable text...
 582 class ConfigText(ConfigElement, NumericalTextInput):
 583         def __init__(self, default = "", fixed_size = True, visible_width = False):
 584                 ConfigElement.__init__(self)
 585                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
 586
 587                 self.marked_pos = 0
 588                 self.allmarked = (default != "")
 589                 self.fixed_size = fixed_size
 590                 self.visible_width = visible_width
 591                 self.offset = 0
 592                 self.overwrite = fixed_size
 593                 self.help_window = None
 594                 self.value = self.default = default
 595
 596         def validateMarker(self):
 597                 if self.fixed_size:
 598                         if self.marked_pos > len(self.text)-1:
 599                                 self.marked_pos = len(self.text)-1
 600                 else:
 601                         if self.marked_pos > len(self.text):
 602                                 self.marked_pos = len(self.text)
 603                 if self.marked_pos < 0:
 604                         self.marked_pos = 0
 605                 if self.visible_width:
 606                         if self.marked_pos < self.offset:
 607                                 self.offset = self.marked_pos
 608                         if self.marked_pos >= self.offset + self.visible_width:
 609                                 if self.marked_pos == len(self.text):
 610                                         self.offset = self.marked_pos - self.visible_width
 611                                 else:
 612                                         self.offset = self.marked_pos - self.visible_width + 1
 613                         if self.offset > 0 and self.offset + self.visible_width > len(self.text):
 614                                 self.offset = max(0, len(self.text) - self.visible_width)
 615
 616         def insertChar(self, ch, pos, owr):
 617                 if owr or self.overwrite:
 618                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
 619                 elif self.fixed_size:
 620                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
 621                 else:
 622                         self.text = self.text[0:pos] + ch + self.text[pos:]
 623
 624         def deleteChar(self, pos):
 625                 if not self.fixed_size:
 626                         self.text = self.text[0:pos] + self.text[pos + 1:]
 627                 elif self.overwrite:
 628                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
 629                 else:
 630                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
 631
 632         def deleteAllChars(self):
 633                 if self.fixed_size:
 634                         self.text = " " * len(self.text)
 635                 else:
 636                         self.text = ""
 637                 self.marked_pos = 0
 638
 639         def handleKey(self, key):
 640                 # this will no change anything on the value itself
 641                 # so we can handle it here in gui element
 642                 if key == KEY_DELETE:
 643                         self.timeout()
 644                         if self.allmarked:
 645                                 self.deleteAllChars()
 646                                 self.allmarked = False
 647                         else:
 648                                 self.deleteChar(self.marked_pos)
 649                                 if self.fixed_size and self.overwrite:
 650                                         self.marked_pos += 1
 651                 elif key == KEY_BACKSPACE:
 652                         self.timeout()
 653                         if self.allmarked:
 654                                 self.deleteAllChars()
 655                                 self.allmarked = False
 656                         elif self.marked_pos > 0:
 657                                 self.deleteChar(self.marked_pos-1)
 658                                 if not self.fixed_size and self.offset > 0:
 659                                         self.offset -= 1
 660                                 self.marked_pos -= 1
 661                 elif key == KEY_LEFT:
 662                         self.timeout()
 663                         if self.allmarked:
 664                                 self.marked_pos = len(self.text)
 665                                 self.allmarked = False
 666                         else:
 667                                 self.marked_pos -= 1
 668                 elif key == KEY_RIGHT:
 669                         self.timeout()
 670                         if self.allmarked:
 671                                 self.marked_pos = 0
 672                                 self.allmarked = False
 673                         else:
 674                                 self.marked_pos += 1
 675                 elif key == KEY_HOME:
 676                         self.timeout()
 677                         self.allmarked = False
 678                         self.marked_pos = 0
 679                 elif key == KEY_END:
 680                         self.timeout()
 681                         self.allmarked = False
 682                         self.marked_pos = len(self.text)
 683                 elif key == KEY_TOGGLEOW:
 684                         self.timeout()
 685                         self.overwrite = not self.overwrite
 686                 elif key == KEY_ASCII:
 687                         self.timeout()
 688                         newChar = unichr(getPrevAsciiCode())
 689                         if self.allmarked:
 690                                 self.deleteAllChars()
 691                                 self.allmarked = False
 692                         self.insertChar(newChar, self.marked_pos, False)
 693                         self.marked_pos += 1
 694                 elif key in KEY_NUMBERS:
 695                         owr = self.lastKey == getKeyNumber(key)
 696                         newChar = self.getKey(getKeyNumber(key))
 697                         if self.allmarked:
 698                                 self.deleteAllChars()
 699                                 self.allmarked = False
 700                         self.insertChar(newChar, self.marked_pos, owr)
 701                 elif key == KEY_TIMEOUT:
 702                         self.timeout()
 703                         if self.help_window:
 704                                 self.help_window.update(self)
 705                         return
 706
 707                 if self.help_window:
 708                         self.help_window.update(self)
 709                 self.validateMarker()
 710                 self.changed()
 711
 712         def nextFunc(self):
 713                 self.marked_pos += 1
 714                 self.validateMarker()
 715                 self.changed()
 716
 717         def getValue(self):
 718                 return self.text.encode("utf-8")
 719
 720         def setValue(self, val):
 721                 try:
 722                         self.text = val.decode("utf-8")
 723                 except UnicodeDecodeError:
 724                         self.text = val
 725                         print "Broken UTF8!"
 726
 727         value = property(getValue, setValue)
 728         _value = property(getValue, setValue)
 729
 730         def getText(self):
 731                 return self.text.encode("utf-8")
 732
 733         def getMulti(self, selected):
 734                 if self.visible_width:
 735                         if self.allmarked:
 736                                 mark = range(0, min(self.visible_width, len(self.text)))
 737                         else:
 738                                 mark = [self.marked_pos-self.offset]
 739                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
 740                 else:
 741                         if self.allmarked:
 742                                 mark = range(0, len(self.text))
 743                         else:
 744                                 mark = [self.marked_pos]
 745                         return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
 746
 747         def onSelect(self, session):
 748                 self.allmarked = (self.value != "")
 749                 if session is not None:
 750                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
 751                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
 752                         self.help_window.show()
 753
 754         def onDeselect(self, session):
 755                 self.marked_pos = 0
 756                 self.offset = 0
 757                 if self.help_window:
 758                         session.deleteDialog(self.help_window)
 759                         self.help_window = None
 760
 761         def getHTML(self, id):
 762                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
 763
 764         def unsafeAssign(self, value):
 765                 self.value = str(value)
 766
 767 class ConfigPassword(ConfigText):
 768         def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
 769                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
 770                 self.censor_char = censor
 771                 self.hidden = True
 772
 773         def getMulti(self, selected):
 774                 mtext, text, mark = ConfigText.getMulti(self, selected)
 775                 if self.hidden:
 776                         text = len(text) * self.censor_char
 777                 return (mtext, text, mark)
 778
 779         def onSelect(self, session):
 780                 ConfigText.onSelect(self, session)
 781                 self.hidden = False
 782
 783         def onDeselect(self, session):
 784                 ConfigText.onDeselect(self, session)
 785                 self.hidden = True
 786
 787 class ConfigNumber(ConfigText):
 788         def __init__(self, default = 0):
 789                 ConfigText.__init__(self, str(default), fixed_size = False)
 790
 791         def getValue(self):
 792                 return int(self.text)
 793
 794         def setValue(self, val):
 795                 self.text = str(val)
 796
 797         value = property(getValue, setValue)
 798         _value = property(getValue, setValue)
 799
 800         def conform(self):
 801                 pos = len(self.text) - self.marked_pos
 802                 self.text = self.text.lstrip("0")
 803                 if self.text == "":
 804                         self.text = "0"
 805                 if pos > len(self.text):
 806                         self.marked_pos = 0
 807                 else:
 808                         self.marked_pos = len(self.text) - pos
 809
 810         def handleKey(self, key):
 811                 if key in KEY_NUMBERS or key == KEY_ASCII:
 812                         if key == KEY_ASCII:
 813                                 ascii = getPrevAsciiCode()
 814                                 if not (48 <= ascii <= 57):
 815                                         return
 816                         else:
 817                                 ascii = getKeyNumber(key) + 48
 818                         newChar = unichr(ascii)
 819                         if self.allmarked:
 820                                 self.deleteAllChars()
 821                                 self.allmarked = False
 822                         self.insertChar(newChar, self.marked_pos, False)
 823                         self.marked_pos += 1
 824                 else:
 825                         ConfigText.handleKey(self, key)
 826                 self.conform()
 827
 828         def onSelect(self, session):
 829                 self.allmarked = (self.value != "")
 830
 831         def onDeselect(self, session):
 832                 self.marked_pos = 0
 833                 self.offset = 0
 834
 835 # a slider.
 836 class ConfigSlider(ConfigElement):
 837         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
 838                 ConfigElement.__init__(self)
 839                 self.value = self.default = default
 840                 self.min = limits[0]
 841                 self.max = limits[1]
 842                 self.increment = increment
 843
 844         def checkValues(self):
 845                 if self.value < self.min:
 846                         self.value = self.min
 847
 848                 if self.value > self.max:
 849                         self.value = self.max
 850
 851         def handleKey(self, key):
 852                 if key == KEY_LEFT:
 853                         self.value -= self.increment
 854                 elif key == KEY_RIGHT:
 855                         self.value += self.increment
 856                 elif key == KEY_HOME:
 857                         self.value = self.min
 858                 elif key == KEY_END:
 859                         self.value = self.max
 860                 else:
 861                         return
 862                 self.checkValues()
 863
 864         def getText(self):
 865                 return "%d / %d" % (self.value, self.max)
 866
 867         def getMulti(self, selected):
 868                 self.checkValues()
 869                 return ("slider", self.value, self.max)
 870
 871         def fromstring(self, value):
 872                 return int(value)
 873
 874 # a satlist. in fact, it's a ConfigSelection.
 875 class ConfigSatlist(ConfigSelection):
 876         def __init__(self, list, default = None):
 877                 if default is not None:
 878                         default = str(default)
 879                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
 880
 881         def getOrbitalPosition(self):
 882                 if self.value == "":
 883                         return None
 884                 return int(self.value)
 885
 886         orbital_position = property(getOrbitalPosition)
 887
 888 class ConfigSet(ConfigElement):
 889         def __init__(self, choices, default = []):
 890                 ConfigElement.__init__(self)
 891                 self.choices = []
 892                 self.description = {}
 893                 if isinstance(choices, list):
 894                         choices.sort()
 895                         for x in choices:
 896                                 if isinstance(x, tuple):
 897                                         self.choices.append(x[0])
 898                                         self.description[x[0]] = str(x[1])
 899                                 else:
 900                                         self.choices.append(x)
 901                                         self.description[x] = str(x)
 902                 else:
 903                         assert False, "ConfigSet choices must be a list!"
 904                 if len(self.choices) == 0:
 905                         self.choices = [""]
 906                         self.description[""] = ""
 907                 if default is None:
 908                         default = []
 909                 self.pos = -1
 910                 default.sort()
 911                 self.default = default
 912                 self.value = default+[]
 913
 914         def toggleChoice(self, choice):
 915                 if choice in self.value:
 916                         self.value.remove(choice)
 917                 else:
 918                         self.value.append(choice)
 919                         self.value.sort()
 920
 921         def handleKey(self, key):
 922                 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
 923                         if self.pos != -1:
 924                                 self.toggleChoice(self.choices[self.pos])
 925                 elif key == KEY_LEFT:
 926                         self.pos -= 1
 927                         if self.pos < -1:
 928                             self.pos = len(self.choices)-1
 929                 elif key == KEY_RIGHT:
 930                         self.pos += 1
 931                         if self.pos >= len(self.choices):
 932                             self.pos = -1
 933                 elif key in [KEY_HOME, KEY_END]:
 934                         self.pos = -1
 935
 936         def genString(self, lst):
 937                 res = ""
 938                 for x in lst:
 939                         res += self.description[x]+" "
 940                 return res
 941
 942         def getText(self):
 943                 return self.genString(self.value)
 944
 945         def getMulti(self, selected):
 946                 if not selected or self.pos == -1:
 947                         return ("text", self.genString(self.value))
 948                 else:
 949                         tmp = self.value+[]
 950                         ch = self.choices[self.pos]
 951                         mem = ch in self.value
 952                         if not mem:
 953                                 tmp.append(ch)
 954                                 tmp.sort()
 955                         ind = tmp.index(ch)
 956                         val1 = self.genString(tmp[:ind])
 957                         val2 = " "+self.genString(tmp[ind+1:])
 958                         if mem:
 959                                 chstr = " "+self.description[ch]+" "
 960                         else:
 961                                 chstr = "("+self.description[ch]+")"
 962                         return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
 963
 964         def onDeselect(self, session):
 965                 self.pos = -1
 966                 self.changed()
 967
 968         def tostring(self, value):
 969                 return str(value)
 970
 971         def fromstring(self, val):
 972                 return eval(val)
 973
 974 class ConfigLocations(ConfigElement):
 975         def __init__(self, default = [], visible_width = False):
 976                 ConfigElement.__init__(self)
 977                 self.visible_width = visible_width
 978                 self.pos = -1
 979                 self.default = default
 980                 self.locations = []
 981                 self.mountpoints = []
 982                 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
 983
 984         def setValue(self, value):
 985                 loc = [x[0] for x in self.locations if x[3]]
 986                 add = [x for x in value if not x in loc]
 987                 diff = add + [x for x in loc if not x in value]
 988                 self.locations = [x for x in self.locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
 989                 self.locations.sort(key = lambda x: x[0])
 990                 self.changed()
 991
 992         def getValue(self):
 993                 self.checkChangedMountpoints()
 994                 for x in self.locations:
 995                         x[3] = x[2]
 996                 return [x[0] for x in self.locations if x[3]]
 997
 998         value = property(getValue, setValue)
 999
1000         def tostring(self, value):
1001                 return str(value)
1002
1003         def fromstring(self, val):
1004                 return eval(val)
1005
1006         def load(self):
1007                 sv = self.saved_value
1008                 if sv is None:
1009                         tmp = self.default
1010                 else:
1011                         tmp = self.fromstring(sv)
1012                 self.locations = [[x, None, False, False] for x in tmp]
1013                 self.refreshMountpoints()
1014                 for x in self.locations:
1015                         if os.path.exists(x[0]):
1016                                 x[1] = self.getMountpoint(x[0])
1017                                 x[2] = True
1018
1019         def save(self):
1020                 if self.save_disabled or self.locations == []:
1021                         self.saved_value = None
1022                 else:
1023                         self.saved_value = self.tostring([x[0] for x in self.locations])
1024
1025         def isChanged(self):
1026                 sv = self.saved_value
1027                 if val is None and self.locations == []:
1028                         return False
1029                 return self.tostring([x[0] for x in self.locations]) != sv
1030
1031         def mountpointsChanged(self, action, dev):
1032                 print "Mounts changed: ", action, dev
1033                 mp = dev.mountpoint+"/"
1034                 if action == "add":
1035                         self.addedMount(mp)
1036                 elif action == "remove":
1037                         self.removedMount(mp)
1038                 self.refreshMountpoints()
1039
1040         def addedMount(self, mp):
1041                 for x in self.locations:
1042                         if x[1] == mp:
1043                                 x[2] = True
1044                         elif x[1] == None and os.path.exists(x[0]):
1045                                 x[1] = self.getMountpoint(x[0])
1046                                 x[2] = True
1047
1048         def removedMount(self, mp):
1049                 for x in self.locations:
1050                         if x[1] == mp:
1051                                 x[2] = False
1052
1053         def refreshMountpoints(self):
1054                 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1055                 self.mountpoints.sort(key = lambda x: -len(x))
1056
1057         def checkChangedMountpoints(self):
1058                 oldmounts = self.mountpoints
1059                 self.refreshMountpoints()
1060                 if oldmounts == self.mountpoints:
1061                         return
1062                 for x in oldmounts:
1063                         if not x in self.mountpoints:
1064                                 self.removedMount(x)
1065                 for x in self.mountpoints:
1066                         if not x in oldmounts:
1067                                 self.addedMount(x)
1068
1069         def getMountpoint(self, file):
1070                 file = os.path.realpath(file)+"/"
1071                 for m in self.mountpoints:
1072                         if file.startswith(m):
1073                                 return m
1074                 return None
1075
1076         def handleKey(self, key):
1077                 if key == KEY_LEFT:
1078                         self.pos -= 1
1079                         if self.pos < -1:
1080                             self.pos = len(self.value)-1
1081                 elif key == KEY_RIGHT:
1082                         self.pos += 1
1083                         if self.pos >= len(self.value):
1084                             self.pos = -1
1085                 elif key in [KEY_HOME, KEY_END]:
1086                         self.pos = -1
1087
1088         def getText(self):
1089                 return " ".join(self.value)
1090
1091         def getMulti(self, selected):
1092                 if not selected:
1093                         valstr = " ".join(self.value)
1094                         if self.visible_width and len(valstr) > self.visible_width:
1095                                 return ("text", valstr[0:self.visible_width])
1096                         else:
1097                                 return ("text", valstr)
1098                 else:
1099                         i = 0
1100                         valstr = ""
1101                         ind1 = 0
1102                         ind2 = 0
1103                         for val in self.value:
1104                                 if i == self.pos:
1105                                         ind1 = len(valstr)
1106                                 valstr += str(val)+" "
1107                                 if i == self.pos:
1108                                         ind2 = len(valstr)
1109                                 i += 1
1110                         if self.visible_width and len(valstr) > self.visible_width:
1111                                 if ind1+1 < self.visible_width/2:
1112                                         off = 0
1113                                 else:
1114                                         off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1115                                 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1116                         else:
1117                                 return ("mtext", valstr, range(ind1,ind2))
1118
1119         def onDeselect(self, session):
1120                 self.pos = -1
1121
1122 # nothing.
1123 class ConfigNothing(ConfigSelection):
1124         def __init__(self):
1125                 ConfigSelection.__init__(self, choices = [""])
1126
1127 # until here, 'saved_value' always had to be a *string*.
1128 # now, in ConfigSubsection, and only there, saved_value
1129 # is a dict, essentially forming a tree.
1130 #
1131 # config.foo.bar=True
1132 # config.foobar=False
1133 #
1134 # turns into:
1135 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1136 #
1137
1138
1139 class ConfigSubsectionContent(object):
1140         pass
1141
1142 # we store a backup of the loaded configuration
1143 # data in self.stored_values, to be able to deploy
1144 # them when a new config element will be added,
1145 # so non-default values are instantly available
1146
1147 # A list, for example:
1148 # config.dipswitches = ConfigSubList()
1149 # config.dipswitches.append(ConfigYesNo())
1150 # config.dipswitches.append(ConfigYesNo())
1151 # config.dipswitches.append(ConfigYesNo())
1152 class ConfigSubList(list, object):
1153         def __init__(self):
1154                 object.__init__(self)
1155                 list.__init__(self)
1156                 self.stored_values = {}
1157
1158         def save(self):
1159                 for x in self:
1160                         x.save()
1161
1162         def load(self):
1163                 for x in self:
1164                         x.load()
1165
1166         def getSavedValue(self):
1167                 res = {}
1168                 for i in range(len(self)):
1169                         sv = self[i].saved_value
1170                         if sv is not None:
1171                                 res[str(i)] = sv
1172                 return res
1173
1174         def setSavedValue(self, values):
1175                 self.stored_values = dict(values)
1176                 for (key, val) in self.stored_values.items():
1177                         if int(key) < len(self):
1178                                 self[int(key)].saved_value = val
1179
1180         saved_value = property(getSavedValue, setSavedValue)
1181
1182         def append(self, item):
1183                 i = str(len(self))
1184                 list.append(self, item)
1185                 if i in self.stored_values:
1186                         item.saved_value = self.stored_values[i]
1187                         item.load()
1188
1189         def dict(self):
1190                 res = dict()
1191                 for index in range(len(self)):
1192                         res[str(index)] = self[index]
1193                 return res
1194
1195 # same as ConfigSubList, just as a dictionary.
1196 # care must be taken that the 'key' has a proper
1197 # str() method, because it will be used in the config
1198 # file.
1199 class ConfigSubDict(dict, object):
1200         def __init__(self):
1201                 object.__init__(self)
1202                 dict.__init__(self)
1203                 self.stored_values = {}
1204
1205         def save(self):
1206                 for x in self.values():
1207                         x.save()
1208
1209         def load(self):
1210                 for x in self.values():
1211                         x.load()
1212
1213         def getSavedValue(self):
1214                 res = {}
1215                 for (key, val) in self.items():
1216                         sv = val.saved_value
1217                         if sv is not None:
1218                                 res[str(key)] = sv
1219                 return res
1220
1221         def setSavedValue(self, values):
1222                 self.stored_values = dict(values)
1223                 for (key, val) in self.items():
1224                         if str(key) in self.stored_values:
1225                                 val = self.stored_values[str(key)]
1226
1227         saved_value = property(getSavedValue, setSavedValue)
1228
1229         def __setitem__(self, key, item):
1230                 dict.__setitem__(self, key, item)
1231                 if str(key) in self.stored_values:
1232                         item.saved_value = self.stored_values[str(key)]
1233                         item.load()
1234
1235         def dict(self):
1236                 return self
1237
1238 # Like the classes above, just with a more "native"
1239 # syntax.
1240 #
1241 # some evil stuff must be done to allow instant
1242 # loading of added elements. this is why this class
1243 # is so complex.
1244 #
1245 # we need the 'content' because we overwrite
1246 # __setattr__.
1247 # If you don't understand this, try adding
1248 # __setattr__ to a usual exisiting class and you will.
1249 class ConfigSubsection(object):
1250         def __init__(self):
1251                 object.__init__(self)
1252                 self.__dict__["content"] = ConfigSubsectionContent()
1253                 self.content.items = { }
1254                 self.content.stored_values = { }
1255
1256         def __setattr__(self, name, value):
1257                 if name == "saved_value":
1258                         return self.setSavedValue(value)
1259                 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"
1260                 self.content.items[name] = value
1261                 if name in self.content.stored_values:
1262                         #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
1263                         value.saved_value = self.content.stored_values[name]
1264                         value.load()
1265
1266         def __getattr__(self, name):
1267                 return self.content.items[name]
1268
1269         def getSavedValue(self):
1270                 res = self.content.stored_values
1271                 for (key, val) in self.content.items.items():
1272                         sv = val.saved_value
1273                         if sv is not None:
1274                                 res[key] = sv
1275                         elif key in res:
1276                                 del res[key]
1277                 return res
1278
1279         def setSavedValue(self, values):
1280                 values = dict(values)
1281
1282                 self.content.stored_values = values
1283
1284                 for (key, val) in self.content.items.items():
1285                         if key in values:
1286                                 val.saved_value = values[key]
1287
1288         saved_value = property(getSavedValue, setSavedValue)
1289
1290         def save(self):
1291                 for x in self.content.items.values():
1292                         x.save()
1293
1294         def load(self):
1295                 for x in self.content.items.values():
1296                         x.load()
1297
1298         def dict(self):
1299                 return self.content.items
1300
1301 # the root config object, which also can "pickle" (=serialize)
1302 # down the whole config tree.
1303 #
1304 # we try to keep non-existing config entries, to apply them whenever
1305 # a new config entry is added to a subsection
1306 # also, non-existing config entries will be saved, so they won't be
1307 # lost when a config entry disappears.
1308 class Config(ConfigSubsection):
1309         def __init__(self):
1310                 ConfigSubsection.__init__(self)
1311
1312         def pickle_this(self, prefix, topickle, result):
1313                 for (key, val) in topickle.items():
1314                         name = prefix + "." + key
1315
1316                         if isinstance(val, dict):
1317                                 self.pickle_this(name, val, result)
1318                         elif isinstance(val, tuple):
1319                                 result.append(name + "=" + val[0]) # + " ; " + val[1])
1320                         else:
1321                                 result.append(name + "=" + val)
1322
1323         def pickle(self):
1324                 result = [ ]
1325                 self.pickle_this("config", self.saved_value, result)
1326                 return '\n'.join(result) + "\n"
1327
1328         def unpickle(self, lines):
1329                 tree = { }
1330                 for l in lines:
1331                         if not len(l) or l[0] == '#':
1332                                 continue
1333
1334                         n = l.find('=')
1335                         val = l[n+1:].strip()
1336
1337                         names = l[:n].split('.')
1338 #                       if val.find(' ') != -1:
1339 #                               val = val[:val.find(' ')]
1340
1341                         base = tree
1342
1343                         for n in names[:-1]:
1344                                 base = base.setdefault(n, {})
1345
1346                         base[names[-1]] = val
1347
1348                 # we inherit from ConfigSubsection, so ...
1349                 #object.__setattr__(self, "saved_value", tree["config"])
1350                 if "config" in tree:
1351                         self.setSavedValue(tree["config"])
1352
1353         def saveToFile(self, filename):
1354                 f = open(filename, "w")
1355                 f.write(self.pickle())
1356                 f.close()
1357
1358         def loadFromFile(self, filename):
1359                 f = open(filename, "r")
1360                 self.unpickle(f.readlines())
1361                 f.close()
1362
1363 config = Config()
1364 config.misc = ConfigSubsection()
1365
1366 class ConfigFile:
1367         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1368
1369         def load(self):
1370                 try:
1371                         config.loadFromFile(self.CONFIG_FILE)
1372                 except IOError, e:
1373                         print "unable to load config (%s), assuming defaults..." % str(e)
1374
1375         def save(self):
1376 #               config.save()
1377                 config.saveToFile(self.CONFIG_FILE)
1378
1379         def __resolveValue(self, pickles, cmap):
1380                 if cmap.has_key(pickles[0]):
1381                         if len(pickles) > 1:
1382                                 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1383                         else:
1384                                 return str(cmap[pickles[0]].value)
1385                 return None
1386
1387         def getResolvedKey(self, key):
1388                 names = key.split('.')
1389                 if len(names) > 1:
1390                         if names[0] == "config":
1391                                 ret=self.__resolveValue(names[1:], config.content.items)
1392                                 if ret and len(ret):
1393                                         return ret
1394                 print "getResolvedKey", key, "failed !! (Typo??)"
1395                 return ""
1396
1397 def NoSave(element):
1398         element.disableSave()
1399         return element
1400
1401 configfile = ConfigFile()
1402
1403 configfile.load()
1404
1405 def getConfigListEntry(*args):
1406         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1407         return args
1408
1409 def updateConfigElement(element, newelement):
1410         newelement.value = element.value
1411         return newelement
1412
1413 #def _(x):
1414 #       return x
1415 #
1416 #config.bla = ConfigSubsection()
1417 #config.bla.test = ConfigYesNo()
1418 #config.nim = ConfigSubList()
1419 #config.nim.append(ConfigSubsection())
1420 #config.nim[0].bla = ConfigYesNo()
1421 #config.nim.append(ConfigSubsection())
1422 #config.nim[1].bla = ConfigYesNo()
1423 #config.nim[1].blub = ConfigYesNo()
1424 #config.arg = ConfigSubDict()
1425 #config.arg["Hello"] = ConfigYesNo()
1426 #
1427 #config.arg["Hello"].handleKey(KEY_RIGHT)
1428 #config.arg["Hello"].handleKey(KEY_RIGHT)
1429 #
1430 ##config.saved_value
1431 #
1432 ##configfile.save()
1433 #config.save()
1434 #print config.pickle()