lib/python/Screens/Wizard.py

   1 from Screen import Screen
   2
   3 import string
   4
   5 from Screens.HelpMenu import HelpableScreen
   6 from Components.Label import Label
   7 from Components.Slider import Slider
   8 from Components.ActionMap import HelpableActionMap, NumberActionMap
   9 from Components.Pixmap import *
  10 from Components.MenuList import MenuList
  11 from Components.ConfigList import ConfigList
  12
  13 from xml.sax import make_parser
  14 from xml.sax.handler import ContentHandler
  15
  16 class Wizard(Screen, HelpableScreen):
  17
  18         class parseWizard(ContentHandler):
  19                 def __init__(self, wizard):
  20                         self.isPointsElement, self.isReboundsElement = 0, 0
  21                         self.wizard = wizard
  22                         self.currContent = ""
  23                         self.lastStep = 0
  24
  25                 def startElement(self, name, attrs):
  26                         print "startElement", name
  27                         self.currContent = name
  28                         if (name == "step"):
  29                                 self.lastStep += 1
  30                                 if attrs.has_key('id'):
  31                                         id = str(attrs.get('id'))
  32                                 else:
  33                                         id = ""
  34                                 if attrs.has_key('nextstep'):
  35                                         nextstep = str(attrs.get('nextstep'))
  36                                 else:
  37                                         nextstep = None
  38                                 self.wizard[self.lastStep] = {"id": id, "condition": "", "text": "", "list": [], "config": {"screen": None, "args": None, "type": "" }, "code": "", "codeafter": "", "nextstep": nextstep}
  39                         elif (name == "text"):
  40                                 self.wizard[self.lastStep]["text"] = string.replace(str(attrs.get('value')), "\\n", "\n")
  41                         elif (name == "listentry"):
  42                                 self.wizard[self.lastStep]["list"].append((str(attrs.get('caption')), str(attrs.get('step'))))
  43                         elif (name == "config"):
  44                                 exec "from Screens." + str(attrs.get('module')) + " import *"
  45                                 self.wizard[self.lastStep]["config"]["screen"] = eval(str(attrs.get('screen')))
  46                                 if (attrs.has_key('args')):
  47                                         print "has args"
  48                                         self.wizard[self.lastStep]["config"]["args"] = str(attrs.get('args'))
  49                                 self.wizard[self.lastStep]["config"]["type"] = str(attrs.get('type'))
  50                         elif (name == "code"):
  51                                 if attrs.has_key('pos') and str(attrs.get('pos')) == "after":
  52                                         self.codeafter = True
  53                                 else:
  54                                         self.codeafter = False
  55                         elif (name == "condition"):
  56                                 pass
  57                 def endElement(self, name):
  58                         self.currContent = ""
  59                         if name == 'code':
  60                                 if self.codeafter:
  61                                         self.wizard[self.lastStep]["codeafter"] = self.wizard[self.lastStep]["codeafter"].strip()
  62                                 else:
  63                                         self.wizard[self.lastStep]["code"] = self.wizard[self.lastStep]["code"].strip()
  64                         elif name == 'condition':
  65                                 self.wizard[self.lastStep]["condition"] = self.wizard[self.lastStep]["condition"].strip()
  66
  67                 def characters(self, ch):
  68                         if self.currContent == "code":
  69                                 if self.codeafter:
  70                                         self.wizard[self.lastStep]["codeafter"] = self.wizard[self.lastStep]["codeafter"] + ch
  71                                 else:
  72                                         self.wizard[self.lastStep]["code"] = self.wizard[self.lastStep]["code"] + ch
  73                         elif self.currContent == "condition":
  74                                  self.wizard[self.lastStep]["condition"] = self.wizard[self.lastStep]["condition"] + ch
  75
  76         def __init__(self, session, showSteps = True, showStepSlider = True, showList = True, showConfig = True):
  77                 Screen.__init__(self, session)
  78                 HelpableScreen.__init__(self)
  79
  80                 self.stepHistory = []
  81
  82                 self.wizard = {}
  83                 parser = make_parser()
  84                 print "Reading " + self.xmlfile
  85                 wizardHandler = self.parseWizard(self.wizard)
  86                 parser.setContentHandler(wizardHandler)
  87                 parser.parse('/usr/share/enigma2/' + self.xmlfile)
  88
  89                 self.showSteps = showSteps
  90                 self.showStepSlider = showStepSlider
  91                 self.showList = showList
  92                 self.showConfig = showConfig
  93
  94                 self.numSteps = len(self.wizard)
  95                 self.currStep = 1
  96
  97                 self["text"] = Label()
  98
  99                 if showConfig:
 100                         self["config"] = ConfigList([])
 101
 102                 if self.showSteps:
 103                         self["step"] = Label()
 104
 105                 if self.showStepSlider:
 106                         self["stepslider"] = Slider(1, self.numSteps)
 107
 108                 if self.showList:
 109                         self.list = []
 110                         self["list"] = MenuList(self.list)
 111
 112                 self.onShown.append(self.updateValues)
 113
 114                 self.configInstance = None
 115
 116                 self["actions"] = NumberActionMap(["WizardActions", "NumberActions"],
 117                 {
 118                         "ok": self.ok,
 119                         "back": self.back,
 120                         "left": self.left,
 121                         "right": self.right,
 122                         "up": self.up,
 123                         "down": self.down,
 124                         "1": self.keyNumberGlobal,
 125                         "2": self.keyNumberGlobal,
 126                         "3": self.keyNumberGlobal,
 127                         "4": self.keyNumberGlobal,
 128                         "5": self.keyNumberGlobal,
 129                         "6": self.keyNumberGlobal,
 130                         "7": self.keyNumberGlobal,
 131                         "8": self.keyNumberGlobal,
 132                         "9": self.keyNumberGlobal,
 133                         "0": self.keyNumberGlobal
 134                 }, -1)
 135
 136         def back(self):
 137                 if len(self.stepHistory) > 1:
 138                         self.currStep = self.stepHistory[-2]
 139                         self.stepHistory = self.stepHistory[:-2]
 140                 if self.currStep < 1:
 141                         self.currStep = 1
 142                 self.updateValues()
 143
 144         def markDone(self):
 145                 pass
 146
 147         def getStepWithID(self, id):
 148                 count = 0
 149                 for x in self.wizard:
 150                         if self.wizard[x]["id"] == id:
 151                                 return count
 152                         count += 1
 153                 return 0
 154
 155         def ok(self):
 156                 print "OK"
 157                 currStep = self.currStep
 158                 if self.showConfig:
 159                         if (self.wizard[currStep]["config"]["screen"] != None):
 160                                 # TODO: don't die, if no run() is available
 161                                 # there was a try/except here, but i can't see a reason
 162                                 # for this. If there is one, please do a more specific check
 163                                 # and/or a comment in which situation there is no run()
 164                                 self.configInstance.run()
 165
 166                 if self.showList:
 167                         if (len(self.wizard[currStep]["list"]) > 0):
 168                                 nextStep = self.wizard[currStep]["list"][self["list"].l.getCurrentSelectionIndex()][1]
 169                                 self.currStep = self.getStepWithID(nextStep)
 170
 171                 if (currStep == self.numSteps): # wizard finished
 172                         self.markDone()
 173                         self.close()
 174                 else:
 175                         self.runCode(self.wizard[currStep]["codeafter"])
 176                         if self.wizard[currStep]["nextstep"] is not None:
 177                                 self.currStep = self.getStepWithID(self.wizard[currStep]["nextstep"])
 178                         self.currStep += 1
 179                         self.updateValues()
 180
 181                 print "Now: " + str(self.currStep)
 182
 183         def keyNumberGlobal(self, number):
 184                 if (self.wizard[self.currStep]["config"]["screen"] != None):
 185                         self.configInstance.keyNumberGlobal(number)
 186
 187         def left(self):
 188                 if (self.wizard[self.currStep]["config"]["screen"] != None):
 189                         self.configInstance.keyLeft()
 190                 print "left"
 191
 192         def right(self):
 193                 if (self.wizard[self.currStep]["config"]["screen"] != None):
 194                         self.configInstance.keyRight()
 195                 print "right"
 196
 197         def up(self):
 198                 if (self.showConfig and self.wizard[self.currStep]["config"]["screen"] != None):
 199                                 self["config"].instance.moveSelection(self["config"].instance.moveUp)
 200                 elif (self.showList and len(self.wizard[self.currStep]["list"]) > 0):
 201                         self["list"].instance.moveSelection(self["list"].instance.moveUp)
 202                 print "up"
 203
 204         def down(self):
 205                 if (self.showConfig and self.wizard[self.currStep]["config"]["screen"] != None):
 206                         self["config"].instance.moveSelection(self["config"].instance.moveDown)
 207                 elif (self.showList and len(self.wizard[self.currStep]["list"]) > 0):
 208                         self["list"].instance.moveSelection(self["list"].instance.moveDown)
 209                 print "down"
 210
 211         def runCode(self, code):
 212                 if code != "":
 213                         print "code", code
 214                         exec(code)
 215
 216         def updateValues(self):
 217                 print "Updating values in step " + str(self.currStep)
 218
 219                 self.stepHistory.append(self.currStep)
 220
 221                 if self.configInstance is not None:
 222                         del self.configInstance["config"]
 223                         self.configInstance.doClose()
 224                         self.configInstance = None
 225
 226                 self.condition = True
 227                 exec (self.wizard[self.currStep]["condition"])
 228                 if self.condition:
 229                         if self.showSteps:
 230                                 self["step"].setText(_("Step ") + str(self.currStep) + "/" + str(self.numSteps))
 231                         if self.showStepSlider:
 232                                 self["stepslider"].setValue(self.currStep)
 233
 234                         print "wizard text", _(self.wizard[self.currStep]["text"])
 235                         self["text"].setText(_(self.wizard[self.currStep]["text"]))
 236
 237                         self.runCode(self.wizard[self.currStep]["code"])
 238
 239                         if self.showList:
 240                                 self["list"].instance.setZPosition(1)
 241                                 self.list = []
 242                                 if (len(self.wizard[self.currStep]["list"]) > 0):
 243                                         self["list"].instance.setZPosition(2)
 244                                         for x in self.wizard[self.currStep]["list"]:
 245                                                 self.list.append((_(x[0]), None))
 246                                 self["list"].l.setList(self.list)
 247
 248                         if self.showConfig:
 249                                 self["config"].instance.setZPosition(1)
 250                                 if (self.wizard[self.currStep]["config"]["screen"] != None):
 251                                         if self.wizard[self.currStep]["config"]["type"] == "standalone":
 252                                                 print "Type is standalone"
 253                                                 self.session.openWithCallback(self.ok, self.wizard[self.currStep]["config"]["screen"])
 254                                         else:
 255                                                 self["config"].instance.setZPosition(2)
 256                                                 print "wizard screen", self.wizard[self.currStep]["config"]["screen"]
 257                                                 if self.wizard[self.currStep]["config"]["args"] == None:
 258                                                         self.configInstance = self.session.instantiateDialog(self.wizard[self.currStep]["config"]["screen"])
 259                                                 else:
 260                                                         self.configInstance = self.session.instantiateDialog(self.wizard[self.currStep]["config"]["screen"], eval(self.wizard[self.currStep]["config"]["args"]))
 261                                                 self["config"].l.setList(self.configInstance["config"].list)
 262                                                 self.configInstance["config"].destroy()
 263                                                 self.configInstance["config"] = self["config"]
 264                                 else:
 265                                         self["config"].l.setList([])
 266                 else: # condition false
 267                                 self.currStep += 1
 268                                 self.updateValues()
 269
 270 class WizardManager:
 271         def __init__(self):
 272                 self.wizards = []
 273
 274         def registerWizard(self, wizard, precondition):
 275                 self.wizards.append((wizard, precondition))
 276
 277         def getWizards(self):
 278                 list = []
 279                 for x in self.wizards:
 280                         if x[1] == 1: # precondition
 281                                 list.append(x[0])
 282                 return list
 283
 284 wizardManager = WizardManager()