allow overriding menus from plugins
[enigma2.git] / lib / python / Screens / Menu.py
index 328c9b3995762602c9162c4080ff060ebf049ab1..9f0db4254d9318698df21a78e07c7fb3a822b568 100644 (file)
-#from Screen import *
-from Components.MenuList import MenuList
-from Components.ActionMap import ActionMap
-from Components.Header import Header
-from Components.Button import Button
-from Components.Label import Label
-from Components.ProgressBar import ProgressBar
-
-# hack.... dynamically importing all screens
-from __init__ import __all__
-for i in __all__:
-       print "import " + i
-       if (i is not "Menu" ):
-               exec "from " + i + " import *"
-
-from enigma import quitMainloop
+from Screen import Screen
+from Components.Sources.List import List
+from Components.ActionMap import NumberActionMap
+from Components.Sources.StaticText import StaticText
+from Components.config import configfile
+from Components.PluginComponent import plugins
+from Components.config import config
 
-import xml.dom.minidom
-from xml.dom import EMPTY_NAMESPACE
-from skin import elementsWithTag
+from Tools.Directories import resolveFilename, SCOPE_SKIN
 
-from Tools import XMLTools
+import xml.dom.minidom
 
-# some screens
-def doGlobal(screen):
-       screen["clock"] = Clock()
+from Screens.Setup import Setup, getSetupTitle
 
+from Tools import XMLTools
 
 #              <item text="TV-Mode">self.setModeTV()</item>
 #              <item text="Radio-Mode">self.setModeRadio()</item>
 #              <item text="File-Mode">self.setModeFile()</item>
-#              <item text="Scart">self.openDialog(ScartLoopThrough)</item>
 #                      <item text="Sleep Timer"></item>
 
 
 # read the menu
-try:
-       # first we search in the current path
-       menufile = file('data/menu.xml', 'r')
-except:
-       # if not found in the current path, we use the global datadir-path
-       menufile = file('/usr/share/enigma2/menu.xml', 'r')
+menufile = file(resolveFilename(SCOPE_SKIN, 'menu.xml'), 'r')
 mdom = xml.dom.minidom.parseString(menufile.read())
 menufile.close()
 
-
-
-def getValbyAttr(x, attr):
-       for p in range(x.attributes.length):
-               a = x.attributes.item(p)
-               attrib = str(a.name)
-               value = str(a.value)
-               if attrib == attr:
-                       return value
-                       
-       return ""
-
 class boundFunction:
        def __init__(self, fnc, *args):
                self.fnc = fnc
                self.args = args
        def __call__(self):
                self.fnc(*self.args)
+               
+class MenuUpdater:
+       def __init__(self):
+               self.updatedMenuItems = {}
+       
+       def addMenuItem(self, id, pos, text, module, screen, weight):
+               if not self.updatedMenuAvailable(id):
+                       self.updatedMenuItems[id] = []
+               self.updatedMenuItems[id].append([text, pos, module, screen, weight])
+       
+       def delMenuItem(self, id, pos, text, module, screen, weight):
+               self.updatedMenuItems[id].remove([text, pos, module, screen, weight])
+       
+       def updatedMenuAvailable(self, id):
+               return self.updatedMenuItems.has_key(id)
+       
+       def getUpdatedMenu(self, id):
+               return self.updatedMenuItems[id]
+
+menuupdater = MenuUpdater()
+
+class MenuSummary(Screen):
+       skin = """
+       <screen position="0,0" size="132,64">
+               <widget source="parent.title" render="Label" position="6,4" size="120,21" font="Regular;18" />
+               <widget source="parent.menu" render="Label" position="6,25" size="120,21" font="Regular;16">
+                       <convert type="StringListSelection" />
+               </widget>
+               <widget source="global.CurrentTime" render="Label" position="56,46" size="82,18" font="Regular;16" >
+                       <convert type="ClockToText">WithSeconds</convert>
+               </widget>
+       </screen>"""
+
+       def __init__(self, session, parent):
+               Screen.__init__(self, session, parent)
 
 class Menu(Screen):
+
+       ALLOW_SUSPEND = True
+
        def okbuttonClick(self):
                print "okbuttonClick"
                selection = self["menu"].getCurrent()
-               selection[1]()
+               if selection is not None:
+                       selection[1]()
 
