ease usability of ConfigIP elements
[vuplus_dvbapp] / lib / python / Components / config.py
1 import time
2 from enigma import getPrevAsciiCode
3 from Tools.NumericalTextInput import NumericalTextInput
4 from Tools.Directories import resolveFilename, SCOPE_CONFIG
5 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):
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
514         def handleKey(self, key):
515                 if key == KEY_LEFT:
516                         if self.marked_block > 0:
517                                 self.marked_block -= 1
518                                 self.overwrite = True
519
520                 if key == KEY_RIGHT:
521                         if self.marked_block < len(self.limits)-1:
522                                 self.marked_block += 1
523                                 self.overwrite = True
524
525                 if key == KEY_HOME:
526                         self.marked_block = 0
527                         self.overwrite = True
528
529                 if key == KEY_END:
530                         self.marked_block = len(self.limits)-1
531                         self.overwrite = True
532
533                 if key in KEY_NUMBERS:
534                         number = getKeyNumber(key)
535                         oldvalue = self._value[self.marked_block]
536                         
537                         if self.overwrite:
538                                 self._value[self.marked_block] = number
539                                 self.overwrite = False          
540                         else:
541                                 oldvalue *= 10
542                                 self._value[self.marked_block] = oldvalue + number
543
544                         if len(str(self._value[self.marked_block])) >= self.block_len[self.marked_block]:
545                                 self.handleKey(KEY_RIGHT)
546
547                         self.validate()
548                         self.changed()
549
550         def genText(self):
551                 value = ""
552                 block_strlen = []
553                 for i in self._value:
554                         block_strlen.append(len(str(i)))        
555                         if len(value):
556                                 value += self.seperator
557                         value += str(i)
558                 leftPos = sum(block_strlen[:(self.marked_block)])+self.marked_block
559                 rightPos = sum(block_strlen[:(self.marked_block+1)])+self.marked_block
560                 mBlock = range(leftPos, rightPos)
561                 return (value, mBlock)
562         
563         def getMulti(self, selected):
564                 (value, mBlock) = self.genText()
565                 if self.enabled:
566                         return ("mtext"[1-selected:], value, mBlock)
567                 else:
568                         return ("text", value)
569
570         def getHTML(self, id):
571                 # we definitely don't want leading zeros
572                 return '.'.join(["%d" % d for d in self.value])
573
574 class ConfigMAC(ConfigSequence):
575         def __init__(self, default):
576                 ConfigSequence.__init__(self, seperator = ":", limits = [(1,255),(1,255),(1,255),(1,255),(1,255),(1,255)], default = default)
577
578 class ConfigPosition(ConfigSequence):
579         def __init__(self, default, args):
580                 ConfigSequence.__init__(self, seperator = ",", limits = [(0,args[0]),(0,args[1]),(0,args[2]),(0,args[3])], default = default)
581
582 class ConfigClock(ConfigSequence):
583         def __init__(self, default):
584                 import time
585                 t = time.localtime(default)
586                 ConfigSequence.__init__(self, seperator = ":", limits = [(0,23),(0,59)], default = [t.tm_hour, t.tm_min])
587
588 class ConfigInteger(ConfigSequence):
589         def __init__(self, default, limits = (0, 9999999999)):
590                 ConfigSequence.__init__(self, seperator = ":", limits = [limits], default = default)
591         
592         # you need to override this to do input validation
593         def setValue(self, value):
594                 self._value = [value]
595                 self.changed()
596
597         def getValue(self):
598                 return self._value[0]
599         
600         value = property(getValue, setValue)
601
602         def fromstring(self, value):
603                 return int(value)
604
605         def tostring(self, value):
606                 return str(value)
607
608 class ConfigPIN(ConfigInteger):
609         def __init__(self, default, len = 4, censor = ""):
610                 assert isinstance(default, int), "ConfigPIN default must be an integer"
611                 if default == -1:
612                         default = "aaaa"
613                 ConfigSequence.__init__(self, seperator = ":", limits = [(0, (10**len)-1)], censor_char = censor, default = default)
614                 self.len = len
615
616         def getLength(self):
617                 return self.len
618
619 class ConfigFloat(ConfigSequence):
620         def __init__(self, default, limits):
621                 ConfigSequence.__init__(self, seperator = ".", limits = limits, default = default)
622
623         def getFloat(self):
624                 return float(self.value[1] / float(self.limits[1][1] + 1) + self.value[0])
625
626         float = property(getFloat)
627
628 # an editable text...
629 class ConfigText(ConfigElement, NumericalTextInput):
630         def __init__(self, default = "", fixed_size = True, visible_width = False):
631                 ConfigElement.__init__(self)
632                 NumericalTextInput.__init__(self, nextFunc = self.nextFunc, handleTimeout = False)
633                 
634                 self.marked_pos = 0
635                 self.allmarked = (default != "")
636                 self.fixed_size = fixed_size
637                 self.visible_width = visible_width
638                 self.offset = 0
639                 self.overwrite = fixed_size
640                 self.help_window = None
641                 self.value = self.default = default
642
643         def validateMarker(self):
644                 if self.fixed_size:
645                         if self.marked_pos > len(self.text)-1:
646                                 self.marked_pos = len(self.text)-1
647                 else:
648                         if self.marked_pos > len(self.text):
649                                 self.marked_pos = len(self.text)
650                 if self.marked_pos < 0:
651                         self.marked_pos = 0
652                 if self.visible_width:
653                         if self.marked_pos < self.offset:
654                                 self.offset = self.marked_pos
655                         if self.marked_pos >= self.offset + self.visible_width:
656                                 if self.marked_pos == len(self.text):
657                                         self.offset = self.marked_pos - self.visible_width
658                                 else:
659                                         self.offset = self.marked_pos - self.visible_width + 1
660                         if self.offset > 0 and self.offset + self.visible_width > len(self.text):
661                                 self.offset = max(0, len(self.text) - self.visible_width)
662
663         def insertChar(self, ch, pos, owr):
664                 if owr or self.overwrite:
665                         self.text = self.text[0:pos] + ch + self.text[pos + 1:]
666                 elif self.fixed_size:
667                         self.text = self.text[0:pos] + ch + self.text[pos:-1]
668                 else:
669                         self.text = self.text[0:pos] + ch + self.text[pos:]
670
671         def deleteChar(self, pos):
672                 if not self.fixed_size:
673                         self.text = self.text[0:pos] + self.text[pos + 1:]
674                 elif self.overwrite:
675                         self.text = self.text[0:pos] + " " + self.text[pos + 1:]
676                 else:
677                         self.text = self.text[0:pos] + self.text[pos + 1:] + " "
678
679         def deleteAllChars(self):
680                 if self.fixed_size:
681                         self.text = " " * len(self.text)
682                 else:
683                         self.text = ""
684                 self.marked_pos = 0
685
686         def handleKey(self, key):
687                 # this will no change anything on the value itself
688                 # so we can handle it here in gui element
689                 if key == KEY_DELETE:
690                         self.timeout()
691                         if self.allmarked:
692                                 self.deleteAllChars()
693                                 self.allmarked = False
694                         else:
695                                 self.deleteChar(self.marked_pos)
696                                 if self.fixed_size and self.overwrite:
697                                         self.marked_pos += 1
698                 elif key == KEY_BACKSPACE:
699                         self.timeout()
700                         if self.allmarked:
701                                 self.deleteAllChars()
702                                 self.allmarked = False
703                         elif self.marked_pos > 0:
704                                 self.deleteChar(self.marked_pos-1)
705                                 if not self.fixed_size and self.offset > 0:
706                                         self.offset -= 1
707                                 self.marked_pos -= 1
708                 elif key == KEY_LEFT:
709                         self.timeout()
710                         if self.allmarked:
711                                 self.marked_pos = len(self.text)
712                                 self.allmarked = False
713                         else:
714                                 self.marked_pos -= 1
715                 elif key == KEY_RIGHT:
716                         self.timeout()
717                         if self.allmarked:
718                                 self.marked_pos = 0
719                                 self.allmarked = False
720                         else:
721                                 self.marked_pos += 1
722                 elif key == KEY_HOME:
723                         self.timeout()
724                         self.allmarked = False
725                         self.marked_pos = 0
726                 elif key == KEY_END:
727                         self.timeout()
728                         self.allmarked = False
729                         self.marked_pos = len(self.text)
730                 elif key == KEY_TOGGLEOW:
731                         self.timeout()
732                         self.overwrite = not self.overwrite
733                 elif key == KEY_ASCII:
734                         self.timeout()
735                         newChar = unichr(getPrevAsciiCode())
736                         if self.allmarked:
737                                 self.deleteAllChars()
738                                 self.allmarked = False
739                         self.insertChar(newChar, self.marked_pos, False)
740                         self.marked_pos += 1
741                 elif key in KEY_NUMBERS:
742                         owr = self.lastKey == getKeyNumber(key)
743                         newChar = self.getKey(getKeyNumber(key))
744                         if self.allmarked:
745                                 self.deleteAllChars()
746                                 self.allmarked = False
747                         self.insertChar(newChar, self.marked_pos, owr)
748                 elif key == KEY_TIMEOUT:
749                         self.timeout()
750                         if self.help_window:
751                                 self.help_window.update(self)
752                         return
753
754                 if self.help_window:
755                         self.help_window.update(self)
756                 self.validateMarker()
757                 self.changed()
758
759         def nextFunc(self):
760                 self.marked_pos += 1
761                 self.validateMarker()
762                 self.changed()
763
764         def getValue(self):
765                 return self.text.encode("utf-8")
766                 
767         def setValue(self, val):
768                 try:
769                         self.text = val.decode("utf-8")
770                 except UnicodeDecodeError:
771                         self.text = val
772                         print "Broken UTF8!"
773
774         value = property(getValue, setValue)
775         _value = property(getValue, setValue)
776
777         def getText(self):
778                 return self.text.encode("utf-8")
779
780         def getMulti(self, selected):
781                 if self.visible_width:
782                         if self.allmarked:
783                                 mark = range(0, min(self.visible_width, len(self.text)))
784                         else:
785                                 mark = [self.marked_pos-self.offset]
786                         return ("mtext"[1-selected:], self.text[self.offset:self.offset+self.visible_width].encode("utf-8")+" ", mark)
787                 else:
788                         if self.allmarked:
789                                 mark = range(0, len(self.text))
790                         else:
791                                 mark = [self.marked_pos]
792                         return ("mtext"[1-selected:], self.text.encode("utf-8")+" ", mark)
793
794         def onSelect(self, session):
795                 self.allmarked = (self.value != "")
796                 if session is not None:
797                         from Screens.NumericalTextInputHelpDialog import NumericalTextInputHelpDialog
798                         self.help_window = session.instantiateDialog(NumericalTextInputHelpDialog, self)
799                         self.help_window.show()
800
801         def onDeselect(self, session):
802                 self.marked_pos = 0
803                 self.offset = 0
804                 if self.help_window:
805                         session.deleteDialog(self.help_window)
806                         self.help_window = None
807
808         def getHTML(self, id):
809                 return '<input type="text" name="' + id + '" value="' + self.value + '" /><br>\n'
810
811         def unsafeAssign(self, value):
812                 self.value = str(value)
813
814 class ConfigPassword(ConfigText):
815         def __init__(self, default = "", fixed_size = False, visible_width = False, censor = "*"):
816                 ConfigText.__init__(self, default = default, fixed_size = fixed_size, visible_width = visible_width)
817                 self.censor_char = censor
818                 self.hidden = True
819
820         def getMulti(self, selected):
821                 mtext, text, mark = ConfigText.getMulti(self, selected)
822                 if self.hidden:
823                         text = len(text) * self.censor_char
824                 return (mtext, text, mark)
825                         
826         def onSelect(self, session):
827                 ConfigText.onSelect(self, session)
828                 self.hidden = False
829
830         def onDeselect(self, session):
831                 ConfigText.onDeselect(self, session)
832                 self.hidden = True
833
834 class ConfigNumber(ConfigText):
835         def __init__(self, default = 0):
836                 ConfigText.__init__(self, str(default), fixed_size = False)
837
838         def getValue(self):
839                 return int(self.text)
840                 
841         def setValue(self, val):
842                 self.text = str(val)
843
844         value = property(getValue, setValue)
845         _value = property(getValue, setValue)
846
847         def conform(self):
848                 pos = len(self.text) - self.marked_pos
849                 self.text = self.text.lstrip("0")
850                 if self.text == "":
851                         self.text = "0"
852                 if pos > len(self.text):
853                         self.marked_pos = 0
854                 else:
855                         self.marked_pos = len(self.text) - pos
856
857         def handleKey(self, key):
858                 if key in KEY_NUMBERS or key == KEY_ASCII:
859                         if key == KEY_ASCII:
860                                 ascii = getPrevAsciiCode()
861                                 if not (48 <= ascii <= 57):
862                                         return
863                         else:
864                                 ascii = getKeyNumber(key) + 48
865                         newChar = unichr(ascii)
866                         if self.allmarked:
867                                 self.deleteAllChars()
868                                 self.allmarked = False
869                         self.insertChar(newChar, self.marked_pos, False)
870                         self.marked_pos += 1
871                 else:
872                         ConfigText.handleKey(self, key)
873                 self.conform()
874
875         def onSelect(self, session):
876                 self.allmarked = (self.value != "")
877
878         def onDeselect(self, session):
879                 self.marked_pos = 0
880                 self.offset = 0
881
882 # a slider.
883 class ConfigSlider(ConfigElement):
884         def __init__(self, default = 0, increment = 1, limits = (0, 100)):
885                 ConfigElement.__init__(self)
886                 self.value = self.default = default
887                 self.min = limits[0]
888                 self.max = limits[1]
889                 self.increment = increment
890
891         def checkValues(self):
892                 if self.value < self.min:
893                         self.value = self.min
894
895                 if self.value > self.max:
896                         self.value = self.max
897
898         def handleKey(self, key):
899                 if key == KEY_LEFT:
900                         self.value -= self.increment
901                 elif key == KEY_RIGHT:
902                         self.value += self.increment
903                 elif key == KEY_HOME:
904                         self.value = self.min
905                 elif key == KEY_END:
906                         self.value = self.max
907                 else:
908                         return
909                 self.checkValues()
910
911         def getText(self):
912                 return "%d / %d" % (self.value, self.max)
913
914         def getMulti(self, selected):
915                 self.checkValues()
916                 return ("slider", self.value, self.max)
917
918         def fromstring(self, value):
919                 return int(value)
920
921 # a satlist. in fact, it's a ConfigSelection.
922 class ConfigSatlist(ConfigSelection):
923         def __init__(self, list, default = None):
924                 if default is not None:
925                         default = str(default)
926                 ConfigSelection.__init__(self, choices = [(str(orbpos), desc) for (orbpos, desc, flags) in list], default = default)
927
928         def getOrbitalPosition(self):
929                 if self.value == "":
930                         return None
931                 return int(self.value)
932         
933         orbital_position = property(getOrbitalPosition)
934
935 class ConfigSet(ConfigElement):
936         def __init__(self, choices, default = []):
937                 ConfigElement.__init__(self)
938                 self.choices = []
939                 self.description = {}
940                 if isinstance(choices, list):
941                         choices.sort()
942                         for x in choices:
943                                 if isinstance(x, tuple):
944                                         self.choices.append(x[0])
945                                         self.description[x[0]] = str(x[1])
946                                 else:
947                                         self.choices.append(x)
948                                         self.description[x] = str(x)
949                 else:
950                         assert False, "ConfigSet choices must be a list!"
951                 if len(self.choices) == 0:
952                         self.choices = [""]
953                         self.description[""] = ""
954                 if default is None:
955                         default = []
956                 self.pos = -1
957                 default.sort()
958                 self.default = default
959                 self.value = default+[]
960
961         def toggleChoice(self, choice):
962                 if choice in self.value:
963                         self.value.remove(choice)
964                 else:
965                         self.value.append(choice)
966                         self.value.sort()
967
968         def handleKey(self, key):
969                 if key in KEY_NUMBERS + [KEY_DELETE, KEY_BACKSPACE]:
970                         if self.pos != -1:
971                                 self.toggleChoice(self.choices[self.pos])
972                 elif key == KEY_LEFT:
973                         self.pos -= 1
974                         if self.pos < -1:
975                             self.pos = len(self.choices)-1
976                 elif key == KEY_RIGHT:
977                         self.pos += 1
978                         if self.pos >= len(self.choices):
979                             self.pos = -1
980                 elif key in [KEY_HOME, KEY_END]:
981                         self.pos = -1
982
983         def genString(self, lst):
984                 res = ""
985                 for x in lst:
986                         res += self.description[x]+" "
987                 return res
988
989         def getText(self):
990                 return self.genString(self.value)
991
992         def getMulti(self, selected):
993                 if not selected or self.pos == -1:
994                         return ("text", self.genString(self.value))
995                 else:
996                         tmp = self.value+[]
997                         ch = self.choices[self.pos]
998                         mem = ch in self.value
999                         if not mem:
1000                                 tmp.append(ch)
1001                                 tmp.sort()
1002                         ind = tmp.index(ch)
1003                         val1 = self.genString(tmp[:ind])
1004                         val2 = " "+self.genString(tmp[ind+1:])
1005                         if mem:
1006                                 chstr = " "+self.description[ch]+" "
1007                         else:
1008                                 chstr = "("+self.description[ch]+")"
1009                         return ("mtext", val1+chstr+val2, range(len(val1),len(val1)+len(chstr)))
1010
1011         def onDeselect(self, session):
1012                 self.pos = -1
1013                 self.changed()
1014                 
1015         def tostring(self, value):
1016                 return str(value)
1017
1018         def fromstring(self, val):
1019                 return eval(val)
1020
1021 class ConfigLocations(ConfigElement):
1022         def __init__(self, default = [], visible_width = False):
1023                 ConfigElement.__init__(self)
1024                 self.visible_width = visible_width
1025                 self.pos = -1
1026                 self.default = default
1027                 self.locations = []
1028                 self.mountpoints = []
1029                 harddiskmanager.on_partition_list_change.append(self.mountpointsChanged)
1030
1031         def setValue(self, value):
1032                 loc = [x[0] for x in self.locations if x[3]]
1033                 add = [x for x in value if not x in loc]
1034                 diff = add + [x for x in loc if not x in value]
1035                 self.locations = [x for x in self.locations if not x[0] in diff] + [[x, self.getMountpoint(x), True, True] for x in add]
1036                 self.locations.sort(key = lambda x: x[0])
1037                 self.changed()
1038
1039         def getValue(self):
1040                 self.checkChangedMountpoints()
1041                 for x in self.locations:
1042                         x[3] = x[2]
1043                 return [x[0] for x in self.locations if x[3]]
1044         
1045         value = property(getValue, setValue)
1046
1047         def tostring(self, value):
1048                 return str(value)
1049
1050         def fromstring(self, val):
1051                 return eval(val)
1052
1053         def load(self):
1054                 sv = self.saved_value
1055                 if sv is None:
1056                         tmp = self.default
1057                 else:
1058                         tmp = self.fromstring(sv)
1059                 self.locations = [[x, None, False, False] for x in tmp]
1060                 self.refreshMountpoints()
1061                 for x in self.locations:
1062                         if os.path.exists(x[0]):
1063                                 x[1] = self.getMountpoint(x[0])
1064                                 x[2] = True
1065
1066         def save(self):
1067                 if self.save_disabled or self.locations == []:
1068                         self.saved_value = None
1069                 else:
1070                         self.saved_value = self.tostring([x[0] for x in self.locations])
1071
1072         def isChanged(self):
1073                 sv = self.saved_value
1074                 if val is None and self.locations == []:
1075                         return False
1076                 return self.tostring([x[0] for x in self.locations]) != sv
1077
1078         def mountpointsChanged(self, action, dev):
1079                 print "Mounts changed: ", action, dev
1080                 mp = dev.mountpoint+"/"
1081                 if action == "add":
1082                         self.addedMount(mp)
1083                 elif action == "remove":
1084                         self.removedMount(mp)
1085                 self.refreshMountpoints()
1086
1087         def addedMount(self, mp):
1088                 for x in self.locations:
1089                         if x[1] == mp:
1090                                 x[2] = True
1091                         elif x[1] == None and os.path.exists(x[0]):
1092                                 x[1] = self.getMountpoint(x[0])
1093                                 x[2] = True
1094
1095         def removedMount(self, mp):
1096                 for x in self.locations:
1097                         if x[1] == mp:
1098                                 x[2] = False
1099                 
1100         def refreshMountpoints(self):
1101                 self.mountpoints = [p.mountpoint + "/" for p in harddiskmanager.getMountedPartitions() if p.mountpoint != "/"]
1102                 self.mountpoints.sort(key = lambda x: -len(x))
1103
1104         def checkChangedMountpoints(self):
1105                 oldmounts = self.mountpoints
1106                 self.refreshMountpoints()
1107                 if oldmounts == self.mountpoints:
1108                         return
1109                 for x in oldmounts:
1110                         if not x in self.mountpoints:
1111                                 self.removedMount(x)
1112                 for x in self.mountpoints:
1113                         if not x in oldmounts:
1114                                 self.addedMount(x)
1115
1116         def getMountpoint(self, file):
1117                 file = os.path.realpath(file)+"/"
1118                 for m in self.mountpoints:
1119                         if file.startswith(m):
1120                                 return m
1121                 return None
1122
1123         def handleKey(self, key):
1124                 if key == KEY_LEFT:
1125                         self.pos -= 1
1126                         if self.pos < -1:
1127                             self.pos = len(self.value)-1
1128                 elif key == KEY_RIGHT:
1129                         self.pos += 1
1130                         if self.pos >= len(self.value):
1131                             self.pos = -1
1132                 elif key in [KEY_HOME, KEY_END]:
1133                         self.pos = -1
1134
1135         def getText(self):
1136                 return " ".join(self.value)
1137
1138         def getMulti(self, selected):
1139                 if not selected:
1140                         valstr = " ".join(self.value)
1141                         if self.visible_width and len(valstr) > self.visible_width:
1142                                 return ("text", valstr[0:self.visible_width])
1143                         else:
1144                                 return ("text", valstr)
1145                 else:
1146                         i = 0
1147                         valstr = ""
1148                         ind1 = 0
1149                         ind2 = 0
1150                         for val in self.value:
1151                                 if i == self.pos:
1152                                         ind1 = len(valstr)
1153                                 valstr += str(val)+" "
1154                                 if i == self.pos:
1155                                         ind2 = len(valstr)
1156                                 i += 1
1157                         if self.visible_width and len(valstr) > self.visible_width:
1158                                 if ind1+1 < self.visible_width/2:
1159                                         off = 0
1160                                 else:
1161                                         off = min(ind1+1-self.visible_width/2, len(valstr)-self.visible_width)
1162                                 return ("mtext", valstr[off:off+self.visible_width], range(ind1-off,ind2-off))
1163                         else:
1164                                 return ("mtext", valstr, range(ind1,ind2))
1165
1166         def onDeselect(self, session):
1167                 self.pos = -1
1168                 
1169 # nothing.
1170 class ConfigNothing(ConfigSelection):
1171         def __init__(self):
1172                 ConfigSelection.__init__(self, choices = [""])
1173
1174 # until here, 'saved_value' always had to be a *string*.
1175 # now, in ConfigSubsection, and only there, saved_value
1176 # is a dict, essentially forming a tree.
1177 #
1178 # config.foo.bar=True
1179 # config.foobar=False
1180 #
1181 # turns into:
1182 # config.saved_value == {"foo": {"bar": "True"}, "foobar": "False"}
1183 #
1184
1185
1186 class ConfigSubsectionContent(object):
1187         pass
1188
1189 # we store a backup of the loaded configuration
1190 # data in self.stored_values, to be able to deploy
1191 # them when a new config element will be added,
1192 # so non-default values are instantly available
1193
1194 # A list, for example:
1195 # config.dipswitches = ConfigSubList()
1196 # config.dipswitches.append(ConfigYesNo())
1197 # config.dipswitches.append(ConfigYesNo())
1198 # config.dipswitches.append(ConfigYesNo())
1199 class ConfigSubList(list, object):
1200         def __init__(self):
1201                 object.__init__(self)
1202                 list.__init__(self)
1203                 self.stored_values = {}
1204
1205         def save(self):
1206                 for x in self:
1207                         x.save()
1208         
1209         def load(self):
1210                 for x in self:
1211                         x.load()
1212
1213         def getSavedValue(self):
1214                 res = {}
1215                 for i in range(len(self)):
1216                         sv = self[i].saved_value
1217                         if sv is not None:
1218                                 res[str(i)] = sv
1219                 return res
1220
1221         def setSavedValue(self, values):
1222                 self.stored_values = dict(values)
1223                 for (key, val) in self.stored_values.items():
1224                         if int(key) < len(self):
1225                                 self[int(key)].saved_value = val
1226
1227         saved_value = property(getSavedValue, setSavedValue)
1228
1229         def append(self, item):
1230                 i = str(len(self))
1231                 list.append(self, item)
1232                 if i in self.stored_values:
1233                         item.saved_value = self.stored_values[i]
1234                         item.load()
1235
1236         def dict(self):
1237                 res = dict()
1238                 for index in range(len(self)):
1239                         res[str(index)] = self[index]
1240                 return res
1241
1242 # same as ConfigSubList, just as a dictionary.
1243 # care must be taken that the 'key' has a proper
1244 # str() method, because it will be used in the config
1245 # file.
1246 class ConfigSubDict(dict, object):
1247         def __init__(self):
1248                 object.__init__(self)
1249                 dict.__init__(self)
1250                 self.stored_values = {}
1251
1252         def save(self):
1253                 for x in self.values():
1254                         x.save()
1255         
1256         def load(self):
1257                 for x in self.values():
1258                         x.load()
1259
1260         def getSavedValue(self):
1261                 res = {}
1262                 for (key, val) in self.items():
1263                         sv = val.saved_value
1264                         if sv is not None:
1265                                 res[str(key)] = sv
1266                 return res
1267
1268         def setSavedValue(self, values):
1269                 self.stored_values = dict(values)
1270                 for (key, val) in self.items():
1271                         if str(key) in self.stored_values:
1272                                 val = self.stored_values[str(key)]
1273
1274         saved_value = property(getSavedValue, setSavedValue)
1275
1276         def __setitem__(self, key, item):
1277                 dict.__setitem__(self, key, item)
1278                 if str(key) in self.stored_values:
1279                         item.saved_value = self.stored_values[str(key)]
1280                         item.load()
1281
1282         def dict(self):
1283                 return self
1284
1285 # Like the classes above, just with a more "native"
1286 # syntax.
1287 #
1288 # some evil stuff must be done to allow instant
1289 # loading of added elements. this is why this class
1290 # is so complex.
1291 #
1292 # we need the 'content' because we overwrite 
1293 # __setattr__.
1294 # If you don't understand this, try adding
1295 # __setattr__ to a usual exisiting class and you will.
1296 class ConfigSubsection(object):
1297         def __init__(self):
1298                 object.__init__(self)
1299                 self.__dict__["content"] = ConfigSubsectionContent()
1300                 self.content.items = { }
1301                 self.content.stored_values = { }
1302         
1303         def __setattr__(self, name, value):
1304                 if name == "saved_value":
1305                         return self.setSavedValue(value)
1306                 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"
1307                 self.content.items[name] = value
1308                 if name in self.content.stored_values:
1309                         #print "ok, now we have a new item,", name, "and have the following value for it:", self.content.stored_values[name]
1310                         value.saved_value = self.content.stored_values[name]
1311                         value.load()
1312
1313         def __getattr__(self, name):
1314                 return self.content.items[name]
1315
1316         def getSavedValue(self):
1317                 res = self.content.stored_values
1318                 for (key, val) in self.content.items.items():
1319                         sv = val.saved_value
1320                         if sv is not None:
1321                                 res[key] = sv
1322                         elif key in res:
1323                                 del res[key]
1324                 return res
1325
1326         def setSavedValue(self, values):
1327                 values = dict(values)
1328                 
1329                 self.content.stored_values = values
1330
1331                 for (key, val) in self.content.items.items():
1332                         if key in values:
1333                                 val.saved_value = values[key]
1334
1335         saved_value = property(getSavedValue, setSavedValue)
1336
1337         def save(self):
1338                 for x in self.content.items.values():
1339                         x.save()
1340
1341         def load(self):
1342                 for x in self.content.items.values():
1343                         x.load()
1344
1345         def dict(self):
1346                 return self.content.items
1347
1348 # the root config object, which also can "pickle" (=serialize)
1349 # down the whole config tree.
1350 #
1351 # we try to keep non-existing config entries, to apply them whenever
1352 # a new config entry is added to a subsection
1353 # also, non-existing config entries will be saved, so they won't be
1354 # lost when a config entry disappears.
1355 class Config(ConfigSubsection):
1356         def __init__(self):
1357                 ConfigSubsection.__init__(self)
1358
1359         def pickle_this(self, prefix, topickle, result):
1360                 for (key, val) in topickle.items():
1361                         name = prefix + "." + key
1362                         
1363                         if isinstance(val, dict):
1364                                 self.pickle_this(name, val, result)
1365                         elif isinstance(val, tuple):
1366                                 result.append(name + "=" + val[0]) # + " ; " + val[1])
1367                         else:
1368                                 result.append(name + "=" + val)
1369
1370         def pickle(self):
1371                 result = [ ]
1372                 self.pickle_this("config", self.saved_value, result)
1373                 return '\n'.join(result) + "\n"
1374
1375         def unpickle(self, lines):
1376                 tree = { }
1377                 for l in lines:
1378                         if not len(l) or l[0] == '#':
1379                                 continue
1380                         
1381                         n = l.find('=')
1382                         val = l[n+1:].strip()
1383
1384                         names = l[:n].split('.')
1385 #                       if val.find(' ') != -1:
1386 #                               val = val[:val.find(' ')]
1387
1388                         base = tree
1389                         
1390                         for n in names[:-1]:
1391                                 base = base.setdefault(n, {})
1392                         
1393                         base[names[-1]] = val
1394
1395                 # we inherit from ConfigSubsection, so ...
1396                 #object.__setattr__(self, "saved_value", tree["config"])
1397                 if "config" in tree:
1398                         self.setSavedValue(tree["config"])
1399
1400         def saveToFile(self, filename):
1401                 f = open(filename, "w")
1402                 f.write(self.pickle())
1403                 f.close()
1404
1405         def loadFromFile(self, filename):
1406                 f = open(filename, "r")
1407                 self.unpickle(f.readlines())
1408                 f.close()
1409
1410 config = Config()
1411 config.misc = ConfigSubsection()
1412
1413 class ConfigFile:
1414         CONFIG_FILE = resolveFilename(SCOPE_CONFIG, "settings")
1415
1416         def load(self):
1417                 try:
1418                         config.loadFromFile(self.CONFIG_FILE)
1419                 except IOError, e:
1420                         print "unable to load config (%s), assuming defaults..." % str(e)
1421         
1422         def save(self):
1423 #               config.save()
1424                 config.saveToFile(self.CONFIG_FILE)
1425         
1426         def __resolveValue(self, pickles, cmap):
1427                 if cmap.has_key(pickles[0]):
1428                         if len(pickles) > 1:
1429                                 return self.__resolveValue(pickles[1:], cmap[pickles[0]].dict())
1430                         else:
1431                                 return str(cmap[pickles[0]].value)
1432                 return None
1433         
1434         def getResolvedKey(self, key):
1435                 names = key.split('.')
1436                 if len(names) > 1:
1437                         if names[0] == "config":
1438                                 ret=self.__resolveValue(names[1:], config.content.items)
1439                                 if ret and len(ret):
1440                                         return ret
1441                 print "getResolvedKey", key, "failed !! (Typo??)"
1442                 return ""
1443
1444 def NoSave(element):
1445         element.disableSave()
1446         return element
1447
1448 configfile = ConfigFile()
1449
1450 configfile.load()
1451
1452 def getConfigListEntry(*args):
1453         assert len(args) > 1, "getConfigListEntry needs a minimum of two arguments (descr, configElement)"
1454         return args
1455
1456 def updateConfigElement(element, newelement):
1457         newelement.value = element.value
1458         return newelement
1459
1460 #def _(x):
1461 #       return x
1462 #
1463 #config.bla = ConfigSubsection()
1464 #config.bla.test = ConfigYesNo()
1465 #config.nim = ConfigSubList()
1466 #config.nim.append(ConfigSubsection())
1467 #config.nim[0].bla = ConfigYesNo()
1468 #config.nim.append(ConfigSubsection())
1469 #config.nim[1].bla = ConfigYesNo()
1470 #config.nim[1].blub = ConfigYesNo()
1471 #config.arg = ConfigSubDict()
1472 #config.arg["Hello"] = ConfigYesNo()
1473 #
1474 #config.arg["Hello"].handleKey(KEY_RIGHT)
1475 #config.arg["Hello"].handleKey(KEY_RIGHT)
1476 #
1477 ##config.saved_value
1478 #
1479 ##configfile.save()
1480 #config.save()
1481 #print config.pickle()