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