lib/python/Components/config.py

   1 from time import *
   2 from Tools.NumericalTextInput import *
   3 from Tools.Directories import *
   4
   5 class configFile:
   6         def __init__(self):
   7                 self.changed = 0
   8                 self.configElements = { }
   9                 try:
  10                         self.file = open(resolveFilename(SCOPE_CONFIG, "config"))
  11                 except IOError:
  12                         print "cannot open config file"
  13                         return
  14
  15                 while 1:
  16                         line = self.file.readline()
  17                         if line == "":
  18                                 break
  19
  20                         if line.startswith("#"):                #skip comments
  21                                 continue
  22
  23                         self.addElement(line)
  24                 self.file.close()
  25
  26         def addElement(self, line):
  27                 x = line.find("=")
  28                 if x > -1:
  29                         self.configElements[line[:x]] = line[x + 1:-1]
  30
  31         def getKey(self, key):
  32                 return self.configElements[key]
  33
  34         def setKey(self, key, value, isDefaultKey=False):
  35                 self.changed = 1
  36                 if isDefaultKey and self.configElements.has_key(key):
  37                         del self.configElements[key]
  38                 else:
  39                         self.configElements[key] = value
  40
  41         def getResolvedKey(self, key):
  42                 str = self.configElements[key]
  43                 if len(str):
  44                         pos = str.find('*')
  45                         if pos != -1:
  46                                 str = str[pos+1:]
  47                                 pos = str.find('*')
  48                                 if pos != -1:
  49                                         return str[:pos]
  50                         return str
  51                 return None
  52
  53         def save(self):
  54                 if self.changed == 0:           #no changes, so no write to disk needed
  55                         return
  56
  57                 fileHandle = open(resolveFilename(SCOPE_CONFIG, "config"), "w")
  58
  59                 keys = self.configElements.keys()
  60                 keys.sort()
  61                 for x in keys:
  62                         wstr = x + "=" + self.configElements[x] + "\n"
  63
  64                         fileHandle.write(wstr)
  65
  66                 fileHandle.close()
  67
  68 def currentConfigSelectionElement(element):
  69         return element.vals[element.value][0]
  70
  71 def getConfigSelectionElement(element, value):
  72         count = 0
  73         for x in element.vals:
  74                 if x[0] == value:
  75                         return count
  76                 count += 1
  77         return -1
  78
  79 class configSelection:
  80         def __init__(self, parent):
  81                 self.parent = parent
  82
  83         def checkValues(self):
  84                 if self.parent.value < 0:
  85                         self.parent.value = len(self.parent.vals) - 1
  86                 elif(self.parent.value > (len(self.parent.vals) - 1)):
  87                         self.parent.value = 0
  88
  89         def cancel(self):
  90                 self.parent.reload()
  91
  92         def save(self):
  93                 self.parent.save()
  94
  95         def handleKey(self, key):
  96                 if key == config.key["prevElement"]:
  97                         self.parent.value = self.parent.value - 1
  98                 if key == config.key["nextElement"]:
  99                         self.parent.value = self.parent.value + 1
 100
 101                 self.checkValues()
 102
 103                 self.parent.change()
 104
 105         def __call__(self, selected):                   #needed by configlist
 106                 self.checkValues()
 107
 108                 returnValue = _(self.parent.vals[self.parent.value])
 109                 if not isinstance(returnValue, str):
 110                         returnValue = returnValue[1]
 111
 112                 # FIXME: it's not really nice to translate this here.
 113                 # however, configSelections are persistent.
 114
 115                 # WORKAROUND: don't translate ""
 116                 if returnValue:
 117                         returnValue = _(returnValue)
 118
 119                 return ("text", returnValue)
 120
 121 class configDateTime:
 122         def __init__(self, parent):
 123                 self.parent = parent
 124
 125         def checkValues(self):
 126                 pass
 127 #               if self.parent.value < 0:
 128                         #self.parent.value = 0
 129
 130                 #if(self.parent.value >= (len(self.parent.vals) - 1)):
 131                         #self.parent.value = len(self.parent.vals) - 1
 132
 133         def cancel(self):
 134                 self.parent.reload()
 135
 136         def save(self):
 137                 self.parent.save()
 138
 139         def handleKey(self, key):
 140                 if key == config.key["prevElement"]:
 141                         self.parent.value = self.parent.value - self.parent.vals[1]
 142                 if key == config.key["nextElement"]:
 143                         self.parent.value = self.parent.value + self.parent.vals[1]
 144
 145                 self.checkValues()
 146
 147                 self.parent.change()
 148
 149         def __call__(self, selected):                   #needed by configlist
 150                 self.checkValues()
 151                 return ("text", strftime(self.parent.vals[0], localtime(self.parent.value)))
 152
 153 class configSatlist:
 154         def __init__(self, parent):
 155                 self.parent = parent
 156
 157         def checkValues(self):
 158                 if self.parent.value < 0:
 159                         self.parent.value = 0
 160
 161                 if(self.parent.value >= (len(self.parent.vals) - 1)):
 162                         self.parent.value = len(self.parent.vals) - 1
 163
 164         def cancel(self):
 165                 self.parent.reload()
 166
 167         def save(self):
 168                 self.parent.save()
 169
 170         def handleKey(self, key):
 171                 if key == config.key["prevElement"]:
 172                         self.parent.value = self.parent.value - 1
 173                 if key == config.key["nextElement"]:
 174                         self.parent.value = self.parent.value + 1
 175
 176                 self.checkValues()
 177
 178                 self.parent.change()
 179
 180         def __call__(self, selected):                   #needed by configlist
 181                 self.checkValues()
 182                 #fixme
 183                 return ("text", str(self.parent.vals[self.parent.value][0]))
 184
 185 class configSequenceArg:
 186         def get(self, type, args = ()):
 187                 # configsequencearg.get ("IP")
 188                 if (type == "IP"):
 189                         return (("."), [(0,255),(0,255),(0,255),(0,255)], "")
 190                 # configsequencearg.get ("MAC")
 191                 if (type == "POSITION"):
 192                         return ((","), [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], "")
 193                 if (type == "MAC"):
 194                         return ((":"), [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], "")
 195                 # configsequencearg.get ("CLOCK")
 196                 if (type == "CLOCK"):
 197                         return ((":"), [(0,23),(0,59)], "")
 198                 # configsequencearg.get("INTEGER", (min, max)) => x with min <= x <= max
 199                 if (type == "INTEGER"):
 200                         return ((":"), [args], "")
 201                 # configsequencearg.get("PINCODE", (number, "*")) => pin with number = length of pincode and "*" as numbers shown as stars
 202                 # configsequencearg.get("PINCODE", (number, "")) => pin with number = length of pincode and numbers shown
 203                 if (type == "PINCODE"):
 204                         return ((":"), [(0, (10**args[0])-1)], args[1])
 205                 # configsequencearg.get("FLOAT", [(min,max),(min1,max1)]) => x.y with min <= x <= max and min1 <= y <= max1
 206                 if (type == "FLOAT"):
 207                         return (("."), args, "")
 208
 209         def getFloat(self, element):
 210                 return float(("%d.%0" + str(len(str(element.vals[1][1][1]))) + "d") % (element.value[0], element.value[1]))
 211
 212 configsequencearg = configSequenceArg()
 213
 214 class configSequence:
 215         def __init__(self, parent):
 216                 self.parent = parent
 217                 self.markedPos = 0
 218                 self.seperator = self.parent.vals[0]
 219                 self.valueBounds = self.parent.vals[1]
 220                 self.censorChar = self.parent.vals[2]
 221
 222         def checkValues(self):
 223                 maxPos = 0
 224                 num = 0
 225                 for i in self.parent.value:
 226                         maxPos += len(str(self.valueBounds[num][1]))
 227                         while (self.valueBounds[num][0] > self.parent.value[num]):
 228                                 self.parent.value[num] += 1
 229
 230                         while (self.valueBounds[num][1] < self.parent.value[num]):
 231                                 self.parent.value[num] -= 1
 232
 233 #                       if (self.valueBounds[num][0] <= i <= self.valueBounds[num][1]):
 234                                 #pass
 235                         #else:
 236                                 #self.parent.value[num] = self.valueBounds[num][0]
 237                         num += 1
 238
 239                 if self.markedPos >= maxPos:
 240                         self.markedPos = maxPos - 1
 241                 if self.markedPos < 0:
 242                         self.markedPos = 0
 243
 244         def cancel(self):
 245                 self.parent.reload()
 246
 247         def save(self):
 248                 self.parent.save()
 249
 250         def handleKey(self, key):
 251                 #this will no change anything on the value itself
 252                 #so we can handle it here in gui element
 253                 if key == config.key["prevElement"]:
 254                         self.markedPos -= 1
 255                 if key == config.key["nextElement"]:
 256                         self.markedPos += 1
 257
 258                 if key >= config.key["0"] and key <= config.key["9"]:
 259                         self.blockLen = []
 260                         for x in self.valueBounds:
 261                                 self.blockLen.append(len(str(x[1])))
 262
 263                         pos = 0
 264                         blocknumber = 0
 265                         self.blockLenTotal = [0,]
 266                         for x in self.blockLen:
 267                                 pos += self.blockLen[blocknumber]
 268                                 self.blockLenTotal.append(pos)
 269                                 if (pos - 1 >= self.markedPos):
 270                                         pass
 271                                 else:
 272                                         blocknumber += 1
 273
 274                         number = 9 - config.key["9"] + key
 275                         # length of numberblock
 276                         numberLen = len(str(self.valueBounds[blocknumber][1]))
 277                         # position in the block
 278                         posinblock = self.markedPos - self.blockLenTotal[blocknumber]
 279
 280                         oldvalue = self.parent.value[blocknumber]
 281                         olddec = oldvalue % 10 ** (numberLen - posinblock) - (oldvalue % 10 ** (numberLen - posinblock - 1))
 282                         newvalue = oldvalue - olddec + (10 ** (numberLen - posinblock - 1) * number)
 283
 284                         self.parent.value[blocknumber] = newvalue
 285                         self.markedPos += 1
 286
 287                 self.checkValues()
 288
 289                 #FIXME: dont call when press left/right
 290                 self.parent.change()
 291
 292         def __call__(self, selected):                   #needed by configlist
 293                 value = ""
 294                 mPos = self.markedPos
 295                 num = 0;
 296                 for i in self.parent.value:
 297                         if len(value):  #fixme no heading separator possible
 298                                 value += self.seperator
 299                                 if mPos >= len(value) - 1:
 300                                         mPos += 1
 301
 302                         #diff =         self.valueBounds - len(str(i))
 303                         #if diff > 0:
 304                                 ## if this helps?!
 305                                 #value += " " * diff
 306                         if (self.censorChar == ""):
 307                                 value += ("%0" + str(len(str(self.valueBounds[num][1]))) + "d") % i
 308                         else:
 309                                 value += (self.censorChar * len(str(self.valueBounds[num][1])))
 310                         num += 1
 311                         # only mark cursor when we are selected
 312                         # (this code is heavily ink optimized!)
 313                 if (self.parent.enabled == True):
 314                         return ("mtext"[1-selected:], value, [mPos])
 315                 else:
 316                         return ("text", value)
 317
 318 class configNothing:
 319         def __init__(self, parent):
 320                 self.parent = parent
 321                 self.markedPos = 0
 322
 323         def cancel(self):
 324                 self.parent.reload()
 325
 326         def save(self):
 327                 self.parent.save()
 328
 329         def nextEntry(self):
 330                 self.parent.vals[1](self.parent.getConfigPath())
 331
 332         def handleKey(self, key):
 333                 pass
 334
 335         def __call__(self, selected):                   #needed by configlist
 336                 return ("text", "")
 337
 338 class configText:
 339         # used as first parameter
 340         # is the text of a fixed size or is the user able to extend the length of the text
 341         extendableSize = 1
 342         fixedSize = 2
 343
 344         def __init__(self, parent):
 345                 self.parent = parent
 346                 self.markedPos = 0
 347                 self.mode = self.parent.vals[0]
 348                 self.textInput = NumericalTextInput(self.nextEntry)
 349
 350         def checkValues(self):
 351                 if (self.markedPos < 0):
 352                         self.markedPos = 0
 353                 if (self.markedPos >= len(self.parent.value)):
 354                         self.markedPos = len(self.parent.value) - 1
 355
 356         def cancel(self):
 357                 self.parent.reload()
 358
 359         def save(self):
 360                 self.parent.save()
 361
 362         def nextEntry(self):
 363                 self.parent.vals[1](self.parent.getConfigPath())
 364
 365         def handleKey(self, key):
 366                 #this will no change anything on the value itself
 367                 #so we can handle it here in gui element
 368                 if key == config.key["delete"]:
 369                         self.parent.value = self.parent.value[0:self.markedPos] + self.parent.value[self.markedPos + 1:]
 370                 if key == config.key["prevElement"]:
 371                         self.textInput.nextKey()
 372                         self.markedPos -= 1
 373
 374                 if key == config.key["nextElement"]:
 375                         self.textInput.nextKey()
 376                         self.markedPos += 1
 377                         if (self.mode == self.extendableSize):
 378                                 if (self.markedPos >= len(self.parent.value)):
 379                                         self.parent.value = self.parent.value.ljust(len(self.parent.value) + 1)
 380
 381
 382                 if key >= config.key["0"] and key <= config.key["9"]:
 383                         number = 9 - config.key["9"] + key
 384
 385                         self.parent.value = self.parent.value[0:self.markedPos] + str(self.textInput.getKey(number)) + self.parent.value[self.markedPos + 1:]
 386
 387                 self.checkValues()
 388
 389                 self.parent.change()
 390
 391         def __call__(self, selected):                   #needed by configlist
 392                 return ("mtext"[1-selected:], str(self.parent.value), [self.markedPos])
 393
 394 class configValue:
 395         def __init__(self, obj):
 396                 self.obj = obj
 397
 398         def __str__(self):
 399                 return self.obj
 400
 401 class Config:
 402         def __init__(self):
 403                 self.key = { "choseElement": 0,
 404                                          "prevElement": 1,
 405                                          "nextElement": 2,
 406                                          "delete": 3,
 407                                          "0": 10,
 408                                          "1": 11,
 409                                          "2": 12,
 410                                          "3": 13,
 411                                          "4": 14,
 412                                          "5": 15,
 413                                          "6": 16,
 414                                          "7": 17,
 415                                          "8": 18,
 416                                          "9": 19 }
 417
 418 config = Config();
 419
 420 configfile = configFile()
 421
 422 class configSlider:
 423         def __init__(self, parent):
 424                 self.parent = parent
 425
 426         def cancel(self):
 427                 self.parent.reload()
 428
 429         def save(self):
 430                 self.parent.save()
 431
 432         def checkValues(self):
 433                 if self.parent.value < 0:
 434                         self.parent.value = 0
 435
 436                 if self.parent.value > self.parent.vals[1]:
 437                         self.parent.value = self.parent.vals[1]
 438
 439         def handleKey(self, key):
 440                 if key == config.key["prevElement"]:
 441                         self.parent.value = self.parent.value - self.parent.vals[0]
 442                 if key == config.key["nextElement"]:
 443                         self.parent.value = self.parent.value + self.parent.vals[0]
 444
 445                 self.checkValues()
 446                 self.parent.change()
 447
 448         def __call__(self, selected):                   #needed by configlist
 449                 self.checkValues()
 450                 return ("slider", self.parent.value, self.parent.vals[1])
 451
 452 class ConfigSubsection:
 453         def __init__(self):
 454                 pass
 455
 456 class configElement:
 457
 458         def getIndexbyEntry(self, data):
 459                 cnt = 0;
 460                 tcnt = -1; #for defaultval
 461                 for x in self.vals:
 462                         if int(x[1]) == int(data):
 463                                         return cnt
 464                         if int(x[1]) == int(self.defaultValue):
 465                                         tcnt = cnt
 466                         cnt += 1
 467                 if tcnt != -1:
 468                         return tcnt
 469                 return 0        #prevent bigger then array
 470
 471         def datafromFile(self, control, data):
 472                 if control == configSlider:
 473                         return int(data)
 474                 elif control == configSelection:
 475                         try:
 476                                 return int(data)
 477                         except:
 478                                 for x in data.split(":"):
 479                                         if x[0] == "*":
 480                                                 count = 0
 481                                                 for y in self.vals:
 482                                                         if y[0] == x[1:-1]:
 483                                                                 return count
 484                                                         count += 1
 485                                 return self.defaultValue
 486                 elif control == configDateTime:
 487                         return int(data)
 488                 elif control == configText:
 489                         return str(data)
 490                 elif control == configSequence:
 491                         list = [ ]
 492                         part = data.split(self.vals[0])
 493                         for x in part:
 494                                 list.append(int(x))
 495                         return list
 496                 elif control == configSatlist:
 497                         return self.getIndexbyEntry(data)
 498                 else:
 499                         return ""
 500
 501         def datatoFile(self, control, data):
 502                 if control == configSlider:
 503                         return str(data)
 504                 elif control == configSelection:
 505                         if len(self.vals) < data + 1:
 506                                 return "0"
 507                         if isinstance(self.vals[data], str):
 508                                 return str(data)
 509                         else:
 510                                 confList = []
 511                                 count = 0
 512                                 for x in self.vals:
 513                                         if count == data:
 514                                                 confList.append("*" + str(x[0] + "*"))
 515                                         else:
 516                                                 confList.append(x[0])
 517                                         count += 1
 518                                 return ":".join(confList)
 519                         return str(data)
 520                 elif control == configDateTime:
 521                         return str(data)
 522                 elif control == configText:
 523                         return str(data.strip())
 524                 elif control == configSequence:
 525 #                       print self.vals
 526 #                       print self.value
 527                         try:
 528                                 value = ""
 529                                 count = 0
 530                                 for i in data:
 531                                         if value !="":
 532                                                 value += self.vals[0]
 533                                         value += (("%0" + str(len(str(self.vals[1][count][1]))) + "d") % i)
 534                                         count += 1
 535                                         #value = ((len(data) * ("%d" + self.vals[0]))[0:-1]) % tuple(data)
 536                         except:
 537                                 value = str(data)
 538                         return value
 539                 elif control == configSatlist:
 540                         return str(self.vals[self.value][1]);
 541                 else:
 542                         return ""
 543
 544         def loadData(self):
 545                 #print "load:" + self.configPath
 546                 try:
 547                         value = self.datafromFile(self.controlType, configfile.getKey(self.configPath))
 548                 except:
 549                         value = ""
 550
 551                 if value == "":
 552                         #print "value not found - using default"
 553                         if self.controlType == configSatlist:
 554                                 self.value = self.getIndexbyEntry(self.defaultValue)
 555                         elif self.controlType == configSequence:
 556                                 self.value = self.defaultValue[:]
 557                         else:
 558                                 self.value = self.defaultValue
 559
 560                         self.save()             #add missing value to dict
 561                 else:
 562                         #print "set val:" + str(value)
 563                         self.value = value
 564
 565                 #is this right? activate settings after load/cancel and use default
 566                 self.change()
 567
 568         def __init__(self, configPath, control, defaultValue, vals, saveDefaults = True):
 569                 self.configPath = configPath
 570                 self.defaultValue = defaultValue
 571                 self.controlType = control
 572                 self.vals = vals
 573                 self.notifierList = [ ]
 574                 self.enabled = True
 575                 self.saveDefaults = saveDefaults
 576                 self.loadData()
 577
 578         def getConfigPath(self):
 579                 return self.configPath
 580
 581         def addNotifier(self, notifier):
 582                 self.notifierList.append(notifier);
 583                 notifier(self);
 584
 585         def change(self):
 586                 for notifier in self.notifierList:
 587                         notifier(self)
 588
 589         def reload(self):
 590                 self.loadData()
 591
 592         def save(self):
 593                 if self.controlType == configSatlist:
 594                         defaultValue = self.getIndexbyEntry(self.defaultValue)
 595                 else:
 596                         defaultValue = self.defaultValue
 597                 if self.value != defaultValue or self.saveDefaults:
 598                         configfile.setKey(self.configPath, self.datatoFile(self.controlType, self.value))
 599                 else:
 600                         try:
 601                                 oldValue = configfile.getKey(self.configPath)
 602                         except:
 603                                 oldValue = None
 604                         if oldValue is not None and oldValue != defaultValue:
 605                                 configfile.setKey(self.configPath, self.datatoFile(self.controlType, self.value), True)
 606
 607 class configElement_nonSave(configElement):
 608         def __init__(self, configPath, control, defaultValue, vals):
 609                 configElement.__init__(self, configPath, control, defaultValue, vals)
 610
 611         def save(self):
 612                 pass
 613
 614 def getConfigListEntry(description, element):
 615         b = element
 616         item = b.controlType(b)
 617         return ((description, item))
 618
 619 def configElementBoolean(name, default, texts=(_("Disable"), _("Enable"))):
 620         return configElement(name, configSelection, default, texts)
 621
 622 config.misc = ConfigSubsection()