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         def genText(self):
 512                 value = ""
 513                 mPos = self.marked_pos
 514                 num = 0;
 515                 for i in self._value:
 516                         if len(value):
 517                                 value += self.seperator
 518                                 if mPos >= len(value) - 1:
 519                                         mPos += 1
 520                         value += str(i)
 521                         num += 1
 522                 return (value, mPos)
 523
 524 class ConfigMAC(ConfigSequence):
 525         def __init__(self, default):
 526                 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
 527
 528 class ConfigPosition(ConfigSequence):
 529         def __init__(self, default, args):
 530                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
 531
 532 class ConfigClock(ConfigSequence):
 533         def __init__(self, default):
 534                 import time
 535                 t = time.localtime(default)
 536                 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
 537
 538 class ConfigInteger(ConfigSequence):
 539         def __init__(self, default, limits = (0, 9999999999)):
 540                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
 541
 542         # you need to override this to do input validation
 543         def setValue(self, value):
 544                 self._value = [value]
 545                 self.changed()
 546
 547         def getValue(self):
 548                 return self._value[0]
 549
 550         value = property(getValue, setValue)
 551
 552         def fromstring(self, value):
 553                 return int(value)
 554
 555         def tostring(self, value):
 556                 return str(value)
 557
 558 class ConfigPIN(ConfigInteger):
 559         def __init__(self, default, len = 4, censor = ""):
 560                 assert isinstance(default, int), "ConfigPIN default must be an integer"
 561                 if default == -1:
 562                         default = "aaaa"
 563                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
 564                 self.len = len
 565
 566         def getLength(self):
 567                 return self.len
 568
 569 class ConfigFloat(ConfigSequence):
 570         def __init__(self, default, limits):
 571                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
 572
 573         def getFloat(self):
 574                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
 575
 576         float = property(getFloat)
 577
 578 # an editable text...
 579 class ConfigText(ConfigElement, NumericalTextInput):
 580         def __init__(self, default = "", fixed_size = True, visible_width = False):
 581                 ConfigElement.__init__(self)
 582                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
 583
 584                 self.marked_pos = 0
 585                 self.allmarked = (default != "")
 586                 self.fixed_size = fixed_size
 587                 self.visible_width = visible_width
 588                 self.offset = 0
 589                 self.overwrite = fixed_size
 590                 self.help_window = None
 591                 self.value = self.default = default
 592
 593         def validateMarker(self):
 594                 if self.fixed_size:
 595                         if self.marked_pos > len(self.text)-1:
 596                                 self.marked_pos = len(self.text)-1
 597                 else:
 598                         if self.marked_pos > len(self.text):
 599                                 self.marked_pos = len(self.text)
 600                 if self.marked_pos < 0:
 601                         self.marked_pos = 0
 602                 if self.visible_width:
 603                         if self.marked_pos < self.offset:
 604                                 self.offset = self.marked_pos
 605                         if self.marked_pos >= self.offset + self.visible_width:
 606                                 if self.marked_pos == len(self.text):
 607                                         self.offset = self.marked_pos - self.visible_width
 608                                 else:
 609                                         self.offset = self.marked_pos - self.visible_width + 1
 610                         if self.offset > 0 and self.offset + self.visible_width > len(self.text):
 611                                 self.offset = max(0, len(self.text) - self.visible_width)
 612
 613         def insertChar(self, ch, pos, owr):
 614                 if owr or self.overwrite:
 615                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
 616                 elif self.fixed_size:
 617                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
 618                 else:
 619                         self.text = self.text[0:pos] + ch + self.text[pos:]
 620
 621         def deleteChar(self, pos):
 622                 if not self.fixed_size:
 623                         self.text = self.text[0:pos] + self.text[pos + 1:]
 624                 elif self.overwrite:
 625                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
 626                 else:
 627                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
 628
 629         def deleteAllChars(self):
 630                 if self.fixed_size:
 631                         self.text = " " * len(self.text)
 632                 else:
 633                         self.text = ""
 634                 self.marked_pos = 0
 635
 636         def handleKey(self, key):
 637                 # this will no change anything on the value itself
 638                 # so we can handle it here in gui element
 639                 if key == KEY_DELETE:
 640                         self.timeout()
 641                         if self.allmarked:
 642                                 self.deleteAllChars()
 643                                 self.allmarked = False
 644                         else:
 645                                 self.deleteChar(self.marked_pos)
 646                                 if self.fixed_size and self.overwrite:
 647                                         self.marked_pos += 1
 648                 elif key == KEY_BACKSPACE:
 649                         self.timeout()
 650                         if self.allmarked:
 651                                 self.deleteAllChars()
 652                                 self.allmarked = False
 653                         elif self.marked_pos > 0:
 654                                 self.deleteChar(self.marked_pos-1)
 655                                 if not self.fixed_size and self.offset > 0:
 656                                         self.offset -= 1
 657                                 self.marked_pos -= 1
 658                 elif key == KEY_LEFT:
 659                         self.timeout()
 660                         if self.allmarked:
 661                                 self.marked_pos = len(self.text)
 662                                 self.allmarked = False
 663                         else:
 664                                 self.marked_pos -= 1
 665                 elif key == KEY_RIGHT:
 666                         self.timeout()
 667                         if self.allmarked:
 668                                 self.marked_pos = 0
 669                                 self.allmarked = False
 670                         else:
 671                                 self.marked_pos += 1
 672                 elif key == KEY_HOME:
 673                         self.timeout()
 674                         self.allmarked = False
 675                         self.marked_pos = 0
 676                 elif key == KEY_END:
 677                         self.timeout()
 678                         self.allmarked = False
 679                         self.marked_pos = len(self.text)
 680                 elif key == KEY_TOGGLEOW:
 681                         self.timeout()
 682                         self.overwrite = not self.overwrite
 683                 elif key == KEY_ASCII:
 684                         self.timeout()
 685                         newChar = unichr(getPrevAsciiCode())
 686                         if self.allmarked:
 687                                 self.deleteAllChars()
 688                                 self.allmarked = False
 689                         self.insertChar(newChar, self.marked_pos, False)
 690                         self.marked_pos += 1
 691                 elif key in KEY_NUMBERS:
 692                         owr = self.lastKey == getKeyNumber(key)
 693                         newChar = self.getKey(getKeyNumber(key))
 694                         if self.allmarked:
 695                                 self.deleteAllChars()
 696                                 self.allmarked = False
 697                         self.insertChar(newChar, self.marked_pos, owr)
 698                 elif key == KEY_TIMEOUT:
 699                         self.timeout()
 700                         if self.help_window:
 701                                 self.help_window.update(self)
 702                         return
 703
 704                 if self.help_window:
 705                         self.help_window.update(self)
 706                 self.validateMarker()
 707                 self.changed()
 708
 709         def nextFunc(self):
 710                 self.marked_pos += 1
 711                 self.validateMarker()
 712                 self.changed()
 713
 714         def getValue(self):
 715                 return self.text.encode("utf-8")
 716
 717         def setValue(self, val):
 718                 try:
 719                         self.text = val.decode("utf-8")
 720                 except UnicodeDecodeError:
 721                         self.text = val
 722                         print "Broken UTF8!"
 723
 724         value = property(getValue, setValue)
 725         _value = property(getValue, setValue)
 726
 727         def getText(self):
 728                 return self.text.encode("utf-8")
 729
 730         def getMulti(self, selected):
 731                 if self.visible_width:
 732                         if self.allmarked:
 733                                 mark = range(0, min(self.visible_width, len(self.text)))
 734                         else:
 735                                 mark = [self.marked_pos-self.offset]
 736                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
 737                 else:
 738                         if self.allmarked:
 739                                 mark = range(0, len(self.text))
 740                         else:
 741                                 mark = [self.marked_pos]
 742                         return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
 743
 744         def onSelect(self, session):
 745                 self.allmarked = (self.value != "")
 746                 if session is not None:
 747                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
 748                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
 749                         self.help_window.show()
 750
 751         def onDeselect(self, session):
 752                 self.marked_pos = 0
 753                 self.offset = 0
 754                 if self.help_window:
 755                         session.deleteDialog(self.help_window)
 756                         self.help_window = None
 757
 758         def getHTML(self, id):
 759                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
 760
 761         def unsafeAssign(self, value):
 762                 self.value = str(value)
 763
 764 class ConfigNumber(ConfigText):
 765         def __init__(self, default = 0):
 766                 ConfigText.__init__(self, str(default), fixed_size = False)
 767
 768         def getValue(self):
 769                 return int(self.text)
 770
 771         def setValue(self, val):
 772                 self.text = str(val)
 773
 774         value = property(getValue, setValue)
 775         _value = property(getValue, setValue)
 776
 777         def conform(self):
 778                 pos = len(self.text) - self.marked_pos
 779                 self.text = self.text.lstrip("0")
 780                 if self.text == "":
 781                         self.text = "0"
 782                 if pos > len(self.text):
 783                         self.marked_pos = 0
 784                 else:
 785                         self.marked_pos = len(self.text) - pos
 786
 787         def handleKey(self, key):
 788                 if key in KEY_NUMBERS or key == KEY_ASCII:
 789                         if key == KEY_ASCII:
 790                                 ascii = getPrevAsciiCode()
 791                                 if not (48 <= ascii <= 57):
 792                                         return
 793                         else:
 794                                 ascii = getKeyNumber(key) + 48
 795                         newChar = unichr(ascii)
 796                         if self.allmarked:
 797                                 self.deleteAllChars()
 798                                 self.allmarked = False
 799                         self.insertChar(newChar, self.marked_pos, False)
 800                         self.marked_pos += 1
 801                 else:
 802                         ConfigText.handleKey(self, key)
 803                 self.conform()
 804
 805         def onSelect(self, session):
 806                 self.allmarked = (self.value != "")
 807
 808         def onDeselect(self, session):
 809                 self.marked_pos = 0
 810                 self.offset = 0
 811
 812 # a slider.
 813 class ConfigSlider(ConfigElement):
 814         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
 815                 ConfigElement.__init__(self)
 816                 self.value = self.default = default
 817                 self.min = limits[0]
 818                 self.max = limits[1]
 819                 self.increment = increment
 820
 821         def checkValues(self):
 822                 if self.value < self.min:
 823                         self.value = self.min
 824
 825                 if self.value > self.max:
 826                         self.value = self.max
 827
 828         def handleKey(self, key):
 829                 if key == KEY_LEFT:
 830                         self.value -= self.increment
 831                 elif key == KEY_RIGHT:
 832                         self.value += self.increment
 833                 elif key == KEY_HOME:
 834                         self.value = self.min
 835                 elif key == KEY_END:
 836                         self.value = self.max
 837                 else:
 838                         return
 839                 self.checkValues()
 840
 841         def getText(self):
 842                 return "%d / %d" % (self.value, self.max)
 843
 844         def getMulti(self, selected):
 845                 self.checkValues()
 846                 return ("slider", self.value, self.max)
 847
 848         def fromstring(self, value):
 849                 return int(value)
 850
 851 # a satlist. in fact, it's a ConfigSelection.
 852 class ConfigSatlist(ConfigSelection):
 853         def __init__(self, list, default = None):
 854                 if default is not None:
 855                         default = str(default)
 856                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
 857
 858         def getOrbitalPosition(self):
 859                 if self.value == "":
 860                         return None
 861                 return int(self.value)
 862
 863         orbital_position = property(getOrbitalPosition)
 864
 865 class ConfigSet(ConfigElement):
 866         def __init__(self, choices, default = []):
 867                 ConfigElement.__init__(self)
 868                 self.choices = []
 869                 self.description = {}
 870                 if isinstance(choices, list):
 871                         choices.sort()
 872                         for x in choices:
 873                                 if isinstance(x, tuple):
 874                                         self.choices.append(x[0])
 875                                         self.description[x[0]] = str(x[1])
 876                                 else:
 877                                         self.choices.append(x)
 878                                         self.description[x] = str(x)
 879                 else:
 880                         assert False, "ConfigSet choices must be a list!"
 881                 if len(self.choices) == 0:
 882                         self.choices = [""]
 883                         self.description[""] = ""
 884                 if default is None:
 885                         default = []
 886                 self.pos = -1
 887                 default.sort()
 888                 self.default = default
 889                 self.value = default+[]
 890
 891         def toggleChoice(self, choice):
 892                 if choice in self.value:
 893                         self.value.remove(choice)
 894                 else:
 895                         self.value.append(choice)
 896                         self.value.sort()
 897
 898         def handleKey(self, key):
 899                 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
 900                         if self.pos != -1:
 901                                 self.toggleChoice(self.choices[self.pos])
 902                 elif key == KEY_LEFT:
 903                         self.pos -= 1
 904                         if self.pos < -1:
 905                             self.pos = len(self.choices)-1
 906                 elif key == KEY_RIGHT:
 907                         self.pos += 1
 908                         if self.pos >= len(self.choices):
 909                             self.pos = -1
 910                 elif key in [KEY_HOME, KEY_END]:
 911                         self.pos = -1
 912
 913         def genString(self, lst):
 914                 res = ""
 915                 for x in lst:
 916                         res += self.description[x]+" "
 917                 return res
 918
 919         def getText(self):
 920                 return self.genString(self.value)
 921
 922         def getMulti(self, selected):
 923                 if not selected or self.pos == -1:
 924                         return ("text", self.genString(self.value))
 925                 else:
 926                         tmp = self.value+[]
 927                         ch = self.choices[self.pos]
 928                         mem = ch in self.value
 929                         if not mem:
 930                                 tmp.append(ch)
 931                                 tmp.sort()
 932                         ind = tmp.index(ch)
 933                         val1 = self.genString(tmp[:ind])
 934                         val2 = " "+self.genString(tmp[ind+1:])
 935                         if mem:
 936                                 chstr = " "+self.description[ch]+" "
 937                         else:
 938                                 chstr = "("+self.description[ch]+")"
 939                         return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
 940
 941         def onDeselect(self, session):
 942                 self.pos = -1
 943                 self.changed()
 944
 945         def tostring(self, value):
 946                 return str(value)
 947
 948         def fromstring(self, val):
 949                 return eval(val)
 950
 951 class ConfigLocations(ConfigElement):
 952         def __init__(self, default = [], visible_width = False):
 953                 ConfigElement.__init__(self)
 954                 self.visible_width = visible_width
 955                 self.pos = -1
 956                 self.default = default
 957                 self.locations = []
 958                 self.mountpoints = []
 959                 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
 960
 961         def setValue(self, value):
 962                 loc = [x[0] for x in self.locations if x[3]]
 963                 add = [x for x in value if not x in loc]
 964                 diff = add + [x for x in loc if not x in value]
 965                 self.locations = [x for x in self.locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
 966                 self.locations.sort(key = lambda x: x[0])
 967                 self.changed()
 968
 969         def getValue(self):
 970                 self.checkChangedMountpoints()
 971                 for x in self.locations:
 972                         x[3] = x[2]
 973                 return [x[0] for x in self.locations if x[3]]
 974
 975         value = property(getValue, setValue)
 976
 977         def tostring(self, value):
 978                 return str(value)
 979
 980         def fromstring(self, val):
 981                 return eval(val)
 982
 983         def load(self):
 984                 if self.saved_value is None:
 985                         tmp = self.default
 986                 else:
 987                         tmp = self.fromstring(self.saved_value)
 988                 self.locations = [[x, None, False, False] for x in tmp]
 989                 self.refreshMountpoints()
 990                 for x in self.locations:
 991                         if os.path.exists(x[0]):
 992                                 x[1] = self.getMountpoint(x[0])
 993                                 x[2] = True
 994
 995         def save(self):
 996                 if self.save_disabled or self.locations == []:
 997                         self.saved_value = None
 998                 else:
 999                         self.saved_value = self.tostring([x[0] for x in self.locations])
1000
1001         def isChanged(self):
1002                 if self.saved_value is None and self.locations == []:
1003                         return False
1004                 return self.tostring([x[0] for x in self.locations]) != self.saved_value
1005
1006         def mountpointsChanged(self, action, dev):
1007                 print "Mounts changed: ", action, dev
1008                 mp = dev.mountpoint+"/"
1009                 if action == "add":
1010                         self.addedMount(mp)
1011                 elif action == "remove":
1012                         self.removedMount(mp)
1013                 self.refreshMountpoints()
1014
1015         def addedMount(self, mp):
1016                 for x in self.locations:
1017                         if x[1] == mp:
1018                                 x[2] = True
1019                         elif x[1] == None and os.path.exists(x[0]):
1020                                 x[1] = self.getMountpoint(x[0])
1021                                 x[2] = True
1022
1023         def removedMount(self, mp):
1024                 for x in self.locations:
1025                         if x[1] == mp:
1026                                 x[2] = False
1027
1028         def refreshMountpoints(self):
1029                 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1030                 self.mountpoints.sort(key = lambda x: -len(x))
1031
1032         def checkChangedMountpoints(self):
1033                 oldmounts = self.mountpoints
1034                 self.refreshMountpoints()
1035                 if oldmounts == self.mountpoints:
1036                         return
1037                 for x in oldmounts:
1038                         if not x in self.mountpoints:
1039                                 self.removedMount(x)
1040                 for x in self.mountpoints:
1041                         if not x in oldmounts:
1042                                 self.addedMount(x)
1043
1044         def getMountpoint(self, file):
1045                 file = os.path.realpath(file)+"/"
1046                 for m in self.mountpoints:
1047                         if file.startswith(m):
1048                                 return m
1049                 return None
1050
1051         def handleKey(self, key):
1052                 if key == KEY_LEFT:
1053                         self.pos -= 1
1054                         if self.pos < -1:
1055                             self.pos = len(self.value)-1
1056                 elif key == KEY_RIGHT:
1057                         self.pos += 1
1058                         if self.pos >= len(self.value):
1059                             self.pos = -1
1060                 elif key in [KEY_HOME, KEY_END]:
1061                         self.pos = -1
1062
1063         def getText(self):
1064                 return " ".join(self.value)
1065
1066         def getMulti(self, selected):
1067                 if not selected:
1068                         valstr = " ".join(self.value)
1069                         if self.visible_width and len(valstr) > self.visible_width:
1070                                 return ("text", valstr[0:self.visible_width])
1071                         else:
1072                                 return ("text", valstr)
1073                 else:
1074                         i = 0
1075                         valstr = ""
1076                         ind1 = 0
1077                         ind2 = 0
1078                         for val in self.value:
1079                                 if i == self.pos:
1080                                         ind1 = len(valstr)
1081                                 valstr += str(val)+" "
1082                                 if i == self.pos:
1083                                         ind2 = len(valstr)
1084                                 i += 1
1085                         if self.visible_width and len(valstr) > self.visible_width:
1086                                 if ind1+1 < self.visible_width/2:
1087                                         off = 0
1088                                 else:
1089                                         off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1090                                 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1091                         else:
1092                                 return ("mtext", valstr, range(ind1,ind2))
1093
1094         def onDeselect(self, session):
1095                 self.pos = -1
1096
1097 # nothing.
1098 class ConfigNothing(ConfigSelection):
1099         def __init__(self):
1100                 ConfigSelection.__init__(self, choices = [""])
1101
1102 # until here, 'saved_value' always had to be a *string*.
1103 # now, in ConfigSubsection, and only there, saved_value
1104 # is a dict, essentially forming a tree.
1105 #
1106 # config.foo.bar=True
1107 # config.foobar=False
1108 #
1109 # turns into:
1110 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1111 #
1112
1113
1114 class ConfigSubsectionContent(object):
1115         pass
1116
1117 # we store a backup of the loaded configuration
1118 # data in self.stored_values, to be able to deploy
1119 # them when a new config element will be added,
1120 # so non-default values are instantly available
1121
1122 # A list, for example:
1123 # config.dipswitches = ConfigSubList()
1124 # config.dipswitches.append(ConfigYesNo())
1125 # config.dipswitches.append(ConfigYesNo())
1126 # config.dipswitches.append(ConfigYesNo())
1127 class ConfigSubList(list, object):
1128         def __init__(self):
1129                 object.__init__(self)
1130                 list.__init__(self)
1131                 self.stored_values = {}
1132
1133         def save(self):
1134                 for x in self:
1135                         x.save()
1136
1137         def load(self):
1138                 for x in self:
1139                         x.load()
1140
1141         def getSavedValue(self):
1142                 res = {}
1143                 for i in range(len(self)):
1144                         sv = self[i].saved_value
1145                         if sv is not None:
1146                                 res[str(i)] = sv
1147                 return res
1148
1149         def setSavedValue(self, values):
1150                 self.stored_values = dict(values)
1151                 for (key, val) in self.stored_values.items():
1152                         if int(key) < len(self):
1153                                 self[int(key)].saved_value = val
1154
1155         saved_value = property(getSavedValue, setSavedValue)
1156
1157         def append(self, item):
1158                 i = str(len(self))
1159                 list.append(self, item)
1160                 if i in self.stored_values:
1161                         item.saved_value = self.stored_values[i]
1162                         item.load()
1163
1164         def dict(self):
1165                 res = dict()
1166                 for index in range(len(self)):
1167                         res[str(index)] = self[index]
1168                 return res
1169
1170 # same as ConfigSubList, just as a dictionary.
1171 # care must be taken that the 'key' has a proper
1172 # str() method, because it will be used in the config
1173 # file.
1174 class ConfigSubDict(dict, object):
1175         def __init__(self):
1176                 object.__init__(self)
1177                 dict.__init__(self)
1178                 self.stored_values = {}
1179
1180         def save(self):
1181                 for x in self.values():
1182                         x.save()
1183
1184         def load(self):
1185                 for x in self.values():
1186                         x.load()
1187
1188         def getSavedValue(self):
1189                 res = {}
1190                 for (key, val) in self.items():
1191                         if val.saved_value is not None:
1192                                 res[str(key)] = val.saved_value
1193                 return res
1194
1195         def setSavedValue(self, values):
1196                 self.stored_values = dict(values)
1197                 for (key, val) in self.items():
1198                         if str(key) in self.stored_values:
1199                                 val = self.stored_values[str(key)]
1200
1201         saved_value = property(getSavedValue, setSavedValue)
1202
1203         def __setitem__(self, key, item):
1204                 dict.__setitem__(self, key, item)
1205                 if str(key) in self.stored_values:
1206                         item.saved_value = self.stored_values[str(key)]
1207                         item.load()
1208
1209         def dict(self):
1210                 return self
1211
1212 # Like the classes above, just with a more "native"
1213 # syntax.
1214 #
1215 # some evil stuff must be done to allow instant
1216 # loading of added elements. this is why this class
1217 # is so complex.
1218 #
1219 # we need the 'content' because we overwrite
1220 # __setattr__.
1221 # If you don't understand this, try adding
1222 # __setattr__ to a usual exisiting class and you will.
1223 class ConfigSubsection(object):
1224         def __init__(self):
1225                 object.__init__(self)
1226                 self.__dict__["content"] = ConfigSubsectionContent()
1227                 self.content.items = { }
1228                 self.content.stored_values = { }
1229
1230         def __setattr__(self, name, value):
1231                 if name == "saved_value":
1232                         return self.setSavedValue(value)
1233                 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"
1234                 self.content.items[name] = value
1235                 if name in self.content.stored_values:
1236                         #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
1237                         value.saved_value = self.content.stored_values[name]
1238                         value.load()
1239
1240         def __getattr__(self, name):
1241                 return self.content.items[name]
1242
1243         def getSavedValue(self):
1244                 res = self.content.stored_values
1245                 for (key, val) in self.content.items.items():
1246                         if val.saved_value is not None:
1247                                 res[key] = val.saved_value
1248                         elif key in res:
1249                                 del res[key]
1250
1251                 return res
1252
1253         def setSavedValue(self, values):
1254                 values = dict(values)
1255
1256                 self.content.stored_values = values
1257
1258                 for (key, val) in self.content.items.items():
1259                         if key in values:
1260                                 val.saved_value = values[key]
1261
1262         saved_value = property(getSavedValue, setSavedValue)
1263
1264         def save(self):
1265                 for x in self.content.items.values():
1266                         x.save()
1267
1268         def load(self):
1269                 for x in self.content.items.values():
1270                         x.load()
1271
1272         def dict(self):
1273                 return self.content.items
1274
1275 # the root config object, which also can "pickle" (=serialize)
1276 # down the whole config tree.
1277 #
1278 # we try to keep non-existing config entries, to apply them whenever
1279 # a new config entry is added to a subsection
1280 # also, non-existing config entries will be saved, so they won't be
1281 # lost when a config entry disappears.
1282 class Config(ConfigSubsection):
1283         def __init__(self):
1284                 ConfigSubsection.__init__(self)
1285
1286         def pickle_this(self, prefix, topickle, result):
1287                 for (key, val) in topickle.items():
1288                         name = prefix + "." + key
1289
1290                         if isinstance(val, dict):
1291                                 self.pickle_this(name, val, result)
1292                         elif isinstance(val, tuple):
1293                                 result.append(name + "=" + val[0]) # + " ; " + val[1])
1294                         else:
1295                                 result.append(name + "=" + val)
1296
1297         def pickle(self):
1298                 result = [ ]
1299                 self.pickle_this("config", self.saved_value, result)
1300                 return '\n'.join(result) + "\n"
1301
1302         def unpickle(self, lines):
1303                 tree = { }
1304                 for l in lines:
1305                         if not len(l) or l[0] == '#':
1306                                 continue
1307
1308                         n = l.find('=')
1309                         val = l[n+1:].strip()
1310
1311                         names = l[:n].split('.')
1312 #                       if val.find(' ') != -1:
1313 #                               val = val[:val.find(' ')]
1314
1315                         base = tree
1316
1317                         for n in names[:-1]:
1318                                 base = base.setdefault(n, {})
1319
1320                         base[names[-1]] = val
1321
1322                 # we inherit from ConfigSubsection, so ...
1323                 #object.__setattr__(self, "saved_value", tree["config"])
1324                 if "config" in tree:
1325                         self.setSavedValue(tree["config"])
1326
1327         def saveToFile(self, filename):
1328                 f = open(filename, "w")
1329                 f.write(self.pickle())
1330                 f.close()
1331
1332         def loadFromFile(self, filename):
1333                 f = open(filename, "r")
1334                 self.unpickle(f.readlines())
1335                 f.close()
1336
1337 config = Config()
1338 config.misc = ConfigSubsection()
1339
1340 class ConfigFile:
1341         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1342
1343         def load(self):
1344                 try:
1345                         config.loadFromFile(self.CONFIG_FILE)
1346                 except IOError, e:
1347                         print "unable to load config (%s), assuming defaults..." % str(e)
1348
1349         def save(self):
1350 #               config.save()
1351                 config.saveToFile(self.CONFIG_FILE)
1352
1353         def __resolveValue(self, pickles, cmap):
1354                 if cmap.has_key(pickles[0]):
1355                         if len(pickles) > 1:
1356                                 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1357                         else:
1358                                 return str(cmap[pickles[0]].value)
1359                 return None
1360
1361         def getResolvedKey(self, key):
1362                 names = key.split('.')
1363                 if len(names) > 1:
1364                         if names[0] == "config":
1365                                 ret=self.__resolveValue(names[1:], config.content.items)
1366                                 if ret and len(ret):
1367                                         return ret
1368                 print "getResolvedKey", key, "failed !! (Typo??)"
1369                 return ""
1370
1371 def NoSave(element):
1372         element.disableSave()
1373         return element
1374
1375 configfile = ConfigFile()
1376
1377 configfile.load()
1378
1379 def getConfigListEntry(*args):
1380         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1381         return args
1382
1383 def updateConfigElement(element, newelement):
1384         newelement.value = element.value
1385         return newelement
1386
1387 #def _(x):
1388 #       return x
1389 #
1390 #config.bla = ConfigSubsection()
1391 #config.bla.test = ConfigYesNo()
1392 #config.nim = ConfigSubList()
1393 #config.nim.append(ConfigSubsection())
1394 #config.nim[0].bla = ConfigYesNo()
1395 #config.nim.append(ConfigSubsection())
1396 #config.nim[1].bla = ConfigYesNo()
1397 #config.nim[1].blub = ConfigYesNo()
1398 #config.arg = ConfigSubDict()
1399 #config.arg["Hello"] = ConfigYesNo()
1400 #
1401 #config.arg["Hello"].handleKey(KEY_RIGHT)
1402 #config.arg["Hello"].handleKey(KEY_RIGHT)
1403 #
1404 ##config.saved_value
1405 #
1406 ##configfile.save()
1407 #config.save()
1408 #print config.pickle()