-       def evalText(self, text):
-               eval(text)
-               
-       def nothing(self):                                                                                                                                      #dummy
+       def execText(self, text):
+               exec text
+
+       def runScreen(self, arg):
+               # arg[0] is the module (as string)
+               # arg[1] is Screen inside this module 
+               #        plus possible arguments, as 
+               #        string (as we want to reference 
+               #        stuff which is just imported)
+               # FIXME. somehow
+               if arg[0] != "":
+                       exec "from " + arg[0] + " import *"
+
+               self.openDialog(*eval(arg[1]))
+
+       def nothing(self): #dummy
                pass
 
-       def openDialog(self, dialog):                           # in every layer needed
-               self.session.open(dialog)
+       def openDialog(self, *dialog):                          # in every layer needed
+               self.session.openWithCallback(self.menuClosed, *dialog)
 
        def openSetup(self, dialog):
-               self.session.open(Setup, dialog)
+               self.session.openWithCallback(self.menuClosed, Setup, dialog)
 
        def addMenu(self, destList, node):
-               MenuTitle = getValbyAttr(node, "text")
-               if MenuTitle != "":                                                                                                                                     #check for title
-                       a = boundFunction(self.session.open, Menu, node, node.childNodes)
-                       #TODO add check if !empty(node.childNodes)
-                       destList.append((MenuTitle, a))
-               
+               MenuTitle = _(node.getAttribute("text").encode("UTF-8") or "??")
+               entryID = node.getAttribute("entryID") or "undefined"
+               weight = node.getAttribute("weight") or 50
+               x = node.getAttribute("flushConfigOnClose")
+               if x:
+                       a = boundFunction(self.session.openWithCallback, self.menuClosedWithConfigFlush, Menu, node, node.childNodes)
+               else:
+                       a = boundFunction(self.session.openWithCallback, self.menuClosed, Menu, node, node.childNodes)
+               #TODO add check if !empty(node.childNodes)
+               destList.append((MenuTitle, a, entryID, weight))
+
+       def menuClosedWithConfigFlush(self, *res):
+               configfile.save()
+               self.menuClosed(*res)
+
+       def menuClosed(self, *res):
+               if len(res) and res[0]:
+                       self.close(True)
+
        def addItem(self, destList, node):
-               ItemText = getValbyAttr(node, "text")
-               if ItemText != "":                                                                                                                                      #check for name
-                       b = XMLTools.mergeText(node.childNodes)
-                       if b != "":                                                                                                                                                             #check for function
-                               destList.append((ItemText,boundFunction(self.evalText,b)))
-                       else:
-                               destList.append((ItemText,self.nothing))                                #use dummy as function
+               item_text = node.getAttribute("text").encode("UTF-8")
+               entryID = node.getAttribute("entryID") or "undefined"
+               weight = node.getAttribute("weight") or 50
+               for x in node.childNodes:
+                       if x.nodeType != xml.dom.minidom.Element.nodeType:
+                               continue
+                       elif x.tagName == 'screen':
+                               module = x.getAttribute("module") or None
+                               screen = x.getAttribute("screen") or None
+
+                               if screen is None:
+                                       screen = module
+
+                               print module, screen
+                               if module:
+                                       module = "Screens." + module
+                               else:
+                                       module = ""
+
+                               # check for arguments. they will be appended to the
+                               # openDialog call
+                               args = XMLTools.mergeText(x.childNodes)
+                               screen += ", " + args
+
+                               destList.append((_(item_text or "??"), boundFunction(self.runScreen, (module, screen)), entryID, weight))
+                               return
+                       elif x.tagName == 'code':
+                               destList.append((_(item_text or "??"), boundFunction(self.execText, XMLTools.mergeText(x.childNodes)), entryID, weight))
+                               return
+                       elif x.tagName == 'setup':
+                               id = x.getAttribute("id")
+                               if item_text == "":
+                                       item_text = _(getSetupTitle(id)) + "..."
+                               else:
+                                       item_text = _(item_text)
+                               destList.append((item_text, boundFunction(self.openSetup, id), entryID, weight))
+                               return
+               destList.append((item_text, self.nothing, entryID, weight))
+
 
        def __init__(self, session, parent, childNode):
                Screen.__init__(self, session)
                
                list = []
-
-               for x in childNode:                                                     #walk through the actual nodelist
+               
+               menuID = None
+               for x in childNode:                                             #walk through the actual nodelist
                        if x.nodeType != xml.dom.minidom.Element.nodeType:
                            continue
                        elif x.tagName == 'item':
