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