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