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