-                               self.addItem(list, x)
+                               item_level = int(x.getAttribute("level") or "0")
+                               if item_level <= config.usage.setup_level.index:
+                                       self.addItem(list, x)
+                                       count += 1
                        elif x.tagName == 'menu':
                                self.addMenu(list, x)
+                               count += 1
+                       elif x.tagName == "id":
+                               menuID = x.getAttribute("val")
+                               count = 0
 
-               self["menu"] = MenuList(list)   
-                                                       
-               self["actions"] = ActionMap(["OkCancelActions"], 
-                       {
-                               "ok": self.okbuttonClick,
-                               "cancel": self.close
-                       })
-               
-               a = getValbyAttr(parent, "title")
-               if a == "":                                                                                                             #if empty use name
-                       a = getValbyAttr(parent, "text")
-               self["title"] = Header(a)
+                       if menuID is not None:
+                               # menuupdater?
+                               if menuupdater.updatedMenuAvailable(menuID):
+                                       for x in menuupdater.getUpdatedMenu(menuID):
+                                               if x[1] == count:
+                                                       list.append((x[0], boundFunction(self.runScreen, (x[2], x[3] + ", ")), x[4]))
+                                                       count += 1
 
-class FixedMenu(Screen):
-       def okbuttonClick(self):
-               selection = self["menu"].getCurrent()
-               selection[1]()
+               if menuID is not None:
+                       # plugins
+                       for l in plugins.getPluginsForMenu(menuID):
+                               # check if a plugin overrides an existing menu
+                               plugin_menuid = l[2]
+                               for x in list:
+                                       print x[2], plugin_menuid
+                                       if x[2] == plugin_menuid:
+                                               list.remove(x)
+                                               break
+                               list.append((l[0], boundFunction(l[1], self.session), l[2], l[3] or 50))
 
-       def __init__(self, session, title, list):
-               Screen.__init__(self, session)
-               
-               self["menu"] = MenuList(list)   
-                                                       
-               self["actions"] = ActionMap(["OkCancelActions"], 
+               # for the skin: first try a menu_<menuID>, then Menu
+               self.skinName = [ ]
+               if menuID is not None:
+                       self.skinName.append("menu_" + menuID)
+               self.skinName.append("Menu")
+
+               # Sort by Weight
+               list.sort(key=lambda x: int(x[3]))
+
+               self["menu"] = List(list)
+
+               self["actions"] = NumberActionMap(["OkCancelActions", "MenuActions", "NumberActions"],
                        {
                                "ok": self.okbuttonClick,
-                               "cancel": self.close
+                               "cancel": self.closeNonRecursive,
+                               "menu": self.closeRecursive,
+                               "1": self.keyNumberGlobal,
+                               "2": self.keyNumberGlobal,
+                               "3": self.keyNumberGlobal,
+                               "4": self.keyNumberGlobal,
+                               "5": self.keyNumberGlobal,
+                               "6": self.keyNumberGlobal,
+                               "7": self.keyNumberGlobal,
+                               "8": self.keyNumberGlobal,
+                               "9": self.keyNumberGlobal
                        })
-               
-               self["title"] = Header(title)
 
+               a = parent.getAttribute("title").encode("UTF-8") or None
+               if a is None:
+                       a = _(parent.getAttribute("text").encode("UTF-8"))
+               self["title"] = StaticText(a)
+               self.menu_title = a
 
-class MainMenu(Menu):
-       #add file load functions for the xml-file
-       
-       def __init__(self, *x):
-               Menu.__init__(self, *x)
-               self.skinName = "Menu"
+       def keyNumberGlobal(self, number):
+               print "menu keyNumber:", number
+               # Calculate index
+               number -= 1
 
-       def openDialog(self, dialog):
-               self.session.open(dialog)
+               if len(self["menu"].list) > number:
+                       self["menu"].setIndex(number)
+                       self.okbuttonClick()
 
-       def openSetup(self, dialog):
-               self.session.open(Setup, dialog)
+       def closeNonRecursive(self):
+               self.close(False)
 
-       def setModeTV(self):
-               print "set Mode to TV"
-               pass
+       def closeRecursive(self):
+               self.close(True)
 
-       def setModeRadio(self):
-               print "set Mode to Radio"
-               pass
+       def createSummary(self):
+               return MenuSummary
 
-       def setModeFile(self):
-               print "set Mode to File"
-               pass
+class MainMenu(Menu):
+       #add file load functions for the xml-file
+       
+       def __init__(self, *x):
+               self.skinName = "Menu"
+               Menu.__init__(self, *x)