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