add plugin to connect via builtin modem to internet (just dm500hd yet)
[vuplus_dvbapp] / lib / python / Components / config.py
1 from enigma import getPrevAsciiCode
2 from Tools.NumericalTextInput import NumericalTextInput
3 from Tools.Directories import resolveFilename, SCOPE_CONFIG
4 from Components.Harddisk import harddiskmanager
5 from copy import copy as copy_copy
6 from os import path as os_path
7 from time import localtime, strftime
8
9 # ConfigElement, the base class of all ConfigElements.
10
11 # it stores:
12 #   value    the current value, usefully encoded.
13 #            usually a property which retrieves _value,
14 #            and maybe does some reformatting
15 #   _value   the value as it's going to be saved in the configfile,
16 #            though still in non-string form.
17 #            this is the object which is actually worked on.
18 #   default  the initial value. If _value is equal to default,
19 #            it will not be stored in the config file
20 #   saved_value is a text representation of _value, stored in the config file
21 #
22 # and has (at least) the following methods:
23 #   save()   stores _value into saved_value,
24 #            (or stores 'None' if it should not be stored)
25 #   load()   loads _value from saved_value, or loads
26 #            the default if saved_value is 'None' (default)
27 #            or invalid.
28 #
29 class ConfigElement(object):
30         def __init__(self):
31                 self.saved_value = None
32                 self.last_value = None
33                 self.save_disabled = False
34                 self.__notifiers = None
35                 self.__notifiers_final = None
36                 self.enabled = True
37                 self.callNotifiersOnSaveAndCancel = False
38
39         def getNotifiers(self):
40                 if self.__notifiers is None:
41                         self.__notifiers = [ ]
42                 return self.__notifiers
43
44         def setNotifiers(self, val):
45                 self.__notifiers = val
46
47         notifiers = property(getNotifiers, setNotifiers)
48
49         def getNotifiersFinal(self):
50                 if self.__notifiers_final is None:
51                         self.__notifiers_final = [ ]
52                 return self.__notifiers_final
53
54         def setNotifiersFinal(self, val):
55                 self.__notifiers_final = val
56
57         notifiers_final = property(getNotifiersFinal, setNotifiersFinal)
58
59         # you need to override this to do input validation
60         def setValue(self, value):
61                 self._value = value
62                 self.changed()
63
64         def getValue(self):
65                 return self._value
66
67         value = property(getValue, setValue)
68
69         # you need to override this if self.value is not a string
70         def fromstring(self, value):
71                 return value
72
73         # you can overide this for fancy default handling
74         def load(self):
75                 sv = self.saved_value
76                 if sv is None:
77                         self.value = self.default
78                 else:
79                         self.value = self.fromstring(sv)
80
81         def tostring(self, value):
82                 return str(value)
83
84         # you need to override this if str(self.value) doesn't work
85         def save(self):
86                 if self.save_disabled or self.value == self.default:
87                         self.saved_value = None
88                 else:
89                         self.saved_value = self.tostring(self.value)
90                 if self.callNotifiersOnSaveAndCancel:
91                         self.changed()
92
93         def cancel(self):
94                 self.load()
95                 if self.callNotifiersOnSaveAndCancel:
96                         self.changed()
97
98         def isChanged(self):
99                 sv = self.saved_value
100                 if sv is None and self.value == self.default:
101                         return False
102                 return self.tostring(self.value) != sv
103
104         def changed(self):
105                 if self.__notifiers:
106                         for x in self.notifiers:
107                                 x(self)
108
109         def changedFinal(self):
110                 if self.__notifiers_final:
111                         for x in self.notifiers_final:
112                                 x(self)
113
114         def addNotifier(self, notifier, initial_call = True, immediate_feedback = True):
115                 assert callable(notifier), "notifiers must be callable"
116                 if immediate_feedback:
117                         self.notifiers.append(notifier)
118                 else:
119                         self.notifiers_final.append(notifier)
120                 # CHECKME:
121                 # do we want to call the notifier
122                 #  - at all when adding it? (yes, though optional)
123                 #  - when the default is active? (yes)
124                 #  - when no value *yet* has been set,
125                 #    because no config has ever been read (currently yes)
126                 #    (though that's not so easy to detect.
127                 #     the entry could just be new.)
128                 if initial_call:
129                         notifier(self)
130
131         def disableSave(self):
132                 self.save_disabled = True
133
134         def __call__(self, selected):
135                 return self.getMulti(selected)
136
137         def onSelect(self, session):
138                 pass
139
140         def onDeselect(self, session):
141                 if not self.last_value == self.value:
142                         self.changedFinal()
143                         self.last_value = self.value
144
145 KEY_LEFT = 0
146 KEY_RIGHT = 1
147 KEY_OK = 2
148 KEY_DELETE = 3
149 KEY_BACKSPACE = 4
150 KEY_HOME = 5
151 KEY_END = 6
152 KEY_TOGGLEOW = 7
153 KEY_ASCII = 8
154 KEY_TIMEOUT = 9
155 KEY_NUMBERS = range(12, 12+10)
156 KEY_0 = 12
157 KEY_9 = 12+9
158
159 def getKeyNumber(key):
160         assert key in KEY_NUMBERS
161         return key - KEY_0
162
163 class choicesList(object): # XXX: we might want a better name for this
164         LIST_TYPE_LIST = 1
165         LIST_TYPE_DICT = 2
166
167         def __init__(self, choices, type = None):
168                 self.choices = choices
169                 if type is None:
170                         if isinstance(choices, list):
171                                 self.type = choicesList.LIST_TYPE_LIST
172                         elif isinstance(choices, dict):
173                                 self.type = choicesList.LIST_TYPE_DICT
174                         else:
175                                 assert False, "choices must be dict or list!"
176                 else:
177                         self.type = type
178
179         def __list__(self):
180                 if self.type == choicesList.LIST_TYPE_LIST:
181                         ret = [not isinstance(x, tuple) and x or x[0] for x in self.choices]
182                 else:
183                         ret = self.choices.keys()
184                 return ret or [""]
185
186         def __iter__(self):
187                 if self.type == choicesList.LIST_TYPE_LIST:
188                         ret = [not isinstance(x, tuple) and x or x[0] for x in self.choices]
189                 else:
190                         ret = self.choices
191                 return iter(ret or [""])
192
193         def __len__(self):
194                 return len(self.choices) or 1
195
196         def __getitem__(self, index):
197                 if self.type == choicesList.LIST_TYPE_LIST:
198                         ret = self.choices[index]
199                         if isinstance(ret, tuple):
200                                 ret = ret[0]
201                         return ret
202                 return self.choices.keys()[index]
203
204         def index(self, value):
205                 return self.__list__().index(value)
206
207         def __setitem__(self, index, value):
208                 if self.type == choicesList.LIST_TYPE_LIST:
209                         orig = self.choices[index]
210                         if isinstance(orig, tuple):
211                                 self.choices[index] = (value, orig[1])
212                         else:
213                                 self.choices[index] = value
214                 else:
215                         key = self.choices.keys()[index]
216                         orig = self.choices[key]
217                         del self.choices[key]
218                         self.choices[value] = orig
219
220         def default(self):
221                 choices = self.choices
222                 if not choices:
223                         return ""
224                 if self.type is choicesList.LIST_TYPE_LIST:
225                         default = choices[0]
226                         if isinstance(default, tuple):
227                                 default = default[0]
228                 else:
229                         default = choices.keys()[0]
230                 return default
231
232 class descriptionList(choicesList): # XXX: we might want a better name for this
233         def __list__(self):
234                 if self.type == choicesList.LIST_TYPE_LIST:
235                         ret = [not isinstance(x, tuple) and x or x[1] for x in self.choices]
236                 else:
237                         ret = self.choices.values()
238                 return ret or [""]
239
240         def __iter__(self):
241                 return iter(self.__list__())
242
243         def __getitem__(self, index):
244                 if self.type == choicesList.LIST_TYPE_LIST:
245                         for x in self.choices:
246                                 if isinstance(x, tuple):
247                                         if x[0] == index:
248                                                 return str(x[1])
249                                 elif x == index:
250                                         return str(x)
251                         return str(index) # Fallback!
252                 else:
253                         return str(self.choices.get(index, ""))
254
255         def __setitem__(self, index, value):
256                 if self.type == choicesList.LIST_TYPE_LIST:
257                         i = self.index(index)
258                         orig = self.choices[i]
259                         if isinstance(orig, tuple):
260                                 self.choices[i] = (orig[0], value)
261                         else:
262                                 self.choices[i] = value
263                 else:
264                         self.choices[index] = value
265
266 #
267 # ConfigSelection is a "one of.."-type.
268 # it has the "choices", usually a list, which contains
269 # (id, desc)-tuples (or just only the ids, in case the id
270 # will be used as description)
271 #
272 # all ids MUST be plain strings.
273 #
274 class ConfigSelection(ConfigElement):
275         def __init__(self, choices, default = None):
276                 ConfigElement.__init__(self)
277                 self.choices = choicesList(choices)
278
279                 if default is None:
280                         default = self.choices.default()
281
282                 self._descr = None
283                 self.default = self._value = self.last_value = default
284
285         def setChoices(self, choices, default = None):
286                 self.choices = choicesList(choices)
287
288                 if default is None:
289                         default = self.choices.default()
290                 self.default = default
291
292                 if self.value not in self.choices:
293                         self.value = default
294
295         def setValue(self, value):
296                 if value in self.choices:
297                         self._value = value
298                 else:
299                         self._value = self.default
300                 self._descr = None
301                 self.changed()
302
303         def tostring(self, val):
304                 return val
305
306         def getValue(self):
307                 return self._value
308
309         def setCurrentText(self, text):
310                 i = self.choices.index(self.value)
311                 self.choices[i] = text
312                 self._descr = self.description[text] = text
313                 self._value = text
314
315         value = property(getValue, setValue)
316
317         def getIndex(self):
318                 return self.choices.index(self.value)
319
320         index = property(getIndex)
321
322         # GUI
323         def handleKey(self, key):
324                 nchoices = len(self.choices)
325                 i = self.choices.index(self.value)
326                 if key == KEY_LEFT:
327                         self.value = self.choices[(i + nchoices - 1) % nchoices]
328                 elif key == KEY_RIGHT:
329                         self.value = self.choices[(i + 1) % nchoices]
330                 elif key == KEY_HOME:
331                         self.value = self.choices[0]
332                 elif key == KEY_END:
333                         self.value = self.choices[nchoices - 1]
334
335         def selectNext(self):
336                 nchoices = len(self.choices)
337                 i = self.choices.index(self.value)
338                 self.value = self.choices[(i + 1) % nchoices]
339
340         def getText(self):
341                 if self._descr is not None:
342                         return self._descr
343                 descr = self._descr = self.description[self.value]
344                 if descr:
345                         return _(descr)
346                 return descr
347
348         def getMulti(self, selected):
349                 if self._descr is not None:
350                         descr = self._descr
351                 else:
352                         descr = self._descr = self.description[self.value]
353                 if descr:
354                         return ("text", _(descr))
355                 return ("text", descr)
356
357         # HTML
358         def getHTML(self, id):
359                 res = ""
360                 for v in self.choices:
361                         descr = self.description[v]
362                         if self.value == v:
363                                 checked = 'checked="checked" '
364                         else:
365                                 checked = ''
366                         res += '<input type="radio" name="' + id + '" ' + checked + 'value="' + v + '">' + descr + "</input></br>\n"
367                 return res;
368
369         def unsafeAssign(self, value):
370                 # setValue does check if value is in choices. This is safe enough.
371                 self.value = value
372
373         description = property(lambda self: descriptionList(self.choices.choices, self.choices.type))
374
375 # a binary decision.
376 #
377 # several customized versions exist for different
378 # descriptions.
379 #
380 boolean_descriptions = {False: "false", True: "true"}
381 class ConfigBoolean(ConfigElement):
382         def __init__(self, default = False, descriptions = boolean_descriptions):
383                 ConfigElement.__init__(self)
384                 self.descriptions = descriptions
385                 self.value = self.last_value = self.default = default
386
387         def handleKey(self, key):
388                 if key in (KEY_LEFT, KEY_RIGHT):
389                         self.value = not self.value
390                 elif key == KEY_HOME:
391                         self.value = False
392                 elif key == KEY_END:
393                         self.value = True
394
395         def getText(self):
396                 descr = self.descriptions[self.value]
397                 if descr:
398                         return _(descr)
399                 return descr
400
401         def getMulti(self, selected):
402                 descr = self.descriptions[self.value]
403                 if descr:
404                         return ("text", _(descr))
405                 return ("text", descr)
406
407         def tostring(self, value):
408                 if not value:
409                         return "false"
410                 else:
411                         return "true"
412
413         def fromstring(self, val):
414                 if val == "true":
415                         return True
416                 else:
417                         return False
418
419         def getHTML(self, id):
420                 if self.value:
421                         checked = ' checked="checked"'
422                 else:
423                         checked = ''
424                 return '<input type="checkbox" name="' + id + '" value="1" ' + checked + " />"
425
426         # this is FLAWED. and must be fixed.
427         def unsafeAssign(self, value):
428                 if value == "1":
429                         self.value = True
430                 else:
431                         self.value = False
432
433         def onDeselect(self, session):
434                 if not self.last_value == self.value:
435                         self.changedFinal()
436                         self.last_value = self.value
437
438 yes_no_descriptions = {False: _("no"), True: _("yes")}
439 class ConfigYesNo(ConfigBoolean):
440         def __init__(self, default = False):
441                 ConfigBoolean.__init__(self, default = default, descriptions = yes_no_descriptions)
442
443 on_off_descriptions = {False: _("off"), True: _("on")}
444 class ConfigOnOff(ConfigBoolean):
445         def __init__(self, default = False):
446                 ConfigBoolean.__init__(self, default = default, descriptions = on_off_descriptions)
447
448 enable_disable_descriptions = {False: _("disable"), True: _("enable")}
449 class ConfigEnableDisable(ConfigBoolean):
450         def __init__(self, default = False):
451                 ConfigBoolean.__init__(self, default = default, descriptions = enable_disable_descriptions)
452
453 class ConfigDateTime(ConfigElement):
454         def __init__(self, default, formatstring, increment = 86400):
455                 ConfigElement.__init__(self)
456                 self.increment = increment
457                 self.formatstring = formatstring
458                 self.value = self.last_value = self.default = int(default)
459
460         def handleKey(self, key):
461                 if key == KEY_LEFT:
462                         self.value = self.value - self.increment
463                 elif key == KEY_RIGHT:
464                         self.value = self.value + self.increment
465                 elif key == KEY_HOME or key == KEY_END:
466                         self.value = self.default
467
468         def getText(self):
469                 return strftime(self.formatstring, localtime(self.value))
470
471         def getMulti(self, selected):
472                 return ("text", strftime(self.formatstring, localtime(self.value)))
473
474         def fromstring(self, val):
475                 return int(val)
476
477 # *THE* mighty config element class
478 #
479 # allows you to store/edit a sequence of values.
480 # can be used for IP-addresses, dates, plain integers, ...
481 # several helper exist to ease this up a bit.
482 #
483 class ConfigSequence(ConfigElement):
484         def __init__(self, seperator, limits, default, censor_char = ""):
485                 ConfigElement.__init__(self)
486                 assert isinstance(limits, list) and len(limits[0]) == 2, "limits must be [(min, max),...]-tuple-list"
487                 assert censor_char == "" or len(censor_char) == 1, "censor char must be a single char (or \"\")"
488                 #assert isinstance(default, list), "default must be a list"
489                 #assert isinstance(default[0], int), "list must contain numbers"
490                 #assert len(default) == len(limits), "length must match"
491
492                 self.marked_pos = 0
493                 self.seperator = seperator
494                 self.limits = limits
495                 self.censor_char = censor_char
496
497                 self.last_value = self.default = default
498                 self.value = copy_copy(default)
499                 self.endNotifier = None
500
501         def validate(self):
502                 max_pos = 0
503                 num = 0
504                 for i in self._value:
505                         max_pos += len(str(self.limits[num][1]))
506
507                         if self._value[num] < self.limits[num][0]:
508                                 self._value[num] = self.limits[num][0]
509
510                         if self._value[num] > self.limits[num][1]:
511                                 self._value[num] = self.limits[num][1]
512
513                         num += 1
514
515                 if self.marked_pos >= max_pos:
516                         if self.endNotifier:
517                                 for x in self.endNotifier:
518                                         x(self)
519                         self.marked_pos = max_pos - 1
520
521                 if self.marked_pos < 0:
522                         self.marked_pos = 0
523
524         def validatePos(self):
525                 if self.marked_pos < 0:
526                         self.marked_pos = 0
527
528                 total_len = sum([len(str(x[1])) for x in self.limits])
529
530                 if self.marked_pos >= total_len:
531                         self.marked_pos = total_len - 1
532
533         def addEndNotifier(self, notifier):
534                 if self.endNotifier is None:
535                         self.endNotifier = []
536                 self.endNotifier.append(notifier)
537
538         def handleKey(self, key):
539                 if key == KEY_LEFT:
540                         self.marked_pos -= 1
541                         self.validatePos()
542
543                 elif key == KEY_RIGHT:
544                         self.marked_pos += 1
545                         self.validatePos()
546
547                 elif key == KEY_HOME:
548                         self.marked_pos = 0
549                         self.validatePos()
550
551                 elif key == KEY_END:
552                         max_pos = 0
553                         num = 0
554                         for i in self._value:
555                                 max_pos += len(str(self.limits[num][1]))
556                                 num += 1
557                         self.marked_pos = max_pos - 1
558                         self.validatePos()
559
560                 elif key in KEY_NUMBERS or key == KEY_ASCII:
561                         if key == KEY_ASCII:
562                                 code = getPrevAsciiCode()
563                                 if code < 48 or code > 57:
564                                         return
565                                 number = code - 48
566                         else:
567                                 number = getKeyNumber(key)
568
569                         block_len = [len(str(x[1])) for x in self.limits]
570                         total_len = sum(block_len)
571
572                         pos = 0
573                         blocknumber = 0
574                         block_len_total = [0, ]
575                         for x in block_len:
576                                 pos += block_len[blocknumber]
577                                 block_len_total.append(pos)
578                                 if pos - 1 >= self.marked_pos:
579                                         pass
580                                 else:
581                                         blocknumber += 1
582
583                         # length of numberblock
584                         number_len = len(str(self.limits[blocknumber][1]))
585
586                         # position in the block
587                         posinblock = self.marked_pos - block_len_total[blocknumber]
588
589                         oldvalue = self._value[blocknumber]
590                         olddec = oldvalue % 10 ** (number_len - posinblock) - (oldvalue % 10 ** (number_len - posinblock - 1))
591                         newvalue = oldvalue - olddec + (10 ** (number_len - posinblock - 1) * number)
592
593                         self._value[blocknumber] = newvalue
594                         self.marked_pos += 1
595
596                         self.validate()
597                         self.changed()
598
599         def genText(self):
600                 value = ""
601                 mPos = self.marked_pos
602                 num = 0;
603                 for i in self._value:
604                         if value:       #fixme no heading separator possible
605                                 value += self.seperator
606                                 if mPos >= len(value) - 1:
607                                         mPos += 1
608                         if self.censor_char == "":
609                                 value += ("%0" + str(len(str(self.limits[num][1]))) + "d") % i
610                         else:
611                                 value += (self.censor_char * len(str(self.limits[num][1])))
612                         num += 1
613                 return (value, mPos)
614
615         def getText(self):
616                 (value, mPos) = self.genText()
617                 return value
618
619         def getMulti(self, selected):
620                 (value, mPos) = self.genText()
621                         # only mark cursor when we are selected
622                         # (this code is heavily ink optimized!)
623                 if self.enabled:
624                         return ("mtext"[1-selected:], value, [mPos])
625                 else:
626                         return ("text", value)
627
628         def tostring(self, val):
629                 return self.seperator.join([self.saveSingle(x) for x in val])
630
631         def saveSingle(self, v):
632                 return str(v)
633
634         def fromstring(self, value):
635                 return [int(x) for x in value.split(self.seperator)]
636
637         def onDeselect(self, session):
638                 if self.last_value != self._value:
639                         self.changedFinal()
640                         self.last_value = copy_copy(self._value)
641
642 ip_limits = [(0,255),(0,255),(0,255),(0,255)]
643 class ConfigIP(ConfigSequence):
644         def __init__(self, default, auto_jump = False):
645                 ConfigSequence.__init__(self, seperator = ".", limits = ip_limits, default = default)
646                 self.block_len = [len(str(x[1])) for x in self.limits]
647                 self.marked_block = 0
648                 self.overwrite = True
649                 self.auto_jump = auto_jump
650
651         def handleKey(self, key):
652                 if key == KEY_LEFT:
653                         if self.marked_block > 0:
654                                 self.marked_block -= 1
655                         self.overwrite = True
656
657                 elif key == KEY_RIGHT:
658                         if self.marked_block < len(self.limits)-1:
659                                 self.marked_block += 1
660                         self.overwrite = True
661
662                 elif key == KEY_HOME:
663                         self.marked_block = 0
664                         self.overwrite = True
665
666                 elif key == KEY_END:
667                         self.marked_block = len(self.limits)-1
668                         self.overwrite = True
669
670                 elif key in KEY_NUMBERS or key == KEY_ASCII:
671                         if key == KEY_ASCII:
672                                 code = getPrevAsciiCode()
673                                 if code < 48 or code > 57:
674                                         return
675                                 number = code - 48
676                         else:
677                                 number = getKeyNumber(key)
678                         oldvalue = self._value[self.marked_block]
679
680                         if self.overwrite:
681                                 self._value[self.marked_block] = number
682                                 self.overwrite = False
683                         else:
684                                 oldvalue *= 10
685                                 newvalue = oldvalue + number
686                                 if self.auto_jump and newvalue > self.limits[self.marked_block][1] and self.marked_block < len(self.limits)-1:
687                                         self.handleKey(KEY_RIGHT)
688                                         self.handleKey(key)
689                                         return
690                                 else:
691                                         self._value[self.marked_block] = newvalue
692
693                         if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
694                                 self.handleKey(KEY_RIGHT)
695
696                         self.validate()
697                         self.changed()
698
699         def genText(self):
700                 value = ""
701                 block_strlen = []
702                 for i in self._value:
703                         block_strlen.append(len(str(i)))
704                         if value:
705                                 value += self.seperator
706                         value += str(i)
707                 leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
708                 rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
709                 mBlock = range(leftPos, rightPos)
710                 return (value, mBlock)
711
712         def getMulti(self, selected):
713                 (value, mBlock) = self.genText()
714                 if self.enabled:
715                         return ("mtext"[1-selected:], value, mBlock)
716                 else:
717                         return ("text", value)
718
719         def getHTML(self, id):
720                 # we definitely don't want leading zeros
721                 return '.'.join(["%d" % d for d in self.value])
722
723 mac_limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)]
724 class ConfigMAC(ConfigSequence):
725         def __init__(self, default):
726                 ConfigSequence.__init__(self, seperator = ":", limits = mac_limits, default = default)
727
728 class ConfigPosition(ConfigSequence):
729         def __init__(self, default, args):
730                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
731
732 clock_limits = [(0,23),(0,59)]
733 class ConfigClock(ConfigSequence):
734         def __init__(self, default):
735                 t = localtime(default)
736                 ConfigSequence.__init__(self, seperator = ":", limits = clock_limits, default = [t.tm_hour, t.tm_min])
737
738         def increment(self):
739                 # Check if Minutes maxed out
740                 if self._value[1] == 59:
741                         # Increment Hour, reset Minutes
742                         if self._value[0] < 23:
743                                 self._value[0] += 1
744                         else:
745                                 self._value[0] = 0
746                         self._value[1] = 0
747                 else:
748                         # Increment Minutes
749                         self._value[1] += 1
750                 # Trigger change
751                 self.changed()
752
753         def decrement(self):
754                 # Check if Minutes is minimum
755                 if self._value[1] == 0:
756                         # Decrement Hour, set Minutes to 59
757                         if self._value[0] > 0:
758                                 self._value[0] -= 1
759                         else:
760                                 self._value[0] = 23
761                         self._value[1] = 59
762                 else:
763                         # Decrement Minutes
764                         self._value[1] -= 1
765                 # Trigger change
766                 self.changed()
767
768 integer_limits = (0, 9999999999)
769 class ConfigInteger(ConfigSequence):
770         def __init__(self, default, limits = integer_limits):
771                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
772
773         # you need to override this to do input validation
774         def setValue(self, value):
775                 self._value = [value]
776                 self.changed()
777
778         def getValue(self):
779                 return self._value[0]
780
781         value = property(getValue, setValue)
782
783         def fromstring(self, value):
784                 return int(value)
785
786         def tostring(self, value):
787                 return str(value)
788
789 class ConfigPIN(ConfigInteger):
790         def __init__(self, default, len = 4, censor = ""):
791                 assert isinstance(default, int), "ConfigPIN default must be an integer"
792                 if default == -1:
793                         default = "aaaa"
794                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
795                 self.len = len
796
797         def getLength(self):
798                 return self.len
799
800 class ConfigFloat(ConfigSequence):
801         def __init__(self, default, limits):
802                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
803
804         def getFloat(self):
805                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
806
807         float = property(getFloat)
808
809 # an editable text...
810 class ConfigText(ConfigElement, NumericalTextInput):
811         def __init__(self, default = "", fixed_size = True, visible_width = False):
812                 ConfigElement.__init__(self)
813                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
814
815                 self.marked_pos = 0
816                 self.allmarked = (default != "")
817                 self.fixed_size = fixed_size
818                 self.visible_width = visible_width
819                 self.offset = 0
820                 self.overwrite = fixed_size
821                 self.help_window = None
822                 self.value = self.last_value = self.default = default
823
824         def validateMarker(self):
825                 textlen = len(self.text)
826                 if self.fixed_size:
827                         if self.marked_pos > textlen-1:
828                                 self.marked_pos = textlen-1
829                 else:
830                         if self.marked_pos > textlen:
831                                 self.marked_pos = textlen
832                 if self.marked_pos < 0:
833                         self.marked_pos = 0
834                 if self.visible_width:
835                         if self.marked_pos < self.offset:
836                                 self.offset = self.marked_pos
837                         if self.marked_pos >= self.offset + self.visible_width:
838                                 if self.marked_pos == textlen:
839                                         self.offset = self.marked_pos - self.visible_width
840                                 else:
841                                         self.offset = self.marked_pos - self.visible_width + 1
842                         if self.offset > 0 and self.offset + self.visible_width > textlen:
843                                 self.offset = max(0, len - self.visible_width)
844
845         def insertChar(self, ch, pos, owr):
846                 if owr or self.overwrite:
847                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
848                 elif self.fixed_size:
849                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
850                 else:
851                         self.text = self.text[0:pos] + ch + self.text[pos:]
852
853         def deleteChar(self, pos):
854                 if not self.fixed_size:
855                         self.text = self.text[0:pos] + self.text[pos + 1:]
856                 elif self.overwrite:
857                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
858                 else:
859                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
860
861         def deleteAllChars(self):
862                 if self.fixed_size:
863                         self.text = " " * len(self.text)
864                 else:
865                         self.text = ""
866                 self.marked_pos = 0
867
868         def handleKey(self, key):
869                 # this will no change anything on the value itself
870                 # so we can handle it here in gui element
871                 if key == KEY_DELETE:
872                         self.timeout()
873                         if self.allmarked:
874                                 self.deleteAllChars()
875                                 self.allmarked = False
876                         else:
877                                 self.deleteChar(self.marked_pos)
878                                 if self.fixed_size and self.overwrite:
879                                         self.marked_pos += 1
880                 elif key == KEY_BACKSPACE:
881                         self.timeout()
882                         if self.allmarked:
883                                 self.deleteAllChars()
884                                 self.allmarked = False
885                         elif self.marked_pos > 0:
886                                 self.deleteChar(self.marked_pos-1)
887                                 if not self.fixed_size and self.offset > 0:
888                                         self.offset -= 1
889                                 self.marked_pos -= 1
890                 elif key == KEY_LEFT:
891                         self.timeout()
892                         if self.allmarked:
893                                 self.marked_pos = len(self.text)
894                                 self.allmarked = False
895                         else:
896                                 self.marked_pos -= 1
897                 elif key == KEY_RIGHT:
898                         self.timeout()
899                         if self.allmarked:
900                                 self.marked_pos = 0
901                                 self.allmarked = False
902                         else:
903                                 self.marked_pos += 1
904                 elif key == KEY_HOME:
905                         self.timeout()
906                         self.allmarked = False
907                         self.marked_pos = 0
908                 elif key == KEY_END:
909                         self.timeout()
910                         self.allmarked = False
911                         self.marked_pos = len(self.text)
912                 elif key == KEY_TOGGLEOW:
913                         self.timeout()
914                         self.overwrite = not self.overwrite
915                 elif key == KEY_ASCII:
916                         self.timeout()
917                         newChar = unichr(getPrevAsciiCode())
918                         if self.allmarked:
919                                 self.deleteAllChars()
920                                 self.allmarked = False
921                         self.insertChar(newChar, self.marked_pos, False)
922                         self.marked_pos += 1
923                 elif key in KEY_NUMBERS:
924                         owr = self.lastKey == getKeyNumber(key)
925                         newChar = self.getKey(getKeyNumber(key))
926                         if self.allmarked:
927                                 self.deleteAllChars()
928                                 self.allmarked = False
929                         self.insertChar(newChar, self.marked_pos, owr)
930                 elif key == KEY_TIMEOUT:
931                         self.timeout()
932                         if self.help_window:
933                                 self.help_window.update(self)
934                         return
935
936                 if self.help_window:
937                         self.help_window.update(self)
938                 self.validateMarker()
939                 self.changed()
940
941         def nextFunc(self):
942                 self.marked_pos += 1
943                 self.validateMarker()
944                 self.changed()
945
946         def getValue(self):
947                 return self.text.encode("utf-8")
948
949         def setValue(self, val):
950                 try:
951                         self.text = val.decode("utf-8")
952                 except UnicodeDecodeError:
953                         self.text = val.decode("utf-8", "ignore")
954                         print "Broken UTF8!"
955
956         value = property(getValue, setValue)
957         _value = property(getValue, setValue)
958
959         def getText(self):
960                 return self.text.encode("utf-8")
961
962         def getMulti(self, selected):
963                 if self.visible_width:
964                         if self.allmarked:
965                                 mark = range(0, min(self.visible_width, len(self.text)))
966                         else:
967                                 mark = [self.marked_pos-self.offset]
968                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
969                 else:
970                         if self.allmarked:
971                                 mark = range(0, len(self.text))
972                         else:
973                                 mark = [self.marked_pos]
974                         return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
975
976         def onSelect(self, session):
977                 self.allmarked = (self.value != "")
978                 if session is not None:
979                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
980                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
981                         self.help_window.show()
982
983         def onDeselect(self, session):
984                 self.marked_pos = 0
985                 self.offset = 0
986                 if self.help_window:
987                         session.deleteDialog(self.help_window)
988                         self.help_window = None
989                 if not self.last_value == self.value:
990                         self.changedFinal()
991                         self.last_value = self.value
992
993         def getHTML(self, id):
994                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
995
996         def unsafeAssign(self, value):
997                 self.value = str(value)
998
999 class ConfigPassword(ConfigText):
1000         def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
1001                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1002                 self.censor_char = censor
1003                 self.hidden = True
1004
1005         def getMulti(self, selected):
1006                 mtext, text, mark = ConfigText.getMulti(self, selected)
1007                 if self.hidden:
1008                         text = len(text) * self.censor_char
1009                 return (mtext, text, mark)
1010
1011         def onSelect(self, session):
1012                 ConfigText.onSelect(self, session)
1013                 self.hidden = False
1014
1015         def onDeselect(self, session):
1016                 ConfigText.onDeselect(self, session)
1017                 self.hidden = True
1018
1019 class ConfigNumber(ConfigText):
1020         def __init__(self, default = 0):
1021                 ConfigText.__init__(self, str(default), fixed_size = False)
1022
1023         def getValue(self):
1024                 return int(self.text)
1025
1026         def setValue(self, val):
1027                 self.text = str(val)
1028
1029         value = property(getValue, setValue)
1030         _value = property(getValue, setValue)
1031
1032         def isChanged(self):
1033                 sv = self.saved_value
1034                 strv = self.tostring(self.value)
1035                 if sv is None and strv == self.default:
1036                         return False
1037                 return strv != sv
1038
1039         def conform(self):
1040                 pos = len(self.text) - self.marked_pos
1041                 self.text = self.text.lstrip("0")
1042                 if self.text == "":
1043                         self.text = "0"
1044                 if pos > len(self.text):
1045                         self.marked_pos = 0
1046                 else:
1047                         self.marked_pos = len(self.text) - pos
1048
1049         def handleKey(self, key):
1050                 if key in KEY_NUMBERS or key == KEY_ASCII:
1051                         if key == KEY_ASCII:
1052                                 ascii = getPrevAsciiCode()
1053                                 if not (48 <= ascii <= 57):
1054                                         return
1055                         else:
1056                                 ascii = getKeyNumber(key) + 48
1057                         newChar = unichr(ascii)
1058                         if self.allmarked:
1059                                 self.deleteAllChars()
1060                                 self.allmarked = False
1061                         self.insertChar(newChar, self.marked_pos, False)
1062                         self.marked_pos += 1
1063                 else:
1064                         ConfigText.handleKey(self, key)
1065                 self.conform()
1066
1067         def onSelect(self, session):
1068                 self.allmarked = (self.value != "")
1069
1070         def onDeselect(self, session):
1071                 self.marked_pos = 0
1072                 self.offset = 0
1073                 if not self.last_value == self.value:
1074                         self.changedFinal()
1075                         self.last_value = self.value
1076
1077 class ConfigSearchText(ConfigText):
1078         def __init__(self, default = "", fixed_size = False, visible_width = False):
1079                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
1080                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False, search = True)
1081
1082 class ConfigDirectory(ConfigText):
1083         def __init__(self, default="", visible_width=60):
1084                 ConfigText.__init__(self, default, fixed_size = True, visible_width = visible_width)
1085
1086         def handleKey(self, key):
1087                 pass
1088
1089         def getValue(self):
1090                 if self.text == "":
1091                         return None
1092                 else:
1093                         return ConfigText.getValue(self)
1094
1095         def setValue(self, val):
1096                 if val == None:
1097                         val = ""
1098                 ConfigText.setValue(self, val)
1099
1100         def getMulti(self, selected):
1101                 if self.text == "":
1102                         return ("mtext"[1-selected:], _("List of Storage Devices"), range(0))
1103                 else:
1104                         return ConfigText.getMulti(self, selected)
1105
1106 # a slider.
1107 class ConfigSlider(ConfigElement):
1108         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
1109                 ConfigElement.__init__(self)
1110                 self.value = self.last_value = self.default = default
1111                 self.min = limits[0]
1112                 self.max = limits[1]
1113                 self.increment = increment
1114
1115         def checkValues(self):
1116                 if self.value < self.min:
1117                         self.value = self.min
1118
1119                 if self.value > self.max:
1120                         self.value = self.max
1121
1122         def handleKey(self, key):
1123                 if key == KEY_LEFT:
1124                         self.value -= self.increment
1125                 elif key == KEY_RIGHT:
1126                         self.value += self.increment
1127                 elif key == KEY_HOME:
1128                         self.value = self.min
1129                 elif key == KEY_END:
1130                         self.value = self.max
1131                 else:
1132                         return
1133                 self.checkValues()
1134
1135         def getText(self):
1136                 return "%d / %d" % (self.value, self.max)
1137
1138         def getMulti(self, selected):
1139                 self.checkValues()
1140                 return ("slider", self.value, self.max)
1141
1142         def fromstring(self, value):
1143                 return int(value)
1144
1145 # a satlist. in fact, it's a ConfigSelection.
1146 class ConfigSatlist(ConfigSelection):
1147         def __init__(self, list, default = None):
1148                 if default is not None:
1149                         default = str(default)
1150                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
1151
1152         def getOrbitalPosition(self):
1153                 if self.value == "":
1154                         return None
1155                 return int(self.value)
1156
1157         orbital_position = property(getOrbitalPosition)
1158
1159 class ConfigSet(ConfigElement):
1160         def __init__(self, choices, default = []):
1161                 ConfigElement.__init__(self)
1162                 if isinstance(choices, list):
1163                         choices.sort()
1164                         self.choices = choicesList(choices, choicesList.LIST_TYPE_LIST)
1165                 else:
1166                         assert False, "ConfigSet choices must be a list!"
1167                 if default is None:
1168                         default = []
1169                 self.pos = -1
1170                 default.sort()
1171                 self.last_value = self.default = default
1172                 self.value = default[:]
1173
1174         def toggleChoice(self, choice):
1175                 value = self.value
1176                 if choice in value:
1177                         value.remove(choice)
1178                 else:
1179                         value.append(choice)
1180                         value.sort()
1181                 self.changed()
1182
1183         def handleKey(self, key):
1184                 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
1185                         if self.pos != -1:
1186                                 self.toggleChoice(self.choices[self.pos])
1187                 elif key == KEY_LEFT:
1188                         if self.pos < 0:
1189                                 self.pos = len(self.choices)-1
1190                         else:
1191                                 self.pos -= 1
1192                 elif key == KEY_RIGHT:
1193                         if self.pos >= len(self.choices)-1:
1194                                 self.pos = -1
1195                         else:
1196                                 self.pos += 1
1197                 elif key in (KEY_HOME, KEY_END):
1198                         self.pos = -1
1199
1200         def genString(self, lst):
1201                 res = ""
1202                 for x in lst:
1203                         res += self.description[x]+" "
1204                 return res
1205
1206         def getText(self):
1207                 return self.genString(self.value)
1208
1209         def getMulti(self, selected):
1210                 if not selected or self.pos == -1:
1211                         return ("text", self.genString(self.value))
1212                 else:
1213                         tmp = self.value[:]
1214                         ch = self.choices[self.pos]
1215                         mem = ch in self.value
1216                         if not mem:
1217                                 tmp.append(ch)
1218                                 tmp.sort()
1219                         ind = tmp.index(ch)
1220                         val1 = self.genString(tmp[:ind])
1221                         val2 = " "+self.genString(tmp[ind+1:])
1222                         if mem:
1223                                 chstr = " "+self.description[ch]+" "
1224                         else:
1225                                 chstr = "("+self.description[ch]+")"
1226                         len_val1 = len(val1)
1227                         return ("mtext", val1+chstr+val2, range(len_val1, len_val1 + len(chstr)))
1228
1229         def onDeselect(self, session):
1230                 self.pos = -1
1231                 if not self.last_value == self.value:
1232                         self.changedFinal()
1233                         self.last_value = self.value[:]
1234
1235         def tostring(self, value):
1236                 return str(value)
1237
1238         def fromstring(self, val):
1239                 return eval(val)
1240
1241         description = property(lambda self: descriptionList(self.choices.choices, choicesList.LIST_TYPE_LIST))
1242
1243 class ConfigLocations(ConfigElement):
1244         def __init__(self, default = [], visible_width = False):
1245                 ConfigElement.__init__(self)
1246                 self.visible_width = visible_width
1247                 self.pos = -1
1248                 self.default = default
1249                 self.locations = []
1250                 self.mountpoints = []
1251                 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
1252                 self.value = default[:]
1253
1254         def setValue(self, value):
1255                 locations = self.locations
1256                 loc = [x[0] for x in locations if x[3]]
1257                 add = [x for x in value if not x in loc]
1258                 diff = add + [x for x in loc if not x in value]
1259                 locations = [x for x in locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
1260                 locations.sort(key = lambda x: x[0])
1261                 self.locations = locations
1262                 self.changed()
1263
1264         def getValue(self):
1265                 self.checkChangedMountpoints()
1266                 locations = self.locations
1267                 for x in locations:
1268                         x[3] = x[2]
1269                 return [x[0] for x in locations if x[3]]
1270
1271         value = property(getValue, setValue)
1272
1273         def tostring(self, value):
1274                 return str(value)
1275
1276         def fromstring(self, val):
1277                 return eval(val)
1278
1279         def load(self):
1280                 sv = self.saved_value
1281                 if sv is None:
1282                         tmp = self.default
1283                 else:
1284                         tmp = self.fromstring(sv)
1285                 locations = [[x, None, False, False] for x in tmp]
1286                 self.refreshMountpoints()
1287                 for x in locations:
1288                         if os_path.exists(x[0]):
1289                                 x[1] = self.getMountpoint(x[0])
1290                                 x[2] = True
1291                 self.locations = locations
1292
1293         def save(self):
1294                 locations = self.locations
1295                 if self.save_disabled or not locations:
1296                         self.saved_value = None
1297                 else:
1298                         self.saved_value = self.tostring([x[0] for x in locations])
1299
1300         def isChanged(self):
1301                 sv = self.saved_value
1302                 locations = self.locations
1303                 if val is None and not locations:
1304                         return False
1305                 return self.tostring([x[0] for x in locations]) != sv
1306
1307         def mountpointsChanged(self, action, dev):
1308                 print "Mounts changed: ", action, dev
1309                 mp = dev.mountpoint+"/"
1310                 if action == "add":
1311                         self.addedMount(mp)
1312                 elif action == "remove":
1313                         self.removedMount(mp)
1314                 self.refreshMountpoints()
1315
1316         def addedMount(self, mp):
1317                 for x in self.locations:
1318                         if x[1] == mp:
1319                                 x[2] = True
1320                         elif x[1] == None and os_path.exists(x[0]):
1321                                 x[1] = self.getMountpoint(x[0])
1322                                 x[2] = True
1323
1324         def removedMount(self, mp):
1325                 for x in self.locations:
1326                         if x[1] == mp:
1327                                 x[2] = False
1328
1329         def refreshMountpoints(self):
1330                 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1331                 self.mountpoints.sort(key = lambda x: -len(x))
1332
1333         def checkChangedMountpoints(self):
1334                 oldmounts = self.mountpoints
1335                 self.refreshMountpoints()
1336                 newmounts = self.mountpoints
1337                 if oldmounts == newmounts:
1338                         return
1339                 for x in oldmounts:
1340                         if not x in newmounts:
1341                                 self.removedMount(x)
1342                 for x in newmounts:
1343                         if not x in oldmounts:
1344                                 self.addedMount(x)
1345
1346         def getMountpoint(self, file):
1347                 file = os_path.realpath(file)+"/"
1348                 for m in self.mountpoints:
1349                         if file.startswith(m):
1350                                 return m
1351                 return None
1352
1353         def handleKey(self, key):
1354                 if key == KEY_LEFT:
1355                         self.pos -= 1
1356                         if self.pos < -1:
1357                                 self.pos = len(self.value)-1
1358                 elif key == KEY_RIGHT:
1359                         self.pos += 1
1360                         if self.pos >= len(self.value):
1361                                 self.pos = -1
1362                 elif key in (KEY_HOME, KEY_END):
1363                         self.pos = -1
1364
1365         def getText(self):
1366                 return " ".join(self.value)
1367
1368         def getMulti(self, selected):
1369                 if not selected:
1370                         valstr = " ".join(self.value)
1371                         if self.visible_width and len(valstr) > self.visible_width:
1372                                 return ("text", valstr[0:self.visible_width])
1373                         else:
1374                                 return ("text", valstr)
1375                 else:
1376                         i = 0
1377                         valstr = ""
1378                         ind1 = 0
1379                         ind2 = 0
1380                         for val in self.value:
1381                                 if i == self.pos:
1382                                         ind1 = len(valstr)
1383                                 valstr += str(val)+" "
1384                                 if i == self.pos:
1385                                         ind2 = len(valstr)
1386                                 i += 1
1387                         if self.visible_width and len(valstr) > self.visible_width:
1388                                 if ind1+1 < self.visible_width/2:
1389                                         off = 0
1390                                 else:
1391                                         off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1392                                 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1393                         else:
1394                                 return ("mtext", valstr, range(ind1,ind2))
1395
1396         def onDeselect(self, session):
1397                 self.pos = -1
1398
1399 # nothing.
1400 class ConfigNothing(ConfigSelection):
1401         def __init__(self):
1402                 ConfigSelection.__init__(self, choices = [("","")])
1403
1404 # until here, 'saved_value' always had to be a *string*.
1405 # now, in ConfigSubsection, and only there, saved_value
1406 # is a dict, essentially forming a tree.
1407 #
1408 # config.foo.bar=True
1409 # config.foobar=False
1410 #
1411 # turns into:
1412 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1413 #
1414
1415 class ConfigSubsectionContent(object):
1416         pass
1417
1418 # we store a backup of the loaded configuration
1419 # data in self.stored_values, to be able to deploy
1420 # them when a new config element will be added,
1421 # so non-default values are instantly available
1422
1423 # A list, for example:
1424 # config.dipswitches = ConfigSubList()
1425 # config.dipswitches.append(ConfigYesNo())
1426 # config.dipswitches.append(ConfigYesNo())
1427 # config.dipswitches.append(ConfigYesNo())
1428 class ConfigSubList(list, object):
1429         def __init__(self):
1430                 list.__init__(self)
1431                 self.stored_values = {}
1432
1433         def save(self):
1434                 for x in self:
1435                         x.save()
1436
1437         def load(self):
1438                 for x in self:
1439                         x.load()
1440
1441         def getSavedValue(self):
1442                 res = { }
1443                 for i, val in enumerate(self):
1444                         sv = val.saved_value
1445                         if sv is not None:
1446                                 res[str(i)] = sv
1447                 return res
1448
1449         def setSavedValue(self, values):
1450                 self.stored_values = dict(values)
1451                 for (key, val) in self.stored_values.items():
1452                         if int(key) < len(self):
1453                                 self[int(key)].saved_value = val
1454
1455         saved_value = property(getSavedValue, setSavedValue)
1456
1457         def append(self, item):
1458                 i = str(len(self))
1459                 list.append(self, item)
1460                 if i in self.stored_values:
1461                         item.saved_value = self.stored_values[i]
1462                         item.load()
1463
1464         def dict(self):
1465                 return dict([(str(index), value) for index, value in enumerate(self)])
1466
1467 # same as ConfigSubList, just as a dictionary.
1468 # care must be taken that the 'key' has a proper
1469 # str() method, because it will be used in the config
1470 # file.
1471 class ConfigSubDict(dict, object):
1472         def __init__(self):
1473                 dict.__init__(self)
1474                 self.stored_values = {}
1475
1476         def save(self):
1477                 for x in self.values():
1478                         x.save()
1479
1480         def load(self):
1481                 for x in self.values():
1482                         x.load()
1483
1484         def getSavedValue(self):
1485                 res = {}
1486                 for (key, val) in self.items():
1487                         sv = val.saved_value
1488                         if sv is not None:
1489                                 res[str(key)] = sv
1490                 return res
1491
1492         def setSavedValue(self, values):
1493                 self.stored_values = dict(values)
1494                 for (key, val) in self.items():
1495                         if str(key) in self.stored_values:
1496                                 val = self.stored_values[str(key)]
1497
1498         saved_value = property(getSavedValue, setSavedValue)
1499
1500         def __setitem__(self, key, item):
1501                 dict.__setitem__(self, key, item)
1502                 if str(key) in self.stored_values:
1503                         item.saved_value = self.stored_values[str(key)]
1504                         item.load()
1505
1506         def dict(self):
1507                 return self
1508
1509 # Like the classes above, just with a more "native"
1510 # syntax.
1511 #
1512 # some evil stuff must be done to allow instant
1513 # loading of added elements. this is why this class
1514 # is so complex.
1515 #
1516 # we need the 'content' because we overwrite
1517 # __setattr__.
1518 # If you don't understand this, try adding
1519 # __setattr__ to a usual exisiting class and you will.
1520 class ConfigSubsection(object):
1521         def __init__(self):
1522                 self.__dict__["content"] = ConfigSubsectionContent()
1523                 self.content.items = { }
1524                 self.content.stored_values = { }
1525
1526         def __setattr__(self, name, value):
1527                 if name == "saved_value":
1528                         return self.setSavedValue(value)
1529                 assert isinstance(value, (ConfigSubsection, ConfigElement, ConfigSubList, ConfigSubDict)), "ConfigSubsections can only store ConfigSubsections, ConfigSubLists, ConfigSubDicts or ConfigElements"
1530                 content = self.content
1531                 content.items[name] = value
1532                 x = content.stored_values.get(name, None)
1533                 if x is not None:
1534                         #print "ok, now we have a new item,", name, "and have the following value for it:", x
1535                         value.saved_value = x
1536                         value.load()
1537
1538         def __getattr__(self, name):
1539                 return self.content.items[name]
1540
1541         def getSavedValue(self):
1542                 res = self.content.stored_values
1543                 for (key, val) in self.content.items.items():
1544                         sv = val.saved_value
1545                         if sv is not None:
1546                                 res[key] = sv
1547                         elif key in res:
1548                                 del res[key]
1549                 return res
1550
1551         def setSavedValue(self, values):
1552                 values = dict(values)
1553                 self.content.stored_values = values
1554                 for (key, val) in self.content.items.items():
1555                         value = values.get(key, None)
1556                         if value is not None:
1557                                 val.saved_value = value
1558
1559         saved_value = property(getSavedValue, setSavedValue)
1560
1561         def save(self):
1562                 for x in self.content.items.values():
1563                         x.save()
1564
1565         def load(self):
1566                 for x in self.content.items.values():
1567                         x.load()
1568
1569         def dict(self):
1570                 return self.content.items
1571
1572 # the root config object, which also can "pickle" (=serialize)
1573 # down the whole config tree.
1574 #
1575 # we try to keep non-existing config entries, to apply them whenever
1576 # a new config entry is added to a subsection
1577 # also, non-existing config entries will be saved, so they won't be
1578 # lost when a config entry disappears.
1579 class Config(ConfigSubsection):
1580         def __init__(self):
1581                 ConfigSubsection.__init__(self)
1582
1583         def pickle_this(self, prefix, topickle, result):
1584                 for (key, val) in topickle.items():
1585                         name = '.'.join((prefix, key))
1586                         if isinstance(val, dict):
1587                                 self.pickle_this(name, val, result)
1588                         elif isinstance(val, tuple):
1589                                 result += [name, '=', val[0], '\n']
1590                         else:
1591                                 result += [name, '=', val, '\n']
1592
1593         def pickle(self):
1594                 result = []
1595                 self.pickle_this("config", self.saved_value, result)
1596                 return ''.join(result)
1597
1598         def unpickle(self, lines):
1599                 tree = { }
1600                 for l in lines:
1601                         if not l or l[0] == '#':
1602                                 continue
1603
1604                         n = l.find('=')
1605                         val = l[n+1:].strip()
1606
1607                         names = l[:n].split('.')
1608 #                       if val.find(' ') != -1:
1609 #                               val = val[:val.find(' ')]
1610
1611                         base = tree
1612
1613                         for n in names[:-1]:
1614                                 base = base.setdefault(n, {})
1615
1616                         base[names[-1]] = val
1617
1618                 # we inherit from ConfigSubsection, so ...
1619                 #object.__setattr__(self, "saved_value", tree["config"])
1620                 if "config" in tree:
1621                         self.setSavedValue(tree["config"])
1622
1623         def saveToFile(self, filename):
1624                 text = self.pickle()
1625                 f = open(filename, "w")
1626                 f.write(text)
1627                 f.close()
1628
1629         def loadFromFile(self, filename):
1630                 f = open(filename, "r")
1631                 self.unpickle(f.readlines())
1632                 f.close()
1633
1634 config = Config()
1635 config.misc = ConfigSubsection()
1636
1637 class ConfigFile:
1638         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1639
1640         def load(self):
1641                 try:
1642                         config.loadFromFile(self.CONFIG_FILE)
1643                 except IOError, e:
1644                         print "unable to load config (%s), assuming defaults..." % str(e)
1645
1646         def save(self):
1647 #               config.save()
1648                 config.saveToFile(self.CONFIG_FILE)
1649
1650         def __resolveValue(self, pickles, cmap):
1651                 key = pickles[0]
1652                 if cmap.has_key(key):
1653                         if len(pickles) > 1:
1654                                 return self.__resolveValue(pickles[1:], cmap[key].dict())
1655                         else:
1656                                 return str(cmap[key].value)
1657                 return None
1658
1659         def getResolvedKey(self, key):
1660                 names = key.split('.')
1661                 if len(names) > 1:
1662                         if names[0] == "config":
1663                                 ret=self.__resolveValue(names[1:], config.content.items)
1664                                 if ret and len(ret):
1665                                         return ret
1666                 print "getResolvedKey", key, "failed !! (Typo??)"
1667                 return ""
1668
1669 def NoSave(element):
1670         element.disableSave()
1671         return element
1672
1673 configfile = ConfigFile()
1674
1675 configfile.load()
1676
1677 def getConfigListEntry(*args):
1678         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1679         return args
1680
1681 def updateConfigElement(element, newelement):
1682         newelement.value = element.value
1683         return newelement
1684
1685 #def _(x):
1686 #       return x
1687 #
1688 #config.bla = ConfigSubsection()
1689 #config.bla.test = ConfigYesNo()
1690 #config.nim = ConfigSubList()
1691 #config.nim.append(ConfigSubsection())
1692 #config.nim[0].bla = ConfigYesNo()
1693 #config.nim.append(ConfigSubsection())
1694 #config.nim[1].bla = ConfigYesNo()
1695 #config.nim[1].blub = ConfigYesNo()
1696 #config.arg = ConfigSubDict()
1697 #config.arg["Hello"] = ConfigYesNo()
1698 #
1699 #config.arg["Hello"].handleKey(KEY_RIGHT)
1700 #config.arg["Hello"].handleKey(KEY_RIGHT)
1701 #
1702 ##config.saved_value
1703 #
1704 ##configfile.save()
1705 #config.save()
1706 #print config.pickle()