allow overriding menus from plugins
[vuplus_dvbapp] / lib / python / Screens / Menu.py
1 from Screen import Screen
2 from Components.Sources.List import List
3 from Components.ActionMap import NumberActionMap
4 from Components.Sources.StaticText import StaticText
5 from Components.config import configfile
6 from Components.PluginComponent import plugins
7 from Components.config import config
8
9 from Tools.Directories import resolveFilename, SCOPE_SKIN
10
11 import xml.dom.minidom
12
13 from Screens.Setup import Setup, getSetupTitle
14
15 from Tools import XMLTools
16
17 #               <item text="TV-Mode">self.setModeTV()</item>
18 #               <item text="Radio-Mode">self.setModeRadio()</item>
19 #               <item text="File-Mode">self.setModeFile()</item>
20 #                       <item text="Sleep Timer"></item>
21
22
23 # read the menu
24 menufile = file(resolveFilename(SCOPE_SKIN, 'menu.xml'), 'r')
25 mdom = xml.dom.minidom.parseString(menufile.read())
26 menufile.close()
27
28 class boundFunction:
29         def __init__(self, fnc, *args):
30                 self.fnc = fnc
31                 self.args = args
32         def __call__(self):
33                 self.fnc(*self.args)
34                 
35 class MenuUpdater:
36         def __init__(self):
37                 self.updatedMenuItems = {}
38         
39         def addMenuItem(self, id, pos, text, module, screen, weight):
40                 if not self.updatedMenuAvailable(id):
41                         self.updatedMenuItems[id] = []
42                 self.updatedMenuItems[id].append([text, pos, module, screen, weight])
43         
44         def delMenuItem(self, id, pos, text, module, screen, weight):
45                 self.updatedMenuItems[id].remove([text, pos, module, screen, weight])
46         
47         def updatedMenuAvailable(self, id):
48                 return self.updatedMenuItems.has_key(id)
49         
50         def getUpdatedMenu(self, id):
51                 return self.updatedMenuItems[id]
52
53 menuupdater = MenuUpdater()
54
55 class MenuSummary(Screen):
56         skin = """
57         <screen position="0,0" size="132,64">
58                 <widget source="parent.title" render="Label" position="6,4" size="120,21" font="Regular;18" />
59                 <widget source="parent.menu" render="Label" position="6,25" size="120,21" font="Regular;16">
60                         <convert type="StringListSelection" />
61                 </widget>
62                 <widget source="global.CurrentTime" render="Label" position="56,46" size="82,18" font="Regular;16" >
63                         <convert type="ClockToText">WithSeconds</convert>
64                 </widget>
65         </screen>"""
66
67         def __init__(self, session, parent):
68                 Screen.__init__(self, session, parent)
69
70 class Menu(Screen):
71
72         ALLOW_SUSPEND = True
73
74         def okbuttonClick(self):
75                 print "okbuttonClick"
76                 selection = self["menu"].getCurrent()
77                 if selection is not None:
78                         selection[1]()
79
80         def execText(self, text):
81                 exec text
82
83         def runScreen(self, arg):
84                 # arg[0] is the module (as string)
85                 # arg[1] is Screen inside this module 
86                 #        plus possible arguments, as 
87                 #        string (as we want to reference 
88                 #        stuff which is just imported)
89                 # FIXME. somehow
90                 if arg[0] != "":
91                         exec "from " + arg[0] + " import *"
92
93                 self.openDialog(*eval(arg[1]))
94
95         def nothing(self): #dummy
96                 pass
97
98         def openDialog(self, *dialog):                          # in every layer needed
99                 self.session.openWithCallback(self.menuClosed, *dialog)
100
101         def openSetup(self, dialog):
102                 self.session.openWithCallback(self.menuClosed, Setup, dialog)
103
104         def addMenu(self, destList, node):
105                 MenuTitle = _(node.getAttribute("text").encode("UTF-8") or "??")
106                 entryID = node.getAttribute("entryID") or "undefined"
107                 weight = node.getAttribute("weight") or 50
108                 x = node.getAttribute("flushConfigOnClose")
109                 if x:
110                         a = boundFunction(self.session.openWithCallback, self.menuClosedWithConfigFlush, Menu, node, node.childNodes)
111                 else:
112                         a = boundFunction(self.session.openWithCallback, self.menuClosed, Menu, node, node.childNodes)
113                 #TODO add check if !empty(node.childNodes)
114                 destList.append((MenuTitle, a, entryID, weight))
115
116         def menuClosedWithConfigFlush(self, *res):
117                 configfile.save()
118                 self.menuClosed(*res)
119
120         def menuClosed(self, *res):
121                 if len(res) and res[0]:
122                         self.close(True)
123
124         def addItem(self, destList, node):
125                 item_text = node.getAttribute("text").encode("UTF-8")
126                 entryID = node.getAttribute("entryID") or "undefined"
127                 weight = node.getAttribute("weight") or 50
128                 for x in node.childNodes:
129                         if x.nodeType != xml.dom.minidom.Element.nodeType:
130                                 continue
131                         elif x.tagName == 'screen':
132                                 module = x.getAttribute("module") or None
133                                 screen = x.getAttribute("screen") or None
134
135                                 if screen is None:
136                                         screen = module
137
138                                 print module, screen
139                                 if module:
140                                         module = "Screens." + module
141                                 else:
142                                         module = ""
143
144                                 # check for arguments. they will be appended to the
145                                 # openDialog call
146                                 args = XMLTools.mergeText(x.childNodes)
147                                 screen += ", " + args
148
149                                 destList.append((_(item_text or "??"), boundFunction(self.runScreen, (module, screen)), entryID, weight))
150                                 return
151                         elif x.tagName == 'code':
152                                 destList.append((_(item_text or "??"), boundFunction(self.execText, XMLTools.mergeText(x.childNodes)), entryID, weight))
153                                 return
154                         elif x.tagName == 'setup':
155                                 id = x.getAttribute("id")
156                                 if item_text == "":
157                                         item_text = _(getSetupTitle(id)) + "..."
158                                 else:
159                                         item_text = _(item_text)
160                                 destList.append((item_text, boundFunction(self.openSetup, id), entryID, weight))
161                                 return
162                 destList.append((item_text, self.nothing, entryID, weight))
163
164
165         def __init__(self, session, parent, childNode):
166                 Screen.__init__(self, session)
167                 
168                 list = []
169                 
170                 menuID = None
171                 for x in childNode:                                             #walk through the actual nodelist
172                         if x.nodeType != xml.dom.minidom.Element.nodeType:
173                             continue
174                         elif x.tagName == 'item':
175                                 item_level = int(x.getAttribute("level") or "0")
176                                 if item_level <= config.usage.setup_level.index:
177                                         self.addItem(list, x)
178                                         count += 1
179                         elif x.tagName == 'menu':
180                                 self.addMenu(list, x)
181                                 count += 1
182                         elif x.tagName == "id":
183                                 menuID = x.getAttribute("val")
184                                 count = 0
185
186                         if menuID is not None:
187                                 # menuupdater?
188                                 if menuupdater.updatedMenuAvailable(menuID):
189                                         for x in menuupdater.getUpdatedMenu(menuID):
190                                                 if x[1] == count:
191                                                         list.append((x[0], boundFunction(self.runScreen, (x[2], x[3] + ", ")), x[4]))
192                                                         count += 1
193
194                 if menuID is not None:
195                         # plugins
196                         for l in plugins.getPluginsForMenu(menuID):
197                                 # check if a plugin overrides an existing menu
198                                 plugin_menuid = l[2]
199                                 for x in list:
200                                         print x[2], plugin_menuid
201                                         if x[2] == plugin_menuid:
202                                                 list.remove(x)
203                                                 break
204                                 list.append((l[0], boundFunction(l[1], self.session), l[2], l[3] or 50))
205
206                 # for the skin: first try a menu_<menuID>, then Menu
207                 self.skinName = [ ]
208                 if menuID is not None:
209                         self.skinName.append("menu_" + menuID)
210                 self.skinName.append("Menu")
211
212                 # Sort by Weight
213                 list.sort(key=lambda x: int(x[3]))
214
215                 self["menu"] = List(list)
216
217                 self["actions"] = NumberActionMap(["OkCancelActions", "MenuActions", "NumberActions"],
218                         {
219                                 "ok": self.okbuttonClick,
220                                 "cancel": self.closeNonRecursive,
221                                 "menu": self.closeRecursive,
222                                 "1": self.keyNumberGlobal,
223                                 "2": self.keyNumberGlobal,
224                                 "3": self.keyNumberGlobal,
225                                 "4": self.keyNumberGlobal,
226                                 "5": self.keyNumberGlobal,
227                                 "6": self.keyNumberGlobal,
228                                 "7": self.keyNumberGlobal,
229                                 "8": self.keyNumberGlobal,
230                                 "9": self.keyNumberGlobal
231                         })
232
233                 a = parent.getAttribute("title").encode("UTF-8") or None
234                 if a is None:
235                         a = _(parent.getAttribute("text").encode("UTF-8"))
236                 self["title"] = StaticText(a)
237                 self.menu_title = a
238
239         def keyNumberGlobal(self, number):
240                 print "menu keyNumber:", number
241                 # Calculate index
242                 number -= 1
243
244                 if len(self["menu"].list) > number:
245                         self["menu"].setIndex(number)
246                         self.okbuttonClick()
247
248         def closeNonRecursive(self):
249                 self.close(False)
250
251         def closeRecursive(self):
252                 self.close(True)
253
254         def createSummary(self):
255                 return MenuSummary
256
257 class MainMenu(Menu):
258         #add file load functions for the xml-file
259         
260         def __init__(self, *x):
261                 self.skinName = "Menu"
262                 Menu.__init__(self, *x)