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 configText:
 298         # used as first parameter
 299         # is the text of a fixed size or is the user able to extend the length of the text
 300         extendableSize = 1
 301         fixedSize = 2
 302
 303         def __init__(self, parent):
 304                 self.parent = parent
 305                 self.markedPos = 0
 306                 self.mode = self.parent.vals[0]
 307                 self.textInput = NumericalTextInput(self.nextEntry)
 308
 309         def checkValues(self):
 310                 if (self.markedPos < 0):
 311                         self.markedPos = 0
 312                 if (self.markedPos >= len(self.parent.value)):
 313                         self.markedPos = len(self.parent.value) - 1
 314
 315         def cancel(self):
 316                 self.parent.reload()
 317
 318         def save(self):
 319                 self.parent.save()
 320
 321         def nextEntry(self):
 322                 self.parent.vals[1](self.parent.getConfigPath())
 323
 324         def handleKey(self, key):
 325                 #this will no change anything on the value itself
 326                 #so we can handle it here in gui element
 327                 if key == config.key["delete"]:
 328                         self.parent.value = self.parent.value[0:self.markedPos] + self.parent.value[self.markedPos + 1:]
 329                 if key == config.key["prevElement"]:
 330                         self.textInput.nextKey()
 331                         self.markedPos -= 1
 332
 333                 if key == config.key["nextElement"]:
 334                         self.textInput.nextKey()
 335                         self.markedPos += 1
 336                         if (self.mode == self.extendableSize):
 337                                 if (self.markedPos >= len(self.parent.value)):
 338                                         self.parent.value = self.parent.value.ljust(len(self.parent.value) + 1)
 339
 340
 341                 if key >= config.key["0"] and key <= config.key["9"]:
 342                         number = 9 - config.key["9"] + key
 343
 344                         self.parent.value = self.parent.value[0:self.markedPos] + str(self.textInput.getKey(number)) + self.parent.value[self.markedPos + 1:]
 345
 346                 self.checkValues()
 347
 348                 self.parent.change()
 349
 350         def __call__(self, selected):                   #needed by configlist
 351                 return ("mtext"[1-selected:], str(self.parent.value), [self.markedPos])
 352
 353 class configValue:
 354         def __init__(self, obj):
 355                 self.obj = obj
 356
 357         def __str__(self):
 358                 return self.obj
 359
 360 class Config:
 361         def __init__(self):
 362                 self.key = { "choseElement": 0,
 363                                          "prevElement": 1,
 364                                          "nextElement": 2,
 365                                          "delete": 3,
 366                                          "0": 10,
 367                                          "1": 11,
 368                                          "2": 12,
 369                                          "3": 13,
 370                                          "4": 14,
 371                                          "5": 15,
 372                                          "6": 16,
 373                                          "7": 17,
 374                                          "8": 18,
 375                                          "9": 19 }
 376
 377 config = Config();
 378
 379 configfile = configFile()
 380
 381 class ConfigSlider:
 382         def __init__(self, parent):
 383                 self.parent = parent
 384
 385         def cancel(self):
 386                 self.parent.reload()
 387
 388         def save(self):
 389                 self.parent.save()
 390
 391         def checkValues(self):
 392                 if self.parent.value < 0:
 393                         self.parent.value = 0
 394
 395                 if self.parent.value > 10:
 396                         self.parent.value = 10
 397
 398         def handleKey(self, key):
 399                 if key == config.key["prevElement"]:
 400                         self.parent.value = self.parent.value - 1
 401                 if key == config.key["nextElement"]:
 402                         self.parent.value = self.parent.value + 1
 403
 404                 self.checkValues()
 405                 self.parent.change()
 406
 407         def __call__(self, selected):                   #needed by configlist
 408                 self.checkValues()
 409                 return ("slider", self.parent.value * 10)
 410
 411 class ConfigSubsection:
 412         def __init__(self):
 413                 pass
 414
 415 class configElement:
 416
 417         def getIndexbyEntry(self, data):
 418                 cnt = 0;
 419                 tcnt = -1; #for defaultval
 420                 for x in self.vals:
 421                         if int(x[1]) == int(data):
 422                                         return cnt
 423                         if int(x[1]) == int(self.defaultValue):
 424                                         tcnt = cnt
 425                         cnt += 1
 426                 if tcnt != -1:
 427                         return tcnt
 428                 return 0        #prevent bigger then array
 429
 430         def datafromFile(self, control, data):
 431                 if control == ConfigSlider:
 432                         return int(data)
 433                 elif control == configSelection:
 434                         try:
 435                                 return int(data)
 436                         except:
 437                                 for x in data.split(":"):
 438                                         if x[0] == "*":
 439                                                 count = 0
 440                                                 for y in self.vals:
 441                                                         if y[0] == x[1:-1]:
 442                                                                 return count
 443                                                         count += 1
 444                                 return self.defaultValue
 445                 elif control == configDateTime:
 446                         return int(data)
 447                 elif control == configText:
 448                         return str(data)
 449                 elif control == configSequence:
 450                         list = [ ]
 451                         part = data.split(self.vals[0])
 452                         for x in part:
 453                                 list.append(int(x))
 454                         return list
 455                 elif control == configSatlist:
 456                         return self.getIndexbyEntry(data)
 457                 else:
 458                         return ""
 459
 460         def datatoFile(self, control, data):
 461                 if control == ConfigSlider:
 462                         return str(data)
 463                 elif control == configSelection:
 464                         if len(self.vals) < data + 1:
 465                                 return "0"
 466                         if isinstance(self.vals[data], str):
 467                                 return str(data)
 468                         else:
 469                                 confList = []
 470                                 count = 0
 471                                 for x in self.vals:
 472                                         if count == data:
 473                                                 confList.append("*" + str(x[0] + "*"))
 474                                         else:
 475                                                 confList.append(x[0])
 476                                         count += 1
 477                                 return ":".join(confList)
 478                         return str(data)
 479                 elif control == configDateTime:
 480                         return str(data)
 481                 elif control == configText:
 482                         return str(data.strip())
 483                 elif control == configSequence:
 484 #                       print self.vals
 485 #                       print self.value
 486                         try:
 487                                 value = ""
 488                                 count = 0
 489                                 for i in data:
 490                                         if value !="":
 491                                                 value += self.vals[0]
 492                                         value += (("%0" + str(len(str(self.vals[1][count][1]))) + "d") % i)
 493                                         count += 1
 494                                         #value = ((len(data) * ("%d" + self.vals[0]))[0:-1]) % tuple(data)
 495                         except:
 496                                 value = str(data)
 497                         return value
 498                 elif control == configSatlist:
 499                         return str(self.vals[self.value][1]);
 500                 else:
 501                         return ""
 502
 503         def loadData(self):
 504                 #print "load:" + self.configPath
 505                 try:
 506                         value = self.datafromFile(self.controlType, configfile.getKey(self.configPath))
 507                 except:
 508                         value = ""
 509
 510                 if value == "":
 511                         #print "value not found - using default"
 512                         if self.controlType == configSatlist:
 513                                 self.value = self.getIndexbyEntry(self.defaultValue)
 514                         elif self.controlType == configSequence:
 515                                 self.value = self.defaultValue[:]
 516                         else:
 517                                 self.value = self.defaultValue
 518
 519                         self.save()             #add missing value to dict
 520                 else:
 521                         #print "set val:" + str(value)
 522                         self.value = value
 523
 524                 #is this right? activate settings after load/cancel and use default
 525                 self.change()
 526
 527         def __init__(self, configPath, control, defaultValue, vals, saveDefaults = True):
 528                 self.configPath = configPath
 529                 self.defaultValue = defaultValue
 530                 self.controlType = control
 531                 self.vals = vals
 532                 self.notifierList = [ ]
 533                 self.enabled = True
 534                 self.saveDefaults = saveDefaults
 535                 self.loadData()
 536
 537         def getConfigPath(self):
 538                 return self.configPath
 539
 540         def addNotifier(self, notifier):
 541                 self.notifierList.append(notifier);
 542                 notifier(self);
 543
 544         def change(self):
 545                 for notifier in self.notifierList:
 546                         notifier(self)
 547
 548         def reload(self):
 549                 self.loadData()
 550
 551         def save(self):
 552                 if self.controlType == configSatlist:
 553                         defaultValue = self.getIndexbyEntry(self.defaultValue)
 554                 else:
 555                         defaultValue = self.defaultValue
 556                 if self.value != defaultValue or self.saveDefaults:
 557                         configfile.setKey(self.configPath, self.datatoFile(self.controlType, self.value))
 558                 else:
 559                         try:
 560                                 oldValue = configfile.getKey(self.configPath)
 561                         except:
 562                                 oldValue = None
 563                         if oldValue is not None and oldValue != defaultValue:
 564                                 configfile.setKey(self.configPath, self.datatoFile(self.controlType, self.value), True)
 565
 566 class configElement_nonSave(configElement):
 567         def __init__(self, configPath, control, defaultValue, vals):
 568                 configElement.__init__(self, configPath, control, defaultValue, vals)
 569
 570         def save(self):
 571                 pass
 572
 573 def getConfigListEntry(description, element):
 574         b = element
 575         item = b.controlType(b)
 576         return ((description, item))
 577
 578 def configElementBoolean(name, default, texts=(_("Enable"), _("Disable"))):
 579         return configElement(name, configSelection, default, texts)
 580
 581 config.misc = ConfigSubsection()