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 == "MAC"):
 192                         return ((":"), [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], "")
 193                 # configsequencearg.get ("CLOCK")
 194                 if (type == "CLOCK"):
 195                         return ((":"), [(0,23),(0,59)], "")
 196                 # configsequencearg.get("INTEGER", (min, max)) => x with min <= x <= max
 197                 if (type == "INTEGER"):
 198                         return ((":"), [args], "")
 199                 # configsequencearg.get("PINCODE", (number, "*")) => pin with number = length of pincode and "*" as numbers shown as stars
 200                 # configsequencearg.get("PINCODE", (number, "")) => pin with number = length of pincode and numbers shown
 201                 if (type == "PINCODE"):
 202                         return ((":"), [(0, (10**args[0])-1)], args[1])
 203                 # configsequencearg.get("FLOAT", [(min,max),(min1,max1)]) => x.y with min <= x <= max and min1 <= y <= max1
 204                 if (type == "FLOAT"):
 205                         return (("."), args, "")
 206
 207         def getFloat(self, element):
 208                 return float(("%d.%0" + str(len(str(element.vals[1][1][1]))) + "d") % (element.value[0], element.value[1]))
 209
 210 configsequencearg = configSequenceArg()
 211
 212 class configSequence:
 213         def __init__(self, parent):
 214                 self.parent = parent
 215                 self.markedPos = 0
 216                 self.seperator = self.parent.vals[0]
 217                 self.valueBounds = self.parent.vals[1]
 218                 self.censorChar = self.parent.vals[2]
 219
 220         def checkValues(self):
 221                 maxPos = 0
 222                 num = 0
 223                 for i in self.parent.value:
 224                         maxPos += len(str(self.valueBounds[num][1]))
 225                         while (self.valueBounds[num][0] > self.parent.value[num]):
 226                                 self.parent.value[num] += 1
 227
 228                         while (self.valueBounds[num][1] < self.parent.value[num]):
 229                                 self.parent.value[num] -= 1
 230
 231 #                       if (self.valueBounds[num][0] <= i <= self.valueBounds[num][1]):
 232                                 #pass
 233                         #else:
 234                                 #self.parent.value[num] = self.valueBounds[num][0]
 235                         num += 1
 236
 237                 if self.markedPos >= maxPos:
 238                         self.markedPos = maxPos - 1
 239                 if self.markedPos < 0:
 240                         self.markedPos = 0
 241
 242         def cancel(self):
 243                 self.parent.reload()
 244
 245         def save(self):
 246                 self.parent.save()
 247
 248         def handleKey(self, key):
 249                 #this will no change anything on the value itself
 250                 #so we can handle it here in gui element
 251                 if key == config.key["prevElement"]:
 252                         self.markedPos -= 1
 253                 if key == config.key["nextElement"]:
 254                         self.markedPos += 1
 255
 256                 if key >= config.key["0"] and key <= config.key["9"]:
 257                         self.blockLen = []
 258                         for x in self.valueBounds:
 259                                 self.blockLen.append(len(str(x[1])))
 260
 261                         pos = 0
 262                         blocknumber = 0
 263                         self.blockLenTotal = [0,]
 264                         for x in self.blockLen:
 265                                 pos += self.blockLen[blocknumber]
 266                                 self.blockLenTotal.append(pos)
 267                                 if (pos - 1 >= self.markedPos):
 268                                         pass
 269                                 else:
 270                                         blocknumber += 1
 271
 272                         number = 9 - config.key["9"] + key
 273                         # length of numberblock
 274                         numberLen = len(str(self.valueBounds[blocknumber][1]))
 275                         # position in the block
 276                         posinblock = self.markedPos - self.blockLenTotal[blocknumber]
 277
 278                         oldvalue = self.parent.value[blocknumber]
 279                         olddec = oldvalue % 10 ** (numberLen - posinblock) - (oldvalue % 10 ** (numberLen - posinblock - 1))
 280                         newvalue = oldvalue - olddec + (10 ** (numberLen - posinblock - 1) * number)
 281
 282                         self.parent.value[blocknumber] = newvalue
 283                         self.markedPos += 1
 284
 285                 self.checkValues()
 286
 287                 #FIXME: dont call when press left/right
 288                 self.parent.change()
 289
 290         def __call__(self, selected):                   #needed by configlist
 291                 value = ""
 292                 mPos = self.markedPos
 293                 num = 0;
 294                 for i in self.parent.value:
 295                         if len(value):  #fixme no heading separator possible
 296                                 value += self.seperator
 297                                 if mPos >= len(value) - 1:
 298                                         mPos += 1
 299
 300                         #diff =         self.valueBounds - len(str(i))
 301                         #if diff > 0:
 302                                 ## if this helps?!
 303                                 #value += " " * diff
 304                         if (self.censorChar == ""):
 305                                 value += ("%0" + str(len(str(self.valueBounds[num][1]))) + "d") % i
 306                         else:
 307                                 value += (self.censorChar * len(str(self.valueBounds[num][1])))
 308                         num += 1
 309                         # only mark cursor when we are selected
 310                         # (this code is heavily ink optimized!)
 311                 if (self.parent.enabled == True):
 312                         return ("mtext"[1-selected:], value, [mPos])
 313                 else:
 314                         return ("text", value)
 315
 316 class configNothing:
 317         def __init__(self, parent):
 318                 self.parent = parent
 319                 self.markedPos = 0
 320
 321         def cancel(self):
 322                 self.parent.reload()
 323
 324         def save(self):
 325                 self.parent.save()
 326
 327         def nextEntry(self):
 328                 self.parent.vals[1](self.parent.getConfigPath())
 329
 330         def handleKey(self, key):
 331                 pass
 332
 333         def __call__(self, selected):                   #needed by configlist
 334                 return ("text", "")
 335
 336 class configText:
 337         # used as first parameter
 338         # is the text of a fixed size or is the user able to extend the length of the text
 339         extendableSize = 1
 340         fixedSize = 2
 341
 342         def __init__(self, parent):
 343                 self.parent = parent
 344                 self.markedPos = 0
 345                 self.mode = self.parent.vals[0]
 346                 self.textInput = NumericalTextInput(self.nextEntry)
 347
 348         def checkValues(self):
 349                 if (self.markedPos < 0):
 350                         self.markedPos = 0
 351                 if (self.markedPos >= len(self.parent.value)):
 352                         self.markedPos = len(self.parent.value) - 1
 353
 354         def cancel(self):
 355                 self.parent.reload()
 356
 357         def save(self):
 358                 self.parent.save()
 359
 360         def nextEntry(self):
 361                 self.parent.vals[1](self.parent.getConfigPath())
 362
 363         def handleKey(self, key):
 364                 #this will no change anything on the value itself
 365                 #so we can handle it here in gui element
 366                 if key == config.key["delete"]:
 367                         self.parent.value = self.parent.value[0:self.markedPos] + self.parent.value[self.markedPos + 1:]
 368                 if key == config.key["prevElement"]:
 369                         self.textInput.nextKey()
 370                         self.markedPos -= 1
 371
 372                 if key == config.key["nextElement"]:
 373                         self.textInput.nextKey()
 374                         self.markedPos += 1
 375                         if (self.mode == self.extendableSize):
 376                                 if (self.markedPos >= len(self.parent.value)):
 377                                         self.parent.value = self.parent.value.ljust(len(self.parent.value) + 1)
 378
 379
 380                 if key >= config.key["0"] and key <= config.key["9"]:
 381                         number = 9 - config.key["9"] + key
 382
 383                         self.parent.value = self.parent.value[0:self.markedPos] + str(self.textInput.getKey(number)) + self.parent.value[self.markedPos + 1:]
 384
 385                 self.checkValues()
 386
 387                 self.parent.change()
 388
 389         def __call__(self, selected):                   #needed by configlist
 390                 return ("mtext"[1-selected:], str(self.parent.value), [self.markedPos])
 391
 392 class configValue:
 393         def __init__(self, obj):
 394                 self.obj = obj
 395
 396         def __str__(self):
 397                 return self.obj
 398
 399 class Config:
 400         def __init__(self):
 401                 self.key = { "choseElement": 0,
 402                                          "prevElement": 1,
 403                                          "nextElement": 2,
 404                                          "delete": 3,
 405                                          "0": 10,
 406                                          "1": 11,
 407                                          "2": 12,
 408                                          "3": 13,
 409                                          "4": 14,
 410                                          "5": 15,
 411                                          "6": 16,
 412                                          "7": 17,
 413                                          "8": 18,
 414                                          "9": 19 }
 415
 416 config = Config();
 417
 418 configfile = configFile()
 419
 420 class configSlider:
 421         def __init__(self, parent):
 422                 self.parent = parent
 423
 424         def cancel(self):
 425                 self.parent.reload()
 426
 427         def save(self):
 428                 self.parent.save()
 429
 430         def checkValues(self):
 431                 if self.parent.value < 0:
 432                         self.parent.value = 0
 433
 434                 if self.parent.value > self.parent.vals[1]:
 435                         self.parent.value = self.parent.vals[1]
 436
 437         def handleKey(self, key):
 438                 if key == config.key["prevElement"]:
 439                         self.parent.value = self.parent.value - self.parent.vals[0]
 440                 if key == config.key["nextElement"]:
 441                         self.parent.value = self.parent.value + self.parent.vals[0]
 442
 443                 self.checkValues()
 444                 self.parent.change()
 445
 446         def __call__(self, selected):                   #needed by configlist
 447                 self.checkValues()
 448                 return ("slider", self.parent.value, self.parent.vals[1])
 449
 450 class ConfigSubsection:
 451         def __init__(self):
 452                 pass
 453
 454 class configElement:
 455
 456         def getIndexbyEntry(self, data):
 457                 cnt = 0;
 458                 tcnt = -1; #for defaultval
 459                 for x in self.vals:
 460                         if int(x[1]) == int(data):
 461                                         return cnt
 462                         if int(x[1]) == int(self.defaultValue):
 463                                         tcnt = cnt
 464                         cnt += 1
 465                 if tcnt != -1:
 466                         return tcnt
 467                 return 0        #prevent bigger then array
 468
 469         def datafromFile(self, control, data):
 470                 if control == configSlider:
 471                         return int(data)
 472                 elif control == configSelection:
 473                         try:
 474                                 return int(data)
 475                         except:
 476                                 for x in data.split(":"):
 477                                         if x[0] == "*":
 478                                                 count = 0
 479                                                 for y in self.vals:
 480                                                         if y[0] == x[1:-1]:
 481                                                                 return count
 482                                                         count += 1
 483                                 return self.defaultValue
 484                 elif control == configDateTime:
 485                         return int(data)
 486                 elif control == configText:
 487                         return str(data)
 488                 elif control == configSequence:
 489                         list = [ ]
 490                         part = data.split(self.vals[0])
 491                         for x in part:
 492                                 list.append(int(x))
 493                         return list
 494                 elif control == configSatlist:
 495                         return self.getIndexbyEntry(data)
 496                 else:
 497                         return ""
 498
 499         def datatoFile(self, control, data):
 500                 if control == configSlider:
 501                         return str(data)
 502                 elif control == configSelection:
 503                         if len(self.vals) < data + 1:
 504                                 return "0"
 505                         if isinstance(self.vals[data], str):
 506                                 return str(data)
 507                         else:
 508                                 confList = []
 509                                 count = 0
 510                                 for x in self.vals:
 511                                         if count == data:
 512                                                 confList.append("*" + str(x[0] + "*"))
 513                                         else:
 514                                                 confList.append(x[0])
 515                                         count += 1
 516                                 return ":".join(confList)
 517                         return str(data)
 518                 elif control == configDateTime:
 519                         return str(data)
 520                 elif control == configText:
 521                         return str(data.strip())
 522                 elif control == configSequence:
 523 #                       print self.vals
 524 #                       print self.value
 525                         try:
 526                                 value = ""
 527                                 count = 0
 528                                 for i in data:
 529                                         if value !="":
 530                                                 value += self.vals[0]
 531                                         value += (("%0" + str(len(str(self.vals[1][count][1]))) + "d") % i)
 532                                         count += 1
 533                                         #value = ((len(data) * ("%d" + self.vals[0]))[0:-1]) % tuple(data)
 534                         except:
 535                                 value = str(data)
 536                         return value
 537                 elif control == configSatlist:
 538                         return str(self.vals[self.value][1]);
 539                 else:
 540                         return ""
 541
 542         def loadData(self):
 543                 #print "load:" + self.configPath
 544                 try:
 545                         value = self.datafromFile(self.controlType, configfile.getKey(self.configPath))
 546                 except:
 547                         value = ""
 548
 549                 if value == "":
 550                         #print "value not found - using default"
 551                         if self.controlType == configSatlist:
 552                                 self.value = self.getIndexbyEntry(self.defaultValue)
 553                         elif self.controlType == configSequence:
 554                                 self.value = self.defaultValue[:]
 555                         else:
 556                                 self.value = self.defaultValue
 557
 558                         self.save()             #add missing value to dict
 559                 else:
 560                         #print "set val:" + str(value)
 561                         self.value = value
 562
 563                 #is this right? activate settings after load/cancel and use default
 564                 self.change()
 565
 566         def __init__(self, configPath, control, defaultValue, vals, saveDefaults = True):
 567                 self.configPath = configPath
 568                 self.defaultValue = defaultValue
 569                 self.controlType = control
 570                 self.vals = vals
 571                 self.notifierList = [ ]
 572                 self.enabled = True
 573                 self.saveDefaults = saveDefaults
 574                 self.loadData()
 575
 576         def getConfigPath(self):
 577                 return self.configPath
 578
 579         def addNotifier(self, notifier):
 580                 self.notifierList.append(notifier);
 581                 notifier(self);
 582
 583         def change(self):
 584                 for notifier in self.notifierList:
 585                         notifier(self)
 586
 587         def reload(self):
 588                 self.loadData()
 589
 590         def save(self):
 591                 if self.controlType == configSatlist:
 592                         defaultValue = self.getIndexbyEntry(self.defaultValue)
 593                 else:
 594                         defaultValue = self.defaultValue
 595                 if self.value != defaultValue or self.saveDefaults:
 596                         configfile.setKey(self.configPath, self.datatoFile(self.controlType, self.value))
 597                 else:
 598                         try:
 599                                 oldValue = configfile.getKey(self.configPath)
 600                         except:
 601                                 oldValue = None
 602                         if oldValue is not None and oldValue != defaultValue:
 603                                 configfile.setKey(self.configPath, self.datatoFile(self.controlType, self.value), True)
 604
 605 class configElement_nonSave(configElement):
 606         def __init__(self, configPath, control, defaultValue, vals):
 607                 configElement.__init__(self, configPath, control, defaultValue, vals)
 608
 609         def save(self):
 610                 pass
 611
 612 def getConfigListEntry(description, element):
 613         b = element
 614         item = b.controlType(b)
 615         return ((description, item))
 616
 617 def configElementBoolean(name, default, texts=(_("Enable"), _("Disable"))):
 618         return configElement(name, configSelection, default, texts)
 619
 620 config.misc = ConfigSubsection()