add support for cyclic garbage collection to eTimer and eSocketNotifier
[vuplus_dvbapp] / lib / python / Components / config.py
1 import time
2 from enigma import getPrevAsciiCode
3 from Tools.NumericalTextInput import NumericalTextInput
4 from Tools.Directories import resolveFilename, SCOPE_CONFIG
5 import copy
6
7
8 # ConfigElement, the base class of all ConfigElements.
9
10 # it stores:
11 #   value    the current value, usefully encoded.
12 #            usually a property which retrieves _value,
13 #            and maybe does some reformatting
14 #   _value   the value as it's going to be saved in the configfile,
15 #            though still in non-string form.
16 #            this is the object which is actually worked on.
17 #   default  the initial value. If _value is equal to default,
18 #            it will not be stored in the config file
19 #   saved_value is a text representation of _value, stored in the config file
20 #
21 # and has (at least) the following methods:
22 #   save()   stores _value into saved_value, 
23 #            (or stores 'None' if it should not be stored)
24 #   load()   loads _value from saved_value, or loads
25 #            the default if saved_value is 'None' (default)
26 #            or invalid.
27 #
28 class ConfigElement(object):
29         def __init__(self):
30
31                 object.__init__(self)
32                 self.saved_value = None
33                 self.save_disabled = False
34                 self.notifiers = []
35                 self.enabled = True
36
37         # you need to override this to do input validation
38         def setValue(self, value):
39                 self._value = value
40                 self.changed()
41
42         def getValue(self):
43                 return self._value
44         
45         value = property(getValue, setValue)
46
47         # you need to override this if self.value is not a string
48         def fromstring(self, value):
49                 return value
50
51         # you can overide this for fancy default handling
52         def load(self):
53                 if self.saved_value is None:
54                         self.value = self.default
55                 else:
56                         self.value = self.fromstring(self.saved_value)
57
58         def tostring(self, value):
59                 return str(value)
60
61         # you need to override this if str(self.value) doesn't work
62         def save(self):
63                 if self.save_disabled or self.value == self.default:
64                         self.saved_value = None
65                 else:
66                         self.saved_value = self.tostring(self.value)
67
68         def cancel(self):
69                 self.load()
70
71         def isChanged(self):
72                 if self.saved_value is None and self.value == self.default:
73                         return False
74                 return self.tostring(self.value) != self.saved_value
75
76         def changed(self):
77                 for x in self.notifiers:
78                         x(self)
79                         
80         def addNotifier(self, notifier, initial_call = True):
81                 assert callable(notifier), "notifiers must be callable"
82                 self.notifiers.append(notifier)
83
84                 # CHECKME:
85                 # do we want to call the notifier
86                 #  - at all when adding it? (yes, though optional)
87                 #  - when the default is active? (yes)
88                 #  - when no value *yet* has been set,
89                 #    because no config has ever been read (currently yes)
90                 #    (though that's not so easy to detect.
91                 #     the entry could just be new.)
92                 if initial_call:
93                         notifier(self)
94
95         def disableSave(self):
96                 self.save_disabled = True
97
98         def __call__(self, selected):
99                 return self.getMulti(selected)
100
101         def onSelect(self, session):
102                 pass
103
104         def onDeselect(self, session):
105                 pass
106
107 KEY_LEFT = 0
108 KEY_RIGHT = 1
109 KEY_OK = 2
110 KEY_DELETE = 3
111 KEY_BACKSPACE = 4
112 KEY_HOME = 5
113 KEY_END = 6
114 KEY_TOGGLEOW = 7
115 KEY_ASCII = 8
116 KEY_TIMEOUT = 9
117 KEY_NUMBERS = range(12, 12+10)
118 KEY_0 = 12
119 KEY_9 = 12+9
120
121 def getKeyNumber(key):
122         assert key in KEY_NUMBERS
123         return key - KEY_0
124
125 #
126 # ConfigSelection is a "one of.."-type.
127 # it has the "choices", usually a list, which contains
128 # (id, desc)-tuples (or just only the ids, in case the id
129 # will be used as description)
130 #
131 # all ids MUST be plain strings.
132 #
133 class ConfigSelection(ConfigElement):
134         def __init__(self, choices, default = None):
135                 ConfigElement.__init__(self)
136                 self.choices = []
137                 self.description = {}
138                 
139                 if isinstance(choices, list):
140                         for x in choices:
141                                 if isinstance(x, tuple):
142                                         self.choices.append(x[0])
143                                         self.description[x[0]] = x[1]
144                                 else:
145                                         self.choices.append(x)
146                                         self.description[x] = x
147                 elif isinstance(choices, dict):
148                         for (key, val) in choices.items():
149                                 self.choices.append(key)
150                                 self.description[key] = val
151                 else:
152                         assert False, "ConfigSelection choices must be dict or list!"
153                 
154                 #assert len(self.choices), "you can't have an empty configselection"
155                 if len(self.choices) == 0:
156                         self.choices = [""]
157                         self.description[""] = ""
158
159                 if default is None:
160                         default = self.choices[0]
161
162                 assert default in self.choices, "default must be in choice list, but " + repr(default) + " is not!"
163                 for x in self.choices:
164                         assert isinstance(x, str), "ConfigSelection choices must be strings"
165                 
166                 self.value = self.default = default
167
168         def setValue(self, value):
169                 if value in self.choices:
170                         self._value = value
171                 else:
172                         self._value = self.default
173                 
174                 self.changed()
175
176         def tostring(self, val):
177                 return val
178
179         def getValue(self):
180                 return self._value
181
182         def setCurrentText(self, text):
183                 i = self.choices.index(self.value)
184                 del self.description[self.choices[i]]
185                 self.choices[i] = text
186                 self.description[text] = text
187                 self._value = text
188
189         value = property(getValue, setValue)
190         
191         def getIndex(self):
192                 return self.choices.index(self.value)
193         
194         index = property(getIndex)
195
196         # GUI
197         def handleKey(self, key):
198                 nchoices = len(self.choices)
199                 i = self.choices.index(self.value)
200                 if key == KEY_LEFT:
201                         self.value = self.choices[(i + nchoices - 1) % nchoices]
202                 elif key == KEY_RIGHT:
203                         self.value = self.choices[(i + 1) % nchoices]
204                 elif key == KEY_HOME:
205                         self.value = self.choices[0]
206                 elif key == KEY_END:
207                         self.value = self.choices[nchoices - 1]
208
209         def getText(self):
210                 descr = self.description[self.value]
211                 if len(descr):
212                         return _(descr)
213                 return descr
214
215         def getMulti(self, selected):
216                 descr = self.description[self.value]
217                 if len(descr):
218                         return ("text", _(descr))
219                 return ("text", descr)
220
221         # HTML
222         def getHTML(self, id):
223                 res = ""
224                 for v in self.choices:
225                         if self.value == v:
226                                 checked = 'checked="checked" '
227                         else:
228                                 checked = ''
229                         res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + self.description[v] + "</input></br>\n"
230                 return res;
231
232         def unsafeAssign(self, value):
233                 # setValue does check if value is in choices. This is safe enough.
234                 self.value = value
235
236 # a binary decision.
237 #
238 # several customized versions exist for different
239 # descriptions.
240 #
241 class ConfigBoolean(ConfigElement):
242         def __init__(self, default = False, descriptions = {False: "false", True: "true"}):
243                 ConfigElement.__init__(self)
244                 self.descriptions = descriptions
245                 self.value = self.default = default
246         def handleKey(self, key):
247                 if key in [KEY_LEFT, KEY_RIGHT]:
248                         self.value = not self.value
249                 elif key == KEY_HOME:
250                         self.value = False
251                 elif key == KEY_END:
252                         self.value = True
253
254         def getText(self):
255                 descr = self.descriptions[self.value]
256                 if len(descr):
257                         return _(descr)
258                 return descr
259
260         def getMulti(self, selected):
261                 descr = self.descriptions[self.value]
262                 if len(descr):
263                         return ("text", _(descr))
264                 return ("text", descr)
265
266         def tostring(self, value):
267                 if not value:
268                         return "false"
269                 else:
270                         return "true"
271
272         def fromstring(self, val):
273                 if val == "true":
274                         return True
275                 else:
276                         return False
277
278         def getHTML(self, id):
279                 if self.value:
280                         checked = ' checked="checked"'
281                 else:
282                         checked = ''
283                 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
284
285         # this is FLAWED. and must be fixed.
286         def unsafeAssign(self, value):
287                 if value == "1":
288                         self.value = True
289                 else:
290                         self.value = False
291
292 class ConfigYesNo(ConfigBoolean):
293         def __init__(self, default = False):
294                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("no"), True: _("yes")})
295
296 class ConfigOnOff(ConfigBoolean):
297         def __init__(self, default = False):
298                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("off"), True: _("on")})
299
300 class ConfigEnableDisable(ConfigBoolean):
301         def __init__(self, default = False):
302                 ConfigBoolean.__init__(self, default = default, descriptions = {False: _("disable"), True: _("enable")})
303
304 class ConfigDateTime(ConfigElement):
305         def __init__(self, default, formatstring, increment = 86400):
306                 ConfigElement.__init__(self)
307                 self.increment = increment
308                 self.formatstring = formatstring
309                 self.value = self.default = int(default)
310
311         def handleKey(self, key):
312                 if key == KEY_LEFT:
313                         self.value = self.value - self.increment
314                 elif key == KEY_RIGHT:
315                         self.value = self.value + self.increment
316                 elif key == KEY_HOME or key == KEY_END:
317                         self.value = self.default
318
319         def getText(self):
320                 return time.strftime(self.formatstring, time.localtime(self.value))
321
322         def getMulti(self, selected):
323                 return ("text", time.strftime(self.formatstring, time.localtime(self.value)))
324
325         def fromstring(self, val):
326                 return int(val)
327
328 # *THE* mighty config element class
329 #
330 # allows you to store/edit a sequence of values.
331 # can be used for IP-addresses, dates, plain integers, ...
332 # several helper exist to ease this up a bit.
333 #
334 class ConfigSequence(ConfigElement):
335         def __init__(self, seperator, limits, censor_char = "", default = None):
336                 ConfigElement.__init__(self)
337                 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
338                 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
339                 #assert isinstance(default, list), "default must be a list"
340                 #assert isinstance(default[0], int), "list must contain numbers"
341                 #assert len(default) == len(limits), "length must match"
342
343                 self.marked_pos = 0
344                 self.seperator = seperator
345                 self.limits = limits
346                 self.censor_char = censor_char
347                 
348                 self.default = default
349                 self.value = copy.copy(default)
350                 
351                 self.endNotifier = []
352
353         def validate(self):
354                 max_pos = 0
355                 num = 0
356                 for i in self._value:
357                         max_pos += len(str(self.limits[num][1]))
358
359                         while self._value[num] < self.limits[num][0]:
360                                 self._value[num] += 1
361
362                         while self._value[num] > self.limits[num][1]:
363                                 self._value[num] -= 1
364
365                         num += 1
366
367                 if self.marked_pos >= max_pos:
368                         for x in self.endNotifier:
369                                 x(self)
370                         self.marked_pos = max_pos - 1
371
372                 if self.marked_pos < 0:
373                         self.marked_pos = 0
374
375         def validatePos(self):
376                 if self.marked_pos < 0:
377                         self.marked_pos = 0
378                         
379                 total_len = sum([len(str(x[1])) for x in self.limits])
380
381                 if self.marked_pos >= total_len:
382                         self.marked_pos = total_len - 1
383                         
384         def addEndNotifier(self, notifier):
385                 self.endNotifier.append(notifier)
386
387         def handleKey(self, key):
388                 if key == KEY_LEFT:
389                         self.marked_pos -= 1
390                         self.validatePos()
391
392                 if key == KEY_RIGHT:
393                         self.marked_pos += 1
394                         self.validatePos()
395                 
396                 if key == KEY_HOME:
397                         self.marked_pos = 0
398                         self.validatePos()
399
400                 if key == KEY_END:
401                         max_pos = 0
402                         num = 0
403                         for i in self._value:
404                                 max_pos += len(str(self.limits[num][1]))
405                                 num += 1
406                         self.marked_pos = max_pos - 1
407                         self.validatePos()
408                 
409                 if key in KEY_NUMBERS or key == KEY_ASCII:
410                         if key == KEY_ASCII:
411                                 code = getPrevAsciiCode()
412                                 if code < 48 or code > 57:
413                                         return
414                                 number = code - 48
415                         else:
416                                 number = getKeyNumber(key)
417                         
418                         block_len = []
419                         for x in self.limits:
420                                 block_len.append(len(str(x[1])))
421                         
422                         total_len = sum(block_len)
423
424                         pos = 0
425                         blocknumber = 0
426                         block_len_total = [0, ]
427                         for x in block_len:
428                                 pos += block_len[blocknumber]
429                                 block_len_total.append(pos)
430                                 if pos - 1 >= self.marked_pos:
431                                         pass
432                                 else:
433                                         blocknumber += 1
434
435                         # length of numberblock
436                         number_len = len(str(self.limits[blocknumber][1]))
437
438                         # position in the block
439                         posinblock = self.marked_pos - block_len_total[blocknumber]
440                         
441                         oldvalue = self._value[blocknumber]
442                         olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
443                         newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
444                         
445                         self._value[blocknumber] = newvalue
446                         self.marked_pos += 1
447                 
448                         self.validate()
449                         self.changed()
450         
451         def genText(self):
452                 value = ""
453                 mPos = self.marked_pos
454                 num = 0;
455                 for i in self._value:
456                         if len(value):  #fixme no heading separator possible
457                                 value += self.seperator
458                                 if mPos >= len(value) - 1:
459                                         mPos += 1
460
461                         if self.censor_char == "":
462                                 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
463                         else:
464                                 value += (self.censor_char * len(str(self.limits[num][1])))
465                         num += 1
466                 return (value, mPos)
467                 
468         def getText(self):
469                 (value, mPos) = self.genText()
470                 return value
471         
472         def getMulti(self, selected):
473                 (value, mPos) = self.genText()
474                         # only mark cursor when we are selected
475                         # (this code is heavily ink optimized!)
476                 if self.enabled:
477                         return ("mtext"[1-selected:], value, [mPos])
478                 else:
479                         return ("text", value)
480
481         def tostring(self, val):
482                 return self.seperator.join([self.saveSingle(x) for x in val])
483         
484         def saveSingle(self, v):
485                 return str(v)
486
487         def fromstring(self, value):
488                 return [int(x) for x in value.split(self.seperator)]
489
490 class ConfigIP(ConfigSequence):
491         def __init__(self, default):
492                 ConfigSequence.__init__(self, seperator = ".", limits = [(0,255),(0,255),(0,255),(0,255)], default = default)
493         
494         def getHTML(self, id):
495                 # we definitely don't want leading zeros
496                 return '.'.join(["%d" % d for d in self.value])
497
498 class ConfigMAC(ConfigSequence):
499         def __init__(self, default):
500                 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
501
502 class ConfigPosition(ConfigSequence):
503         def __init__(self, default, args):
504                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
505
506 class ConfigClock(ConfigSequence):
507         def __init__(self, default):
508                 import time
509                 t = time.localtime(default)
510                 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
511
512 class ConfigInteger(ConfigSequence):
513         def __init__(self, default, limits = (0, 10000000000)):
514                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
515         
516         # you need to override this to do input validation
517         def setValue(self, value):
518                 self._value = [value]
519                 self.changed()
520
521         def getValue(self):
522                 return self._value[0]
523         
524         value = property(getValue, setValue)
525
526         def fromstring(self, value):
527                 return int(value)
528
529         def tostring(self, value):
530                 return str(value)
531
532 class ConfigPIN(ConfigInteger):
533         def __init__(self, default, len = 4, censor = ""):
534                 assert isinstance(default, int), "ConfigPIN default must be an integer"
535                 if default == -1:
536                         default = "aaaa"
537                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
538                 self.len = len
539
540         def getLength(self):
541                 return self.len
542
543 class ConfigFloat(ConfigSequence):
544         def __init__(self, default, limits):
545                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
546
547         def getFloat(self):
548                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
549
550         float = property(getFloat)
551
552 # an editable text...
553 class ConfigText(ConfigElement, NumericalTextInput):
554         def __init__(self, default = "", fixed_size = True, visible_width = False):
555                 ConfigElement.__init__(self)
556                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
557                 
558                 self.marked_pos = 0
559                 self.allmarked = (default != "")
560                 self.fixed_size = fixed_size
561                 self.visible_width = visible_width
562                 self.offset = 0
563                 self.overwrite = fixed_size
564                 self.help_window = None
565                 self.value = self.default = default
566
567         def validateMarker(self):
568                 if self.fixed_size:
569                         if self.marked_pos > len(self.text)-1:
570                                 self.marked_pos = len(self.text)-1
571                 else:
572                         if self.marked_pos > len(self.text):
573                                 self.marked_pos = len(self.text)
574                 if self.marked_pos < 0:
575                         self.marked_pos = 0
576                 if self.visible_width:
577                         if self.marked_pos < self.offset:
578                                 self.offset = self.marked_pos
579                         if self.marked_pos >= self.offset + self.visible_width:
580                                 if self.marked_pos == len(self.text):
581                                         self.offset = self.marked_pos - self.visible_width
582                                 else:
583                                         self.offset = self.marked_pos - self.visible_width + 1
584                         if self.offset > 0 and self.offset + self.visible_width > len(self.text):
585                                 self.offset = max(0, len(self.text) - self.visible_width)
586
587         def insertChar(self, ch, pos, owr):
588                 if owr or self.overwrite:
589                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
590                 elif self.fixed_size:
591                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
592                 else:
593                         self.text = self.text[0:pos] + ch + self.text[pos:]
594
595         def deleteChar(self, pos):
596                 if not self.fixed_size:
597                         self.text = self.text[0:pos] + self.text[pos + 1:]
598                 elif self.overwrite:
599                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
600                 else:
601                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
602
603         def deleteAllChars(self):
604                 if self.fixed_size:
605                         self.text = " " * len(self.text)
606                 else:
607                         self.text = ""
608                 self.marked_pos = 0
609
610         def handleKey(self, key):
611                 # this will no change anything on the value itself
612                 # so we can handle it here in gui element
613                 if key == KEY_DELETE:
614                         self.timeout()
615                         if self.allmarked:
616                                 self.deleteAllChars()
617                                 self.allmarked = False
618                         else:
619                                 self.deleteChar(self.marked_pos)
620                                 if self.fixed_size and self.overwrite:
621                                         self.marked_pos += 1
622                 elif key == KEY_BACKSPACE:
623                         self.timeout()
624                         if self.allmarked:
625                                 self.deleteAllChars()
626                                 self.allmarked = False
627                         elif self.marked_pos > 0:
628                                 self.deleteChar(self.marked_pos-1)
629                                 if not self.fixed_size and self.offset > 0:
630                                         self.offset -= 1
631                                 self.marked_pos -= 1
632                 elif key == KEY_LEFT:
633                         self.timeout()
634                         if self.allmarked:
635                                 self.marked_pos = len(self.text)
636                                 self.allmarked = False
637                         else:
638                                 self.marked_pos -= 1
639                 elif key == KEY_RIGHT:
640                         self.timeout()
641                         if self.allmarked:
642                                 self.marked_pos = 0
643                                 self.allmarked = False
644                         else:
645                                 self.marked_pos += 1
646                 elif key == KEY_HOME:
647                         self.timeout()
648                         self.allmarked = False
649                         self.marked_pos = 0
650                 elif key == KEY_END:
651                         self.timeout()
652                         self.allmarked = False
653                         self.marked_pos = len(self.text)
654                 elif key == KEY_TOGGLEOW:
655                         self.timeout()
656                         self.overwrite = not self.overwrite
657                 elif key == KEY_ASCII:
658                         self.timeout()
659                         newChar = unichr(getPrevAsciiCode())
660                         if self.allmarked:
661                                 self.deleteAllChars()
662                                 self.allmarked = False
663                         self.insertChar(newChar, self.marked_pos, False)
664                         self.marked_pos += 1
665                 elif key in KEY_NUMBERS:
666                         owr = self.lastKey == getKeyNumber(key)
667                         newChar = self.getKey(getKeyNumber(key))
668                         if self.allmarked:
669                                 self.deleteAllChars()
670                                 self.allmarked = False
671                         self.insertChar(newChar, self.marked_pos, owr)
672                 elif key == KEY_TIMEOUT:
673                         self.timeout()
674                         if self.help_window:
675                                 self.help_window.update(self)
676                         return
677
678                 if self.help_window:
679                         self.help_window.update(self)
680                 self.validateMarker()
681                 self.changed()
682
683         def nextFunc(self):
684                 self.marked_pos += 1
685                 self.validateMarker()
686                 self.changed()
687
688         def getValue(self):
689                 return self.text.encode("utf-8")
690                 
691         def setValue(self, val):
692                 try:
693                         self.text = val.decode("utf-8")
694                 except UnicodeDecodeError:
695                         self.text = val
696                         print "Broken UTF8!"
697
698         value = property(getValue, setValue)
699         _value = property(getValue, setValue)
700
701         def getText(self):
702                 return self.value
703
704         def getMulti(self, selected):
705                 if self.visible_width:
706                         if self.allmarked:
707                                 mark = range(0, min(self.visible_width, len(self.text)))
708                         else:
709                                 mark = [self.marked_pos-self.offset]
710                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
711                 else:
712                         if self.allmarked:
713                                 mark = range(0, len(self.text))
714                         else:
715                                 mark = [self.marked_pos]
716                         return ("mtext"[1-selected:], self.value+" ", mark)
717
718         def onSelect(self, session):
719                 self.allmarked = (self.value != "")
720                 if session is not None:
721                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
722                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
723                         self.help_window.show()
724
725         def onDeselect(self, session):
726                 self.marked_pos = 0
727                 self.offset = 0
728                 if self.help_window:
729                         session.deleteDialog(self.help_window)
730                         self.help_window = None
731
732         def getHTML(self, id):
733                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
734
735         def unsafeAssign(self, value):
736                 self.value = str(value)
737
738 # a slider.
739 class ConfigSlider(ConfigElement):
740         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
741                 ConfigElement.__init__(self)
742                 self.value = self.default = default
743                 self.min = limits[0]
744                 self.max = limits[1]
745                 self.increment = increment
746
747         def checkValues(self):
748                 if self.value < self.min:
749                         self.value = self.min
750
751                 if self.value > self.max:
752                         self.value = self.max
753
754         def handleKey(self, key):
755                 if key == KEY_LEFT:
756                         self.value -= self.increment
757                 elif key == KEY_RIGHT:
758                         self.value += self.increment
759                 elif key == KEY_HOME:
760                         self.value = self.min
761                 elif key == KEY_END:
762                         self.value = self.max
763                 else:
764                         return
765
766                 self.checkValues()
767                 self.changed()
768
769         def getText(self):
770                 return "%d / %d" % (self.value, self.max)
771
772         def getMulti(self, selected):
773                 self.checkValues()
774                 return ("slider", self.value, self.max)
775
776         def fromstring(self, value):
777                 return int(value)
778
779 # a satlist. in fact, it's a ConfigSelection.
780 class ConfigSatlist(ConfigSelection):
781         def __init__(self, list, default = None):
782                 if default is not None:
783                         default = str(default)
784                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
785
786         def getOrbitalPosition(self):
787                 if self.value == "":
788                         return None
789                 return int(self.value)
790         
791         orbital_position = property(getOrbitalPosition)
792
793 # nothing.
794 class ConfigNothing(ConfigSelection):
795         def __init__(self):
796                 ConfigSelection.__init__(self, choices = [""])
797
798 # until here, 'saved_value' always had to be a *string*.
799 # now, in ConfigSubsection, and only there, saved_value
800 # is a dict, essentially forming a tree.
801 #
802 # config.foo.bar=True
803 # config.foobar=False
804 #
805 # turns into:
806 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
807 #
808
809
810 class ConfigSubsectionContent(object):
811         pass
812
813 # we store a backup of the loaded configuration
814 # data in self.stored_values, to be able to deploy
815 # them when a new config element will be added,
816 # so non-default values are instantly available
817
818 # A list, for example:
819 # config.dipswitches = ConfigSubList()
820 # config.dipswitches.append(ConfigYesNo())
821 # config.dipswitches.append(ConfigYesNo())
822 # config.dipswitches.append(ConfigYesNo())
823 class ConfigSubList(list, object):
824         def __init__(self):
825                 object.__init__(self)
826                 list.__init__(self)
827                 self.stored_values = {}
828
829         def save(self):
830                 for x in self:
831                         x.save()
832         
833         def load(self):
834                 for x in self:
835                         x.load()
836
837         def getSavedValue(self):
838                 res = {}
839                 for i in range(len(self)):
840                         sv = self[i].saved_value
841                         if sv is not None:
842                                 res[str(i)] = sv
843                 return res
844
845         def setSavedValue(self, values):
846                 self.stored_values = dict(values)
847                 for (key, val) in self.stored_values.items():
848                         if int(key) < len(self):
849                                 self[int(key)].saved_value = val
850
851         saved_value = property(getSavedValue, setSavedValue)
852         
853         def append(self, item):
854                 i = str(len(self))
855                 list.append(self, item)
856                 if i in self.stored_values:
857                         item.saved_value = self.stored_values[i]
858                         item.load()
859
860         def dict(self):
861                 res = dict()
862                 for index in range(len(self)):
863                         res[str(index)] = self[index]
864                 return res
865
866 # same as ConfigSubList, just as a dictionary.
867 # care must be taken that the 'key' has a proper
868 # str() method, because it will be used in the config
869 # file.
870 class ConfigSubDict(dict, object):
871         def __init__(self):
872                 object.__init__(self)
873                 dict.__init__(self)
874                 self.stored_values = {}
875
876         def save(self):
877                 for x in self.values():
878                         x.save()
879         
880         def load(self):
881                 for x in self.values():
882                         x.load()
883
884         def getSavedValue(self):
885                 res = {}
886                 for (key, val) in self.items():
887                         if val.saved_value is not None:
888                                 res[str(key)] = val.saved_value
889                 return res
890
891         def setSavedValue(self, values):
892                 self.stored_values = dict(values)
893                 for (key, val) in self.items():
894                         if str(key) in self.stored_values:
895                                 val = self.stored_values[str(key)]
896
897         saved_value = property(getSavedValue, setSavedValue)
898
899         def __setitem__(self, key, item):
900                 dict.__setitem__(self, key, item)
901                 if str(key) in self.stored_values:
902                         item.saved_value = self.stored_values[str(key)]
903                         item.load()
904
905         def dict(self):
906                 return self
907
908 # Like the classes above, just with a more "native"
909 # syntax.
910 #
911 # some evil stuff must be done to allow instant
912 # loading of added elements. this is why this class
913 # is so complex.
914 #
915 # we need the 'content' because we overwrite 
916 # __setattr__.
917 # If you don't understand this, try adding
918 # __setattr__ to a usual exisiting class and you will.
919 class ConfigSubsection(object):
920         def __init__(self):
921                 object.__init__(self)
922                 self.__dict__["content"] = ConfigSubsectionContent()
923                 self.content.items = { }
924                 self.content.stored_values = { }
925         
926         def __setattr__(self, name, value):
927                 if name == "saved_value":
928                         return self.setSavedValue(value)
929                 assert isinstance(value, ConfigSubsection) or isinstance(value, ConfigElement) or isinstance(value, ConfigSubList) or isinstance(value, ConfigSubDict), "ConfigSubsections can only store ConfigSubsections, ConfigSubLists, ConfigSubDicts or ConfigElements"
930                 self.content.items[name] = value
931                 if name in self.content.stored_values:
932                         #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
933                         value.saved_value = self.content.stored_values[name]
934                         value.load()
935
936         def __getattr__(self, name):
937                 return self.content.items[name]
938
939         def getSavedValue(self):
940                 res = self.content.stored_values
941                 for (key, val) in self.content.items.items():
942                         if val.saved_value is not None:
943                                 res[key] = val.saved_value
944                         elif key in res:
945                                 del res[key]
946                                 
947                 return res
948
949         def setSavedValue(self, values):
950                 values = dict(values)
951                 
952                 self.content.stored_values = values
953                 
954                 for (key, val) in self.content.items.items():
955                         if key in values:
956                                 val.setSavedValue(values[key])
957
958         saved_value = property(getSavedValue, setSavedValue)
959
960         def save(self):
961                 for x in self.content.items.values():
962                         x.save()
963
964         def load(self):
965                 for x in self.content.items.values():
966                         x.load()
967
968         def dict(self):
969                 return self.content.items
970
971 # the root config object, which also can "pickle" (=serialize)
972 # down the whole config tree.
973 #
974 # we try to keep non-existing config entries, to apply them whenever
975 # a new config entry is added to a subsection
976 # also, non-existing config entries will be saved, so they won't be
977 # lost when a config entry disappears.
978 class Config(ConfigSubsection):
979         def __init__(self):
980                 ConfigSubsection.__init__(self)
981
982         def pickle_this(self, prefix, topickle, result):
983                 for (key, val) in topickle.items():
984                         name = prefix + "." + key
985                         
986                         if isinstance(val, dict):
987                                 self.pickle_this(name, val, result)
988                         elif isinstance(val, tuple):
989                                 result.append(name + "=" + val[0]) # + " ; " + val[1])
990                         else:
991                                 result.append(name + "=" + val)
992
993         def pickle(self):
994                 result = [ ]
995                 self.pickle_this("config", self.saved_value, result)
996                 return '\n'.join(result) + "\n"
997
998         def unpickle(self, lines):
999                 tree = { }
1000                 for l in lines:
1001                         if not len(l) or l[0] == '#':
1002                                 continue
1003                         
1004                         n = l.find('=')
1005                         val = l[n+1:].strip()
1006
1007                         names = l[:n].split('.')
1008 #                       if val.find(' ') != -1:
1009 #                               val = val[:val.find(' ')]
1010
1011                         base = tree
1012                         
1013                         for n in names[:-1]:
1014                                 base = base.setdefault(n, {})
1015                         
1016                         base[names[-1]] = val
1017
1018                 # we inherit from ConfigSubsection, so ...
1019                 #object.__setattr__(self, "saved_value", tree["config"])
1020                 if "config" in tree:
1021                         self.setSavedValue(tree["config"])
1022
1023         def saveToFile(self, filename):
1024                 f = open(filename, "w")
1025                 f.write(self.pickle())
1026                 f.close()
1027
1028         def loadFromFile(self, filename):
1029                 f = open(filename, "r")
1030                 self.unpickle(f.readlines())
1031                 f.close()
1032
1033 config = Config()
1034 config.misc = ConfigSubsection()
1035
1036 class ConfigFile:
1037         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1038
1039         def load(self):
1040                 try:
1041                         config.loadFromFile(self.CONFIG_FILE)
1042                 except IOError, e:
1043                         print "unable to load config (%s), assuming defaults..." % str(e)
1044         
1045         def save(self):
1046 #               config.save()
1047                 config.saveToFile(self.CONFIG_FILE)
1048         
1049         def __resolveValue(self, pickles, cmap):
1050                 if cmap.has_key(pickles[0]):
1051                         if len(pickles) > 1:
1052                                 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1053                         else:
1054                                 return str(cmap[pickles[0]].value)
1055                 return None
1056         
1057         def getResolvedKey(self, key):
1058                 names = key.split('.')
1059                 if len(names) > 1:
1060                         if names[0] == "config":
1061                                 ret=self.__resolveValue(names[1:], config.content.items)
1062                                 if ret and len(ret):
1063                                         return ret
1064                 print "getResolvedKey", key, "failed !! (Typo??)"
1065                 return ""
1066
1067 def NoSave(element):
1068         element.disableSave()
1069         return element
1070
1071 configfile = ConfigFile()
1072
1073 configfile.load()
1074
1075 def getConfigListEntry(*args):
1076         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1077         return args
1078
1079 #def _(x):
1080 #       return x
1081 #
1082 #config.bla = ConfigSubsection()
1083 #config.bla.test = ConfigYesNo()
1084 #config.nim = ConfigSubList()
1085 #config.nim.append(ConfigSubsection())
1086 #config.nim[0].bla = ConfigYesNo()
1087 #config.nim.append(ConfigSubsection())
1088 #config.nim[1].bla = ConfigYesNo()
1089 #config.nim[1].blub = ConfigYesNo()
1090 #config.arg = ConfigSubDict()
1091 #config.arg["Hello"] = ConfigYesNo()
1092 #
1093 #config.arg["Hello"].handleKey(KEY_RIGHT)
1094 #config.arg["Hello"].handleKey(KEY_RIGHT)
1095 #
1096 ##config.saved_value
1097 #
1098 ##configfile.save()
1099 #config.save()
1100 #print config.pickle()